latestOpenAPI 3.0.02026-08-10233809957.8 KB
5cdfae3fa1fa
Purchase Orders
Gets the latest purchase order for a business.
get/purchaseOrders
Query parameters
businessNamestring required
serviceName'quickbooks' | 'quickbooksDesktop' | 'xero' | 'oracleNetsuite' | 'sageIntacct' | 'dynamicsBusinessCentral' | 'myob' | 'zohoBooks' required
startDatestring
Transaction date greater than or equal to parameter in the format: YYYY-MM-DD.
endDatestring
Transaction date less than or equal to parameter in the format: YYYY-MM-DD.
offsetnumber
The offset is the position in the dataset of a particular record.
limitnumber
This is the size of the results set you would like (default: 100).
orderBystring
totalAmountnumber float
status'open' | 'closed' | 'void' | 'unknown' | 'draft'
Response
Example response
{
"count": 1,
"meta": {
"reportId": [
"5fad8a342a88364234392fb5"
],
"serviceName": "xero",
"businessName": "Railz",
"createdAt": "2020-11-25T01:02:03Z",
"updatedAt": "2020-11-30T01:02:03Z",
"startDate": "2020-11-25T01:02:03Z",
"endDate": "2020-11-30T01:02:03Z"
},
"data": [
{
"id": "1",
"postedDate": "2021-03-09T10:18:29.985Z",
"deliveryDate": "2021-03-09T10:18:29.985Z",
"expectedArrivalDate": "2021-03-09T10:18:29.985Z",
"dueDate": "2021-03-09T10:18:29.985Z",
"currencyRate": 1.13,
"totalDiscount": 322,
"discountPercentage": 322,
"subTotal": 301.5,
"taxAmount": 20.5,
"totalAmount": 322,
"status": "open",
"memo": "Example bill memo.",
"shippingAddress": {
"line1": "1234 Park Street",
"line2": "Suite 1000",
"city": "Toronto",
"region": "ON",
"country": "CAN",
"postalCode": "A0B1C2"
},
"contact": {
"name": "John Smith",
"email": "jsmith@company.com",
"phone": "8884449999"
},
"sourceModifiedDate": "2021-03-09T10:18:29.985Z",
"vendorRef": {
"id": "1",
"name": "Home Depot"
},
"currencyRef": {
"id": "CAD",
"name": "Canadian Dollar",
"symbol": "USD,CAD"
},
"lines": [
{
"description": "Services rendered.",
"unitAmount": 100.5,
"quantity": 3,
"taxAmount": 20.5,
"taxRateRef": {
"id": "1",
"name": "HST",
"effectiveTaxRate": 13
},
"inventoryRef": {
"id": "1",
"name": "Digital Services"
},
"discountPercentage": 10.5,
"accountRef": {
"id": "145",
"name": "Example account"
},
"totalAmount": 10.5,
"subTotal": 301.5,
"trackingCategoryRef": {
"id": "4040",
"name": "Region",
"option": "East",
"optionId": "40401"
}
}
]
}
]
}