Sign in
Sales Order Tax Line Item

Update a specific tax line item for a sales order

put/api/sales-orders/{salesOrderId}/tax-line-items/{lineItemId}

Path parameters

salesOrderIdstring required
lineItemIdstring required

Request body

descriptionstring nullable

Verbose description for this entity.

taxCodeIdstring nullable

Tax code key identifier. Please reference /api/tax-rates endpoint. If FulcrumProduct.PublicApi.Dto.SalesOrder.TaxLineItem.TaxLineItemUpdateDto.AvalaraOptions is provided, FulcrumProduct.PublicApi.Dto.SalesOrder.TaxLineItem.TaxLineItemUpdateDto.TaxCodeId will be ignored.

taxRatenumber double nullable

Tax rate to use for this entity. If a FulcrumProduct.PublicApi.Dto.SalesOrder.TaxLineItem.TaxLineItemUpdateDto.TaxCodeId is provided, the provided FulcrumProduct.PublicApi.Dto.SalesOrder.TaxLineItem.TaxLineItemUpdateDto.TaxRate will supercede the defined tax rate.

externalReferencesobject nullable

Arbitrary key-value-pair like data that can be used to later on search for this line item.

Response

Tax line item

idstring required

Unique id associated to this entity.

descriptionstring nullable

Verbose description for this entity.

taxCodeIdstring nullable

Tax code key identifier. Please reference /api/tax-rates endpoint.

taxRatenumber double nullable

Tax code to use for this entity. If a FulcrumProduct.PublicApi.Dto.SalesOrder.TaxLineItem.TaxLineItemDto.TaxCodeId is provided, the provided FulcrumProduct.PublicApi.Dto.SalesOrder.TaxLineItem.TaxLineItemDto.TaxRate will supercede the defined tax rate.

externalReferencesobject nullable

Arbitrary key-value-pair like data that can be used to later on search for this line item.

pricenumber double nullable

Tax amount applied at this rate across the entire sales order.

Changes