Download OpenAPI specification:Download
Getting access to Procurify API involves the following three steps:
The first step is to request credentials from Procurify. Your role must have access to manage integrations settings in order to request API credentials. You can request API credentials by going to go:
This page will allow you to enter an optional description of the application you are developing with the Procurify API and once you are ready, click on “Create Application”. On the next screen, you will be presented with a Client ID and a Client Secret. You will need to copy and save these credentials securely. Please note that the Client Secret is only presented once.
Once you have the client credentials, you will need to request an access token using these credentials that can be used as a bearer token when making a request to Procurify API. You will need the following information to request an access token:
Info | Value |
---|---|
Token URL: | https://<your-domain>.procurify.com/oauth/token |
Client ID: | From the previous step |
Client Secret: | From the previous step |
Audience: | https://api.procurify.com/ |
Grant Type: | client_credentials |
Once you have the access token, you will need to cache it until it expires (24 hrs). Please let Procurify support know if you would like help with this.
An example request and response using cURL (replace client id and client secret)
$ curl -H "content-type: application/json" -X POST \
-d '{"client_id": "~your_client_id~", \
"client_secret": "~your_client_secret~", \
"audience": "https://api.procurify.com/", \
"grant_type": "client_credentials"}' \
https://<your-domain>.procurify.com/oauth/token
{"access_token": "~your-access-token~",
"scope": "urn:procurify-api:domain:~your_domain~ urn:procurify-api:email:~your_email~",
"expires_in": 86400,
"token_type": "Bearer"}
Once you have the access token, you can make requests to Procurify API resources. You will need to set the following headers when making the request.
Key | Value |
---|---|
Authorization: | Bearer access_token from previous step |
X-Procurify-Client: | api |
An example request and response using cURL (replace access token and your procurify domain)
$ curl -H "Authorization: Bearer ~access_token~" \
-H "X-Procurify-Client: api" \
https://<your-domain>.procurify.com/api/v3/vendors/
{"data":[{"id":1,"name":"OTHER","active":true,"addressLineOne":"OTHER"...}
{- "client_id": "~your_client_id~",
- "client_secret": "~your_client_secret~",
- "grant_type": "client_credentials"
}
{- "access_token": "~your-access-token~",
- "scope": "urn:procurify-api:domain:~your_domain~ urn:procurify-api:email:~your_email~",
- "expires_in": 86400,
- "token_type": "Bearer"
}
object | |
Array of objects (PermissionRead) |
{- "metadata": {
- "pagination": {
- "count": 10,
- "next": null,
- "previous": null,
- "page_size": 10,
- "num_pages": 1,
- "current_page": 1
}
}, - "data": [
- {
- "id": 507,
- "codename": "add_bill"
}
]
}
object | |
Array of objects (PermissionGroup) |
{- "metadata": {
- "pagination": {
- "count": 10,
- "next": null,
- "previous": null,
- "page_size": 10,
- "num_pages": 1,
- "current_page": 1
}
}, - "data": [
- {
- "id": 5,
- "name": "Approver",
- "user_count": 0,
- "permissions": [
- {
- "id": 900,
- "codename": "view_reports"
}, - {
- "id": 982,
- "codename": "view_reports_budgets"
}, - {
- "id": 977,
- "codename": "view_reports_expenses_by_department"
}, - {
- "id": 976,
- "codename": "view_reports_orders_by_department"
}, - {
- "id": 975,
- "codename": "view_reports_orders_by_user"
}, - {
- "id": 974,
- "codename": "view_reports_orders_by_vendor"
}, - {
- "id": 101,
- "codename": "add_expensereport"
}, - {
- "id": 887,
- "codename": "approve_expensereport"
}, - {
- "id": 71,
- "codename": "add_order"
}, - {
- "id": 886,
- "codename": "approve_order"
}, - {
- "id": 95,
- "codename": "add_travel"
}, - {
- "id": 888,
- "codename": "approve_travel"
}
], - "type": 1
}
]
}
object | |
Array of objects (UserProfileUnoptimized) |
{- "metadata": {
- "pagination": {
- "count": 10,
- "next": null,
- "previous": null,
- "page_size": 10,
- "num_pages": 1,
- "current_page": 1
}
}, - "data": [
- {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "user": 0,
- "email": "user@example.com",
- "department": {
- "id": 0,
- "name": "string",
- "location": {
- "id": 0,
- "name": "string",
- "headquarter": true
}
}, - "location": {
- "id": 0,
- "name": "string",
- "headquarter": true
}, - "profile_image": "string",
- "is_active": true,
- "phone": "string",
- "position": "string",
- "role": {
- "id": 0,
- "name": "string",
- "type": 0
}, - "approval_delegatee": {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}, - "pending_approvals_count": {
- "order": 0,
- "expense": 0,
- "travel": 0,
- "bill": 0,
- "payment": 0
}, - "expected_return_date": "2019-08-24"
}
]
}
object Default: {} | |
required | Array of objects (UserProfileUnoptimized) |
[- {
- "email": "user@example.com",
- "send_invitation_email": true,
- "first_name": "",
- "last_name": "",
- "phone": "",
- "position": "",
- "role_id": 0,
- "all_locations": false,
- "locations": [ ],
- "home_department": 0,
- "home_location": 0
}
]
{- "metadata": { },
- "data": [
- {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "user": 0,
- "email": "user@example.com",
- "department": {
- "id": 0,
- "name": "string",
- "location": {
- "id": 0,
- "name": "string",
- "headquarter": true
}
}, - "location": {
- "id": 0,
- "name": "string",
- "headquarter": true
}, - "profile_image": "string",
- "is_active": true,
- "phone": "string",
- "position": "string",
- "role": {
- "id": 0,
- "name": "string",
- "type": 0
}, - "approval_delegatee": {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}, - "pending_approvals_count": {
- "order": 0,
- "expense": 0,
- "travel": 0,
- "bill": 0,
- "payment": 0
}, - "expected_return_date": "2019-08-24"
}
]
}
object Default: {} | |
required | object (UserProfileUnoptimized) |
{- "id": 0,
- "user": 0,
- "email": "user@example.com",
- "firstName": "string",
- "lastName": "string",
- "location": 0,
- "department": 0,
- "position": "",
- "phone": "",
- "profile_image": "string",
- "is_sso_enabled": false,
- "mark_for_skip": false,
- "mark_for_delete": false
}
{- "metadata": { },
- "data": {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "user": 0,
- "email": "user@example.com",
- "department": {
- "id": 0,
- "name": "string",
- "location": {
- "id": 0,
- "name": "string",
- "headquarter": true
}
}, - "location": {
- "id": 0,
- "name": "string",
- "headquarter": true
}, - "profile_image": "string",
- "is_active": true,
- "phone": "string",
- "position": "string",
- "role": {
- "id": 0,
- "name": "string",
- "type": 0
}, - "approval_delegatee": {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}, - "pending_approvals_count": {
- "order": 0,
- "expense": 0,
- "travel": 0,
- "bill": 0,
- "payment": 0
}, - "expected_return_date": "2019-08-24"
}
}
Get the logged in user account information
object Default: {} | |
required | object (UserProfileMe) |
{- "data": {
- "id": 2,
- "domains": {
- "active": false,
- "procurify_domains": [
- {
- "subdomain": "example.com",
- "name": "example.com"
}
]
}, - "systemaccess_cache": {
- "structured": {
- "1": {
- "flattened": [
- "nav_receive",
- "nav_approval",
- "nav_manage",
- "nav_request",
- "nav_purchase",
- "nav_report",
- "nav_setting"
], - "roles": [
- {
- "permissions": [
- {
- "id": 3,
- "description": "Navigation for Request",
- "name": "Request"
}, - {
- "id": 4,
- "description": "Navigation for Approval",
- "name": "Approval"
}, - {
- "id": 5,
- "description": "Navigation for Purchase",
- "name": "Purchase"
}, - {
- "id": 6,
- "description": "Navigation for Receive",
- "name": "Receive"
}, - {
- "id": 7,
- "description": "Navigation for Manage",
- "name": "Manage"
}, - {
- "id": 8,
- "description": "Navigation for Settings",
- "name": "Settings"
}, - {
- "id": 9,
- "description": "Navigation for Report",
- "name": "Report"
}
], - "id": 15,
- "name": "Location Manager"
}
]
}, - "2": {
- "flattened": [
- "nav_request",
- "nav_approval",
- "nav_report"
], - "roles": [
- {
- "permissions": [
- {
- "id": 3,
- "description": "Navigation for Request",
- "name": "Request"
}, - {
- "id": 4,
- "description": "Navigation for Approval",
- "name": "Approval"
}, - {
- "id": 9,
- "description": "Navigation for Report",
- "name": "Report"
}
], - "id": 25,
- "name": "Approver"
}
]
}, - "3": {
- "flattened": [
- "nav_request",
- "nav_approval",
- "nav_report"
], - "roles": [
- {
- "permissions": [
- {
- "id": 3,
- "description": "Navigation for Request",
- "name": "Request"
}, - {
- "id": 4,
- "description": "Navigation for Approval",
- "name": "Approval"
}, - {
- "id": 9,
- "description": "Navigation for Report",
- "name": "Report"
}
], - "id": 25,
- "name": "Approver"
}
]
}, - "system": {
- "flattened": [
- "superuser",
- "accounts_payable"
], - "roles": [
- {
- "permissions": [
- {
- "id": 2,
- "description": "Full Access",
- "name": "Superuser"
}
], - "id": 2,
- "name": "Superuser"
}, - {
- "permissions": [
- {
- "id": 12,
- "description": "Accounts Payable",
- "name": "Accounts Payable"
}
], - "id": 31,
- "name": "AP"
}
]
}
}, - "flattened": [
- "superuser",
- "nav_manage",
- "nav_request",
- "nav_purchase",
- "accounts_payable",
- "nav_receive",
- "nav_setting",
- "nav_approval",
- "nav_report"
]
}, - "approval_delegatee": null,
- "is_approval_delegatee": false,
- "department": {
- "branch": {
- "name": "",
- "url": "",
- "logo": null,
- "currency": {
- "name": "",
- "description": "",
- "rate": null,
- "base": false,
- "active": false
}, - "phoneOne": "",
- "fax": "",
- "email": "",
- "primary_billing_address": {
- "name": "",
- "addressLineOne": "",
- "city": "",
- "postalCode": "",
- "state_province": "",
- "country": ""
}, - "primary_shipping_address": {
- "name": "",
- "addressLineOne": "",
- "city": "",
- "postalCode": "",
- "state_province": "",
- "country": ""
}, - "language": null,
- "locationTimezone": null,
- "active": false,
- "external_id": ""
}, - "external_id": "",
- "name": "",
- "active": false
}, - "created_at": "2017-03-17T21:45:36.120222Z",
- "updated_at": "2017-03-24T00:55:40.724146Z",
- "firstName": "Frank",
- "lastName": "Borman",
- "email": "nick+redshift7@procurify.com",
- "position": "",
- "phone": "-",
- "address": "",
- "notifications": true,
- "is_active": true,
- "pending_invite": false,
- "role": 7,
- "mobile": false,
- "profile_image": "nickredshift7procurifycom_aa1fbc9b_frank-borman.jpg",
- "slack_user_id": "",
- "is_sso_enabled": false,
- "last_changed_by": null,
- "user": 2
}, - "metadata": { }
}
object | |
Array of objects (LocationViewSerializerList) |
{- "metadata": {
- "pagination": {
- "count": 10,
- "next": null,
- "previous": null,
- "page_size": 10,
- "num_pages": 1,
- "current_page": 1
}
}, - "data": [
- {
- "metadata": { },
- "data": [
- {
- "id": 0,
- "name": "string",
- "logo": "string",
- "currency": {
- "id": 0,
- "name": "string",
- "description": "string",
- "rate": "string",
- "base": true,
- "active": true
}, - "phoneOne": "string",
- "fax": "string",
- "email": "user@example.com",
- "primary_billing_address": {
- "id": 0,
- "name": "string",
- "addressLineOne": "string",
- "city": "string",
- "postalCode": "string",
- "state_province": "string",
- "country": "string"
}, - "primary_shipping_address": {
- "id": 0,
- "name": "string",
- "addressLineOne": "string",
- "city": "string",
- "postalCode": "string",
- "state_province": "string",
- "country": "string"
}, - "shipping_addresses": [
- {
- "id": 0,
- "name": "string",
- "addressLineOne": "string",
- "city": "string",
- "postalCode": "string",
- "state_province": "string",
- "country": "string"
}
], - "language": 1,
- "locationTimezone": "Africa/Abidjan",
- "headquarter": true,
- "department_count": 0,
- "active": true,
- "external_id": "string"
}
]
}
]
}
Create New Location. Note: only users with superuser permission can create locations.
object Default: {} | |
required | object (LocationView) |
{- "name": "string",
- "url": "string",
- "logo": "string",
- "currency": "string",
- "phoneOne": "string",
- "fax": "string",
- "email": "user@example.com",
- "primary_billing_address": {
- "name": "string",
- "addressLineOne": "string",
- "city": "string",
- "postalCode": "string",
- "state_province": "string",
- "country": "string"
}, - "primary_shipping_address": {
- "name": "string",
- "addressLineOne": "string",
- "city": "string",
- "postalCode": "string",
- "state_province": "string",
- "country": "string"
}, - "shipping_addresses": [
- {
- "name": "string",
- "addressLineOne": "string",
- "city": "string",
- "postalCode": "string",
- "state_province": "string",
- "country": "string"
}
], - "language": 1,
- "locationTimezone": "Africa/Abidjan",
- "active": true,
- "external_id": "string"
}
{- "metadata": { },
- "data": {
- "id": 0,
- "name": "string",
- "logo": "string",
- "currency": {
- "id": 0,
- "name": "string",
- "description": "string",
- "rate": "string",
- "base": true,
- "active": true
}, - "phoneOne": "string",
- "fax": "string",
- "email": "user@example.com",
- "primary_billing_address": {
- "id": 0,
- "name": "string",
- "addressLineOne": "string",
- "city": "string",
- "postalCode": "string",
- "state_province": "string",
- "country": "string"
}, - "primary_shipping_address": {
- "id": 0,
- "name": "string",
- "addressLineOne": "string",
- "city": "string",
- "postalCode": "string",
- "state_province": "string",
- "country": "string"
}, - "shipping_addresses": [
- {
- "id": 0,
- "name": "string",
- "addressLineOne": "string",
- "city": "string",
- "postalCode": "string",
- "state_province": "string",
- "country": "string"
}
], - "language": 1,
- "locationTimezone": "Africa/Abidjan",
- "headquarter": true,
- "department_count": 0,
- "active": true,
- "external_id": "string"
}
}
object Default: {} | |
required | object (LocationView) |
{- "metadata": { },
- "data": {
- "id": 0,
- "name": "string",
- "logo": "string",
- "currency": {
- "id": 0,
- "name": "string",
- "description": "string",
- "rate": "string",
- "base": true,
- "active": true
}, - "phoneOne": "string",
- "fax": "string",
- "email": "user@example.com",
- "primary_billing_address": {
- "id": 0,
- "name": "string",
- "addressLineOne": "string",
- "city": "string",
- "postalCode": "string",
- "state_province": "string",
- "country": "string"
}, - "primary_shipping_address": {
- "id": 0,
- "name": "string",
- "addressLineOne": "string",
- "city": "string",
- "postalCode": "string",
- "state_province": "string",
- "country": "string"
}, - "shipping_addresses": [
- {
- "id": 0,
- "name": "string",
- "addressLineOne": "string",
- "city": "string",
- "postalCode": "string",
- "state_province": "string",
- "country": "string"
}
], - "language": 1,
- "locationTimezone": "Africa/Abidjan",
- "headquarter": true,
- "department_count": 0,
- "active": true,
- "external_id": "string"
}
}
object | |
Array of objects (DepartmentRead) |
{- "metadata": {
- "pagination": {
- "count": 10,
- "next": null,
- "previous": null,
- "page_size": 10,
- "num_pages": 1,
- "current_page": 1
}
}, - "data": [
- {
- "id": 0,
- "branch": {
- "id": 0,
- "name": "string",
- "headquarter": true
}, - "external_id": "string",
- "name": "string",
- "active": true,
- "punchout_email": "string",
- "is_active_for_account_code": true
}
]
}
object Default: {} | |
required | object (DepartmentRead) |
{- "branch": 0,
- "external_id": "string",
- "name": "string",
- "active": true,
- "punchout_email": "string"
}
{- "metadata": { },
- "data": {
- "id": 0,
- "branch": {
- "id": 0,
- "name": "string",
- "headquarter": true
}, - "external_id": "string",
- "name": "string",
- "active": true,
- "punchout_email": "string",
- "is_active_for_account_code": true
}
}
object Default: {} | |
required | object (DepartmentRead) |
{- "branch": 0,
- "external_id": "string",
- "name": "string",
- "active": true,
- "punchout_email": "string"
}
{- "metadata": { },
- "data": {
- "id": 0,
- "branch": {
- "id": 0,
- "name": "string",
- "headquarter": true
}, - "external_id": "string",
- "name": "string",
- "active": true,
- "punchout_email": "string",
- "is_active_for_account_code": true
}
}
Account Code Types
Account Code Type | Type |
---|---|
ASSETS | 0 |
LIABILITY | 1 |
EXPENSE | 2 |
INCOME | 3 |
EQUITY | 4 |
OTHER | 5 |
object | |
Array of objects (AccountCodeRead) |
{- "metadata": {
- "pagination": {
- "count": 10,
- "next": null,
- "previous": null,
- "page_size": 10,
- "num_pages": 1,
- "current_page": 1
}
}, - "data": [
- {
- "id": 0,
- "applied_accounts_count": 0,
- "code": "string",
- "code_length": -2147483648,
- "description": "string",
- "account_type": 0,
- "active": true,
- "parent": 0
}
]
}
Account Code Types
Account Code Type | Type |
---|---|
ASSETS | 0 |
LIABILITY | 1 |
EXPENSE | 2 |
INCOME | 3 |
EQUITY | 4 |
OTHER | 5 |
object Default: {} | |
required | object (AccountCodeRead) |
{- "code": "string",
- "description": "string",
- "parent": 0,
- "account_type": 0,
- "departments": [
- 0
]
}
{- "metadata": { },
- "data": {
- "id": 0,
- "applied_accounts_count": 0,
- "code": "string",
- "code_length": -2147483648,
- "description": "string",
- "account_type": 0,
- "active": true,
- "parent": 0
}
}
Account Code Types
Account Code Type | Type |
---|---|
ASSETS | 0 |
LIABILITY | 1 |
EXPENSE | 2 |
INCOME | 3 |
EQUITY | 4 |
OTHER | 5 |
object Default: {} | |
required | object (AccountCodeRead) |
{- "code": "string",
- "description": "string",
- "account_type": 0,
- "parent": 0
}
{- "metadata": { },
- "data": {
- "id": 0,
- "applied_accounts_count": 0,
- "code": "string",
- "code_length": -2147483648,
- "description": "string",
- "account_type": 0,
- "active": true,
- "parent": 0
}
}
object | |
Array of objects (ChartOfAccountsAccount) |
{- "metadata": {
- "pagination": {
- "count": 10,
- "next": null,
- "previous": null,
- "page_size": 10,
- "num_pages": 1,
- "current_page": 1
}
}, - "data": [
- {
- "id": 0,
- "account_code": {
- "id": 0,
- "applied_accounts_count": 0,
- "code": "string",
- "code_length": -2147483648,
- "description": "string",
- "account_type": 0,
- "active": true,
- "parent": 0
}, - "department": {
- "id": 0,
- "branch": {
- "id": 0,
- "name": "string",
- "headquarter": true
}, - "external_id": "string",
- "name": "string",
- "active": true,
- "punchout_email": "string",
- "is_active_for_account_code": true
}, - "start_datetime": "2019-08-24T14:15:22Z",
- "end_datetime": "2019-08-24T14:15:22Z",
- "budget": "string",
- "budget_used_approved": "string",
- "budget_used_purchased": "string",
- "balance_approved": "string",
- "balance_purchased": "string",
- "active": true
}
]
}
Vendor Type Codes
Vendor Type | Type | Description |
---|---|---|
OTHER | 1 | Previously 'OTHER' vendor (ID=1), used for storing non-vendor |
for storing non-vendor Vendor names in request. | ||
HIDDEN | 2 | New type of vendors that is reserved for system purposes (eg. Amazon Business). |
PREFERRED (default) | 3 | The default vendors from previous list |
where active vendor dropdowns everywhere previously showed. | ||
Request now ONLY shows these vendors (+OTHER) | ||
REGULAR | 4 | New type of vendors that are non-preferred, |
for any AP purposes and purchasers to update. | ||
(DOES NOT show up in Request, but shows up in Procure) | ||
EMPLOYEE | 5 | New type of vendors that do not show up anywhere except in AP employees list. |
CC_PROVIDER | 6 | Similar type of vendors to AP employees, but for AP credit card providers. |
object | |
Array of objects (OptimizedVendor) |
{- "metadata": {
- "pagination": {
- "count": 10,
- "next": null,
- "previous": null,
- "page_size": 10,
- "num_pages": 1,
- "current_page": 1
}
}, - "data": [
- {
- "id": 0,
- "name": "string",
- "active": true,
- "addressLineOne": "string",
- "addressLineTwo": "string",
- "postalCode": "string",
- "city": "string",
- "state_province": "string",
- "country": "string",
- "phoneOne": "string",
- "phoneTwo": "string",
- "fax": "string",
- "email": [
- "user@example.com"
], - "comments": "string",
- "contact": "string",
- "url": "string",
- "external_id": "string",
- "dateModified": "2019-08-24T14:15:22Z",
- "currency": 0,
- "payment_term_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "shipping_term_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "payment_method_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "shipping_method_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "payment_methods": [
- {
- "id": 0,
- "name": "string",
- "type": 0,
- "data": null,
- "currency": {
- "id": 0,
- "name": "string",
- "description": "string",
- "rate": "string",
- "base": true,
- "active": true
}
}
], - "tax": 0,
- "type": 2,
- "default_payment_method": 0,
- "creditcards": [
- {
- "id": 0,
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "is_active": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "number": "string",
- "balance": -2147483648,
- "gl_code": "string",
- "type": 0,
- "category": 0,
- "external_id": "string",
- "status": "pending",
- "require_activation": true,
- "last_changed_by": 0,
- "vendor": 0,
- "payment_method": 0,
- "currency": 0,
- "currency_name": "string",
- "creator": 0,
- "assignees": [
- {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "profile_image": "string"
}
]
}
], - "is_1099_eligible": true,
- "overall_score": "string",
- "is_auto_email_po_enabled": true,
- "po_pdf_labels": "string",
- "vendor_request": {
- "id": 0,
- "requester": "string",
- "submitted_date": "2019-08-24T14:15:22Z",
- "next_approver": "string",
- "permissions": {
- "property1": null,
- "property2": null
}
}
}
]
}
Create a new vendor
Due to having multiple vendors with the same name, especially common if user keeps deleting vendors with the same name, these deleted vendors get thrown into the inactive list.
Vendor Types
Vendor Type | Type |
---|---|
OTHER | 1 |
HIDDEN | 2 |
PREFERRED (default) | 3 |
REGULAR | 4 |
EMPLOYEE | 5 |
CC_PROVIDER | 6 |
object Default: {} | |
required | object (VendorDetail) |
{- "name": "string",
- "active": true,
- "addressLineOne": "string",
- "addressLineTwo": "string",
- "postalCode": "string",
- "city": "string",
- "state_province": "string",
- "country": "string",
- "phoneOne": "string",
- "phoneTwo": "string",
- "fax": "string",
- "email": [
- "user@example.com"
], - "comments": "string",
- "contact": "string",
- "url": "string",
- "external_id": "string",
- "currency": 0,
- "payment_term_ref": {
- "name": "string",
- "description": "string",
- "active": true
}, - "shipping_term_ref": {
- "name": "string",
- "description": "string",
- "active": true
}, - "payment_method_ref": {
- "name": "string",
- "description": "string",
- "active": true
}, - "shipping_method_ref": {
- "name": "string",
- "description": "string",
- "active": true
}, - "tax": 0,
- "type": 2,
- "default_payment_method": 0,
- "is_1099_eligible": true,
- "overall_score": "string",
- "is_auto_email_po_enabled": true,
- "po_pdf_labels": "string"
}
{- "metadata": { },
- "data": {
- "id": 0,
- "name": "string",
- "active": true,
- "addressLineOne": "string",
- "addressLineTwo": "string",
- "postalCode": "string",
- "city": "string",
- "state_province": "string",
- "country": "string",
- "phoneOne": "string",
- "phoneTwo": "string",
- "fax": "string",
- "email": [
- "string"
], - "comments": "string",
- "contact": "string",
- "url": "string",
- "external_id": "string",
- "dateModified": "2019-08-24T14:15:22Z",
- "currency": 0,
- "payment_term_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "shipping_term_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "payment_method_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "shipping_method_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "payment_methods": [
- {
- "id": 0,
- "name": "string",
- "type": 0,
- "data": null,
- "currency": {
- "id": 0,
- "name": "string",
- "description": "string",
- "rate": "string",
- "base": true,
- "active": true
}
}
], - "tax": 0,
- "type": 2,
- "default_payment_method": 0,
- "creditcards": [
- {
- "id": 0,
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "is_active": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "number": "string",
- "balance": -2147483648,
- "gl_code": "string",
- "type": 0,
- "category": 0,
- "external_id": "string",
- "status": "pending",
- "require_activation": true,
- "last_changed_by": 0,
- "vendor": 0,
- "payment_method": 0,
- "currency": 0,
- "currency_name": "string",
- "creator": 0,
- "assignees": [
- {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "profile_image": "string"
}
]
}
], - "is_1099_eligible": true,
- "overall_score": 0,
- "is_auto_email_po_enabled": true,
- "po_pdf_labels": "string",
- "performance": {
- "overall_score": 0,
- "average_delivery_time": "string",
- "breakdown": {
- "speed": {
- "score": 0,
- "weight": "string"
}, - "accuracy": {
- "score": 0,
- "weight": "string"
}, - "quality": {
- "score": 0,
- "weight": "string"
}, - "cost": {
- "score": 0,
- "weight": "string"
}
}
}, - "vendor_request": {
- "id": 0,
- "requester": "string",
- "submitted_date": "2019-08-24T14:15:22Z",
- "next_approver": "string",
- "permissions": {
- "property1": null,
- "property2": null
}
}
}
}
Get detail of a vendor by id
object Default: {} | |
required | object (VendorDetail) |
{- "metadata": { },
- "data": {
- "id": 0,
- "name": "string",
- "active": true,
- "addressLineOne": "string",
- "addressLineTwo": "string",
- "postalCode": "string",
- "city": "string",
- "state_province": "string",
- "country": "string",
- "phoneOne": "string",
- "phoneTwo": "string",
- "fax": "string",
- "email": [
- "string"
], - "comments": "string",
- "contact": "string",
- "url": "string",
- "external_id": "string",
- "dateModified": "2019-08-24T14:15:22Z",
- "currency": 0,
- "payment_term_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "shipping_term_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "payment_method_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "shipping_method_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "payment_methods": [
- {
- "id": 0,
- "name": "string",
- "type": 0,
- "data": null,
- "currency": {
- "id": 0,
- "name": "string",
- "description": "string",
- "rate": "string",
- "base": true,
- "active": true
}
}
], - "tax": 0,
- "type": 2,
- "default_payment_method": 0,
- "creditcards": [
- {
- "id": 0,
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "is_active": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "number": "string",
- "balance": -2147483648,
- "gl_code": "string",
- "type": 0,
- "category": 0,
- "external_id": "string",
- "status": "pending",
- "require_activation": true,
- "last_changed_by": 0,
- "vendor": 0,
- "payment_method": 0,
- "currency": 0,
- "currency_name": "string",
- "creator": 0,
- "assignees": [
- {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "profile_image": "string"
}
]
}
], - "is_1099_eligible": true,
- "overall_score": 0,
- "is_auto_email_po_enabled": true,
- "po_pdf_labels": "string",
- "performance": {
- "overall_score": 0,
- "average_delivery_time": "string",
- "breakdown": {
- "speed": {
- "score": 0,
- "weight": "string"
}, - "accuracy": {
- "score": 0,
- "weight": "string"
}, - "quality": {
- "score": 0,
- "weight": "string"
}, - "cost": {
- "score": 0,
- "weight": "string"
}
}
}, - "vendor_request": {
- "id": 0,
- "requester": "string",
- "submitted_date": "2019-08-24T14:15:22Z",
- "next_approver": "string",
- "permissions": {
- "property1": null,
- "property2": null
}
}
}
}
object Default: {} | |
required | object (Vendor) |
{- "name": "string",
- "active": true,
- "addressLineOne": "string",
- "addressLineTwo": "string",
- "postalCode": "string",
- "city": "string",
- "state_province": "string",
- "country": "string",
- "phoneOne": "string",
- "phoneTwo": "string",
- "fax": "string",
- "email": [
- "user@example.com"
], - "comments": "string",
- "contact": "string",
- "url": "string",
- "external_id": "string",
- "currency": 0,
- "payment_term_ref": {
- "name": "string",
- "description": "string",
- "active": true
}, - "shipping_term_ref": {
- "name": "string",
- "description": "string",
- "active": true
}, - "payment_method_ref": {
- "name": "string",
- "description": "string",
- "active": true
}, - "shipping_method_ref": {
- "name": "string",
- "description": "string",
- "active": true
}, - "tax": 0,
- "type": 2,
- "default_payment_method": 0,
- "is_1099_eligible": true,
- "overall_score": "string",
- "is_auto_email_po_enabled": true,
- "po_pdf_labels": "string"
}
{- "metadata": { },
- "data": {
- "id": 0,
- "name": "string",
- "active": true,
- "addressLineOne": "string",
- "addressLineTwo": "string",
- "postalCode": "string",
- "city": "string",
- "state_province": "string",
- "country": "string",
- "phoneOne": "string",
- "phoneTwo": "string",
- "fax": "string",
- "email": [
- "user@example.com"
], - "comments": "string",
- "contact": "string",
- "url": "string",
- "external_id": "string",
- "dateModified": "2019-08-24T14:15:22Z",
- "currency": 0,
- "payment_term_ref": 0,
- "shipping_term_ref": 0,
- "payment_method_ref": 0,
- "shipping_method_ref": 0,
- "payment_methods": [
- {
- "id": 0,
- "name": "string",
- "type": 0,
- "data": null,
- "currency": {
- "id": 0,
- "name": "string",
- "description": "string",
- "rate": "string",
- "base": true,
- "active": true
}
}
], - "tax": 0,
- "type": 2,
- "default_payment_method": 0,
- "creditcards": [
- {
- "id": 0,
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "is_active": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "number": "string",
- "balance": -2147483648,
- "gl_code": "string",
- "type": 0,
- "category": 0,
- "external_id": "string",
- "status": "pending",
- "require_activation": true,
- "last_changed_by": 0,
- "vendor": 0,
- "payment_method": 0,
- "currency": 0,
- "currency_name": "string",
- "creator": 0,
- "assignees": [
- {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "profile_image": "string"
}
]
}
], - "is_1099_eligible": true,
- "overall_score": 0,
- "is_auto_email_po_enabled": true,
- "po_pdf_labels": "string"
}
}
object Default: {} | |
required | object (OptimizedVendor) |
{- "name": "string",
- "active": true,
- "addressLineOne": "string",
- "addressLineTwo": "string",
- "postalCode": "string",
- "city": "string",
- "state_province": "string",
- "country": "string",
- "phoneOne": "string",
- "phoneTwo": "string",
- "fax": "string",
- "email": [
- "user@example.com"
], - "comments": "string",
- "contact": "string",
- "url": "string",
- "external_id": "string",
- "currency": 0,
- "payment_term_ref": {
- "name": "string",
- "description": "string",
- "active": true
}, - "shipping_term_ref": {
- "name": "string",
- "description": "string",
- "active": true
}, - "payment_method_ref": {
- "name": "string",
- "description": "string",
- "active": true
}, - "shipping_method_ref": {
- "name": "string",
- "description": "string",
- "active": true
}, - "tax": 0,
- "type": 2,
- "default_payment_method": 0,
- "is_1099_eligible": true,
- "overall_score": "string",
- "is_auto_email_po_enabled": true,
- "po_pdf_labels": "string"
}
{- "metadata": { },
- "data": {
- "id": 0,
- "name": "string",
- "active": true,
- "addressLineOne": "string",
- "addressLineTwo": "string",
- "postalCode": "string",
- "city": "string",
- "state_province": "string",
- "country": "string",
- "phoneOne": "string",
- "phoneTwo": "string",
- "fax": "string",
- "email": [
- "user@example.com"
], - "comments": "string",
- "contact": "string",
- "url": "string",
- "external_id": "string",
- "dateModified": "2019-08-24T14:15:22Z",
- "currency": 0,
- "payment_term_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "shipping_term_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "payment_method_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "shipping_method_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "payment_methods": [
- {
- "id": 0,
- "name": "string",
- "type": 0,
- "data": null,
- "currency": {
- "id": 0,
- "name": "string",
- "description": "string",
- "rate": "string",
- "base": true,
- "active": true
}
}
], - "tax": 0,
- "type": 2,
- "default_payment_method": 0,
- "creditcards": [
- {
- "id": 0,
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "is_active": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "number": "string",
- "balance": -2147483648,
- "gl_code": "string",
- "type": 0,
- "category": 0,
- "external_id": "string",
- "status": "pending",
- "require_activation": true,
- "last_changed_by": 0,
- "vendor": 0,
- "payment_method": 0,
- "currency": 0,
- "currency_name": "string",
- "creator": 0,
- "assignees": [
- {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "profile_image": "string"
}
]
}
], - "is_1099_eligible": true,
- "overall_score": "string",
- "is_auto_email_po_enabled": true,
- "po_pdf_labels": "string",
- "vendor_request": {
- "id": 0,
- "requester": "string",
- "submitted_date": "2019-08-24T14:15:22Z",
- "next_approver": "string",
- "permissions": {
- "property1": null,
- "property2": null
}
}
}
}
object | |
Array of objects (Currency) |
{- "metadata": {
- "pagination": {
- "count": 10,
- "next": null,
- "previous": null,
- "page_size": 10,
- "num_pages": 1,
- "current_page": 1
}
}, - "data": [
- {
- "id": 0,
- "name": "string",
- "description": "string",
- "rate": "string",
- "base": true,
- "active": true
}
]
}
object | |
Array of objects (CatalogItemBundleRead) |
{- "metadata": {
- "pagination": {
- "count": 10,
- "next": null,
- "previous": null,
- "page_size": 10,
- "num_pages": 1,
- "current_page": 1
}
}, - "data": [
- {
- "id": 0,
- "name": "string",
- "description": "string",
- "image": "string",
- "active": true,
- "items": [
- {
- "id": 0,
- "name": "string",
- "image": "string",
- "unitType": "string",
- "pref_vendor": {
- "id": 0,
- "name": "string",
- "active": true,
- "addressLineOne": "string",
- "addressLineTwo": "string",
- "postalCode": "string",
- "city": "string",
- "state_province": "string",
- "country": "string",
- "phoneOne": "string",
- "phoneTwo": "string",
- "fax": "string",
- "email": [
- "user@example.com"
], - "comments": "string",
- "contact": "string",
- "url": "string",
- "external_id": "string",
- "dateModified": "2019-08-24T14:15:22Z",
- "currency": 0,
- "payment_term_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "shipping_term_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "payment_method_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "shipping_method_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "payment_methods": [
- {
- "id": null,
- "name": null,
- "type": null,
- "data": null,
- "currency": null
}
], - "tax": 0,
- "type": 2,
- "default_payment_method": 0,
- "creditcards": [
- {
- "id": null,
- "uuid": null,
- "is_active": null,
- "created_at": null,
- "updated_at": null,
- "name": null,
- "number": null,
- "balance": null,
- "gl_code": null,
- "type": null,
- "category": null,
- "external_id": null,
- "status": null,
- "require_activation": null,
- "last_changed_by": null,
- "vendor": null,
- "payment_method": null,
- "currency": null,
- "currency_name": null,
- "creator": null,
- "assignees": [ ]
}
], - "is_1099_eligible": true,
- "overall_score": 0,
- "is_auto_email_po_enabled": true,
- "po_pdf_labels": "string"
}, - "account_code": {
- "id": 0,
- "applied_accounts_count": 0,
- "code": "string",
- "code_length": -2147483648,
- "description": "string",
- "account_type": 0,
- "active": true,
- "parent": 0
}, - "internalSKU": "string",
- "description": "string",
- "product_url": "string",
- "currency": {
- "id": 0,
- "name": "string",
- "rate": "string",
- "base": true
}, - "price": "string",
- "rfo_lock": true,
- "departments": [
- 0
], - "custom_fields": [
- {
- "id": 0,
- "value": "string",
- "field": {
- "id": null,
- "name": null,
- "content_type": null,
- "default_value": null,
- "is_required": null,
- "field_choices": [ ],
- "field_type": null,
- "field_label": null,
- "is_active": null
}
}
], - "requested_count": -2147483648,
- "last_requested_date": "2019-08-24T14:15:22Z",
- "selected_account": {
- "property1": null,
- "property2": null
}, - "quantity": 0
}
], - "items_count": 0
}
]
}
object | |
Array of objects (CatalogItemRead) |
{- "metadata": {
- "pagination": {
- "count": 10,
- "next": null,
- "previous": null,
- "page_size": 10,
- "num_pages": 1,
- "current_page": 1
}
}, - "data": [
- {
- "id": 0,
- "name": "string",
- "image": "string",
- "unitType": "string",
- "pref_vendor": {
- "id": 0,
- "name": "string",
- "active": true,
- "addressLineOne": "string",
- "addressLineTwo": "string",
- "postalCode": "string",
- "city": "string",
- "state_province": "string",
- "country": "string",
- "phoneOne": "string",
- "phoneTwo": "string",
- "fax": "string",
- "email": [
- "user@example.com"
], - "comments": "string",
- "contact": "string",
- "url": "string",
- "external_id": "string",
- "dateModified": "2019-08-24T14:15:22Z",
- "currency": 0,
- "payment_term_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "shipping_term_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "payment_method_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "shipping_method_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "payment_methods": [
- {
- "id": 0,
- "name": "string",
- "type": 0,
- "data": null,
- "currency": {
- "id": 0,
- "name": "string",
- "description": "string",
- "rate": "string",
- "base": true,
- "active": true
}
}
], - "tax": 0,
- "type": 2,
- "default_payment_method": 0,
- "creditcards": [
- {
- "id": 0,
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "is_active": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "number": "string",
- "balance": -2147483648,
- "gl_code": "string",
- "type": 0,
- "category": 0,
- "external_id": "string",
- "status": "pending",
- "require_activation": true,
- "last_changed_by": 0,
- "vendor": 0,
- "payment_method": 0,
- "currency": 0,
- "currency_name": "string",
- "creator": 0,
- "assignees": [
- {
- "id": null,
- "firstName": null,
- "lastName": null,
- "email": null,
- "profile_image": null
}
]
}
], - "is_1099_eligible": true,
- "overall_score": 0,
- "is_auto_email_po_enabled": true,
- "po_pdf_labels": "string"
}, - "account_code": {
- "id": 0,
- "applied_accounts_count": 0,
- "code": "string",
- "code_length": -2147483648,
- "description": "string",
- "account_type": 0,
- "active": true,
- "parent": 0
}, - "internalSKU": "string",
- "description": "string",
- "product_url": "string",
- "currency": {
- "id": 0,
- "name": "string",
- "rate": "string",
- "base": true
}, - "price": "string",
- "rfo_lock": true,
- "departments": [
- 0
], - "custom_fields": [
- {
- "id": 0,
- "value": "string",
- "field": {
- "id": 0,
- "name": "string",
- "content_type": 0,
- "default_value": "string",
- "is_required": true,
- "field_choices": [
- "string"
], - "field_type": "t",
- "field_label": "string",
- "is_active": true
}
}
], - "requested_count": -2147483648,
- "last_requested_date": "2019-08-24T14:15:22Z",
- "selected_account": {
- "property1": null,
- "property2": null
}
}
]
}
object Default: {} | |
required | object (CatalogItemRead) |
{- "id": 0,
- "name": "string",
- "image": "string",
- "unitType": "string",
- "pref_vendor": 0,
- "account_code": 0,
- "internalSKU": "string",
- "description": "string",
- "product_url": "string",
- "currency": 0,
- "price": "string",
- "rfo_lock": true,
- "departments": [
- 0
], - "custom_fields": [
- {
- "property1": null,
- "property2": null
}
]
}
{- "metadata": { },
- "data": {
- "id": 0,
- "name": "string",
- "image": "string",
- "unitType": "string",
- "pref_vendor": {
- "id": 0,
- "name": "string",
- "active": true,
- "addressLineOne": "string",
- "addressLineTwo": "string",
- "postalCode": "string",
- "city": "string",
- "state_province": "string",
- "country": "string",
- "phoneOne": "string",
- "phoneTwo": "string",
- "fax": "string",
- "email": [
- "user@example.com"
], - "comments": "string",
- "contact": "string",
- "url": "string",
- "external_id": "string",
- "dateModified": "2019-08-24T14:15:22Z",
- "currency": 0,
- "payment_term_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "shipping_term_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "payment_method_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "shipping_method_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "payment_methods": [
- {
- "id": 0,
- "name": "string",
- "type": 0,
- "data": null,
- "currency": {
- "id": 0,
- "name": "string",
- "description": "string",
- "rate": "string",
- "base": true,
- "active": true
}
}
], - "tax": 0,
- "type": 2,
- "default_payment_method": 0,
- "creditcards": [
- {
- "id": 0,
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "is_active": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "number": "string",
- "balance": -2147483648,
- "gl_code": "string",
- "type": 0,
- "category": 0,
- "external_id": "string",
- "status": "pending",
- "require_activation": true,
- "last_changed_by": 0,
- "vendor": 0,
- "payment_method": 0,
- "currency": 0,
- "currency_name": "string",
- "creator": 0,
- "assignees": [
- {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "profile_image": "string"
}
]
}
], - "is_1099_eligible": true,
- "overall_score": 0,
- "is_auto_email_po_enabled": true,
- "po_pdf_labels": "string"
}, - "account_code": {
- "id": 0,
- "applied_accounts_count": 0,
- "code": "string",
- "code_length": -2147483648,
- "description": "string",
- "account_type": 0,
- "active": true,
- "parent": 0
}, - "internalSKU": "string",
- "description": "string",
- "product_url": "string",
- "currency": {
- "id": 0,
- "name": "string",
- "rate": "string",
- "base": true
}, - "price": "string",
- "rfo_lock": true,
- "departments": [
- 0
], - "custom_fields": [
- {
- "id": 0,
- "value": "string",
- "field": {
- "id": 0,
- "name": "string",
- "content_type": 0,
- "default_value": "string",
- "is_required": true,
- "field_choices": [
- "string"
], - "field_type": "t",
- "field_label": "string",
- "is_active": true
}
}
], - "requested_count": -2147483648,
- "last_requested_date": "2019-08-24T14:15:22Z",
- "selected_account": {
- "property1": null,
- "property2": null
}
}
}
object Default: {} | |
required | object (CatalogItemRead) |
{- "id": 0,
- "name": "string",
- "image": "string",
- "unitType": "string",
- "pref_vendor": 0,
- "account_code": 0,
- "internalSKU": "string",
- "description": "string",
- "product_url": "string",
- "currency": 0,
- "price": "string",
- "rfo_lock": true,
- "departments": [
- 0
], - "custom_fields": [
- {
- "property1": null,
- "property2": null
}
]
}
{- "metadata": { },
- "data": {
- "id": 0,
- "name": "string",
- "image": "string",
- "unitType": "string",
- "pref_vendor": {
- "id": 0,
- "name": "string",
- "active": true,
- "addressLineOne": "string",
- "addressLineTwo": "string",
- "postalCode": "string",
- "city": "string",
- "state_province": "string",
- "country": "string",
- "phoneOne": "string",
- "phoneTwo": "string",
- "fax": "string",
- "email": [
- "user@example.com"
], - "comments": "string",
- "contact": "string",
- "url": "string",
- "external_id": "string",
- "dateModified": "2019-08-24T14:15:22Z",
- "currency": 0,
- "payment_term_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "shipping_term_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "payment_method_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "shipping_method_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "payment_methods": [
- {
- "id": 0,
- "name": "string",
- "type": 0,
- "data": null,
- "currency": {
- "id": 0,
- "name": "string",
- "description": "string",
- "rate": "string",
- "base": true,
- "active": true
}
}
], - "tax": 0,
- "type": 2,
- "default_payment_method": 0,
- "creditcards": [
- {
- "id": 0,
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "is_active": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "number": "string",
- "balance": -2147483648,
- "gl_code": "string",
- "type": 0,
- "category": 0,
- "external_id": "string",
- "status": "pending",
- "require_activation": true,
- "last_changed_by": 0,
- "vendor": 0,
- "payment_method": 0,
- "currency": 0,
- "currency_name": "string",
- "creator": 0,
- "assignees": [
- {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "profile_image": "string"
}
]
}
], - "is_1099_eligible": true,
- "overall_score": 0,
- "is_auto_email_po_enabled": true,
- "po_pdf_labels": "string"
}, - "account_code": {
- "id": 0,
- "applied_accounts_count": 0,
- "code": "string",
- "code_length": -2147483648,
- "description": "string",
- "account_type": 0,
- "active": true,
- "parent": 0
}, - "internalSKU": "string",
- "description": "string",
- "product_url": "string",
- "currency": {
- "id": 0,
- "name": "string",
- "rate": "string",
- "base": true
}, - "price": "string",
- "rfo_lock": true,
- "departments": [
- 0
], - "custom_fields": [
- {
- "id": 0,
- "value": "string",
- "field": {
- "id": 0,
- "name": "string",
- "content_type": 0,
- "default_value": "string",
- "is_required": true,
- "field_choices": [
- "string"
], - "field_type": "t",
- "field_label": "string",
- "is_active": true
}
}
], - "requested_count": -2147483648,
- "last_requested_date": "2019-08-24T14:15:22Z",
- "selected_account": {
- "property1": null,
- "property2": null
}
}
}
Order Item Status Codes
Order Item Type | Code | Description |
---|---|---|
PURCHASE_PENDING | 0 | Approved but not purchased. |
PURCHASE_INUSE | 1 | Added to purchaser's PO list. |
RECEIVE_PENDING | 2 | Purchased but not yet received, i.e. receivedPassQty == 0. |
RECEIVED | 3 | Fully received, i.e. receivedPassQty == quantity. |
REJECTED_FOR_PURCHASE | 4 | Rejected at procurement, i.e. denied. |
RECEIVE_PARTIAL | 5 | Partially received, i.e. receivedPassQty != quantity and receivedPassQty > 0. |
FULFILLED | 6 | Received but unused. |
APPROVAL_DENIED | 7 | Denied in approval routing (by approver). |
REQUEST_DRAFT | 8 | Preparing for draft instead of using sessions. |
object | |
Array of objects (OrderItem) |
{- "metadata": {
- "pagination": {
- "count": 10,
- "next": null,
- "previous": null,
- "page_size": 10,
- "num_pages": 1,
- "current_page": 1
}
}, - "data": [
- {
- "PO": [
- 0
], - "PO_line_num": -2147483648,
- "account": 0,
- "accountCode": "string",
- "active": true,
- "approved_currency_rate": "string",
- "approved_datetime": "2019-08-24T14:15:22Z",
- "approved_price": "string",
- "approved_quantity": "string",
- "approved_shipping_amount": "string",
- "approved_tax_amount": "string",
- "attachments": "string",
- "catalog_item": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "currency": 0,
- "dateInvoiced": "2019-08-24T14:15:22Z",
- "external_id": "string",
- "hot": true,
- "id": 0,
- "inventoryItem": 0,
- "is_active": true,
- "item_attachments": [
- 0
], - "last_changed_by": 0,
- "last_modified": "2019-08-24T14:15:22Z",
- "lineComment": "string",
- "name": "string",
- "num": "string",
- "orderNum": 0,
- "po_note": "string",
- "po_version": -2147483648,
- "pref_vendor": 0,
- "price": "string",
- "purchase_order": 0,
- "purchaser": 0,
- "quantity": "string",
- "receivedFailQty": "string",
- "receivedPassQty": "string",
- "shipping_amount": "string",
- "sku": "string",
- "status": 0,
- "tax_amount": "string",
- "total_cost": "string",
- "unit": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "vendor": "string",
- "receive_method": 0,
- "type": 0,
- "blanket": {
- "price": "string",
- "quantity": 0,
- "amount": 0
}
}
]
}
Order Status Codes
Order Type | Code |
---|---|
PENDING | 0 |
APPROVED | 1 |
REJECTED | 2 |
PURCHASED | 3 |
CANCELLED (legacy) | 4 |
RECEIVED | 5 |
DRAFT | 6 |
object | |
Array of objects (OrderRead) |
{- "metadata": {
- "pagination": {
- "count": 10,
- "next": null,
- "previous": null,
- "page_size": 10,
- "num_pages": 1,
- "current_page": 1
}
}, - "data": [
- {
- "num": 0,
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "branch": {
- "id": 0,
- "external_id": "string",
- "name": "string",
- "logo": "string",
- "language": 1,
- "multipleLocations": true,
- "locationTimezone": "Africa/Abidjan",
- "userLimit": 4294967295,
- "budgetOvertureToggle": true,
- "purchase_filtering": true,
- "catalog_permission": true,
- "separate_expense_approval": true,
- "standalone_travel_approval": true,
- "phoneOne": "string",
- "phoneTwo": "string",
- "fax": "string",
- "email": "user@example.com",
- "fiscalYearEndDay": 4294967295,
- "fiscalYearEndMonth": 4294967295,
- "beginDate": "2019-08-24T14:15:22Z",
- "ported": true,
- "port_date": "2019-08-24T14:15:22Z",
- "active": true,
- "activated": true,
- "setup_stage": "COMP",
- "localCurrency": 0,
- "contactPerson": 0,
- "buyerAddress": 0,
- "shippingAddress": 0
}, - "user": {
- "id": 0,
- "department": {
- "id": 0,
- "branch": {
- "id": 0,
- "name": "string"
}, - "external_id": "string",
- "name": "string",
- "punchout_email": "user@example.com",
- "active": true
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "phone": "string",
- "address": "string",
- "notifications": true,
- "is_active": true,
- "mobile": true,
- "profile_image": "string",
- "slack_user_id": "string",
- "is_sso_enabled": true,
- "last_changed_by": 0,
- "user": 0,
- "approval_delegatee": {
- "id": 0,
- "department": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}, - "expected_return_date": "2019-08-24"
}, - "department": {
- "id": 0,
- "branch": {
- "id": 0,
- "name": "string"
}, - "external_id": "string",
- "name": "string",
- "punchout_email": "user@example.com",
- "active": true
}, - "currency": {
- "id": 0,
- "name": "string",
- "rate": "string",
- "base": true
}, - "total_cost_in_base_currency": 0,
- "logs": [
- {
- "id": 0,
- "user": {
- "id": 0,
- "department": {
- "id": 0,
- "branch": {
- "id": null,
- "name": null
}, - "external_id": "string",
- "name": "string",
- "punchout_email": "user@example.com",
- "active": true
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "phone": "string",
- "address": "string",
- "notifications": true,
- "is_active": true,
- "mobile": true,
- "profile_image": "string",
- "slack_user_id": "string",
- "is_sso_enabled": true,
- "last_changed_by": 0,
- "user": 0,
- "approval_delegatee": {
- "id": 0,
- "department": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}, - "expected_return_date": "2019-08-24"
}, - "next_approver": {
- "id": 0,
- "department": {
- "id": 0,
- "branch": {
- "id": null,
- "name": null
}, - "external_id": "string",
- "name": "string",
- "punchout_email": "user@example.com",
- "active": true
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "phone": "string",
- "address": "string",
- "notifications": true,
- "is_active": true,
- "mobile": true,
- "profile_image": "string",
- "slack_user_id": "string",
- "is_sso_enabled": true,
- "last_changed_by": 0,
- "user": 0,
- "approval_delegatee": {
- "id": 0,
- "department": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}, - "expected_return_date": "2019-08-24"
}, - "nextApprover": {
- "id": 0,
- "department": {
- "id": 0,
- "branch": {
- "id": null,
- "name": null
}, - "external_id": "string",
- "name": "string",
- "punchout_email": "user@example.com",
- "active": true
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "phone": "string",
- "address": "string",
- "notifications": true,
- "is_active": true,
- "mobile": true,
- "profile_image": "string",
- "slack_user_id": "string",
- "is_sso_enabled": true,
- "last_changed_by": 0,
- "user": 0,
- "approval_delegatee": {
- "id": 0,
- "department": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}, - "expected_return_date": "2019-08-24"
}, - "approval_delegation": {
- "approval_delegatee": {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "department": {
- "id": null,
- "name": null,
- "location": null
}
}, - "expected_return_date": "2019-08-24",
- "delegator": {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}, - "setter": {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}
}, - "dateTime": "2019-08-24T14:15:22Z",
- "action": 0,
- "line_qty_pass": "string",
- "line_qty_fail": "string",
- "order": 0,
- "lineItem": 0,
- "PO": 0,
- "inventoryItem": 0,
- "stocking_parent": 0
}
], - "item_count": 0,
- "ip_address": "string",
- "date": "2019-08-24T14:15:22Z",
- "description": "string",
- "dateRequired": "2019-08-24T14:15:22Z",
- "dateModified": "2019-08-24T14:15:22Z",
- "lineCount": -2147483648,
- "purchasedCount": -2147483648,
- "totalPrice": "string",
- "status": 0,
- "next_approver": {
- "id": 0,
- "department": {
- "id": 0,
- "branch": {
- "id": 0,
- "name": "string"
}, - "external_id": "string",
- "name": "string",
- "punchout_email": "user@example.com",
- "active": true
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "phone": "string",
- "address": "string",
- "notifications": true,
- "is_active": true,
- "mobile": true,
- "profile_image": "string",
- "slack_user_id": "string",
- "is_sso_enabled": true,
- "last_changed_by": 0,
- "user": 0,
- "approval_delegatee": {
- "id": 0,
- "department": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}, - "expected_return_date": "2019-08-24"
}, - "approval_delegatee": 0,
- "punchout_group": {
- "id": 0,
- "name": "string"
}, - "punchout_shipping_address": {
- "id": 0,
- "name": "string"
}, - "punchout_items_rejected": true,
- "punchout_supplier_name": "string",
- "punchout_supplier_icon": "string",
- "punchout_vendor_reference": 0,
- "has_blanket_order_items": true
}
]
}
object Default: {} | |
required | object (RequisitionRead) |
{- "required_date": "2019-08-24",
- "location_name": "string",
- "department_name": "string",
- "line_items": [
- {
- "item_name": "string",
- "vendor_name": "string",
- "account_code": "string",
- "unit_price": "string",
- "quantity": "string",
- "unit": "string",
- "currency_code": "string",
- "custom_fields": [
- {
- "custom_field_name": "string",
- "custom_field_value": "string"
}
]
}
]
}
{- "metadata": { },
- "data": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}
}
Deprecated method for revising a purchase order. Pending removable after November 16, 2023. Use PUT
on /api/v3/purchase-orders/{id}
instead.
object Default: {} | |
required | object (PurchaseOrderDetail) |
{- "order_items": [
- {
- "id": 0,
- "name": "string",
- "sku": "string",
- "unit": "string",
- "quantity": "string",
- "price": "string",
- "po_note": "string",
- "custom_fields": [
- {
- "property1": null,
- "property2": null
}
], - "tax_amount": "string",
- "shipping_amount": "string"
}
], - "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": {
- "property1": null,
- "property2": null
}, - "tax": {
- "property1": null,
- "property2": null
}, - "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
}
{- "metadata": { },
- "data": {
- "number": "string",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "purchaser": {
- "id": 0,
- "department": {
- "id": 0,
- "branch": {
- "id": 0,
- "name": "string"
}, - "external_id": "string",
- "name": "string",
- "punchout_email": "user@example.com",
- "active": true
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "phone": "string",
- "address": "string",
- "notifications": true,
- "is_active": true,
- "mobile": true,
- "profile_image": "string",
- "slack_user_id": "string",
- "is_sso_enabled": true,
- "last_changed_by": 0,
- "user": 0,
- "approval_delegatee": {
- "id": 0,
- "department": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}, - "expected_return_date": "2019-08-24"
}, - "procurify_PO": 0,
- "PO_Num": "string",
- "date": "2019-08-24T14:15:22Z",
- "buyer_name": "string",
- "buyer_contact": "string",
- "buyer_addressLineOne": "string",
- "buyer_postalCode": "string",
- "buyer_city": "string",
- "buyer_state_province": "string",
- "buyer_country": "string",
- "buyer_address": {
- "id": 0,
- "is_active": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "addressAssociation": 1,
- "addressLineOne": "string",
- "addressLineTwo": "string",
- "postalCode": "string",
- "city": "string",
- "state_province": "string",
- "country": "string",
- "last_changed_by": 0
}, - "receiver_name": "string",
- "receiver_contact": "string",
- "receiver_addressLineOne": "string",
- "receiver_postalCode": "string",
- "receiver_city": "string",
- "receiver_state_province": "string",
- "receiver_country": "string",
- "receiver_address": {
- "id": 0,
- "is_active": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "addressAssociation": 1,
- "addressLineOne": "string",
- "addressLineTwo": "string",
- "postalCode": "string",
- "city": "string",
- "state_province": "string",
- "country": "string",
- "last_changed_by": 0
}, - "pref_vendor": {
- "id": 0,
- "name": "string",
- "active": true,
- "addressLineOne": "string",
- "addressLineTwo": "string",
- "postalCode": "string",
- "city": "string",
- "state_province": "string",
- "country": "string",
- "phoneOne": "string",
- "phoneTwo": "string",
- "fax": "string",
- "email": [
- "user@example.com"
], - "comments": "string",
- "contact": "string",
- "url": "string",
- "external_id": "string",
- "dateModified": "2019-08-24T14:15:22Z",
- "currency": 0,
- "payment_term_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "shipping_term_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "payment_method_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "shipping_method_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "payment_methods": [
- {
- "id": 0,
- "name": "string",
- "type": 0,
- "data": null,
- "currency": {
- "id": 0,
- "name": "string",
- "description": "string",
- "rate": "string",
- "base": true,
- "active": true
}
}
], - "tax": 0,
- "type": 2,
- "default_payment_method": 0,
- "creditcards": [
- {
- "id": 0,
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "is_active": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "number": "string",
- "balance": -2147483648,
- "gl_code": "string",
- "type": 0,
- "category": 0,
- "external_id": "string",
- "status": "pending",
- "require_activation": true,
- "last_changed_by": 0,
- "vendor": 0,
- "payment_method": 0,
- "currency": 0,
- "currency_name": "string",
- "creator": 0,
- "assignees": [
- {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "profile_image": "string"
}
]
}
], - "is_1099_eligible": true,
- "overall_score": 0,
- "is_auto_email_po_enabled": true,
- "po_pdf_labels": "string"
}, - "vendor_name": "string",
- "vendor_contact": "string",
- "vendor_addressLineOne": "string",
- "vendor_postalCode": "string",
- "vendor_city": "string",
- "vendor_state_province": "string",
- "vendor_country": "string",
- "payment_terms": "string",
- "shipping_terms": "string",
- "shipping_method": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "promise_date": "2019-08-24T14:15:22Z",
- "subtotal": "string",
- "freight": "string",
- "tax": {
- "value": 0,
- "type": "amount"
}, - "discount": {
- "value": 0,
- "type": "amount"
}, - "other": "string",
- "total": "string",
- "comment": "string",
- "purchased_currency": {
- "id": 0,
- "name": "string",
- "rate": "string",
- "base": true
}, - "purchased_currency_rate": "string",
- "active": true,
- "state": 0,
- "fulfilment_status": "empty",
- "disclaimer_description": "string",
- "disclaimer_text": "string",
- "recorded_date": "2019-08-24T14:15:22Z",
- "closed_date": "2019-08-24T14:15:22Z",
- "last_modified": "2019-08-24T14:15:22Z",
- "staged_for_export": true,
- "version": -2147483648,
- "item_count": 0,
- "most_recent_version": -2147483648,
- "punchout_system": 0,
- "purchase_agreement": 0,
- "purchase_agreement_status": { },
- "punchout_vendor_reference": 0,
- "punchout_supplier_icon": "string",
- "punchout_supplier_name": "string",
- "has_blanket_order_items": true,
- "expiry_date": "2019-08-24T14:15:22Z",
- "contract": {
- "id": 0,
- "uuid": "string",
- "name": "string"
}, - "order_items": [
- {
- "PO": [
- 0
], - "PO_line_num": -2147483648,
- "account": {
- "id": 0,
- "account_code": {
- "id": 0,
- "applied_accounts_count": 0,
- "code": "string",
- "code_length": -2147483648,
- "description": "string",
- "account_type": 0,
- "active": true,
- "parent": 0
}, - "department": {
- "id": 0,
- "branch": {
- "id": 0,
- "name": "string"
}, - "external_id": "string",
- "name": "string",
- "punchout_email": "user@example.com",
- "active": true
}, - "warning_indicator": true,
- "budget_used_approved": 0,
- "budget_used_purchased": 0,
- "start_datetime": "2019-08-24T14:15:22Z",
- "end_datetime": "2019-08-24T14:15:22Z",
- "budget": "string",
- "balance_approved": "string",
- "balance_purchased": "string",
- "active": true
}, - "accountCode": "string",
- "active": true,
- "approved_currency_rate": "string",
- "approved_datetime": "2019-08-24T14:15:22Z",
- "approved_price": "string",
- "approved_quantity": 0,
- "approved_shipping_amount": "string",
- "approved_tax_amount": "string",
- "attachments": [
- {
- "id": 0,
- "attachment": "string",
- "upload_datetime": "2019-08-24T14:15:22Z",
- "name": "string",
- "type": "other",
- "user": 0,
- "item": 0
}
], - "catalog_item": {
- "id": 0,
- "name": "string",
- "image": "string",
- "unitType": "string",
- "pref_vendor": {
- "id": 0,
- "name": "string",
- "active": true,
- "addressLineOne": "string",
- "addressLineTwo": "string",
- "postalCode": "string",
- "city": "string",
- "state_province": "string",
- "country": "string",
- "phoneOne": "string",
- "phoneTwo": "string",
- "fax": "string",
- "email": [
- "user@example.com"
], - "comments": "string",
- "contact": "string",
- "url": "string",
- "external_id": "string",
- "dateModified": "2019-08-24T14:15:22Z",
- "currency": 0,
- "payment_term_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "shipping_term_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "payment_method_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "shipping_method_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "payment_methods": [
- {
- "id": null,
- "name": null,
- "type": null,
- "data": null,
- "currency": null
}
], - "tax": 0,
- "type": 2,
- "default_payment_method": 0,
- "creditcards": [
- {
- "id": null,
- "uuid": null,
- "is_active": null,
- "created_at": null,
- "updated_at": null,
- "name": null,
- "number": null,
- "balance": null,
- "gl_code": null,
- "type": null,
- "category": null,
- "external_id": null,
- "status": null,
- "require_activation": null,
- "last_changed_by": null,
- "vendor": null,
- "payment_method": null,
- "currency": null,
- "currency_name": null,
- "creator": null,
- "assignees": [ ]
}
], - "is_1099_eligible": true,
- "overall_score": 0,
- "is_auto_email_po_enabled": true,
- "po_pdf_labels": "string"
}, - "account_code": {
- "id": 0,
- "applied_accounts_count": 0,
- "code": "string",
- "code_length": -2147483648,
- "description": "string",
- "account_type": 0,
- "active": true,
- "parent": 0
}, - "internalSKU": "string",
- "description": "string",
- "product_url": "string",
- "currency": {
- "id": 0,
- "name": "string",
- "rate": "string",
- "base": true
}, - "price": "string",
- "rfo_lock": true,
- "departments": [
- 0
], - "custom_fields": [
- {
- "id": 0,
- "value": "string",
- "field": {
- "id": null,
- "name": null,
- "content_type": null,
- "default_value": null,
- "is_required": null,
- "field_choices": [ ],
- "field_type": null,
- "field_label": null,
- "is_active": null
}
}
], - "requested_count": -2147483648,
- "last_requested_date": "2019-08-24T14:15:22Z",
- "selected_account": {
- "property1": null,
- "property2": null
}
}, - "created_at": "2019-08-24T14:15:22Z",
- "currency": {
- "id": 0,
- "name": "string",
- "rate": "string",
- "base": true
}, - "dateInvoiced": "2019-08-24T14:15:22Z",
- "external_id": "string",
- "hot": true,
- "id": 0,
- "inventoryItem": 0,
- "is_active": true,
- "item_attachments": [
- {
- "id": 0,
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "file": "string",
- "name": "string",
- "user": 0,
- "description": "string",
- "mimetype": "string",
- "length": -2147483648,
- "sha1_hash": "string",
- "created_at": "2019-08-24T14:15:22Z"
}
], - "last_changed_by": 0,
- "last_modified": "2019-08-24T14:15:22Z",
- "lineComment": "string",
- "name": "string",
- "num": "string",
- "orderNum": 0,
- "po_note": "string",
- "po_version": -2147483648,
- "pref_vendor": {
- "id": 0,
- "name": "string",
- "active": true,
- "addressLineOne": "string",
- "addressLineTwo": "string",
- "postalCode": "string",
- "city": "string",
- "state_province": "string",
- "country": "string",
- "phoneOne": "string",
- "phoneTwo": "string",
- "fax": "string",
- "email": [
- "user@example.com"
], - "comments": "string",
- "contact": "string",
- "url": "string",
- "external_id": "string",
- "dateModified": "2019-08-24T14:15:22Z",
- "currency": 0,
- "payment_term_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "shipping_term_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "payment_method_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "shipping_method_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "payment_methods": [
- {
- "id": 0,
- "name": "string",
- "type": 0,
- "data": null,
- "currency": {
- "id": null,
- "name": null,
- "description": null,
- "rate": null,
- "base": null,
- "active": null
}
}
], - "tax": 0,
- "type": 2,
- "default_payment_method": 0,
- "creditcards": [
- {
- "id": 0,
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "is_active": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "number": "string",
- "balance": -2147483648,
- "gl_code": "string",
- "type": 0,
- "category": 0,
- "external_id": "string",
- "status": "pending",
- "require_activation": true,
- "last_changed_by": 0,
- "vendor": 0,
- "payment_method": 0,
- "currency": 0,
- "currency_name": "string",
- "creator": 0,
- "assignees": [
- null
]
}
], - "is_1099_eligible": true,
- "overall_score": 0,
- "is_auto_email_po_enabled": true,
- "po_pdf_labels": "string"
}, - "price": "string",
- "purchase_order": 0,
- "purchaser": {
- "id": 0,
- "department": {
- "id": 0,
- "branch": {
- "id": 0,
- "name": "string"
}, - "external_id": "string",
- "name": "string",
- "punchout_email": "user@example.com",
- "active": true
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "phone": "string",
- "address": "string",
- "notifications": true,
- "is_active": true,
- "mobile": true,
- "profile_image": "string",
- "slack_user_id": "string",
- "is_sso_enabled": true,
- "last_changed_by": 0,
- "user": 0,
- "approval_delegatee": {
- "id": 0,
- "department": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}, - "expected_return_date": "2019-08-24"
}, - "quantity": 0,
- "receivedFailQty": 0,
- "receivedPassQty": 0,
- "shipping_amount": "string",
- "sku": "string",
- "status": 0,
- "tax_amount": "string",
- "total_cost": "string",
- "unit": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "vendor": "string",
- "receive_method": 0,
- "type": 0,
- "blanket": {
- "price": "string",
- "quantity": 0,
- "amount": 0
}, - "comments": [
- {
- "userprofile": {
- "id": 0,
- "department": {
- "id": null,
- "branch": null,
- "external_id": null,
- "name": null,
- "punchout_email": null,
- "active": null
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "phone": "string",
- "address": "string",
- "notifications": true,
- "is_active": true,
- "mobile": true,
- "profile_image": "string",
- "slack_user_id": "string",
- "is_sso_enabled": true,
- "last_changed_by": 0,
- "user": 0,
- "approval_delegatee": {
- "id": null,
- "department": null,
- "firstName": null,
- "lastName": null,
- "email": null
}, - "expected_return_date": "2019-08-24"
}, - "id": 0,
- "comment": "string",
- "submit_date": "2019-08-24T14:15:22Z"
}
], - "confirmation_status": 0,
- "confirmation_status_description": "string",
- "cost_details": {
- "subtotal": "string",
- "total_cost": "string",
- "total_cost_in_base_currency": "string",
- "tax_amount": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "value": "string",
- "field": {
- "id": 0,
- "name": "string",
- "content_type": 0,
- "default_value": "string",
- "is_required": true,
- "field_choices": [
- null
], - "field_type": "t",
- "field_label": "string",
- "is_active": true
}
}
], - "date_required": "2019-08-24T14:15:22Z",
- "has_sibling_items": true,
- "line_comment": "string",
- "logs": [
- {
- "id": 0,
- "user": {
- "id": 0,
- "department": {
- "id": null,
- "branch": null,
- "external_id": null,
- "name": null,
- "punchout_email": null,
- "active": null
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "phone": "string",
- "address": "string",
- "notifications": true,
- "is_active": true,
- "mobile": true,
- "profile_image": "string",
- "slack_user_id": "string",
- "is_sso_enabled": true,
- "last_changed_by": 0,
- "user": 0,
- "approval_delegatee": {
- "id": null,
- "department": null,
- "firstName": null,
- "lastName": null,
- "email": null
}, - "expected_return_date": "2019-08-24"
}, - "next_approver": {
- "id": 0,
- "department": {
- "id": null,
- "branch": null,
- "external_id": null,
- "name": null,
- "punchout_email": null,
- "active": null
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "phone": "string",
- "address": "string",
- "notifications": true,
- "is_active": true,
- "mobile": true,
- "profile_image": "string",
- "slack_user_id": "string",
- "is_sso_enabled": true,
- "last_changed_by": 0,
- "user": 0,
- "approval_delegatee": {
- "id": null,
- "department": null,
- "firstName": null,
- "lastName": null,
- "email": null
}, - "expected_return_date": "2019-08-24"
}, - "nextApprover": {
- "id": 0,
- "department": {
- "id": null,
- "branch": null,
- "external_id": null,
- "name": null,
- "punchout_email": null,
- "active": null
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "phone": "string",
- "address": "string",
- "notifications": true,
- "is_active": true,
- "mobile": true,
- "profile_image": "string",
- "slack_user_id": "string",
- "is_sso_enabled": true,
- "last_changed_by": 0,
- "user": 0,
- "approval_delegatee": {
- "id": null,
- "department": null,
- "firstName": null,
- "lastName": null,
- "email": null
}, - "expected_return_date": "2019-08-24"
}, - "approval_delegation": {
- "approval_delegatee": {
- "id": null,
- "firstName": null,
- "lastName": null,
- "email": null,
- "department": { }
}, - "expected_return_date": "2019-08-24",
- "delegator": {
- "id": null,
- "firstName": null,
- "lastName": null,
- "email": null
}, - "setter": {
- "id": null,
- "firstName": null,
- "lastName": null,
- "email": null
}
}, - "dateTime": "2019-08-24T14:15:22Z",
- "action": 0,
- "line_qty_pass": "string",
- "line_qty_fail": "string",
- "order": 0,
- "lineItem": 0,
- "PO": 0,
- "inventoryItem": 0,
- "stocking_parent": 0
}
], - "order_description": "string",
- "order_status": 0,
- "order_uuid": "e56795c7-0bc3-4742-a52f-988d2af8608f",
- "punchout_supplier_icon": "string",
- "punchout_supplier_name": "string",
- "punchout_system": 0,
- "punchout_vendor_reference": 0,
- "punchout_supplier_can_update_quantity": true,
- "purchase_order_number": "string",
- "purchase_order_uuid": "62208f57-ed5e-48b5-8bf2-30e42f35ea6f",
- "purchased_currency_rate": "0.000000",
- "recurrence": {
- "id": 0,
- "start_date": "2019-08-24",
- "frequency": 0,
- "duration": 0,
- "duration_quantity": 1,
- "recurring_price": "string",
- "periods_count": 0
}, - "requester": {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "profile_image": "string",
- "approval_delegatee": {
- "id": 0,
- "department": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}, - "expected_return_date": "2019-08-24"
}, - "spend_allocation": [
- {
- "id": 0,
- "amount": "string",
- "account": {
- "id": 0,
- "account_code": {
- "id": null,
- "code": null,
- "code_length": null,
- "description": null,
- "account_type": null,
- "active": null,
- "parent": null
}, - "department": {
- "id": null,
- "branch": null,
- "external_id": null,
- "name": null,
- "punchout_email": null,
- "active": null
}, - "active": true
}
}
], - "submitted_date": "2019-08-24T14:15:22Z",
- "taxes": [
- {
- "id": 0,
- "type": "percent",
- "value": "string",
- "name": "string"
}
], - "receive_log_count": 0,
- "approval_history": [
- {
- "id": 0,
- "user": {
- "id": 0,
- "department": {
- "id": null,
- "branch": null,
- "external_id": null,
- "name": null,
- "punchout_email": null,
- "active": null
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "phone": "string",
- "address": "string",
- "notifications": true,
- "is_active": true,
- "mobile": true,
- "profile_image": "string",
- "slack_user_id": "string",
- "is_sso_enabled": true,
- "last_changed_by": 0,
- "user": 0,
- "approval_delegatee": {
- "id": null,
- "department": null,
- "firstName": null,
- "lastName": null,
- "email": null
}, - "expected_return_date": "2019-08-24"
}, - "next_approver": {
- "id": 0,
- "department": {
- "id": null,
- "branch": null,
- "external_id": null,
- "name": null,
- "punchout_email": null,
- "active": null
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "phone": "string",
- "address": "string",
- "notifications": true,
- "is_active": true,
- "mobile": true,
- "profile_image": "string",
- "slack_user_id": "string",
- "is_sso_enabled": true,
- "last_changed_by": 0,
- "user": 0,
- "approval_delegatee": {
- "id": null,
- "department": null,
- "firstName": null,
- "lastName": null,
- "email": null
}, - "expected_return_date": "2019-08-24"
}, - "nextApprover": {
- "id": 0,
- "department": {
- "id": null,
- "branch": null,
- "external_id": null,
- "name": null,
- "punchout_email": null,
- "active": null
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "phone": "string",
- "address": "string",
- "notifications": true,
- "is_active": true,
- "mobile": true,
- "profile_image": "string",
- "slack_user_id": "string",
- "is_sso_enabled": true,
- "last_changed_by": 0,
- "user": 0,
- "approval_delegatee": {
- "id": null,
- "department": null,
- "firstName": null,
- "lastName": null,
- "email": null
}, - "expected_return_date": "2019-08-24"
}, - "approval_delegation": {
- "approval_delegatee": {
- "id": null,
- "firstName": null,
- "lastName": null,
- "email": null,
- "department": { }
}, - "expected_return_date": "2019-08-24",
- "delegator": {
- "id": null,
- "firstName": null,
- "lastName": null,
- "email": null
}, - "setter": {
- "id": null,
- "firstName": null,
- "lastName": null,
- "email": null
}
}, - "dateTime": "2019-08-24T14:15:22Z",
- "action": 0,
- "line_qty_pass": "string",
- "line_qty_fail": "string",
- "order": 0,
- "lineItem": 0,
- "PO": 0,
- "inventoryItem": 0,
- "stocking_parent": 0
}
], - "flags": [
- {
- "color": "string",
- "symbol": "string",
- "object_id": 4294967295,
- "content_type": 0
}
]
}
], - "creditcard_is_editable": true,
- "custom_fields": [
- {
- "id": 0,
- "value": "string",
- "field": {
- "id": 0,
- "name": "string",
- "content_type": 0,
- "default_value": "string",
- "is_required": true,
- "field_choices": [
- "string"
], - "field_type": "t",
- "field_label": "string",
- "is_active": true
}
}
], - "creditcard": {
- "id": 0,
- "name": "string",
- "number": "string",
- "vendor": {
- "id": 0,
- "name": "string",
- "active": true,
- "addressLineOne": "string",
- "addressLineTwo": "string",
- "postalCode": "string",
- "city": "string",
- "state_province": "string",
- "country": "string",
- "overall_score": "string",
- "is_auto_email_po_enabled": true
}, - "type": 0,
- "currency": {
- "id": 0,
- "name": "string",
- "description": "string",
- "rate": "string",
- "base": true,
- "active": true
}, - "balance": -2147483648,
- "assignees": [
- {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "profile_image": "string",
- "approval_delegatee": {
- "id": 0,
- "department": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}, - "expected_return_date": "2019-08-24"
}
], - "last_reconciliation_date": "2019-08-24T14:15:22Z",
- "last_reconciliation_balance": 0,
- "session": {
- "creditcard": 0,
- "balance": "string",
- "statement_date": "2019-08-24T14:15:22Z"
}, - "gl_code": "string",
- "last_statement_date": "2019-08-24T14:15:22Z"
}, - "payment_term": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "shipping_term": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "cost_details": {
- "subtotal": "string",
- "total_cost": "string",
- "total_cost_in_base_currency": "string",
- "tax_amount": "string"
}
}
}
Purchase Order State Codes
Order Type | Code |
---|---|
PURCHASED | 0 |
CANCELLED | 1 |
(legacy code) | 2 |
CLOSED | 3 |
PAID | 4 |
REOPENED | 5 |
required | object (PermissionsEditDelete) |
required | object (PurchaseOrderDetail) |
{- "metadata": {
- "can_edit": true,
- "can_delete": true
}, - "data": {
- "number": "string",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "purchaser": {
- "id": 0,
- "department": {
- "id": 0,
- "branch": {
- "id": 0,
- "name": "string"
}, - "external_id": "string",
- "name": "string",
- "punchout_email": "user@example.com",
- "active": true
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "phone": "string",
- "address": "string",
- "notifications": true,
- "is_active": true,
- "mobile": true,
- "profile_image": "string",
- "slack_user_id": "string",
- "is_sso_enabled": true,
- "last_changed_by": 0,
- "user": 0,
- "approval_delegatee": {
- "id": 0,
- "department": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}, - "expected_return_date": "2019-08-24"
}, - "procurify_PO": 0,
- "PO_Num": "string",
- "date": "2019-08-24T14:15:22Z",
- "buyer_name": "string",
- "buyer_contact": "string",
- "buyer_addressLineOne": "string",
- "buyer_postalCode": "string",
- "buyer_city": "string",
- "buyer_state_province": "string",
- "buyer_country": "string",
- "buyer_address": {
- "id": 0,
- "is_active": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "addressAssociation": 1,
- "addressLineOne": "string",
- "addressLineTwo": "string",
- "postalCode": "string",
- "city": "string",
- "state_province": "string",
- "country": "string",
- "last_changed_by": 0
}, - "receiver_name": "string",
- "receiver_contact": "string",
- "receiver_addressLineOne": "string",
- "receiver_postalCode": "string",
- "receiver_city": "string",
- "receiver_state_province": "string",
- "receiver_country": "string",
- "receiver_address": {
- "id": 0,
- "is_active": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "addressAssociation": 1,
- "addressLineOne": "string",
- "addressLineTwo": "string",
- "postalCode": "string",
- "city": "string",
- "state_province": "string",
- "country": "string",
- "last_changed_by": 0
}, - "pref_vendor": {
- "id": 0,
- "name": "string",
- "active": true,
- "addressLineOne": "string",
- "addressLineTwo": "string",
- "postalCode": "string",
- "city": "string",
- "state_province": "string",
- "country": "string",
- "phoneOne": "string",
- "phoneTwo": "string",
- "fax": "string",
- "email": [
- "user@example.com"
], - "comments": "string",
- "contact": "string",
- "url": "string",
- "external_id": "string",
- "dateModified": "2019-08-24T14:15:22Z",
- "currency": 0,
- "payment_term_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "shipping_term_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "payment_method_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "shipping_method_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "payment_methods": [
- {
- "id": 0,
- "name": "string",
- "type": 0,
- "data": null,
- "currency": {
- "id": 0,
- "name": "string",
- "description": "string",
- "rate": "string",
- "base": true,
- "active": true
}
}
], - "tax": 0,
- "type": 2,
- "default_payment_method": 0,
- "creditcards": [
- {
- "id": 0,
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "is_active": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "number": "string",
- "balance": -2147483648,
- "gl_code": "string",
- "type": 0,
- "category": 0,
- "external_id": "string",
- "status": "pending",
- "require_activation": true,
- "last_changed_by": 0,
- "vendor": 0,
- "payment_method": 0,
- "currency": 0,
- "currency_name": "string",
- "creator": 0,
- "assignees": [
- {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "profile_image": "string"
}
]
}
], - "is_1099_eligible": true,
- "overall_score": 0,
- "is_auto_email_po_enabled": true,
- "po_pdf_labels": "string"
}, - "vendor_name": "string",
- "vendor_contact": "string",
- "vendor_addressLineOne": "string",
- "vendor_postalCode": "string",
- "vendor_city": "string",
- "vendor_state_province": "string",
- "vendor_country": "string",
- "payment_terms": "string",
- "shipping_terms": "string",
- "shipping_method": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "promise_date": "2019-08-24T14:15:22Z",
- "subtotal": "string",
- "freight": "string",
- "tax": {
- "value": 0,
- "type": "amount"
}, - "discount": {
- "value": 0,
- "type": "amount"
}, - "other": "string",
- "total": "string",
- "comment": "string",
- "purchased_currency": {
- "id": 0,
- "name": "string",
- "rate": "string",
- "base": true
}, - "purchased_currency_rate": "string",
- "active": true,
- "state": 0,
- "fulfilment_status": "empty",
- "disclaimer_description": "string",
- "disclaimer_text": "string",
- "recorded_date": "2019-08-24T14:15:22Z",
- "closed_date": "2019-08-24T14:15:22Z",
- "last_modified": "2019-08-24T14:15:22Z",
- "staged_for_export": true,
- "version": -2147483648,
- "item_count": 0,
- "most_recent_version": -2147483648,
- "punchout_system": 0,
- "purchase_agreement": 0,
- "purchase_agreement_status": { },
- "punchout_vendor_reference": 0,
- "punchout_supplier_icon": "string",
- "punchout_supplier_name": "string",
- "has_blanket_order_items": true,
- "expiry_date": "2019-08-24T14:15:22Z",
- "contract": {
- "id": 0,
- "uuid": "string",
- "name": "string"
}, - "order_items": [
- {
- "PO": [
- 0
], - "PO_line_num": -2147483648,
- "account": {
- "id": 0,
- "account_code": {
- "id": 0,
- "applied_accounts_count": 0,
- "code": "string",
- "code_length": -2147483648,
- "description": "string",
- "account_type": 0,
- "active": true,
- "parent": 0
}, - "department": {
- "id": 0,
- "branch": {
- "id": 0,
- "name": "string"
}, - "external_id": "string",
- "name": "string",
- "punchout_email": "user@example.com",
- "active": true
}, - "warning_indicator": true,
- "budget_used_approved": 0,
- "budget_used_purchased": 0,
- "start_datetime": "2019-08-24T14:15:22Z",
- "end_datetime": "2019-08-24T14:15:22Z",
- "budget": "string",
- "balance_approved": "string",
- "balance_purchased": "string",
- "active": true
}, - "accountCode": "string",
- "active": true,
- "approved_currency_rate": "string",
- "approved_datetime": "2019-08-24T14:15:22Z",
- "approved_price": "string",
- "approved_quantity": 0,
- "approved_shipping_amount": "string",
- "approved_tax_amount": "string",
- "attachments": [
- {
- "id": 0,
- "attachment": "string",
- "upload_datetime": "2019-08-24T14:15:22Z",
- "name": "string",
- "type": "other",
- "user": 0,
- "item": 0
}
], - "catalog_item": {
- "id": 0,
- "name": "string",
- "image": "string",
- "unitType": "string",
- "pref_vendor": {
- "id": 0,
- "name": "string",
- "active": true,
- "addressLineOne": "string",
- "addressLineTwo": "string",
- "postalCode": "string",
- "city": "string",
- "state_province": "string",
- "country": "string",
- "phoneOne": "string",
- "phoneTwo": "string",
- "fax": "string",
- "email": [
- "user@example.com"
], - "comments": "string",
- "contact": "string",
- "url": "string",
- "external_id": "string",
- "dateModified": "2019-08-24T14:15:22Z",
- "currency": 0,
- "payment_term_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "shipping_term_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "payment_method_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "shipping_method_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "payment_methods": [
- {
- "id": null,
- "name": null,
- "type": null,
- "data": null,
- "currency": null
}
], - "tax": 0,
- "type": 2,
- "default_payment_method": 0,
- "creditcards": [
- {
- "id": null,
- "uuid": null,
- "is_active": null,
- "created_at": null,
- "updated_at": null,
- "name": null,
- "number": null,
- "balance": null,
- "gl_code": null,
- "type": null,
- "category": null,
- "external_id": null,
- "status": null,
- "require_activation": null,
- "last_changed_by": null,
- "vendor": null,
- "payment_method": null,
- "currency": null,
- "currency_name": null,
- "creator": null,
- "assignees": [ ]
}
], - "is_1099_eligible": true,
- "overall_score": 0,
- "is_auto_email_po_enabled": true,
- "po_pdf_labels": "string"
}, - "account_code": {
- "id": 0,
- "applied_accounts_count": 0,
- "code": "string",
- "code_length": -2147483648,
- "description": "string",
- "account_type": 0,
- "active": true,
- "parent": 0
}, - "internalSKU": "string",
- "description": "string",
- "product_url": "string",
- "currency": {
- "id": 0,
- "name": "string",
- "rate": "string",
- "base": true
}, - "price": "string",
- "rfo_lock": true,
- "departments": [
- 0
], - "custom_fields": [
- {
- "id": 0,
- "value": "string",
- "field": {
- "id": null,
- "name": null,
- "content_type": null,
- "default_value": null,
- "is_required": null,
- "field_choices": [ ],
- "field_type": null,
- "field_label": null,
- "is_active": null
}
}
], - "requested_count": -2147483648,
- "last_requested_date": "2019-08-24T14:15:22Z",
- "selected_account": {
- "property1": null,
- "property2": null
}
}, - "created_at": "2019-08-24T14:15:22Z",
- "currency": {
- "id": 0,
- "name": "string",
- "rate": "string",
- "base": true
}, - "dateInvoiced": "2019-08-24T14:15:22Z",
- "external_id": "string",
- "hot": true,
- "id": 0,
- "inventoryItem": 0,
- "is_active": true,
- "item_attachments": [
- {
- "id": 0,
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "file": "string",
- "name": "string",
- "user": 0,
- "description": "string",
- "mimetype": "string",
- "length": -2147483648,
- "sha1_hash": "string",
- "created_at": "2019-08-24T14:15:22Z"
}
], - "last_changed_by": 0,
- "last_modified": "2019-08-24T14:15:22Z",
- "lineComment": "string",
- "name": "string",
- "num": "string",
- "orderNum": 0,
- "po_note": "string",
- "po_version": -2147483648,
- "pref_vendor": {
- "id": 0,
- "name": "string",
- "active": true,
- "addressLineOne": "string",
- "addressLineTwo": "string",
- "postalCode": "string",
- "city": "string",
- "state_province": "string",
- "country": "string",
- "phoneOne": "string",
- "phoneTwo": "string",
- "fax": "string",
- "email": [
- "user@example.com"
], - "comments": "string",
- "contact": "string",
- "url": "string",
- "external_id": "string",
- "dateModified": "2019-08-24T14:15:22Z",
- "currency": 0,
- "payment_term_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "shipping_term_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "payment_method_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "shipping_method_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "payment_methods": [
- {
- "id": 0,
- "name": "string",
- "type": 0,
- "data": null,
- "currency": {
- "id": null,
- "name": null,
- "description": null,
- "rate": null,
- "base": null,
- "active": null
}
}
], - "tax": 0,
- "type": 2,
- "default_payment_method": 0,
- "creditcards": [
- {
- "id": 0,
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "is_active": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "number": "string",
- "balance": -2147483648,
- "gl_code": "string",
- "type": 0,
- "category": 0,
- "external_id": "string",
- "status": "pending",
- "require_activation": true,
- "last_changed_by": 0,
- "vendor": 0,
- "payment_method": 0,
- "currency": 0,
- "currency_name": "string",
- "creator": 0,
- "assignees": [
- null
]
}
], - "is_1099_eligible": true,
- "overall_score": 0,
- "is_auto_email_po_enabled": true,
- "po_pdf_labels": "string"
}, - "price": "string",
- "purchase_order": 0,
- "purchaser": {
- "id": 0,
- "department": {
- "id": 0,
- "branch": {
- "id": 0,
- "name": "string"
}, - "external_id": "string",
- "name": "string",
- "punchout_email": "user@example.com",
- "active": true
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "phone": "string",
- "address": "string",
- "notifications": true,
- "is_active": true,
- "mobile": true,
- "profile_image": "string",
- "slack_user_id": "string",
- "is_sso_enabled": true,
- "last_changed_by": 0,
- "user": 0,
- "approval_delegatee": {
- "id": 0,
- "department": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}, - "expected_return_date": "2019-08-24"
}, - "quantity": 0,
- "receivedFailQty": 0,
- "receivedPassQty": 0,
- "shipping_amount": "string",
- "sku": "string",
- "status": 0,
- "tax_amount": "string",
- "total_cost": "string",
- "unit": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "vendor": "string",
- "receive_method": 0,
- "type": 0,
- "blanket": {
- "price": "string",
- "quantity": 0,
- "amount": 0
}, - "comments": [
- {
- "userprofile": {
- "id": 0,
- "department": {
- "id": null,
- "branch": null,
- "external_id": null,
- "name": null,
- "punchout_email": null,
- "active": null
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "phone": "string",
- "address": "string",
- "notifications": true,
- "is_active": true,
- "mobile": true,
- "profile_image": "string",
- "slack_user_id": "string",
- "is_sso_enabled": true,
- "last_changed_by": 0,
- "user": 0,
- "approval_delegatee": {
- "id": null,
- "department": null,
- "firstName": null,
- "lastName": null,
- "email": null
}, - "expected_return_date": "2019-08-24"
}, - "id": 0,
- "comment": "string",
- "submit_date": "2019-08-24T14:15:22Z"
}
], - "confirmation_status": 0,
- "confirmation_status_description": "string",
- "cost_details": {
- "subtotal": "string",
- "total_cost": "string",
- "total_cost_in_base_currency": "string",
- "tax_amount": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "value": "string",
- "field": {
- "id": 0,
- "name": "string",
- "content_type": 0,
- "default_value": "string",
- "is_required": true,
- "field_choices": [
- null
], - "field_type": "t",
- "field_label": "string",
- "is_active": true
}
}
], - "date_required": "2019-08-24T14:15:22Z",
- "has_sibling_items": true,
- "line_comment": "string",
- "logs": [
- {
- "id": 0,
- "user": {
- "id": 0,
- "department": {
- "id": null,
- "branch": null,
- "external_id": null,
- "name": null,
- "punchout_email": null,
- "active": null
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "phone": "string",
- "address": "string",
- "notifications": true,
- "is_active": true,
- "mobile": true,
- "profile_image": "string",
- "slack_user_id": "string",
- "is_sso_enabled": true,
- "last_changed_by": 0,
- "user": 0,
- "approval_delegatee": {
- "id": null,
- "department": null,
- "firstName": null,
- "lastName": null,
- "email": null
}, - "expected_return_date": "2019-08-24"
}, - "next_approver": {
- "id": 0,
- "department": {
- "id": null,
- "branch": null,
- "external_id": null,
- "name": null,
- "punchout_email": null,
- "active": null
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "phone": "string",
- "address": "string",
- "notifications": true,
- "is_active": true,
- "mobile": true,
- "profile_image": "string",
- "slack_user_id": "string",
- "is_sso_enabled": true,
- "last_changed_by": 0,
- "user": 0,
- "approval_delegatee": {
- "id": null,
- "department": null,
- "firstName": null,
- "lastName": null,
- "email": null
}, - "expected_return_date": "2019-08-24"
}, - "nextApprover": {
- "id": 0,
- "department": {
- "id": null,
- "branch": null,
- "external_id": null,
- "name": null,
- "punchout_email": null,
- "active": null
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "phone": "string",
- "address": "string",
- "notifications": true,
- "is_active": true,
- "mobile": true,
- "profile_image": "string",
- "slack_user_id": "string",
- "is_sso_enabled": true,
- "last_changed_by": 0,
- "user": 0,
- "approval_delegatee": {
- "id": null,
- "department": null,
- "firstName": null,
- "lastName": null,
- "email": null
}, - "expected_return_date": "2019-08-24"
}, - "approval_delegation": {
- "approval_delegatee": {
- "id": null,
- "firstName": null,
- "lastName": null,
- "email": null,
- "department": { }
}, - "expected_return_date": "2019-08-24",
- "delegator": {
- "id": null,
- "firstName": null,
- "lastName": null,
- "email": null
}, - "setter": {
- "id": null,
- "firstName": null,
- "lastName": null,
- "email": null
}
}, - "dateTime": "2019-08-24T14:15:22Z",
- "action": 0,
- "line_qty_pass": "string",
- "line_qty_fail": "string",
- "order": 0,
- "lineItem": 0,
- "PO": 0,
- "inventoryItem": 0,
- "stocking_parent": 0
}
], - "order_description": "string",
- "order_status": 0,
- "order_uuid": "e56795c7-0bc3-4742-a52f-988d2af8608f",
- "punchout_supplier_icon": "string",
- "punchout_supplier_name": "string",
- "punchout_system": 0,
- "punchout_vendor_reference": 0,
- "punchout_supplier_can_update_quantity": true,
- "purchase_order_number": "string",
- "purchase_order_uuid": "62208f57-ed5e-48b5-8bf2-30e42f35ea6f",
- "purchased_currency_rate": "0.000000",
- "recurrence": {
- "id": 0,
- "start_date": "2019-08-24",
- "frequency": 0,
- "duration": 0,
- "duration_quantity": 1,
- "recurring_price": "string",
- "periods_count": 0
}, - "requester": {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "profile_image": "string",
- "approval_delegatee": {
- "id": 0,
- "department": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}, - "expected_return_date": "2019-08-24"
}, - "spend_allocation": [
- {
- "id": 0,
- "amount": "string",
- "account": {
- "id": 0,
- "account_code": {
- "id": null,
- "code": null,
- "code_length": null,
- "description": null,
- "account_type": null,
- "active": null,
- "parent": null
}, - "department": {
- "id": null,
- "branch": null,
- "external_id": null,
- "name": null,
- "punchout_email": null,
- "active": null
}, - "active": true
}
}
], - "submitted_date": "2019-08-24T14:15:22Z",
- "taxes": [
- {
- "id": 0,
- "type": "percent",
- "value": "string",
- "name": "string"
}
], - "receive_log_count": 0,
- "approval_history": [
- {
- "id": 0,
- "user": {
- "id": 0,
- "department": {
- "id": null,
- "branch": null,
- "external_id": null,
- "name": null,
- "punchout_email": null,
- "active": null
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "phone": "string",
- "address": "string",
- "notifications": true,
- "is_active": true,
- "mobile": true,
- "profile_image": "string",
- "slack_user_id": "string",
- "is_sso_enabled": true,
- "last_changed_by": 0,
- "user": 0,
- "approval_delegatee": {
- "id": null,
- "department": null,
- "firstName": null,
- "lastName": null,
- "email": null
}, - "expected_return_date": "2019-08-24"
}, - "next_approver": {
- "id": 0,
- "department": {
- "id": null,
- "branch": null,
- "external_id": null,
- "name": null,
- "punchout_email": null,
- "active": null
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "phone": "string",
- "address": "string",
- "notifications": true,
- "is_active": true,
- "mobile": true,
- "profile_image": "string",
- "slack_user_id": "string",
- "is_sso_enabled": true,
- "last_changed_by": 0,
- "user": 0,
- "approval_delegatee": {
- "id": null,
- "department": null,
- "firstName": null,
- "lastName": null,
- "email": null
}, - "expected_return_date": "2019-08-24"
}, - "nextApprover": {
- "id": 0,
- "department": {
- "id": null,
- "branch": null,
- "external_id": null,
- "name": null,
- "punchout_email": null,
- "active": null
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "phone": "string",
- "address": "string",
- "notifications": true,
- "is_active": true,
- "mobile": true,
- "profile_image": "string",
- "slack_user_id": "string",
- "is_sso_enabled": true,
- "last_changed_by": 0,
- "user": 0,
- "approval_delegatee": {
- "id": null,
- "department": null,
- "firstName": null,
- "lastName": null,
- "email": null
}, - "expected_return_date": "2019-08-24"
}, - "approval_delegation": {
- "approval_delegatee": {
- "id": null,
- "firstName": null,
- "lastName": null,
- "email": null,
- "department": { }
}, - "expected_return_date": "2019-08-24",
- "delegator": {
- "id": null,
- "firstName": null,
- "lastName": null,
- "email": null
}, - "setter": {
- "id": null,
- "firstName": null,
- "lastName": null,
- "email": null
}
}, - "dateTime": "2019-08-24T14:15:22Z",
- "action": 0,
- "line_qty_pass": "string",
- "line_qty_fail": "string",
- "order": 0,
- "lineItem": 0,
- "PO": 0,
- "inventoryItem": 0,
- "stocking_parent": 0
}
], - "flags": [
- {
- "color": "string",
- "symbol": "string",
- "object_id": 4294967295,
- "content_type": 0
}
]
}
], - "creditcard_is_editable": true,
- "custom_fields": [
- {
- "id": 0,
- "value": "string",
- "field": {
- "id": 0,
- "name": "string",
- "content_type": 0,
- "default_value": "string",
- "is_required": true,
- "field_choices": [
- "string"
], - "field_type": "t",
- "field_label": "string",
- "is_active": true
}
}
], - "creditcard": {
- "id": 0,
- "name": "string",
- "number": "string",
- "vendor": {
- "id": 0,
- "name": "string",
- "active": true,
- "addressLineOne": "string",
- "addressLineTwo": "string",
- "postalCode": "string",
- "city": "string",
- "state_province": "string",
- "country": "string",
- "overall_score": "string",
- "is_auto_email_po_enabled": true
}, - "type": 0,
- "currency": {
- "id": 0,
- "name": "string",
- "description": "string",
- "rate": "string",
- "base": true,
- "active": true
}, - "balance": -2147483648,
- "assignees": [
- {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "profile_image": "string",
- "approval_delegatee": {
- "id": 0,
- "department": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}, - "expected_return_date": "2019-08-24"
}
], - "last_reconciliation_date": "2019-08-24T14:15:22Z",
- "last_reconciliation_balance": 0,
- "session": {
- "creditcard": 0,
- "balance": "string",
- "statement_date": "2019-08-24T14:15:22Z"
}, - "gl_code": "string",
- "last_statement_date": "2019-08-24T14:15:22Z"
}, - "payment_term": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "shipping_term": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "cost_details": {
- "subtotal": "string",
- "total_cost": "string",
- "total_cost_in_base_currency": "string",
- "tax_amount": "string"
}
}
}
required | object (PurchaseOrderListMeta) |
required | Array of objects (PurchaseOrderDocs) |
{- "metadata": {
- "counts": {
- "purchased": {
- "all": 0,
- "open": 0,
- "partial": 0,
- "closed": 0,
- "cancelled": 0,
- "page": 0
}, - "receivable": {
- "all": 0,
- "open": 0,
- "partial": 0,
- "closed": 0,
- "cancelled": 0,
- "page": 0
}
}, - "pagination": {
- "count": 0,
- "next": "string",
- "previous": "string",
- "page_size": 0,
- "num_pages": 0,
- "current_page": 0
}
}, - "data": [
- {
- "number": "string",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "purchaser": {
- "id": 0,
- "department": {
- "id": 0,
- "branch": {
- "id": 0,
- "name": "string"
}, - "external_id": "string",
- "name": "string",
- "punchout_email": "user@example.com",
- "active": true
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "phone": "string",
- "address": "string",
- "notifications": true,
- "is_active": true,
- "mobile": true,
- "profile_image": "string",
- "slack_user_id": "string",
- "is_sso_enabled": true,
- "last_changed_by": 0,
- "user": 0,
- "approval_delegatee": {
- "id": 0,
- "department": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}, - "expected_return_date": "2019-08-24"
}, - "procurify_PO": 0,
- "PO_Num": "string",
- "date": "2019-08-24T14:15:22Z",
- "buyer_name": "string",
- "buyer_contact": "string",
- "buyer_addressLineOne": "string",
- "buyer_postalCode": "string",
- "buyer_city": "string",
- "buyer_state_province": "string",
- "buyer_country": "string",
- "buyer_address": {
- "id": 0,
- "is_active": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "addressAssociation": 1,
- "addressLineOne": "string",
- "addressLineTwo": "string",
- "postalCode": "string",
- "city": "string",
- "state_province": "string",
- "country": "string",
- "last_changed_by": 0
}, - "receiver_name": "string",
- "receiver_contact": "string",
- "receiver_addressLineOne": "string",
- "receiver_postalCode": "string",
- "receiver_city": "string",
- "receiver_state_province": "string",
- "receiver_country": "string",
- "receiver_address": {
- "id": 0,
- "is_active": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "addressAssociation": 1,
- "addressLineOne": "string",
- "addressLineTwo": "string",
- "postalCode": "string",
- "city": "string",
- "state_province": "string",
- "country": "string",
- "last_changed_by": 0
}, - "pref_vendor": {
- "id": 0,
- "name": "string",
- "active": true,
- "addressLineOne": "string",
- "addressLineTwo": "string",
- "postalCode": "string",
- "city": "string",
- "state_province": "string",
- "country": "string",
- "phoneOne": "string",
- "phoneTwo": "string",
- "fax": "string",
- "email": [
- "user@example.com"
], - "comments": "string",
- "contact": "string",
- "url": "string",
- "external_id": "string",
- "dateModified": "2019-08-24T14:15:22Z",
- "currency": 0,
- "payment_term_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "shipping_term_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "payment_method_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "shipping_method_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "payment_methods": [
- {
- "id": 0,
- "name": "string",
- "type": 0,
- "data": null,
- "currency": {
- "id": 0,
- "name": "string",
- "description": "string",
- "rate": "string",
- "base": true,
- "active": true
}
}
], - "tax": 0,
- "type": 2,
- "default_payment_method": 0,
- "creditcards": [
- {
- "id": 0,
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "is_active": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "number": "string",
- "balance": -2147483648,
- "gl_code": "string",
- "type": 0,
- "category": 0,
- "external_id": "string",
- "status": "pending",
- "require_activation": true,
- "last_changed_by": 0,
- "vendor": 0,
- "payment_method": 0,
- "currency": 0,
- "currency_name": "string",
- "creator": 0,
- "assignees": [
- {
- "id": null,
- "firstName": null,
- "lastName": null,
- "email": null,
- "profile_image": null
}
]
}
], - "is_1099_eligible": true,
- "overall_score": 0,
- "is_auto_email_po_enabled": true,
- "po_pdf_labels": "string"
}, - "vendor_name": "string",
- "vendor_contact": "string",
- "vendor_addressLineOne": "string",
- "vendor_postalCode": "string",
- "vendor_city": "string",
- "vendor_state_province": "string",
- "vendor_country": "string",
- "payment_terms": "string",
- "shipping_terms": "string",
- "shipping_method": "string",
- "promise_date": "2019-08-24T14:15:22Z",
- "subtotal": "string",
- "freight": "string",
- "tax": {
- "value": 0,
- "type": "amount"
}, - "discount": {
- "value": 0,
- "type": "amount"
}, - "other": "string",
- "total": "string",
- "comment": "string",
- "purchased_currency": {
- "id": 0,
- "name": "string",
- "rate": "string",
- "base": true
}, - "purchased_currency_rate": "string",
- "active": true,
- "state": 0,
- "fulfilment_status": "empty",
- "disclaimer_description": "string",
- "disclaimer_text": "string",
- "recorded_date": "2019-08-24T14:15:22Z",
- "closed_date": "2019-08-24T14:15:22Z",
- "last_modified": "2019-08-24T14:15:22Z",
- "staged_for_export": true,
- "version": -2147483648,
- "item_count": 0,
- "most_recent_version": -2147483648,
- "punchout_system": 0,
- "purchase_agreement": 0,
- "purchase_agreement_status": { },
- "punchout_vendor_reference": 0,
- "punchout_supplier_icon": "string",
- "punchout_supplier_name": "string",
- "has_blanket_order_items": true,
- "expiry_date": "2019-08-24T14:15:22Z",
- "contract": {
- "id": 0,
- "uuid": "string",
- "name": "string"
}
}
]
}
object Default: {} | |
required | object (PurchaseOrderUpdate) |
{- "order_items": [
- {
- "id": 0,
- "name": "string",
- "sku": "string",
- "unit": "string",
- "quantity": "string",
- "price": "string",
- "po_note": "string",
- "custom_fields": [
- {
- "property1": null,
- "property2": null
}
], - "tax_amount": "string",
- "shipping_amount": "string"
}
], - "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": {
- "property1": null,
- "property2": null
}, - "tax": {
- "property1": null,
- "property2": null
}, - "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
}
{- "metadata": { },
- "data": {
- "order_items": [
- {
- "id": 0,
- "name": "string",
- "sku": "string",
- "unit": "string",
- "quantity": "string",
- "price": "string",
- "po_note": "string",
- "custom_fields": [
- {
- "property1": null,
- "property2": null
}
], - "tax_amount": "string",
- "shipping_amount": "string"
}
], - "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": {
- "property1": null,
- "property2": null
}, - "tax": {
- "property1": null,
- "property2": null
}, - "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
}
}
object Default: {} | |
required | object (PurchaseOrderReadDocs) |
{- "metadata": { },
- "data": {
- "id": 0,
- "PO_Num": "string",
- "date": "2019-08-24T14:15:22Z",
- "discount": {
- "value": 0,
- "type": "amount"
}, - "freight": "string",
- "fulfilment_status": "empty",
- "item_count": 0,
- "last_modified": "2019-08-24T14:15:22Z",
- "number": "string",
- "other": "string",
- "pref_vendor": {
- "id": 0,
- "name": "string",
- "active": true,
- "addressLineOne": "string",
- "addressLineTwo": "string",
- "postalCode": "string",
- "city": "string",
- "state_province": "string",
- "country": "string",
- "overall_score": "string",
- "is_auto_email_po_enabled": true
}, - "procurify_PO": 0,
- "promise_date": "2019-08-24T14:15:22Z",
- "punchout_system": 0,
- "purchase_agreement": 0,
- "purchase_agreement_status": { },
- "purchased_currency": {
- "id": 0,
- "name": "string",
- "rate": "string"
}, - "purchased_currency_rate": "string",
- "purchaser": {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "profile_image": "string",
- "department_name": "string",
- "branch_name": "string"
}, - "state": 0,
- "subtotal": "string",
- "total": "string",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "version": -2147483648,
- "punchout_items_rejected": true,
- "total_amount": "string",
- "currency": "",
- "email_status": "string",
- "email_status_updated_at": "2019-08-24T14:15:22Z",
- "punchout_supplier_name": "string",
- "punchout_supplier_icon": "string",
- "punchout_vendor_reference": 0,
- "has_blanket_order_items": true,
- "expiry_date": "2019-08-24T14:15:22Z"
}
}
object Default: {} | |
required | Array of objects (PurchaseOrderBillingHistory) |
{- "metadata": { },
- "data": [
- {
- "id": 0,
- "number": "string",
- "has_unbilled_unreceived_items": true,
- "items": [
- {
- "id": 0,
- "billed_qty": "0.00000000",
- "received_qty": "0.00000"
}
]
}
]
}
Order Item Status Codes
Order Item Type | Code | Description |
---|---|---|
PURCHASE_PENDING | 0 | Approved but not purchased. |
PURCHASE_INUSE | 1 | Added to purchaser's PO list. |
RECEIVE_PENDING | 2 | Purchased but not yet received, i.e. receivedPassQty == 0. |
RECEIVED | 3 | Fully received, i.e. receivedPassQty == quantity. |
REJECTED_FOR_PURCHASE | 4 | Rejected at procurement, i.e. denied. |
RECEIVE_PARTIAL | 5 | Partially received, i.e. receivedPassQty != quantity and receivedPassQty > 0. |
FULFILLED | 6 | Received but unused. |
APPROVAL_DENIED | 7 | Denied in approval routing (by approver). |
REQUEST_DRAFT | 8 | Preparing for draft instead of using sessions. |
object | |
Array of objects (OrderItem) |
{- "metadata": {
- "pagination": {
- "count": 10,
- "next": null,
- "previous": null,
- "page_size": 10,
- "num_pages": 1,
- "current_page": 1
}
}, - "data": [
- {
- "PO": [
- 0
], - "PO_line_num": -2147483648,
- "account": 0,
- "accountCode": "string",
- "active": true,
- "approved_currency_rate": "string",
- "approved_datetime": "2019-08-24T14:15:22Z",
- "approved_price": "string",
- "approved_quantity": "string",
- "approved_shipping_amount": "string",
- "approved_tax_amount": "string",
- "attachments": "string",
- "catalog_item": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "currency": 0,
- "dateInvoiced": "2019-08-24T14:15:22Z",
- "external_id": "string",
- "hot": true,
- "id": 0,
- "inventoryItem": 0,
- "is_active": true,
- "item_attachments": [
- 0
], - "last_changed_by": 0,
- "last_modified": "2019-08-24T14:15:22Z",
- "lineComment": "string",
- "name": "string",
- "num": "string",
- "orderNum": 0,
- "po_note": "string",
- "po_version": -2147483648,
- "pref_vendor": 0,
- "price": "string",
- "purchase_order": 0,
- "purchaser": 0,
- "quantity": "string",
- "receivedFailQty": "string",
- "receivedPassQty": "string",
- "shipping_amount": "string",
- "sku": "string",
- "status": 0,
- "tax_amount": "string",
- "total_cost": "string",
- "unit": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "vendor": "string",
- "receive_method": 0,
- "type": 0,
- "blanket": {
- "price": "string",
- "quantity": 0,
- "amount": 0
}
}
]
}
required | object (SingleBillMetadataDocs) |
required | object (BillRead) |
{- "metadata": {
- "permissions": {
- "can_edit": true,
- "can_delete": true,
- "can_approve": true
}, - "summary": {
- "has_multiple_currency": true,
- "total_cost": 0
}
}, - "data": {
- "id": 0,
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "user": {
- "id": 0,
- "department": {
- "id": 0,
- "branch": {
- "id": 0,
- "name": "string"
}, - "external_id": "string",
- "name": "string",
- "punchout_email": "user@example.com",
- "active": true
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "phone": "string",
- "address": "string",
- "notifications": true,
- "is_active": true,
- "mobile": true,
- "profile_image": "string",
- "slack_user_id": "string",
- "is_sso_enabled": true,
- "last_changed_by": 0,
- "user": 0,
- "approval_delegatee": {
- "id": 0,
- "department": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}, - "expected_return_date": "2019-08-24"
}, - "vendor": {
- "id": 0,
- "name": "string",
- "active": true,
- "addressLineOne": "string",
- "addressLineTwo": "string",
- "postalCode": "string",
- "city": "string",
- "state_province": "string",
- "country": "string",
- "phoneOne": "string",
- "phoneTwo": "string",
- "fax": "string",
- "email": [
- "user@example.com"
], - "comments": "string",
- "contact": "string",
- "url": "string",
- "external_id": "string",
- "dateModified": "2019-08-24T14:15:22Z",
- "currency": 0,
- "payment_term_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "shipping_term_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "payment_method_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "shipping_method_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "payment_methods": [
- {
- "id": 0,
- "name": "string",
- "type": 0,
- "data": null,
- "currency": {
- "id": 0,
- "name": "string",
- "description": "string",
- "rate": "string",
- "base": true,
- "active": true
}
}
], - "tax": 0,
- "type": 2,
- "default_payment_method": 0,
- "creditcards": [
- {
- "id": 0,
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "is_active": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "number": "string",
- "balance": -2147483648,
- "gl_code": "string",
- "type": 0,
- "category": 0,
- "external_id": "string",
- "status": "pending",
- "require_activation": true,
- "last_changed_by": 0,
- "vendor": 0,
- "payment_method": 0,
- "currency": 0,
- "currency_name": "string",
- "creator": 0,
- "assignees": [
- {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "profile_image": "string"
}
]
}
], - "is_1099_eligible": true,
- "overall_score": 0,
- "is_auto_email_po_enabled": true,
- "po_pdf_labels": "string"
}, - "approval_chain": 0,
- "approver": {
- "id": 0,
- "user": {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "profile_image": "string",
- "approval_delegatee": {
- "id": 0,
- "department": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}, - "expected_return_date": "2019-08-24"
}, - "amount_limit": "string",
- "item_variance_amount_limit": "string",
- "item_variance_percentage_limit": "string",
- "approval_level": 0
}, - "items": [
- {
- "id": 0,
- "orderitem": {
- "PO": [
- 0
], - "PO_line_num": -2147483648,
- "account": {
- "id": 0,
- "account_code": {
- "id": 0,
- "applied_accounts_count": 0,
- "code": "string",
- "code_length": -2147483648,
- "description": "string",
- "account_type": 0,
- "active": true,
- "parent": 0
}, - "department": {
- "id": 0,
- "branch": {
- "id": null,
- "name": null
}, - "external_id": "string",
- "name": "string",
- "punchout_email": "user@example.com",
- "active": true
}, - "warning_indicator": true,
- "budget_used_approved": 0,
- "budget_used_purchased": 0,
- "start_datetime": "2019-08-24T14:15:22Z",
- "end_datetime": "2019-08-24T14:15:22Z",
- "budget": "string",
- "balance_approved": "string",
- "balance_purchased": "string",
- "active": true
}, - "accountCode": "string",
- "active": true,
- "approved_currency_rate": "string",
- "approved_datetime": "2019-08-24T14:15:22Z",
- "approved_price": "string",
- "approved_quantity": 0,
- "approved_shipping_amount": "string",
- "approved_tax_amount": "string",
- "attachments": "string",
- "catalog_item": {
- "id": 0,
- "name": "string",
- "image": "string",
- "unitType": "string",
- "pref_vendor": {
- "id": 0,
- "name": "string",
- "active": true,
- "addressLineOne": "string",
- "addressLineTwo": "string",
- "postalCode": "string",
- "city": "string",
- "state_province": "string",
- "country": "string",
- "phoneOne": "string",
- "phoneTwo": "string",
- "fax": "string",
- "email": [
- null
], - "comments": "string",
- "contact": "string",
- "url": "string",
- "external_id": "string",
- "dateModified": "2019-08-24T14:15:22Z",
- "currency": 0,
- "payment_term_ref": {
- "id": null,
- "name": null,
- "description": null,
- "active": null
}, - "shipping_term_ref": {
- "id": null,
- "name": null,
- "description": null,
- "active": null
}, - "payment_method_ref": {
- "id": null,
- "name": null,
- "description": null,
- "active": null
}, - "shipping_method_ref": {
- "id": null,
- "name": null,
- "description": null,
- "active": null
}, - "payment_methods": [
- null
], - "tax": 0,
- "type": 2,
- "default_payment_method": 0,
- "creditcards": [
- null
], - "is_1099_eligible": true,
- "overall_score": 0,
- "is_auto_email_po_enabled": true,
- "po_pdf_labels": "string"
}, - "account_code": {
- "id": 0,
- "applied_accounts_count": 0,
- "code": "string",
- "code_length": -2147483648,
- "description": "string",
- "account_type": 0,
- "active": true,
- "parent": 0
}, - "internalSKU": "string",
- "description": "string",
- "product_url": "string",
- "currency": {
- "id": 0,
- "name": "string",
- "rate": "string",
- "base": true
}, - "price": "string",
- "rfo_lock": true,
- "departments": [
- 0
], - "custom_fields": [
- {
- "id": null,
- "value": null,
- "field": null
}
], - "requested_count": -2147483648,
- "last_requested_date": "2019-08-24T14:15:22Z",
- "selected_account": {
- "property1": null,
- "property2": null
}
}, - "created_at": "2019-08-24T14:15:22Z",
- "currency": {
- "id": 0,
- "name": "string",
- "rate": "string",
- "base": true
}, - "dateInvoiced": "2019-08-24T14:15:22Z",
- "external_id": "string",
- "hot": true,
- "id": 0,
- "inventoryItem": 0,
- "is_active": true,
- "item_attachments": [
- {
- "id": 0,
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "file": "string",
- "name": "string",
- "user": 0,
- "description": "string",
- "mimetype": "string",
- "length": -2147483648,
- "sha1_hash": "string",
- "created_at": "2019-08-24T14:15:22Z"
}
], - "last_changed_by": 0,
- "last_modified": "2019-08-24T14:15:22Z",
- "lineComment": "string",
- "name": "string",
- "num": "string",
- "orderNum": 0,
- "po_note": "string",
- "po_version": -2147483648,
- "pref_vendor": {
- "id": 0,
- "name": "string",
- "active": true,
- "addressLineOne": "string",
- "addressLineTwo": "string",
- "postalCode": "string",
- "city": "string",
- "state_province": "string",
- "country": "string",
- "phoneOne": "string",
- "phoneTwo": "string",
- "fax": "string",
- "email": [
- "user@example.com"
], - "comments": "string",
- "contact": "string",
- "url": "string",
- "external_id": "string",
- "dateModified": "2019-08-24T14:15:22Z",
- "currency": 0,
- "payment_term_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "shipping_term_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "payment_method_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "shipping_method_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "payment_methods": [
- {
- "id": null,
- "name": null,
- "type": null,
- "data": null,
- "currency": null
}
], - "tax": 0,
- "type": 2,
- "default_payment_method": 0,
- "creditcards": [
- {
- "id": null,
- "uuid": null,
- "is_active": null,
- "created_at": null,
- "updated_at": null,
- "name": null,
- "number": null,
- "balance": null,
- "gl_code": null,
- "type": null,
- "category": null,
- "external_id": null,
- "status": null,
- "require_activation": null,
- "last_changed_by": null,
- "vendor": null,
- "payment_method": null,
- "currency": null,
- "currency_name": null,
- "creator": null,
- "assignees": [ ]
}
], - "is_1099_eligible": true,
- "overall_score": 0,
- "is_auto_email_po_enabled": true,
- "po_pdf_labels": "string"
}, - "price": "string",
- "purchase_order": 0,
- "purchaser": {
- "id": 0,
- "department": {
- "id": 0,
- "branch": {
- "id": null,
- "name": null
}, - "external_id": "string",
- "name": "string",
- "punchout_email": "user@example.com",
- "active": true
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "phone": "string",
- "address": "string",
- "notifications": true,
- "is_active": true,
- "mobile": true,
- "profile_image": "string",
- "slack_user_id": "string",
- "is_sso_enabled": true,
- "last_changed_by": 0,
- "user": 0,
- "approval_delegatee": {
- "id": 0,
- "department": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}, - "expected_return_date": "2019-08-24"
}, - "quantity": 0,
- "receivedFailQty": 0,
- "receivedPassQty": 0,
- "shipping_amount": "string",
- "sku": "string",
- "status": 0,
- "tax_amount": "string",
- "total_cost": "string",
- "unit": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "vendor": "string",
- "receive_method": 0,
- "type": 0,
- "blanket": {
- "price": "string",
- "quantity": 0,
- "amount": 0
}, - "comments": [
- {
- "userprofile": {
- "id": null,
- "department": null,
- "created_at": null,
- "updated_at": null,
- "firstName": null,
- "lastName": null,
- "email": null,
- "position": null,
- "phone": null,
- "address": null,
- "notifications": null,
- "is_active": null,
- "mobile": null,
- "profile_image": null,
- "slack_user_id": null,
- "is_sso_enabled": null,
- "last_changed_by": null,
- "user": null,
- "approval_delegatee": { },
- "expected_return_date": null
}, - "id": 0,
- "comment": "string",
- "submit_date": "2019-08-24T14:15:22Z"
}
], - "confirmation_status": 0,
- "confirmation_status_description": "string",
- "cost_details": {
- "subtotal": "string",
- "total_cost": "string",
- "total_cost_in_base_currency": "string",
- "tax_amount": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "value": "string",
- "field": {
- "id": null,
- "name": null,
- "content_type": null,
- "default_value": null,
- "is_required": null,
- "field_choices": [ ],
- "field_type": null,
- "field_label": null,
- "is_active": null
}
}
], - "date_required": "2019-08-24T14:15:22Z",
- "has_sibling_items": true,
- "line_comment": "string",
- "logs": [
- {
- "id": 0,
- "user": {
- "id": null,
- "department": null,
- "created_at": null,
- "updated_at": null,
- "firstName": null,
- "lastName": null,
- "email": null,
- "position": null,
- "phone": null,
- "address": null,
- "notifications": null,
- "is_active": null,
- "mobile": null,
- "profile_image": null,
- "slack_user_id": null,
- "is_sso_enabled": null,
- "last_changed_by": null,
- "user": null,
- "approval_delegatee": { },
- "expected_return_date": null
}, - "next_approver": {
- "id": null,
- "department": null,
- "created_at": null,
- "updated_at": null,
- "firstName": null,
- "lastName": null,
- "email": null,
- "position": null,
- "phone": null,
- "address": null,
- "notifications": null,
- "is_active": null,
- "mobile": null,
- "profile_image": null,
- "slack_user_id": null,
- "is_sso_enabled": null,
- "last_changed_by": null,
- "user": null,
- "approval_delegatee": { },
- "expected_return_date": null
}, - "nextApprover": {
- "id": null,
- "department": null,
- "created_at": null,
- "updated_at": null,
- "firstName": null,
- "lastName": null,
- "email": null,
- "position": null,
- "phone": null,
- "address": null,
- "notifications": null,
- "is_active": null,
- "mobile": null,
- "profile_image": null,
- "slack_user_id": null,
- "is_sso_enabled": null,
- "last_changed_by": null,
- "user": null,
- "approval_delegatee": { },
- "expected_return_date": null
}, - "approval_delegation": {
- "approval_delegatee": null,
- "expected_return_date": null,
- "delegator": null,
- "setter": null
}, - "dateTime": "2019-08-24T14:15:22Z",
- "action": 0,
- "line_qty_pass": "string",
- "line_qty_fail": "string",
- "order": 0,
- "lineItem": 0,
- "PO": 0,
- "inventoryItem": 0,
- "stocking_parent": 0
}
], - "order_description": "string",
- "order_status": 0,
- "order_uuid": "e56795c7-0bc3-4742-a52f-988d2af8608f",
- "punchout_supplier_icon": "string",
- "punchout_supplier_name": "string",
- "punchout_system": 0,
- "punchout_vendor_reference": 0,
- "punchout_supplier_can_update_quantity": true,
- "purchase_order_number": "string",
- "purchase_order_uuid": "62208f57-ed5e-48b5-8bf2-30e42f35ea6f",
- "purchased_currency_rate": "0.000000",
- "recurrence": {
- "id": 0,
- "start_date": "2019-08-24",
- "frequency": 0,
- "duration": 0,
- "duration_quantity": 1,
- "recurring_price": "string",
- "periods_count": 0
}, - "requester": {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "profile_image": "string",
- "approval_delegatee": {
- "id": 0,
- "department": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}, - "expected_return_date": "2019-08-24"
}, - "spend_allocation": [
- {
- "id": 0,
- "amount": "string",
- "account": {
- "id": null,
- "account_code": null,
- "department": null,
- "active": null
}
}
], - "submitted_date": "2019-08-24T14:15:22Z",
- "taxes": [
- {
- "id": 0,
- "type": "percent",
- "value": "string",
- "name": "string"
}
]
}, - "expense": {
- "id": 0,
- "account": {
- "id": 0,
- "account_code": {
- "id": 0,
- "applied_accounts_count": 0,
- "code": "string",
- "code_length": -2147483648,
- "description": "string",
- "account_type": 0,
- "active": true,
- "parent": 0
}, - "department": {
- "id": 0,
- "branch": {
- "id": null,
- "name": null
}, - "external_id": "string",
- "name": "string",
- "punchout_email": "user@example.com",
- "active": true
}, - "warning_indicator": true,
- "start_datetime": "2019-08-24T14:15:22Z",
- "end_datetime": "2019-08-24T14:15:22Z",
- "budget": "string",
- "budget_used_approved": "string",
- "budget_used_purchased": "string",
- "balance_approved": "string",
- "balance_purchased": "string",
- "active": true
}, - "localCurrency": {
- "id": 0,
- "name": "string",
- "rate": "string",
- "base": true
}, - "expense_type_fields": null,
- "expenseReport": {
- "id": 0,
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}, - "requester": {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "profile_image": "string",
- "approval_delegatee": {
- "id": 0,
- "department": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}, - "expected_return_date": "2019-08-24"
}, - "approver": {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "profile_image": "string",
- "approval_delegatee": {
- "id": 0,
- "department": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}, - "expected_return_date": "2019-08-24"
}, - "approved_date": "2019-08-24T14:15:22Z",
- "is_active": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "merchant": "string",
- "transDate": "2019-08-24T14:15:22Z",
- "reimburse": true,
- "expense_type": 0,
- "paymentType": 0,
- "amount": "string",
- "currency_rate_final": "string",
- "exchange_rate_override": true,
- "tax_name": "string",
- "tax_percentage": "string",
- "tax_amount": "string",
- "tax_is_inclusive": true,
- "notes": "string",
- "attachment": "string",
- "active": true,
- "last_changed_by": 0,
- "creditcard": 0,
- "tax": 0
}, - "bill": 0,
- "vendor": {
- "id": 0,
- "name": "string",
- "active": true,
- "addressLineOne": "string",
- "addressLineTwo": "string",
- "postalCode": "string",
- "city": "string",
- "state_province": "string",
- "country": "string",
- "phoneOne": "string",
- "phoneTwo": "string",
- "fax": "string",
- "email": [
- "user@example.com"
], - "comments": "string",
- "contact": "string",
- "url": "string",
- "external_id": "string",
- "dateModified": "2019-08-24T14:15:22Z",
- "currency": 0,
- "payment_term_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "shipping_term_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "payment_method_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "shipping_method_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "payment_methods": [
- {
- "id": 0,
- "name": "string",
- "type": 0,
- "data": null,
- "currency": {
- "id": null,
- "name": null,
- "description": null,
- "rate": null,
- "base": null,
- "active": null
}
}
], - "tax": 0,
- "type": 2,
- "default_payment_method": 0,
- "creditcards": [
- {
- "id": 0,
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "is_active": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "number": "string",
- "balance": -2147483648,
- "gl_code": "string",
- "type": 0,
- "category": 0,
- "external_id": "string",
- "status": "pending",
- "require_activation": true,
- "last_changed_by": 0,
- "vendor": 0,
- "payment_method": 0,
- "currency": 0,
- "currency_name": "string",
- "creator": 0,
- "assignees": [
- null
]
}
], - "is_1099_eligible": true,
- "overall_score": 0,
- "is_auto_email_po_enabled": true,
- "po_pdf_labels": "string"
}, - "sku": "string",
- "description": "string",
- "po": {
- "number": "string",
- "id": 0,
- "uuid": "string"
}, - "unit": "string",
- "quantity": "string",
- "currency": {
- "id": 0,
- "name": "string",
- "description": "string",
- "rate": "string",
- "base": true,
- "active": true
}, - "total_cost": 0,
- "received_on": "2019-08-24T14:15:22Z",
- "packing_slips": [
- {
- "id": 0,
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "file": "string",
- "name": "string",
- "user": 0,
- "description": "string",
- "mimetype": "string",
- "length": -2147483648,
- "sha1_hash": "string",
- "created_at": "2019-08-24T14:15:22Z"
}
], - "cost_allocations": [
- {
- "id": 0,
- "budget": {
- "id": 0,
- "account_code": {
- "id": null,
- "applied_accounts_count": null,
- "code": null,
- "code_length": null,
- "description": null,
- "account_type": null,
- "active": null,
- "parent": null
}, - "department": {
- "id": null,
- "branch": null,
- "external_id": null,
- "name": null,
- "punchout_email": null,
- "active": null
}, - "warning_indicator": true,
- "budget_used_approved": 0,
- "budget_used_purchased": 0,
- "start_datetime": "2019-08-24T14:15:22Z",
- "end_datetime": "2019-08-24T14:15:22Z",
- "budget": "string",
- "balance_approved": "string",
- "balance_purchased": "string",
- "active": true
}, - "object_id": 4294967295,
- "amount": "string",
- "currency": {
- "id": 0,
- "name": "string",
- "description": "string",
- "rate": "string",
- "base": true,
- "active": true
}, - "created_on": "2019-08-24T14:15:22Z"
}
], - "archived": true,
- "expense_report": {
- "id": 0,
- "uuid": "string"
}, - "same_unit_cost": true,
- "creditcard_item": {
- "id": 0,
- "creditcard": {
- "id": 0,
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "is_active": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "number": "string",
- "balance": -2147483648,
- "gl_code": "string",
- "type": 0,
- "category": 0,
- "external_id": "string",
- "status": "pending",
- "require_activation": true,
- "last_changed_by": 0,
- "vendor": 0,
- "payment_method": 0,
- "currency": 0,
- "creator": 0
}, - "po": {
- "number": "string",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "purchaser": {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "profile_image": "string",
- "approval_delegatee": {
- "id": null,
- "department": null,
- "firstName": null,
- "lastName": null,
- "email": null
}, - "expected_return_date": "2019-08-24"
}, - "vendor_name": "string"
}, - "expense": {
- "merchant": "string",
- "notes": "string",
- "expenseReport": {
- "id": 0,
- "uuid": "string",
- "user": {
- "id": null,
- "firstName": null,
- "lastName": null,
- "email": null,
- "position": null,
- "profile_image": null,
- "approval_delegatee": { },
- "expected_return_date": null
}
}
}, - "creditcard_is_editable": true,
- "matched_statement_items": [
- {
- "id": 0,
- "creditcard": 0,
- "statement": 0,
- "match": 0,
- "date": "2019-08-24",
- "description": "string",
- "amount": "string",
- "duplicate_of": 0
}
]
}, - "is_edited": true,
- "unit_cost_diff_log": {
- "changed_by": "string",
- "changed_date": "string",
- "original_unit_cost": 0,
- "original_currency_label": "string"
}, - "tax_name": "string",
- "tax_percentage": "string",
- "tax_amount": 0,
- "tax_is_inclusive": true,
- "tax": 0,
- "total_cost_with_tax": 0,
- "shipping_amount": "string",
- "unit_cost": 0,
- "custom_fields": [
- {
- "id": 0,
- "value": "string",
- "field": {
- "id": 0,
- "name": "string",
- "content_type": 0,
- "default_value": "string",
- "is_required": true,
- "field_choices": [
- null
], - "field_type": "t",
- "field_label": "string",
- "is_active": true
}
}
], - "item_type": 0,
- "type": "string",
- "bill_by_cost": true
}
], - "costs": [
- {
- "id": 0,
- "cost_allocation": {
- "id": 0,
- "budget": {
- "id": 0,
- "account_code": {
- "id": 0,
- "applied_accounts_count": 0,
- "code": "string",
- "code_length": -2147483648,
- "description": "string",
- "account_type": 0,
- "active": true,
- "parent": 0
}, - "department": {
- "id": 0,
- "branch": {
- "id": null,
- "name": null
}, - "external_id": "string",
- "name": "string",
- "punchout_email": "user@example.com",
- "active": true
}, - "warning_indicator": true,
- "budget_used_approved": 0,
- "budget_used_purchased": 0,
- "start_datetime": "2019-08-24T14:15:22Z",
- "end_datetime": "2019-08-24T14:15:22Z",
- "budget": "string",
- "balance_approved": "string",
- "balance_purchased": "string",
- "active": true
}, - "object_id": 4294967295,
- "amount": "string",
- "currency": {
- "id": 0,
- "name": "string",
- "description": "string",
- "rate": "string",
- "base": true,
- "active": true
}, - "created_on": "2019-08-24T14:15:22Z"
}, - "name": "string",
- "amount": "string",
- "bill": 0,
- "cost": 0,
- "currency": 0
}
], - "invoice_attachments": [
- {
- "id": 0,
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "file": "string",
- "name": "string",
- "user": 0,
- "description": "string",
- "mimetype": "string",
- "length": -2147483648,
- "sha1_hash": "string",
- "created_at": "2019-08-24T14:15:22Z"
}
], - "bill_statuses": [
- {
- "id": 0,
- "user": {
- "id": 0,
- "department": {
- "id": 0,
- "branch": {
- "id": 0,
- "name": "string"
}, - "external_id": "string",
- "name": "string",
- "punchout_email": "user@example.com",
- "active": true
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "phone": "string",
- "address": "string",
- "notifications": true,
- "is_active": true,
- "mobile": true,
- "profile_image": "string",
- "slack_user_id": "string",
- "is_sso_enabled": true,
- "last_changed_by": 0,
- "user": 0,
- "approval_delegatee": {
- "id": 0,
- "department": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}, - "expected_return_date": "2019-08-24"
}, - "date": "2019-08-24T14:15:22Z",
- "status": 0,
- "bill": 0
}
], - "currency": {
- "id": 0,
- "name": "string",
- "description": "string",
- "rate": "string",
- "base": true,
- "active": true
}, - "comments": [
- {
- "userprofile": {
- "id": 0,
- "department": {
- "id": 0,
- "branch": {
- "id": 0,
- "name": "string"
}, - "external_id": "string",
- "name": "string",
- "punchout_email": "user@example.com",
- "active": true
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "phone": "string",
- "address": "string",
- "notifications": true,
- "is_active": true,
- "mobile": true,
- "profile_image": "string",
- "slack_user_id": "string",
- "is_sso_enabled": true,
- "last_changed_by": 0,
- "user": 0,
- "approval_delegatee": {
- "id": 0,
- "department": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}, - "expected_return_date": "2019-08-24"
}, - "id": 0,
- "comment": "string",
- "submit_date": "2019-08-24T14:15:22Z"
}
], - "version_choices": [
- {
- "pk": 0,
- "version": 0
}
], - "tax_amount": 0,
- "inclusive_tax_amount": 0,
- "exclusive_tax_amount": 0,
- "subtotal_cost": 0,
- "total_cost": 0,
- "total_cost_with_tax": 0,
- "converted_total_cost": 0,
- "next_approver_choices": [
- {
- "id": 0,
- "user": {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "profile_image": "string",
- "approval_delegatee": {
- "id": 0,
- "department": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}, - "expected_return_date": "2019-08-24"
}, - "amount_limit": "string",
- "item_variance_amount_limit": "string",
- "item_variance_percentage_limit": "string",
- "approval_level": 0
}
], - "locked": true,
- "bill_payment": {
- "id": 0,
- "payment": {
- "id": 0,
- "user": 0,
- "approver": 0,
- "status": 0,
- "currency": 0,
- "amount": "string",
- "payment_method": 0,
- "payment_date": "2019-08-24",
- "memo": "string",
- "reference_number": "string",
- "is_processed": true
}, - "payment_method": {
- "id": 0,
- "vendor": 0,
- "name": "string",
- "type": 0,
- "data": "string",
- "currency": {
- "id": 0,
- "name": "string",
- "description": "string",
- "rate": "string",
- "base": true,
- "active": true
}
}, - "amount": "string",
- "transaction": 0
}, - "creditcard": 0,
- "creditcard_name": "string",
- "last_export_user": {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "profile_image": "string",
- "approval_delegatee": {
- "id": 0,
- "department": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}, - "expected_return_date": "2019-08-24"
}, - "last_export_date": "2019-08-24",
- "vendor_name": "string",
- "vendor_contact": "string",
- "vendor_address_one": "string",
- "vendor_address_two": "string",
- "vendor_postal_code": "string",
- "vendor_city": "string",
- "vendor_state_province": "string",
- "vendor_country": "string",
- "last_modified_datetime": "2019-08-24T14:15:22Z",
- "submitted_date": "2019-08-24T14:15:22Z",
- "invoice_number": "string",
- "invoice_date": "2019-08-24T14:15:22Z",
- "due_date": "2019-08-24T14:15:22Z",
- "payment_terms": "string",
- "version": 4294967295,
- "status": 0,
- "type": 0,
- "active": true,
- "note": "string",
- "gl_post_date": "2019-08-24T14:15:22Z",
- "group": 0,
- "payment_method": 0,
- "payment_method_name": "string",
- "added_purchase_orders": [
- {
- "id": 0,
- "number": "string",
- "currency": "string",
- "total_amount": "string"
}
], - "shipping_amount": 0,
- "invoice_uuid": "string"
}
}
Payment Method Types:
Payment Method | Type |
---|---|
OTHER | 0 |
CHECK | 1 |
CHEQUE | 1 |
ACH | 2 |
EFT | 3 |
WIRE | 4 |
The context of 'data' field varies based on different Payment Method type:
Payment Method | 'data' field structure |
---|---|
OTHER | {"description": <string>} |
CHECK/CHEQUE | {"payable_to": <string>} |
ACH | {"routing_number": <string>, "account_number": <string>, "company_name": <string>} |
object | |
Array of objects (CompanyPaymentMethodRead) |
{- "metadata": {
- "pagination": {
- "count": 10,
- "next": null,
- "previous": null,
- "page_size": 10,
- "num_pages": 1,
- "current_page": 1
}
}, - "data": [
- {
- "id": 1,
- "name": "Bank Account",
- "type": 0,
- "data": {
- "description": "Bank Account description"
}, - "currency": {
- "id": 3,
- "name": "USD",
- "description": "",
- "rate": "1.000000",
- "base": true,
- "active": true
}, - "gl_code": "9000"
}
]
}
Payment Method Types:
Payment Method | Type |
---|---|
OTHER | 0 |
CHECK | 1 |
CHEQUE | 1 |
ACH | 2 |
EFT | 3 |
WIRE | 4 |
The context of 'data' field varies based on different Payment Method type:
Payment Method | 'data' field structure |
---|---|
OTHER | {"description": <string>} |
CHECK/CHEQUE | {"payable_to": <string>} |
ACH | {"routing_number": <string>, "account_number": <string>, "company_name": <string>} |
{- "name": "Bank Account",
- "type": 0,
- "data": {
- "description": "Bank Account description"
}, - "gl_code": "9000",
- "currency": 3
}
{- "id": 1,
- "name": "Bank Account",
- "type": 0,
- "data": {
- "description": "Bank Account description"
}, - "currency": {
- "id": 3,
- "name": "USD",
- "description": "",
- "rate": "1.000000",
- "base": true,
- "active": true
}, - "gl_code": "9000"
}
required | object (BillItemsMetadataDocs) |
required | Array of objects (ItemReadSerializer_v2) |
{- "metadata": {
- "summary": {
- "total_items": 0,
- "total_cost": 0
}, - "pagination": {
- "count": 0,
- "next": "string",
- "previous": "string",
- "page_size": 0,
- "num_pages": 0,
- "current_page": 0
}
}, - "data": [
- {
- "id": 0,
- "orderitem": {
- "PO": [
- 0
], - "PO_line_num": -2147483648,
- "account": {
- "id": 0,
- "account_code": {
- "id": 0,
- "applied_accounts_count": 0,
- "code": "string",
- "code_length": -2147483648,
- "description": "string",
- "account_type": 0,
- "active": true,
- "parent": 0
}, - "department": {
- "id": 0,
- "branch": {
- "id": 0,
- "name": "string"
}, - "external_id": "string",
- "name": "string",
- "punchout_email": "user@example.com",
- "active": true
}, - "warning_indicator": true,
- "budget_used_approved": 0,
- "budget_used_purchased": 0,
- "start_datetime": "2019-08-24T14:15:22Z",
- "end_datetime": "2019-08-24T14:15:22Z",
- "budget": "string",
- "balance_approved": "string",
- "balance_purchased": "string",
- "active": true
}, - "accountCode": "string",
- "active": true,
- "approved_currency_rate": "string",
- "approved_datetime": "2019-08-24T14:15:22Z",
- "approved_price": "string",
- "approved_quantity": 0,
- "approved_shipping_amount": "string",
- "approved_tax_amount": "string",
- "attachments": "string",
- "catalog_item": {
- "id": 0,
- "name": "string",
- "image": "string",
- "unitType": "string",
- "pref_vendor": {
- "id": 0,
- "name": "string",
- "active": true,
- "addressLineOne": "string",
- "addressLineTwo": "string",
- "postalCode": "string",
- "city": "string",
- "state_province": "string",
- "country": "string",
- "phoneOne": "string",
- "phoneTwo": "string",
- "fax": "string",
- "email": [
- "user@example.com"
], - "comments": "string",
- "contact": "string",
- "url": "string",
- "external_id": "string",
- "dateModified": "2019-08-24T14:15:22Z",
- "currency": 0,
- "payment_term_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "shipping_term_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "payment_method_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "shipping_method_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "payment_methods": [
- {
- "id": null,
- "name": null,
- "type": null,
- "data": null,
- "currency": null
}
], - "tax": 0,
- "type": 2,
- "default_payment_method": 0,
- "creditcards": [
- {
- "id": null,
- "uuid": null,
- "is_active": null,
- "created_at": null,
- "updated_at": null,
- "name": null,
- "number": null,
- "balance": null,
- "gl_code": null,
- "type": null,
- "category": null,
- "external_id": null,
- "status": null,
- "require_activation": null,
- "last_changed_by": null,
- "vendor": null,
- "payment_method": null,
- "currency": null,
- "currency_name": null,
- "creator": null,
- "assignees": [ ]
}
], - "is_1099_eligible": true,
- "overall_score": 0,
- "is_auto_email_po_enabled": true,
- "po_pdf_labels": "string"
}, - "account_code": {
- "id": 0,
- "applied_accounts_count": 0,
- "code": "string",
- "code_length": -2147483648,
- "description": "string",
- "account_type": 0,
- "active": true,
- "parent": 0
}, - "internalSKU": "string",
- "description": "string",
- "product_url": "string",
- "currency": {
- "id": 0,
- "name": "string",
- "rate": "string",
- "base": true
}, - "price": "string",
- "rfo_lock": true,
- "departments": [
- 0
], - "custom_fields": [
- {
- "id": 0,
- "value": "string",
- "field": {
- "id": null,
- "name": null,
- "content_type": null,
- "default_value": null,
- "is_required": null,
- "field_choices": [ ],
- "field_type": null,
- "field_label": null,
- "is_active": null
}
}
], - "requested_count": -2147483648,
- "last_requested_date": "2019-08-24T14:15:22Z",
- "selected_account": {
- "property1": null,
- "property2": null
}
}, - "created_at": "2019-08-24T14:15:22Z",
- "currency": {
- "id": 0,
- "name": "string",
- "rate": "string",
- "base": true
}, - "dateInvoiced": "2019-08-24T14:15:22Z",
- "external_id": "string",
- "hot": true,
- "id": 0,
- "inventoryItem": 0,
- "is_active": true,
- "item_attachments": [
- {
- "id": 0,
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "file": "string",
- "name": "string",
- "user": 0,
- "description": "string",
- "mimetype": "string",
- "length": -2147483648,
- "sha1_hash": "string",
- "created_at": "2019-08-24T14:15:22Z"
}
], - "last_changed_by": 0,
- "last_modified": "2019-08-24T14:15:22Z",
- "lineComment": "string",
- "name": "string",
- "num": "string",
- "orderNum": 0,
- "po_note": "string",
- "po_version": -2147483648,
- "pref_vendor": {
- "id": 0,
- "name": "string",
- "active": true,
- "addressLineOne": "string",
- "addressLineTwo": "string",
- "postalCode": "string",
- "city": "string",
- "state_province": "string",
- "country": "string",
- "phoneOne": "string",
- "phoneTwo": "string",
- "fax": "string",
- "email": [
- "user@example.com"
], - "comments": "string",
- "contact": "string",
- "url": "string",
- "external_id": "string",
- "dateModified": "2019-08-24T14:15:22Z",
- "currency": 0,
- "payment_term_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "shipping_term_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "payment_method_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "shipping_method_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "payment_methods": [
- {
- "id": 0,
- "name": "string",
- "type": 0,
- "data": null,
- "currency": {
- "id": null,
- "name": null,
- "description": null,
- "rate": null,
- "base": null,
- "active": null
}
}
], - "tax": 0,
- "type": 2,
- "default_payment_method": 0,
- "creditcards": [
- {
- "id": 0,
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "is_active": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "number": "string",
- "balance": -2147483648,
- "gl_code": "string",
- "type": 0,
- "category": 0,
- "external_id": "string",
- "status": "pending",
- "require_activation": true,
- "last_changed_by": 0,
- "vendor": 0,
- "payment_method": 0,
- "currency": 0,
- "currency_name": "string",
- "creator": 0,
- "assignees": [
- null
]
}
], - "is_1099_eligible": true,
- "overall_score": 0,
- "is_auto_email_po_enabled": true,
- "po_pdf_labels": "string"
}, - "price": "string",
- "purchase_order": 0,
- "purchaser": {
- "id": 0,
- "department": {
- "id": 0,
- "branch": {
- "id": 0,
- "name": "string"
}, - "external_id": "string",
- "name": "string",
- "punchout_email": "user@example.com",
- "active": true
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "phone": "string",
- "address": "string",
- "notifications": true,
- "is_active": true,
- "mobile": true,
- "profile_image": "string",
- "slack_user_id": "string",
- "is_sso_enabled": true,
- "last_changed_by": 0,
- "user": 0,
- "approval_delegatee": {
- "id": 0,
- "department": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}, - "expected_return_date": "2019-08-24"
}, - "quantity": 0,
- "receivedFailQty": 0,
- "receivedPassQty": 0,
- "shipping_amount": "string",
- "sku": "string",
- "status": 0,
- "tax_amount": "string",
- "total_cost": "string",
- "unit": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "vendor": "string",
- "receive_method": 0,
- "type": 0,
- "blanket": {
- "price": "string",
- "quantity": 0,
- "amount": 0
}, - "comments": [
- {
- "userprofile": {
- "id": 0,
- "department": {
- "id": null,
- "branch": null,
- "external_id": null,
- "name": null,
- "punchout_email": null,
- "active": null
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "phone": "string",
- "address": "string",
- "notifications": true,
- "is_active": true,
- "mobile": true,
- "profile_image": "string",
- "slack_user_id": "string",
- "is_sso_enabled": true,
- "last_changed_by": 0,
- "user": 0,
- "approval_delegatee": {
- "id": null,
- "department": null,
- "firstName": null,
- "lastName": null,
- "email": null
}, - "expected_return_date": "2019-08-24"
}, - "id": 0,
- "comment": "string",
- "submit_date": "2019-08-24T14:15:22Z"
}
], - "confirmation_status": 0,
- "confirmation_status_description": "string",
- "cost_details": {
- "subtotal": "string",
- "total_cost": "string",
- "total_cost_in_base_currency": "string",
- "tax_amount": "string"
}, - "custom_fields": [
- {
- "id": 0,
- "value": "string",
- "field": {
- "id": 0,
- "name": "string",
- "content_type": 0,
- "default_value": "string",
- "is_required": true,
- "field_choices": [
- null
], - "field_type": "t",
- "field_label": "string",
- "is_active": true
}
}
], - "date_required": "2019-08-24T14:15:22Z",
- "has_sibling_items": true,
- "line_comment": "string",
- "logs": [
- {
- "id": 0,
- "user": {
- "id": 0,
- "department": {
- "id": null,
- "branch": null,
- "external_id": null,
- "name": null,
- "punchout_email": null,
- "active": null
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "phone": "string",
- "address": "string",
- "notifications": true,
- "is_active": true,
- "mobile": true,
- "profile_image": "string",
- "slack_user_id": "string",
- "is_sso_enabled": true,
- "last_changed_by": 0,
- "user": 0,
- "approval_delegatee": {
- "id": null,
- "department": null,
- "firstName": null,
- "lastName": null,
- "email": null
}, - "expected_return_date": "2019-08-24"
}, - "next_approver": {
- "id": 0,
- "department": {
- "id": null,
- "branch": null,
- "external_id": null,
- "name": null,
- "punchout_email": null,
- "active": null
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "phone": "string",
- "address": "string",
- "notifications": true,
- "is_active": true,
- "mobile": true,
- "profile_image": "string",
- "slack_user_id": "string",
- "is_sso_enabled": true,
- "last_changed_by": 0,
- "user": 0,
- "approval_delegatee": {
- "id": null,
- "department": null,
- "firstName": null,
- "lastName": null,
- "email": null
}, - "expected_return_date": "2019-08-24"
}, - "nextApprover": {
- "id": 0,
- "department": {
- "id": null,
- "branch": null,
- "external_id": null,
- "name": null,
- "punchout_email": null,
- "active": null
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "phone": "string",
- "address": "string",
- "notifications": true,
- "is_active": true,
- "mobile": true,
- "profile_image": "string",
- "slack_user_id": "string",
- "is_sso_enabled": true,
- "last_changed_by": 0,
- "user": 0,
- "approval_delegatee": {
- "id": null,
- "department": null,
- "firstName": null,
- "lastName": null,
- "email": null
}, - "expected_return_date": "2019-08-24"
}, - "approval_delegation": {
- "approval_delegatee": {
- "id": null,
- "firstName": null,
- "lastName": null,
- "email": null,
- "department": { }
}, - "expected_return_date": "2019-08-24",
- "delegator": {
- "id": null,
- "firstName": null,
- "lastName": null,
- "email": null
}, - "setter": {
- "id": null,
- "firstName": null,
- "lastName": null,
- "email": null
}
}, - "dateTime": "2019-08-24T14:15:22Z",
- "action": 0,
- "line_qty_pass": "string",
- "line_qty_fail": "string",
- "order": 0,
- "lineItem": 0,
- "PO": 0,
- "inventoryItem": 0,
- "stocking_parent": 0
}
], - "order_description": "string",
- "order_status": 0,
- "order_uuid": "e56795c7-0bc3-4742-a52f-988d2af8608f",
- "punchout_supplier_icon": "string",
- "punchout_supplier_name": "string",
- "punchout_system": 0,
- "punchout_vendor_reference": 0,
- "punchout_supplier_can_update_quantity": true,
- "purchase_order_number": "string",
- "purchase_order_uuid": "62208f57-ed5e-48b5-8bf2-30e42f35ea6f",
- "purchased_currency_rate": "0.000000",
- "recurrence": {
- "id": 0,
- "start_date": "2019-08-24",
- "frequency": 0,
- "duration": 0,
- "duration_quantity": 1,
- "recurring_price": "string",
- "periods_count": 0
}, - "requester": {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "profile_image": "string",
- "approval_delegatee": {
- "id": 0,
- "department": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}, - "expected_return_date": "2019-08-24"
}, - "spend_allocation": [
- {
- "id": 0,
- "amount": "string",
- "account": {
- "id": 0,
- "account_code": {
- "id": null,
- "code": null,
- "code_length": null,
- "description": null,
- "account_type": null,
- "active": null,
- "parent": null
}, - "department": {
- "id": null,
- "branch": null,
- "external_id": null,
- "name": null,
- "punchout_email": null,
- "active": null
}, - "active": true
}
}
], - "submitted_date": "2019-08-24T14:15:22Z",
- "taxes": [
- {
- "id": 0,
- "type": "percent",
- "value": "string",
- "name": "string"
}
]
}, - "expense": {
- "id": 0,
- "account": {
- "id": 0,
- "account_code": {
- "id": 0,
- "applied_accounts_count": 0,
- "code": "string",
- "code_length": -2147483648,
- "description": "string",
- "account_type": 0,
- "active": true,
- "parent": 0
}, - "department": {
- "id": 0,
- "branch": {
- "id": 0,
- "name": "string"
}, - "external_id": "string",
- "name": "string",
- "punchout_email": "user@example.com",
- "active": true
}, - "warning_indicator": true,
- "start_datetime": "2019-08-24T14:15:22Z",
- "end_datetime": "2019-08-24T14:15:22Z",
- "budget": "string",
- "budget_used_approved": "string",
- "budget_used_purchased": "string",
- "balance_approved": "string",
- "balance_purchased": "string",
- "active": true
}, - "localCurrency": {
- "id": 0,
- "name": "string",
- "rate": "string",
- "base": true
}, - "expense_type_fields": null,
- "expenseReport": {
- "id": 0,
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}, - "requester": {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "profile_image": "string",
- "approval_delegatee": {
- "id": 0,
- "department": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}, - "expected_return_date": "2019-08-24"
}, - "approver": {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "profile_image": "string",
- "approval_delegatee": {
- "id": 0,
- "department": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}, - "expected_return_date": "2019-08-24"
}, - "approved_date": "2019-08-24T14:15:22Z",
- "is_active": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "merchant": "string",
- "transDate": "2019-08-24T14:15:22Z",
- "reimburse": true,
- "expense_type": 0,
- "paymentType": 0,
- "amount": "string",
- "currency_rate_final": "string",
- "exchange_rate_override": true,
- "tax_name": "string",
- "tax_percentage": "string",
- "tax_amount": "string",
- "tax_is_inclusive": true,
- "notes": "string",
- "attachment": "string",
- "active": true,
- "last_changed_by": 0,
- "creditcard": 0,
- "tax": 0
}, - "bill": 0,
- "vendor": {
- "id": 0,
- "name": "string",
- "active": true,
- "addressLineOne": "string",
- "addressLineTwo": "string",
- "postalCode": "string",
- "city": "string",
- "state_province": "string",
- "country": "string",
- "phoneOne": "string",
- "phoneTwo": "string",
- "fax": "string",
- "email": [
- "user@example.com"
], - "comments": "string",
- "contact": "string",
- "url": "string",
- "external_id": "string",
- "dateModified": "2019-08-24T14:15:22Z",
- "currency": 0,
- "payment_term_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "shipping_term_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "payment_method_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "shipping_method_ref": {
- "id": 0,
- "name": "string",
- "description": "string",
- "active": true
}, - "payment_methods": [
- {
- "id": 0,
- "name": "string",
- "type": 0,
- "data": null,
- "currency": {
- "id": 0,
- "name": "string",
- "description": "string",
- "rate": "string",
- "base": true,
- "active": true
}
}
], - "tax": 0,
- "type": 2,
- "default_payment_method": 0,
- "creditcards": [
- {
- "id": 0,
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "is_active": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "number": "string",
- "balance": -2147483648,
- "gl_code": "string",
- "type": 0,
- "category": 0,
- "external_id": "string",
- "status": "pending",
- "require_activation": true,
- "last_changed_by": 0,
- "vendor": 0,
- "payment_method": 0,
- "currency": 0,
- "currency_name": "string",
- "creator": 0,
- "assignees": [
- {
- "id": null,
- "firstName": null,
- "lastName": null,
- "email": null,
- "profile_image": null
}
]
}
], - "is_1099_eligible": true,
- "overall_score": 0,
- "is_auto_email_po_enabled": true,
- "po_pdf_labels": "string"
}, - "sku": "string",
- "description": "string",
- "po": {
- "number": "string",
- "id": 0,
- "uuid": "string"
}, - "unit": "string",
- "quantity": "string",
- "currency": {
- "id": 0,
- "name": "string",
- "description": "string",
- "rate": "string",
- "base": true,
- "active": true
}, - "total_cost": 0,
- "received_on": "2019-08-24T14:15:22Z",
- "packing_slips": [
- {
- "id": 0,
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "file": "string",
- "name": "string",
- "user": 0,
- "description": "string",
- "mimetype": "string",
- "length": -2147483648,
- "sha1_hash": "string",
- "created_at": "2019-08-24T14:15:22Z"
}
], - "cost_allocations": [
- {
- "id": 0,
- "budget": {
- "id": 0,
- "account_code": {
- "id": 0,
- "applied_accounts_count": 0,
- "code": "string",
- "code_length": -2147483648,
- "description": "string",
- "account_type": 0,
- "active": true,
- "parent": 0
}, - "department": {
- "id": 0,
- "branch": {
- "id": null,
- "name": null
}, - "external_id": "string",
- "name": "string",
- "punchout_email": "user@example.com",
- "active": true
}, - "warning_indicator": true,
- "budget_used_approved": 0,
- "budget_used_purchased": 0,
- "start_datetime": "2019-08-24T14:15:22Z",
- "end_datetime": "2019-08-24T14:15:22Z",
- "budget": "string",
- "balance_approved": "string",
- "balance_purchased": "string",
- "active": true
}, - "object_id": 4294967295,
- "amount": "string",
- "currency": {
- "id": 0,
- "name": "string",
- "description": "string",
- "rate": "string",
- "base": true,
- "active": true
}, - "created_on": "2019-08-24T14:15:22Z"
}
], - "archived": true,
- "expense_report": {
- "id": 0,
- "uuid": "string"
}, - "same_unit_cost": true,
- "creditcard_item": {
- "id": 0,
- "creditcard": {
- "id": 0,
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "is_active": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "number": "string",
- "balance": -2147483648,
- "gl_code": "string",
- "type": 0,
- "category": 0,
- "external_id": "string",
- "status": "pending",
- "require_activation": true,
- "last_changed_by": 0,
- "vendor": 0,
- "payment_method": 0,
- "currency": 0,
- "creator": 0
}, - "po": {
- "number": "string",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "purchaser": {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "profile_image": "string",
- "approval_delegatee": {
- "id": 0,
- "department": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}, - "expected_return_date": "2019-08-24"
}, - "vendor_name": "string"
}, - "expense": {
- "merchant": "string",
- "notes": "string",
- "expenseReport": {
- "id": 0,
- "uuid": "string",
- "user": {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "profile_image": "string",
- "approval_delegatee": {
- "id": null,
- "department": null,
- "firstName": null,
- "lastName": null,
- "email": null
}, - "expected_return_date": "2019-08-24"
}
}
}, - "creditcard_is_editable": true,
- "matched_statement_items": [
- {
- "id": 0,
- "creditcard": 0,
- "statement": 0,
- "match": 0,
- "date": "2019-08-24",
- "description": "string",
- "amount": "string",
- "duplicate_of": 0
}
]
}, - "is_edited": true,
- "unit_cost_diff_log": {
- "changed_by": "string",
- "changed_date": "string",
- "original_unit_cost": 0,
- "original_currency_label": "string"
}, - "tax_name": "string",
- "tax_percentage": "string",
- "tax_amount": 0,
- "tax_is_inclusive": true,
- "tax": 0,
- "total_cost_with_tax": 0,
- "shipping_amount": "string",
- "unit_cost": 0,
- "custom_fields": [
- {
- "id": 0,
- "value": "string",
- "field": {
- "id": 0,
- "name": "string",
- "content_type": 0,
- "default_value": "string",
- "is_required": true,
- "field_choices": [
- "string"
], - "field_type": "t",
- "field_label": "string",
- "is_active": true
}
}
], - "item_type": 0,
- "type": "string",
- "bill_by_cost": true
}
]
}
required | object (PaymentMetadataDocs) |
required | Array of objects (PaymentListRead) |
{- "metadata": {
- "permissions": {
- "can_edit": true,
- "can_delete": true,
- "can_approve": true
}, - "summary": {
- "total_cost": 0
}, - "pagination": {
- "count": 0,
- "next": "string",
- "previous": "string",
- "page_size": 0,
- "num_pages": 0,
- "current_page": 0
}
}, - "data": [
- {
- "id": 0,
- "bill_payments": [
- {
- "id": 0,
- "bill": {
- "id": 0,
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "vendor": {
- "id": 0,
- "name": "string"
}, - "tax_amount": 0,
- "vendor_name": "string",
- "due_date": "2019-08-24T14:15:22Z",
- "status": 0,
- "type": 0,
- "group": 0
}, - "user": {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "profile_image": "string",
- "approval_delegatee": 0
}, - "payment_method": {
- "id": 0,
- "vendor": 0,
- "name": "string",
- "type": 0,
- "data": null,
- "currency": {
- "id": 0,
- "name": "string",
- "description": "string",
- "rate": "string",
- "base": true,
- "active": true
}
}, - "amount": "string",
- "transaction": 0
}
], - "payment_method_type": 0,
- "payment_method": {
- "id": 0,
- "name": "string",
- "type": 0,
- "data": null,
- "currency": {
- "id": 0,
- "name": "string",
- "description": "string",
- "rate": "string",
- "base": true,
- "active": true
}, - "gl_code": "string"
}, - "payment_date": "2019-08-24",
- "amount": "string",
- "total_amount_with_tax": "string",
- "tax_amount": "string",
- "inclusive_tax_amount": "string",
- "exclusive_tax_amount": "string",
- "currency": {
- "id": 0,
- "name": "string",
- "description": "string",
- "rate": "string",
- "base": true,
- "active": true
}, - "status": 0,
- "ach_number": 0,
- "next_approver_choices": [
- {
- "id": 0,
- "user": {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "profile_image": "string",
- "approval_delegatee": {
- "id": 0,
- "department": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}, - "expected_return_date": "2019-08-24"
}, - "amount_limit": "string",
- "item_variance_amount_limit": "string",
- "item_variance_percentage_limit": "string",
- "approval_level": 0
}
]
}
]
}
required | object (ApproverChoicesMetadataDocs) |
required | Array of objects (ApproverReadDocs) |
{- "metadata": {
- "permissions": {
- "can_approve": true
}, - "summary": {
- "total_cost": 0
}
}, - "data": [
- {
- "id": 0,
- "user": {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "profile_image": "string",
- "approval_delegatee": {
- "id": 0,
- "department": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}, - "expected_return_date": "2019-08-24"
}, - "amount_limit": "string",
- "item_variance_amount_limit": "string",
- "item_variance_percentage_limit": "string",
- "approval_level": 0,
- "bill_amount_limit": "string"
}
]
}
Payment Method Types:
Payment Method | Type |
---|---|
OTHER | 0 |
CHECK | 1 |
CHEQUE | 1 |
ACH | 2 |
EFT | 3 |
WIRE | 4 |
The context of 'data' field varies based on different Payment Method type:
Payment Method | 'data' field structure |
---|---|
OTHER | {"description": <string>} |
CHECK/CHEQUE | {"payable_to": <string>} |
ACH | {"routing_number": <string>, "account_number": <string>, "company_name": <string>} |
object | |
Array of objects (VendorPaymentMethodRead) |
{- "metadata": {
- "pagination": {
- "count": 10,
- "next": null,
- "previous": null,
- "page_size": 10,
- "num_pages": 1,
- "current_page": 1
}
}, - "data": [
- {
- "id": 1,
- "vendor": 10,
- "name": "Technology Inc ACH 98G395E",
- "type": 2,
- "data": {
- "company_name": "ABC Technology Inc",
- "account_number": "****0021",
- "routing_number": "****7892"
}, - "currency": {
- "id": 3,
- "name": "USD",
- "description": "",
- "rate": "1.000000",
- "base": true,
- "active": true
}
}
]
}
Payment Method Types:
Payment Method | Type |
---|---|
OTHER | 0 |
CHECK | 1 |
CHEQUE | 1 |
ACH | 2 |
EFT | 3 |
WIRE | 4 |
The context of 'data' field varies based on different Payment Method type:
Payment Method | 'data' field structure |
---|---|
OTHER | {"description": <string>} |
CHECK/CHEQUE | {"payable_to": <string>} |
ACH | {"routing_number": <string>, "account_number": <string>, "company_name": <string>} |
{- "vendor": 10,
- "name": "Technology Inc ACH 98G395E",
- "type": 2,
- "data": {
- "company_name": "ABC Technology Inc",
- "account_number": "****0021",
- "routing_number": "****7892"
}, - "currency": 3
}
{- "id": 1,
- "vendor": 10,
- "name": "Technology Inc ACH 98G395E",
- "type": 2,
- "data": {
- "company_name": "ABC Technology Inc",
- "account_number": "****0021",
- "routing_number": "****7892"
}, - "currency": {
- "id": 3,
- "name": "USD",
- "description": "",
- "rate": "1.000000",
- "base": true,
- "active": true
}
}
list: This endpoint supports OPTIONS method which returns a list of available fields and their types.
required | object (ListBillsMetadataDocs) |
required | Array of objects (SimpleBill) |
{- "metadata": {
- "permissions": {
- "can_edit": true,
- "can_delete": true,
- "can_approve": true
}, - "summary": {
- "has_multiple_currency": true,
- "total_cost": 0
}, - "pagination": {
- "count": 0,
- "next": "string",
- "previous": "string",
- "page_size": 0,
- "num_pages": 0,
- "current_page": 0
}
}, - "data": [
- {
- "id": 0,
- "status": 0,
- "version": 4294967295,
- "locked": true,
- "currency": {
- "id": 0,
- "name": "string",
- "rate": "string"
}, - "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "items": [
- 0
], - "vendor": {
- "id": 0,
- "name": "string"
}, - "due_date": "string",
- "total_cost_with_tax": 0,
- "invoice_date": "string",
- "next_approver_choices": [
- {
- "id": 0,
- "user": {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "position": "string",
- "profile_image": "string",
- "approval_delegatee": {
- "id": 0,
- "department": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}, - "expected_return_date": "2019-08-24"
}, - "amount_limit": "string",
- "item_variance_amount_limit": "string",
- "item_variance_percentage_limit": "string",
- "approval_level": 0
}
], - "last_export_user": {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com"
}, - "last_modified_datetime": "2019-08-24T14:15:22Z",
- "last_export_date": "2019-08-24",
- "submitted_date": "2019-08-24T14:15:22Z",
- "gl_post_date": "2019-08-24T14:15:22Z",
- "invoice_number": "string",
- "group": 0,
- "type": 0,
- "user": {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "user@example.com",
- "profile_image": "string",
- "department_name": "string",
- "branch_name": "string"
}, - "approver": {
- "firstName": "string",
- "lastName": "string",
- "profile_image": "string",
- "approval_delegatee": {
- "id": 0,
- "firstName": "string",
- "lastName": "string"
}
}, - "past_due": true,
- "invoice_uuid": "string"
}
]
}
object Default: {} | |
required | object (CustomFieldRead) |
{- "name": "string",
- "default_value": "string",
- "is_required": true,
- "field_type": "string",
- "field_choices": [ ]
}
{- "metadata": { },
- "data": {
- "id": 0,
- "name": "string",
- "content_type": 0,
- "default_value": "string",
- "is_required": true,
- "field_choices": [
- "string"
], - "field_type": "t",
- "field_label": "string",
- "is_active": true
}
}
Get list of custom fields associated with order items
object | |
Array of objects (CustomFieldRead) |
{- "metadata": {
- "pagination": {
- "count": 10,
- "next": null,
- "previous": null,
- "page_size": 10,
- "num_pages": 1,
- "current_page": 1
}
}, - "data": [
- {
- "id": 0,
- "name": "string",
- "content_type": 0,
- "default_value": "string",
- "is_required": true,
- "field_choices": [
- "string"
], - "field_type": "t",
- "field_label": "string",
- "is_active": true
}
]
}