Calculate Tax as a Buyer
Learn about calculating tax for buyers.
Calculate tax as a buyer
| Endpoint | Method | Key values | Required fields |
|---|---|---|---|
/v2/procurement | POST | purchaseMessageType | transactionType |
This request represents tax calculation from the buyer's perspective. It performs a calculation request based on the set property of the Purchase Message Type. Valid values are: Purchase Order, Invoice Verification, Accrual, Distribute Tax, and Evaluated Receipts Settlement (ERS). Based on the property PurchaseMessageType value, a tax calculation is performed and may or may not be saved for reporting and tax remittance.
Purchase message types
| Message type | Description |
|---|---|
| Purchase Order | A Purchase Order is used to estimate the tax on intended purchases for a Buyer. The intended purchase of goods or services, including tax, is used as input to generate the purchase order. The ultimate use of the goods or services typically dictates the taxability of the purchase. Purchase Order transactions are not stored for reporting or used in tax remittance. |
| Invoice Verification | The Accrual Request initiates a self-accrual calculation. This situation occurs when the buyer must remit tax on tangible personal property or services (used or consumed) when tax due on the transaction has not been paid. Accrual transactions are stored and used for reporting and remittance. |
| Accrual | The Invoice Verification is used to verify tax on incoming invoices to the buyer for tangible personal property, rentals, and leases. The invoice is recreated from the seller's perspective to validate that the appropriate tax has been applied. The Invoice Verification compares the total vendor-charged or supplier-charged tax amount from the original invoice to the Vertex-calculated tax amount. If any user-defined verification thresholds are set up, the engine validates for tolerances at the transaction level, and returns an indicator to the host system for undercharges and overcharges outside of the settings. The invoice may display no tax if the buyer has filed a direct pay permit with the vendor or supplier. Invoice Verification transactions are not stored for reporting or used in tax remittance. |
| Distribute Tax | The Distribute Tax Procurement accepts a combined total tax amount for a purchase and distributes that tax to the appropriate jurisdictions. The engine uses the total tax amount with the combined rates for the taxing jurisdictions to determine the taxable base, and then redistributes the calculated taxes to each level for remittance. Use this request for a tax-only adjustment (debit or credit) to reconcile a tax underpayment or overpayment. The engine uses Vertex taxability rules that are effective on the date specified in the documentDate attribute. The engine processes records for jurisdiction registration, product exception or customer exception, or customer exemption if they are dated on or before that date. A Distribute Tax Procurement transaction impacts revenue unless you designate it as a tax-only adjustment. Distribute Tax Procurement transactions are stored for reporting. |
| Evaluated Receipts Settlement (ERS) | Initiates an ERS calculation. Use the ERS request to calculate tax when a formalized agreement between the buyer and seller places the tax calculation burden on the buyer. In these situations, the seller does not issue an invoice. Instead, the buyer relies on pre-established terms (represented in a purchase order or other agreement) to calculate the tax due and remit payment directly to the seller. You must have a current knowledge of the seller's tax status (for example, where the seller is registered or has nexus) to assess tax at the appropriate rate. In instances where the seller is not registered or does not have nexus in a taxing jurisdiction, the buyer determines the tax due and remits this Consumer Use Tax directly to the jurisdiction |
Child lines and the lineItems array
All calculation requests include alineItems array, which is the header for a component (a line) of a transaction. A separate lineItems array is required for each component (line) to be calculated in a tax calculation request.
One of the objects in a header-level lineItems array is a sub-level lineItems array, used for the calculation of child lines. Child lines are transaction lines that belong to a parent line on a transaction. Child lines are required for complex taxing scenarios, such as bundled services, multi-line calculation for line-based telecommunications taxes, and the allocation of accruals.
A sub-level lineItems array includes the same objects and fields as a header-level lineItems array, so each sub-level lineItems array contains its ownlineItems array. To allow for flexibility during calculation, O Series supports the calculation of child lines that belong to other child lines.
Sample request - Calculate tax as a buyer
curl --request POST
--url https://developer.vertexcloud.com/api/v2/procurement
--header 'accept: application/json'
--header 'content-type: application/json'
--data '
{
"accumulationCustomerNumber": "string",
"accumulationDocumentNumber": "string",
"billingType": "string",
"buyer": {
"administrativeDestination": {
"city": "string",
"country": "string",
"currencyConversion": {
"currency": {
"isoCurrencyCodeAlpha": "string",
"isoCurrencyCodeNum": 0,
"isoCurrencyName": "string"
},
"rate": 0
},
"externalJurisdictionCode": "string",
"latitude": "string",
"locationCode": "string",
"locationCustomsStatus": "FREE_CIRCULATION",
"longitude": "string",
"mainDivision": "string",
"postalCode": "string",
"streetAddress1": "string",
"streetAddress2": "string",
"subDivision": "string",
"taxAreaId": "string"
},
"company": "string",
"department": "string",
"destination": {
"city": "string",
"country": "string",
"currencyConversion": {
"currency": {
"isoCurrencyCodeAlpha": "string",
"isoCurrencyCodeNum": 0,
"isoCurrencyName": "string"
},
"rate": 0
},
"externalJurisdictionCode": "string",
"latitude": "string",
"locationCode": "string",
"locationCustomsStatus": "FREE_CIRCULATION",
"longitude": "string",
"mainDivision": "string",
"postalCode": "string",
"streetAddress1": "string",
"streetAddress2": "string",
"subDivision": "string",
"taxAreaId": "string"
},
"division": "string",
"exemptionCertificate": {
"exemptionCertificateNumber": "string",
"value": "string"
},
"exemptionReasonCode": "string",
"isTaxExempt": true,
"recipient": {
"recipientCode": {
"classCode": "string",
"isBusinessIndicator": true,
"value": "string"
},
"taxRegistrations": [
{
"hasPhysicalPresenceIndicator": true,
"impositionType": {
"impositionTypeId": "string",
"userDefined": true,
"value": "string",
"withholdingType": "string"
},
"isoCountryCode": "string",
"jurisdictionId": "string",
"mainDivision": "string",
"nexusOverrides": [
{
"city": true,
"country": true,
"district": true,
"locationRole": "ADMINISTRATIVE_DESTINATION",
"mainDivision": true,
"subDivision": true
}
],
"physicalLocations": [
{
"city": "string",
"country": "string",
"mainDivision": "string",
"postalCode": "string",
"streetAddress1": "string",
"streetAddress2": "string",
"subDivision": "string",
"taxAreaId": "string"
}
],
"taxRegistrationNumber": "string",
"filingCurrency": {
"isoCurrencyCodeAlpha": "string",
"isoCurrencyCodeNum": 0,
"isoCurrencyName": "string"
},
"taxRegistrationType": "VAT Registration"
}
]
},
"taxRegistrations": [
{
"hasPhysicalPresenceIndicator": true,
"impositionType": {
"impositionTypeId": "string",
"userDefined": true,
"value": "string",
"withholdingType": "string"
},
"isoCountryCode": "string",
"jurisdictionId": "string",
"mainDivision": "string",
"nexusOverrides": [
{
"city": true,
"country": true,
"district": true,
"locationRole": "ADMINISTRATIVE_DESTINATION",
"mainDivision": true,
"subDivision": true
}
],
"physicalLocations": [
{
"city": "string",
"country": "string",
"mainDivision": "string",
"postalCode": "string",
"streetAddress1": "string",
"streetAddress2": "string",
"subDivision": "string",
"taxAreaId": "string"
}
],
"taxRegistrationNumber": "string",
"filingCurrency": {
"isoCurrencyCodeAlpha": "string",
"isoCurrencyCodeNum": 0,
"isoCurrencyName": "string"
},
"taxRegistrationType": "VAT Registration"
}
],
"utilityProvider": "REGULATED_TAXPAYER"
},
"calculateVendorTaxIndicator": true,
"calculateSelfAccrualIndicator": true,
"chargedTax": 0,
"companyCodeCurrency": {
"isoCurrencyCodeAlpha": "string",
"isoCurrencyCodeNum": 0,
"isoCurrencyName": "string"
},
"currency": {
"isoCurrencyCodeAlpha": "string",
"isoCurrencyCodeNum": 0,
"isoCurrencyName": "string"
},
"currencyConversionFactors": [
{
"conversionFactor": 0,
"sourceCurrency": {
"isoCurrencyCodeAlpha": "string",
"isoCurrencyCodeNum": 0,
"isoCurrencyName": "string"
},
"targetCurrency": {
"isoCurrencyCodeAlpha": "string",
"isoCurrencyCodeNum": 0,
"isoCurrencyName": "string"
}
}
],
"deliveryTerm": "EXW",
"discount": {
"discountType": "DiscountAmount",
"discountValue": 0,
"userDefinedDiscountCode": "string"
},
"documentDate": "2025-01-30",
"documentNumber": "string",
"documentSequenceId": "string",
"documentType": "string",
"exemptOverrides": [
{
"amount": 0,
"impositionType": {
"impositionTypeId": "string",
"userDefined": true,
"value": "string",
"withholdingType": "string"
},
"jurisdictionType": "APO",
"reasonCode": "string"
}
],
"franchiseAreaId": "string",
"impositionInclusions": [
{
"impositionType": {
"impositionTypeId": "string",
"userDefined": true,
"value": "string",
"withholdingType": "string"
},
"jurisdictionType": "APO"
}
],
"isTaxOnlyAdjustmentIndicator": true,
"lineItems": [
{
"amountBilledToDate": 0,
"blockingOverridePercent": 0,
"buyer": {
"administrativeDestination": {
"city": "string",
"country": "string",
"currencyConversion": {
"currency": {
"isoCurrencyCodeAlpha": "string",
"isoCurrencyCodeNum": 0,
"isoCurrencyName": "string"
},
"rate": 0
},
"externalJurisdictionCode": "string",
"latitude": "string",
"locationCode": "string",
"locationCustomsStatus": "FREE_CIRCULATION",
"longitude": "string",
"mainDivision": "string",
"postalCode": "string",
"streetAddress1": "string",
"streetAddress2": "string",
"subDivision": "string",
"taxAreaId": "string"
},
"company": "string",
"department": "string",
"destination": {
"city": "string",
"country": "string",
"currencyConversion": {
"currency": {
"isoCurrencyCodeAlpha": "string",
"isoCurrencyCodeNum": 0,
"isoCurrencyName": "string"
},
"rate": 0
},
"externalJurisdictionCode": "string",
"latitude": "string",
"locationCode": "string",
"locationCustomsStatus": "FREE_CIRCULATION",
"longitude": "string",
"mainDivision": "string",
"postalCode": "string",
"streetAddress1": "string",
"streetAddress2": "string",
"subDivision": "string",
"taxAreaId": "string"
},
"division": "string",
"exemptionCertificate": {
"exemptionCertificateNumber": "string",
"value": "string"
},
"exemptionReasonCode": "string",
"isTaxExempt": true,
"recipient": {
"recipientCode": {
"classCode": "string",
"isBusinessIndicator": true,
"value": "string"
},
"taxRegistrations": [
{
"hasPhysicalPresenceIndicator": true,
"impositionType": {
"impositionTypeId": "string",
"userDefined": true,
"value": "string",
"withholdingType": "string"
},
"isoCountryCode": "string",
"jurisdictionId": "string",
"mainDivision": "string",
"nexusOverrides": [
{
"city": true,
"country": true,
"district": true,
"locationRole": "ADMINISTRATIVE_DESTINATION",
"mainDivision": true,
"subDivision": true
}
],
"physicalLocations": [
{
"city": "string",
"country": "string",
"mainDivision": "string",
"postalCode": "string",
"streetAddress1": "string",
"streetAddress2": "string",
"subDivision": "string",
"taxAreaId": "string"
}
],
"taxRegistrationNumber": "string",
"filingCurrency": {
"isoCurrencyCodeAlpha": "string",
"isoCurrencyCodeNum": 0,
"isoCurrencyName": "string"
},
"taxRegistrationType": "VAT Registration"
}
]
},
"taxRegistrations": [
{
"hasPhysicalPresenceIndicator": true,
"impositionType": {
"impositionTypeId": "string",
"userDefined": true,
"value": "string",
"withholdingType": "string"
},
"isoCountryCode": "string",
"jurisdictionId": "string",
"mainDivision": "string",
"nexusOverrides": [
{
"city": true,
"country": true,
"district": true,
"locationRole": "ADMINISTRATIVE_DESTINATION",
"mainDivision": true,
"subDivision": true
}
],
"physicalLocations": [
{
"city": "string",
"country": "string",
"mainDivision": "string",
"postalCode": "string",
"streetAddress1": "string",
"streetAddress2": "string",
"subDivision": "string",
"taxAreaId": "string"
}
],
"taxRegistrationNumber": "string",
"filingCurrency": {
"isoCurrencyCodeAlpha": "string",
"isoCurrencyCodeNum": 0,
"isoCurrencyName": "string"
},
"taxRegistrationType": "VAT Registration"
}
],
"utilityProvider": "REGULATED_TAXPAYER"
},
"chainTransactionPhase": "MANUFACTURER",
"chargedTax": 0,
"commodityCode": {
"commodityCodeType": "string",
"value": "string"
},
"companyCodeCurrencyTaxAmount": 0,
"companyCodeCurrencyTaxableAmount": 0,
"cost": 0,
"costCenter": "string",
"countryOfOriginISOCode": "string",
"deliveryTerm": "EXW",
"departmentCode": "string",
"discount": {
"discountType": "DiscountAmount",
"discountValue": 0,
"userDefinedDiscountCode": "string"
},
"exemptOverrides": [
{
"amount": 0,
"impositionType": {
"impositionTypeId": "string",
"userDefined": true,
"value": "string",
"withholdingType": "string"
},
"jurisdictionType": "APO",
"reasonCode": "string"
}
],
"exportProcedure": "string",
"extendedPrice": 0,
"flexibleFields": {
"flexibleCodeFields": [
{
"fieldId": 0,
"value": "string"
}
],
"flexibleDateFields": [
{
"fieldId": 0,
"value": "2025-01-30"
}
],
"flexibleNumericFields": [
{
"fieldId": 0,
"value": 0
}
]
},
"franchiseAreaId": "string",
"freight": 0,
"generalLedgerAccount": "string",
"impositionInclusions": [
{
"impositionType": {
"impositionTypeId": "string",
"userDefined": true,
"value": "string",
"withholdingType": "string"
},
"jurisdictionType": "APO"
}
],
"inputTotalTax": 0,
"intrastatCommodityCode": "string",
"isMulticomponent": true,
"landedCost": 0,
"lineItemId": "string",
"lineItemNumber": 0,
"lineType": {
"accumulationLocation": "string",
"content": "string",
"direction": "string",
"status": "string",
"value": "string"
},
"locationCode": "string",
"materialCode": "string",
"materialOrigin": "string",
"modeOfTransport": 0,
"natureOfTransaction": 0,
"netMassKilograms": 0,
"nonTaxableOverrides": [
{
"amount": 0,
"impositionType": {
"impositionTypeId": "string",
"userDefined": true,
"value": "string",
"withholdingType": "string"
},
"jurisdictionType": "APO",
"reasonCode": "string"
}
],
"partialExemptRecoverableOverridePercent": 0,
"projectNumber": "string",
"purchase": {
"purchaseClass": "string",
"value": "string"
},
"quantity": {
"unitOfMeasure": "string",
"value": 0
},
"rateOverrides": [
{
"impositionType": {
"impositionTypeId": "string",
"userDefined": true,
"value": "string",
"withholdingType": "string"
},
"jurisdictionType": "APO",
"rate": 0
}
],
"recoverableDate": "2025-01-30",
"returnsFields": {
"returnsCodeFields": [
{
"name": "string",
"value": "string"
}
],
"returnsDateFields": [
{
"name": "string",
"value": "2025-01-30"
}
],
"returnsIndicatorFields": [
{
"name": "string",
"value": true
}
],
"returnsNumericFields": [
{
"name": "string",
"value": 0
}
]
},
"simplificationCode": "CONSIGNMENT",
"situsOverride": {
"taxingLocation": "ADMINISTRATIVE_DESTINATION"
},
"specialTaxBasis": 0,
"statisticalValue": {
"amount": 0,
"currency": {
"isoCurrencyCodeAlpha": "string",
"isoCurrencyCodeNum": 0,
"isoCurrencyName": "string"
}
},
"supplementaryUnit": {
"unitType": "string",
"value": 0
},
"taxDate": "2025-01-30",
"taxIncludedIndicator": true,
"taxOverride": {
"overrideReasonCode": "string",
"overrideType": "TAXABLE"
},
"titleTransfer": "ORIGIN",
"transactionType": "PURCHASE",
"unitPrice": 0,
"usage": "string",
"usageClass": "string",
"vendor": {
"administrativeOrigin": {
"city": "string",
"country": "string",
"currencyConversion": {
"currency": {
"isoCurrencyCodeAlpha": "string",
"isoCurrencyCodeNum": 0,
"isoCurrencyName": "string"
},
"rate": 0
},
"externalJurisdictionCode": "string",
"latitude": "string",
"locationCode": "string",
"locationCustomsStatus": "FREE_CIRCULATION",
"longitude": "string",
"mainDivision": "string",
"postalCode": "string",
"streetAddress1": "string",
"streetAddress2": "string",
"subDivision": "string",
"taxAreaId": "string"
},
"physicalOrigin": {
"city": "string",
"country": "string",
"currencyConversion": {
"currency": {
"isoCurrencyCodeAlpha": "string",
"isoCurrencyCodeNum": 0,
"isoCurrencyName": "string"
},
"rate": 0
},
"externalJurisdictionCode": "string",
"latitude": "string",
"locationCode": "string",
"locationCustomsStatus": "FREE_CIRCULATION",
"longitude": "string",
"mainDivision": "string",
"postalCode": "string",
"streetAddress1": "string",
"streetAddress2": "string",
"subDivision": "string",
"taxAreaId": "string"
},
"taxRegistrations": [
{
"hasPhysicalPresenceIndicator": true,
"impositionType": {
"impositionTypeId": "string",
"userDefined": true,
"value": "string",
"withholdingType": "string"
},
"isoCountryCode": "string",
"jurisdictionId": "string",
"mainDivision": "string",
"nexusOverrides": [
{
"city": true,
"country": true,
"district": true,
"locationRole": "ADMINISTRATIVE_DESTINATION",
"mainDivision": true,
"subDivision": true
}
],
"physicalLocations": [
{
"city": "string",
"country": "string",
"mainDivision": "string",
"postalCode": "string",
"streetAddress1": "string",
"streetAddress2": "string",
"subDivision": "string",
"taxAreaId": "string"
}
],
"taxRegistrationNumber": "string",
"filingCurrency": {
"isoCurrencyCodeAlpha": "string",
"isoCurrencyCodeNum": 0,
"isoCurrencyName": "string"
},
"taxRegistrationType": "VAT Registration"
}
],
"vendorCode": {
"classCode": "string",
"value": "string"
},
"dispatcherCode": {
"classCode": "string",
"value": "string"
}
},
"vendorSKU": "string",
"vendorTaxes": [
{
"blockingOverridePercent": 0,
"inputAmount": 0,
"invoiceTaxRate": 0,
"isImport": true,
"partialExemptRecoverableOverridePercent": 0,
"taxingJurisdictionLocation": {
"city": "string",
"country": "string",
"currencyConversion": {
"currency": {
"isoCurrencyCodeAlpha": "string",
"isoCurrencyCodeNum": 0,
"isoCurrencyName": "string"
},
"rate": 0
},
"externalJurisdictionCode": "string",
"impositionType": {
"impositionTypeId": "string",
"userDefined": true,
"value": "string",
"withholdingType": "string"
},
"jurisdictionType": "APO",
"latitude": "string",
"locationCode": "string",
"longitude": "string",
"mainDivision": "string",
"postalCode": "string",
"streetAddress1": "string",
"streetAddress2": "string",
"subDivision": "string",
"taxAreaId": "string"
}
}
],
"volume": {
"unitOfMeasure": "string",
"value": 0
},
"wageBasis": 0,
"weight": {
"unitOfMeasure": "string",
"value": 0
}
}
],
"locationCode": "string",
"nonTaxableOverrides": [
{
"amount": 0,
"impositionType": {
"impositionTypeId": "string",
"userDefined": true,
"value": "string",
"withholdingType": "string"
},
"jurisdictionType": "APO",
"reasonCode": "string"
}
],
"orderType": "string",
"originalCurrency": {
"isoCurrencyCodeAlpha": "string",
"isoCurrencyCodeNum": 0,
"isoCurrencyName": "string"
},
"paymentDate": "2025-01-30",
"postToJournal": true,
"postingDate": "2025-01-30",
"proratePercentage": 0,
"purchaseMessageType": "PURCHASE_ORDER",
"rateOverrides": [
{
"impositionType": {
"impositionTypeId": "string",
"userDefined": true,
"value": "string",
"withholdingType": "string"
},
"jurisdictionType": "APO",
"rate": 0
}
],
"recoverableDate": "2025-01-30",
"returnAssistedParametersIndicator": true,
"returnGeneratedLineItemsIndicator": true,
"roundAtLineLevel": true,
"simplificationCode": "CONSIGNMENT",
"situsOverride": {
"taxingLocation": "ADMINISTRATIVE_DESTINATION"
},
"taxOverride": {
"overrideReasonCode": "string",
"overrideType": "TAXABLE"
},
"taxPointDate": "2025-01-30",
"taxabilityCategoryTotals": [
{
"city": "string",
"country": "string",
"impositionType": {
"impositionTypeId": "string",
"userDefined": true,
"value": "string",
"withholdingType": "string"
},
"mainDivision": "string",
"subDivision": "string",
"taxImposition": {
"impositionId": "string",
"jurisdictionId": "string",
"userDefined": true,
"value": "string"
},
"taxabilityCategory": {
"userDefined": true,
"value": "string"
},
"totalAmount": {
"amount": 0,
"currency": {
"isoCurrencyCodeAlpha": "string",
"isoCurrencyCodeNum": 0,
"isoCurrencyName": "string"
}
}
}
],
"transactionId": "string",
"transactionType": "PURCHASE",
"vendor": {
"administrativeOrigin": {
"city": "string",
"country": "string",
"currencyConversion": {
"currency": {
"isoCurrencyCodeAlpha": "string",
"isoCurrencyCodeNum": 0,
"isoCurrencyName": "string"
},
"rate": 0
},
"externalJurisdictionCode": "string",
"latitude": "string",
"locationCode": "string",
"locationCustomsStatus": "FREE_CIRCULATION",
"longitude": "string",
"mainDivision": "string",
"postalCode": "string",
"streetAddress1": "string",
"streetAddress2": "string",
"subDivision": "string",
"taxAreaId": "string"
},
"physicalOrigin": {
"city": "string",
"country": "string",
"currencyConversion": {
"currency": {
"isoCurrencyCodeAlpha": "string",
"isoCurrencyCodeNum": 0,
"isoCurrencyName": "string"
},
"rate": 0
},
"externalJurisdictionCode": "string",
"latitude": "string",
"locationCode": "string",
"locationCustomsStatus": "FREE_CIRCULATION",
"longitude": "string",
"mainDivision": "string",
"postalCode": "string",
"streetAddress1": "string",
"streetAddress2": "string",
"subDivision": "string",
"taxAreaId": "string"
},
"taxRegistrations": [
{
"hasPhysicalPresenceIndicator": true,
"impositionType": {
"impositionTypeId": "string",
"userDefined": true,
"value": "string",
"withholdingType": "string"
},
"isoCountryCode": "string",
"jurisdictionId": "string",
"mainDivision": "string",
"nexusOverrides": [
{
"city": true,
"country": true,
"district": true,
"locationRole": "ADMINISTRATIVE_DESTINATION",
"mainDivision": true,
"subDivision": true
}
],
"physicalLocations": [
{
"city": "string",
"country": "string",
"mainDivision": "string",
"postalCode": "string",
"streetAddress1": "string",
"streetAddress2": "string",
"subDivision": "string",
"taxAreaId": "string"
}
],
"taxRegistrationNumber": "string",
"filingCurrency": {
"isoCurrencyCodeAlpha": "string",
"isoCurrencyCodeNum": 0,
"isoCurrencyName": "string"
},
"taxRegistrationType": "VAT Registration"
}
],
"vendorCode": {
"classCode": "string",
"value": "string"
},
"dispatcherCode": {
"classCode": "string",
"value": "string"
}
}
}
'
Sample response - Calculate tax as a buyer
{
"data": {
"accumulationCustomerNumber": "string",
"accumulationDocumentNumber": "string",
"billingType": "string",
"companyCodeCurrency": {
"isoCurrencyCodeAlpha": "string",
"isoCurrencyCodeNum": 0,
"isoCurrencyName": "string"
},
"currency": {
"isoCurrencyCodeAlpha": "string",
"isoCurrencyCodeNum": 0,
"isoCurrencyName": "string"
},
"currencyConversionFactors": [
{
"conversionFactor": 0,
"sourceCurrency": {
"isoCurrencyCodeAlpha": "string",
"isoCurrencyCodeNum": 0,
"isoCurrencyName": "string"
},
"targetCurrency": {
"isoCurrencyCodeAlpha": "string",
"isoCurrencyCodeNum": 0,
"isoCurrencyName": "string"
}
}
],
"customer": {
"administrativeDestination": {
"city": "string",
"country": "string",
"currencyConversion": {
"currency": {
"isoCurrencyCodeAlpha": "string",
"isoCurrencyCodeNum": 0,
"isoCurrencyName": "string"
},
"rate": 0
},
"externalJurisdictionCode": "string",
"latitude": "string",
"locationCode": "string",
"locationCustomsStatus": "FREE_CIRCULATION",
"longitude": "string",
"mainDivision": "string",
"postalCode": "string",
"streetAddress1": "string",
"streetAddress2": "string",
"subDivision": "string",
"taxAreaId": "string"
},
"customerCode": {
"classCode": "string",
"isBusinessIndicator": true,
"value": "string"
},
"destination": {
"city": "string",
"country": "string",
"currencyConversion": {
"currency": {
"isoCurrencyCodeAlpha": "string",
"isoCurrencyCodeNum": 0,
"isoCurrencyName": "string"
},
"rate": 0
},
"externalJurisdictionCode": "string",
"latitude": "string",
"locationCode": "string",
"locationCustomsStatus": "FREE_CIRCULATION",
"longitude": "string",
"mainDivision": "string",
"postalCode": "string",
"streetAddress1": "string",
"streetAddress2": "string",
"subDivision": "string",
"taxAreaId": "string"
},
"exemptionCertificate": {
"exemptionCertificateNumber": "string",
"value": "string"
},
"exemptionReasonCode": "string",
"isTaxExempt": true,
"taxRegistrations": [
{
"hasPhysicalPresenceIndicator": true,
"impositionType": {
"impositionTypeId": "string",
"userDefined": true,
"value": "string",
"withholdingType": "string"
},
"isoCountryCode": "string",
"jurisdictionId": "string",
"mainDivision": "string",
"nexusOverrides": [
{
"city": true,
"country": true,
"district": true,
"locationRole": "ADMINISTRATIVE_DESTINATION",
"mainDivision": true,
"subDivision": true
}
],
"physicalLocations": [
{
"city": "string",
"country": "string",
"mainDivision": "string",
"postalCode": "string",
"streetAddress1": "string",
"streetAddress2": "string",
"subDivision": "string",
"taxAreaId": "string"
}
],
"taxRegistrationNumber": "string",
"filingCurrency": {
"isoCurrencyCodeAlpha": "string",
"isoCurrencyCodeNum": 0,
"isoCurrencyName": "string"
},
"taxRegistrationType": "VAT Registration"
}
]
},
"deliveryTerm": "EXW",
"discount": {
"discountType": "DiscountAmount",
"discountValue": 0,
"userDefinedDiscountCode": "string"
},
"documentDate": "2025-01-30",
"documentNumber": "string",
"documentSequenceId": "string",
"documentType": "string",
"exemptOverrides": [
{
"amount": 0,
"impositionType": {
"impositionTypeId": "string",
"userDefined": true,
"value": "string",
"withholdingType": "string"
},
"jurisdictionType": "APO",
"reasonCode": "string"
}
],
"franchiseAreaId": "string",
"impositionInclusions": [
{
"impositionType": {
"impositionTypeId": "string",
"userDefined": true,
"value": "string",
"withholdingType": "string"
},
"jurisdictionType": "APO"
}
],
"isTaxOnlyAdjustmentIndicator": true,
"lineItems": [
{
"amountBilledToDate": 0,
"assistedParameters": [
{
"originalValue": "string",
"paramName": "string",
"phase": "PRE",
"ruleName": "string",
"value": "string"
}
],
"chainTransactionPhase": "MANUFACTURER",
"commodityCode": {
"commodityCodeType": "string",
"usedCommodityCode": "string",
"userDefined": true,
"value": "string"
},
"companyCodeCurrencyTaxAmount": 0,
"companyCodeCurrencyTaxableAmount": 0,
"costCenter": "string",
"countryOfOriginISOCode": "string",
"customer": {
"administrativeDestination": {
"city": "string",
"country": "string",
"currencyConversion": {
"currency": {
"isoCurrencyCodeAlpha": "string",
"isoCurrencyCodeNum": 0,
"isoCurrencyName": "string"
},
"rate": 0
},
"externalJurisdictionCode": "string",
"latitude": "string",
"locationCode": "string",
"locationCustomsStatus": "FREE_CIRCULATION",
"longitude": "string",
"mainDivision": "string",
"postalCode": "string",
"streetAddress1": "string",
"streetAddress2": "string",
"subDivision": "string",
"taxAreaId": "string"
},
"customerCode": {
"classCode": "string",
"isBusinessIndicator": true,
"value": "string"
},
"destination": {
"city": "string",
"country": "string",
"currencyConversion": {
"currency": {
"isoCurrencyCodeAlpha": "string",
"isoCurrencyCodeNum": 0,
"isoCurrencyName": "string"
},
"rate": 0
},
"externalJurisdictionCode": "string",
"latitude": "string",
"locationCode": "string",
"locationCustomsStatus": "FREE_CIRCULATION",
"longitude": "string",
"mainDivision": "string",
"postalCode": "string",
"streetAddress1": "string",
"streetAddress2": "string",
"subDivision": "string",
"taxAreaId": "string"
},
"exemptionCertificate": {
"exemptionCertificateNumber": "string",
"value": "string"
},
"exemptionReasonCode": "string",
"isTaxExempt": true,
"taxRegistrations": [
{
"hasPhysicalPresenceIndicator": true,
"impositionType": {
"impositionTypeId": "string",
"userDefined": true,
"value": "string",
"withholdingType": "string"
},
"isoCountryCode": "string",
"jurisdictionId": "string",
"mainDivision": "string",
"nexusOverrides": [
{
"city": true,
"country": true,
"district": true,
"locationRole": "ADMINISTRATIVE_DESTINATION",
"mainDivision": true,
"subDivision": true
}
],
"physicalLocations": [
{
"city": "string",
"country": "string",
"mainDivision": "string",
"postalCode": "string",
"streetAddress1": "string",
"streetAddress2": "string",
"subDivision": "string",
"taxAreaId": "string"
}
],
"taxRegistrationNumber": "string",
"filingCurrency": {
"isoCurrencyCodeAlpha": "string",
"isoCurrencyCodeNum": 0,
"isoCurrencyName": "string"
},
"taxRegistrationType": "VAT Registration"
}
]
},
"deliveryTerm": "EXW",
"departmentCode": "string",
"discount": {
"discountType": "DiscountAmount",
"discountValue": 0,
"userDefinedDiscountCode": "string"
},
"exemptOverrides": [
{
"amount": 0,
"impositionType": {
"impositionTypeId": "string",
"userDefined": true,
"value": "string",
"withholdingType": "string"
},
"jurisdictionType": "APO",
"reasonCode": "string"
}
],
"exportProcedure": "string",
"extendedPrice": 0,
"fairMarketValue": 0,
"flexibleFields": {
"flexibleCodeFields": [
{
"fieldId": 0,
"value": "string"
}
],
"flexibleDateFields": [
{
"fieldId": 0,
"value": "2025-01-30"
}
],
"flexibleNumericFields": [
{
"fieldId": 0,
"value": 0
}
]
},
"franchiseAreaId": "string",
"freight": 0,
"generalLedgerAccount": "string",
"impositionInclusions": [
{
"impositionType": {
"impositionTypeId": "string",
"userDefined": true,
"value": "string",
"withholdingType": "string"
},
"jurisdictionType": "APO"
}
],
"inputTotalTax": 0,
"intrastatCommodityCode": "string",
"isMulticomponent": true,
"lineItemId": "string",
"lineItemNumber": 0,
"lineItems": [
null
],
"lineType": {
"accumulationLocation": "string",
"content": "string",
"direction": "string",
"status": "string",
"value": "string"
},
"lineTypes": [
{
"accumulationLocation": "string",
"basis": "string",
"content": "string",
"count": 0,
"direction": "string",
"lineTypeNumber": 0,
"status": "string",
"value": "string"
}
],
"locationCode": "string",
"materialCode": "string",
"materialOrigin": "string",
"modeOfTransport": 0,
"natureOfTransaction": 0,
"netMassKilograms": 0,
"nonTaxableOverrides": [
{
"amount": 0,
"impositionType": {
"impositionTypeId": "string",
"userDefined": true,
"value": "string",
"withholdingType": "string"
},
"jurisdictionType": "APO",
"reasonCode": "string"
}
],
"product": {
"productClass": "string",
"value": "string"
},
"projectNumber": "string",
"quantity": {
"unitOfMeasure": "string",
"value": 0
},
"rateOverrides": [
{
"impositionType": {
"impositionTypeId": "string",
"userDefined": true,
"value": "string",
"withholdingType": "string"
},
"jurisdictionType": "APO",
"rate": 0
}
],
"returnsFields": {
"returnsCodeFields": [
{
"name": "string",
"value": "string"
}
],
"returnsDateFields": [
{
"name": "string",
"value": "2025-01-30"
}
],
"returnsIndicatorFields": [
{
"name": "string",
"value": true
}
],
"returnsNumericFields": [
{
"name": "string",
"value": 0
}
]
},
"seller": {
"administrativeOrigin": {
"city": "string",
"country": "string",
"currencyConversion": {
"currency": {
"isoCurrencyCodeAlpha": "string",
"isoCurrencyCodeNum": 0,
"isoCurrencyName": "string"
},
"rate": 0
},
"externalJurisdictionCode": "string",
"latitude": "string",
"locationCode": "string",
"locationCustomsStatus": "FREE_CIRCULATION",
"longitude": "string",
"mainDivision": "string",
"postalCode": "string",
"streetAddress1": "string",
"streetAddress2": "string",
"subDivision": "string",
"taxAreaId": "string"
},
"company": "string",
"department": "string",
"dispatcher": {
"dispatcherCode": {
"classCode": "string",
"value": "string"
},
"taxRegistrations": [
{
"hasPhysicalPresenceIndicator": true,
"impositionType": {
"impositionTypeId": "string",
"userDefined": true,
"value": "string",
"withholdingType": "string"
},
"isoCountryCode": "string",
"jurisdictionId": "string",
"mainDivision": "string",
"nexusOverrides": [
{
"city": true,
"country": true,
"district": true,
"locationRole": "ADMINISTRATIVE_DESTINATION",
"mainDivision": true,
"subDivision": true
}
],
"physicalLocations": [
{
"city": "string",
"country": "string",
"mainDivision": "string",
"postalCode": "string",
"streetAddress1": "string",
"streetAddress2": "string",
"subDivision": "string",
"taxAreaId": "string"
}
],
"taxRegistrationNumber": "string",
"filingCurrency": {
"isoCurrencyCodeAlpha": "string",
"isoCurrencyCodeNum": 0,
"isoCurrencyName": "string"
},
"taxRegistrationType": "VAT Registration"
}
]
},
"division": "string",
"nexusIndicator": true,
"nexusReasonCode": "string",
"physicalOrigin": {
"city": "string",
"country": "string",
"currencyConversion": {
"currency": {
"isoCurrencyCodeAlpha": "string",
"isoCurrencyCodeNum": 0,
"isoCurrencyName": "string"
},
"rate": 0
},
"externalJurisdictionCode": "string",
"latitude": "string",
"locationCode": "string",
"locationCustomsStatus": "FREE_CIRCULATION",
"longitude": "string",
"mainDivision": "string",
"postalCode": "string",
"streetAddress1": "string",
"streetAddress2": "string",
"subDivision": "string",
"taxAreaId": "string"
},
"taxRegistrations": [
{
"hasPhysicalPresenceIndicator": true,
"impositionType": {
"impositionTypeId": "string",
"userDefined": true,
"value": "string",
"withholdingType": "string"
},
"isoCountryCode": "string",
"jurisdictionId": "string",
"mainDivision": "string",
"nexusOverrides": [
{
"city": true,
"country": true,
"district": true,
"locationRole": "ADMINISTRATIVE_DESTINATION",
"mainDivision": true,
"subDivision": true
}
],
"physicalLocations": [
{
"city": "string",
"country": "string",
"mainDivision": "string",
"postalCode": "string",
"streetAddress1": "string",
"streetAddress2": "string",
"subDivision": "string",
"taxAreaId": "string"
}
],
"taxRegistrationNumber": "string",
"filingCurrency": {
"isoCurrencyCodeAlpha": "string",
"isoCurrencyCodeNum": 0,
"isoCurrencyName": "string"
},
"taxRegistrationType": "VAT Registration"
}
],
"utilityProvider": "REGULATED_TAXPAYER"
},
"simplificationCode": "CONSIGNMENT",
"situsOverride": {
"taxingLocation": "ADMINISTRATIVE_DESTINATION"
},
"statisticalValue": {
"amount": 0,
"currency": {
"isoCurrencyCodeAlpha": "string",
"isoCurrencyCodeNum": 0,
"isoCurrencyName": "string"
}
},
"supplementaryUnit": {
"unitType": "string",
"value": 0
},
"taxDate": "2025-01-30",
"taxIncludedIndicator": true,
"taxOverride": {
"overrideReasonCode": "string",
"overrideType": "TAXABLE"
},
"taxes": [
{
"accumulateAsImposition": {
"impositionId": "string",
"jurisdictionId": "string",
"userDefined": true,
"value": "string"
},
"accumulateAsImpositionType": {
"impositionTypeId": "string",
"userDefined": true,
"value": "string",
"withholdingType": "string"
},
"accumulateAsJurisdiction": {
"effectiveDate": "2025-01-30",
"expirationDate": "2025-01-30",
"externalJurisdictionCode": "string",
"jurisdictionId": "string",
"jurisdictionType": "APO",
"value": "string"
},
"accumulateAsLineType": {
"userDefined": true,
"value": "string"
},
"accumulationRuleId": {
"salesTaxHolidayIndicator": true,
"userDefined": true,
"value": "string"
},
"assistedParameters": [
{
"originalValue": "string",
"paramName": "string",
"phase": "PRE",
"ruleName": "string",
"value": "string"
}
],
"basisApportionmentRuleId": {
"salesTaxHolidayIndicator": true,
"userDefined": true,
"value": "string"
},
"basisReductionPercentage": 0,
"basisRuleId": {
"salesTaxHolidayIndicator": true,
"userDefined": true,
"value": "string"
},
"blockingRecoverablePercent": 0,
"buyerRegistrationId": "string",
"calculatedTax": 0,
"calculationRuleId": {
"salesTaxHolidayIndicator": true,
"userDefined": true,
"value": "string"
},
"certificateNumber": {
"certificateType": "string",
"value": "string"
},
"creditRuleId": {
"salesTaxHolidayIndicator": true,
"userDefined": true,
"value": "string"
},
"dispatcherRegistrationId": "string",
"effectiveRate": 0,
"exempt": 0,
"exemptMeasure": {
"unitOfMeasure": "string",
"value": 0
},
"filingCategoryCode": 0,
"filingCurrencyAmounts": {
"currencyConversion": {
"currency": {
"isoCurrencyCodeAlpha": "string",
"isoCurrencyCodeNum": 0,
"isoCurrencyName": "string"
},
"rate": 0
},
"filingCalculatedTax": 0,
"filingExempt": 0,
"filingNonTaxable": 0,
"filingRecoverableAmount": 0,
"filingTaxable": 0,
"filingUnrecoverableAmount": 0
},
"imposition": {
"impositionId": "string",
"jurisdictionId": "string",
"userDefined": true,
"value": "string"
},
"impositionType": {
"impositionTypeId": "string",
"userDefined": true,
"value": "string",
"withholdingType": "string"
},
"includedTax": 0,
"inclusionRuleId": {
"salesTaxHolidayIndicator": true,
"userDefined": true,
"value": "string"
},
"taxInclusion": [
{
"direction": "PULL",
"inclusionRuleId": {
"salesTaxHolidayIndicator": true,
"userDefined": true,
"value": "string"
},
"jurisdiction": {
"effectiveDate": "2025-01-30",
"expirationDate": "2025-01-30",
"externalJurisdictionCode": "string",
"jurisdictionId": "string",
"jurisdictionType": "APO",
"value": "string"
},
"imposition": {
"impositionId": "string",
"jurisdictionId": "string",
"userDefined": true,
"value": "string"
},
"impositionType": {
"impositionTypeId": "string",
"userDefined": true,
"value": "string",
"withholdingType": "string"
},
"includedTax": 0
}
],
"inputOutputType": "INPUT",
"invoiceTextCodes": [
0
],
"invoiceTexts": [
{
"code": "string",
"invoiceTextRuleId": "string",
"text": "string",
"userDefined": true
}
],
"isService": true,
"jurisdiction": {
"effectiveDate": "2025-01-30",
"expirationDate": "2025-01-30",
"externalJurisdictionCode": "string",
"jurisdictionId": "string",
"jurisdictionType": "APO",
"value": "string"
},
"markUpRate": 0,
"maxTaxIndicator": true,
"maxTaxRuleId": {
"salesTaxHolidayIndicator": true,
"userDefined": true,
"value": "string"
},
"nominalRate": 0,
"nonTaxable": 0,
"nonTaxableMeasure": {
"unitOfMeasure": "string",
"value": 0
},
"notRegisteredIndicator": true,
"originalTax": 0,
"ownerRegistrationId": "string",
"partialExemptRecoverablePercent": 0,
"postCalculationEvaluationRuleId": {
"salesTaxHolidayIndicator": true,
"userDefined": true,
"value": "string"
},
"rateClassification": "string",
"reasonCode": "string",
"recipientRegistrationId": "string",
"recoverableAmount": 0,
"recoverablePercent": 0,
"recoverableRuleId": {
"salesTaxHolidayIndicator": true,
"userDefined": true,
"value": "string"
},
"reportingBasis": 0,
"reportingBasisRuleId": {
"salesTaxHolidayIndicator": true,
"userDefined": true,
"value": "string"
},
"sellerRegistrationId": "string",
"situs": "ADMINISTRATIVE_DESTINATION",
"summaryInvoiceText": "string",
"taxApportionmentRate": 0,
"taxApportionmentRuleId": {
"salesTaxHolidayIndicator": true,
"userDefined": true,
"value": "string"
},
"taxCode": "string",
"taxCollectedFromParty": "SELLER",
"taxRateAdjustmentRuleId": {
"salesTaxHolidayIndicator": true,
"userDefined": true,
"value": "string"
},
"taxResult": "TAXABLE",
"taxStructure": "BRACKET",
"taxType": "SALES",
"taxable": 0,
"taxableMeasure": {
"unitOfMeasure": "string",
"value": 0
},
"telecomUnitConversionRuleId": {
"salesTaxHolidayIndicator": true,
"userDefined": true,
"value": "string"
},
"unrecoverableAmount": 0,
"vertexTaxCode": "string"
}
],
"titleTransfer": "ORIGIN",
"totalTax": 0,
"transactionType": "SALE",
"unitPrice": 0,
"usage": "string",
"usageClass": "string",
"vendorSKU": "string",
"volume": {
"unitOfMeasure": "string",
"value": 0
},
"weight": {
"unitOfMeasure": "string",
"value": 0
}
}
],
"locationCode": "string",
"nonTaxableOverrides": [
{
"amount": 0,
"impositionType": {
"impositionTypeId": "string",
"userDefined": true,
"value": "string",
"withholdingType": "string"
},
"jurisdictionType": "APO",
"reasonCode": "string"
}
],
"orderType": "string",
"originalCurrency": {
"isoCurrencyCodeAlpha": "string",
"isoCurrencyCodeNum": 0,
"isoCurrencyName": "string"
},
"paymentDate": "2025-01-30",
"postToJournal": true,
"postingDate": "2025-01-30",
"proratePercentage": 0,
"rateOverrides": [
{
"impositionType": {
"impositionTypeId": "string",
"userDefined": true,
"value": "string",
"withholdingType": "string"
},
"jurisdictionType": "APO",
"rate": 0
}
],
"returnAssistedParametersIndicator": true,
"returnGeneratedLineItemsIndicator": true,
"roundAtLineLevel": true,
"saleMessageType": "QUOTATION",
"seller": {
"administrativeOrigin": {
"city": "string",
"country": "string",
"currencyConversion": {
"currency": {
"isoCurrencyCodeAlpha": "string",
"isoCurrencyCodeNum": 0,
"isoCurrencyName": "string"
},
"rate": 0
},
"externalJurisdictionCode": "string",
"latitude": "string",
"locationCode": "string",
"locationCustomsStatus": "FREE_CIRCULATION",
"longitude": "string",
"mainDivision": "string",
"postalCode": "string",
"streetAddress1": "string",
"streetAddress2": "string",
"subDivision": "string",
"taxAreaId": "string"
},
"company": "string",
"department": "string",
"dispatcher": {
"dispatcherCode": {
"classCode": "string",
"value": "string"
},
"taxRegistrations": [
{
"hasPhysicalPresenceIndicator": true,
"impositionType": {
"impositionTypeId": "string",
"userDefined": true,
"value": "string",
"withholdingType": "string"
},
"isoCountryCode": "string",
"jurisdictionId": "string",
"mainDivision": "string",
"nexusOverrides": [
{
"city": true,
"country": true,
"district": true,
"locationRole": "ADMINISTRATIVE_DESTINATION",
"mainDivision": true,
"subDivision": true
}
],
"physicalLocations": [
{
"city": "string",
"country": "string",
"mainDivision": "string",
"postalCode": "string",
"streetAddress1": "string",
"streetAddress2": "string",
"subDivision": "string",
"taxAreaId": "string"
}
],
"taxRegistrationNumber": "string",
"filingCurrency": {
"isoCurrencyCodeAlpha": "string",
"isoCurrencyCodeNum": 0,
"isoCurrencyName": "string"
},
"taxRegistrationType": "VAT Registration"
}
]
},
"division": "string",
"nexusIndicator": true,
"nexusReasonCode": "string",
"physicalOrigin": {
"city": "string",
"country": "string",
"currencyConversion": {
"currency": {
"isoCurrencyCodeAlpha": "string",
"isoCurrencyCodeNum": 0,
"isoCurrencyName": "string"
},
"rate": 0
},
"externalJurisdictionCode": "string",
"latitude": "string",
"locationCode": "string",
"locationCustomsStatus": "FREE_CIRCULATION",
"longitude": "string",
"mainDivision": "string",
"postalCode": "string",
"streetAddress1": "string",
"streetAddress2": "string",
"subDivision": "string",
"taxAreaId": "string"
},
"taxRegistrations": [
{
"hasPhysicalPresenceIndicator": true,
"impositionType": {
"impositionTypeId": "string",
"userDefined": true,
"value": "string",
"withholdingType": "string"
},
"isoCountryCode": "string",
"jurisdictionId": "string",
"mainDivision": "string",
"nexusOverrides": [
{
"city": true,
"country": true,
"district": true,
"locationRole": "ADMINISTRATIVE_DESTINATION",
"mainDivision": true,
"subDivision": true
}
],
"physicalLocations": [
{
"city": "string",
"country": "string",
"mainDivision": "string",
"postalCode": "string",
"streetAddress1": "string",
"streetAddress2": "string",
"subDivision": "string",
"taxAreaId": "string"
}
],
"taxRegistrationNumber": "string",
"filingCurrency": {
"isoCurrencyCodeAlpha": "string",
"isoCurrencyCodeNum": 0,
"isoCurrencyName": "string"
},
"taxRegistrationType": "VAT Registration"
}
],
"utilityProvider": "REGULATED_TAXPAYER"
},
"simplificationCode": "CONSIGNMENT",
"situsOverride": {
"taxingLocation": "ADMINISTRATIVE_DESTINATION"
},
"subTotal": 0,
"taxOverride": {
"overrideReasonCode": "string",
"overrideType": "TAXABLE"
},
"taxPointDate": "2025-01-30",
"total": 0,
"totalTax": 0,
"transactionId": "string",
"transactionType": "SALE"
},
"meta": {
"app": "string",
"timeElapsed(ms)": 0,
"timeReceived": "2025-01-30T16:44:09.191Z",
"timeElapsedDetails": [
{
"key": "string",
"value": "string"
}
]
}
}
Updated 23 days ago