purchase-orders

Revise a Purchase OrderDeprecated

Deprecated method for revising a purchase order. Pending removable after November 16, 2023. Use PUT on /api/v3/purchase-orders/{id} instead.

SecurityRemoteAuthentication or M2MAuthentication or BasicAuthentication or cookieAuth
Request
path Parameters
procurify_PO
required
integer (Procurify PO Number)

A unique integer value identifying this po.

query Parameters
confirm_duplicate_external_po_number
string
Default: "False"

Mechanism to check for duplicate custom PO number. If there is a duplicate, API will fail unless this query param is set to True.

Enum: "False" "True"
format
string
Enum: "csv" "json"
Request Body schema:
required
required
Array of objects (OrderItemPurchaseEditRequest)
Array of objects
Default: []
PO_Num
string or null (PO Number) <= 30 characters
buyer_name
required
string [ 1 .. 100 ] characters
buyer_contact
required
string [ 1 .. 100 ] characters
buyer_addressLineOne
required
string (Address line) [ 1 .. 300 ] characters
buyer_postalCode
required
string (Postal Code) [ 1 .. 20 ] characters
buyer_city
required
string [ 1 .. 50 ] characters
buyer_state_province
string (State/Province) <= 40 characters
buyer_country
required
string (Country) [ 1 .. 80 ] characters
buyer_address
required
integer
comment
string or null (Notes)
receiver_name
required
string [ 1 .. 100 ] characters
receiver_contact
required
string [ 1 .. 100 ] characters
receiver_addressLineOne
required
string (Address line) [ 1 .. 300 ] characters
receiver_postalCode
required
string (Postal Code) [ 1 .. 20 ] characters
receiver_city
required
string [ 1 .. 50 ] characters
receiver_state_province
string (State/Province) <= 40 characters
receiver_country
required
string (Country) [ 1 .. 80 ] characters
receiver_address
required
integer
promise_date
required
string <date-time>
freight
string or null <decimal> ^-?\d{0,13}(?:\.\d{0,6})?$
required
object
required
object
other
string or null <decimal> ^-?\d{0,13}(?:\.\d{0,6})?$
disclaimer_description
string or null <= 100 characters
disclaimer_text
string or null
payment_term_ref
integer or null
shipping_term_ref
integer or null
payment_method_ref
integer or null
shipping_method_ref
integer or null
creditcard
integer or null
version
required
integer
expiry_date
string or null <date-time>
contract
integer or null
Responses
200
Response Schema:
object
Default: {}
required
object (PurchaseOrderDetail)
put/api/v2/purchase_order/revise/{procurify_PO}/
Request samples
{
  • "order_items": [
    ],
  • "custom_fields": [ ],
  • "PO_Num": "string",
  • "buyer_name": "string",
  • "buyer_contact": "string",
  • "buyer_addressLineOne": "string",
  • "buyer_postalCode": "string",
  • "buyer_city": "string",
  • "buyer_state_province": "string",
  • "buyer_country": "string",
  • "buyer_address": 0,
  • "comment": "string",
  • "receiver_name": "string",
  • "receiver_contact": "string",
  • "receiver_addressLineOne": "string",
  • "receiver_postalCode": "string",
  • "receiver_city": "string",
  • "receiver_state_province": "string",
  • "receiver_country": "string",
  • "receiver_address": 0,
  • "promise_date": "2019-08-24T14:15:22Z",
  • "freight": "string",
  • "discount": {
    },
  • "tax": {
    },
  • "other": "string",
  • "disclaimer_description": "string",
  • "disclaimer_text": "string",
  • "payment_term_ref": 0,
  • "shipping_term_ref": 0,
  • "payment_method_ref": 0,
  • "shipping_method_ref": 0,
  • "creditcard": 0,
  • "version": 0,
  • "expiry_date": "2019-08-24T14:15:22Z",
  • "contract": 0
}
Response samples
{
  • "metadata": { },
  • "data": {
    }
}

Get Purchase Order by ID (with items)

Purchase Order State Codes

Order Type Code
PURCHASED 0
CANCELLED 1
(legacy code) 2
CLOSED 3
PAID 4
REOPENED 5
SecurityRemoteAuthentication or M2MAuthentication or BasicAuthentication or cookieAuth
Request
path Parameters
id
required
string

Procurify PO or UUID

query Parameters
format
string
Enum: "csv" "json"
Responses
200
Response Schema:
required
object (PermissionsEditDelete)
required
object (PurchaseOrderDetail)
get/api/v2/purchase_orders/{id}/
Response samples
{
  • "metadata": {
    },
  • "data": {
    }
}

Get Purchase Orders by Role & Status

SecurityRemoteAuthentication or M2MAuthentication or BasicAuthentication or cookieAuth
Request
path Parameters
role
required
string
Enum: "purchased" "receivable"
status
required
string
Enum: "all" "cancelled" "closed" "open" "paid" "partial"
query Parameters
account_code
integer

Account Code

contract
integer

Contract

date_0
string <date>

YYYY-MM-DD (start date): Filter POs by Created Date range

date_1
string <date>

YYYY-MM-DD (end date): Filter POs by Created Date range

expiry_date_0
string <date>

Expiry Date

expiry_date_1
string <date>

Expiry Date

has_blanket_order_items
boolean
modified_date_0
string <date>

YYYY-MM-DD (start date): Filter POs by Last Modified Date range

modified_date_1
string <date>

YYYY-MM-DD (end date): Filter POs by Last Modified Date range

order_by
string

