Create recurring invoice schedule

const options = {
  method: 'POST',
  headers: {'x-dolfin-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    customerId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    currency: '<string>',
    lineItems: [
      {
        productId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        quantity: 123,
        taxRateId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        unitPriceOverride: 123
      }
    ]
  })
};

fetch('https://api.dolfinai.co/v1/recurring-invoices', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.dolfinai.co/v1/recurring-invoices"

payload = {
    "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "currency": "<string>",
    "lineItems": [
        {
            "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "quantity": 123,
            "taxRateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "unitPriceOverride": 123
        }
    ]
}
headers = {
    "x-dolfin-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

using RestSharp;


var options = new RestClientOptions("https://api.dolfinai.co/v1/recurring-invoices");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-dolfin-api-key", "<api-key>");
request.AddJsonBody("{\n  \"customerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"currency\": \"<string>\",\n  \"lineItems\": [\n    {\n      \"productId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"quantity\": 123,\n      \"taxRateId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"unitPriceOverride\": 123\n    }\n  ]\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

curl --request POST \
  --url https://api.dolfinai.co/v1/recurring-invoices \
  --header 'Content-Type: application/json' \
  --header 'x-dolfin-api-key: <api-key>' \
  --data '
{
  "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "currency": "<string>",
  "lineItems": [
    {
      "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "quantity": 123,
      "taxRateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "unitPriceOverride": 123
    }
  ]
}
'

{
  "currency": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organisationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "memo": "<string>",
  "paymentTermsDays": 123,
  "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
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

Recurring Invoices

Create recurring invoice schedule

Create a recurring-invoice schedule (contract). Invoices are generated from the schedule’s template on the cadence — occurrence N falls on StartDate plus N intervals (month-end clamped). With AutoSend each occurrence is generated and emailed in one step; otherwise occurrences land as Draft for review. Admin-gated because an AutoSend schedule sends email without further review.

Authentication. An API key (x-dolfin-api-key) together with the x-dolfin-organisation-id header identifying the organisation, or a JWT Bearer token that carries the organisation in its claims.

POST

recurring-invoices

const options = {
  method: 'POST',
  headers: {'x-dolfin-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    customerId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    currency: '<string>',
    lineItems: [
      {
        productId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        quantity: 123,
        taxRateId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        unitPriceOverride: 123
      }
    ]
  })
};

fetch('https://api.dolfinai.co/v1/recurring-invoices', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.dolfinai.co/v1/recurring-invoices"

payload = {
    "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "currency": "<string>",
    "lineItems": [
        {
            "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "quantity": 123,
            "taxRateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "unitPriceOverride": 123
        }
    ]
}
headers = {
    "x-dolfin-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

using RestSharp;


var options = new RestClientOptions("https://api.dolfinai.co/v1/recurring-invoices");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-dolfin-api-key", "<api-key>");
request.AddJsonBody("{\n  \"customerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"currency\": \"<string>\",\n  \"lineItems\": [\n    {\n      \"productId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"quantity\": 123,\n      \"taxRateId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"unitPriceOverride\": 123\n    }\n  ]\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

curl --request POST \
  --url https://api.dolfinai.co/v1/recurring-invoices \
  --header 'Content-Type: application/json' \
  --header 'x-dolfin-api-key: <api-key>' \
  --data '
{
  "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "currency": "<string>",
  "lineItems": [
    {
      "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "quantity": 123,
      "taxRateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "unitPriceOverride": 123
    }
  ]
}
'

{
  "currency": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organisationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "memo": "<string>",
  "paymentTermsDays": 123,
  "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
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

Authorizations

x-dolfin-api-key

string

header

required

An API key issued to your client. It carries the client's scope; org-scoped calls also require the x-dolfin-organisation-id header. Keys are created and revoked by a client administrator.

Headers

x-dolfin-organisation-id

string<uuid>

Target organisation. Required when authenticating with an API key; omit for Bearer callers (resolved from the token).

Body

application/json

customerId

string<uuid>

required

currency

string

required

ISO 4217 currency code (e.g. GBP, USD, EUR)

lineItems

object[]

required

Show child attributes

memo

null | string

paymentTermsDays

Payment terms in days (0-365) applied to every generated invoice — the due date is this many days after each occurrence's issue date. 0 means due on receipt. Omit to use the organisation's default payment terms.

startDate

string<date-time>

Date of the first invoice. Subsequent occurrences fall on this date plus N intervals (month-end clamped).

cadence

enum<string>

Available options:

Weekly,

Monthly,

Quarterly,

Annually

totalOccurrences

Total number of invoices to generate. Omit to run until paused or cancelled.

autoSend

boolean

True: each occurrence is generated and emailed in one step. False: occurrences land as Draft for review.

Response

Created

currency

string

required

ISO 4217 currency code (e.g. GBP, USD, EUR)

string<uuid>

organisationId

string<uuid>

customerId

string<uuid>

memo

null | string

paymentTermsDays

Payment terms in days applied to every generated invoice. Null means each occurrence uses the organisation's default at generation time.

startDate

string<date-time>

cadence

enum<string>

Available options:

Weekly,

Monthly,

Quarterly,

Annually

totalOccurrences

occurrencesGenerated

nextRunAt

null | string<date-time>

When the next invoice will be generated. Null on Paused, Completed, and Cancelled schedules.

autoSend

boolean

status

enum<string>

Available options:

Active,

Paused,

Completed,

Cancelled

lastGeneratedAt

null | string<date-time>

createdAt

string<date-time>

createdBy

null | string<uuid>

updatedAt

string<date-time>

updatedBy

null | string<uuid>

customer

null | object

Show child attributes

lineItems

object[]

Show child attributes

Overview

Auth

Users

Organisations

Clients

Agent

MCP

Invoices

Invoice Reminders

Recurring Invoices

Credit Notes

Receivables

Bills

Companies

Purchase Orders

Delivery Notes

Matching

Supplier Credit Notes

Approval Policies

Payables

Bank Payments

Gmail

Suppliers

Payments

Customers

Products

Tax Rates

Currencies

Bank details

Industries

Webhooks

Create recurring invoice schedule

Authorizations

Headers

Body

Response