Skip to content

Create an invoice line

Finance module

POST/invoice-linesinvoiceLines.create

A line of an invoice. Creates an invoice line. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

  • Requires the capability finance.invoice.write.
  • OAuth scopes: finance.
  • Send an Idempotency-Key header. A replay with the same key returns the original response.
  • Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.

Request body: InvoiceLineCreate

invoiceLines.create: InvoiceLineCreate
FieldTypeRequiredDescription
invoice_idstring (uuid)YesIdentifier of the invoice.
descriptionstringYesLine description.Constraints: length 1 to 300
quantitynumber | nullNoQuantity.
unit_price_minorinteger (int64) | nullNoUnit price. Integer minor units of the resource currency; null means unpriced, never zero.
line_numberintegerYesLine number within the invoice.Constraints: range 1 to any
budget_line_idstring (uuid) | nullNoIdentifier of the budget line.
tax_rate_idstring (uuid) | nullNoIdentifier of the tax rate.
uridUridAtAnyGrain | nullNo
{
  "invoice_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "description": "Stage deck rental",
  "quantity": 24,
  "unit_price_minor": 4500,
  "line_number": 1,
  "budget_line_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "tax_rate_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Response 201: InvoiceLine

invoiceLines.create: InvoiceLine
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the invoice line.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
invoice_idstring (uuid)YesIdentifier of the invoice.
descriptionstringYesLine description.Constraints: length 1 to 300
quantitynumber | nullYesQuantity.
unit_price_minorinteger (int64) | nullYesUnit price. Integer minor units of the resource currency; null means unpriced, never zero.
line_numberintegerYesLine number within the invoice.Constraints: range 1 to any
budget_line_idstring (uuid) | nullYesIdentifier of the budget line.
tax_rate_idstring (uuid) | nullYesIdentifier of the tax rate.
uridUridAtAnyGrain | nullYes
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "invoice_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "description": "Stage deck rental",
  "quantity": 24,
  "unit_price_minor": 4500,
  "line_number": 1,
  "budget_line_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "tax_rate_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "urid": "4000.01"
}

Code samples

curl -X POST "$XOS_BASE_URL/invoice-lines" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"invoice_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","description":"Stage deck rental","quantity":24,"unit_price_minor":4500,"line_number":1,"budget_line_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","tax_rate_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'
const { data } = await xos.invoiceLines.create({
    "invoice_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "description": "Stage deck rental",
    "quantity": 24,
    "unit_price_minor": 4500,
    "line_number": 1,
    "budget_line_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "tax_rate_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
  });
response = xos.invoice_lines.create({"invoice_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "description": "Stage deck rental", "quantity": 24, "unit_price_minor": 4500, "line_number": 1, "budget_line_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "tax_rate_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"})
xos invoice-lines create --data '{"invoice_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","description":"Stage deck rental","quantity":24,"unit_price_minor":4500,"line_number":1,"budget_line_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","tax_rate_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'