API Reference

Represents tax calculation from the seller's perspective. Performs a calculation request based on the set property of the Sale Message Type. Valid values are Quotation, Invoice, or Distribute Tax.

post
https://developer.vertexcloud.com/api/v2/supplies

Based on the property SaleMessageType value, a tax calculation is performed and may or may not be saved for reporting and tax remittance.

Quotation call / message

A quotation request is used to estimate taxes on a proposed sale or rental by the seller. Because it is an estimate, a quotation request is subject to change until the transaction is finalized and is not stored for reporting and remittance.

Invoice call / message

An Invoice request is used to initiate tax calculation on a transaction. Use this request to calculate tax at the time of shipping, billing, or invoicing from the seller's perspective. Invoice transactions are stored and used for reporting and remittance.

Distribute Tax call / message

A Distribute tax message is used to initial a Distribute Tax Calculation. This request can be used for a tax-only adjustment (debit or credit) to reconcile a tax underpayment or overpayment. It 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 rate for the taxing jurisdictions to determine the taxable base and then redistributes the calculated taxes to each level for remittance. Distribute tax transactions are stored and may affect revenue and be used in reporting and remittance.

ARBilling Sync call / message

The Accounts Receivable Billing Synchronization Request message. This request initiates the reconciliation of Accounts Receivable transactions between Vertex O Series and your host system.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

body

string
length between 0 and 40

A string to represent the accumulation customer identity.

string
length between 0 and 40

A string to represent the accumulation invoice identity.

string
length between 0 and 20

Indicates the billing documents that specify different business transactions that are involved in billing activities. Examples of billing documents include invoice, credit or debit memo, or cancellation document. This field is at the transaction level.

string
length between 1 and 40

The Buyer Condition is mandatory information for calculating taxes in Brazil. It represents the type of tax behavior of the entity when buying a good or service.

string
length between 1 and 40

The buyer CNAE (“National Classification of Economic Activities“) code is optional information for the O Series. It’s more granular information when compared to the Buyer's condition.

citationOverrides
array of objects
citationOverrides
companyCodeCurrency
object

The monetary unit to be used in calculations as defined by ISO 4217 standard.

currency
object

The monetary unit to be used in calculations as defined by ISO 4217 standard.

currencyConversionFactors
array of objects
currencyConversionFactors
customer
object
string | null
enum
discount
object

Details on the discount. To pass discount information, pass either DiscountPercent or DiscountAmount, but not both.

date
string
length between 0 and 50

The document number in the host application that references the event.

string
length between 0 and 60

Supports reporting and the document sequence identifier used by your ERP system. Some countries require that documents follow a unique sequential sequence number, depending on the registration type and the type of invoice. Use this field for audit purposes to track the sequence of your documents. This field is used in European Union (EU) countries.

string
length between 0 and 20

Indicates the type of business transaction to be posted. This field is at the transaction level.

exemptOverrides
array of objects
exemptOverrides
string
length between 0 and 40

The unique identifier of a telecom franchise area used to trigger the calculation of the franchise area fee. This value is configured on the imposition that defines the franchise area in O Series.

impositionInclusions
array of objects
impositionInclusions
boolean
lineItems
array of objects

The header for a component of a transaction. A line item is required for each component of the transaction. Each transaction requires at least one line item. Note that a line item can contain child line items.

lineItems
string
length between 0 and 20

A value that can be used for tax return filing in jurisdictions that require taxes to be filed for individual retail locations.

nonTaxableOverrides
array of objects
nonTaxableOverrides
string
length between 1 and 40

NatureOfFiscalOperation is mandatory information to determine what type of transaction we are running in the ERP.

string
length between 0 and 20

The key that identifies the purpose of the order. This field is on the transaction level.

originalCurrency
object

The monetary unit to be used in calculations as defined by ISO 4217 standard.

string
length between 0 and 40

Identifies the transaction that has already been processed, that the current request refers to. Required for generation of credit notes reflecting negative INVOICE requests.

date

The date on which the purchaser paid for the product. If the purchaser pays for the product but physically receives it at a later date, Vertex O Series uses this field for returns and reporting for your tax type. This field is also used in cash accounting.

date

The payment due date - reflected on the generated documents.

boolean

Indicates whether the results of the transaction are posted to the Tax Journal. Defaults to true. This field is not applicable to Invoice and Quotation tax calculation.

date
double
-100000000 to 100000000

Percentage passed from the billing system to calculate a remainder of an assessed tax or fee.

rateOverrides
array of objects
rateOverrides
taxDeferredOverrides
array of objects
taxDeferredOverrides
boolean

Indicates whether the response message should contain an additional structure that shows the elements and attributes that were changed by Tax Assist. This is for informational purposes only and contains no tax results.

boolean

If this indicator is set, the response message returns child line items that were generated by the Tax Assist allocation feature. Otherwise, these line items are deleted after the transaction is posted to the Tax Journal and only the primary line item, which contains the combined tax results of the child line items, is passed back to the host system.

boolean

Indicates whether the response message should contain details of what composed the elapsed time. The default value is false.

boolean

The roundAtLineLevel attribute enables you to apply line-item level or invoice-level rounding to tax calculations. Set this attribute to true to set up line-item level rounding. With line-item level rounding, the calculation engine rounds amounts at the line-item level and then sums those amounts to calculate an invoice total. This method is useful for invoices that include line items with different taxing jurisdictions. The default value for this attribute is false. In this case, O Series applies an invoice-level rounding, where the calculation engine compares the sum of rounded line item-level totals to the rounded invoice-level total. When there is a difference between these totals, the calculation engine compares differences between rounded and unrounded amounts at each jurisdiction level and distributes the difference to the jurisdiction that results in the smallest total rounding difference amount. For more information about invoice-level rounding, contact Vertex Customer Support to obtain the Rounding Guide.

string
enum
Allowed:
seller
object
string
length between 1 and 40

The Seller Condition is mandatory information for calculating taxes in Brazil. It represents the type of tax behavior of the entity when selling a good or service.

string
length between 1 and 40

The Seller CNAE (“National Classification of Economic Activities“) code is optional information for the O Series. It’s more granular information when compared to the Seller's condition.

string | null
enum
Allowed:
situsOverride
object

Details about the situs determination overrides.

taxOverride
object

Details on the tax override.

date

The date that drives the timing of when the VAT liability arises. In some countries, if the Tax Point Date (also called the Time of Supply) is different from the invoice date, this field is shown separately on an invoice. Use this field if you have reporting compliance in Spain, Poland, and/or Hungary.

string
length between 0 and 40

An identifier that further defines the document and corresponds to the transaction stored in the host system. The Transaction ID is used for synchronization services, but is not used for reporting purposes.

string
enum
required
Allowed:
applicationData
object
Responses

Updated 11 months ago

Language
Credentials
LoadingLoading…
Response
Choose an example:
application/json

Updated 11 months ago