Facturering & betalingen

Facturen, factuurregels, betalingen, herinneringen en e-facturatie (KSeF) — automatiseer facturatie van begin tot eind.

Deze referentie wordt gegenereerd op basis van het API-schema. Veldbeschrijvingen en tekst die nog niet is vertaald, worden in het Engels weergegeven.

Factuur

Endpoints

Factuur: Endpoints
Methode	Pad	Beschrijving
POST	/e-invoices/send	Maakt een Invoice-resource aan.
GET	/invoices	Haalt de verzameling Invoice-resources op.
POST	/invoices	Maakt een Invoice-resource aan.
GET	/invoices/{id}	Haalt een Invoice-resource op.
PATCH	/invoices/{id}	Werkt de Invoice-resource bij.
DELETE	/invoices/{id}	Verwijdert de Invoice-resource.
GET	/invoices/{id}/send	Haalt een Invoice-resource op.
POST	/invoices/{id}/send	Maakt een Invoice-resource aan.
GET	/invoices/draft	Haalt de verzameling Invoice-resources op.
POST	/invoices/import	Maakt een Invoice-resource aan.
GET	/invoices/name/{date}	Haalt de verzameling Invoice-resources op.
POST	/invoices/send	Maakt een Invoice-resource aan.

Factuurregel

Endpoints

Factuurregel: Endpoints
Methode	Pad	Beschrijving
GET	/invoice-rows	Haalt de verzameling InvoiceRow-resources op.
POST	/invoice-rows	Maakt een InvoiceRow-resource aan.
GET	/invoice-rows/{id}	Haalt een InvoiceRow-resource op.
PATCH	/invoice-rows/{id}	Werkt de InvoiceRow-resource bij.

Schema-velden

Factuurregel: Schema-velden
Veld	Type	Beschrijving
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.

Factuurtransactie

Endpoints

Factuurtransactie: Endpoints
Methode	Pad	Beschrijving
GET	/invoice-transactions	Haalt de verzameling InvoiceTransaction-resources op.
POST	/invoice-transactions	Maakt een InvoiceTransaction-resource aan.
GET	/invoice-transactions/{id}	Haalt een InvoiceTransaction-resource op.
PATCH	/invoice-transactions/{id}	Werkt de InvoiceTransaction-resource bij.
DELETE	/invoice-transactions/{id}	Verwijdert de InvoiceTransaction-resource.

Schema-velden

Factuurtransactie: Schema-velden
Veld	Type	Beschrijving
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.

Betaalmethode

Endpoints

Betaalmethode: Endpoints
Methode	Pad	Beschrijving
GET	/payment-methods	Haalt de verzameling PaymentMethod-resources op.
GET	/payment-methods/{id}	Haalt een PaymentMethod-resource op.
PATCH	/payment-methods/{id}	Werkt de PaymentMethod-resource bij.
DELETE	/payment-methods/{id}	Verwijdert de PaymentMethod-resource.
POST	/payment-methods/create-setup-intent	Maakt een PaymentMethod-resource aan.

Schema-velden

Betaalmethode: Schema-velden
Veld	Type	Beschrijving
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.

Factuurdownload

Endpoints

Factuurdownload: Endpoints
Methode	Pad	Beschrijving
GET	/e-invoicing/invoices/{id}/download/pdf	Haalt een InvoiceDownload-resource op.
GET	/e-invoicing/invoices/{id}/download/preview/pdf	Haalt een InvoiceDownload-resource op.
GET	/e-invoicing/invoices/{id}/download/upo	Haalt een InvoiceDownload-resource op.
GET	/e-invoicing/invoices/{id}/download/xml	Haalt een InvoiceDownload-resource op.
GET	/e-invoicing/invoices/download/xml	Haalt de verzameling InvoiceDownload-resources op.

Factuurherinnering

Endpoints

Factuurherinnering: Endpoints
Methode	Pad	Beschrijving
GET	/invoice-reminders	Haalt de verzameling InvoiceReminder-resources op.
POST	/invoice-reminders/{id}/approve	Maakt een InvoiceReminder-resource aan.
POST	/invoice-reminders/{id}/dismiss	Maakt een InvoiceReminder-resource aan.
GET	/invoice-reminders/{id}/send	Haalt een InvoiceReminder-resource op.
POST	/invoice-reminders/{id}/send	Maakt een InvoiceReminder-resource aan.

Schema-velden

Factuurherinnering: Schema-velden
Veld	Type	Beschrijving
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

Factuurlogboek

Endpoints

Factuurlogboek: Endpoints
Methode	Pad	Beschrijving
GET	/invoice-logs	Haalt de verzameling InvoiceLog-resources op.
GET	/invoice-logs/{id}	Haalt een InvoiceLog-resource op.

Schema-velden

Factuurlogboek: Schema-velden
Veld	Type	Beschrijving
id	integer
invoice	string (iri-reference)
employee	string (iri-reference)
statusName	string
description	stringnull

Factuur verzenden

Endpoints

Factuur verzenden: Endpoints
Methode	Pad	Beschrijving
POST	/e-invoicing/invoices/{id}/send	Maakt een InvoiceSend-resource aan.

Factuurcorrectie verzenden

Endpoints

Factuurcorrectie verzenden: Endpoints
Methode	Pad	Beschrijving
POST	/e-invoicing/invoices/{id}/correction	Maakt een InvoiceCorrectionSend-resource aan.

Betaling

Endpoints

Betaling: Endpoints
Methode	Pad	Beschrijving
GET	/payments	Haalt de verzameling Payment-resources op.

Schema-velden

Betaling: Schema-velden
Veld	Type	Beschrijving
id	string
paymentMethod	string,null (iri-reference)
type	string
currency	string
status	string

Download inkomende factuur

Endpoints

Download inkomende factuur: Endpoints
Methode	Pad	Beschrijving
GET	/e-invoicing/invoices/inbound/{id}/download/upo	Haalt een InboundInvoiceDownload-resource op.
GET	/e-invoicing/invoices/inbound/{id}/download/xml	Haalt een InboundInvoiceDownload-resource op.
GET	/e-invoicing/invoices/inbound/download/xml	Haalt de verzameling InboundInvoiceDownload-resources op.

Wachtrij inkomende facturen

Endpoints

Wachtrij inkomende facturen: Endpoints
Methode	Pad	Beschrijving
POST	/e-invoicing/invoices/inbound/queue	Maakt een InboundInvoiceQueue-resource aan.

Synchronisatie inkomende facturen

Endpoints

Synchronisatie inkomende facturen: Endpoints
Methode	Pad	Beschrijving
POST	/e-invoicing/invoices/inbound/sync	Maakt een InboundInvoiceSync-resource aan.

Importwachtrij uitgaande facturen

Endpoints

Importwachtrij uitgaande facturen: Endpoints
Methode	Pad	Beschrijving
POST	/v1/pl/invoices/outbound/import/queue	Maakt een OutboundInvoiceImportQueue-resource aan.

Importsynchronisatie uitgaande facturen

Endpoints

Importsynchronisatie uitgaande facturen: Endpoints
Methode	Pad	Beschrijving
POST	/v1/pl/invoices/outbound/import/sync	Maakt een OutboundInvoiceImportSync-resource aan.

KSeF-sessie

Endpoints

KSeF-sessie: Endpoints
Methode	Pad	Beschrijving
POST	/e-invoicing/ksef/session	Maakt een KsefSession-resource aan.