Patch an organisation's AR settings

const options = {
  method: 'PATCH',
  headers: {'x-dolfin-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    defaultPaymentTermsDays: 123,
    latePaymentFee: 123,
    defaultReminderOffsets: [],
    bankDetails: {
      accountHolderName: '<string>',
      accountNumber: '<string>',
      sortCode: '<string>',
      routingNumber: '<string>',
      iban: '<string>',
      bicSwift: '<string>',
      country: '<string>',
      currency: '<string>'
    },
    defaultInvoiceCcEmails: ['<string>'],
    defaultReplyToEmail: '<string>',
    invoiceNumberPrefix: '<string>',
    invoiceNumberPadding: 123
  })
};

fetch('https://api.dolfinai.co/v1/organisations/{organisationId}/settings/ar', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.dolfinai.co/v1/organisations/{organisationId}/settings/ar"

payload = {
    "defaultPaymentTermsDays": 123,
    "latePaymentFee": 123,
    "defaultReminderOffsets": [],
    "bankDetails": {
        "accountHolderName": "<string>",
        "accountNumber": "<string>",
        "sortCode": "<string>",
        "routingNumber": "<string>",
        "iban": "<string>",
        "bicSwift": "<string>",
        "country": "<string>",
        "currency": "<string>"
    },
    "defaultInvoiceCcEmails": ["<string>"],
    "defaultReplyToEmail": "<string>",
    "invoiceNumberPrefix": "<string>",
    "invoiceNumberPadding": 123
}
headers = {
    "x-dolfin-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

using RestSharp;


var options = new RestClientOptions("https://api.dolfinai.co/v1/organisations/{organisationId}/settings/ar");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-dolfin-api-key", "<api-key>");
request.AddJsonBody("{\n  \"defaultPaymentTermsDays\": 123,\n  \"latePaymentFee\": 123,\n  \"defaultReminderOffsets\": [],\n  \"bankDetails\": {\n    \"accountHolderName\": \"<string>\",\n    \"accountNumber\": \"<string>\",\n    \"sortCode\": \"<string>\",\n    \"routingNumber\": \"<string>\",\n    \"iban\": \"<string>\",\n    \"bicSwift\": \"<string>\",\n    \"country\": \"<string>\",\n    \"currency\": \"<string>\"\n  },\n  \"defaultInvoiceCcEmails\": [\n    \"<string>\"\n  ],\n  \"defaultReplyToEmail\": \"<string>\",\n  \"invoiceNumberPrefix\": \"<string>\",\n  \"invoiceNumberPadding\": 123\n}", false);
var response = await client.PatchAsync(request);

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

curl --request PATCH \
  --url https://api.dolfinai.co/v1/organisations/{organisationId}/settings/ar \
  --header 'Content-Type: application/json' \
  --header 'x-dolfin-api-key: <api-key>' \
  --data '
{
  "defaultPaymentTermsDays": 123,
  "latePaymentFee": 123,
  "defaultReminderOffsets": [],
  "bankDetails": {
    "accountHolderName": "<string>",
    "accountNumber": "<string>",
    "sortCode": "<string>",
    "routingNumber": "<string>",
    "iban": "<string>",
    "bicSwift": "<string>",
    "country": "<string>",
    "currency": "<string>"
  },
  "defaultInvoiceCcEmails": [
    "<string>"
  ],
  "defaultReplyToEmail": "<string>",
  "invoiceNumberPrefix": "<string>",
  "invoiceNumberPadding": 123
}
'

{
  "defaultReminderOffsets": [],
  "defaultInvoiceCcEmails": [
    "<string>"
  ],
  "invoiceNumberPrefix": "<string>",
  "invoiceNumberNextValue": 123,
  "invoiceNumberPadding": 123,
  "defaultPaymentTermsDays": 123,
  "latePaymentFee": 123,
  "bankDetails": {
    "accountHolderName": "<string>",
    "accountNumber": "<string>",
    "sortCode": "<string>",
    "routingNumber": "<string>",
    "iban": "<string>",
    "bicSwift": "<string>",
    "country": "<string>",
    "currency": "<string>"
  },
  "defaultReplyToEmail": "<string>"
}

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

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

Patch an organisation's AR settings

Partially update an organisation’s accounts-receivable defaults. Only supplied fields change; a settings row is created on first write. These values are copied onto new invoices, which may then override them individually — changing a default never alters an invoice that already exists.

Authentication. An API key (x-dolfin-api-key) or a JWT Bearer token; the organisation is determined without the x-dolfin-organisation-id header.

PATCH

organisations

{organisationId}

settings

Patch an organisation's AR settings

const options = {
  method: 'PATCH',
  headers: {'x-dolfin-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    defaultPaymentTermsDays: 123,
    latePaymentFee: 123,
    defaultReminderOffsets: [],
    bankDetails: {
      accountHolderName: '<string>',
      accountNumber: '<string>',
      sortCode: '<string>',
      routingNumber: '<string>',
      iban: '<string>',
      bicSwift: '<string>',
      country: '<string>',
      currency: '<string>'
    },
    defaultInvoiceCcEmails: ['<string>'],
    defaultReplyToEmail: '<string>',
    invoiceNumberPrefix: '<string>',
    invoiceNumberPadding: 123
  })
};

fetch('https://api.dolfinai.co/v1/organisations/{organisationId}/settings/ar', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.dolfinai.co/v1/organisations/{organisationId}/settings/ar"

payload = {
    "defaultPaymentTermsDays": 123,
    "latePaymentFee": 123,
    "defaultReminderOffsets": [],
    "bankDetails": {
        "accountHolderName": "<string>",
        "accountNumber": "<string>",
        "sortCode": "<string>",
        "routingNumber": "<string>",
        "iban": "<string>",
        "bicSwift": "<string>",
        "country": "<string>",
        "currency": "<string>"
    },
    "defaultInvoiceCcEmails": ["<string>"],
    "defaultReplyToEmail": "<string>",
    "invoiceNumberPrefix": "<string>",
    "invoiceNumberPadding": 123
}
headers = {
    "x-dolfin-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

using RestSharp;


var options = new RestClientOptions("https://api.dolfinai.co/v1/organisations/{organisationId}/settings/ar");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-dolfin-api-key", "<api-key>");
request.AddJsonBody("{\n  \"defaultPaymentTermsDays\": 123,\n  \"latePaymentFee\": 123,\n  \"defaultReminderOffsets\": [],\n  \"bankDetails\": {\n    \"accountHolderName\": \"<string>\",\n    \"accountNumber\": \"<string>\",\n    \"sortCode\": \"<string>\",\n    \"routingNumber\": \"<string>\",\n    \"iban\": \"<string>\",\n    \"bicSwift\": \"<string>\",\n    \"country\": \"<string>\",\n    \"currency\": \"<string>\"\n  },\n  \"defaultInvoiceCcEmails\": [\n    \"<string>\"\n  ],\n  \"defaultReplyToEmail\": \"<string>\",\n  \"invoiceNumberPrefix\": \"<string>\",\n  \"invoiceNumberPadding\": 123\n}", false);
var response = await client.PatchAsync(request);

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

curl --request PATCH \
  --url https://api.dolfinai.co/v1/organisations/{organisationId}/settings/ar \
  --header 'Content-Type: application/json' \
  --header 'x-dolfin-api-key: <api-key>' \
  --data '
{
  "defaultPaymentTermsDays": 123,
  "latePaymentFee": 123,
  "defaultReminderOffsets": [],
  "bankDetails": {
    "accountHolderName": "<string>",
    "accountNumber": "<string>",
    "sortCode": "<string>",
    "routingNumber": "<string>",
    "iban": "<string>",
    "bicSwift": "<string>",
    "country": "<string>",
    "currency": "<string>"
  },
  "defaultInvoiceCcEmails": [
    "<string>"
  ],
  "defaultReplyToEmail": "<string>",
  "invoiceNumberPrefix": "<string>",
  "invoiceNumberPadding": 123
}
'

{
  "defaultReminderOffsets": [],
  "defaultInvoiceCcEmails": [
    "<string>"
  ],
  "invoiceNumberPrefix": "<string>",
  "invoiceNumberNextValue": 123,
  "invoiceNumberPadding": 123,
  "defaultPaymentTermsDays": 123,
  "latePaymentFee": 123,
  "bankDetails": {
    "accountHolderName": "<string>",
    "accountNumber": "<string>",
    "sortCode": "<string>",
    "routingNumber": "<string>",
    "iban": "<string>",
    "bicSwift": "<string>",
    "country": "<string>",
    "currency": "<string>"
  },
  "defaultReplyToEmail": "<string>"
}

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

{
  "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.

Path Parameters

organisationId

string<uuid>

required

Body

application/json

defaultPaymentTermsDays

Default number of days between an invoice's issue date and its due date, from 0 to 365. 0 means due on receipt. Copied onto each new invoice, which may then override it.

latePaymentFee

Percentage fee applied to overdue invoices. Not currently applied automatically.

defaultInvoiceMessageTone

null | enum<string>

Tone used to compose invoice and reminder emails, unless overridden for an individual send.

Available options:

Friendly,

Direct,

Formal

defaultReminderOffsets

null | enum<string>[]

Reminder schedule applied automatically when an invoice is sent. Supply an empty list to disable automatic reminders. Duplicates are removed.

Available options:

OneWeekBefore,

TwoDaysBefore,

OnDueDate,

TwoDaysAfter,

OneWeekAfter

bankDetails

null | object

The organisation's own bank details, shown in the payment details section of the invoice PDF.

Show child attributes

defaultInvoiceCcEmails

null | string[]

Default CC recipients added to every invoice email and its reminders. Supply an empty list to clear. Each must be a valid email; duplicates and the customer's own address are removed.

defaultReplyToEmail

null | string

Reply-To address for invoice and reminder emails. Send an empty string to clear it and fall back to the organisation's contact email. Must be a valid email.

invoiceNumberPrefix

null | string

Prefix for generated invoice numbers (e.g. "INV"). 1-16 characters.

invoiceNumberPadding

Minimum zero-padded digit width of the invoice number sequence, 1-10.

Response

An organisation's accounts-receivable defaults. Each value is the starting point for new invoices; individual invoices may override them.

defaultInvoiceMessageTone

enum<string>

required

Tone used to compose invoice and reminder emails, unless overridden for an individual send.

Available options:

Friendly,

Direct,

Formal

defaultReminderOffsets

enum<string>[]

required

Reminder schedule applied automatically when an invoice is sent, unless the send call supplies its own. An empty list disables automatic reminders.

Available options:

OneWeekBefore,

TwoDaysBefore,

OnDueDate,

TwoDaysAfter,

OneWeekAfter

defaultInvoiceCcEmails

string[]

required

Default CC recipients added to every invoice email and its reminders, unless an invoice overrides them.

invoiceNumberPrefix

string

required

Prefix for generated invoice numbers, e.g. "INV" produces INV-0001.

invoiceNumberNextValue

required

The next invoice sequence number that will be allocated for this organisation.

invoiceNumberPadding

required

Minimum digit width of the invoice number sequence, zero-padded (e.g. 4 → 0001).

defaultPaymentTermsDays

Default number of days between an invoice's issue date and its due date. Copied onto each new invoice, which may then override it. 0 means due on receipt. Null means the platform default of 30 days applies.

latePaymentFee

Percentage fee applied to overdue invoices. Not currently applied automatically.

bankDetails

object

The organisation's own bank details, shown in the payment details section of the invoice PDF.

Show child attributes

defaultReplyToEmail

null | string

Reply-To address for invoice and reminder emails. When null, the organisation's contact email is used.

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

Patch an organisation's AR settings

Authorizations

Path Parameters

Body

Response