🔒 Create supplier invoice V3

post

https://{xentralId}.xentral.biz/api/v3/supplierInvoices

This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues.

This endpoint requires the following scopes: supplierInvoice:create.

Create a supplier invoice (liability). The invoice is created as a draft without a document number; omitted fields are derived from the supplier and project defaults. Line items, account assignments and purchase order assignments can be sent along and are created in the same transaction as the invoice; files are managed through their sub-resource.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

supplier

object

required

The supplier this invoice was received from.

supplierInvoiceNumber

string | null

The invoice number as printed on the supplier's invoice document.

date

date | null

Invoice date as printed on the supplier's invoice. Defaults to today.

receiptDate

date | null

Date the invoice was received. Defaults to today.

serviceDate

date | null

Date of supply or service.

project

object | null

Project this invoice belongs to. Defaults to the supplier's default project.

salesOrder

object | null

Sales order this invoice relates to.

purchaseOrder

object | null

Primary purchase order this invoice belongs to. Further purchase orders can be assigned inline through purchaseOrders or afterwards through the purchase order assignment sub-resource.

paymentReference

string | null

Payment reference used when paying this invoice.

internalComment

string | null

Internal comment, not visible to the supplier.

description

string | null

Free-text description of the invoice.

vatId

string | null

VAT identification number printed on the supplier's invoice. Defaults to the VAT ID stored on the supplier.

financials

object

Financial settings of the invoice.

amountGross

object | null

Gross total of the invoice. The currency must match the invoice currency. Defaults to 0.

freightCharge

object | null

Freight charge portion of the invoice. The currency must match the invoice currency. Defaults to 0.

taxationType

string | null

enum

Taxation scheme of the invoice. Defaults to the taxation scheme stored on the supplier.

Allowed:

taxes

object

Tax rates and amounts contained in the invoice total. Rates default to the standard and reduced rates of the project.

paymentTerms

object

Payment terms of the invoice.

payment

object

Payment details of the invoice.

generalLedgerAccount

string | null

General ledger account number from the chart of accounts.

costCenter

string | null

Cost center number.

isInNeedOfClarification

boolean

Marks the invoice as a clarification case. Defaults to false.

clarificationReason

string | null

Reason why the invoice needs clarification.

goodsCheckAccepted

boolean

Whether the goods check (sachliche Prüfung) has been accepted. Defaults to false.

invoiceCheckAccepted

boolean

Whether the invoice check has been accepted. Defaults to false.

paymentStatus

string | null

enum

Payment state of the invoice. Only pending and paid can be set on creation. Defaults to pending. A payment method that is configured to auto-pay liabilities overrides this and creates the invoice as paid.

Allowed:

lineItems

array of objects

length ≤ 100

Line items to create together with the invoice. They document what was invoiced and never change the totals of the invoice. Line items can also be added afterwards through the line item sub-resource.

lineItems

accountAssignments

array of objects

length ≤ 100

Account assignments to book together with the invoice - the shares of the invoice booked onto contra accounts. Splitting an invoice across accounts or tax rates is the normal case, so the whole split lands in one transaction. Assignments can also be added afterwards through their sub-resource, which is where the created ones are addressable.

accountAssignments

purchaseOrders

array of objects

length ≤ 100

Purchase orders to assign to the invoice, each stating its own share of it. Assignments can also be added afterwards through their sub-resource, which is where the created ones are addressable.

purchaseOrders

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Unauthorized

403

Forbidden

Language

Credentials

Bearer

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

400Failed validation

429Too Many Requests