Clients
Create Client
Creates a new client. When the organisation has finance defaults set (default revenue account and default tax), defaultRevenueAccountCode and defaultTaxType may be omitted and are auto-filled from org defaults; otherwise both fields are required.
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>"
}
}
'import requests
url = "https://api.sandbox.flowpayroll.ai/v1/billing/clients"
payload = {
"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>"
}
}
headers = {
"X-Auth-Token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Auth-Token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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>'
}
})
};
fetch('https://api.sandbox.flowpayroll.ai/v1/billing/clients', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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>'
]
]),
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"
payload := strings.NewReader("{\n \"typeDiscriminator\": \"<string>\",\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"invoiceFormatTagGroup\": \"<string>\",\n \"invoiceFormatTagName\": \"<string>\",\n \"invoiceNumberTagGroup\": \"<string>\",\n \"invoiceNumberTagName\": \"<string>\",\n \"subtotalTagGroupName\": \"<string>\",\n \"rebatePercentage\": 123,\n \"vatNumber\": \"<string>\",\n \"registrationNumber\": \"<string>\",\n \"contacts\": [\n {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"id\": \"<string>\",\n \"phone\": \"<string>\",\n \"role\": \"<string>\",\n \"tags\": [\n {\n \"name\": \"<string>\",\n \"group\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"includeInEmails\": true\n }\n ],\n \"tags\": [\n {\n \"name\": \"<string>\",\n \"group\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"defaultRevenueAccountCode\": \"<string>\",\n \"defaultTaxType\": \"<string>\",\n \"providerId\": \"<string>\",\n \"externalProvider\": \"<string>\",\n \"lastSyncedAt\": \"<string>\",\n \"syncErrorMessage\": \"<string>\",\n \"billingAddress\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"county\": \"<string>\",\n \"postcode\": \"<string>\",\n \"countryCode\": \"<string>\"\n },\n \"physicalAddress\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"county\": \"<string>\",\n \"postcode\": \"<string>\",\n \"countryCode\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.sandbox.flowpayroll.ai/v1/billing/clients")
.header("X-Auth-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"typeDiscriminator\": \"<string>\",\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"invoiceFormatTagGroup\": \"<string>\",\n \"invoiceFormatTagName\": \"<string>\",\n \"invoiceNumberTagGroup\": \"<string>\",\n \"invoiceNumberTagName\": \"<string>\",\n \"subtotalTagGroupName\": \"<string>\",\n \"rebatePercentage\": 123,\n \"vatNumber\": \"<string>\",\n \"registrationNumber\": \"<string>\",\n \"contacts\": [\n {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"id\": \"<string>\",\n \"phone\": \"<string>\",\n \"role\": \"<string>\",\n \"tags\": [\n {\n \"name\": \"<string>\",\n \"group\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"includeInEmails\": true\n }\n ],\n \"tags\": [\n {\n \"name\": \"<string>\",\n \"group\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"defaultRevenueAccountCode\": \"<string>\",\n \"defaultTaxType\": \"<string>\",\n \"providerId\": \"<string>\",\n \"externalProvider\": \"<string>\",\n \"lastSyncedAt\": \"<string>\",\n \"syncErrorMessage\": \"<string>\",\n \"billingAddress\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"county\": \"<string>\",\n \"postcode\": \"<string>\",\n \"countryCode\": \"<string>\"\n },\n \"physicalAddress\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"county\": \"<string>\",\n \"postcode\": \"<string>\",\n \"countryCode\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.flowpayroll.ai/v1/billing/clients")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Auth-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"typeDiscriminator\": \"<string>\",\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"invoiceFormatTagGroup\": \"<string>\",\n \"invoiceFormatTagName\": \"<string>\",\n \"invoiceNumberTagGroup\": \"<string>\",\n \"invoiceNumberTagName\": \"<string>\",\n \"subtotalTagGroupName\": \"<string>\",\n \"rebatePercentage\": 123,\n \"vatNumber\": \"<string>\",\n \"registrationNumber\": \"<string>\",\n \"contacts\": [\n {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"id\": \"<string>\",\n \"phone\": \"<string>\",\n \"role\": \"<string>\",\n \"tags\": [\n {\n \"name\": \"<string>\",\n \"group\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"includeInEmails\": true\n }\n ],\n \"tags\": [\n {\n \"name\": \"<string>\",\n \"group\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"defaultRevenueAccountCode\": \"<string>\",\n \"defaultTaxType\": \"<string>\",\n \"providerId\": \"<string>\",\n \"externalProvider\": \"<string>\",\n \"lastSyncedAt\": \"<string>\",\n \"syncErrorMessage\": \"<string>\",\n \"billingAddress\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"county\": \"<string>\",\n \"postcode\": \"<string>\",\n \"countryCode\": \"<string>\"\n },\n \"physicalAddress\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"county\": \"<string>\",\n \"postcode\": \"<string>\",\n \"countryCode\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"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>"
}
]
}
}{
"content": {
"data": null,
"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>"
}
]
}
}{
"content": {
"data": null,
"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
Authentication token for API access
Body
application/json
- Option 1
- Option 2
- Option 3
Available options:
None, Warning, Required Available options:
None, Warning, Required Available options:
None, Date, PayElementId, PoNumber, TagGroup, PayrollConfigId Available options:
None, TagLookup Available options:
None, PayElement, TagGroup Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
Active, Archived Available options:
NotSynced, Synced, SyncFailed, Pending Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?
⌘I
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>"
}
}
'import requests
url = "https://api.sandbox.flowpayroll.ai/v1/billing/clients"
payload = {
"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>"
}
}
headers = {
"X-Auth-Token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Auth-Token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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>'
}
})
};
fetch('https://api.sandbox.flowpayroll.ai/v1/billing/clients', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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>'
]
]),
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"
payload := strings.NewReader("{\n \"typeDiscriminator\": \"<string>\",\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"invoiceFormatTagGroup\": \"<string>\",\n \"invoiceFormatTagName\": \"<string>\",\n \"invoiceNumberTagGroup\": \"<string>\",\n \"invoiceNumberTagName\": \"<string>\",\n \"subtotalTagGroupName\": \"<string>\",\n \"rebatePercentage\": 123,\n \"vatNumber\": \"<string>\",\n \"registrationNumber\": \"<string>\",\n \"contacts\": [\n {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"id\": \"<string>\",\n \"phone\": \"<string>\",\n \"role\": \"<string>\",\n \"tags\": [\n {\n \"name\": \"<string>\",\n \"group\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"includeInEmails\": true\n }\n ],\n \"tags\": [\n {\n \"name\": \"<string>\",\n \"group\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"defaultRevenueAccountCode\": \"<string>\",\n \"defaultTaxType\": \"<string>\",\n \"providerId\": \"<string>\",\n \"externalProvider\": \"<string>\",\n \"lastSyncedAt\": \"<string>\",\n \"syncErrorMessage\": \"<string>\",\n \"billingAddress\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"county\": \"<string>\",\n \"postcode\": \"<string>\",\n \"countryCode\": \"<string>\"\n },\n \"physicalAddress\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"county\": \"<string>\",\n \"postcode\": \"<string>\",\n \"countryCode\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.sandbox.flowpayroll.ai/v1/billing/clients")
.header("X-Auth-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"typeDiscriminator\": \"<string>\",\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"invoiceFormatTagGroup\": \"<string>\",\n \"invoiceFormatTagName\": \"<string>\",\n \"invoiceNumberTagGroup\": \"<string>\",\n \"invoiceNumberTagName\": \"<string>\",\n \"subtotalTagGroupName\": \"<string>\",\n \"rebatePercentage\": 123,\n \"vatNumber\": \"<string>\",\n \"registrationNumber\": \"<string>\",\n \"contacts\": [\n {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"id\": \"<string>\",\n \"phone\": \"<string>\",\n \"role\": \"<string>\",\n \"tags\": [\n {\n \"name\": \"<string>\",\n \"group\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"includeInEmails\": true\n }\n ],\n \"tags\": [\n {\n \"name\": \"<string>\",\n \"group\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"defaultRevenueAccountCode\": \"<string>\",\n \"defaultTaxType\": \"<string>\",\n \"providerId\": \"<string>\",\n \"externalProvider\": \"<string>\",\n \"lastSyncedAt\": \"<string>\",\n \"syncErrorMessage\": \"<string>\",\n \"billingAddress\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"county\": \"<string>\",\n \"postcode\": \"<string>\",\n \"countryCode\": \"<string>\"\n },\n \"physicalAddress\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"county\": \"<string>\",\n \"postcode\": \"<string>\",\n \"countryCode\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.flowpayroll.ai/v1/billing/clients")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Auth-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"typeDiscriminator\": \"<string>\",\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"invoiceFormatTagGroup\": \"<string>\",\n \"invoiceFormatTagName\": \"<string>\",\n \"invoiceNumberTagGroup\": \"<string>\",\n \"invoiceNumberTagName\": \"<string>\",\n \"subtotalTagGroupName\": \"<string>\",\n \"rebatePercentage\": 123,\n \"vatNumber\": \"<string>\",\n \"registrationNumber\": \"<string>\",\n \"contacts\": [\n {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"id\": \"<string>\",\n \"phone\": \"<string>\",\n \"role\": \"<string>\",\n \"tags\": [\n {\n \"name\": \"<string>\",\n \"group\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"includeInEmails\": true\n }\n ],\n \"tags\": [\n {\n \"name\": \"<string>\",\n \"group\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"defaultRevenueAccountCode\": \"<string>\",\n \"defaultTaxType\": \"<string>\",\n \"providerId\": \"<string>\",\n \"externalProvider\": \"<string>\",\n \"lastSyncedAt\": \"<string>\",\n \"syncErrorMessage\": \"<string>\",\n \"billingAddress\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"county\": \"<string>\",\n \"postcode\": \"<string>\",\n \"countryCode\": \"<string>\"\n },\n \"physicalAddress\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"county\": \"<string>\",\n \"postcode\": \"<string>\",\n \"countryCode\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"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>"
}
]
}
}{
"content": {
"data": null,
"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>"
}
]
}
}{
"content": {
"data": null,
"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>"
}
]
}
}