Invoices

List all invoices

Retrieve a list of invoices for the authenticated team.

get/invoices

Request

  • Base URL
    https://api.midday.ai
  • URL
    https://api.midday.ai/invoices
  • Auth
    • OAuth 2
      Authorization code: https://app.midday.ai/oauth/authorize
      Token URL: https://api.midday.ai/oauth/token
    • or HTTP bearer

Query parameters

cursorstring nullable

A cursor for pagination, representing the last item from the previous page.

Example:25
sortstring[] nullable

Sort as [column, direction]. Columns: created_at, due_date, issue_date, amount, status, customer, invoice_number. Direction: asc or desc.

[
  "created_at",
  "desc"
]
pageSizenumber

Number of invoices to return per page (1-100).

Example:25
qstring nullable

Search query string to filter invoices by text.

Example:Acme
startstring nullable

Start date (inclusive) for filtering invoices, in ISO 8601 format.

Example:2024-01-01
endstring nullable

End date (inclusive) for filtering invoices, in ISO 8601 format.

Example:2024-01-31
statusesstring[] nullable

List of invoice statuses to filter by (e.g., 'paid', 'unpaid', 'overdue').

[
  "paid",
  "unpaid"
]
customersstring[] nullable

List of customer IDs to filter invoices.

[
  "customer-uuid-1",
  "customer-uuid-2"
]
idsstring[] nullable

List of invoice IDs to filter by.

[
  "invoice-uuid-1",
  "invoice-uuid-2"
]
recurringIdsstring[] nullable

List of recurring series IDs to filter invoices by (shows all invoices from these series).

[
  "recurring-uuid-1",
  "recurring-uuid-2"
]
recurringboolean nullable

Filter by recurring status. true = only recurring invoices, false = only non-recurring invoices.

Example:true

Response

A list of invoices for the authenticated team.

Example response

{
  "meta": {
    "cursor": "25",
    "hasNextPage": true
  },
  "data": [
    {
      "id": "b3b7e6e2-8c2a-4e2a-9b1a-2e4b5c6d7f8a",
      "status": "paid",
      "dueDate": "2024-06-30T23:59:59.000Z",
      "issueDate": "2024-06-01T00:00:00.000Z",
      "invoiceNumber": "INV-2024-001",
      "amount": 1500.75,
      "currency": "USD",
      "customer": {
        "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "name": "Acme Corporation",
        "website": "https://acme.com",
        "email": "info@acme.com"
      },
      "paidAt": "2024-06-15T12:00:00.000Z",
      "reminderSentAt": "2024-06-10T09:00:00.000Z",
      "note": "Thank you for your business.",
      "vat": 120,
      "tax": 80,
      "discount": 50,
      "subtotal": 1400,
      "viewedAt": "2024-06-05T14:30:00.000Z",
      "customerName": "Acme Corporation",
      "sentTo": "billing@acme.com",
      "sentAt": "2024-06-02T08:00:00.000Z",
      "createdAt": "2024-06-01T07:00:00.000Z",
      "updatedAt": "2024-06-15T10:00:00.000Z",
      "pdfUrl": "https://app.midday.ai/api/download/invoice?token=eef58951-1682-4062-b010-425866032390",
      "previewUrl": "https://app.midday.ai/i/eef58951-1682-4062-b010-425866032390"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.