How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Vic.ai Vendors API

Vendors are part of your *ERP* **Masterdata**, and represent companiesthat produce invoices. In order to be associated with an invoice, keydata about the vendor must be stored in Vic.ai. These operations allowquerying and manipulation of the vendor data.

Vic.ai Vendors API is one of 33 APIs that Vic.ai publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Vendors. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 14 operations across 8 paths, and defines 31 schemas. It is described by OpenAPI 3.1.0, at version v10.40.4.

Requests are made against 3 base URLs: https://api.no.stage.vic.ai, https://api.us.vic.ai, https://api.no.vic.ai.

14 operations 8 paths 31 schemas 4 DELETE4 GET3 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v10.40.4
Base URL
https://api.us.vic.ai
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Vic.ai Vendors API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

Paths & Operations 14

Across 8 paths, the API surfaces 14 operations — 4 DELETE, 4 GET, 3 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Vendors 14

Vendors are part of your ERP Masterdata, and represent companies that produce invoices. In order to be associated with an invoice, key data about the vendor must be stored in Vic.…

GET
/v0/vendors
List all vendors
listVendors 8 params → 2004294XX
POST
/v0/vendors/synchronize
Synchronize Vendors
synchronizeVendors → 2044294XX
GET
/v0/vendors/{id}
Info for a specific vendor
getVendor 2 params → 2004294XX
PUT
/v0/vendors/{id}
Upserts a vendor
upsertVendor 3 params body → 2002014294XX
DELETE
/v0/vendors/{id}
Deletes a vendor
deleteVendor 2 params → 2014294XX
POST
/v0/vendors/{id}/errors
Completes the response callback cycle resulting from a 202
setVendorRemoteErrors 3 params body → 2004294XX
DELETE
/v0/vendors/{id}/errors
Clears errors on the Vendor.
clearVendorRemoteErrors 3 params → 2004294XX
DELETE
/v0/vendors/{vendor_id}/tags/{tag_id}
Delete a vendor tag by vendor ID and tag ID
deleteTagFromVendor 3 params → 2044034044294XX
GET
/v0/vendorGroups
List all vendor groups
listVendorGroups 2 params → 2004294XX
POST
/v0/vendorGroups
Create a vendor group
createVendorGroup body → 2014294XX
PUT
/v0/vendorGroups/{id}
Update the vendor group
updateVendorGroup 1 param body → 2004294XX
DELETE
/v0/vendorGroups/{id}
Delete vendor group
deleteVendorGroup 1 param → 2044294XX
GET
/v2/vendors/{id}
Get a vendor by UUID
getVendorV2 1 param → 2004034044XX
PUT
/v2/vendors/{id}
Update a vendor
updateVendorV2 1 param body → 2004224XX

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are VendorV2 (33 properties), Vendor (25 properties), VendorUpsert (21 properties), VendorOfacReport (8 properties). Each schema is shown below with its type and property counts.

VendorManager
object
Vic.ai user who manages a vendor. When email is provided, it takes priority over name. If no user exists with the email provided, then name will be used as a f…
2 properties
Tag
object
2 properties 1 required
VendorV2
object
Full vendor representation with all vendor information and metadata.
33 properties
VendorStateFilter
string
- PENDING - The vendor is not confirmed, has no errors, and was not predicted. It is pending to be confirmed. - ACTIVE - The vendor is confirmed and has no err…
SetVendorRemoteErrors
object
Data structure for setting a Vendor's remote errors.
1 property 1 required
InternalId
string
The internal id Vic uses for the record.
ErrorV2
object
2 properties 1 required
UpdateVendorV2
object
Schema for updating vendor information in the V2 API.
2 properties
PaymentInfoTermUnit
string
The payment term units supported.
UpdateVendorGroup
object
1 property 1 required
Vendors
array
ExternalData
object
A free form json object that is stored with the record.
VendorGroups
array
CreateVendorGroup
object
1 property 1 required
ExternalId
string
The external id set by the ERP system. It does not have to be a UUID and can be any non empty string desired.
PaymentInfoMethod
string
The payment method to be used. Note: BANKACCOUNT is equivalent to ACH in the Web UI.
Email
string
VendorRemoteError
object
The remote error on a Vendor. This is to describe any errors that have happened in the ERP system. If the error that occurred does not pertain to a specific fi…
2 properties 1 required
VendorGroup
object
2 properties 2 required
Currency
string
The ISO-4217 currency code.
VendorTaxInfo
object
4 properties
VendorState
string
VendorOfacReport
object
OFAC (Office of Foreign Assets Control) screening report for a vendor
8 properties
ErrorString
string
Error
object
generic error message in JSON format. Note the 'code' field should match the HTTP status code of the wrapping HTTP request.
2 properties 2 required
PaymentInfo
object
8 properties
PaymentInfoTerm
object
2 properties 2 required
CountryCode
string
The ISO-3166 country code. The acceptable values are Alpha-2 codes.
InternationalBankAccount
object
2 properties
Vendor
object
25 properties 10 required
VendorUpsert
object
21 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vicai-vendors-api-openapi.yml Raw ↑

Other APIs Vic.ai publishes across the network.

Vic.ai Accounts API
Vic.ai Allowed Senders API
Vic.ai Attachments API
Vic.ai Authentication API
Vic.ai Beta Features API
Vic.ai Bills API
Vic.ai Companies API
Vic.ai Company Settings API
Vic.ai Credit Confirmations API
Vic.ai CSV Reports API
Vic.ai Dimensions API
Vic.ai Email Endpoints API
Where this information came from

This is an independent, third-party profile of Vic.ai Vendors API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.