Sign in
latestOpenAPI 3.0.12026-08-192092911.2 MB

916e669fc527

PurchaseOrders

Get a purchase order

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

get/v1/finance/purchaseOrders/{purchaseOrderId}

Path parameters

purchaseOrderIdinteger required

The unique identifer of the purchase order

Headers

Customer-Idinteger required

The customer identifier

Response

OK

idinteger

The unique identifier of the purchase order

jobIdinteger nullable

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

jobGroupIdinteger nullable

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

contactIdinteger

The unique identifier of the contact associated with this purchase order

seriesIdinteger nullable

The unique identifier of the purchase order series

contractIdinteger nullable

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

supplierIdinteger nullable

The unique identifier of the supplier associated with the purchase order

createdAtstring date-time

The dateTime the purchase order was created

referencestring

The reference of the purchase order

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 purchase order, if applicable

clientNotesstring

Notes on the purchase order

internalNotesstring

Internal notes not visible to the client

sentAtstring date-time nullable

The date and time when the purchase order was sent, if applicable

cancelledAtstring date-time nullable

The date and time when the purchase order was cancelled, if applicable

receivedAtstring date-time nullable

The date and time when the purchase order was received, if applicable

costnumber double nullable

The cost of the purchase order

totalExclTaxnumber double

The total amount excluding tax

totalInclTaxnumber double

The total amount including tax

totalPaidnumber double

The total amount paid

Example response

{
  "id": 12345,
  "jobId": 54321,
  "jobGroupId": 67890,
  "seriesId": 1234,
  "contractId": 101112,
  "supplierId": 12345,
  "createdAt": "2022-11-29T16:50:16.0000000+00:00",
  "reference": "InvoiceNote101",
  "currencyCode": "EUR",
  "deliverySiteContactId": 56789,
  "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",
  "receivedAt": "2024-01-20T11:00:00.0000000+00:00",
  "cost": 850.5,
  "totalExclTax": 1000,
  "totalInclTax": 1200,
  "totalPaid": 1200,
  "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"
      }
    }
  ]
}