GET/api/partner/users/:userId/invoices

Their invoices

Lists one of your users' invoices created between two dates, split into income (invoices they sent) and expenses (invoices they pay). Both lists are always present, empty when there are none.

Path parameters

Field Type Required
userId string yes

Query parameters

Field Type Required
startDate string yes
endDate string yes

The date range

The range is on createdAt, and both ends are included. A date-only endDate means midnight UTC at the start of that day, so it leaves that day out: send the next day, or a time. startDate and endDate each take YYYY-MM-DD, RFC 3339, or YYYY-MM-DDTHH:MM:SS.

Invoices come newest first, all at once, with no paging. What each field means is on Invoices and payment states.

200 OK
{
  "success": true,
  "message": "Invoices retrieved",
  "result": {
    "income": [
      {
        "id": "3b9d…",
        "number": "1001",
        "amount": 250,
        "currency": "USD",
        "status": "paid"
      }
    ],
    "expenses": []
  }
}