Sign in

v1

latestOpenAPI 3.1.02026-07-247328324.6 KB
Invoices

Update an invoice item

patch/sellers/{seller_id}/invoices/{invoice_id}/invoice-items/{id}

Path parameters

seller_idstring required

An object id with prefix

Example:user_0123456789ABCDEFGHIJKLMNOPq

An object id with prefix

invoice_idstring required

An object id with prefix

Example:user_0123456789ABCDEFGHIJKLMNOPq

An object id with prefix

idstring required

An object id with prefix

Example:user_0123456789ABCDEFGHIJKLMNOPq

An object id with prefix

Headers

if-matchstring date-time required

ETag value for Optimistic Concurrency Control (OCC). Should contain the last known updated_at timestamp in ISO 8601 format.

Example:2024-01-15T10:30:00Z

ETag value for Optimistic Concurrency Control (OCC). Should contain the last known updated_at timestamp in ISO 8601 format.

Request body

amountinteger

Integer amount in lowest currency denomination. See Money for details.

descriptionstring nullable

Non-empty text string

metadataobject nullable

Key-value metadata object

Example request

{
  "amount": 10000,
  "category": "unspsc:43211508",
  "metadata": {
    "key": "value"
  }
}

Response

Successful operation

amountinteger required

Integer amount in lowest currency denomination. See Money for details.

descriptionstring

Non-empty text string

metadataobject

Key-value metadata object

unspscstring required

UNSPSC (United Nations Standard Products and Services Code) - An 8-digit code with unspsc: prefix, organized as: Segment(2) + Family(2) + Class(2) + Commodity(2)

idstring required

An object id with prefix

created_atstring date-time required

Creation date and time

created_bystring required

ID of the user that created this object

updated_atstring date-time required

Last update date and time

updated_bystring required

ID of the user that last updated this object

Example response

{
  "amount": 10000,
  "category": "unspsc:43211508",
  "metadata": {
    "key": "value"
  },
  "unspsc": "unspsc:43211508",
  "id": "user_0123456789ABCDEFGHIJKLMNOPq",
  "created_at": "2024-01-15T10:30:00Z",
  "created_by": "user_0123456789ABCDEFGHIJKLMNOPq",
  "updated_at": "2024-01-15T10:30:00Z",
  "updated_by": "user_0123456789ABCDEFGHIJKLMNOPq"
}