For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Contact UsDashboard
DocumentationAPI ReferenceChangelog
DocumentationAPI ReferenceChangelog
  • API Reference
      • GETRetrieve a paginated list of accounting vendors
      • GETRetrieve a specific vendor by ID
      • POSTCreate a single new accounting vendor
      • POSTCreate or update multiple accounting vendors
LogoLogo
Contact UsDashboard
API ReferenceVendors

Retrieve a paginated list of accounting vendors

GET
/vendors
GET
/v1/vendors
$curl -G https://api.ottimate.com/v1/vendors \
>     -H "X-Api-Key: your-api-key-here" \
>     -H "X-API-Version: 1.0.0" \
>     -H "Authorization: Bearer <token>" \
>     -d ottimate_company_id=15196 \
>     -d last_modified_date_from=2024-01-01 \
>     --data-urlencode "last_modified_date_to=2024-12-31 23:59:59"
1{
2  "version": "1.0.0",
3  "count": 100,
4  "page": 1,
5  "limit": 20,
6  "vendors": [
7    {
8      "id": 169860239,
9      "erp_vendor_name": "Sysco Foods Corp",
10      "ottimate_company_id": 15196,
11      "company_name": "Sysco Foods Corp",
12      "erp_vendor_id": "SYS-001",
13      "email": "orders@sysco.com",
14      "phone": "+1-555-123-4567",
15      "net_terms": "Net 30",
16      "payment_method": "wire_transfer",
17      "address_line_1": "1 Sysco Way",
18      "address_line_2": null,
19      "city": "Houston",
20      "state": "TX",
21      "zipcode": "77077"
22    },
23    {
24      "id": 169860240,
25      "erp_vendor_name": "US Foods Inc",
26      "ottimate_company_id": 15196,
27      "company_name": "Sysco Foods Corp",
28      "erp_vendor_id": "USF-002",
29      "email": "contact@usfoods.com",
30      "phone": "+1-555-987-6543",
31      "net_terms": "Net 45",
32      "payment_method": "ach",
33      "address_line_1": "9399 W Higgins Rd",
34      "address_line_2": "Suite 500",
35      "city": "Rosemont",
36      "state": "IL",
37      "zipcode": "60018"
38    },
39    {
40      "id": 169860241,
41      "erp_vendor_name": "Performance Food Group",
42      "ottimate_company_id": 15197,
43      "company_name": "Performance Food Group",
44      "erp_vendor_id": "PFG-003",
45      "email": null,
46      "phone": null,
47      "net_terms": null,
48      "payment_method": "unknown",
49      "address_line_1": null,
50      "address_line_2": null,
51      "city": null,
52      "state": null,
53      "zipcode": null
54    }
55  ]
56}

Returns a paginated list of accounting vendors, filterable by company. The detail=basic query parameter returns a simplified response.

Was this page helpful?
Previous

Retrieve a specific vendor by ID

Next
Built with

Authentication

AuthorizationBearer
OAuth2 authentication flows. Auth server URLs will vary by environment

Headers

X-Api-KeystringRequired
API key for authentication
X-API-VersionenumOptional

API version to use (optional, defaults to latest)

Allowed values:

Query parameters

ottimate_company_idintegerOptional
Filter vendors by company ID
detailenumOptional
Specify the level of detail in the response
Allowed values:
last_modified_date_fromstringOptional

(Beta — this field is available in sandbox and not yet in production.) Filter vendors last modified on or after this date. Requires ottimate_company_id. Accepted formats: YYYY-MM-DD or YYYY-MM-DD HH:MM:SS. All times are interpreted as UTC. A date-only value is treated as 00:00:00 UTC.

last_modified_date_tostringOptional
*(Beta — this field is available in sandbox and not yet in production.)* Filter vendors last modified on or before this date. Requires ottimate_company_id. Accepted formats: YYYY-MM-DD or YYYY-MM-DD HH:MM:SS. All times are interpreted as UTC. A date-only value is treated as 00:00:00 UTC — to include the full day pass an explicit time (e.g. 2024-12-31 23:59:59).

Response

Successful response with paginated vendor list
versionstring
countinteger
pageinteger
limitinteger
vendorslist of objects

Errors

400
Bad Request Error
401
Unauthorized Error

(Beta — this field is available in sandbox and not yet in production.) Filter vendors last modified on or before this date. Requires ottimate_company_id. Accepted formats: YYYY-MM-DD or YYYY-MM-DD HH:MM:SS. All times are interpreted as UTC. A date-only value is treated as 00:00:00 UTC — to include the full day pass an explicit time (e.g. 2024-12-31 23:59:59).