Order line object

Attributes

AttributeTypeDefaultDescription
namestringLine item name
descriptionstringnullLine description
codestringnullInternal/product code
quantitynumberQuantity
amountnumberUnit price
exemptbooleanWhether line is tax-exempt
taxnumberLine tax total (auto-calculated)
tax_percentnumberLine effective tax rate (auto-calculated)
totalnumberLine total (auto-calculated)
unit_codestringMeasurement / unit code
tax_settingsobjectCountry-specific line tax settings (e.g. BR br_cfop, br_ncm)
taxesarray of objectsDetailed taxes for this line
createddatetimeCreation timestamp (read-only)
updateddatetimeLast update timestamp (read-only)

Tax settings

AttributeTypeDefaultDescription
codestringnullTax code (icms, ipi, pis, cofins, etc)
namestringnullTax display name
ratenumbernullTax rate (%)
basenumbernullTax base amount
amountnumbernullTax amount. If omitted, API computes from rate and base
include_in_totalbooleantrueIf true, this tax contributes to line total
tax_settingsobjectTax-specific config. Keys must start with country iso code br_, co_, cl_ or mx_

Object sample

{}