# Invoice Schema

### Invoice - requestHeader <a href="#invoice---requestheader" id="invoice---requestheader"></a>

<table data-full-width="true"><thead><tr><th>Name</th><th>Type</th><th>Format</th><th>Description</th></tr></thead><tbody><tr><td><code>amountNetInvoice</code></td><td><code>Number</code></td><td>-</td><td>The invoice total amount minus the shipping and tax amounts. Maximum length 23 characters.</td></tr><tr><td><code>amountShippingTotal</code></td><td><code>Number</code></td><td>-</td><td>The value for the shipping amount header field. Maximum length 23 characters.</td></tr><tr><td><code>amountTax</code></td><td><code>Number</code></td><td>-</td><td>The total amount of tax on a given invoice. Maximum length 23 characters.</td></tr><tr><td><code>amountVAT1</code> through <code>amountVAT4</code></td><td><code>Number</code></td><td>23</td><td>The individual total VAT amounts for the invoice. Maximum length 23 characters.</td></tr><tr><td><code>clearingAccountCode</code></td><td><code>String</code></td><td>-</td><td>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 <strong>Account Code</strong> field when creating or editing a CBS account. Maximum length 20 characters.</td></tr><tr><td><code>currencyAlphaCode</code></td><td><code>String</code></td><td>ISO 4217 3-letter alpha code.</td><td>Currency ISO alpha code for the spend currency if not an imported credit card or the invoice currency if this is a credit card.</td></tr><tr><td><code>deliverySlipNumber</code></td><td><code>String</code></td><td>-</td><td>Delivery slip number of the receipt which is associated to the invoice line item. Maximum length 256 characters.</td></tr><tr><td><code>discountPercentage</code></td><td><code>Number</code></td><td>Percentage</td><td>Percent value that defines the amount of discount that would be applied.</td></tr><tr><td><code>discountTermsDays</code></td><td><code>Number</code></td><td>-</td><td>Numeric value defining the discount term day amount. Maximum length 3 characters.</td></tr><tr><td><code>externalPolicyId</code></td><td><code>String</code></td><td>-</td><td>The external policy ID of the Invoice.</td></tr><tr><td><code>invoiceDate</code></td><td><code>String</code></td><td>YYYY-MM-DD</td><td>Date of the invoice.</td></tr><tr><td><code>invoicePayIndicator</code></td><td><code>String</code></td><td>Y/N-</td><td>Signifies if this report belongs to a test user in system.</td></tr><tr><td><code>invoiceReceivedDate</code></td><td><code>String</code></td><td>YYYY-MM-DD</td><td>The date on which the invoice was received.</td></tr><tr><td><code>isTest</code></td><td><code>String</code></td><td>Y/N</td><td>Signifies if this report belongs to a test user in system.</td></tr><tr><td><code>ledgerCode</code></td><td><code>String</code></td><td>-</td><td>External accounting system ID. Maximum length 20 characters.</td></tr><tr><td><code>ledgerName</code></td><td><code>String</code></td><td>-</td><td>The general ledger tied to the invoice. Maximum length 100 characters.</td></tr><tr><td><code>multiplePurchaseOrder</code></td><td><code>String</code></td><td>Y/N</td><td>Defines whether or not multiple purchase orders are tied to the invoice.</td></tr><tr><td><code>netPaymentTermDays</code></td><td><code>Number</code></td><td>-</td><td>Numeric value defining the payment term day amount. Maximum length 3 characters.</td></tr><tr><td><code>paymentDueDate</code></td><td><code>String</code></td><td>YYYY-MM-DD</td><td>The date the payment is due for a given invoice.</td></tr><tr><td><code>payMethodType</code></td><td><code>String</code></td><td>Drop Down Selector. Valid format options include: ACH, client paid, check, PAYPVD, wire, card, or VCHER.</td><td>The method used to pay the invoice, as of the point in time the extract is run. <strong>NOTE:</strong> It is possible for the method to be changed or updated <em>post-extract</em> through either the Payment Confirmation import (if the client controls payments), or through Invoice Pay (using Payment Manager).</td></tr><tr><td><code>policyName</code></td><td><code>String</code></td><td>-</td><td>The name of the policy that applies to this Invoice.</td></tr><tr><td><code>postingDate</code></td><td><code>String</code></td><td>YYYY-MM-DD</td><td>The date the invoice will be posted to the ERP system.</td></tr><tr><td><code>processCompleteDate</code></td><td><code>String</code></td><td>YYYY-MM-DD</td><td>The date the invoice was processed.</td></tr><tr><td><code>reqKey</code></td><td><code>Number</code></td><td>Integer</td><td>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.</td></tr><tr><td><code>requestCreationDate</code></td><td><code>String</code></td><td>YYYY-MM-DD</td><td>The date the invoice was originally saved.</td></tr><tr><td><code>requestCustom1Code</code> through <code>requestCustom24Code</code></td><td><code>CustomField</code></td><td> </td><td>The details from the custom fields. These fields may not have data, depending on the configuration. Maximum length 48 characters.</td></tr><tr><td><code>requestCustom1Value</code> through <code>requestCustom24Value</code></td><td><code>CustomField</code></td><td>-</td><td>The details from the custom fields. These fields may not have data, depending on the configuration. Maximum length 48 characters.</td></tr><tr><td><code>requestDescription</code></td><td><code>String</code></td><td>-</td><td>The invoice’s description. Maximum length 250 characters.</td></tr><tr><td><code>requestId</code></td><td><code>String</code></td><td>-</td><td>The unique identification assigned to the invoice. Maximum length 20 characters.</td></tr><tr><td><code>requestOrgUnit1Code</code> through <code>requestOrgUnit6Code</code></td><td><code>CustomField</code></td><td>-</td><td>The details from the custom fields. These fields may not have data, depending on the configuration. Maximum length 48 characters.</td></tr><tr><td><code>requestOrgUnit1Value</code> through <code>requestOrgUnit6Value</code></td><td><code>CustomField</code></td><td>-</td><td>The details from the custom fields. These fields may not have data, depending on the configuration. Maximum length 48 characters.</td></tr><tr><td><code>requestTitle</code></td><td><code>String</code></td><td>-</td><td>The invoice name. Maximum length 100 characters.</td></tr><tr><td><code>requestTotal</code></td><td><code>Number</code></td><td>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.</td><td>The sum of all Line Item Amounts plus Shipping Amount and Tax Amount for the invoice.</td></tr><tr><td><code>revisionNumber</code></td><td><code>Number</code></td><td>-</td><td>Invoice revision number. Default value is 1. Maximum length 32 characters.</td></tr><tr><td><code>submitDate</code></td><td><code>String</code></td><td>YYYY-MM-DD</td><td>Date/time the employee submitted the invoice for approval.</td></tr><tr><td><code>vendorInvoiceNumber</code></td><td><code>String</code></td><td>-</td><td>The invoice number assigned by the vendor. Maximum length 50 characters.</td></tr><tr><td><code>vendorTaxId</code></td><td><code>String</code></td><td>-</td><td>The Vendor Tax ID.</td></tr><tr><td><code>versionId</code></td><td><code>String</code></td><td>-</td><td>The version of the FI Document, which is the same as the version of the API endpoint. Maximum length 32 characters.</td></tr></tbody></table>

