Skip to main content
GET
Get Invoice

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

x-runas
string

The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.

x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

Path Parameters

invoiceId
integer<int32>
required

Response

Returns the invoice for the given ID.

Model Class: Invoice

Id
integer<int32>
required
Number
string
required

The number of the invoice.

Example:

"A1004465"

ExternalNumber
string
required

The external number of the sales order.

Example:

"D456-64894-132"

CompanyId
integer<int32>
required
DepartureCountry
object
required

Model Class: InvoiceDepartureCountry

CustomerId
integer<int32>
required
BillingAddress
object
required

Model Class: Address

ShipmentAddress
object
required

Model Class: Address

InvoiceDate
string<date-time>
required

The date when the invoice was created.

Example:

"2023-02-01T12:45:00.0000000+00:00"

InvoicePaymentDetails
object
required

Model Class: InvoicePaymentDetail

ColorcodeId
integer<int32>
required
DunningBlock
boolean
required

The creation of dunning letters is blocked.

Example:

false

IsExternalInvoice
boolean
required

Indicates if the invoice of the sales order was created in an external system like Amazon VCS.

Example:

false

Comment
string
required

A comment on the sales order.

Example:

"an additional order comment"

CustomerComment
string
required

A customer comment on the sales order.

Example:

"an additional customer comment"

IsCancelled
boolean
required

Indicates if the invoice has been cancelled.

Example:

false

LanguageIso
string
required

The language of the invoice.

Example:

"DE"

CancellationDetails
object
required

Model Class: InvoiceCancellationDetails