Rechnungen & Zahlungen

Rechnungen, Positionen, Zahlungen, Erinnerungen und E-Rechnung (KSeF) — automatisieren Sie die Abrechnung durchgängig.

Diese Referenz wird aus dem API-Schema generiert. Feldbeschreibungen und alle noch nicht übersetzten Texte werden auf Englisch angezeigt.

Rechnung

Endpoints

Rechnung: Endpoints
Methode	Pfad	Beschreibung
POST	/e-invoices/send	Erstellt eine Invoice-Ressource.
GET	/invoices	Ruft die Sammlung der Invoice-Ressourcen ab.
POST	/invoices	Erstellt eine Invoice-Ressource.
GET	/invoices/{id}	Ruft eine Invoice-Ressource ab.
PATCH	/invoices/{id}	Aktualisiert die Invoice-Ressource.
DELETE	/invoices/{id}	Entfernt die Invoice-Ressource.
GET	/invoices/{id}/send	Ruft eine Invoice-Ressource ab.
POST	/invoices/{id}/send	Erstellt eine Invoice-Ressource.
GET	/invoices/draft	Ruft die Sammlung der Invoice-Ressourcen ab.
POST	/invoices/import	Erstellt eine Invoice-Ressource.
GET	/invoices/name/{date}	Ruft die Sammlung der Invoice-Ressourcen ab.
POST	/invoices/send	Erstellt eine Invoice-Ressource.

Rechnungsposition

Endpoints

Rechnungsposition: Endpoints
Methode	Pfad	Beschreibung
GET	/invoice-rows	Ruft die Sammlung der InvoiceRow-Ressourcen ab.
POST	/invoice-rows	Erstellt eine InvoiceRow-Ressource.
GET	/invoice-rows/{id}	Ruft eine InvoiceRow-Ressource ab.
PATCH	/invoice-rows/{id}	Aktualisiert die InvoiceRow-Ressource.

Schemafelder

Rechnungsposition: Schemafelder
Feld	Typ	Beschreibung
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.

Rechnungstransaktion

Endpoints

Rechnungstransaktion: Endpoints
Methode	Pfad	Beschreibung
GET	/invoice-transactions	Ruft die Sammlung der InvoiceTransaction-Ressourcen ab.
POST	/invoice-transactions	Erstellt eine InvoiceTransaction-Ressource.
GET	/invoice-transactions/{id}	Ruft eine InvoiceTransaction-Ressource ab.
PATCH	/invoice-transactions/{id}	Aktualisiert die InvoiceTransaction-Ressource.
DELETE	/invoice-transactions/{id}	Entfernt die InvoiceTransaction-Ressource.

Schemafelder

Rechnungstransaktion: Schemafelder
Feld	Typ	Beschreibung
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.

Zahlungsart

Endpoints

Zahlungsart: Endpoints
Methode	Pfad	Beschreibung
GET	/payment-methods	Ruft die Sammlung der PaymentMethod-Ressourcen ab.
GET	/payment-methods/{id}	Ruft eine PaymentMethod-Ressource ab.
PATCH	/payment-methods/{id}	Aktualisiert die PaymentMethod-Ressource.
DELETE	/payment-methods/{id}	Entfernt die PaymentMethod-Ressource.
POST	/payment-methods/create-setup-intent	Erstellt eine PaymentMethod-Ressource.

Schemafelder

Zahlungsart: Schemafelder
Feld	Typ	Beschreibung
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.

Rechnungsdownload

Endpoints

Rechnungsdownload: Endpoints
Methode	Pfad	Beschreibung
GET	/e-invoicing/invoices/{id}/download/pdf	Ruft eine InvoiceDownload-Ressource ab.
GET	/e-invoicing/invoices/{id}/download/preview/pdf	Ruft eine InvoiceDownload-Ressource ab.
GET	/e-invoicing/invoices/{id}/download/upo	Ruft eine InvoiceDownload-Ressource ab.
GET	/e-invoicing/invoices/{id}/download/xml	Ruft eine InvoiceDownload-Ressource ab.
GET	/e-invoicing/invoices/download/xml	Ruft die Sammlung der InvoiceDownload-Ressourcen ab.

