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 Purchase Orders API

The purchase orders.

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

This API exposes 9 operations across 6 paths, and defines 51 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.

9 operations 6 paths 51 schemas 1 DELETE2 GET5 POST1 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 Purchase Orders API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

Paths & Operations 9

Across 6 paths, the API surfaces 9 operations — 1 DELETE, 2 GET, 5 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Purchase Orders 9

The purchase orders.

GET
/v0/purchaseOrders
List purchase orders
listPurchaseOrders 5 params → 2004294XX
POST
/v0/purchaseOrders
Create a purchase order
createPurchaseOrder body → 201403404422
POST
/v0/purchaseOrders/synchronize
Synchronize Purchase Orders
synchronizePurchaseOrders → 2044294XX
GET
/v0/purchaseOrders/{purchaseOrderId}
Get a purchase order
getPurchaseOrder 2 params → 200403404
PUT
/v0/purchaseOrders/{purchaseOrderId}
Update a purchase order
updatePurchaseOrder 2 params body → 200403404422
DELETE
/v0/purchaseOrders/{purchaseOrderId}
Delete a purchase order
deletePurchaseOrder 2 params → 204403404422
POST
/v0/purchaseOrders/{purchaseOrderId}/process
Process the purchase order
processPurchaseOrder 2 params → 200403404422
POST
/v0/purchaseOrders/{purchaseOrderId}/close
Close a purchase order
closePurchaseOrder 2 params → 200403404422
POST
/v0/purchaseOrders/{purchaseOrderId}/open
Opens a purchase order
openPurchaseOrder 2 params → 200403404422

Schemas 51

The contract defines 51 schemas that model the data the API accepts and returns. The most detailed are Vendor (25 properties), PurchaseOrderLineItem (20 properties), PurchaseOrder (18 properties), PurchaseOrderReceiptLine (17 properties). Each schema is shown below with its type and property counts.

VendorLookupByOrgNumberAndBankAccount
object
4 properties 4 required
VendorLookupByOrgNumber
object
2 properties 1 required
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
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…
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…
UnitOfMeasure
string
The unit of measure used.
InternalId
string
The internal id Vic uses for the record.
PurchaseOrders
array
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
PaymentInfoTermUnit
string
The payment term units supported.
PurchaseOrder
object
18 properties 4 required
PurchaseOrderMatchingType
string
The matching type of the purchase order.
VendorLookup
object
VendorLookupByExternalId
object
1 property 1 required
VendorLookupByName
object
1 property 1 required
PurchaseOrderLineItem
object
20 properties 1 required
ExternalData
object
A free form json object that is stored with the record.
UpdatePurchaseOrder
object
14 properties 3 required
PurchaseOrderScheduleLine
object
A schedule line associated with a purchase order line item.
11 properties 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.
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…
CreatePurchaseOrder
object
15 properties 5 required
PurchaseOrderScheduleLineInput
object
Input schema for creating a schedule line on a purchase order line item.
11 properties 10 required
MatchItem
object
7 properties 3 required
PurchaseOrderType
string
This has been deprecated. Please use the matchingType field.
PaymentInfoMethod
string
The payment method to be used. Note: BANKACCOUNT is equivalent to ACH in the Web UI.
PurchaseOrderReceiptLineInput
object
Input schema for creating a receipt line on a purchase order line item.
17 properties 11 required
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
PurchaseOrderLineField
object
4 properties
PurchaseOrderLineFieldInput
object
2 properties 2 required
Currency
string
The ISO-4217 currency code.
VendorTaxInfo
object
4 properties
CreatePurchaseOrderItem
object
17 properties 5 required
VendorState
string
PurchaseOrderReceiptLine
object
A receipt line associated with a purchase order line item.
17 properties 1 required
VendorInternalId
string
The id of the Vendor in Vic.
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
VendorLookupByInternalId
object
1 property 1 required
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
PaymentInfo
object
8 properties
PaymentInfoTerm
object
2 properties 2 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…
PurchaseOrderStatus
string
The status of the purchase order.
CountryCode
string
The ISO-3166 country code. The acceptable values are Alpha-2 codes.
PurchaseOrderReceiptMatch
object
5 properties 4 required
InternationalBankAccount
object
2 properties
BankAccountType
The type of bank account.
Vendor
object
25 properties 10 required
Tag
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vicai-purchase-orders-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 Purchase Orders 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.