Finance Settings

Update organisation invoice template

Updates organisation-level invoice template (global default). Request body uses boolean flags for grouping: show subsection header, show subtotal in subsection, show VAT and quantity total in subsection and in bottom subtotals; line description formula with placeholders from GET line-item-description-fields (use returned id in curly braces); optional lineDescriptionTagGroupId when formula uses a placeholder with requiresTagGroup; attachment strategy.

PUT

finance

invoice-template

curl --request PUT \
  --url https://api.sandbox.flowpayroll.ai/v1/billing/finance/invoice-template \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: <api-key>' \
  --data '
{
  "showSubsectionHeader": true,
  "showSubtotalInSubsection": true,
  "showSubtotalVatInSubsection": true,
  "showQuantitySumInSubsection": true,
  "showBottomSubtotals": true,
  "showVatInBottomSubtotals": true,
  "showQuantitySumInBottomSubtotals": true,
  "lineDescriptionFormula": "<string>",
  "lineDescriptionTagGroupId": "<string>",
  "includeAttachmentsWithOnlineInvoice": true
}
'

{
  "content": {
    "data": {
      "showSubsectionHeader": true,
      "showSubtotalInSubsection": true,
      "showSubtotalVatInSubsection": true,
      "showQuantitySumInSubsection": true,
      "showBottomSubtotals": true,
      "showVatInBottomSubtotals": true,
      "showQuantitySumInBottomSubtotals": true,
      "lineDescriptionFormula": "<string>",
      "lineDescriptionTagGroupId": "<string>",
      "includeAttachmentsWithOnlineInvoice": true
    },
    "metadata": {
      "dateFormat": "<string>",
      "dateTimeFormat": "<string>"
    }
  },
  "metadata": {
    "dateFormat": "<string>",
    "dateTimeFormat": "<string>"
  },
  "errors": [
    {
      "field": "<string>",
      "reasonText": "<string>",
      "reasonId": "<string>",
      "reasonParameters": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "message": {
    "text": "<string>",
    "textId": "<string>",
    "textParameters": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ]
  }
}

Authorizations

X-Auth-Token

string

header

required

Authentication token for API access

Body

application/json

showSubsectionHeader

boolean

showSubtotalInSubsection

boolean

showSubtotalVatInSubsection

boolean

showQuantitySumInSubsection

boolean

showBottomSubtotals

boolean

showVatInBottomSubtotals

boolean

showQuantitySumInBottomSubtotals

boolean

lineItemSortOrder

enum<string>

Available options:

None,

ByEmployee,

ByPayElementThenEmployee

lineDescriptionFormula

string | null

attachmentStrategy

enum<string>

Available options:

ExcessLost,

MergeOnIntegration

includeAttachmentsWithOnlineInvoice

boolean

Response

content

object

Show child attributes

metadata

object

Show child attributes

errors

object[] | null

Show child attributes

message

object

Show child attributes

Get organisation invoice template

Get organisation credit note template

⌘I

Update organisation invoice template

curl --request PUT \
  --url https://api.sandbox.flowpayroll.ai/v1/billing/finance/invoice-template \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: <api-key>' \
  --data '
{
  "showSubsectionHeader": true,
  "showSubtotalInSubsection": true,
  "showSubtotalVatInSubsection": true,
  "showQuantitySumInSubsection": true,
  "showBottomSubtotals": true,
  "showVatInBottomSubtotals": true,
  "showQuantitySumInBottomSubtotals": true,
  "lineDescriptionFormula": "<string>",
  "lineDescriptionTagGroupId": "<string>",
  "includeAttachmentsWithOnlineInvoice": true
}
'

{
  "content": {
    "data": {
      "showSubsectionHeader": true,
      "showSubtotalInSubsection": true,
      "showSubtotalVatInSubsection": true,
      "showQuantitySumInSubsection": true,
      "showBottomSubtotals": true,
      "showVatInBottomSubtotals": true,
      "showQuantitySumInBottomSubtotals": true,
      "lineDescriptionFormula": "<string>",
      "lineDescriptionTagGroupId": "<string>",
      "includeAttachmentsWithOnlineInvoice": true
    },
    "metadata": {
      "dateFormat": "<string>",
      "dateTimeFormat": "<string>"
    }
  },
  "metadata": {
    "dateFormat": "<string>",
    "dateTimeFormat": "<string>"
  },
  "errors": [
    {
      "field": "<string>",
      "reasonText": "<string>",
      "reasonId": "<string>",
      "reasonParameters": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "message": {
    "text": "<string>",
    "textId": "<string>",
    "textParameters": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ]
  }
}

Documentation Index

Authorizations

Body

Response