Invoice Schema
Invoice - requestHeader
amountNetInvoice
Number
-
The invoice total amount minus the shipping and tax amounts. Maximum length 23 characters.
amountShippingTotal
Number
-
The value for the shipping amount header field. Maximum length 23 characters.
amountTax
Number
-
The total amount of tax on a given invoice. Maximum length 23 characters.
amountVAT1 through amountVAT4
Number
23
The individual total VAT amounts for the invoice. Maximum length 23 characters.
clearingAccountCode
String
-
Contains the expense type account code. - or - If a CBCP Personal expense, the company card clearing account code. - or - If charge is tied to a Statement Report, and accounting code is set for Company Billed card account, the card’s accounting code as specified in the Account Code field when creating or editing a CBS account. Maximum length 20 characters.
currencyAlphaCode
String
ISO 4217 3-letter alpha code.
Currency ISO alpha code for the spend currency if not an imported credit card or the invoice currency if this is a credit card.
deliverySlipNumber
String
-
Delivery slip number of the receipt which is associated to the invoice line item. Maximum length 256 characters.
discountPercentage
Number
Percentage
Percent value that defines the amount of discount that would be applied.
discountTermsDays
Number
-
Numeric value defining the discount term day amount. Maximum length 3 characters.
externalPolicyId
String
-
The external policy ID of the Invoice.
invoiceDate
String
YYYY-MM-DD
Date of the invoice.
invoicePayIndicator
String
Y/N-
Signifies if this report belongs to a test user in system.
invoiceReceivedDate
String
YYYY-MM-DD
The date on which the invoice was received.
isTest
String
Y/N
Signifies if this report belongs to a test user in system.
ledgerCode
String
-
External accounting system ID. Maximum length 20 characters.
ledgerName
String
-
The general ledger tied to the invoice. Maximum length 100 characters.
multiplePurchaseOrder
String
Y/N
Defines whether or not multiple purchase orders are tied to the invoice.
netPaymentTermDays
Number
-
Numeric value defining the payment term day amount. Maximum length 3 characters.
paymentDueDate
String
YYYY-MM-DD
The date the payment is due for a given invoice.
payMethodType
String
Drop Down Selector. Valid format options include: ACH, client paid, check, PAYPVD, wire, card, or VCHER.
The method used to pay the invoice, as of the point in time the extract is run. NOTE: It is possible for the method to be changed or updated post-extract through either the Payment Confirmation import (if the client controls payments), or through Invoice Pay (using Payment Manager).
policyName
String
-
The name of the policy that applies to this Invoice.
postingDate
String
YYYY-MM-DD
The date the invoice will be posted to the ERP system.
processCompleteDate
String
YYYY-MM-DD
The date the invoice was processed.
reqKey
Number
Integer
An integer that uniquely defines this invoice in Turium Enigma. This is the value that the Invoice Confirmation Import uses to match to this particular invoice.
requestCreationDate
String
YYYY-MM-DD
The date the invoice was originally saved.
requestCustom1Code through requestCustom24Code
CustomField
The details from the custom fields. These fields may not have data, depending on the configuration. Maximum length 48 characters.
requestCustom1Value through requestCustom24Value
CustomField
-
The details from the custom fields. These fields may not have data, depending on the configuration. Maximum length 48 characters.
requestDescription
String
-
The invoice’s description. Maximum length 250 characters.
requestId
String
-
The unique identification assigned to the invoice. Maximum length 20 characters.
requestOrgUnit1Code through requestOrgUnit6Code
CustomField
-
The details from the custom fields. These fields may not have data, depending on the configuration. Maximum length 48 characters.
requestOrgUnit1Value through requestOrgUnit6Value
CustomField
-
The details from the custom fields. These fields may not have data, depending on the configuration. Maximum length 48 characters.
requestTitle
String
-
The invoice name. Maximum length 100 characters.
requestTotal
Number
Maximum 23 digits to the left of the decimal; maximum 8 digits to the right of the decimal; with a maximum of 23 digits for the entire field.
The sum of all Line Item Amounts plus Shipping Amount and Tax Amount for the invoice.
revisionNumber
Number
-
Invoice revision number. Default value is 1. Maximum length 32 characters.
submitDate
String
YYYY-MM-DD
Date/time the employee submitted the invoice for approval.
vendorInvoiceNumber
String
-
The invoice number assigned by the vendor. Maximum length 50 characters.
vendorTaxId
String
-
The Vendor Tax ID.
versionId
String
-
The version of the FI Document, which is the same as the version of the API endpoint. Maximum length 32 characters.
Invoice - ownerEmployee
employeeCustom1Code through employeeCustom21Code
CustomField
-
The details from the custom fields. These fields may not have data, depending on the configuration. Maximum length 48 characters.
employeeCustom1Value through employleeCustom21Value
CustomField
-
The details from the custom fields. These fields may not have data, depending on the configuration. Maximum length 48 characters.
employeeFirstName
String
-
First name of employee. Maximum length 32 characters.
employeeId
String
-
Employee ID often also serves as the employee’s Vendor ID for AP system integrations or Payroll ID for Payroll integrations. Maximum length 48 characters.
employeeLastName
String
-
Last name of employee. Maximum length 32 characters.
employeeMI
String
-
Middle initial of employee. Maximum length 1 character.
employeeOrgUnit1Value through employeeOrgUnit6Value
CustomField
-
The details from the custom fields. These fields may not have data, depending on the configuration. Maximum length 48 characters.
Invoice - Vendor
vendorCode
String
-
The financial system’s code for this vendor. Maximum length 23 characters.
vendorContactFirstName
String
-
Buyer contact for the vendor record’s first name. Maximum length 255 characters.
vendorContactLastName
String
-
Buyer contact for the vendor record’s last name. Maximum length 255 characters.
vendorName
String
-
The financial system’s name for this vendor. Maximum length 255 characters.
vendorRemitToAddressCode
String
Less than or equal to 64.
The financial system’s code for this address.
Invoice - lineItem
allocationAccountCode
String
-
The Account Code for the Allocation related to this Journal Entry. Maximum length 20 characters.
allocationCustom1Code through allocationCustom20Code
CustomField
-
The details from the custom fields. These fields may not have data, depending on the configuration. Maximum length 48 characters.
allocationCustom1Value through allocationCustom20Value
CustomField
-
The details from the custom fields. These fields may not have data, depending on the configuration. Maximum length 48 characters.
allocationKey
Number
-
System-generated unique key for this allocation record. Maximum length 13 characters.
allocationPercentage
Number
-
Percent of the report entry assigned to this allocation record. Maximum length 64 characters.
journal
String
-
Container for journal entries tied to the allocation. Maximum length 48 characters.
accountCode
Number
-
The financial system accounting code value tied to the invoice line. Maximum length 20 characters.
amountGross
Number
-
The gross amount (total amount) of the invoice line item. Maximum length 23 characters.
amountNet
Number
-
The net amount of the invoice line item not including shipping and tax. Maximum length 23 characters.
amountShipping
Number
Maximum 23 digits to the left of the decimal; maximum 8 digits to the right of the decimal; with a maximum of 23 digits for the entire field.
The value for the Shipping Amount header field. Maximum 23 digits to the left of the decimal; maximum 8 digits to the right of the decimal; with a maximum of 23 digits for the entire field.
expenseTypeCode
String
-
Code for the expense type so a value that isn’t language dependent is returned. Maximum length is 7 characters.
expenseTypeName
String
-
Expense type name. Maximum length 64 characters.
externalLineItemId
String
-
The PO Line item associated with to the Invoice. Maximum length 100 characters.
lineItemCode
String
-
The Primary Key value for the expense type. Maximum length 7 characters.
lineItemCustom1Code through lineItemCustom20Code
CustomField
-
The details from the custom fields. These fields may not have data, depending on the configuration. Maximum length 48 characters.
lineItemCustom1Value through lineItemCustom20Value
CustomField
-
The details from the custom fields. These fields may not have data, depending on the configuration. Maximum length 48 characters.
lineItemDeliverySlipNumber
String
-
Delivery Slip Number of the receipt which is associated to the invoice line item. Maximum length 256 characters.
lineItemDescription
String
-
The description of the goods or services being purchased on the individual invoice line. Maximum length 255 characters.
lineItemPurchaseOrderNumber
String
-
The purchase order number associated with the invoice line item (for a multiple purchase order-based invoice), or the purchase order number associated with the header (for a single purchase order-based invoice). Maximum length 10 characters.
lineItemQuantity
String
-
The quantity of the line item. Maximum length 23 characters.
lineItemSequenceOrder
Number
Integer
Line item number for the line item related to this Journal Entry. Value is dynamically generated by the system based on the number of lines.
lineItemUnitPrice
Number
-
The quantity unit price for the item being purchased. Maximum length 23 characters.
poLineNumber
Number
-
The PO line item number associated to the payment request. Maximum length 48 characters.
receiptNumber
Number
-
The Goods Receipt number. Maximum length 256 characters.
receiptQuantity
Number
-
The Goods Received quantity. Maximum length 23 characters.
receiptItemID
Number
-
The ID of the Goods Receipt tied to the Invoice and PO Line. Maximum length 48 characters.
Invoice - Tax
amountTax
Number
-
The taxation amount that exists on the invoice line. Maximum length 23 characters.
taxCode
String
-
Tax code assigned to this tax authority for the expense type entered on the expense entry. Maximum length 20 characters.
taxField
String
-
Defines which database field the tax resides in. Maximum length 20 characters.
Last updated