Send invoice

const options = {
  method: 'POST',
  headers: {'x-dolfin-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    subject: '<string>',
    previewText: '<string>',
    greetingLine: '<string>',
    openingBodyMarkdown: '<string>',
    reminders: [],
    cc: ['<string>'],
    replyTo: '<string>'
  })
};

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

import requests

url = "https://api.dolfinai.co/v1/invoices/{id}/send"

payload = {
    "subject": "<string>",
    "previewText": "<string>",
    "greetingLine": "<string>",
    "openingBodyMarkdown": "<string>",
    "reminders": [],
    "cc": ["<string>"],
    "replyTo": "<string>"
}
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/invoices/{id}/send");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-dolfin-api-key", "<api-key>");
request.AddJsonBody("{\n  \"subject\": \"<string>\",\n  \"previewText\": \"<string>\",\n  \"greetingLine\": \"<string>\",\n  \"openingBodyMarkdown\": \"<string>\",\n  \"reminders\": [],\n  \"cc\": [\n    \"<string>\"\n  ],\n  \"replyTo\": \"<string>\"\n}", false);
var response = await client.PostAsync(request);

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

curl --request POST \
  --url https://api.dolfinai.co/v1/invoices/{id}/send \
  --header 'Content-Type: application/json' \
  --header 'x-dolfin-api-key: <api-key>' \
  --data '
{
  "subject": "<string>",
  "previewText": "<string>",
  "greetingLine": "<string>",
  "openingBodyMarkdown": "<string>",
  "reminders": [],
  "cc": [
    "<string>"
  ],
  "replyTo": "<string>"
}
'

{
  "currency": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organisationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "documentNumber": "<string>",
  "issueDate": "2023-11-07T05:31:56Z",
  "dueDate": "2023-11-07T05:31:56Z",
  "subTotal": 123,
  "taxAmount": 123,
  "totalAmount": 123,
  "amountPaid": 123,
  "amountCredited": 123,
  "outstanding": 123,
  "recurringScheduleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "recurringOccurrenceNumber": 123,
  "memo": "<string>",
  "paymentLinkUrl": "<string>",
  "ccEmails": [
    "<string>"
  ],
  "paymentTermsDays": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updatedAt": "2023-11-07T05:31:56Z",
  "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "paymentUrl": "<string>",
  "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": [
    {
      "description": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "productName": "<string>",
      "taxRateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "taxRateSnapshot": {
        "code": "<string>",
        "name": "<string>",
        "source": "<string>",
        "rate": 123,
        "sourceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "snapshottedAt": "2023-11-07T05:31:56Z"
      },
      "quantity": 123,
      "unitPrice": 123,
      "taxAmount": 123,
      "subTotal": 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>"
}

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

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

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

Invoices

Send invoice

Mark an invoice as sent and deliver it to the customer. The optional request body lets the caller override individual fields of the email (Subject, PreviewText, GreetingLine, or OpeningBody Markdown) per send; any field omitted is resolved from the catalogue using the organisation’s DefaultInvoiceMessageTone and industry. Pass an empty body (or no body) to send the catalogue-resolved email as-is.

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

invoices

{id}

send

Send invoice

const options = {
  method: 'POST',
  headers: {'x-dolfin-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    subject: '<string>',
    previewText: '<string>',
    greetingLine: '<string>',
    openingBodyMarkdown: '<string>',
    reminders: [],
    cc: ['<string>'],
    replyTo: '<string>'
  })
};

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

import requests

url = "https://api.dolfinai.co/v1/invoices/{id}/send"

payload = {
    "subject": "<string>",
    "previewText": "<string>",
    "greetingLine": "<string>",
    "openingBodyMarkdown": "<string>",
    "reminders": [],
    "cc": ["<string>"],
    "replyTo": "<string>"
}
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/invoices/{id}/send");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-dolfin-api-key", "<api-key>");
request.AddJsonBody("{\n  \"subject\": \"<string>\",\n  \"previewText\": \"<string>\",\n  \"greetingLine\": \"<string>\",\n  \"openingBodyMarkdown\": \"<string>\",\n  \"reminders\": [],\n  \"cc\": [\n    \"<string>\"\n  ],\n  \"replyTo\": \"<string>\"\n}", false);
var response = await client.PostAsync(request);

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

curl --request POST \
  --url https://api.dolfinai.co/v1/invoices/{id}/send \
  --header 'Content-Type: application/json' \
  --header 'x-dolfin-api-key: <api-key>' \
  --data '
{
  "subject": "<string>",
  "previewText": "<string>",
  "greetingLine": "<string>",
  "openingBodyMarkdown": "<string>",
  "reminders": [],
  "cc": [
    "<string>"
  ],
  "replyTo": "<string>"
}
'

