Faktury i płatności

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

Faktura

Endpoints

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.
GET	/invoices/name/{date}	Pobiera kolekcję zasobów Invoice.
POST	/invoices/send	Tworzy zasób Invoice.

Pozycja faktury

Endpoints

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

Pole	Typ	Opis
classificationNumber	stringnull
unit*	stringnull
quantity*	number
vatRate*	string
netPrice*	string
netDiscountAmount	string
productName*	string
project	string,null (iri-reference)
parentInvoiceRow	mixed
invoiceChildrenRows	array

Transakcja faktury

Endpoints

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

Pole	Typ	Opis
id	integer
invoice*	string (iri-reference)
transaction	string,null (iri-reference)
amount	numbernull
date*	string (date-time)
createdAt	string (date-time)
updatedAt	string (date-time)

Metoda płatności

Endpoints

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

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

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

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

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

GET	/invoice-logs	Pobiera kolekcję zasobów InvoiceLog.
GET	/invoice-logs/{id}	Pobiera zasób InvoiceLog.

Pola schematu

Pole	Typ	Opis
id	integer
invoice	string (iri-reference)
employee	string (iri-reference)
statusName	string
description	stringnull

Wysyłka faktury

Endpoints

POST

/e-invoicing/invoices/{id}/send

Wysyłka korekty faktury

Endpoints

POST

/e-invoicing/invoices/{id}/correction

Płatność

Endpoints

GET

/payments

Pola schematu

Pole	Typ	Opis
id	string
paymentMethod	string,null (iri-reference)
type	string
currency	string
status	string

Pobieranie faktury przychodzącej

Endpoints

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

POST

/e-invoicing/invoices/inbound/queue

Synchronizacja faktur przychodzących

Endpoints

POST

/e-invoicing/invoices/inbound/sync

Kolejka importu faktur wychodzących

Endpoints

POST

/v1/pl/invoices/outbound/import/queue

Synchronizacja importu faktur wychodzących

Endpoints

POST

/v1/pl/invoices/outbound/import/sync

Sesja KSeF

Endpoints

POST

/e-invoicing/ksef/session