Update Client Finance Settings

PUT

clients

{clientId}

finance-settings

curl --request PUT \
  --url https://api.sandbox.flowpayroll.ai/v1/billing/clients/{clientId}/finance-settings \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: <api-key>' \
  --data '
{
  "defaultRevenueAccount": "<string>",
  "defaultTaxRate": "<string>",
  "payElementMappings": [
    {
      "payElementId": "<string>",
      "accountCode": "<string>",
      "taxType": "<string>"
    }
  ],
  "defaultDueDateDays": 123,
  "defaultCurrencyCode": "<string>",
  "defaultLineAmountTypes": "<string>",
  "invoiceTemplateOverride": {
    "showSubsectionHeader": true,
    "showSubtotalInSubsection": true,
    "showSubtotalVatInSubsection": true,
    "showQuantitySumInSubsection": true,
    "showBottomSubtotals": true,
    "showVatInBottomSubtotals": true,
    "showQuantitySumInBottomSubtotals": true,
    "lineDescriptionFormula": "<string>",
    "lineDescriptionTagGroupId": "<string>",
    "includeAttachmentsWithOnlineInvoice": true
  },
  "creditNoteTemplateOverride": {
    "showSubsectionHeader": true,
    "showSubtotalInSubsection": true,
    "showSubtotalVatInSubsection": true,
    "showQuantitySumInSubsection": true,
    "showBottomSubtotals": true,
    "showVatInBottomSubtotals": true,
    "showQuantitySumInBottomSubtotals": true,
    "lineDescriptionFormula": "<string>",
    "lineDescriptionTagGroupId": "<string>",
    "includeAttachmentsWithOnlineInvoice": true
  },
  "invoiceReferenceFormula": "<string>",
  "invoiceReferenceDateFormat": "<string>"
}
'

import requests

url = "https://api.sandbox.flowpayroll.ai/v1/billing/clients/{clientId}/finance-settings"

payload = {
    "defaultRevenueAccount": "<string>",
    "defaultTaxRate": "<string>",
    "payElementMappings": [
        {
            "payElementId": "<string>",
            "accountCode": "<string>",
            "taxType": "<string>"
        }
    ],
    "defaultDueDateDays": 123,
    "defaultCurrencyCode": "<string>",
    "defaultLineAmountTypes": "<string>",
    "invoiceTemplateOverride": {
        "showSubsectionHeader": True,
        "showSubtotalInSubsection": True,
        "showSubtotalVatInSubsection": True,
        "showQuantitySumInSubsection": True,
        "showBottomSubtotals": True,
        "showVatInBottomSubtotals": True,
        "showQuantitySumInBottomSubtotals": True,
        "lineDescriptionFormula": "<string>",
        "lineDescriptionTagGroupId": "<string>",
        "includeAttachmentsWithOnlineInvoice": True
    },
    "creditNoteTemplateOverride": {
        "showSubsectionHeader": True,
        "showSubtotalInSubsection": True,
        "showSubtotalVatInSubsection": True,
        "showQuantitySumInSubsection": True,
        "showBottomSubtotals": True,
        "showVatInBottomSubtotals": True,
        "showQuantitySumInBottomSubtotals": True,
        "lineDescriptionFormula": "<string>",
        "lineDescriptionTagGroupId": "<string>",
        "includeAttachmentsWithOnlineInvoice": True
    },
    "invoiceReferenceFormula": "<string>",
    "invoiceReferenceDateFormat": "<string>"
}
headers = {
    "X-Auth-Token": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {'X-Auth-Token': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    defaultRevenueAccount: '<string>',
    defaultTaxRate: '<string>',
    payElementMappings: [{payElementId: '<string>', accountCode: '<string>', taxType: '<string>'}],
    defaultDueDateDays: 123,
    defaultCurrencyCode: '<string>',
    defaultLineAmountTypes: '<string>',
    invoiceTemplateOverride: {
      showSubsectionHeader: true,
      showSubtotalInSubsection: true,
      showSubtotalVatInSubsection: true,
      showQuantitySumInSubsection: true,
      showBottomSubtotals: true,
      showVatInBottomSubtotals: true,
      showQuantitySumInBottomSubtotals: true,
      lineDescriptionFormula: '<string>',
      lineDescriptionTagGroupId: '<string>',
      includeAttachmentsWithOnlineInvoice: true
    },
    creditNoteTemplateOverride: {
      showSubsectionHeader: true,
      showSubtotalInSubsection: true,
      showSubtotalVatInSubsection: true,
      showQuantitySumInSubsection: true,
      showBottomSubtotals: true,
      showVatInBottomSubtotals: true,
      showQuantitySumInBottomSubtotals: true,
      lineDescriptionFormula: '<string>',
      lineDescriptionTagGroupId: '<string>',
      includeAttachmentsWithOnlineInvoice: true
    },
    invoiceReferenceFormula: '<string>',
    invoiceReferenceDateFormat: '<string>'
  })
};

