Get Purchase Orders
Changed on| Property | Description |
|---|---|
| meta | useful links relating to this Purchase order |
| poID | The unique ID of the Purchase Order. |
| poNumber | The user-set Purchase Order number. |
| budgetID | The unique ID of the budget associated with this Purchase Order. |
| vendorID | The unique ID of the vendor associated with this Purchase Order. |
| locationID | The unique ID of the location associated with this Purchase Order. |
| userIDStarted | The unique ID of the user that started this Purchase Order. |
| userID | The unique ID of the user this Purchase Order is currently assigned to. |
| teamID | The unique ID of the team the user of this Purchase Order is currently assigned to. |
| requestedByUserID | The userID of the user that request this Purchase Order. A value of 0 means this PO wasn't requested, but was manually started by the userIDStarted. |
| date | The date this PO was started as a UNIX timestamp, or the date the user inputted for the Purchase Order. |
| expectedDate | The date this PO is expected as a UNIX timestamp to receive items. |
| billTo | The address that should receive the bill for the PO. |
| shipTo | The address the PO's items should be delivered to. |
| notesToVendor | Any notes sent to the vendor, possibly containing handling, packaging, or delivery instructions. |
| customField1 | PO custom field, the customer chooses which custom fields are available on all POs. |
| customField2 | PO custom field, the customer chooses which custom fields are available on all POs. |
| customField3 | PO custom field, the customer chooses which custom fields are available on all POs. |
| customField4 | PO custom field, the customer chooses which custom fields are available on all POs. |
| customField5 | PO custom field, the customer chooses which custom fields are available on all POs. |
| customField6 | PO custom field, the customer chooses which custom fields are available on all POs. |
| poPrefix | If a PO prefix is configured, it will show up here. |
| lastEdited | Last time this PO was edited as a UNIX timestamp. |
| status | This is the current status of a PO. Status of PO can be as follows:, 0: the PO has only been setup. (Status: Setup), 1-97: these are custom statuses based on the budget steps. Refer to "budgetSteps" in meta. (Status : {Name of the budgetStep it is on} ), 97: the PO is in the ready to receive step. This means items can be received for this PO. (Status: Ready to Receive), 98 all budget steps have been completed, but not all items on the PO have been received. This means only some items or partial qty of items have been received. (Status: Partially Received), 99: the PO is completed. This means all the items and their full qty on the PO have been received but not been paid for ( i.e. all the bills generated for this PO have not been marked as paid yet.) (Status: Fully Received - Pending Payment), 100: the PO is closed. This means all the items on the PO have been received and have been paid for. (i.e. all the bills for this PO have been marked as paid.) (Status: Closed) |
| stateDetails | JSON object containing details about the PO's current state, and available state transitions. |
| poNumberDisplay | Formatted display string with leading zeros and prefix. This is the PO Number the UI will display. |
Request
- Base URL{{server}}:{{port}}
- AuthHTTP basic
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
This parameter is used to only get specific POs. This parameter expects a comma delimited list of PO IDs.
This parameter is used to only get specific Vendors. This parameter expects a comma delimited list of Vendor IDs.
This parameter is used to only get POs at a specific group of Locations. This parameter accepts a comma delimited list of Location IDs.
This parameter is used to only get specific POs by Number. This parameter expects a comma delimited list of PO Numbers.
This parameter is a cursor that selects what poID you want to start receiving results at. e.g. passing 137 here will only get you PO with an id greater than 137.
This parameter is a result limiter. The default is set to return no more than 100 results at one time. Maximum allowed value is 1000.
This parameter is used to only get POs that were last edited after the unix timestamp passed into the start parameter. For example, all POs that were last edited after April 18th, 2018.
This parameter is used to only get POs that were last edited before the unix timestamp passed in.
This parameter is used to only get POs for a specific group of status.
This parameter is used to paginate results based on the limit. Refer to Pagination section for more information.
Response
Get Purchase Orders
Changes
- warning
for the
queryrequest parameterlimit, the max was set to1000.00 - warning
for the
queryrequest parameterlimit, the min was set to1.00 - info
added the non-success response with the status
- warning