### Invoice - ownerEmployee <a href="#scinvown" id="scinvown"></a>

<table data-full-width="true"><thead><tr><th>Name</th><th>Type</th><th>Format</th><th>Description</th></tr></thead><tbody><tr><td><code>employeeCustom1Code</code> through <code>employeeCustom21Code</code></td><td><code>CustomField</code></td><td>-</td><td>The details from the custom fields. These fields may not have data, depending on the configuration. Maximum length 48 characters.</td></tr><tr><td><code>employeeCustom1Value</code> through <code>employleeCustom21Value</code></td><td><code>CustomField</code></td><td>-</td><td>The details from the custom fields. These fields may not have data, depending on the configuration. Maximum length 48 characters.</td></tr><tr><td><code>employeeFirstName</code></td><td><code>String</code></td><td>-</td><td>First name of employee. Maximum length 32 characters.</td></tr><tr><td><code>employeeId</code></td><td><code>String</code></td><td>-</td><td>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.</td></tr><tr><td><code>employeeLastName</code></td><td><code>String</code></td><td>-</td><td>Last name of employee. Maximum length 32 characters.</td></tr><tr><td><code>employeeMI</code></td><td><code>String</code></td><td>-</td><td>Middle initial of employee. Maximum length 1 character.</td></tr><tr><td><code>employeeOrgUnit1Value</code> through <code>employeeOrgUnit6Value</code></td><td><code>CustomField</code></td><td>-</td><td>The details from the custom fields. These fields may not have data, depending on the configuration. Maximum length 48 characters.</td></tr></tbody></table>

