Sign in
Invoice Line Item

Get a specific line item for an invoice of generic type

get/api/invoices/{invoiceId}/line-items/{lineItemId}

Path parameters

invoiceIdstring required
lineItemIdstring required

Response

Line item

idstring required

Unique id associated to this entity.

type'part' | 'additionalFee' | 'shipping' | 'discount' | 'tax' | 'deposit' | 'depositAdjustment' | 'refund' | 'blanket' | 'progressBilling' | 'progressBillingAdjustment' required

Invoice line item type

quantitynumber double required

The line item quantity

pricenumber double required

The line item price.

discountedPricenumber double required

The discounted line item price.

subtotalnumber double required

The subtotal for this line item which generally represents quantity * price.

discountedSubtotalnumber double required

The discounted subtotal for this line item which generally represents quantity * discountedPrice.

namestring nullable

Verbose name for this entity.

descriptionstring nullable

Line item description.

accountingCodeIdstring nullable

Accounting code key identifier. Please reference /api/accounting-codes endpoint.

taxCodeIdstring nullable

The key identifier for the tax code for the line item.

salesOrderLineItemIdstring nullable

Related sales order line item id.

externalReferencesobject nullable

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

isTaxableboolean nullable

Dictate if this line item is taxable.

numberinteger

Line number

Changes

Changed in 1 of the 23 revisions of this API.4

  • 016c1fd45a3f4See the full diff
    • ●

      added the new progressBilling enum value to the response property for the response status (media type: application/json)

      response-property-enum-value-added

    • ●

      added the new progressBilling enum value to the response property for the response status (media type: application/problem+json)

      response-property-enum-value-added

    • ●

      added the new progressBillingAdjustment enum value to the response property for the response status (media type: application/json)

      response-property-enum-value-added

    • ●

      added the new progressBillingAdjustment enum value to the response property for the response status (media type: application/problem+json)

      response-property-enum-value-added