v2

latestOpenAPI 3.1.12026-08-078549932.4 MB
Invoices

post/Invoices/{id}/items

Path parameters

idstring required

Request body

idstring nullable

Existing line-item id, sent on update so the line is reconciled in place (id + any linked inventory transactions preserved) instead of being dropped and recreated. Null/empty for a brand-new line.

serviceCatalogItemIdstring nullable
retailItemIdstring nullable
inventoryItemIdstring nullable
billableItemIdstring nullable

Source BillableItem ("Charge") when this line was added from the charge catalog.

inventoryTransactionIdstring nullable
codestring nullable
descriptionstring
isTaxableboolean
vatCategorystring nullable
providerIdstring nullable
notesstring nullable
groupCodeIdstring nullable
groupCodeNamestring nullable

Response

OK

idstring
invoiceIdstring
serviceCatalogItemIdstring nullable
retailItemIdstring nullable
inventoryItemIdstring nullable
billableItemIdstring nullable

Source BillableItem ("Charge") when this line was added from the charge catalog.

billableItemNamestring nullable

Display name of the source BillableItem (snapshot, response-only).

isFulfilledboolean

True when a BillableItem charge line has been fulfilled — its inventory components dispensed (derived from linked transactions, response-only).

inventoryTransactionIdstring nullable
codestring nullable
descriptionstring
appliedDiscountPolicyIdstring nullable
appliedDiscountCodestring nullable
isTaxableboolean
vatCategorystring nullable
providerIdstring nullable
notesstring nullable
groupCodeIdstring nullable

Kit this line came from, when emitted via GroupCode expansion.

groupCodeNamestring nullable

Snapshot of the kit's display name at time of add.