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 Invoices API

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.

Vic.ai Invoices 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 Invoices. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 21 operations across 15 paths, and defines 77 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.

21 operations 15 paths 77 schemas 3 DELETE8 GET1 PATCH7 POST2 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 Invoices API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

Paths & Operations 21

Across 15 paths, the API surfaces 21 operations — 3 DELETE, 8 GET, 1 PATCH, 7 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Invoices 21

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…

GET
/v0/invoices
List all invoices
listInvoices 8 params → 2004294XX
POST
/v0/invoices
Create an invoice.
createInvoice body → 201403404422
GET
/v0/invoices/{id}
Info for a specific invoice
getInvoice 2 params → 2004294XX
PATCH
/v0/invoices/{id}
Asynchronous reply to invoice post or invoice transfer
ackInvoice 1 param body → 2014294XX
DELETE
/v0/invoices/{id}
Deletes an invoice
deleteInvoice 3 params → 2044224294XX
POST
/v0/invoices/{id}/process
Start the invoice processing.
startProcessingInvoice 2 params → 202403404422
GET
/v0/invoices/{id}/document
Document for a specific invoice
getInvoiceDocument 2 params → 2004294XX
POST
/v0/invoices/{id}/document
Upload document invoice
uploadDocumentInvoice 2 params body → 200403404422
GET
/v0/invoices/{id}/supporting-attachments
List supporting attachments for an invoice
listInvoiceSupportingAttachments 2 params → 2004034044294XX
POST
/v0/invoices/{id}/supporting-attachments
Upload a supporting attachment
uploadInvoiceSupportingAttachment 2 params body → 201403404422
DELETE
/v0/invoices/{id}/supporting-attachments/{attachment_id}
Delete a supporting attachment
deleteInvoiceSupportingAttachment 3 params → 204403404422
GET
/v2/companies/{company_id}/invoices
List invoices
listInvoicesV2 8 params → 2004034224XX
GET
/v2/invoices/{id}
Get an invoice
getInvoiceV2 1 param → 2004044XX
DELETE
/v2/invoices/{id}
Delete an invoice
deleteInvoiceV2 2 params → 2044034044224XX
GET
/v2/invoices/{id}/document
Get invoice document
getInvoiceDocumentV2 1 param → 2002024034045004XX
POST
/v0/invoices/{id}/confirm
Asynchronous reply to invoice post or invoice transfer
confirmInvoice 1 param body → 200403404422
POST
/v0/invoices/{id}/reject
Asynchronous reply to invoice post
rejectInvoice 1 param body → 200403404422
GET
/v0/invoices/{id}/lineItems
List all line items for a specific invoice
getInvoicelineItems 2 params → 2004294XX
PUT
/v0/invoiceItems/{id}
Update a specific invoice line item
updateInvoiceItem 1 param body → 2004034044224294XX
PUT
/v0/invoices/{id}/external
Update invoice external fields
updateInvoiceExternal 2 params body → 202403404422
POST
/v2/companies/{company_id}/invoices/submit
Bulk submit invoices for approval
bulkSubmitInvoicesV2 1 param body → 2024034044224XX

Schemas 77

The contract defines 77 schemas that model the data the API accepts and returns. The most detailed are Invoice (57 properties), BillV2 (54 properties), InvoiceLineItem (32 properties), BillLineItemV2 (27 properties). Each schema is shown below with its type and property counts.