### Invoice - Vendor <a href="#scinvven" id="scinvven"></a>

<table data-full-width="true"><thead><tr><th>Name</th><th>Type</th><th>Format</th><th>Description</th></tr></thead><tbody><tr><td><code>vendorCode</code></td><td><code>String</code></td><td>-</td><td>The financial system’s code for this vendor. Maximum length 23 characters.</td></tr><tr><td><code>vendorContactFirstName</code></td><td><code>String</code></td><td>-</td><td>Buyer contact for the vendor record’s first name. Maximum length 255 characters.</td></tr><tr><td><code>vendorContactLastName</code></td><td><code>String</code></td><td>-</td><td>Buyer contact for the vendor record’s last name. Maximum length 255 characters.</td></tr><tr><td><code>vendorName</code></td><td><code>String</code></td><td>-</td><td>The financial system’s name for this vendor. Maximum length 255 characters.</td></tr><tr><td><code>vendorRemitToAddressCode</code></td><td><code>String</code></td><td>Less than or equal to 64.</td><td>The financial system’s code for this address.</td></tr></tbody></table>

### Invoice - lineItem <a href="#scinclin" id="scinclin"></a>

<table data-full-width="true"><thead><tr><th>Name</th><th>Type</th><th>Format</th><th>Description</th></tr></thead><tbody><tr><td><code>allocationAccountCode</code></td><td><code>String</code></td><td>-</td><td>The Account Code for the Allocation related to this Journal Entry. Maximum length 20 characters.</td></tr><tr><td><code>allocationCustom1Code</code> through <code>allocationCustom20Code</code></td><td><code>CustomField</code></td><td>-</td><td>The details from the custom fields. These fields may not have data, depending on the configuration. Maximum length 48 characters.</td></tr><tr><td><code>allocationCustom1Value</code> through <code>allocationCustom20Value</code></td><td><code>CustomField</code></td><td>-</td><td>The details from the custom fields. These fields may not have data, depending on the configuration. Maximum length 48 characters.</td></tr><tr><td><code>allocationKey</code></td><td><code>Number</code></td><td>-</td><td>System-generated unique key for this allocation record. Maximum length 13 characters.</td></tr><tr><td><code>allocationPercentage</code></td><td><code>Number</code></td><td>-</td><td>Percent of the report entry assigned to this allocation record. Maximum length 64 characters.</td></tr><tr><td><code>journal</code></td><td><code>String</code></td><td>-</td><td>Container for journal entries tied to the allocation. Maximum length 48 characters.</td></tr><tr><td><code>accountCode</code></td><td><code>Number</code></td><td>-</td><td>The financial system accounting code value tied to the invoice line. Maximum length 20 characters.</td></tr><tr><td><code>amountGross</code></td><td><code>Number</code></td><td>-</td><td>The gross amount (total amount) of the invoice line item. Maximum length 23 characters.</td></tr><tr><td><code>amountNet</code></td><td><code>Number</code></td><td>-</td><td>The net amount of the invoice line item not including shipping and tax. Maximum length 23 characters.</td></tr><tr><td><code>amountShipping</code></td><td><code>Number</code></td><td>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.</td><td>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.</td></tr><tr><td><code>expenseTypeCode</code></td><td><code>String</code></td><td>-</td><td>Code for the expense type so a value that isn’t language dependent is returned. Maximum length is 7 characters.</td></tr><tr><td><code>expenseTypeName</code></td><td><code>String</code></td><td>-</td><td>Expense type name. Maximum length 64 characters.</td></tr><tr><td><code>externalLineItemId</code></td><td><code>String</code></td><td>-</td><td>The PO Line item associated with to the Invoice. Maximum length 100 characters.</td></tr><tr><td><code>lineItemCode</code></td><td><code>String</code></td><td>-</td><td>The Primary Key value for the expense type. Maximum length 7 characters.</td></tr><tr><td><code>lineItemCustom1Code</code> through <code>lineItemCustom20Code</code></td><td><code>CustomField</code></td><td>-</td><td>The details from the custom fields. These fields may not have data, depending on the configuration. Maximum length 48 characters.</td></tr><tr><td><code>lineItemCustom1Value</code> through <code>lineItemCustom20Value</code></td><td><code>CustomField</code></td><td>-</td><td>The details from the custom fields. These fields may not have data, depending on the configuration. Maximum length 48 characters.</td></tr><tr><td><code>lineItemDeliverySlipNumber</code></td><td><code>String</code></td><td>-</td><td>Delivery Slip Number of the receipt which is associated to the invoice line item. Maximum length 256 characters.</td></tr><tr><td><code>lineItemDescription</code></td><td><code>String</code></td><td>-</td><td>The description of the goods or services being purchased on the individual invoice line. Maximum length 255 characters.</td></tr><tr><td><code>lineItemPurchaseOrderNumber</code></td><td><code>String</code></td><td>-</td><td>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.</td></tr><tr><td><code>lineItemQuantity</code></td><td><code>String</code></td><td>-</td><td>The quantity of the line item. Maximum length 23 characters.</td></tr><tr><td><code>lineItemSequenceOrder</code></td><td><code>Number</code></td><td>Integer</td><td>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.</td></tr><tr><td><code>lineItemUnitPrice</code></td><td><code>Number</code></td><td>-</td><td>The quantity unit price for the item being purchased. Maximum length 23 characters.</td></tr><tr><td><code>poLineNumber</code></td><td><code>Number</code></td><td>-</td><td>The PO line item number associated to the payment request. Maximum length 48 characters.</td></tr><tr><td><code>receiptNumber</code></td><td><code>Number</code></td><td>-</td><td>The Goods Receipt number. Maximum length 256 characters.</td></tr><tr><td><code>receiptQuantity</code></td><td><code>Number</code></td><td>-</td><td>The Goods Received quantity. Maximum length 23 characters.</td></tr><tr><td><code>receiptItemID</code></td><td><code>Number</code></td><td>-</td><td>The ID of the Goods Receipt tied to the Invoice and PO Line. Maximum length 48 characters.</td></tr></tbody></table>

### Invoice - Tax <a href="#scinvtax" id="scinvtax"></a>

<table data-full-width="true"><thead><tr><th>Name</th><th>Type</th><th>Format</th><th>Description</th></tr></thead><tbody><tr><td><code>amountTax</code></td><td><code>Number</code></td><td>-</td><td>The taxation amount that exists on the invoice line. Maximum length 23 characters.</td></tr><tr><td><code>taxCode</code></td><td><code>String</code></td><td>-</td><td>Tax code assigned to this tax authority for the expense type entered on the expense entry. Maximum length 20 characters.</td></tr><tr><td><code>taxField</code></td><td><code>String</code></td><td>-</td><td>Defines which database field the tax resides in. Maximum length 20 characters.</td></tr></tbody></table>