{
  "currency": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organisationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "documentNumber": "<string>",
  "issueDate": "2023-11-07T05:31:56Z",
  "dueDate": "2023-11-07T05:31:56Z",
  "subTotal": 123,
  "taxAmount": 123,
  "totalAmount": 123,
  "amountPaid": 123,
  "amountCredited": 123,
  "outstanding": 123,
  "recurringScheduleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "recurringOccurrenceNumber": 123,
  "memo": "<string>",
  "paymentLinkUrl": "<string>",
  "ccEmails": [
    "<string>"
  ],
  "paymentTermsDays": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updatedAt": "2023-11-07T05:31:56Z",
  "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "paymentUrl": "<string>",
  "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": [
    {
      "description": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "productName": "<string>",
      "taxRateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "taxRateSnapshot": {
        "code": "<string>",
        "name": "<string>",
        "source": "<string>",
        "rate": 123,
        "sourceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "snapshottedAt": "2023-11-07T05:31:56Z"
      },
      "quantity": 123,
      "unitPrice": 123,
      "taxAmount": 123,
      "subTotal": 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>"
}

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

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

Path Parameters

string<uuid>

required

Body

application/json

tone

null | enum<string>

Resolves the catalogue with this tone instead of the organisation's default for this send only. When null, the organisation's DefaultInvoiceMessageTone is used.

Available options:

Friendly,

Direct,

Formal

subject

null | string

Overrides the catalogue-resolved email Subject. When null, catalogue resolves.

previewText

null | string

Overrides the catalogue-resolved inbox preview text (the line that previews next to the subject in most clients). When null, catalogue resolves.

greetingLine

null | string

Overrides the catalogue-resolved greeting line (e.g. "Hi Acme,"). When null, catalogue resolves.

openingBodyMarkdown

null | string

Overrides the catalogue-resolved opening body. Markdown; rendered to HTML at send time. When null, catalogue resolves.

reminders

null | enum<string>[]

Override the organisation's DefaultReminderOffsets for this send. null (or field omitted): use the organisation's default list. []: schedule no reminders for this send. Populated: schedule exactly these offsets, overriding the organisation default. Each offset is resolved relative to the invoice's DueDate; offsets that would resolve to a past time are skipped silently.

Available options:

OneWeekBefore,

TwoDaysBefore,

OnDueDate,

TwoDaysAfter,

OneWeekAfter

null | string[]

Override the invoice's CC recipients for this send. null (or omitted): use the invoice's CC, or the organisation default when the invoice has none. Populated (or []): use exactly these, and persist them on the invoice so its reminders CC the same recipients. Each must be a valid email.

replyTo

null | string

Override the Reply-To address for this send's email only (reminders keep the organisation default). When null, the organisation's DefaultReplyToEmail is used, falling back to its contact email. Must be a valid email.

Response

currency

string

required

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

string<uuid>

organisationId

string<uuid>

customerId

string<uuid>

documentNumber

null | string

issueDate

string<date-time>

dueDate

null | string<date-time>

status

enum<string>

Available options:

Draft,

Sent,

Paid,

Void,

PartiallyPaid,

Credited

subTotal

taxAmount

totalAmount

amountPaid

Total payments received against this invoice.

amountCredited

Total of issued credit notes applied to this invoice.

outstanding

Remaining balance: TotalAmount - payments received - issued credit notes.

recurringScheduleId

null | string<uuid>

Set when this invoice was generated from a recurring schedule; null for hand-made invoices.

recurringOccurrenceNumber

memo

null | string

paymentLinkUrl

null | string

Custom bring-your-own payment link set on this invoice, if any. Only settable when the client has integrated payments off. Null when the client default (or, under integrated payments, the Dolfin-generated link) applies instead.

ccEmails

null | string[]

Per-invoice CC recipients. Null means the organisation's default CC list is used; an empty list means no CC.

paymentTermsDays

Payment terms in days (0-365) snapshotted onto this invoice; the due date is this many days after the issue date. Snapshotted from the organisation default at creation unless overridden. 0 means due on receipt.

createdAt

string<date-time>

createdBy

null | string<uuid>

updatedAt

string<date-time>

updatedBy

null | string<uuid>

paymentUrl

null | string

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

Send invoice

Authorizations

Headers

Path Parameters

Body

Response