Vic.ai Webhook Subscriptions API
Webhook subscriptions control which events your system receives and wherethey are delivered. Each company may have one V0 subscription or multipleV2 subscriptions.You can subscribe to all events or a specific subset. If you need to updateyour subscription to receive all events after trimming it down, pass`"events":["all"]` -- when using `all`, it must be set by itself.## Partner Onboarding FlowIntegration partners can programmatically provision new companies andconfigure webhook delivery using the V2 API:1. **Create a company** — `POST /v2/companies` with the company's name, country code, and billing timezone. The new company is automatically linked to your OAuth client, inheriting the organization of your primary company (or specify `organization_id` explicitly).2. **Create webhook subscriptions** — `POST /v2/companies/{company_id}/subscriptions` with your callback URL and the events you want to receive.3. **Manage subscriptions** — use `GET`, `PUT`, or `DELETE` on `/v2/companies/{company_id}/subscriptions/{id}` as needed.
Vic.ai Webhook Subscriptions 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 Webhook Subscriptions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
8 operations
across 3 paths,
and defines 101 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.
The identity and technical contract details declared by the specification.
PurchaseOrderRequestor
object
The person or entity who requested the purchase order. Resolved to a user by email first, then by full name. If the name matches more than one user in the comp…
2 properties
VendorError
Data structure for describing errors when posting a vendor to an ERP. Use a string to describe a single error that applies to the entire vendor object, or desc…
NonNegativeMonetaryValue
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…
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
PurchaseOrder
object
18 properties
4 required
VendorConfirm
object
2 properties
2 required
ExternalData
object
A free form json object that is stored with the record.
InvoiceRestoredEvent
object
4 properties
4 required
PurchaseOrderScheduleLine
object
A schedule line associated with a purchase order line item.
11 properties
1 required
PurchaseOrderType
string
This has been deprecated. Please use the matchingType field.
PaymentReferenceId
string
The reference id of the payment or credit is associated with. This will be the identifier is on the remittance advice sent to the Vendor. Example: P001234, A00…
SubscriptionV2
object
9 properties
7 required
VendorCallback
object
19 properties
9 required
VendorInternalId
string
The id of the Vendor in Vic.
PaymentStatusUpdatedEvent
object
4 properties
4 required
InvoicePostEvent
object
4 properties
4 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.
Tag
object
2 properties
1 required
PaymentBatchStatus
string
The status of the payment batch.
PurchaseOrderLineItemStatus
string
The status of the purchase order line item. When status field is set to open, then its value is derived from the line item's remaining amount. If the line item…
AccrualTermUnit
string
The accrual term units supported.
InvoiceConfirm
object
3 properties
2 required
CostAccountInfo
object
3 properties
PaymentStatus
string
The status of the payment. - pendingapproval - The payment is awaiting approval. - approved - The payment was approved for payment. - rejected - The payment wa…
TransactionType
string
The type of invoice transaction.
UpdateSubscriptionV2
object
5 properties
PurchaseOrderLineItemMatchingType
string
The type of matching that should be done on the line item. Determines which quantity fields are required. twoway - Only the quantityRequested field is required…
InvoiceDeletedEvent
object
4 properties
4 required
PurchaseOrderLineField
object
4 properties
Currency
string
The ISO-4217 currency code.
VendorTaxInfo
object
4 properties
PurchaseOrderUpdatedEvent
object
4 properties
4 required
PurchaseOrderReceiptLine
object
A receipt line associated with a purchase order line item.
17 properties
1 required
WebhookEventName
string
A webhook event type, or all to select every type when subscribing.
PurchaseOrderSiteOwner
object
The person or entity who is in charge of the purchase order site. Resolved to a user by email first, then by full name. If the name matches more than one user…
2 properties
InvoiceInfoNO
object
3 properties
1 required
CreditStatusUpdatedEvent
object
4 properties
4 required
PurchaseOrderStatus
string
The status of the purchase order.
InternationalBankAccount
object
2 properties
CostAccountRef
object
A reference to a Account.
2 properties
PurchaseOrderReceiptMatch
object
5 properties
4 required
Vendor
object
25 properties
10 required
InvoiceLineItemInfo
object
3 properties
Credit
object
24 properties
Payment
object
The payment made for an Invoice. The Account assigned to the payment is where the funds are being debited from.
25 properties
PaymentBatch
object
A batch of payments made with Vic.
11 properties
UnitOfMeasure
string
The unit of measure used.
InternalId
string
The internal id Vic uses for the record.
PurchaseOrderCreatedEvent
object
4 properties
4 required
ErrorV2
object
2 properties
1 required
InvoiceExternalPaymentStatus
string
AccrualInfo
object
3 properties
3 required
PaginationV2
object
2 properties
LineItemVat
object
5 properties
VendorRef
object
A reference to a Vendor.
2 properties
PaymentInfoMethod
string
The payment method to be used. Note: BANKACCOUNT is equivalent to ACH in the Web UI.
SubscriptionsListV2
object
2 properties
2 required
InvoicePostedEvent
object
4 properties
4 required
CustomField
object
3 properties
Dimension
object
11 properties
RequestIdCallback
object
2 properties
1 required
PaymentBatchProcessedEvent
object
2 properties
2 required
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
PurchaseOrderMatchingType
string
The matching type of the purchase order.
PurchaseOrderLineItem
object
20 properties
1 required
FieldError
object
Data structure for describing an error associated with a specific field in another datastructure. - internalField represents the Vic.API field name - externalF…
3 properties
3 required
CreateSubscriptionV2
object
5 properties
2 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
InvoiceField
object
4 properties
InvoiceInternalId
string
The id of the Invoice in Vic.
InvoiceItemLineType
string
The type of invoice item line.
SubscriptionUpsert
object
3 properties
2 required
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
InvoiceApprovedEvent
object
4 properties
4 required
MatchedPurchaseOrder
object
3 properties
2 required
InvoicePaymentTerm
object
2 properties
2 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
PurchaseOrderDeletedEvent
object
4 properties
4 required
PaymentInfo
object
8 properties
InvoiceRef
object
A reference to an Invoice.
3 properties
PaymentInfoTerm
object
2 properties
2 required
InvoiceUiStatus
string
The invoice's processing status as shown in the Vic.ai interface.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Vic.ai publishes across the network.
