Skip to main content

Get specified purchase order

Request

Returns single purchase order

Security
BearerAuth
Path
accountNumberstringrequired

Number of account to search by

Example:100013200
numberstringrequired

purchase order number

Example:PO-1234567
Payload
// No request payload

Responses

Purchase orders matching criteria

Bodyapplication/json
typestring(PurchaseOrderType)required

Purchase order type

Enum:"STANDARD_PURCHASE_ORDER""BLANKET_PURCHASE_ORDER"
numberstringrequired

Purchase order number

Example:"10010"
accountobject(PurchaseOrderAccount)required
categoriesArray of stringsrequired
Items Enum:"ALL_SERVICES""INTERCONNECTION""NETWORK""POWER""SPACE""SMART_HANDS""SERVICES"
locationsArray of objects(PurchaseOrder_locations)required
amountnumber, (double)required

Amount

Example:10000.5
startDatestring, (date)

Start date in YYYY-MM-DD format

endDatestring, (date)

End date in YYYY-MM-DD format

descriptionstring

Purchase order description

Example:"Purchase order desc"
draftboolean, (boolean)required

Is draft

Example:false
statusstring(PurchaseOrderStatus)
Enum:"DRAFT""ACTIVE"
Example:"DRAFT"
currencystring(CurrencyCode)required

Currency codes

Enum:"AED""AFN""ALL""AMD""ANG""AOA""ARS""AUD""AWG""AZN"
Example:"USD"
Response
{ "type": "STANDARD_PURCHASE_ORDER", "number": "10010", "account": { "accountNumber": "123123" }, "categories": [ "ALL_SERVICES" ], "locations": [ { … } ], "amount": 10000.5, "startDate": "2019-08-24", "endDate": "2019-08-24", "description": "Purchase order desc", "draft": false, "status": "DRAFT", "currency": "USD" }
Was this page helpful?