WAwafeq
Purchase Orders

Retrieve purchase order

Changed on

Endpoint for retrieving a single purchase order.

get/purchase-orders/{id}/

Request

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

Path parameters

idstring required

Query parameters

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.

Response

amountnumber double required

The total amount of the purchase order, including taxes and discounts.

attachmentsstring[]

List of attachments linked to this purchase order.

branchstring nullable

The branch associated with this purchase order, if applicable.

contactstring

The contact (vendor) associated with this purchase order.

created_tsstring date-time required

The timestamp in UTC when the purchase order was created.

currency'AED' | 'SAR' | 'USD' | 'EUR' | 'CAD' | 'AFN' | 'ALL' | 'AMD' | 'ARS' | 'AUD' | 'AZN' | 'BAM' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BND' | 'BOB' | 'BRL' | 'BWP' | 'BYN' | 'BZD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'GBP' | 'GEL' | 'GHS' | 'GNF' | 'GTQ' | 'HKD' | 'HNL' | 'HRK' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KZT' | 'LBP' | 'LKR' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MOP' | 'MUR' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SDG' | 'SEK' | 'SGD' | 'SOS' | 'SYP' | 'THB' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYU' | 'UZS' | 'VES' | 'VND' | 'XAF' | 'XOF' | 'YER' | 'ZAR' | 'ZMW' required

An ISO 4217 currency code.

View the enum reference

custom_fieldsobject

A mapping of custom field IDs to their values.

exchange_ratenumber double nullable

The exchange rate to the organization base currency at the time of the document.

external_idstring

External identifier for the purchase order.

idstring required

The unique identifier of the purchase order.

language'en' | 'ar'

The language of a document or response.

View the enum reference

legacy_idstring required

[Deprecated] The legacy identifier of the purchase order.

modified_tsstring date-time required

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

notesstring

Any additional notes or comments related to the purchase order.

projectstring nullable

The project associated with this purchase order, if any.

purchase_order_datestring date nullable

The date when the purchase order was issued.

purchase_order_numberstring

The unique identifier or number assigned to this purchase order.

referencestring

Any additional reference information for this purchase order.

status'DRAFT' | 'SENT' | 'BILLED' | 'VOIDED'

The lifecycle status of a purchase order.

View the enum reference

tax_amountnumber double required

The total tax amount applied to the purchase order.

tax_amount_type'TAX_INCLUSIVE' | 'TAX_EXCLUSIVE'

Whether amounts include or exclude tax.

View the enum reference

termsstring

The terms and conditions of the purchase order.

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