Invoice request mapping
Tax calculation on an invoice is initiated by an invoice request message. These messages are used to calculate tax at the time of shipping, billing, or invoicing from the seller's perspective. Any tax liabilities are typically incurred at the point of invoicing. Invoice transactions are written to the tax journal.
| Vertex | Infor | ||
|---|---|---|---|
| Element/Attribute | Data type | Element value | Data type |
| Login | |||
| UserName | String (1-64) | ||
| Password | String (1-64) | ||
| TrustedId | String (6-16) | VertexConfigVersion.TrustedId | Alpha 16 |
| InvoiceRequest | |||
| documentNumber | String (1-50) | InvoiceNumber | Alpha 22 |
| documentType | String (1-20) | ||
| billingType | String (1-20) | ||
| orderType | String (1-20) | ||
| postingDate | Date (yyyy-mm-dd) | PostDate | Date |
| locationCode | String (1-20) | Customer Location | Num 4 |
| returnAssistedParametersIndicator | Boolean | ||
| returnGeneratedLineItemsIndicator | Boolean | ||
| deliveryTerm | DeliveryTermCode | ShipTerm | Alpha 3 |
| documentDate | Date (yyyy-mm-dd) | InvoiceDate | Date |
| transactionId | String (1-40) | ||
| transactionType | SaleTransaction | Vertex SalesTransaction type | |
| simplificationCode | SimplificationCode | ||
| roundAtLineLevel | Boolean | ||
| paymentDate | Date (yyyy-mm-dd) | ||
| documentSequenceId | String (0-60) | ||
| Currency | Currency | Alpha 5 | |
| isoCurrencyName | String | ||
| isoCurrencyCodeAlpha | String (3) | CompanyCurrency.ISOCode | Alpha 3 |
| isoCurrencyCodeNum | Positive Integer (1-999) | CompanyCurrency.ISOCodeNumber | Num 3 |
| OriginalCurrency | |||
| isoCurrencyName | String | ||
| isoCurrencyCodeAlpha | String (3) | ||
| isoCurrencyCodeNum | Positive Integer (1-999) | ||
| Seller | Company | ||
| nexusIndicator | Boolean | ||
| nexusReasonCode | String (1-4) | ||
| Company | String (0-40) | TaxEntity (Accounting Entity) | Alpha 12 |
| Division | String (0-40) | ||
| Department | String (0-40) | ||
| Dispatcher | |||
| DispatcherCode | String (0-40) | ||
| classCode | String (1-40) | ||
| TaxRegistration | From TaxEntity | ||
| isoCountryCode | String (2-3) | TaxEntity.VATCountry | Alpha 3 |
| mainDivision | String (1-60) | ||
| hasPhysicalPresenceIndicator | Boolean | ||
| impositionType | String (0-60) | ||
| TaxRegistrationNumber | String (0-40) | TaxEntity.VATRegistrationNumber | Alpha 12 |
| NexusOverride | |||
| locationRole | TaxingLocationCode | ||
| country | Boolean | ||
| mainDivision | Boolean | ||
| subDivision | Boolean | ||
| city | Boolean | ||
| district | Boolean | ||
| PhysicalLocation | |||
| taxAreaId | Integer (0-999999999) | ||
| StreetAddress1 | String (1-100) | ||
| StreetAddress2 | String (1-100) | ||
| City | String (1-60) | ||
| MainDivision | String (1-60) | ||
| SubDivision | String (1-60) | ||
| PostalCode | String (1-20) | ||
| Country | String (1-60) | ||
| PhysicalOrigin | Company or Process LevelAddress | ||
| taxAreaId | Integer (0-999999999) | Process Level TaxCode | |
| locationCustomsStatus | LocationCustomsStatusCode | ||
| locationCode | String (0-20) | ||
| externalJurisdictionCode | String (0-20) | ||
| StreetAddress1 | String (1-100) | DeliveryAddress.AddressLine1 | |
| StreetAddress2 | String (1-100) | ||
| City | String (1-60) | PostalAddress.Municipality | |
| MainDivision | String (1-60) | PostalAddress.StateProvince | |
| SubDivision | String (1-60) | PostalAddress.County | |
| PostalCode | String (1-20) | PostalAddress.PostalCode | |
| Country | String (1-60) | PostalAddress.Country | |
| CurrencyConversion | Decimal | CompanyBaseCurrencey | Decimal size 31.15 |
| isoCurrencyName | String | Company.BaseCurrencyName | |
| isoCurrencyCodeAlpha | String (3) | Company.BaseCurrencyCode.Alpha | |
| isoCurrencyCodeNum | Positive Integer (1-999) | Company.BaseCurrencyCode.Numeric | |
| AdministrativeOrigin | POAAddress | ||
| taxAreaId | Integer (0-999999999) | POATaxCode | |
| locationCustomsStatus | LocationCustomsStatusCode | ||
| locationCode | String (0-20) | ||
| externalJurisdictionCode | String (0-20) | ||
| StreetAddress1 | String (1-100) | POAAddress.DeliveryAddress.AddressLine1 | |
| StreetAddress2 | String (1-100) | ||
| City | String (1-60) | POAAddress.Municipality | |
| MainDivision | String (1-60) | POAAddress.StateProvince | |
| SubDivision | String (1-60) | POAAddress.County | |
| PostalCode | String (1-20) | POAAddress.PostalCode | |
| Country | String (1-60) | POAAddress.CountryCode | |
| CurrencyConversion | Decimal | POACurrencyRate | |
| isoCurrencyName | String | ||
| isoCurrencyCodeAlpha | String (3) | POACurrency.ISOCode | |
| isoCurrencyCodeNum | Positive Integer (1-999) | POACurrency.ISOCodeNumber | |
| TaxRegistration | Customer VAT Registration | ||
| isoCountryCode | String (2-3) | Customer.CountryCode | Alpha 3 |
| mainDivision | String (1-60) | ||
| hasPhysicalPresenceIndicator | Boolean | ||
| impositionType | String (0-60) | ||
| TaxRegistrationNumber | String (0-40) | Customer.VATRegistrationNumber | Alpha 12 |
| NexusOverride | |||
| locationRole | TaxingLocationCode | ||
| country | Boolean | ||
| mainDivision | Boolean | ||
| subDivision | Boolean | ||
| city | Boolean | ||
| district | Boolean | ||
| PhysicalLocation | |||
| taxAreaId | Integer (0-999999999) | ||
| StreetAddress1 | String (1-100) | ||
| StreetAddress2 | String (1-100) | ||
| City | String (1-60) | ||
| MainDivision | String (1-60) | ||
| SubDivision | String (1-60) | ||
| PostalCode | String (1-20) | ||
| Country | String (1-60) | ||
| Customer | Receivables Customer | ||
| isTaxExempt | Boolean | Customer.Exempt flag | |
| exemptionReasonCode | String (1-4) | ||
| CustomerCode | Receivables Customer | ||
| classCode | String (1-40) | ||
| isBusinessIndicator | Boolean | ||
| Destination | Customer Ship To | ||
| taxAreaId | Integer (0-999999999) | Customer Tax Code | Alpha 15 |
| locationCustomsStatus | LocationCustomsStatusCode | ||
| locationCode | String (0-20) | Customer | |
| externalJurisdictionCode | String (0-20) | ||
| StreetAddress1 | String (1-100) | PostalAddress.DeliveryAddress.AddressLine1 | |
| StreetAddress2 | String (1-100) | ||
| City | String (1-60) | PostalAddress.Municipality | |
| MainDivision | String (1-60) | PostalAddress.StateProvince | |
| SubDivision | String (1-60) | PostalAddress.County | |
| PostalCode | String (1-20) | PostalAddress.PostalCode | |
| Country | String (1-60) | PostalAddress.Country | |
| CurrencyConversion | Decimal | TransactionCurrency | |
| isoCurrencyName | String | ||
| isoCurrencyCodeAlpha | String (3) | TransactionCurrency.ISOCode | |
| isoCurrencyCodeNum | Positive Integer (1-999) | TransactionCurrency.ISOCodeNumber | |
| AdministrativeDestination | POAAddress | ||
| taxAreaId | Integer (0-999999999) | POATaxCode | |
| locationCustomsStatus | LocationCustomsStatusCode | ||
| locationCode | String (0-20) | ||
| externalJurisdictionCode | String (0-20) | ||
| StreetAddress1 | String (1-100) | POAAddress.DeliveryAddress.AddressLine1 | |
| StreetAddress2 | String (1-100) | ||
| City | String (1-60) | POAPostalAddress.Municipality | |
| MainDivision | String (1-60) | POAPostalAddress.StateProvince | |
| SubDivision | String (1-60) | POAPostalAddress.County | |
| PostalCode | String (1-20) | POAPostalAddress.PostalCode | |
| Country | String (1-60) | POAPostalAddress.Country | |
| CurrencyConversion | Decimal | POACurrency | |
| isoCurrencyName | String | ||
| isoCurrencyCodeAlpha | String (3) | POACurrency.ISOCode | Alpha 3 |
| isoCurrencyCodeNum | Positive Integer (1-999) | POACurrency.ISOCodeNumber | Num 3 |
| ExemptionCertificate | String | ||
| exemptionCertificateNumber | String (1-30) | ||
| TaxRegistration | Customer Tax Registration | ||
| isoCountryCode | String (2-3) | TaxEntity.VATCountry | |
| mainDivision | String (1-60) | ||
| hasPhysicalPresenceIndicator | Boolean | ||
| impositionType | String (0-60) | ||
| TaxRegistrationNumber | String (0-40) | VATRegistrationNumber | Alpha 12 |
| NexusOverride | |||
| locationRole | TaxingLocationCode | ||
| country | Boolean | ||
| mainDivision | Boolean | ||
| subDivision | Boolean | ||
| city | Boolean | ||
| district | Boolean | ||
| PhysicalLocation | |||
| taxAreaId | Integer (0-999999999) | ||
| StreetAddress1 | String (1-100) | ||
| StreetAddress2 | String (1-100) | ||
| City | String (1-60) | ||
| MainDivision | String (1-60) | ||
| SubDivision | String (1-60) | ||
| PostalCode | String (1-20) | ||
| Country | String (1-60) | ||
| TaxOverride | |||
| overrideType | TaxOverrideCode | ||
| overrideReasonCode | String (1-4) | ||
| ImpositionToProcess | |||
| impositionType | String (0-60) | ||
| JurisdictionOverride | |||
| jurisdictionLevel | JurisdictionLevelCode | ||
| impositionType | String (0-60) | ||
| DeductionOverride | |||
| ExemptOverride | |||
| overrideExemptReasonCode | String (1-4) | ||
| NonTaxableOverride | |||
| overrideNonTaxableReasonCode | String (1-4) | ||
| RateOverride | Decimal | ||
| SitusOverride | |||
| taxingLocation | TaxingLocationCode | ||
| Discount | |||
| userDefinedDiscountCode | String | ||
| DiscountPercent* | Decimal | ||
| DiscountAmount* | Decimal | ||
| LineItem | |||
| lineItemNumber | Integer | LineNumber (defaults to 1) | Num 6 |
| taxDate | Date (yyyy-mm-dd) | ||
| isMulticomponent | Boolean | ||
| locationCode | String (1-20) | ||
| deliveryTerm | DeliveryTermCode | ShipTerm | Alpha 3 |
| postingDate | Date (yyyy-mm-dd) | ||
| costCenter | String (1-40) | ||
| departmentCode | String (1-40) | ||
| generalLedgerAccount | String (1-40) | ||
| materialCode | String (1-40) | ||
| projectNumber | String (1-40) | ||
| usage | String (1-40) | TaxUsageCode | Alpha 10 |
| usageClass | String (1-40) | ||
| vendorSKU | String (1-40) | ||
| countryOfOriginISOCode | String (0-3) | ||
| modeOfTransport | Positive Integer (1-99) | ||
| natureOfTransaction | Positive Integer (1-999) | ||
| intrastatCommodityCode | String (0-unlimited) | ||
| netMassKilograms | Integer | ||
| lineItemId | String (1-40) | defaults to LineNumber | Num 6 |
| taxIncludedIndicator | Boolean | TaxIncludedIndicator | Boolean |
| transactionType | SaleTransaction | ||
| simplificationCode | SimplificationCode | ||
| titleTransfer | PointOfTitleTransferCode | ||
| chainTransactionPhase | ChainTransactionPhaseCode | ||
| exportProcedure | String (1-20) | ||
| Seller | |||
| nexusIndicator | Boolean | ||
| nexusReasonCode | String (1-4) | ||
| Company | String (0-40) | ||
| Division | String (0-40) | ||
| Department | String (0-40) | ||
| Dispatcher | |||
| DispatcherCode | String (0-40) | ||
| classCode | String (1-40) | ||
| TaxRegistration | |||
| isoCountryCode | String (2-3) | ||
| mainDivision | String (1-60) | ||
| hasPhysicalPresenceIndicator | Boolean | ||
| impositionType | String (0-60) | ||
| TaxRegistrationNumber | String (0-40) | ||
| NexusOverride | |||
| locationRole | TaxingLocationCode | ||
| country | Boolean | ||
| mainDivision | Boolean | ||
| subDivision | Boolean | ||
| city | Boolean | ||
| district | Boolean | ||
| PhysicalLocation | |||
| taxAreaId | Integer (0-999999999) | ||
| StreetAddress1 | String (1-100) | ||
| StreetAddress2 | String (1-100) | ||
| City | String (1-60) | ||
| MainDivision | String (1-60) | ||
| SubDivision | String (1-60) | ||
| PostalCode | String (1-20) | ||
| Country | String (1-60) | ||
| PhysicalOrigin | |||
| taxAreaId | Integer (0-999999999) | ||
| locationCustomsStatus | LocationCustomsStatusCode | ||
| locationCode | String (0-20) | ||
| externalJurisdictionCode | String (0-20) | ||
| StreetAddress1 | String (1-100) | ||
| StreetAddress2 | String (1-100) | ||
| City | String (1-60) | ||
| MainDivision | String (1-60) | ||
| SubDivision | String (1-60) | ||
| PostalCode | String (1-20) | ||
| Country | String (1-60) | ||
| CurrencyConversion | Decimal | ||
| isoCurrencyName | String | ||
| isoCurrencyCodeAlpha | String (3) | ||
| isoCurrencyCodeNum | Positive Integer (1-999) | ||
| AdministrativeOrigin | |||
| taxAreaId | Integer (0-999999999) | ||
| locationCustomsStatus | LocationCustomsStatusCode | ||
| locationCode | String (0-20) | ||
| externalJurisdictionCode | String (0-20) | ||
| StreetAddress1 | String (1-100) | ||
| StreetAddress2 | String (1-100) | ||
| City | String (1-60) | ||
| MainDivision | String (1-60) | ||
| SubDivision | String (1-60) | ||
| PostalCode | String (1-20) | ||
| Country | String (1-60) | ||
| CurrencyConversion | Decimal | ||
| isoCurrencyName | String | ||
| isoCurrencyCodeAlpha | String (3) | ||
| isoCurrencyCodeNum | Positive Integer (1-999) | ||
| TaxRegistration | |||
| isoCountryCode | String (2-3) | ||
| mainDivision | String (1-60) | ||
| hasPhysicalPresenceIndicator | Boolean | ||
| impositionType | String (0-60) | ||
| TaxRegistrationNumber | String (0-40) | ||
| NexusOverride | |||
| locationRole | TaxingLocationCode | ||
| country | Boolean | ||
| mainDivision | Boolean | ||
| subDivision | Boolean | ||
| city | Boolean | ||
| district | Boolean | ||
| PhysicalLocation | |||
| taxAreaId | Integer (0-999999999) | ||
| StreetAddress1 | String (1-100) | ||
| StreetAddress2 | String (1-100) | ||
| City | String (1-60) | ||
| MainDivision | String (1-60) | ||
| SubDivision | String (1-60) | ||
| PostalCode | String (1-20) | ||
| Country | String (1-60) | ||
| Customer | |||
| isTaxExempt | Boolean | ||
| exemptionReasonCode | String (1-4) | ||
| CustomerCode | |||
| classCode | String (1-40) | ||
| isBusinessIndicator | Boolean | ||
| Destination | |||
| taxAreaId | Integer (0-999999999) | ||
| locationCustomsStatus | LocationCustomsStatusCode | ||
| locationCode | String (0-20) | ||
| externalJurisdictionCode | String (0-20) | ||
| StreetAddress1 | String (1-100) | ||
| StreetAddress2 | String (1-100) | ||
| City | String (1-60) | ||
| MainDivision | String (1-60) | ||
| SubDivision | String (1-60) | ||
| PostalCode | String (1-20) | ||
| Country | String (1-60) | ||
| CurrencyConversion | Decimal | ||
| isoCurrencyName | String | ||
| isoCurrencyCodeAlpha | String (3) | ||
| isoCurrencyCodeNum | Positive Integer (1-999) | ||
| AdministrativeDestination | |||
| taxAreaId | Integer (0-999999999) | ||
| locationCustomsStatus | LocationCustomsStatusCode | ||
| locationCode | String (0-20) | ||
| externalJurisdictionCode | String (0-20) | ||
| StreetAddress1 | String (1-100) | ||
| StreetAddress2 | String (1-100) | ||
| City | String (1-60) | ||
| MainDivision | String (1-60) | ||
| SubDivision | String (1-60) | ||
| PostalCode | String (1-20) | ||
| Country | String (1-60) | ||
| CurrencyConversion | Decimal | ||
| isoCurrencyName | String | ||
| isoCurrencyCodeAlpha | String (3) | ||
| isoCurrencyCodeNum | Positive Integer (1-999) | ||
| ExemptionCertificate | String | ||
| exemptionCertificateNumber | String (1-30) | ||
| TaxRegistration | |||
| isoCountryCode | String (2-3) | ||
| mainDivision | String (1-60) | ||
| hasPhysicalPresenceIndicator | Boolean | ||
| impositionType | String (0-60) | ||
| TaxRegistrationNumber | String (0-40) | ||
| NexusOverride | |||
| locationRole | TaxingLocationCode | ||
| country | Boolean | ||
| mainDivision | Boolean | ||
| subDivision | Boolean | ||
| city | Boolean | ||
| district | Boolean | ||
| PhysicalLocation | |||
| taxAreaId | Integer (0-999999999) | ||
| StreetAddress1 | String (1-100) | ||
| StreetAddress2 | String (1-100) | ||
| City | String (1-60) | ||
| MainDivision | String (1-60) | ||
| SubDivision | String (1-60) | ||
| PostalCode | String (1-20) | ||
| Country | String (1-60) | ||
| TaxOverride | |||
| overrideType | TaxOverrideCode | ||
| overrideReasonCode | String (1-4) | ||
| ImpositionToProcess | |||
| impositionType | String (0-60) | ||
| JurisdictionOverride | |||
| jurisdictionLevel | JurisdictionLevelCode | ||
| impositionType | String (0-60) | ||
| DeductionOverride | |||
| ExemptOverride | |||
| overrideExemptReasonCode | String (1-4) | ||
| NonTaxableOverride | |||
| overrideNonTaxableReasonCode | String (1-4) | ||
| RateOverride | Decimal | ||
| SitusOverride | |||
| taxingLocation | TaxingLocationCode | ||
| Product | String (0-40) | ProductTaxCategory | Alpha 15 |
| productClass | String (0-40) | ProductClass | Alpha 40 |
| CommodityCode | String (0-40) | ||
| commodityCodeType | String (1-60) | ||
| Quantity | Decimal | Quantity | Decimal 13.4 |
| unitOfMeasure | String (1-3) | ||
| Weight | Decimal | ||
| unitOfMeasure | String (1-3) | ||
| Volume | Decimal | ||
| unitOfMeasure | String (1-3) | ||
| SupplementaryUnit | Decimal | ||
| unitType | String (0-20) | ||
| StatisticalValue | Decimal | ||
| isoCurrencyName | String | ||
| isoCurrencyCodeAlpha | String (3) | ||
| isoCurrencyCodeNum | Positive Integer (1-999) | ||
| Freight | Decimal | FreightAmount | Decimal 18.2 |
| FairMarketValue | Decimal | ||
| Cost | Decimal | ||
| UnitPrice | Decimal | TaxableAmount | Decimal 18.2 |
| ExtendedPrice | Decimal | TaxableAmount | Decimal 18.2 |
| LandedCost | Decimal | ||
| Discount | |||
| userDefinedDiscountCode | String | ||
| DiscountPercent* | Decimal | ||
| DiscountAmount* | Decimal | ||
| AmountBilledToDate | Decimal | ||
| FlexibleFields | |||
| FlexibleCodeField | String (1-40) | ||
| fieldId | Integer (1-25) | ||
| FlexibleNumericField | Decimal | ||
| fieldId | Integer (1-10) | ||
| FlexibleDateField | Date (yyyy-mm-dd) | ||
| fieldId | Integer (1-5) | ||
| ReturnsFields | |||
| ReturnsCodeField | String | ||
| name | String | ||
| ReturnsNumericField | Decimal | ||
| name | String | ||
| ReturnsDateField | Date (yyyy-mm-dd) | ||
| name | String | ||
| ReturnsIndicatorField | Boolean | ||
| name | String | ||
| LineItem | |||
| ApplicationData | |||
| Sender | String | ||
| MessageLogging | |||
| returnLogEntries | Boolean | ||
| OverrideLoggingThreshold | |||
| thresholdScope | String | ||
| LogEntry | |||
| logLevel | LogLevel | ||
| instanceId | String | ||
| threadId | String | ||
| className | String | ||
| Message | String | ||
| Exception | String | ||
| ResponseTimeMS | Decimal | ||