Faktury i płatności

Faktury, pozycje, płatności, przypomnienia i e-faktury (KSeF) — automatyzuj fakturowanie od początku do końca.

Ta dokumentacja jest generowana ze schematu API. Opisy pól oraz wszelkie teksty, które nie zostały jeszcze przetłumaczone, są wyświetlane po angielsku.

Faktura

Endpoints

Faktura: Endpoints
Metoda	Ścieżka	Opis
POST	/e-invoices/send	Tworzy zasób Invoice.
GET	/invoices	Pobiera kolekcję zasobów Invoice.
POST	/invoices	Tworzy zasób Invoice.
GET	/invoices/{id}	Pobiera zasób Invoice.
PATCH	/invoices/{id}	Aktualizuje zasób Invoice.
DELETE	/invoices/{id}	Usuwa zasób Invoice.
GET	/invoices/{id}/send	Pobiera zasób Invoice.
POST	/invoices/{id}/send	Tworzy zasób Invoice.
GET	/invoices/draft	Pobiera kolekcję zasobów Invoice.
POST	/invoices/import	Tworzy zasób Invoice.
GET	/invoices/name/{date}	Pobiera kolekcję zasobów Invoice.
POST	/invoices/send	Tworzy zasób Invoice.

Pozycja faktury

Endpoints

Pozycja faktury: Endpoints
Metoda	Ścieżka	Opis
GET	/invoice-rows	Pobiera kolekcję zasobów InvoiceRow.
POST	/invoice-rows	Tworzy zasób InvoiceRow.
GET	/invoice-rows/{id}	Pobiera zasób InvoiceRow.
PATCH	/invoice-rows/{id}	Aktualizuje zasób InvoiceRow.

Pola schematu

Pozycja faktury: Pola schematu
Pole	Typ	Opis
classificationNumber	stringnull
unit*	stringnull
quantity*	number
vatRate*	string
netPrice*	string
netDiscountAmount	stringnull
productName*	string
project	string,null (iri-reference)
parentInvoiceRow	mixed
invoiceChildrenRows	array
product	string,null (iri-reference)	The catalog product this row sold, when it sold one. NULL on every row that exists today and on every row written by a non-POS screen — and a NULL product means this row moves no stock at all, which is exactly today's behaviour.
priceBasis	string
grossPrice	stringnull	The tax-INCLUSIVE unit price — the number on the price tag. Set only on a 'gross' row, where it is the authority; NULL on every 'net' row.

Transakcja faktury

Endpoints

Transakcja faktury: Endpoints
Metoda	Ścieżka	Opis
GET	/invoice-transactions	Pobiera kolekcję zasobów InvoiceTransaction.
POST	/invoice-transactions	Tworzy zasób InvoiceTransaction.
GET	/invoice-transactions/{id}	Pobiera zasób InvoiceTransaction.
PATCH	/invoice-transactions/{id}	Aktualizuje zasób InvoiceTransaction.
DELETE	/invoice-transactions/{id}	Usuwa zasób InvoiceTransaction.

Pola schematu

Transakcja faktury: Pola schematu
Pole	Typ	Opis
id	integer
invoice*	string (iri-reference)
transaction	string,null (iri-reference)
amount	number	MINOR units (grosze/cents) — 2 606,74 is 260674, NOT 2606.74. This differs from every neighbouring money field on this API: Invoice.amount, Invoice.amountNet and Transaction.amount are all MAJOR units, so a caller copying a transaction amount straight into this field stores 100x too little and the invoice renders as 1% paid.
date*	string (date-time)
createdAt	string (date-time)
updatedAt	string (date-time)
amountFromMajor	numbernull	Store a payment whose source value is in MAJOR units.

Metoda płatności

Endpoints

Metoda płatności: Endpoints
Metoda	Ścieżka	Opis
GET	/payment-methods	Pobiera kolekcję zasobów PaymentMethod.
GET	/payment-methods/{id}	Pobiera zasób PaymentMethod.
PATCH	/payment-methods/{id}	Aktualizuje zasób PaymentMethod.
DELETE	/payment-methods/{id}	Usuwa zasób PaymentMethod.
POST	/payment-methods/create-setup-intent	Tworzy zasób PaymentMethod.

Pola schematu

Metoda płatności: Pola schematu
Pole	Typ	Opis
id	string
organization	string,null (iri-reference)
type	string
ccBrand	string
ccLastDigits	string
ccExpMonth*	integer
ccExpYear*	integer
externalId	string
createdAt	string (date-time)
updatedAt	string (date-time)
deletedAt	string,null (date-time)
deleted	boolean	Check if the entity has been soft deleted.

Pobieranie faktury

Endpoints

