Skip to main content

PurchaseOrder

A purchase order.

calculatedTaxnumber

The tax.

Example: 16
calculatedTotalnumber

The total.

Example: 96
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
deliveryDatedatenullable

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

Example: 2024-12-14
deliveryInstructionsstringnullable

Sales order delivery instructions.

Example: Leave with neighbour
lineItems object[]
  • Array [
  • amountExclTaxnumber

    The line amount excluding tax.

    Example: 80
    descriptionstring
    miscellaneousstringnullable
    productCodestringnullable
    quantitynumber
    unitPriceExclTaxnumber

    The line unit price excluding tax.

    Example: 80
    taxCode object
    sourceIDstring

    The unique identifier for this object in the source system.

    Example: TAX-001
  • ]
  • poDatedate

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

    Example: 2024-12-14
    poExpiryDatedatenullable

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

    Example: 2024-12-14
    poNumberstring

    The unique identifier.

    Example: PO-999
    poReferencestringnullable

    Any other identifiable purchase order information.

    sendEmailboolean
    statusstring

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

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

    subtotalnumber

    The sub-total.

    Example: 123.45
    supplier object
    accountancySupplierCard object
    sourceIDstring

    The unique identifier for this object in the source system.

    Example: SUPPLIER-001
    supplierEmailsstring[]nullable

    A list of supplier emails.

    PurchaseOrder
    {
    "calculatedTax": 16,
    "calculatedTotal": 96,
    "currencyCode": "GBP",
    "deliveryContactNumber": "020 7371 9918",
    "deliveryDate": "2024-12-14",
    "deliveryInstructions": "Leave with neighbour",
    "lineItems": [
    {
    "amountExclTax": 80,
    "description": "string",
    "miscellaneous": "string",
    "productCode": "string",
    "quantity": 0,
    "unitPriceExclTax": 80,
    "taxCode": {
    "sourceID": "TAX-001"
    }
    }
    ],
    "poDate": "2024-12-14",
    "poExpiryDate": "2024-12-14",
    "poNumber": "PO-999",
    "poReference": "string",
    "sendEmail": true,
    "status": "Draft",
    "subtotal": 123.45,
    "supplier": {
    "accountancySupplierCard": {
    "sourceID": "SUPPLIER-001"
    }
    },
    "supplierEmails": "[email protected]"
    }