Invoices

List Invoices

List invoices with optional filtering.

get/invoices

Request

Base URL
https://api.upflow.io/v1
Auth
API key in header X-Api-Key and API key in header X-Api-Secret

Query parameters

offsetinteger

The 0-based index of the first item to return.

pageinteger

Example:1

The page number to retrieve (1-based). If both page and offset are provided, offset takes priority.

limitinteger

Example:100

Maximum number of items to return per page.

customer.idstring

Example:00a70b35-2be3-4c43-aefb-397190134655

Filter invoices by Customer ID.

customer.externalIdstring

Example:134

Filter invoices by external Customer ID.

updatedAt.gtstring date-time

Minimum value to filter by (exclusive)

updatedAt.gtestring date-time

Minimum value to filter by (inclusive)

updatedAt.ltstring date-time

Maximum value to filter by (exclusive)

updatedAt.ltestring date-time

Maximum value to filter by (inclusive)

{
  "updatedAt.gt": "2015-05-05T12:30:00Z",
  "updatedAt.gte": "2015-05-05T12:30:00Z",
  "updatedAt.lt": "2015-05-05T12:30:00Z",
  "updatedAt.lte": "2015-05-05T12:30:00Z"
}

customIdstring

Example:INV123

Filter invoices by custom ID.

dunningPlanIdstring

Example:35d440f2-aa53-4b22-84ba-0a4274e800e0

Filter invoices by dunning plan ID.

state'DUE' | 'OVERDUE' | 'PAID' | 'WRITTEN_OFF' | 'DISPUTED'

Status of the invoice.

Filter invoices by state.

sortBy'customId' | 'updatedAt'

Example:customId

Sort invoices by a specific column.

sortOrder'DESC' | 'ASC'

Sort order.

Response

Paginated list of invoices.

offsetinteger

0-based index of the first item returned. Returned when using offset-based pagination or by default.

pageinteger

Page number (1-based). Returned when using page-based pagination.

limitinteger required

Maximum number of items returned.

totalinteger required

Total items in the set.

Example response

{
  "page": 1,
  "limit": 50,
  "total": 100,
  "invoices": [
    {
      "externalId": "FAC123",
      "issuedAt": "2015-05-05T12:30:00Z",
      "dueDate": "2015-05-05T12:30:00Z",
      "name": "Facture couvrant les prestations de service de Decembre",
      "currency": "EUR",
      "grossAmount": 2200,
      "netAmount": 2000,
      "amountOutstanding": 500,
      "dunningPlanId": "00a70b35-2be3-4c43-aefb-397190134655",
      "id": "00a70b35-2be3-4c43-aefb-397190134655",
      "customerId": "a1b2c3",
      "payments": [
        {
          "id": "00a70b35-2be3-4c43-aefb-397190134655",
          "amount": 1700,
          "linkedAmount": 1700,
          "executedAt": "2015-05-05T12:30:00Z"
        }
      ],
      "pdfUrl": "http://example.com/invoice.pdf",
      "customFields": [],
      "dunningPausedUntil": "2024-06-01",
      "dunningPausedComment": "Customer requested delay until end of month.",
      "dunningPausedByUserId": "00a70b35-2be3-4c43-aefb-397190134655",
      "promiseToPay": {
        "expectedDate": "2023-08-30",
        "comment": "Customer confirmed payment will be sent next week.",
        "isActive": true,
        "createdAt": "2015-05-05T12:30:00Z"
      },
      "createdAt": "2015-05-05T12:30:00Z",
      "updatedAt": "2015-05-05T12:30:00Z"
    }
  ]
}

Changes

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