WAwafeq
Purchase Orders

List purchase orders

Changed on

Endpoint for retrieving a list of purchase orders.

get/purchase-orders/

Request

  • Base URL
    https://api.wafeq.com/v1
  • URL
    https://api.wafeq.com/v1/purchase-orders/
  • Auth
    API key in header Authorization

Query parameters

branchstring

The unique identifier of the branch.

contactstring

The unique identifier of the contact.

created_ts_afterstring date-time

The timestamp in UTC when the purchase order was created.

created_ts_beforestring date-time

The timestamp in UTC when the purchase order was created.

expandstring

Comma-separated related objects to return in full instead of as IDs. Accepted values: attachments, branch, contact, contact.persons, line_items, line_items.account, line_items.cost_center, line_items.item, line_items.tax_rate, project. Nested relations are joined with a dot.

external_idstring

External identifier.

modified_ts_afterstring date-time

The timestamp in UTC when the purchase order was last modified.

modified_ts_beforestring date-time

The timestamp in UTC when the purchase order was last modified.

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

projectstring

The unique identifier of the project.

purchase_order_datestring date

The date of the purchase order.

referencestring

Reference.

statusstring

The status of the purchase order.

Response

countinteger required

The total number of results across all pages.

nextstring uri nullable

The URL of the next page of results, or null on the last page.

previousstring uri nullable

The URL of the previous page of results, or null on the first page.

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}

Changes

  • b8f5e10134b4Revision changes
    • breaking

      the // response's property type changed from string to no type for status

    • info

      added the new optional query request parameter expand

    • info

      added to the // response property allOf list for the response status

    • info

      removed the ar enum value from the // response property for the response status

    • info

      removed the en enum value from the // response property for the response status