v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB

Companies

Get Company PO by PO ID

Returns details about the specified company purchase order.

get/v1/company/purchase-order/{poId}

Path parameters

poIdstring required

The identifier for the purchase order to be retrieved.

Headers

RequestIdstring uuid

The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.

Unique request identifier (UUID) used to correlate request data with log entries and events.

FrontOfficeTenantIdinteger

An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.

Tenantstring

Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.

Response

The company purchase order.

po_IDinteger

The identifier for the purchase order.

po_compinteger

The identifier for the company.

po_numstring

The purchase order number.

po_amountnumber

The net amount of the purchase order.

po_amountusednumber

The used amount of the purchase order.

po_remainingnumber

The remaining amount of the purchase order.

po_thresholdnumber

The purchase order threshold amount.

po_notifyboolean

An indication of whether a notification email will be sent when the remaining amount reaches the threshold.

notify_usersstring

The IDs of the users who will be sent notification emails.

notify_sentboolean

An indication of whether a notification email has been sent to the specified users or not.

notify_sent_datestring date-time

The date when the notification was sent. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.

po_descriptionstring

The purchase order description.

is_activeboolean

An indication of whether the purchase order is active or inactive.

sendnotificationboolean

An indication of whether a notification email has been sent to the specified users or not.

comp_namestring

The name of the company associated with the purchase order.

Example response

{
  "po_ID": 12345,
  "po_comp": 12346,
  "po_num": "PO-12345",
  "po_amount": 1000,
  "po_amountused": 200,
  "po_remaining": 800,
  "po_threshold": 900,
  "po_notify": true,
  "notify_users": "12345,67890",
  "po_description": "Purchase order for office supplies",
  "is_active": true,
  "comp_name": "Acme Corporation"
}