fetch('https://api.sandbox.flowpayroll.ai/v1/billing/clients/{clientId}/finance-settings', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.flowpayroll.ai/v1/billing/clients/{clientId}/finance-settings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'defaultRevenueAccount' => '<string>',
    'defaultTaxRate' => '<string>',
    'payElementMappings' => [
        [
                'payElementId' => '<string>',
                'accountCode' => '<string>',
                'taxType' => '<string>'
        ]
    ],
    'defaultDueDateDays' => 123,
    'defaultCurrencyCode' => '<string>',
    'defaultLineAmountTypes' => '<string>',
    'invoiceTemplateOverride' => [
        'showSubsectionHeader' => true,
        'showSubtotalInSubsection' => true,
        'showSubtotalVatInSubsection' => true,
        'showQuantitySumInSubsection' => true,
        'showBottomSubtotals' => true,
        'showVatInBottomSubtotals' => true,
        'showQuantitySumInBottomSubtotals' => true,
        'lineDescriptionFormula' => '<string>',
        'lineDescriptionTagGroupId' => '<string>',
        'includeAttachmentsWithOnlineInvoice' => true
    ],
    'creditNoteTemplateOverride' => [
        'showSubsectionHeader' => true,
        'showSubtotalInSubsection' => true,
        'showSubtotalVatInSubsection' => true,
        'showQuantitySumInSubsection' => true,
        'showBottomSubtotals' => true,
        'showVatInBottomSubtotals' => true,
        'showQuantitySumInBottomSubtotals' => true,
        'lineDescriptionFormula' => '<string>',
        'lineDescriptionTagGroupId' => '<string>',
        'includeAttachmentsWithOnlineInvoice' => true
    ],
    'invoiceReferenceFormula' => '<string>',
    'invoiceReferenceDateFormat' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Auth-Token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.flowpayroll.ai/v1/billing/clients/{clientId}/finance-settings"

	payload := strings.NewReader("{\n  \"defaultRevenueAccount\": \"<string>\",\n  \"defaultTaxRate\": \"<string>\",\n  \"payElementMappings\": [\n    {\n      \"payElementId\": \"<string>\",\n      \"accountCode\": \"<string>\",\n      \"taxType\": \"<string>\"\n    }\n  ],\n  \"defaultDueDateDays\": 123,\n  \"defaultCurrencyCode\": \"<string>\",\n  \"defaultLineAmountTypes\": \"<string>\",\n  \"invoiceTemplateOverride\": {\n    \"showSubsectionHeader\": true,\n    \"showSubtotalInSubsection\": true,\n    \"showSubtotalVatInSubsection\": true,\n    \"showQuantitySumInSubsection\": true,\n    \"showBottomSubtotals\": true,\n    \"showVatInBottomSubtotals\": true,\n    \"showQuantitySumInBottomSubtotals\": true,\n    \"lineDescriptionFormula\": \"<string>\",\n    \"lineDescriptionTagGroupId\": \"<string>\",\n    \"includeAttachmentsWithOnlineInvoice\": true\n  },\n  \"creditNoteTemplateOverride\": {\n    \"showSubsectionHeader\": true,\n    \"showSubtotalInSubsection\": true,\n    \"showSubtotalVatInSubsection\": true,\n    \"showQuantitySumInSubsection\": true,\n    \"showBottomSubtotals\": true,\n    \"showVatInBottomSubtotals\": true,\n    \"showQuantitySumInBottomSubtotals\": true,\n    \"lineDescriptionFormula\": \"<string>\",\n    \"lineDescriptionTagGroupId\": \"<string>\",\n    \"includeAttachmentsWithOnlineInvoice\": true\n  },\n  \"invoiceReferenceFormula\": \"<string>\",\n  \"invoiceReferenceDateFormat\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("X-Auth-Token", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.sandbox.flowpayroll.ai/v1/billing/clients/{clientId}/finance-settings")
  .header("X-Auth-Token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"defaultRevenueAccount\": \"<string>\",\n  \"defaultTaxRate\": \"<string>\",\n  \"payElementMappings\": [\n    {\n      \"payElementId\": \"<string>\",\n      \"accountCode\": \"<string>\",\n      \"taxType\": \"<string>\"\n    }\n  ],\n  \"defaultDueDateDays\": 123,\n  \"defaultCurrencyCode\": \"<string>\",\n  \"defaultLineAmountTypes\": \"<string>\",\n  \"invoiceTemplateOverride\": {\n    \"showSubsectionHeader\": true,\n    \"showSubtotalInSubsection\": true,\n    \"showSubtotalVatInSubsection\": true,\n    \"showQuantitySumInSubsection\": true,\n    \"showBottomSubtotals\": true,\n    \"showVatInBottomSubtotals\": true,\n    \"showQuantitySumInBottomSubtotals\": true,\n    \"lineDescriptionFormula\": \"<string>\",\n    \"lineDescriptionTagGroupId\": \"<string>\",\n    \"includeAttachmentsWithOnlineInvoice\": true\n  },\n  \"creditNoteTemplateOverride\": {\n    \"showSubsectionHeader\": true,\n    \"showSubtotalInSubsection\": true,\n    \"showSubtotalVatInSubsection\": true,\n    \"showQuantitySumInSubsection\": true,\n    \"showBottomSubtotals\": true,\n    \"showVatInBottomSubtotals\": true,\n    \"showQuantitySumInBottomSubtotals\": true,\n    \"lineDescriptionFormula\": \"<string>\",\n    \"lineDescriptionTagGroupId\": \"<string>\",\n    \"includeAttachmentsWithOnlineInvoice\": true\n  },\n  \"invoiceReferenceFormula\": \"<string>\",\n  \"invoiceReferenceDateFormat\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.flowpayroll.ai/v1/billing/clients/{clientId}/finance-settings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["X-Auth-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"defaultRevenueAccount\": \"<string>\",\n  \"defaultTaxRate\": \"<string>\",\n  \"payElementMappings\": [\n    {\n      \"payElementId\": \"<string>\",\n      \"accountCode\": \"<string>\",\n      \"taxType\": \"<string>\"\n    }\n  ],\n  \"defaultDueDateDays\": 123,\n  \"defaultCurrencyCode\": \"<string>\",\n  \"defaultLineAmountTypes\": \"<string>\",\n  \"invoiceTemplateOverride\": {\n    \"showSubsectionHeader\": true,\n    \"showSubtotalInSubsection\": true,\n    \"showSubtotalVatInSubsection\": true,\n    \"showQuantitySumInSubsection\": true,\n    \"showBottomSubtotals\": true,\n    \"showVatInBottomSubtotals\": true,\n    \"showQuantitySumInBottomSubtotals\": true,\n    \"lineDescriptionFormula\": \"<string>\",\n    \"lineDescriptionTagGroupId\": \"<string>\",\n    \"includeAttachmentsWithOnlineInvoice\": true\n  },\n  \"creditNoteTemplateOverride\": {\n    \"showSubsectionHeader\": true,\n    \"showSubtotalInSubsection\": true,\n    \"showSubtotalVatInSubsection\": true,\n    \"showQuantitySumInSubsection\": true,\n    \"showBottomSubtotals\": true,\n    \"showVatInBottomSubtotals\": true,\n    \"showQuantitySumInBottomSubtotals\": true,\n    \"lineDescriptionFormula\": \"<string>\",\n    \"lineDescriptionTagGroupId\": \"<string>\",\n    \"includeAttachmentsWithOnlineInvoice\": true\n  },\n  \"invoiceReferenceFormula\": \"<string>\",\n  \"invoiceReferenceDateFormat\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "message": {
    "token": "<string>",
    "text": "<string>",
    "tokenArguments": [
      {
        "name": "<string>",
        "value": null
      }
    ],
    "textId": "<string>",
    "textParameters": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ]
  },
  "content": {
    "data": {
      "defaultRevenueAccount": "<string>",
      "defaultTaxRate": "<string>",
      "payElementMappings": [
        {
          "payElementId": "<string>",
          "accountCode": "<string>",
          "taxType": "<string>"
        }
      ],
      "defaultDueDateDays": 123,
      "defaultDueDateType": "DaysAfterInvoiceDate",
      "defaultCurrencyCode": "<string>",
      "defaultLineAmountTypes": "<string>",
      "invoiceTemplateOverride": {
        "showSubsectionHeader": true,
        "showSubtotalInSubsection": true,
        "showSubtotalVatInSubsection": true,
        "showQuantitySumInSubsection": true,
        "showBottomSubtotals": true,
        "showVatInBottomSubtotals": true,
        "showQuantitySumInBottomSubtotals": true,
        "lineItemSortOrder": "None",
        "lineDescriptionFormula": "<string>",
        "lineDescriptionTagGroupId": "<string>",
        "attachmentStrategy": "ExcessLost",
        "includeAttachmentsWithOnlineInvoice": true
      },
      "creditNoteTemplateOverride": {
        "showSubsectionHeader": true,
        "showSubtotalInSubsection": true,
        "showSubtotalVatInSubsection": true,
        "showQuantitySumInSubsection": true,
        "showBottomSubtotals": true,
        "showVatInBottomSubtotals": true,
        "showQuantitySumInBottomSubtotals": true,
        "lineItemSortOrder": "None",
        "lineDescriptionFormula": "<string>",
        "lineDescriptionTagGroupId": "<string>",
        "attachmentStrategy": "ExcessLost",
        "includeAttachmentsWithOnlineInvoice": true
      },
      "invoiceReferenceFormula": "<string>",
      "invoiceReferenceDateFormat": "<string>"
    },
    "metadata": {
      "dateFormat": "<string>",
      "dateTimeFormat": "<string>",
      "paginationToken": "<string>"
    }
  },
  "validationIssues": [
    {
      "field": "<string>",
      "reason": "<string>",
      "reasonToken": "<string>",
      "reasonTokenArguments": [
        {
          "name": "<string>",
          "value": null
        }
      ]
    }
  ],
  "errors": [
    {
      "field": "<string>",
      "reasonText": "<string>",
      "reasonId": "<string>",
      "reasonParameters": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "metadata": {
    "dateFormat": "<string>",
    "dateTimeFormat": "<string>",
    "paginationToken": "<string>"
  }
}

{
  "message": {
    "token": "<string>",
    "text": "<string>",
    "tokenArguments": [
      {
        "name": "<string>",
        "value": null
      }
    ],
    "textId": "<string>",
    "textParameters": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ]
  },
  "content": {
    "data": null,
    "metadata": {
      "dateFormat": "<string>",
      "dateTimeFormat": "<string>",
      "paginationToken": "<string>"
    }
  },
  "validationIssues": [
    {
      "field": "<string>",
      "reason": "<string>",
      "reasonToken": "<string>",
      "reasonTokenArguments": [
        {
          "name": "<string>",
          "value": null
        }
      ]
    }
  ],
  "errors": [
    {
      "field": "<string>",
      "reasonText": "<string>",
      "reasonId": "<string>",
      "reasonParameters": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "metadata": {
    "dateFormat": "<string>",
    "dateTimeFormat": "<string>",
    "paginationToken": "<string>"
  }
}

{
  "message": {
    "token": "<string>",
    "text": "<string>",
    "tokenArguments": [
      {
        "name": "<string>",
        "value": null
      }
    ],
    "textId": "<string>",
    "textParameters": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ]
  },
  "content": {
    "data": null,
    "metadata": {
      "dateFormat": "<string>",
      "dateTimeFormat": "<string>",
      "paginationToken": "<string>"
    }
  },
  "validationIssues": [
    {
      "field": "<string>",
      "reason": "<string>",
      "reasonToken": "<string>",
      "reasonTokenArguments": [
        {
          "name": "<string>",
          "value": null
        }
      ]
    }
  ],
  "errors": [
    {
      "field": "<string>",
      "reasonText": "<string>",
      "reasonId": "<string>",
      "reasonParameters": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "metadata": {
    "dateFormat": "<string>",
    "dateTimeFormat": "<string>",
    "paginationToken": "<string>"
  }
}

{
  "message": {
    "token": "<string>",
    "text": "<string>",
    "tokenArguments": [
      {
        "name": "<string>",
        "value": null
      }
    ],
    "textId": "<string>",
    "textParameters": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ]
  },
  "content": {
    "data": "<string>",
    "metadata": {
      "dateFormat": "<string>",
      "dateTimeFormat": "<string>",
      "paginationToken": "<string>"
    }
  },
  "validationIssues": [
    {
      "field": "<string>",
      "reason": "<string>",
      "reasonToken": "<string>",
      "reasonTokenArguments": [
        {
          "name": "<string>",
          "value": null
        }
      ]
    }
  ],
  "errors": [
    {
      "field": "<string>",
      "reasonText": "<string>",
      "reasonId": "<string>",
      "reasonParameters": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "metadata": {
    "dateFormat": "<string>",
    "dateTimeFormat": "<string>",
    "paginationToken": "<string>"
  }
}

{
  "message": {
    "token": "<string>",
    "text": "<string>",
    "tokenArguments": [
      {
        "name": "<string>",
        "value": null
      }
    ],
    "textId": "<string>",
    "textParameters": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ]
  },
  "content": {
    "data": "<string>",
    "metadata": {
      "dateFormat": "<string>",
      "dateTimeFormat": "<string>",
      "paginationToken": "<string>"
    }
  },
  "validationIssues": [
    {
      "field": "<string>",
      "reason": "<string>",
      "reasonToken": "<string>",
      "reasonTokenArguments": [
        {
          "name": "<string>",
          "value": null
        }
      ]
    }
  ],
  "errors": [
    {
      "field": "<string>",
      "reasonText": "<string>",
      "reasonId": "<string>",
      "reasonParameters": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "metadata": {
    "dateFormat": "<string>",
    "dateTimeFormat": "<string>",
    "paginationToken": "<string>"
  }
}

Authorizations

X-Auth-Token

string

header

required

Authentication token for API access

Path Parameters

clientId

string

required

Body

application/json

Client-scoped finance settings (defaults and pay element mappings; tax/account data is organisation-level).

defaultRevenueAccount

string | null

defaultTaxRate

string | null

payElementMappings

object[]

Show child attributes

defaultDueDateDays

integer<int32> | null

defaultDueDateType

enum<string> | null

Available options:

DaysAfterInvoiceDate,

DaysAfterInvoiceMonth,

OfCurrentMonth,

OfFollowingMonth

defaultCurrencyCode

string | null

Default currency code for new invoices (e.g. GBP, USD). When null, fallback (GBP) is used.

defaultLineAmountTypes

string | null

Default line amount type for new invoices (e.g. Exclusive, Inclusive). When null, fallback (Exclusive) is used.

invoiceTemplateOverride

object

Document (invoice or credit note) template: grouping, sort order, line description formula, attachment strategy. Same shape for org default and per-client override. Grouping is driven by booleans (subsection header, subtotal row, VAT and quantity total in subsection and in bottom subtotals).

Show child attributes

creditNoteTemplateOverride

object

Show child attributes

invoiceReferenceFormula

string | null

Optional invoice reference formula with token placeholders (e.g. "{payrollConfigName}{separator:space}{payDate}"). When null, the default behaviour (grouping key as reference) is used.

invoiceReferenceDateFormat

string | null

Date format code applied when resolving date tokens in the invoice reference formula (e.g. DMY_SLASH, YMD_DASH, DMY_COMPACT, MDY_SLASH, DMY_DASH, DMY_DOT). Defaults to DMY_SLASH when null.

Response

Billing's response envelope: the platform's (message.text + message.token, content.data + content.metadata, validationIssues) plus the fields billing sent before it (PRODLAUNCH-416). Those are deprecated, removed on 31 December 2026, and are projections of their replacements so the two cannot disagree.

message

object

required

What happened, as English text and a stable snake_case token to translate from.

Show child attributes

content

object

Show child attributes

validationIssues

object[] | null

Show child attributes

errors

object[] | null

deprecated

read-only

Deprecated: the same issues as validationIssues (reasonText is reason, reasonId is reasonToken, reasonParameters is reasonTokenArguments). Read validationIssues; this will be removed.

Show child attributes

metadata

object

deprecated

Deprecated: the same values as content.metadata. Read that; this will be removed.

Show child attributes

Update Client Finance Settings

curl --request PUT \
  --url https://api.sandbox.flowpayroll.ai/v1/billing/clients/{clientId}/finance-settings \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: <api-key>' \
  --data '
{
  "defaultRevenueAccount": "<string>",
  "defaultTaxRate": "<string>",
  "payElementMappings": [
    {
      "payElementId": "<string>",
      "accountCode": "<string>",
      "taxType": "<string>"
    }
  ],
  "defaultDueDateDays": 123,
  "defaultCurrencyCode": "<string>",
  "defaultLineAmountTypes": "<string>",
  "invoiceTemplateOverride": {
    "showSubsectionHeader": true,
    "showSubtotalInSubsection": true,
    "showSubtotalVatInSubsection": true,
    "showQuantitySumInSubsection": true,
    "showBottomSubtotals": true,
    "showVatInBottomSubtotals": true,
    "showQuantitySumInBottomSubtotals": true,
    "lineDescriptionFormula": "<string>",
    "lineDescriptionTagGroupId": "<string>",
    "includeAttachmentsWithOnlineInvoice": true
  },
  "creditNoteTemplateOverride": {
    "showSubsectionHeader": true,
    "showSubtotalInSubsection": true,
    "showSubtotalVatInSubsection": true,
    "showQuantitySumInSubsection": true,
    "showBottomSubtotals": true,
    "showVatInBottomSubtotals": true,
    "showQuantitySumInBottomSubtotals": true,
    "lineDescriptionFormula": "<string>",
    "lineDescriptionTagGroupId": "<string>",
    "includeAttachmentsWithOnlineInvoice": true
  },
  "invoiceReferenceFormula": "<string>",
  "invoiceReferenceDateFormat": "<string>"
}
'

import requests

url = "https://api.sandbox.flowpayroll.ai/v1/billing/clients/{clientId}/finance-settings"

payload = {
    "defaultRevenueAccount": "<string>",
    "defaultTaxRate": "<string>",
    "payElementMappings": [
        {
            "payElementId": "<string>",
            "accountCode": "<string>",
            "taxType": "<string>"
        }
    ],
    "defaultDueDateDays": 123,
    "defaultCurrencyCode": "<string>",
    "defaultLineAmountTypes": "<string>",
    "invoiceTemplateOverride": {
        "showSubsectionHeader": True,
        "showSubtotalInSubsection": True,
        "showSubtotalVatInSubsection": True,
        "showQuantitySumInSubsection": True,
        "showBottomSubtotals": True,
        "showVatInBottomSubtotals": True,
        "showQuantitySumInBottomSubtotals": True,
        "lineDescriptionFormula": "<string>",
        "lineDescriptionTagGroupId": "<string>",
        "includeAttachmentsWithOnlineInvoice": True
    },
    "creditNoteTemplateOverride": {
        "showSubsectionHeader": True,
        "showSubtotalInSubsection": True,
        "showSubtotalVatInSubsection": True,
        "showQuantitySumInSubsection": True,
        "showBottomSubtotals": True,
        "showVatInBottomSubtotals": True,
        "showQuantitySumInBottomSubtotals": True,
        "lineDescriptionFormula": "<string>",
        "lineDescriptionTagGroupId": "<string>",
        "includeAttachmentsWithOnlineInvoice": True
    },
    "invoiceReferenceFormula": "<string>",
    "invoiceReferenceDateFormat": "<string>"
}
headers = {
    "X-Auth-Token": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {'X-Auth-Token': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    defaultRevenueAccount: '<string>',
    defaultTaxRate: '<string>',
    payElementMappings: [{payElementId: '<string>', accountCode: '<string>', taxType: '<string>'}],
    defaultDueDateDays: 123,
    defaultCurrencyCode: '<string>',
    defaultLineAmountTypes: '<string>',
    invoiceTemplateOverride: {
      showSubsectionHeader: true,
      showSubtotalInSubsection: true,
      showSubtotalVatInSubsection: true,
      showQuantitySumInSubsection: true,
      showBottomSubtotals: true,
      showVatInBottomSubtotals: true,
      showQuantitySumInBottomSubtotals: true,
      lineDescriptionFormula: '<string>',
      lineDescriptionTagGroupId: '<string>',
      includeAttachmentsWithOnlineInvoice: true
    },
    creditNoteTemplateOverride: {
      showSubsectionHeader: true,
      showSubtotalInSubsection: true,
      showSubtotalVatInSubsection: true,
      showQuantitySumInSubsection: true,
      showBottomSubtotals: true,
      showVatInBottomSubtotals: true,
      showQuantitySumInBottomSubtotals: true,
      lineDescriptionFormula: '<string>',
      lineDescriptionTagGroupId: '<string>',
      includeAttachmentsWithOnlineInvoice: true
    },
    invoiceReferenceFormula: '<string>',
    invoiceReferenceDateFormat: '<string>'
  })
};

fetch('https://api.sandbox.flowpayroll.ai/v1/billing/clients/{clientId}/finance-settings', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.flowpayroll.ai/v1/billing/clients/{clientId}/finance-settings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'defaultRevenueAccount' => '<string>',
    'defaultTaxRate' => '<string>',
    'payElementMappings' => [
        [
                'payElementId' => '<string>',
                'accountCode' => '<string>',
                'taxType' => '<string>'
        ]
    ],
    'defaultDueDateDays' => 123,
    'defaultCurrencyCode' => '<string>',
    'defaultLineAmountTypes' => '<string>',
    'invoiceTemplateOverride' => [
        'showSubsectionHeader' => true,
        'showSubtotalInSubsection' => true,
        'showSubtotalVatInSubsection' => true,
        'showQuantitySumInSubsection' => true,
        'showBottomSubtotals' => true,
        'showVatInBottomSubtotals' => true,
        'showQuantitySumInBottomSubtotals' => true,
        'lineDescriptionFormula' => '<string>',
        'lineDescriptionTagGroupId' => '<string>',
        'includeAttachmentsWithOnlineInvoice' => true
    ],
    'creditNoteTemplateOverride' => [
        'showSubsectionHeader' => true,
        'showSubtotalInSubsection' => true,
        'showSubtotalVatInSubsection' => true,
        'showQuantitySumInSubsection' => true,
        'showBottomSubtotals' => true,
        'showVatInBottomSubtotals' => true,
        'showQuantitySumInBottomSubtotals' => true,
        'lineDescriptionFormula' => '<string>',
        'lineDescriptionTagGroupId' => '<string>',
        'includeAttachmentsWithOnlineInvoice' => true
    ],
    'invoiceReferenceFormula' => '<string>',
    'invoiceReferenceDateFormat' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Auth-Token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.flowpayroll.ai/v1/billing/clients/{clientId}/finance-settings"

	payload := strings.NewReader("{\n  \"defaultRevenueAccount\": \"<string>\",\n  \"defaultTaxRate\": \"<string>\",\n  \"payElementMappings\": [\n    {\n      \"payElementId\": \"<string>\",\n      \"accountCode\": \"<string>\",\n      \"taxType\": \"<string>\"\n    }\n  ],\n  \"defaultDueDateDays\": 123,\n  \"defaultCurrencyCode\": \"<string>\",\n  \"defaultLineAmountTypes\": \"<string>\",\n  \"invoiceTemplateOverride\": {\n    \"showSubsectionHeader\": true,\n    \"showSubtotalInSubsection\": true,\n    \"showSubtotalVatInSubsection\": true,\n    \"showQuantitySumInSubsection\": true,\n    \"showBottomSubtotals\": true,\n    \"showVatInBottomSubtotals\": true,\n    \"showQuantitySumInBottomSubtotals\": true,\n    \"lineDescriptionFormula\": \"<string>\",\n    \"lineDescriptionTagGroupId\": \"<string>\",\n    \"includeAttachmentsWithOnlineInvoice\": true\n  },\n  \"creditNoteTemplateOverride\": {\n    \"showSubsectionHeader\": true,\n    \"showSubtotalInSubsection\": true,\n    \"showSubtotalVatInSubsection\": true,\n    \"showQuantitySumInSubsection\": true,\n    \"showBottomSubtotals\": true,\n    \"showVatInBottomSubtotals\": true,\n    \"showQuantitySumInBottomSubtotals\": true,\n    \"lineDescriptionFormula\": \"<string>\",\n    \"lineDescriptionTagGroupId\": \"<string>\",\n    \"includeAttachmentsWithOnlineInvoice\": true\n  },\n  \"invoiceReferenceFormula\": \"<string>\",\n  \"invoiceReferenceDateFormat\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("X-Auth-Token", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.sandbox.flowpayroll.ai/v1/billing/clients/{clientId}/finance-settings")
  .header("X-Auth-Token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"defaultRevenueAccount\": \"<string>\",\n  \"defaultTaxRate\": \"<string>\",\n  \"payElementMappings\": [\n    {\n      \"payElementId\": \"<string>\",\n      \"accountCode\": \"<string>\",\n      \"taxType\": \"<string>\"\n    }\n  ],\n  \"defaultDueDateDays\": 123,\n  \"defaultCurrencyCode\": \"<string>\",\n  \"defaultLineAmountTypes\": \"<string>\",\n  \"invoiceTemplateOverride\": {\n    \"showSubsectionHeader\": true,\n    \"showSubtotalInSubsection\": true,\n    \"showSubtotalVatInSubsection\": true,\n    \"showQuantitySumInSubsection\": true,\n    \"showBottomSubtotals\": true,\n    \"showVatInBottomSubtotals\": true,\n    \"showQuantitySumInBottomSubtotals\": true,\n    \"lineDescriptionFormula\": \"<string>\",\n    \"lineDescriptionTagGroupId\": \"<string>\",\n    \"includeAttachmentsWithOnlineInvoice\": true\n  },\n  \"creditNoteTemplateOverride\": {\n    \"showSubsectionHeader\": true,\n    \"showSubtotalInSubsection\": true,\n    \"showSubtotalVatInSubsection\": true,\n    \"showQuantitySumInSubsection\": true,\n    \"showBottomSubtotals\": true,\n    \"showVatInBottomSubtotals\": true,\n    \"showQuantitySumInBottomSubtotals\": true,\n    \"lineDescriptionFormula\": \"<string>\",\n    \"lineDescriptionTagGroupId\": \"<string>\",\n    \"includeAttachmentsWithOnlineInvoice\": true\n  },\n  \"invoiceReferenceFormula\": \"<string>\",\n  \"invoiceReferenceDateFormat\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.flowpayroll.ai/v1/billing/clients/{clientId}/finance-settings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["X-Auth-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"defaultRevenueAccount\": \"<string>\",\n  \"defaultTaxRate\": \"<string>\",\n  \"payElementMappings\": [\n    {\n      \"payElementId\": \"<string>\",\n      \"accountCode\": \"<string>\",\n      \"taxType\": \"<string>\"\n    }\n  ],\n  \"defaultDueDateDays\": 123,\n  \"defaultCurrencyCode\": \"<string>\",\n  \"defaultLineAmountTypes\": \"<string>\",\n  \"invoiceTemplateOverride\": {\n    \"showSubsectionHeader\": true,\n    \"showSubtotalInSubsection\": true,\n    \"showSubtotalVatInSubsection\": true,\n    \"showQuantitySumInSubsection\": true,\n    \"showBottomSubtotals\": true,\n    \"showVatInBottomSubtotals\": true,\n    \"showQuantitySumInBottomSubtotals\": true,\n    \"lineDescriptionFormula\": \"<string>\",\n    \"lineDescriptionTagGroupId\": \"<string>\",\n    \"includeAttachmentsWithOnlineInvoice\": true\n  },\n  \"creditNoteTemplateOverride\": {\n    \"showSubsectionHeader\": true,\n    \"showSubtotalInSubsection\": true,\n    \"showSubtotalVatInSubsection\": true,\n    \"showQuantitySumInSubsection\": true,\n    \"showBottomSubtotals\": true,\n    \"showVatInBottomSubtotals\": true,\n    \"showQuantitySumInBottomSubtotals\": true,\n    \"lineDescriptionFormula\": \"<string>\",\n    \"lineDescriptionTagGroupId\": \"<string>\",\n    \"includeAttachmentsWithOnlineInvoice\": true\n  },\n  \"invoiceReferenceFormula\": \"<string>\",\n  \"invoiceReferenceDateFormat\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "message": {
    "token": "<string>",
    "text": "<string>",
    "tokenArguments": [
      {
        "name": "<string>",
        "value": null
      }
    ],
    "textId": "<string>",
    "textParameters": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ]
  },
  "content": {
    "data": {
      "defaultRevenueAccount": "<string>",
      "defaultTaxRate": "<string>",
      "payElementMappings": [
        {
          "payElementId": "<string>",
          "accountCode": "<string>",
          "taxType": "<string>"
        }
      ],
      "defaultDueDateDays": 123,
      "defaultDueDateType": "DaysAfterInvoiceDate",
      "defaultCurrencyCode": "<string>",
      "defaultLineAmountTypes": "<string>",
      "invoiceTemplateOverride": {
        "showSubsectionHeader": true,
        "showSubtotalInSubsection": true,
        "showSubtotalVatInSubsection": true,
        "showQuantitySumInSubsection": true,
        "showBottomSubtotals": true,
        "showVatInBottomSubtotals": true,
        "showQuantitySumInBottomSubtotals": true,
        "lineItemSortOrder": "None",
        "lineDescriptionFormula": "<string>",
        "lineDescriptionTagGroupId": "<string>",
        "attachmentStrategy": "ExcessLost",
        "includeAttachmentsWithOnlineInvoice": true
      },
      "creditNoteTemplateOverride": {
        "showSubsectionHeader": true,
        "showSubtotalInSubsection": true,
        "showSubtotalVatInSubsection": true,
        "showQuantitySumInSubsection": true,
        "showBottomSubtotals": true,
        "showVatInBottomSubtotals": true,
        "showQuantitySumInBottomSubtotals": true,
        "lineItemSortOrder": "None",
        "lineDescriptionFormula": "<string>",
        "lineDescriptionTagGroupId": "<string>",
        "attachmentStrategy": "ExcessLost",
        "includeAttachmentsWithOnlineInvoice": true
      },
      "invoiceReferenceFormula": "<string>",
      "invoiceReferenceDateFormat": "<string>"
    },
    "metadata": {
      "dateFormat": "<string>",
      "dateTimeFormat": "<string>",
      "paginationToken": "<string>"
    }
  },
  "validationIssues": [
    {
      "field": "<string>",
      "reason": "<string>",
      "reasonToken": "<string>",
      "reasonTokenArguments": [
        {
          "name": "<string>",
          "value": null
        }
      ]
    }
  ],
  "errors": [
    {
      "field": "<string>",
      "reasonText": "<string>",
      "reasonId": "<string>",
      "reasonParameters": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "metadata": {
    "dateFormat": "<string>",
    "dateTimeFormat": "<string>",
    "paginationToken": "<string>"
  }
}

{
  "message": {
    "token": "<string>",
    "text": "<string>",
    "tokenArguments": [
      {
        "name": "<string>",
        "value": null
      }
    ],
    "textId": "<string>",
    "textParameters": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ]
  },
  "content": {
    "data": null,
    "metadata": {
      "dateFormat": "<string>",
      "dateTimeFormat": "<string>",
      "paginationToken": "<string>"
    }
  },
  "validationIssues": [
    {
      "field": "<string>",
      "reason": "<string>",
      "reasonToken": "<string>",
      "reasonTokenArguments": [
        {
          "name": "<string>",
          "value": null
        }
      ]
    }
  ],
  "errors": [
    {
      "field": "<string>",
      "reasonText": "<string>",
      "reasonId": "<string>",
      "reasonParameters": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "metadata": {
    "dateFormat": "<string>",
    "dateTimeFormat": "<string>",
    "paginationToken": "<string>"
  }
}

{
  "message": {
    "token": "<string>",
    "text": "<string>",
    "tokenArguments": [
      {
        "name": "<string>",
        "value": null
      }
    ],
    "textId": "<string>",
    "textParameters": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ]
  },
  "content": {
    "data": null,
    "metadata": {
      "dateFormat": "<string>",
      "dateTimeFormat": "<string>",
      "paginationToken": "<string>"
    }
  },
  "validationIssues": [
    {
      "field": "<string>",
      "reason": "<string>",
      "reasonToken": "<string>",
      "reasonTokenArguments": [
        {
          "name": "<string>",
          "value": null
        }
      ]
    }
  ],
  "errors": [
    {
      "field": "<string>",
      "reasonText": "<string>",
      "reasonId": "<string>",
      "reasonParameters": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "metadata": {
    "dateFormat": "<string>",
    "dateTimeFormat": "<string>",
    "paginationToken": "<string>"
  }
}

{
  "message": {
    "token": "<string>",
    "text": "<string>",
    "tokenArguments": [
      {
        "name": "<string>",
        "value": null
      }
    ],
    "textId": "<string>",
    "textParameters": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ]
  },
  "content": {
    "data": "<string>",
    "metadata": {
      "dateFormat": "<string>",
      "dateTimeFormat": "<string>",
      "paginationToken": "<string>"
    }
  },
  "validationIssues": [
    {
      "field": "<string>",
      "reason": "<string>",
      "reasonToken": "<string>",
      "reasonTokenArguments": [
        {
          "name": "<string>",
          "value": null
        }
      ]
    }
  ],
  "errors": [
    {
      "field": "<string>",
      "reasonText": "<string>",
      "reasonId": "<string>",
      "reasonParameters": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "metadata": {
    "dateFormat": "<string>",
    "dateTimeFormat": "<string>",
    "paginationToken": "<string>"
  }
}

{
  "message": {
    "token": "<string>",
    "text": "<string>",
    "tokenArguments": [
      {
        "name": "<string>",
        "value": null
      }
    ],
    "textId": "<string>",
    "textParameters": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ]
  },
  "content": {
    "data": "<string>",
    "metadata": {
      "dateFormat": "<string>",
      "dateTimeFormat": "<string>",
      "paginationToken": "<string>"
    }
  },
  "validationIssues": [
    {
      "field": "<string>",
      "reason": "<string>",
      "reasonToken": "<string>",
      "reasonTokenArguments": [
        {
          "name": "<string>",
          "value": null
        }
      ]
    }
  ],
  "errors": [
    {
      "field": "<string>",
      "reasonText": "<string>",
      "reasonId": "<string>",
      "reasonParameters": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "metadata": {
    "dateFormat": "<string>",
    "dateTimeFormat": "<string>",
    "paginationToken": "<string>"
  }
}

Overview

Administration API

Email Wording API

Authentication API

Billing

Court orders

HMRC DPS

HMRC P-forms

Holiday & leave

Integrations

Pay API

Payment

Payroll journals

Pensions

Recurring line items

Reports

Salary

Statutory pay

Webhooks

Update Client Finance Settings

Authorizations

Path Parameters

Body

Response