201Successful Response
Schema: SuccessEnvelope_InvoiceResponse_
successbooleanmessagestringcodestringdataInvoiceResponse
/api/v1/invoicesCreate a new invoice for a customer. Optionally include 'recurring' config to also create a recurring template.
Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.
Schema: InvoiceCreateRequest
customer_idstringrequiredUUID of the customer to invoice.
currencystringCurrency for the invoice (USD, CAD, AUD, EUR, or GBP). Defaults to business default.
line_itemsarray · LineItemRequestrequiredLineItemRequestLine items (at least one required). Can be variant-linked or custom.
variant_idstringUUID of product variant. Omit or use 'custom' for manual line items.
quantityintegerQuantity ordered. Defaults to 1 for custom items.
descriptionstringLine item description (required for custom items).
unit_priceintegerPrice per unit in cents. Required for custom items. For variant-linked items this is an OPTIONAL override - if omitted, the current catalog price is used; if provided, the catalog price is ignored for this invoice. The override is snapshotted onto the invoice line item.
amountintegerTotal amount in cents. Deprecated for custom items - use unit_price instead. For backward compatibility, if unit_price is not set, amount is treated as unit_price.
location_idstringOptional warehouse UUID to deduct this line from. Overrides the invoice's fulfillment_location_id and the business default. Ignored for custom (non-variant) lines.
due_datestringrequiredPayment due date in YYYY-MM-DD format.
issue_datestringOptional 'Date of issue' to display on the invoice in YYYY-MM-DD format. Use this to backdate an invoice. When set, it replaces the system-generated issue date on the invoice PDF and receipt.
descriptionstringOptional invoice description or notes.
fulfillment_location_idstringDefault warehouse UUID for inventory deductions when the invoice is delivered. Per-line location_id overrides this.
recurringInvoiceRecurringConfigIf provided, creates a recurring template for this invoice.
Schema: SuccessEnvelope_InvoiceResponse_
successbooleanmessagestringcodestringdataInvoiceResponseSchema: HTTPValidationError
detailarray · ValidationErrorValidationErrorlocarray · string | integerrequiredmsgstringrequiredtypestringrequiredinputobjectctxobject