Sign in
latestOpenAPI 3.0.12026-08-192092911.2 MB

916e669fc527

Invoices

Get an invoice

Retrieve the details of a single invoice (required scope finance:read)

get/v1/finance/invoices/{invoiceId}

Path parameters

invoiceIdinteger required

The unique identifier of the invoice

Headers

Customer-Idinteger required

The customer identifier

Response

OK

idinteger

The unique identifier of the invoice

jobIdinteger nullable

The unique identifier of the job associated with this invoice, if applicable

jobGroupIdinteger nullable

The unique identifier of the job group associated with this invoice, if applicable

contactIdinteger

The unique identifier of the contact associated with this invoice

contractIdinteger nullable

The unique identifier of the contract associated with this invoice, if applicable.<br/>Shown even if the contract has been soft deleted

createdAtstring date-time

The dateTime the invoice was created

dueAtstring date-time nullable

The date the invoice is due to be paid, calculated from the issue date and the payment terms.<br/>Null if payment terms have not been set on the invoice

referencestring

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<p>Possible values:</p><ul><li><b>EUR</b>: Euro</li><li><b>AUD</b>: Australian Dollar</li><li><b>GBP</b>: Pound Sterling</li><li><b>BGN</b>: Bulgarian Lev</li><li><b>CAD</b>: Canadian Dollar</li><li><b>CZK</b>: Czech Koruna</li><li><b>DKK</b>: Danish Krone</li><li><b>HUF</b>: Forint</li><li><b>ILS</b>: New Israeli Sheqel</li><li><b>LVL</b>: Latvian Lats - replaced by Euro</li><li><b>LTL</b>: Lithuanian Litas - replaced by Euro</li><li><b>MXN</b>: Mexican Peso</li><li><b>NZD</b>: New Zealand Dollar</li><li><b>NOK</b>: Norwegian Krone</li><li><b>PLN</b>: Zloty</li><li><b>RON</b>: Romanian Leu</li><li><b>RUB</b>: Russian Ruble</li><li><b>ZAR</b>: Rand</li><li><b>SEK</b>: Swedish Krona</li><li><b>CHF</b>: Swiss Franc</li><li><b>AED</b>: UAE Dirham</li><li><b>USD</b>: US Dollar</li><li><b>UNKNOWN</b>: Unknown currency</li></ul>

deliverySiteContactIdinteger nullable

The unique identifier of the delivery site contact associated with this invoice, if applicable

nominalCodeIdinteger nullable

The unique identifier of the nominal code associated with this invoice, if applicable

bankAccountIdinteger nullable

The unique identifier of the bank account associated with this invoice, if applicable

departmentCodeIdinteger nullable

The unique identifier of the department associated with this invoice, if applicable

clientNotesstring

Notes on the invoice

internalNotesstring

Internal notes not visible to the client

sentAtstring date-time nullable

The date and time when the invoice was sent, if applicable

cancelledAtstring date-time nullable

The date and time when the invoice was cancelled, if applicable

paidAtstring date-time nullable

The date and time when the invoice was paid, if applicable

acceptedAtstring date-time nullable

The date and time when the invoice was accepted, if applicable

costnumber double nullable

The cost of the invoice

totalExclTaxnumber double

The total amount excluding tax

totalInclTaxnumber double

The total amount including tax

totalPaidnumber double

The total amount paid

paymentLinkstring

The payment link associated with the invoice, if applicable

Example response

{
  "id": 12345,
  "jobId": 54321,
  "jobGroupId": 67890,
  "contractId": 101112,
  "createdAt": "2022-11-29T16:50:16.0000000+00:00",
  "dueAt": "2022-12-29T16:50:16.0000000+00:00",
  "reference": "InvoiceNote101",
  "currencyCode": "EUR",
  "deliverySiteContactId": 56789,
  "nominalCodeId": 45678,
  "bankAccountId": 34567,
  "departmentCodeId": 23456,
  "clientNotes": "Please pay within 30 days",
  "internalNotes": "Follow up in two weeks",
  "sentAt": "2024-01-15T10:30:00.0000000+00:00",
  "cancelledAt": "2024-02-20T14:45:00.0000000+00:00",
  "paidAt": "2024-01-30T09:15:00.0000000+00:00",
  "acceptedAt": "2024-01-20T11:00:00.0000000+00:00",
  "cost": 850.5,
  "totalExclTax": 1000,
  "totalInclTax": 1200,
  "totalPaid": 1200,
  "paymentLink": "{bookingSiteBaseUrl}/pay/{invoiceUid}/{invoiceId}/{customerId}",
  "customFields": [
    {
      "definitionId": 5514123,
      "value": "Purple",
      "definition": {
        "caption": "Favourite colour",
        "type": "boolean",
        "listOptions": [
          "Red",
          "Blue",
          "Green",
          "Purple"
        ],
        "isRequired": true,
        "isEditable": true,
        "default": "10"
      },
      "systemListValueMetadata": {
        "label": "John Doe",
        "entityType": "resource"
      }
    }
  ]
}