Skip to main content
GET
/
recurring-invoices
List recurring invoice schedules
const options = {method: 'GET'};

fetch('https://api.dolfinai.co/recurring-invoices', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "data": [
    {
      "currency": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "organisationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "memo": "<string>",
      "startDate": "2023-11-07T05:31:56Z",
      "totalOccurrences": 123,
      "occurrencesGenerated": 123,
      "nextRunAt": "2023-11-07T05:31:56Z",
      "autoSend": true,
      "lastGeneratedAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "updatedAt": "2023-11-07T05:31:56Z",
      "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "customer": {
        "name": "<string>",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "organisationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "email": "<string>",
        "phone": "<string>",
        "taxNumber": "<string>",
        "addressLine1": "<string>",
        "addressLine2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postalCode": "<string>",
        "country": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "updatedAt": "2023-11-07T05:31:56Z",
        "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "lineItems": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "productName": "<string>",
          "quantity": 123,
          "taxRateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "unitPriceOverride": 123
        }
      ]
    }
  ],
  "meta": {
    "cursors": {
      "current": "<string>",
      "next": "<string>",
      "previous": "<string>"
    }
  }
}

Query Parameters

Cursor
string
Limit
default:20
Statuses
enum<string>[]
Available options:
Active,
Paused,
Completed,
Cancelled
CustomerId
string<uuid>

Response

OK

data
object[]
meta
object