Sign in

v1

latestOpenAPI 3.1.02026-07-247328324.6 KB
Invoices

Create an invoice item

post/sellers/{seller_id}/invoices/{invoice_id}/invoice-items

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

Headers

IdempotencyKeystring

A unique key per operation, could be V4 UUID or other high‑entropy random string. Keys can be up to 255 characters. See Idempotent Requests.

Example:978771af-77de-4e24-ba39-f602502ceb78

A unique key per operation, could be V4 UUID or other high‑entropy random string. Keys can be up to 255 characters. See Idempotent Requests.

Request body

amountinteger required

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

descriptionstring

Non-empty text string

metadataobject

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"
}