BillOfLadingNumberV2
object
The bill of lading number.
1 property 1 required
VendorLookupByOrgNumber
object
2 properties 1 required
PaymentKind
string
The payment kind.
InvoiceLineItemChild
object
A child line item within a grouped invoice line item. Contains a subset of fields from the original line item before merging.
12 properties
InvoiceStatus
string
Contact the support to enable the APPROVED value.
PaymentInfoTermUnit
string
The payment term units supported.
TaxCode
object
4 properties
BillV2
object
Schema for a bill response containing complete bill information including line items and payment details.
54 properties
VendorLookup
object
ExternalData
object
A free form json object that is stored with the record.
VendorLookupByName
object
1 property 1 required
InvoiceMarkedAs
string
InvoiceState
string
CreditAccountRef
object
2 properties
VendorInternalId
string
The id of the Vendor in Vic.
ErrorString
string
VendorLookupByInternalId
object
1 property 1 required
InvoiceSupportingAttachment
object
A supporting file that has been uploaded alongside an invoice (for example a contract, packing slip, or correspondence). Distinct from the primary invoice docu…
6 properties 5 required
MonetaryValue
string
The monetary value as a string. A float should not be used. The api will accept a float and it will be transformed into a monetary value, but for best results…
CountryCode
string
The ISO-3166 country code. The acceptable values are Alpha-2 codes.
ReceiptMatchV2
object
Represents a match between an invoice item and a purchase order receipt line.
5 properties
AccrualTermUnit
string
The accrual term units supported.
InvoiceConfirm
object
3 properties 2 required
CostAccountInfo
object
3 properties
TransactionType
string
The type of invoice transaction.
SparseVendorV2
object
A minimal vendor representation containing basic identification and contact information.
5 properties
UpdateInvoiceExternalInput
object
8 properties
Currency
string
The ISO-4217 currency code.
BillLineItemV2
object
Schema for a bill line item containing item details, cost accounting, and tax information.
27 properties
InvoiceInfoNO
object
3 properties 1 required
InternationalBankAccount
object
2 properties
PurchaseOrderReceiptMatch
object
5 properties 4 required
BankAccountType
The type of bank account.
SubmitInvoicesInputV2
object
Input schema for bulk submitting invoices for approval (V2 API).
1 property 1 required
InvoiceLineItemInfo
object
3 properties
VendorLookupByOrgNumberAndBankAccount
object
4 properties 4 required
PaymentMethod
string
ListInvoicesResponseV2
object
2 properties 2 required
InternalId
string
The internal id Vic uses for the record.
InvoiceFieldInput
object
2 properties 1 required
ErrorV2
object
2 properties 1 required
InvoicePaymentInfo
object
The invoice payment information. The kind field is required in order to determine what payment information the invoice needs to use. All other fields are optio…
5 properties 1 required
InvoiceExternalPaymentStatus
string
Invoices
array
AccrualInfo
object
3 properties 3 required
PaginationV2
object
2 properties
UpdateInvoiceLineItem
object
19 properties
AccrualV2
object
Accrual period configuration.
3 properties 3 required
LineItemVat
object
5 properties
BillLineItemChildV2
object
A child line item within a grouped bill line item. Contains a subset of fields from the original line item before merging.
13 properties
PaymentInfoMethod
string
The payment method to be used. Note: BANKACCOUNT is equivalent to ACH in the Web UI.
InvoiceBillStatus
string
CustomField
object
3 properties
MatchItemV2
object
Represents a match between an invoice item and a purchase order item.
4 properties
Dimension
object
11 properties
Language
string
InvoiceLineItem
object
32 properties 3 required
DimensionRef
object
A reference to a dimension within Vic. The internalId takes precedence over all fields specified. If a dimension is not found matching the internalId an error…
4 properties
BillOfLadingNumber
object
The bill of lading number.
1 property 1 required
VendorLookupByExternalId
object
1 property 1 required
CreateInvoice
object
The shape of the request to create an invoice.
25 properties 1 required
Invoice
object
57 properties 8 required
SparseVendor
object
A vendor object but sparsely populated.
5 properties 1 required
PaginationMetaV2
object
1 property
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.
MatchItem
object
7 properties 3 required
CreateInvoiceLineItem
object
16 properties 1 required
InvoiceField
object
4 properties
InvoiceItemLineType
string
The type of invoice item line.
MatchedPurchaseOrder
object
3 properties 2 required
InvoicePaymentTerm
object
2 properties 2 required
CostAccountV2
object
Cost account information including identification, naming, and external system references.
7 properties
InvoiceReject
object
3 properties 3 required
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
InvoiceUiStatus
string
The invoice's processing status as shown in the Vic.ai interface.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vicai-invoices-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 Invoices 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.