v1

latestOpenAPI 3.0.22026-07-223907721.1 MB

invoice

Get Invoice

Get a specific invoice

get/v2/invoices/{invoiceId}

Path parameters

invoiceIdstring uuid required

Example:b45f6432-2462-4c6f-b00f-1d9d01000000

The ID of the invoice to return.

Headers

x-tenant-idstring uuid required

The tenant ID for the target ERP instance.

x-runasstring

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

x-companyidstring

The Company-Id (int or uuid) of the company on whose behalf the request is executed.

Response

Returns the invoice for the given ID.

idstring uuid

numberstring

The number of the invoice.

externalNumberstring

The external number of the sales order.

companyIdstring uuid

Represents a key for identifying a firm within the application.

customerIdstring uuid

Represents a unique key for identifying a customer in the JTL system.

invoiceDatestring date-time

The date when the invoice was created.

colorcodeIdstring uuid

Represents a key for identifying a color entity in the system.

dunningBlockboolean

The creation of dunning letters is blocked.

isExternalInvoiceboolean

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

commentstring

A comment on the sales order.

customerCommentstring

A customer comment on the sales order.

isCancelledboolean

Indicates if the invoice has been cancelled.

languageIsostring

The language of the invoice.

Example response

{
  "id": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "companyId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "customerId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "billingAddress": {
    "id": "b45f6432-2462-4c6f-b00f-1d9d01000000"
  },
  "shipmentAddress": {
    "id": "b45f6432-2462-4c6f-b00f-1d9d01000000"
  },
  "invoicePaymentDetails": {
    "paymentMethodId": "b45f6432-2462-4c6f-b00f-1d9d01000000"
  },
  "colorcodeId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "cancellationDetails": {
    "cancellationReasonId": "b45f6432-2462-4c6f-b00f-1d9d01000000"
  }
}