Pobieranie faktury: Endpoints
Metoda	Ścieżka	Opis
GET	/e-invoicing/invoices/{id}/download/pdf	Pobiera zasób InvoiceDownload.
GET	/e-invoicing/invoices/{id}/download/preview/pdf	Pobiera zasób InvoiceDownload.
GET	/e-invoicing/invoices/{id}/download/upo	Pobiera zasób InvoiceDownload.
GET	/e-invoicing/invoices/{id}/download/xml	Pobiera zasób InvoiceDownload.
GET	/e-invoicing/invoices/download/xml	Pobiera kolekcję zasobów InvoiceDownload.

Przypomnienie o fakturze

Endpoints

Przypomnienie o fakturze: Endpoints
Metoda	Ścieżka	Opis
GET	/invoice-reminders	Pobiera kolekcję zasobów InvoiceReminder.
POST	/invoice-reminders/{id}/approve	Tworzy zasób InvoiceReminder.
POST	/invoice-reminders/{id}/dismiss	Tworzy zasób InvoiceReminder.
GET	/invoice-reminders/{id}/send	Pobiera zasób InvoiceReminder.
POST	/invoice-reminders/{id}/send	Tworzy zasób InvoiceReminder.

Pola schematu

Przypomnienie o fakturze: Pola schematu
Pole	Typ	Opis
id	integer
invoice	string (iri-reference)
level	integer
status	string
dueAt	string (date-time)
createdAt	string (date-time)
sentAt	string,null (date-time)
dismissedAt	string,null (date-time)
failedAt	string,null (date-time)
recipientEmail	stringnull
failureReason	stringnull
sentBody	stringnull
sentCcs	arraynull
pending	boolean
failed	boolean
sendable	boolean	A reminder can be (re-)sent while it is still awaiting its first send or its last attempt failed. Sent/dismissed reminders are terminal.
invoiceId	integernull
invoiceName	stringnull
clientName	stringnull
amountDue	numbernull
currencyCode	stringnull
invoiceDueDate	string (date-time)
daysOverdue	integer

Dziennik faktury

Endpoints

Dziennik faktury: Endpoints
Metoda	Ścieżka	Opis
GET	/invoice-logs	Pobiera kolekcję zasobów InvoiceLog.
GET	/invoice-logs/{id}	Pobiera zasób InvoiceLog.

Pola schematu

Dziennik faktury: Pola schematu
Pole	Typ	Opis
id	integer
invoice	string (iri-reference)
employee	string (iri-reference)
statusName	string
description	stringnull

Wysyłka faktury

Endpoints

Wysyłka faktury: Endpoints
Metoda	Ścieżka	Opis
POST	/e-invoicing/invoices/{id}/send	Tworzy zasób InvoiceSend.

Wysyłka korekty faktury

Endpoints

Wysyłka korekty faktury: Endpoints
Metoda	Ścieżka	Opis
POST	/e-invoicing/invoices/{id}/correction	Tworzy zasób InvoiceCorrectionSend.

Płatność

Endpoints

Płatność: Endpoints
Metoda	Ścieżka	Opis
GET	/payments	Pobiera kolekcję zasobów Payment.

Pola schematu

Płatność: Pola schematu
Pole	Typ	Opis
id	string
paymentMethod	string,null (iri-reference)
type	string
currency	string
status	string

Pobieranie faktury przychodzącej

Endpoints

Pobieranie faktury przychodzącej: Endpoints
Metoda	Ścieżka	Opis
GET	/e-invoicing/invoices/inbound/{id}/download/upo	Pobiera zasób InboundInvoiceDownload.
GET	/e-invoicing/invoices/inbound/{id}/download/xml	Pobiera zasób InboundInvoiceDownload.
GET	/e-invoicing/invoices/inbound/download/xml	Pobiera kolekcję zasobów InboundInvoiceDownload.

Kolejka faktur przychodzących

Endpoints

Kolejka faktur przychodzących: Endpoints
Metoda	Ścieżka	Opis
POST	/e-invoicing/invoices/inbound/queue	Tworzy zasób InboundInvoiceQueue.

Synchronizacja faktur przychodzących

Endpoints

Synchronizacja faktur przychodzących: Endpoints
Metoda	Ścieżka	Opis
POST	/e-invoicing/invoices/inbound/sync	Tworzy zasób InboundInvoiceSync.

Kolejka importu faktur wychodzących

Endpoints

Kolejka importu faktur wychodzących: Endpoints
Metoda	Ścieżka	Opis
POST	/v1/pl/invoices/outbound/import/queue	Tworzy zasób OutboundInvoiceImportQueue.

Synchronizacja importu faktur wychodzących

Endpoints

Synchronizacja importu faktur wychodzących: Endpoints
Metoda	Ścieżka	Opis
POST	/v1/pl/invoices/outbound/import/sync	Tworzy zasób OutboundInvoiceImportSync.

Sesja KSeF

Endpoints

Sesja KSeF: Endpoints
Metoda	Ścieżka	Opis
POST	/e-invoicing/ksef/session	Tworzy zasób KsefSession.