Rechnungserinnerung

Endpoints

Rechnungserinnerung: Endpoints
Methode	Pfad	Beschreibung
GET	/invoice-reminders	Ruft die Sammlung der InvoiceReminder-Ressourcen ab.
POST	/invoice-reminders/{id}/approve	Erstellt eine InvoiceReminder-Ressource.
POST	/invoice-reminders/{id}/dismiss	Erstellt eine InvoiceReminder-Ressource.
GET	/invoice-reminders/{id}/send	Ruft eine InvoiceReminder-Ressource ab.
POST	/invoice-reminders/{id}/send	Erstellt eine InvoiceReminder-Ressource.

Schemafelder

Rechnungserinnerung: Schemafelder
Feld	Typ	Beschreibung
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

Rechnungsprotokoll

Endpoints

Rechnungsprotokoll: Endpoints
Methode	Pfad	Beschreibung
GET	/invoice-logs	Ruft die Sammlung der InvoiceLog-Ressourcen ab.
GET	/invoice-logs/{id}	Ruft eine InvoiceLog-Ressource ab.

Schemafelder

Rechnungsprotokoll: Schemafelder
Feld	Typ	Beschreibung
id	integer
invoice	string (iri-reference)
employee	string (iri-reference)
statusName	string
description	stringnull

Rechnungsversand

Endpoints

Rechnungsversand: Endpoints
Methode	Pfad	Beschreibung
POST	/e-invoicing/invoices/{id}/send	Erstellt eine InvoiceSend-Ressource.

Versand der Rechnungskorrektur

Endpoints

Versand der Rechnungskorrektur: Endpoints
Methode	Pfad	Beschreibung
POST	/e-invoicing/invoices/{id}/correction	Erstellt eine InvoiceCorrectionSend-Ressource.

Zahlung

Endpoints

Zahlung: Endpoints
Methode	Pfad	Beschreibung
GET	/payments	Ruft die Sammlung der Payment-Ressourcen ab.

Schemafelder

Zahlung: Schemafelder
Feld	Typ	Beschreibung
id	string
paymentMethod	string,null (iri-reference)
type	string
currency	string
status	string

Download eingehender Rechnung

Endpoints

Download eingehender Rechnung: Endpoints
Methode	Pfad	Beschreibung
GET	/e-invoicing/invoices/inbound/{id}/download/upo	Ruft eine InboundInvoiceDownload-Ressource ab.
GET	/e-invoicing/invoices/inbound/{id}/download/xml	Ruft eine InboundInvoiceDownload-Ressource ab.
GET	/e-invoicing/invoices/inbound/download/xml	Ruft die Sammlung der InboundInvoiceDownload-Ressourcen ab.

Warteschlange eingehender Rechnungen

Endpoints

Warteschlange eingehender Rechnungen: Endpoints
Methode	Pfad	Beschreibung
POST	/e-invoicing/invoices/inbound/queue	Erstellt eine InboundInvoiceQueue-Ressource.

Sync eingehender Rechnungen

Endpoints

Sync eingehender Rechnungen: Endpoints
Methode	Pfad	Beschreibung
POST	/e-invoicing/invoices/inbound/sync	Erstellt eine InboundInvoiceSync-Ressource.

Importwarteschlange ausgehender Rechnungen

Endpoints

Importwarteschlange ausgehender Rechnungen: Endpoints
Methode	Pfad	Beschreibung
POST	/v1/pl/invoices/outbound/import/queue	Erstellt eine OutboundInvoiceImportQueue-Ressource.

Import-Sync ausgehender Rechnungen

Endpoints

Import-Sync ausgehender Rechnungen: Endpoints
Methode	Pfad	Beschreibung
POST	/v1/pl/invoices/outbound/import/sync	Erstellt eine OutboundInvoiceImportSync-Ressource.

KSeF-Sitzung

Endpoints

KSeF-Sitzung: Endpoints
Methode	Pfad	Beschreibung
POST	/e-invoicing/ksef/session	Erstellt eine KsefSession-Ressource.