Lists all (or one) suppliers.
Endpoint URL
https://dashboard-api.revnue.com/api/v2/supplier
Authentication and rate limits
| Item | Details |
|---|---|
| Authentication method | OAuth 2.0 Bearer token |
| Rate limit | Rate Limit |
Requests Example
curl --request GET \
--url 'https://dashboard-api.revnue.com/api/v2/supplier/?company=1' \
--header 'Authorization: Bearer $BEARER_TOKEN'
curl --request GET \
--url 'https://dashboard-api.revnue.com/api/v2/supplier/$id/?company=1' \
--header 'Authorization: Bearer $BEARER_TOKEN'
Query Parameters
- company (integer) --
[REQUIRED]
The ID of the specific company your API is calling. For accounts with only one company, the default value is1.
To lookup a specific company ID, see the List Company API. - id (integer) --
Optional if you want to list a specific supplier ID. The id parameter is passed as part of the request url
/supplier/$id/.
Response Syntax
{
"id": integer,
"name": "string",
"category": {
"id": integer,
"name": "string"
},
"contact_person": {
"name": "string",
"email": "string",
"type": "account_management" | "billing" | "executive" | "sales" | "support" | "technical"
},
"address_line_1": "string",
"address_line_2": "string",
"city": "string",
"state_province": "string",
"zip_postal_code": "string",
"country": "string",
"phone": "string",
"mobile": "string",
"fax": "string",
"website": "string",
"general_description": "string",
"type": "us"|"foreign",
"business_name": "string",
"business_address_line_1": "string",
"business_address_line_2": "string",
"business_city": "string",
"business_state_province": "string",
"business_zip_postal_code": "string",
"business_country": "string",
"ein": "string",
"financial_description": "string",
"nda_signed": true | false,
"nda_signed_date": "string",
"msa_signed": true | false,
"msa_signed_date": "string",
"supplementary_description": "string",
"additional_description": "string",
"template":{
"id": integer,
"fields":{
key: value,...
}
}
}
Response Fields
- id (integer) --
The ID of the supplier.
- name (string) --
The name of the supplier.
- category (dict) --
The description of the category properties.
- id (integer) --
The ID of the category.
- name (string) --
The name of the category.
- id (integer) --
- contact_person (dict) --
The description of the contact person properties.
- name (string) --
The name of the contact person.
- email (string) --
The email of the contact person.
- type (string) --
The type of the contact person.
- name (string) --
- address_line_1 (string) --
The address line 1 of the supplier.
- address_line_2 (string) --
The address line 2 of the supplier.
- city (string) --
The city associated to the supplier.
- state_province (string) --
The state/province associated to the supplier.
- zip_postal_code (string) --
The zip/postal code associated to the supplier.
- country (string) --
The country associated to the supplier.
- phone (string) --
The phone of the supplier.
- mobile (string) --
The mobile of the supplier.
- fax (string) --
The fax of the supplier.
- website (string) --
The website of the supplier.
- general_description (string) --
The general description of the supplier.
- type (string) --
The type of the supplier.
- business_name (string) --
The business name of the supplier.
- business_address_line_1 (string) --
The business address line 1 of the supplier.
- business_address_line_2 (string) --
The business address line 2 of the supplier.
- business_city (string) --
The business city associated to the supplier.
- business_state_province (string) --
The business state/province associated to the supplier.
- business_zip_postal_code (string) --
The business zip/postal code associated to the supplier.
- business_country (string) --
The business country associated to the supplier.
- ein (string) --
The employer identification number (EIN) of the supplier.
- financial_description (string) --
The financial description of the supplier.
- nda_signed (boolean) --
Whether the NDA has been signed by the supplier.
- nda_signed_date (string) --
The NDA signed date by the supplier.
- msa_signed (boolean) --
Whether the MSA has been signed by the supplier.
- msa_signed_date (string) --
The MSA signed date by the supplier.
- supplementary_description (string) --
The supplementary description of the supplier.
- additional_description (string) --
The additional description of the supplier.
- template (dict) --
The description of the custom field properties.
- id (integer) --
The ID of the custom field template.
- fields (dict) --
The custom fields and their values as defined in the custom field template. The data type of each custom field value varies depending on its definition.
- id (integer) --