Skip to navigation
API ReferenceBilling NewInvoices

Create

Creates a new draft invoice, optionally attaching selected uninvoiced charges atomically. Omitted dates derive from completed deliveries; empty drafts and charges without completed delivery dates require explicit bounds. | authz: allowed_org_types=[provider], min_org_role=operator | (InvoiceCreateReq) -> (PydanticObjectId)

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
currency_codeenumRequired
invoice_typeenumRequired
Allowed values:
schema_versionintegerRequired
counterparty_driver_idstring or nullOptional
counterparty_off_chrt_org_data_idstring or nullOptional
counterparty_org_idstring or nullOptional
descriptionstring or nullOptional<=32768 characters
export_ref__sage__customer_idstring or nullOptional<=255 characters
export_ref__sage__department_idstring or nullOptional<=255 characters
invoice_line_item_idslist of stringsOptional
namestring or nullOptional<=255 characters
period_end_at_timestampstring or nullOptionalformat: "date-time"
period_start_at_timestampstring or nullOptionalformat: "date-time"

Response

Successful Response

Errors

422
Unprocessable Entity Error