Skip to content

graft invoices

Invoices issued against orders.

Command Does
graft invoices create Issue an invoice against an order.
graft invoices get One invoice.
graft invoices list List invoices.
graft invoices update Mark an invoice paid or void.

Issue an invoice against an order. kind is full, deposit or balance.

Endpoint: POST /api/v1/invoices

Terminal window
graft invoices create -d '{"orderId":"000000000000000000000050","kind":"deposit","dueInDays":14}'

One invoice.

Endpoint: GET /api/v1/invoices/:invoiceId · Arguments: <invoiceId>

Terminal window
graft invoices get <invoiceId>

List invoices. Cursor-paginated: pass limit (default 25, max 100) and cursor from the previous response’s meta.cursor. Filter with orderId and status (draft, open, paid, void).

Endpoint: GET /api/v1/invoices

Terminal window
graft invoices list

Add --all to fetch every page.

Mark an invoice paid or void.

Endpoint: PATCH /api/v1/invoices/:invoiceId · Arguments: <invoiceId>

Terminal window
graft invoices update <invoiceId> -d '{"status":"paid"}'