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 (LocationView) |
{- "metadata": {
- "pagination": {
- "count": 10,
- "next": null,
- "previous": null,
- "page_size": 10,
- "num_pages": 1,
- "current_page": 1
}
}, - "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,