Invoices

List invoices

Returns a paginated list of invoices for the active business in the current mode, with optional status, customer, date-range, and sort filters.

get/invoices

Request

  • Base URL: https://api.swiftpayiq.com/api/v1
  • URL: https://api.swiftpayiq.com/api/v1/invoices
  • Auth: HTTP bearer

Query parameters

pageinteger

Page number (1-based).

limitinteger

Items per page (max 100).

status'DRAFT' | 'ISSUED' | 'SENT' | 'PAID' | 'PARTIALLY_PAID' | 'OVERDUE' | 'CANCELLED'

Filter by status.

customerIdstring

Filter by linked customer id.

fromstring date-time

Inclusive lower bound on createdAt (ISO-8601).

tostring date-time

Inclusive upper bound on createdAt (ISO-8601).

sortBy'createdAt' | 'updatedAt' | 'dueDate' | 'issuedAt' | 'total' | 'number'
sortDir'asc' | 'desc'

Response

Paginated invoices

Example response

{
  "items": [
    {
      "subtotal": "50000",
      "discount": "50000",
      "discountPercentage": "10.00",
      "taxAmount": "50000",
      "customerFeeAmount": "50000",
      "total": "50000",
      "amountPaid": "50000",
      "feeRate": "0.60325",
      "feeAmount": "50000",
      "customerFeeShare": "0.5000",
      "netAmount": "50000",
      "createdByType": "API_KEY",
      "items": [
        {
          "unitPrice": "50000",
          "lineTotal": "50000"
        }
      ],
      "payments": [
        {
          "provider": "ALQASEH",
          "amount": "50000",
          "feeAmount": "50000",
          "netAmount": "50000"
        }
      ]
    }
  ],
  "meta": {
    "total": 137,
    "page": 1,
    "limit": 20,
    "pageCount": 7,
    "hasNextPage": true
  }
}

Changes

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