Accounts Payable (Beta)
Endpoints for Accounts Payable Automation such as Invoices, Purchase Orders, Purchase Receipts.
Content
Invoice
An invoice is a digitised representation of a vendor invoice, the invoice includes summary information of the individual invoice lines including taxes and charges, supplier details, billing information, and payment terms.
Endpoints
GET /beta/company/{companyId}/invoice/{invoiceId}
Response
{
"id": "1234567",
"companyId": "1",
"status": "NotSubmitted",
"supplier": {
"id": "",
"name": "",
"code": ""
},
"transactionTotals": [
{
"grossAmount": 500,
"netAmount": 454.55,
"taxAmount": 45.45,
"currencyCode": "AUD"
}
],
"summary": "",
"notes": "",
"reference": "IV1234",
"approvers": [
{
"id": "123",
"name": "Test Name",
"approvedDate": "1970-01-01T00:00:00Z"
}
],
"invoiceDate": "1970-01-01T00:00:00Z",
"dueDate": "1970-01-01T00:00:00Z",
"approvedDate": "1970-01-01T00:00:00Z",
"finalisedDate": "1970-01-01T00:00:00Z",
"createdDate": "1970-01-01T00:00:00Z",
"updatedDate": "1970-01-01T00:00:00Z",
"customFields": [
{
"type": "text",
"name": "Test Custom Field",
"value": "optional"
}
]
}Endpoints
GET /beta/company/{companyId}/invoice
Parameters
finalisedDate (date)
A filter for the finalised date of the invoice, the results returned will be after or on the specified finalised date.
status (string)
A filter on the status, if none provided all status will be included in the results.
None | NotSubmitted | PendingApproval | Approved | Finalised | Rejected
supplierId (string)
A filter for the supplier id
Note: The supplier Id is the primary Id in the ProSpend platform.
minUpdatedDate (string)
A filter for the last updated timestamp. Returns the data updated on or after the specified date-time in UTC.
Example: 2024-08-27 or 2024-08-27T16:25:16Z
Response
{
"page": [
{
"id": "1234567",
"companyId": "1",
"status": "NotSubmitted",
"supplier": {
"id": "",
"name": "",
"code": ""
},
"transactionTotals": [
{
"grossAmount": 500,
"netAmount": 454.55,
"taxAmount": 45.45,
"currencyCode": "AUD"
}
],
"summary": "",
"notes": "",
"reference": "IV1234",
"approvers": [
{
"id": "123",
"name": "Test Name",
"approvedDate": "1970-01-01T00:00:00Z"
}
],
"invoiceDate": "1970-01-01T00:00:00Z",
"dueDate": "1970-01-01T00:00:00Z",
"approvedDate": "1970-01-01T00:00:00Z",
"finalisedDate": "1970-01-01T00:00:00Z",
"createdDate": "1970-01-01T00:00:00Z",
"updatedDate": "1970-01-01T00:00:00Z",
"customFields": [
{
"type": "text",
"name": "Test Custom Field",
"value": "optional"
}
]
}
],
"nextCursor": ez438tjgowjr0"
}
InvoiceLine
Invoice Lines, also referred to as transactions, are the individual lines of a supplier invoice. The line includes the individual transaction details such as price, quantity, description, totals, as well as other data related to splits, allocations, and invoice line matching to Purchase Orders (PO) and Purchase Receipts (PR).
Endpoints
GET /beta/company/{companyId}/invoice/{invoiceId}/line/{lineId}
Response
{
"id": "1234567",
"companyId": "1",
"entityId": "ENT1",
"itemCode": "ITEM_CODE",
"itemName": "ITEM_NAME",
"description": "",
"glCode": "6600",
"isSplit": true,
"splitChildren": [
{
"splitId": "456",
"_link": "/company/4/invoice/555/line/1234567/split/456"
},
{
"splitId": "457",
"_link": "/company/4/invoice/555/line/1234567/split/457"
}
],
"taxCode": "GST",
"itemQty": 5.00,
"netUnitRate": 10.00,
"transactionTotal": {
"grossAmount": 50,
"netAmount": 45.45,
"taxAmount": 4.55,
"currencyCode": "AUD"
},
"portfolioCode": "PORT_CODE",
"projectCode": "PRJ_CODE",
"costCenterCode": "CC001",
"externalCode": "",
"isOmitted": false,
"createdDate": "1970-01-01T00:00:00Z",
"updatedDate": "1970-01-01T00:00:00Z",
"customFields": [
{
"type": "text",
"name": "Test Custom Field",
"value": "optional"
}
]
}Endpoints
GET /beta/company/{companyId}/invoice/{invoiceId}/line
Parameters
includeOmitted (boolean) - false
A filter for including omitted lines in the invoice, omitted lines are those that are excluded from the invoice totals and from approvals and workflows.
minUpdatedDate (string)
A filter for the last updated timestamp. Returns the data updated on or after the specified date-time in UTC.
Example: 2024-08-27 or 2024-08-27T16:25:16Z
Response
{
"page": [
{
"id": "1234567",
"companyId": "1",
"entityId": "ENT1",
"itemCode": "ITEM_CODE",
"itemName": "ITEM_NAME",
"description": "",
"glCode": "GL001",
"isSplit": true,
"splitChildren": [
{
"splitId": "456",
"_link": "/company/4/invoice/555/line/1234567/split/456"
},
{
"splitId": "457",
"_link": "/company/4/invoice/555/line/1234567/split/457"
}
],
"taxCode": "GST",
"itemQty": 5.00,
"netUnitRate": 10.00,
"transactionTotal": {
"grossAmount": 50,
"netAmount": 45.45,
"taxAmount": 4.55,
"currencyCode": "AUD"
},
"projectCode": "PRJ_CODE",
"portfolioCode": "PORT_CODE",
"costCenterCode": "CC001",
"externalCode": "",
"isOmitted": false,
"createdOn": "1970-01-01T00:00:00Z",
"updatedOn": "1970-01-01T00:00:00Z",
"customFields": [
{
"type": "",
"name": "",
"value": ""
}
]
}
],
"nextCursor": ez438tjgowjr0"
}
Invoice Split Line
Endpoints
GET /beta/company/{companyId}/invoice/{invoiceId}/line/{invoiceLineId}/split/{invoiceLineSplitId}
Response
{
"id": "1234567",
"companyId": "1",
"entityId": "ENT1",
"splitParentId": "2",
"itemCode": "ABC",
"itemName": "ItemName",
"description": "",
"taxCode": "GST",
"transactionTotals": [
{
"grossAmount": 20.01,
"netAmount": 18.19,
"taxAmount": 1.82,
"currencyCode": "AUD"
},
],
"portfolioCode": "PORT_CODE",
"projectCode": "PRJ_CODE",
"costCenterCode": "CC001",
"glCode": "GL30240",
"externalCode": "",
"createdDate": "1970-01-01T00:00:00Z",
"updatedDate": "1970-01-01T00:00:00Z",
"customFields": [
{
"type": "",
"name": "",
"value": ""
}
]
}Endpoints
GET /beta/company/{companyId}/invoice/{invoiceId}/line/{invoiceLineId}/split
Response
{
"page": [
{
"id": "1234567",
"companyId": "1",
"entityId": "ENT1",
"splitParentId": "2",
"itemCode": "ABC",
"itemName": "ItemName",
"description": "",
"taxCode": "GST",
"transactionTotals": [
{
"grossAmount": 20.01,
"netAmount": 18.19,
"taxAmount": 1.82,
"currencyCode": "AUD"
},
],
"portfolioCode": "PORT_CODE",
"projectCode": "PRJ_CODE",
"costCenterCode": "CC001",
"glCode": "GL30240",
"externalCode": "",
"createdDate": "1970-01-01T00:00:00Z",
"updatedDate": "1970-01-01T00:00:00Z",
"customFields": [
{
"type": "",
"name": "",
"value": ""
}
]
}
],
"nextCursor": ez438tjgowjr0"
}