Skip to main content

DocumentAIReferenceRequestDto

Request model for referencing an existing Document AI document for coding.

externalInvoiceIdstringrequired

The internal invoice identifier within your system.

Possible values: non-empty

Example: F50015
externalPurchaserIdstringnullable

Unique identifier of the purchaser within your system

Example: MKR
externalApproverIdstringnullable

Unique identifier of the first approver in the workflow

Example: Jack Petterson
externalBuyerIdstringnullable

Unique identifier of the buyer entity within your system.

Example: Buyer-X
externalVendorIdstringnullable

Unique identifier of the vendor within your system

Example: Vendor-X
documentAIReference objectrequired

Reference to a Document AI document.

iduuidrequired

The Document AI document ID.

Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
companyNamestringnullable

The company name in Document AI that owns this document. Null when referencing a tenant-scoped document rather than a company-scoped document.

Example: kaunt
DocumentAIReferenceRequestDto
{
"externalInvoiceId": "F50015",
"externalPurchaserId": "MKR",
"externalApproverId": "Jack Petterson",
"externalBuyerId": "Buyer-X",
"externalVendorId": "Vendor-X",
"documentAIReference": {
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"companyName": "kaunt"
}
}