Skip to main content

PurchaseOrder

A purchase order.

idstring<uuid>nullable

Unique identifier for the Purchase Order. When creating or updating the object this field can be null or omitted.

Example: 123e4567-e89b-12d3-a456-426614174001
calculatedTaxnumber

The tax.

Example: 16
calculatedTotalnumber

The total.

Example: 96
subtotalnumber

The sub-total.

Example: 80
currencyCodestring

The 3 letter ISO currency code for the amounts in this purchase order.

Example: GBP
deliveryContactNumberstringnullable

Delivery contact mobile number.

Example: 020 7371 9918
deliveryDatestring<date>nullable

The ISO formatted delivery date, for example, '2024-12-14'

Example: 2024-12-14
deliveryInstructionsstringnullable

Sales order delivery instructions.

Example: Leave with neighbour
lastUpdatestring<date-time>nullable

The ISO formatted delivery date from in the companies timezone e.g. 2024-05-14T00:00:00+01:00.

When creating the object this field can be null or omitted.

This can often be retrieved from the GET or UPDATE response.

Example: 2024-05-14T00:00:00+01:00
lineItems object[]
  • Array [
    • lineItemIDstring<uuid>nullable

    Unique identifier for the line item. When creating the object this field can be null or omitted.

    Example: 123e4567-e89b-12d3-a456-426614174101
    amountExclTaxnumber

    The line amount excluding tax.

    Example: 80
    descriptionstring
    miscellaneousstringnullable
    productCodestringnullable
    quantitynumber
    Example: 1
    unitPriceExclTaxnumber

    The line unit price excluding tax.

    Example: 80
    taxCode objectnullable
    sourceIDstringnullable

    The unique identifier for this object in the source system.

    Example: TAX-001
  • ]
    • poNumberstring

    The unique identifier.

    Example: PO-999
    poDatestring<date>

    The ISO formatted delivery date, for example, '2024-12-14'

    Example: 2024-12-14
    poExpiryDatestring<date>nullable

    The ISO formatted delivery date, for example, '2024-12-14'

    Example: 2024-12-14
    poReferencestringnullable

    Any other identifiable purchase order information.

    statusstring

    The desired purchase order status. Note: Approvals will be bypassed if status is 'Ordered'

    Possible values: [Draft, PendingApproval, Approved, Ordered]

    supplier object
    accountancySupplierCard object
    sourceIDstring

    The unique identifier for this object in the source system.

    Example: SUPPLIER-001
    sendEmailboolean

    When true and status = 'Approved' and Auto Order POs setting enabled then an email will be sent to the supplier with the purchase order details.

    When true and status != 'Approved' then no email will be sent but will highlight an email has been sent once it gets to 'Ordered'.

    If true then supplierEmails is required to be populated with at least 1 Email Address.

    supplierEmailsstring[]nullable

    A list of supplier emails, Only nullable when sendEmail is 'false'.

    PurchaseOrder
    {
      "id": "123e4567-e89b-12d3-a456-426614174001",
      "calculatedTax": 16,
      "calculatedTotal": 96,
      "subtotal": 80,
      "currencyCode": "GBP",
      "deliveryContactNumber": "020 7371 9918",
      "deliveryDate": "2024-12-14",
      "deliveryInstructions": "Leave with neighbour",
      "lastUpdate": "2024-05-14T00:00:00+01:00",
      "lineItems": [
        {
          "lineItemID": "123e4567-e89b-12d3-a456-426614174101",
          "amountExclTax": 80,
          "description": "string",
          "miscellaneous": "string",
          "productCode": "string",
          "quantity": 1,
          "unitPriceExclTax": 80,
          "taxCode": {
            "sourceID": "TAX-001"
          }
        }
      ],
      "poNumber": "PO-999",
      "poDate": "2024-12-14",
      "poExpiryDate": "2024-12-14",
      "poReference": "string",
      "status": "Draft",
      "supplier": {
        "accountancySupplierCard": {
          "sourceID": "SUPPLIER-001"
        }
      },
      "sendEmail": true,
      "supplierEmails": "[email protected]"
    }