Skip to main content
GET
Get an organisation's AR settings

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

Response

OK

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.

defaultReplyToEmail
null | string

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