Patch invoice

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

fetch('https://api.dolfinai.co/v1/invoices/{id}', 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}"

payload = {
    "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "currency": "<string>",
    "memo": "<string>",
    "paymentTermsDays": 123,
    "paymentLinkUrl": "<string>",
    "lineItems": [
        {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "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.patch(url, json=payload, headers=headers)

print(response.text)

using RestSharp;


var options = new RestClientOptions("https://api.dolfinai.co/v1/invoices/{id}");
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  \"memo\": \"<string>\",\n  \"paymentTermsDays\": 123,\n  \"paymentLinkUrl\": \"<string>\",\n  \"lineItems\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\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.PatchAsync(request);

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

curl --request PATCH \
  --url https://api.dolfinai.co/v1/invoices/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-dolfin-api-key: <api-key>' \
  --data '
{
  "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "currency": "<string>",
  "memo": "<string>",
  "paymentTermsDays": 123,
  "paymentLinkUrl": "<string>",
  "lineItems": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "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",
  "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>"
}

PATCH

invoices

{id}

Patch invoice

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

fetch('https://api.dolfinai.co/v1/invoices/{id}', 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}"

payload = {
    "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "currency": "<string>",
    "memo": "<string>",
    "paymentTermsDays": 123,
    "paymentLinkUrl": "<string>",
    "lineItems": [
        {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "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.patch(url, json=payload, headers=headers)

print(response.text)

using RestSharp;


var options = new RestClientOptions("https://api.dolfinai.co/v1/invoices/{id}");
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  \"memo\": \"<string>\",\n  \"paymentTermsDays\": 123,\n  \"paymentLinkUrl\": \"<string>\",\n  \"lineItems\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\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.PatchAsync(request);

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

curl --request PATCH \
  --url https://api.dolfinai.co/v1/invoices/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-dolfin-api-key: <api-key>' \
  --data '
{
  "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "currency": "<string>",
  "memo": "<string>",
  "paymentTermsDays": 123,
  "paymentLinkUrl": "<string>",
  "lineItems": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "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",
  "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>"
}

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

customerId

null | string<uuid>

currency

null | string

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

memo

null | string

paymentTermsDays

Payment terms in days (0-365) — the number of days from issue to due date. 0 means due on receipt. Omit to leave unchanged.

paymentLinkUrl

null | string

Custom payment link for this invoice. Only allowed when the client has integrated (Dolfin) payments turned off; must be an absolute https URL. Send an empty string to clear it and fall back to the client default.

lineItems

null | object[]

Show child attributes

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

Patch invoice

Authorizations

Headers

Path Parameters

Body

Response