Invoicing & payments

Invoices, rows, payments, reminders and e-invoicing (KSeF) — automate billing end to end.

Invoice

Endpoints

POST	/e-invoices/send	Creates a Invoice resource.
GET	/invoices	Retrieves the collection of Invoice resources.
POST	/invoices	Creates a Invoice resource.
GET	/invoices/{id}	Retrieves a Invoice resource.
PATCH	/invoices/{id}	Updates the Invoice resource.
DELETE	/invoices/{id}	Removes the Invoice resource.
GET	/invoices/{id}/send	Retrieves a Invoice resource.
POST	/invoices/{id}/send	Creates a Invoice resource.
GET	/invoices/draft	Retrieves the collection of Invoice resources.
GET	/invoices/name/{date}	Retrieves the collection of Invoice resources.
POST	/invoices/send	Creates a Invoice resource.

Invoice Row

Endpoints

GET	/invoice-rows	Retrieves the collection of InvoiceRow resources.
POST	/invoice-rows	Creates a InvoiceRow resource.
GET	/invoice-rows/{id}	Retrieves a InvoiceRow resource.
PATCH	/invoice-rows/{id}	Updates the InvoiceRow resource.

Schema fields

Field	Type	Description
classificationNumber	stringnull
unit*	stringnull
quantity*	number
vatRate*	string
netPrice*	string
netDiscountAmount	string
productName*	string
project	string,null (iri-reference)
parentInvoiceRow	mixed
invoiceChildrenRows	array

Invoice Transaction

Endpoints

GET	/invoice-transactions	Retrieves the collection of InvoiceTransaction resources.
POST	/invoice-transactions	Creates a InvoiceTransaction resource.
GET	/invoice-transactions/{id}	Retrieves a InvoiceTransaction resource.
PATCH	/invoice-transactions/{id}	Updates the InvoiceTransaction resource.
DELETE	/invoice-transactions/{id}	Removes the InvoiceTransaction resource.

Schema fields

Field	Type	Description
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)

Payment Method

Endpoints

GET	/payment-methods	Retrieves the collection of PaymentMethod resources.
GET	/payment-methods/{id}	Retrieves a PaymentMethod resource.
PATCH	/payment-methods/{id}	Updates the PaymentMethod resource.
DELETE	/payment-methods/{id}	Removes the PaymentMethod resource.
POST	/payment-methods/create-setup-intent	Creates a PaymentMethod resource.

Schema fields

Field	Type	Description
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.

Invoice Download

Endpoints

GET	/e-invoicing/invoices/{id}/download/pdf	Retrieves a InvoiceDownload resource.
GET	/e-invoicing/invoices/{id}/download/preview/pdf	Retrieves a InvoiceDownload resource.
GET	/e-invoicing/invoices/{id}/download/upo	Retrieves a InvoiceDownload resource.
GET	/e-invoicing/invoices/{id}/download/xml	Retrieves a InvoiceDownload resource.
GET	/e-invoicing/invoices/download/xml	Retrieves the collection of InvoiceDownload resources.

Invoice Reminder

Endpoints

GET	/invoice-reminders	Retrieves the collection of InvoiceReminder resources.
POST	/invoice-reminders/{id}/approve	Creates a InvoiceReminder resource.
POST	/invoice-reminders/{id}/dismiss	Creates a InvoiceReminder resource.
GET	/invoice-reminders/{id}/send	Retrieves a InvoiceReminder resource.
POST	/invoice-reminders/{id}/send	Creates a InvoiceReminder resource.

Schema fields

Field	Type	Description
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

Invoice Log

Endpoints

GET	/invoice-logs	Retrieves the collection of InvoiceLog resources.
GET	/invoice-logs/{id}	Retrieves a InvoiceLog resource.

Schema fields

Field	Type	Description
id	integer
invoice	string (iri-reference)
employee	string (iri-reference)
statusName	string
description	stringnull

Invoice Send

Endpoints

POST

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

Invoice Correction Send

Endpoints

POST

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

Payment

Endpoints

GET

/payments

Schema fields

Field	Type	Description
id	string
paymentMethod	string,null (iri-reference)
type	string
currency	string
status	string

Inbound Invoice Download

Endpoints

GET	/e-invoicing/invoices/inbound/{id}/download/upo	Retrieves a InboundInvoiceDownload resource.
GET	/e-invoicing/invoices/inbound/{id}/download/xml	Retrieves a InboundInvoiceDownload resource.
GET	/e-invoicing/invoices/inbound/download/xml	Retrieves the collection of InboundInvoiceDownload resources.

Inbound Invoice Queue

Endpoints

POST

/e-invoicing/invoices/inbound/queue

Inbound Invoice Sync

Endpoints

POST

/e-invoicing/invoices/inbound/sync

Outbound Invoice Import Queue

Endpoints

POST

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

Outbound Invoice Import Sync

Endpoints

POST

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

KSeF Session

Endpoints

POST

/e-invoicing/ksef/session