Skip to main content
Invoices let a merchant’s systems reconcile what is owed. Each invoice bundles a set of orders and exposes the money involved as currency/amount pairs (e.g. [["USD", "20.00"]]). The list endpoint returns invoice metadata only (for building a grouped overview), while the retrieve endpoint additionally returns the orders on the invoice.

​
Fields

​
number: integer

Attributes: Unique The invoice identifier, shown to merchants as Invoice #. Use it to retrieve a single invoice.

​
status: enum<string>

Current status of the invoice. Values:
  • PENDING_PAYMENT — Pending Payment
  • PAYMENT_SCHEDULED — Payment Scheduled
  • COLLECTED_BY_DRIVER — Collected By Driver
  • IN_PROGRESS — In Progress
  • PAID — Paid
  • AWAITING_RETURN — Awaiting Return
  • FAILED — Failed
  • CANCELLED — Cancelled

​
status_display: string

  • Attributes: List endpoint only
Human-readable label for status (e.g. "Pending Payment").

​
issued_at: string

ISO 8601 datetime when the invoice was issued.

​
order_count: integer

  • Attributes: List endpoint only
Number of orders on the invoice.

​
cod: array

Attributes: Read-only Total cash-on-delivery across the invoice’s orders, as currency/amount pairs.

​
delivery_fee: array

Attributes: Read-only Total delivery fees across the invoice’s orders, as currency/amount pairs.

​
net_due_to_merchant: array

Attributes: Read-only Net amount owed to the merchant (COD minus delivery fees), as currency/amount pairs.

​
orders: array<object>

  • Attributes: Retrieve endpoint only
The orders billed on this invoice. Each entry is a financial summary:
  • order_id: string — the Order identifier
  • reference_id: string — the merchant’s reference for the order
  • workflow: string — STANDARD or RETURN
  • delivery_state: string — the order’s delivery_state
  • payment_state: string — the order’s payment_state
  • cod: array — amount to collect from the customer, as currency/amount pairs
  • delivery_fee: array — the courier’s delivery charge, as currency/amount pairs

​
Example

List item (GET /invoices/):
Single invoice with orders (GET /invoices/{number}/):
The list endpoint (GET /invoices/) returns results wrapped in a pagination envelope: { "count", "next", "previous", "results": [ ... ] }. It also accepts year and month query filters.