v2

latestOpenAPI 3.0.42026-08-084694591.6 MB
Invoice Shipping Charge Line Item

Get the shipping charge line item for an invoice

get/api/invoices/{invoiceId}/shipping-charge-line-item

Path parameters

invoiceIdstring required

Response

Shipping charge line item

idstring required

Unique id associated to this entity.

namestring required

The name of the shipping charge line.

descriptionstring nullable

The description of the shipping charge line.

amountnumber double required

The amount of the charge.

isTaxableboolean nullable

Dictate if this line item is taxable.

overrideTaxRateboolean nullable

Dictate if the tax rate is overridden.

taxCodeIdstring nullable

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

taxRatenumber double nullable

Tax rate to use for this entity. If a FulcrumProduct.PublicApi.Dto.Invoice.ShippingChargeLineItem.ShippingChargeLineItemDto.TaxCodeId is provided, the provided FulcrumProduct.PublicApi.Dto.Invoice.ShippingChargeLineItem.ShippingChargeLineItemDto.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.

salesOrderLineItemIdstring nullable

Related sales order line item id.

numberinteger

Line number