Sort by field

page
integer
page_size
integer
pref_vendor
integer

ID of Vendor

promise_date_0
string <date>

YYYY-MM-DD (start date): Filter POs by Promise Date range

promise_date_1
string <date>

YYYY-MM-DD (end date): Filter POs by Promise Date range

requester
integer

Requester

Responses
200
Response Schema:
required
object (PurchaseOrderListMeta)
required
Array of objects (PurchaseOrderDocs)
get/api/v2/purchase_orders/{role}/{status}/
Response samples
{
  • "metadata": {
    },
  • "data": [
    ]
}

Update a Purchase Order

SecurityRemoteAuthentication or M2MAuthentication or BasicAuthentication or cookieAuth
Request
path Parameters
procurify_PO
required
integer (Procurify PO Number)

A unique integer value identifying this po.

query Parameters
format
string
Enum: "csv" "json"
Request Body schema:
required
required
Array of objects (OrderItemPurchaseEditRequest)
Array of objects
Default: []
PO_Num
string or null (PO Number) <= 30 characters
buyer_name
required
string [ 1 .. 100 ] characters
buyer_contact
required
string [ 1 .. 100 ] characters
buyer_addressLineOne
required
string (Address line) [ 1 .. 300 ] characters
buyer_postalCode
required
string (Postal Code) [ 1 .. 20 ] characters
buyer_city
required
string [ 1 .. 50 ] characters
buyer_state_province
string (State/Province) <= 40 characters
buyer_country
required
string (Country) [ 1 .. 80 ] characters
buyer_address
required
integer
comment
string or null (Notes)
receiver_name
required
string [ 1 .. 100 ] characters
receiver_contact
required
string [ 1 .. 100 ] characters
receiver_addressLineOne
required
string (Address line) [ 1 .. 300 ] characters
receiver_postalCode
required
string (Postal Code) [ 1 .. 20 ] characters
receiver_city
required
string [ 1 .. 50 ] characters
receiver_state_province
string (State/Province) <= 40 characters
receiver_country
required
string (Country) [ 1 .. 80 ] characters
receiver_address
required
integer
promise_date
required
string <date-time>
freight
string or null <decimal> ^-?\d{0,13}(?:\.\d{0,6})?$
required
object
required
object
other
string or null <decimal> ^-?\d{0,13}(?:\.\d{0,6})?$
disclaimer_description
string or null <= 100 characters
disclaimer_text
string or null
payment_term_ref
integer or null
shipping_term_ref
integer or null
payment_method_ref
integer or null
shipping_method_ref
integer or null
creditcard
integer or null
version
required
integer
expiry_date
string or null <date-time>
contract
integer or null
Responses
200
Response Schema:
object
Default: {}
required
object (PurchaseOrderUpdate)
put/api/v3/purchase-orders/{procurify_PO}/
Request samples
{
  • "order_items": [
    ],
  • "custom_fields": [ ],
  • "PO_Num": "string",
  • "buyer_name": "string",
  • "buyer_contact": "string",
  • "buyer_addressLineOne": "string",
  • "buyer_postalCode": "string",
  • "buyer_city": "string",
  • "buyer_state_province": "string",
  • "buyer_country": "string",
  • "buyer_address": 0,
  • "comment": "string",
  • "receiver_name": "string",
  • "receiver_contact": "string",
  • "receiver_addressLineOne": "string",
  • "receiver_postalCode": "string",
  • "receiver_city": "string",
  • "receiver_state_province": "string",
  • "receiver_country": "string",
  • "receiver_address": 0,
  • "promise_date": "2019-08-24T14:15:22Z",
  • "freight": "string",
  • "discount": {
    },
  • "tax": {
    },
  • "other": "string",
  • "disclaimer_description": "string",
  • "disclaimer_text": "string",
  • "payment_term_ref": 0,
  • "shipping_term_ref": 0,
  • "payment_method_ref": 0,
  • "shipping_method_ref": 0,
  • "creditcard": 0,
  • "version": 0,
  • "expiry_date": "2019-08-24T14:15:22Z",
  • "contract": 0
}
Response samples
{
  • "metadata": { },
  • "data": {
    }
}

Close a Purchase Order

SecurityRemoteAuthentication or M2MAuthentication or BasicAuthentication or cookieAuth
Request
path Parameters
procurify_PO
required
integer (Procurify PO Number)

A unique integer value identifying this po.

query Parameters
format
string
Enum: "csv" "json"
Responses
200
Response Schema:
object
Default: {}
required
object (PurchaseOrderReadDocs)
post/api/v3/purchase-orders/{procurify_PO}/close/
Response samples
{
  • "metadata": { },
  • "data": {
    }
}

Reopen a Purchase Order

SecurityRemoteAuthentication or M2MAuthentication or BasicAuthentication or cookieAuth
Request
path Parameters
procurify_PO
required
integer (Procurify PO Number)

A unique integer value identifying this po.

query Parameters
format
string
Enum: "csv" "json"
Responses
200

No response body

post/api/v3/purchase-orders/{procurify_PO}/reopen/

View billing history of a Purchase Order

SecurityRemoteAuthentication or M2MAuthentication or BasicAuthentication or cookieAuth
Request
query Parameters
format
string
Enum: "csv" "json"
Responses
200
Response Schema:
object
Default: {}
required
Array of objects (PurchaseOrderBillingHistory)
get/api/v3/purchase-orders/billing-history/
Response samples
{
  • "metadata": { },
  • "data": [
    ]
}
➔ Next to order-items