--- title: "Get an invoice" method: GET path: "/v1/finance/invoices/{invoiceId}" tags: ["Invoices"] --- # Get an invoice `GET /v1/finance/invoices/{invoiceId}` Retrieve the details of a single invoice (required scope finance:read) ## Path parameters - `invoiceId` integer, required ## Headers - `Customer-Id` integer, required ## Response `200` OK - ReadInvoiceModel — Represents a model that holds information about an invoice - `id` integer — The unique identifier of the invoice - `jobId` integer, nullable — The unique identifier of the job associated with this invoice, if applicable - `jobGroupId` integer, nullable — The unique identifier of the job group associated with this invoice, if applicable - `contactId` integer — The unique identifier of the contact associated with this invoice - `contractId` integer, nullable — The unique identifier of the contract associated with this invoice, if applicable.
Shown even if the contract has been soft deleted - `createdAt` string, date-time — The dateTime the invoice was created - `dueAt` string, date-time, nullable — The date the invoice is due to be paid, calculated from the issue date and the payment terms.
Null if payment terms have not been set on the invoice - `reference` string — The reference of the invoice - `currencyCode` 'EUR' | 'AUD' | 'GBP' | 'BGN' | 'CAD' | 'CZK' | 'DKK' | 'HUF' | 'ILS' | 'LVL' | 'LTL' | 'MXN' | 'NZD' | 'NOK' | 'PLN' | 'RON' | 'RUB' | 'ZAR' | 'SEK' | 'CHF' | 'AED' | 'USD' | 'UNKNOWN' — CurrencyCode definitions enum, matches currencies available in the BigChange Client Site with an unknown value to handle unrecognised currencies returned from the database

Possible values:

- `deliverySiteContactId` integer, nullable — The unique identifier of the delivery site contact associated with this invoice, if applicable - `nominalCodeId` integer, nullable — The unique identifier of the nominal code associated with this invoice, if applicable - `bankAccountId` integer, nullable — The unique identifier of the bank account associated with this invoice, if applicable - `departmentCodeId` integer, nullable — The unique identifier of the department associated with this invoice, if applicable - `clientNotes` string — Notes on the invoice - `internalNotes` string — Internal notes not visible to the client - `sentAt` string, date-time, nullable — The date and time when the invoice was sent, if applicable - `cancelledAt` string, date-time, nullable — The date and time when the invoice was cancelled, if applicable - `paidAt` string, date-time, nullable — The date and time when the invoice was paid, if applicable - `acceptedAt` string, date-time, nullable — The date and time when the invoice was accepted, if applicable - `cost` number, double, nullable — The cost of the invoice - `totalExclTax` number, double — The total amount excluding tax - `totalInclTax` number, double — The total amount including tax - `totalPaid` number, double — The total amount paid - `paymentLink` string — The payment link associated with the invoice, if applicable - `customFields` CustomFieldReadModel[] — Custom fields associated with the invoice - `definitionId` integer — The unique identifier of the associated custom field definition - `value` string, nullable — The current value set for the custom field - `definition` CustomFieldEmbeddedDefinitionModel — Represents the definition of a custom field - `caption` string — The caption of a custom field - `type` 'boolean' | 'integer' | 'decimal' | 'text' | 'list' | 'statement' | 'date' | 'note' | 'time' | 'systemList' — The type of the custom field. New field types may be added in the future, so integrations should be resilient to this

Possible values:

- `listOptions` string[], nullable — Shows the possible values for a list type custom field. Value will be null if type is not list - `isRequired` boolean — Indicates if the field is required in the UI. This is NOT enforced in the API - `isEditable` boolean — Indicates if the field is editable - `default` string, nullable — The default value of a custom field. Formatted in accordance with the rules of the field type - `systemListValueMetadata` SystemListValueMetadataModel — Represents details of custom field value of type system list - `label` string, nullable — A descriptive label for the specific resource, vehicle or web user that this system list value relates to - `entityType` 'resource' | 'vehicle' | 'webUser' — The type of entity used for custom field value of type system list

Possible values:

## Other responses - `400` — Bad Request - `403` — Forbidden - `404` — Not Found - `500` — Internal Server Error --- [API](https://skmtc.net/bigchange/apis/bigchange-dx.md) · [All operations](https://skmtc.net/bigchange/apis/bigchange-dx/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bigchange/bigchange-dx/revisions/916e669fc527/schema)