Sign in
Invoice Part Line Item

Partially update a specific part line item for an invoice

patch/api/invoices/{invoiceId}/part-line-items/{lineItemId}

Path parameters

invoiceIdstring required
lineItemIdstring required

Response

Part line item

idstring required

Unique id associated to this entity.

namestring required

The line item name.

quantitynumber double required

The line item quantity.

pricenumber double required

The line item price.

discountedPricenumber double required

The discounted line item price.

overrideTaxRateboolean nullable

Dictate if the tax rate is overridden.

isTaxableboolean required

Dictate if this line item is taxable.

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.PartLineItem.PartLineItemDto.TaxCodeId is provided, the provided FulcrumProduct.PublicApi.Dto.Invoice.PartLineItem.PartLineItemDto.TaxRate will supercede the defined tax rate.

itemIdstring required

Item id associated with this line item.

descriptionstring nullable

The part line item description. Defaults to the item's description if none specified.

externalReferencesobject nullable

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

accountingCodeIdstring nullable

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

salesOrderLineItemIdstring nullable

Related sales order line item id.

subTotalnumber double required

Total line item cost, including applicable discounts

preDiscountSubTotalnumber double required

Total line item cost, before discounts

isPercentageDiscountboolean nullable

Indicates whether FulcrumProduct.PublicApi.Dto.Invoice.PartLineItem.PartLineItemDto.DiscountAmount discount is percentage based (else, it's an absolute amount).

discountAmountnumber double nullable

The amount of the discount.

customerPartNumberstring nullable

The customer's known part line item number.

customerPartDescriptionstring nullable

The customer's known part line item description.

shipmentIdsstring[]

The shipment identifiers that were invoiced.

numberinteger

Line number

Changes

Changed in 2 of the 23 revisions of this API.12

  • d743ab8b105f11See the full diff
    • ▲

      the / request property type changed from string to no type

      request-property-type-changed

    • ○

      added the new optional request property /

      new-optional-request-property

  • c002514312371See the full diff
    • ○

      added the non-success response with the status

      response-non-success-status-added