Create new tax transaction

Create new tax transaction for Estimates or Final Sales Invoice

Headers

x-site-context

string

required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Body

application/json

addresses

object

required

Show child attributes

addresses.shipFrom

object

required

Show child attributes

addresses.shipFrom.city

string

required

Minimum length: 3

addresses.shipFrom.country

string

required

Minimum length: 2

addresses.shipFrom.state

string

required

Minimum length: 2

addresses.shipFrom.street1

string

required

Minimum length: 3

addresses.shipFrom.zipCode

string

required

Minimum length: 3

addresses.shipTo

object

required

Show child attributes

addresses.shipTo.city

string

required

Minimum length: 3

addresses.shipTo.country

string

required

Minimum length: 2

addresses.shipTo.state

string

required

Minimum length: 2

addresses.shipTo.street1

string

required

Minimum length: 3

addresses.shipTo.zipCode

string

required

Minimum length: 3

lineItems

object[]

required

Show child attributes

lineItems.price

number

required

Required range: x > 0

lineItems.quantity

number

required

Required range: x > 1Must be a multiple of 1

lineItems.taxCode

string

required

Minimum length: 3

lineItems.title

string

required

Minimum length: 3

lineItems.lineItem

integer

Required range: x > 1

lineItems.sku

string

Minimum length: 3

type

enum<string>

required

Available options:

SalesInvoice,

SalesOrder

Response

200 - application/json

code

string

customerCode

string

date

string

lines

object[]

Show child attributes

lines.description

string

lines.id

number

lines.isItemTaxable

boolean

lines.lineAmount

number

lines.lineNumber

string

lines.quantity

number

lines.tax

number

lines.taxableAmount

number

lines.taxCalculated

number

lines.taxCode

string

status

string

totalAmount

number

totalDiscount

number

totalExempt

number

totalTax

number

totalTaxable

number

totalTaxCalculated

number

type

string