latestOpenAPI 3.0.12026-08-192092911.2 MB

916e669fc527

Invoices

Update an invoice line item

Update the details of a single line item (required scope finance:write)

patch/v1/finance/invoices/{invoiceId}/lineItems/{lineItemId}

Path parameters

invoiceIdinteger required

The invoice id

lineItemIdinteger required

The line item id

Headers

Customer-Idinteger required

The customer identifier

Request body

quantitynumber double

The quantity of the invoice line item<br/><br/>Optional: Omit to retain current value

descriptionstring

Description of the invoice line item<br/><br/>Optional: Omit to retain current value

taxIdinteger nullable

Tax identifier (must exist and not be deleted for customer). Nullable<br/><br/>Optional: Omit to retain current value or provide null to unset

unitCostnumber double nullable

Unit cost (nullable, non-negative)<br/><br/>Optional: Omit to retain current value or provide null to unset

unitSellingPricenumber double

Unit selling price (non-negative)<br/><br/>Optional: Omit to retain current value

nominalCodeIdinteger nullable

Nominal code identifier (must exist and not be deleted for customer)<br/><br/>Optional: Omit to retain current value or provide null to unset

departmentCodeIdinteger nullable

Department code identifier (must exist and not be deleted for customer)<br/><br/>Optional: Omit to retain current value or provide null to unset

Example request

{
  "quantity": 2.5,
  "description": "Replacement filter cartridge",
  "taxId": 1001,
  "unitCost": 5.5,
  "unitSellingPrice": 10.99,
  "nominalCodeId": 50001,
  "departmentCodeId": 20002
}

Response

No Content