Skip to main content
POST
/
clients
Create Client
curl --request POST \
  --url https://api.sandbox.flowpayroll.ai/v1/billing/clients \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: <api-key>' \
  --data '
{
  "typeDiscriminator": "<string>",
  "name": "<string>",
  "id": "<string>",
  "invoiceFormatTagGroup": "<string>",
  "invoiceFormatTagName": "<string>",
  "invoiceNumberTagGroup": "<string>",
  "invoiceNumberTagName": "<string>",
  "subtotalTagGroupName": "<string>",
  "rebatePercentage": 123,
  "vatNumber": "<string>",
  "registrationNumber": "<string>",
  "contacts": [
    {
      "firstName": "<string>",
      "lastName": "<string>",
      "email": "<string>",
      "id": "<string>",
      "phone": "<string>",
      "role": "<string>",
      "tags": [
        {
          "name": "<string>",
          "group": "<string>",
          "value": "<string>"
        }
      ],
      "includeInEmails": true
    }
  ],
  "tags": [
    {
      "name": "<string>",
      "group": "<string>",
      "value": "<string>"
    }
  ],
  "defaultRevenueAccountCode": "<string>",
  "defaultTaxType": "<string>",
  "providerId": "<string>",
  "externalProvider": "<string>",
  "lastSyncedAt": "<string>",
  "syncErrorMessage": "<string>",
  "billingAddress": {
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "county": "<string>",
    "postcode": "<string>",
    "countryCode": "<string>"
  },
  "physicalAddress": {
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "county": "<string>",
    "postcode": "<string>",
    "countryCode": "<string>"
  }
}
'
{
  "content": {
    "data": {
      "typeDiscriminator": "<string>",
      "name": "<string>",
      "organisationId": "<string>",
      "createdDate": "<string>",
      "createdBy": "<string>",
      "updatedDate": "<string>",
      "updatedBy": "<string>",
      "id": "<string>",
      "invoiceFormatTagGroup": "<string>",
      "invoiceFormatTagName": "<string>",
      "invoiceNumberTagGroup": "<string>",
      "invoiceNumberTagName": "<string>",
      "subtotalTagGroupName": "<string>",
      "rebatePercentage": 123,
      "vatNumber": "<string>",
      "registrationNumber": "<string>",
      "contacts": [
        {
          "firstName": "<string>",
          "lastName": "<string>",
          "email": "<string>",
          "id": "<string>",
          "phone": "<string>",
          "role": "<string>",
          "tags": [
            {
              "name": "<string>",
              "group": "<string>",
              "value": "<string>"
            }
          ],
          "includeInEmails": true
        }
      ],
      "tags": [
        {
          "name": "<string>",
          "group": "<string>",
          "value": "<string>"
        }
      ],
      "defaultRevenueAccountCode": "<string>",
      "defaultTaxType": "<string>",
      "providerId": "<string>",
      "externalProvider": "<string>",
      "lastSyncedAt": "<string>",
      "syncErrorMessage": "<string>",
      "billingAddress": {
        "line1": "<string>",
        "line2": "<string>",
        "city": "<string>",
        "county": "<string>",
        "postcode": "<string>",
        "countryCode": "<string>"
      },
      "physicalAddress": {
        "line1": "<string>",
        "line2": "<string>",
        "city": "<string>",
        "county": "<string>",
        "postcode": "<string>",
        "countryCode": "<string>"
      },
      "financeSettings": {
        "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>"
      }
    },
    "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

Fetch the complete documentation index at: https://docs.flowpayroll.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-Auth-Token
string
header
required

Authentication token for API access

Body

application/json
​
typeDiscriminator
string
required
​
name
string
required
​
id
string
​
poRequirement
enum<string>
Available options:
None,
Warning,
Required
​
attachmentRequirement
enum<string>
Available options:
None,
Warning,
Required
​
invoiceFormat
enum<string>
Available options:
None,
Date,
PayElementId,
PoNumber,
TagGroup,
PayrollConfigId
​
invoiceFormatTagGroup
string | null
​
invoiceFormatTagName
string | null
​
invoiceNumberFormat
enum<string>
Available options:
None,
TagLookup
​
invoiceNumberTagGroup
string | null
​
invoiceNumberTagName
string | null
​
subtotalGroupBy
enum<string>
Available options:
None,
PayElement,
TagGroup
​
subtotalTagGroupName
string | null
​
rebatePercentage
number<double> | null
​
vatNumber
string | null
​
registrationNumber
string | null
​
contacts
object[] | null
​
tags
object[] | null
​
status
enum<string>
Available options:
Active,
Archived
​
defaultRevenueAccountCode
string | null
​
defaultTaxType
string | null
​
providerId
string | null
​
externalProvider
string | null
​
syncStatus
enum<string> | null
Available options:
NotSynced,
Synced,
SyncFailed,
Pending
​
lastSyncedAt
string | null
​
syncErrorMessage
string | null
​
billingAddress
object
​
physicalAddress
object

Response

Created

​
content
object
​
metadata
object
​
errors
object[] | null
​
message
object