Qodex.ai

Allows you to retrieve purchase orders

GET {{baseUrl}}/PurchaseOrders?Status=<string>&DateFrom=<string>&DateTo=<string>&order=<string>&page=<integer>

Request Params

KeyDatatypeRequiredDescription
StatusstringFilter by purchase order status
DateFromstringFilter by purchase order date (e.g. GET https://.../PurchaseOrders?DateFrom=2015-12-01&DateTo=2015-12-31
DateTostringFilter by purchase order date (e.g. GET https://.../PurchaseOrders?DateFrom=2015-12-01&DateTo=2015-12-31
orderstringOrder by an any element
pagestringTo specify a page, append the page parameter to the URL e.g. ?page=1. If there are 100 records in the response you will need to check if there is any more data by fetching the next page e.g ?page=2 and continuing this process until no more results are returned.

HEADERS

KeyDatatypeRequiredDescription
If-Modified-SincestringOnly records created or modified since this timestamp will be returned
xero-tenant-idstring(Required) Xero identifier for Tenant

RESPONSES

status: OK

{&quot;Id&quot;:&quot;66910bfc-15cc-4692-bd4c-cc8f671e653c&quot;,&quot;Status&quot;:&quot;OK&quot;,&quot;ProviderName&quot;:&quot;Provider Name Example&quot;,&quot;DateTimeUTC&quot;:&quot;/Date(1552523977238)/&quot;,&quot;PurchaseOrders&quot;:[{&quot;PurchaseOrderID&quot;:&quot;f9627f0d-b715-4039-bb6a-96dc3eae5ec5&quot;,&quot;PurchaseOrderNumber&quot;:&quot;PO-0001&quot;,&quot;DateString&quot;:&quot;2019-03-12T00:00:00&quot;,&quot;Date&quot;:&quot;/Date(1552348800000+0000)/&quot;,&quot;AttentionTo&quot;:&quot;Jimmy&quot;,&quot;HasErrors&quot;:false,&quot;IsDiscounted&quot;:false,&quot;Type&quot;:&quot;PURCHASEORDER&quot;,&quot;CurrencyRate&quot;:1.0,&quot;CurrencyCode&quot;:&quot;NZD&quot;,&quot;Contact&quot;:{&quot;ContactID&quot;:&quot;430fa14a-f945-44d3-9f97-5df5e28441b8&quot;,&quot;ContactStatus&quot;:&quot;ACTIVE&quot;,&quot;Name&quot;:&quot;Liam Gallagher&quot;,&quot;FirstName&quot;:&quot;Liam&quot;,&quot;LastName&quot;:&quot;Gallagher&quot;,&quot;Addresses&quot;:[{&quot;AddressType&quot;:&quot;POBOX&quot;,&quot;City&quot;:&quot;Anytown&quot;,&quot;Region&quot;:&quot;NY&quot;,&quot;PostalCode&quot;:&quot;10101&quot;,&quot;Country&quot;:&quot;USA&quot;,&quot;AttentionTo&quot;:&quot;&quot;}],&quot;Phones&quot;:[{&quot;PhoneType&quot;:&quot;DEFAULT&quot;,&quot;PhoneNumber&quot;:&quot;222-2222&quot;,&quot;PhoneAreaCode&quot;:&quot;212&quot;,&quot;PhoneCountryCode&quot;:&quot;&quot;},{&quot;PhoneType&quot;:&quot;FAX&quot;,&quot;PhoneNumber&quot;:&quot;333-2233&quot;,&quot;PhoneAreaCode&quot;:&quot;212&quot;,&quot;PhoneCountryCode&quot;:&quot;&quot;},{&quot;PhoneType&quot;:&quot;MOBILE&quot;,&quot;PhoneNumber&quot;:&quot;444-3433&quot;,&quot;PhoneAreaCode&quot;:&quot;212&quot;,&quot;PhoneCountryCode&quot;:&quot;&quot;}],&quot;UpdatedDateUTC&quot;:&quot;/Date(1551747281053+0000)/&quot;,&quot;ContactGroups&quot;:[],&quot;ContactPersons&quot;:[],&quot;HasValidationErrors&quot;:false},&quot;Status&quot;:&quot;DELETED&quot;,&quot;LineAmountTypes&quot;:&quot;Exclusive&quot;,&quot;LineItems&quot;:[{&quot;Description&quot;:&quot;Foobar&quot;,&quot;UnitAmount&quot;:20.0,&quot;TaxAmount&quot;:0.0,&quot;LineAmount&quot;:20.0,&quot;Tracking&quot;:[],&quot;Quantity&quot;:1.0,&quot;LineItemID&quot;:&quot;0f7b54b8-bfa4-4c5d-9c22-73dbd5796e54&quot;}],&quot;SubTotal&quot;:20.0,&quot;TotalTax&quot;:0.0,&quot;Total&quot;:20.0,&quot;UpdatedDateUTC&quot;:&quot;/Date(1552522703443+0000)/&quot;,&quot;HasAttachments&quot;:false},{&quot;PurchaseOrderID&quot;:&quot;6afa2e02-c514-4964-ab89-b5c0179b8c50&quot;,&quot;PurchaseOrderNumber&quot;:&quot;PO-0002&quot;,&quot;DateString&quot;:&quot;2019-03-12T00:00:00&quot;,&quot;Date&quot;:&quot;/Date(1552348800000+0000)/&quot;,&quot;AttentionTo&quot;:&quot;Jimmy&quot;,&quot;HasErrors&quot;:false,&quot;IsDiscounted&quot;:false,&quot;Type&quot;:&quot;PURCHASEORDER&quot;,&quot;CurrencyRate&quot;:1.0,&quot;CurrencyCode&quot;:&quot;NZD&quot;,&quot;Contact&quot;:{&quot;ContactID&quot;:&quot;430fa14a-f945-44d3-9f97-5df5e28441b8&quot;,&quot;ContactStatus&quot;:&quot;ACTIVE&quot;,&quot;Name&quot;:&quot;Liam Gallagher&quot;,&quot;FirstName&quot;:&quot;Liam&quot;,&quot;LastName&quot;:&quot;Gallagher&quot;,&quot;Addresses&quot;:[{&quot;AddressType&quot;:&quot;POBOX&quot;,&quot;City&quot;:&quot;Anytown&quot;,&quot;Region&quot;:&quot;NY&quot;,&quot;PostalCode&quot;:&quot;10101&quot;,&quot;Country&quot;:&quot;USA&quot;,&quot;AttentionTo&quot;:&quot;&quot;}],&quot;Phones&quot;:[{&quot;PhoneType&quot;:&quot;DEFAULT&quot;,&quot;PhoneNumber&quot;:&quot;222-2222&quot;,&quot;PhoneAreaCode&quot;:&quot;212&quot;,&quot;PhoneCountryCode&quot;:&quot;&quot;},{&quot;PhoneType&quot;:&quot;FAX&quot;,&quot;PhoneNumber&quot;:&quot;333-2233&quot;,&quot;PhoneAreaCode&quot;:&quot;212&quot;,&quot;PhoneCountryCode&quot;:&quot;&quot;},{&quot;PhoneType&quot;:&quot;MOBILE&quot;,&quot;PhoneNumber&quot;:&quot;444-3433&quot;,&quot;PhoneAreaCode&quot;:&quot;212&quot;,&quot;PhoneCountryCode&quot;:&quot;&quot;}],&quot;UpdatedDateUTC&quot;:&quot;/Date(1551747281053+0000)/&quot;,&quot;ContactGroups&quot;:[],&quot;ContactPersons&quot;:[],&quot;HasValidationErrors&quot;:false},&quot;Status&quot;:&quot;DELETED&quot;,&quot;LineAmountTypes&quot;:&quot;Exclusive&quot;,&quot;LineItems&quot;:[{&quot;Description&quot;:&quot;Foobar&quot;,&quot;UnitAmount&quot;:20.0,&quot;TaxAmount&quot;:0.0,&quot;LineAmount&quot;:20.0,&quot;Tracking&quot;:[],&quot;Quantity&quot;:1.0,&quot;LineItemID&quot;:&quot;3e4ec232-32b9-491b-84dd-48fb9aa8916f&quot;}],&quot;SubTotal&quot;:20.0,&quot;TotalTax&quot;:0.0,&quot;Total&quot;:20.0,&quot;UpdatedDateUTC&quot;:&quot;/Date(1552522834733+0000)/&quot;,&quot;HasAttachments&quot;:false}]}