916e669fc527
Get a list of purchase orders
Retrieve a paged collection of purchase orders (required scope finance:read)
Query parameters
Represents the fields that can be used to sort purchase orders.<p>Possible values:</p><ul><li><b>createdAt</b>: The date and time when the purchase order was created.</li><li><b>reference</b>: Represents a reference to an external resource or entity.</li></ul>
The field to sort items in the page by
Represents the direction in which sorting should be applied<p>Possible values:</p><ul><li><b>ascending</b>: Indicates ascending sorting order</li><li><b>descending</b>: Indicates descending sorting order</li></ul>
The direction to apply the sort
Only return purchase orders where id matches the value(s) provided (Max items: 50)
Only return purchase orders where jobId matches the value(s) provided (Max items: 50)
Only return purchase orders where jobGroupId matches the value(s) provided (Max items: 50)
Only return purchase orders where contactId matches the value(s) provided (Max items: 50)
Only return purchase orders where reference matches the value(s) provided (Max items: 50)
Only return purchase orders created at or after this date (inclusive)
Only return purchase orders created at or before this date (inclusive)
The page number being requested (minimum: 1, maximum: 2147483)
The page size being requested (minimum: 1, maximum: 1000)
Headers
The customer identifier
Response
OK
Example response
{
"items": [
{
"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"
}
}
]
}
],
"pageNumber": 2,
"pageSize": 100,
"pageItemCount": 55
}