Vic.ai API (v9.23.11)

The Vic.ai API provides a seamless connection between your Enterprise Resource Planning (ERP) system and the Vic.ai product suite.

The API is designed to offer three main areas of functionality:

• Syncing master data: This refers to the data in your ERP that Vic.ai interacts with. You are required to supply and update this data in Vic.ai, and you also have the option to verify the copy of the masterdata in Vic.ai.

• Syncing training data: We need historical data to train your AI model. To that end, the API provides endpoints to sync historical invoices into Vic.ai and to confirm their presence.

• Subscribing to and receiving webhooks: Webhooks enable users or automated tasks to interact with your ERP through various actions in the Vic.ai product suite, such as posting an invoice, payment or purchase order or requesting synchronization. You will receive a notification via a webhook when these actions occur.

For US-based integrations, please use the following base API URL:

https://api.us.vic.ai

For integrations based in Norway, use the following base API URL:

https://api.no.vic.ai

All paths mentioned in this documentation should use one of these URLs as the base.

Example:

curl https://api.us.vic.ai/v0/healthCheck \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

To begin interacting with the Vic.ai API, you will need the following credentials:

• A Vic.ai client ID
• A Vic.ai client secret.

These can be provided to you securely by a Vic.ai representative upon request.

Please note: These credentials are essentially the keys to your ERP integration. If they fall into the wrong hands, unauthorized parties could impersonate you, gain access to sensitive data, and potentially perform malicious actions. Therefore, it's crucial to keep these credentials safe at all times to protect your application's integrity and your clients' data.

Limitations

The Vic.ai API has the following limitations:

Rate Limiting: The API is rate-limited to 500 requests per 10-second time frame. If you exceed this limit, you will receive a 429 Too Many Requests response. The limit is per Oauth client ID. If you continue to receive 429s, please contact support with a request id from the response headers.

To initiate the authentication process, send a POST request to /v0/token with the payload as shown in the example below:

{
    "client_id": "VIC_CLIENT_ID",
    "client_secret": "VIC_CLIENT_SECRET"
}

Here is an example of how to do this:

curl -X POST https://api.us.vic.ai/v0/token \
    -H "Content-Type: application/json" \
    -d '{"client_id": "VIC_CLIENT_ID", "client_secret": "VIC_CLIENT_SECRET"}'

Upon providing a valid client ID and client secret, you should receive a response similar to the following:

{
    "access_token": "YOUR_ACCESS_TOKEN",
    "token_type": "Bearer",
    "expires_in": 3600
}

For subsequent calls, use the value in access_token in the Authorization field.

Here is an example:

curl https://api.us.vic.ai/v0/healthCheck \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

The response should resemble the following:

{"company":"Your Company Name","status":"PASS","version":"0.19.0"}

The Vic.ai API leverages cursor-based pagination for traversing through data.

To fetch the next page of information, include the cursor parameter to the request. This value can be obtained from the X-next field in a previous response.

Example:

curl https://api.us.vic.ai/v0/accounts?cursor=foobar \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \

GL (General Ledger) accounts are part of your ERP Masterdata. In order to be associated with an invoice line item, key data about the account must be stored in Vic.ai. These operations allow querying and manipulation of these GL account data.

Attachments are original invoice documents that can be processed by Vic.ai.

• application/msword
• application/pdf
• application/vnd.ms-word.document.macroEnabled.12
• application/vnd.ms-word.template.macroEnabled.12
• application/vnd.openxmlformats-officedocument.wordprocessingml.document
• application/vnd.openxmlformats-officedocument.wordprocessingml.template
• image/tiff
• text/xml (See note below about supported EDI formats)
• image/jpg
• image/jpeg
• image/png
• image/gif
• application/vnd.ms-excel
• application/vnd.ms-excel.addin.macroenabled.12
• application/vnd.ms-excel.sheet.binary.macroenabled.12
• application/vnd.ms-excel.sheet.macroenabled.12
• application/vnd.ms-excel.template.macroenabled.12
• application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
• application/vnd.openxmlformats-officedocument.spreadsheetml.template

Supported EDI formats:

PEPPOL BIS Billing v3

Supported embedded attachment MIME codes:

• application/pdf
• image/jpeg
• image/png
• image/tiff

The API will ignore other attachment types.

The companies in the Vic system.

Dimensions are part of your ERP Masterdata, and represent business categories that are associated with invoice line items, that Vic.ai can automatically assign to invoice line items. These operations allow querying and manipulation of the dimension data.

These routes give you read-only access to two types of invoices:

• Invoices which have not yet been posted to the ERP system (restricted access).
• Invoices which have been posted to the ERP system.