Skip to main content
inputCreateCalculateSalesEntityRequestInput

Fields

companyId
ID!
required

The unique identifier of the company for the sales entity.

vatId
String!
required

Vat id of the seller.

customerId
ID!
required

The unique identifier of the customer for whom the sales entity is being calculated.

shippingMethodId
ID

The shipping method ID for shipping cost calculation and tax determination.

shopId
ID

The shop ID for shop-specific price calculation.

The billing address information for tax calculation.

The shipment address information for tax calculation.

The list of sales entity line items to be calculated. Each line item carries its full current state.

currencyIso
String!
required

The ISO code of the currency for price calculation (e.g., EUR, USD).

currencyFactor
Decimal!
required

The currency conversion factor. Must be greater than 0.

departureCountryIso
String!
required

The ISO code of the departure country for tax calculation.

departureCountryStateCode
String

The departure country state/region code for state-level tax calculation (e.g., US states like CA, NY).

extraWeight
Decimal

Additional weight in kg to add to the order for shipping cost calculation.

specialTaxTreatment

The tax special treatment mode for the sales entity (e.g., ReverseCharge, ExemptFromVat).

taxSetting
required

The tax setting for the sales entity.

taxReference

The tax reference of the sales entity. This setting controls which data is used during tax calculation.