Organisations
Add several organisations at once
State the shared details once in defaults; any entry may override any of them. Leave a field out of an entry to inherit the default, or set it to override — an address set on an entry replaces the default address as a whole rather than merging field by field.
Every organisation is created exactly as POST /organisations creates one. One Idempotency-Key covers the whole batch and each entry claims under it by position, so retrying a partly successful batch finds the organisations it already made instead of making them again. Resend the batch unchanged: entries added, removed or reordered make it a different request, which answers 409 idempotency_key_reused.
201 when every entry went through, 207 when some did, 400 when none did. In all three the body lists what happened to each entry. An organisation in created can still be incomplete — its own complete and outstandingSteps say so.
403 billing_not_set_up when billing is not set up for the account yet — email hello@flowpayroll.ai to agree pricing and set it up. Accounts onboarded by Flow Payroll are already set up.
POST
/
organisations
/
bulk
Add several organisations at once
curl --request POST \
--url https://api.sandbox.flowpayroll.ai/v1/administration/organisations/bulk \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: <api-key>' \
--data '
{
"defaults": {
"registeredOfficeAddress": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"county": "<string>",
"postcode": "<string>",
"countryCode": "<string>"
},
"correspondenceAddress": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"county": "<string>",
"postcode": "<string>",
"countryCode": "<string>"
},
"primaryContactDetails": {
"name": "<string>",
"email": "<string>",
"phone": "<string>"
},
"companyContactDetails": {
"name": "<string>",
"email": "<string>",
"phone": "<string>"
}
},
"entries": [
{
"legalName": "<string>",
"tradingName": "<string>",
"companyRegistrationNumber": "<string>",
"registeredOfficeAddress": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"county": "<string>",
"postcode": "<string>",
"countryCode": "<string>"
},
"correspondenceAddress": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"county": "<string>",
"postcode": "<string>",
"countryCode": "<string>"
},
"primaryContactDetails": {
"name": "<string>",
"email": "<string>",
"phone": "<string>"
},
"companyContactDetails": {
"name": "<string>",
"email": "<string>",
"phone": "<string>"
}
}
]
}
'import requests
url = "https://api.sandbox.flowpayroll.ai/v1/administration/organisations/bulk"
payload = {
"defaults": {
"registeredOfficeAddress": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"county": "<string>",
"postcode": "<string>",
"countryCode": "<string>"
},
"correspondenceAddress": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"county": "<string>",
"postcode": "<string>",
"countryCode": "<string>"
},
"primaryContactDetails": {
"name": "<string>",
"email": "<string>",
"phone": "<string>"
},
"companyContactDetails": {
"name": "<string>",
"email": "<string>",
"phone": "<string>"
}
},
"entries": [
{
"legalName": "<string>",
"tradingName": "<string>",
"companyRegistrationNumber": "<string>",
"registeredOfficeAddress": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"county": "<string>",
"postcode": "<string>",
"countryCode": "<string>"
},
"correspondenceAddress": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"county": "<string>",
"postcode": "<string>",
"countryCode": "<string>"
},
"primaryContactDetails": {
"name": "<string>",
"email": "<string>",
"phone": "<string>"
},
"companyContactDetails": {
"name": "<string>",
"email": "<string>",
"phone": "<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({
defaults: {
registeredOfficeAddress: {
line1: '<string>',
line2: '<string>',
city: '<string>',
county: '<string>',
postcode: '<string>',
countryCode: '<string>'
},
correspondenceAddress: {
line1: '<string>',
line2: '<string>',
city: '<string>',
county: '<string>',
postcode: '<string>',
countryCode: '<string>'
},
primaryContactDetails: {name: '<string>', email: '<string>', phone: '<string>'},
companyContactDetails: {name: '<string>', email: '<string>', phone: '<string>'}
},
entries: [
{
legalName: '<string>',
tradingName: '<string>',
companyRegistrationNumber: '<string>',
registeredOfficeAddress: {
line1: '<string>',
line2: '<string>',
city: '<string>',
county: '<string>',
postcode: '<string>',
countryCode: '<string>'
},
correspondenceAddress: {
line1: '<string>',
line2: '<string>',
city: '<string>',
county: '<string>',
postcode: '<string>',
countryCode: '<string>'
},
primaryContactDetails: {name: '<string>', email: '<string>', phone: '<string>'},
companyContactDetails: {name: '<string>', email: '<string>', phone: '<string>'}
}
]
})
};
fetch('https://api.sandbox.flowpayroll.ai/v1/administration/organisations/bulk', 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/administration/organisations/bulk",
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([
'defaults' => [
'registeredOfficeAddress' => [
'line1' => '<string>',
'line2' => '<string>',
'city' => '<string>',
'county' => '<string>',
'postcode' => '<string>',
'countryCode' => '<string>'
],
'correspondenceAddress' => [
'line1' => '<string>',
'line2' => '<string>',
'city' => '<string>',
'county' => '<string>',
'postcode' => '<string>',
'countryCode' => '<string>'
],
'primaryContactDetails' => [
'name' => '<string>',
'email' => '<string>',
'phone' => '<string>'
],
'companyContactDetails' => [
'name' => '<string>',
'email' => '<string>',
'phone' => '<string>'
]
],
'entries' => [
[
'legalName' => '<string>',
'tradingName' => '<string>',
'companyRegistrationNumber' => '<string>',
'registeredOfficeAddress' => [
'line1' => '<string>',
'line2' => '<string>',
'city' => '<string>',
'county' => '<string>',
'postcode' => '<string>',
'countryCode' => '<string>'
],
'correspondenceAddress' => [
'line1' => '<string>',
'line2' => '<string>',
'city' => '<string>',
'county' => '<string>',
'postcode' => '<string>',
'countryCode' => '<string>'
],
'primaryContactDetails' => [
'name' => '<string>',
'email' => '<string>',
'phone' => '<string>'
],
'companyContactDetails' => [
'name' => '<string>',
'email' => '<string>',
'phone' => '<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/administration/organisations/bulk"
payload := strings.NewReader("{\n \"defaults\": {\n \"registeredOfficeAddress\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"county\": \"<string>\",\n \"postcode\": \"<string>\",\n \"countryCode\": \"<string>\"\n },\n \"correspondenceAddress\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"county\": \"<string>\",\n \"postcode\": \"<string>\",\n \"countryCode\": \"<string>\"\n },\n \"primaryContactDetails\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"companyContactDetails\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\"\n }\n },\n \"entries\": [\n {\n \"legalName\": \"<string>\",\n \"tradingName\": \"<string>\",\n \"companyRegistrationNumber\": \"<string>\",\n \"registeredOfficeAddress\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"county\": \"<string>\",\n \"postcode\": \"<string>\",\n \"countryCode\": \"<string>\"\n },\n \"correspondenceAddress\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"county\": \"<string>\",\n \"postcode\": \"<string>\",\n \"countryCode\": \"<string>\"\n },\n \"primaryContactDetails\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"companyContactDetails\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\"\n }\n }\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/administration/organisations/bulk")
.header("X-Auth-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"defaults\": {\n \"registeredOfficeAddress\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"county\": \"<string>\",\n \"postcode\": \"<string>\",\n \"countryCode\": \"<string>\"\n },\n \"correspondenceAddress\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"county\": \"<string>\",\n \"postcode\": \"<string>\",\n \"countryCode\": \"<string>\"\n },\n \"primaryContactDetails\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"companyContactDetails\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\"\n }\n },\n \"entries\": [\n {\n \"legalName\": \"<string>\",\n \"tradingName\": \"<string>\",\n \"companyRegistrationNumber\": \"<string>\",\n \"registeredOfficeAddress\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"county\": \"<string>\",\n \"postcode\": \"<string>\",\n \"countryCode\": \"<string>\"\n },\n \"correspondenceAddress\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"county\": \"<string>\",\n \"postcode\": \"<string>\",\n \"countryCode\": \"<string>\"\n },\n \"primaryContactDetails\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"companyContactDetails\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\"\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.flowpayroll.ai/v1/administration/organisations/bulk")
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 \"defaults\": {\n \"registeredOfficeAddress\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"county\": \"<string>\",\n \"postcode\": \"<string>\",\n \"countryCode\": \"<string>\"\n },\n \"correspondenceAddress\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"county\": \"<string>\",\n \"postcode\": \"<string>\",\n \"countryCode\": \"<string>\"\n },\n \"primaryContactDetails\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"companyContactDetails\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\"\n }\n },\n \"entries\": [\n {\n \"legalName\": \"<string>\",\n \"tradingName\": \"<string>\",\n \"companyRegistrationNumber\": \"<string>\",\n \"registeredOfficeAddress\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"county\": \"<string>\",\n \"postcode\": \"<string>\",\n \"countryCode\": \"<string>\"\n },\n \"correspondenceAddress\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"county\": \"<string>\",\n \"postcode\": \"<string>\",\n \"countryCode\": \"<string>\"\n },\n \"primaryContactDetails\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"companyContactDetails\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\"\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": null
}
]
},
"content": {
"data": {
"created": [
{
"organisationId": "<string>",
"complete": true,
"completedSteps": [
"<string>"
],
"outstandingSteps": [
"<string>"
]
}
],
"failed": [
{
"reference": "<string>",
"reason": "<string>",
"message": "<string>"
}
]
},
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": null
}
]
}
]
}{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": null
}
]
},
"content": {
"data": {
"created": [
{
"organisationId": "<string>",
"complete": true,
"completedSteps": [
"<string>"
],
"outstandingSteps": [
"<string>"
]
}
],
"failed": [
{
"reference": "<string>",
"reason": "<string>",
"message": "<string>"
}
]
},
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": null
}
]
}
]
}{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": null
}
]
},
"content": {
"data": {
"created": [
{
"organisationId": "<string>",
"complete": true,
"completedSteps": [
"<string>"
],
"outstandingSteps": [
"<string>"
]
}
],
"failed": [
{
"reference": "<string>",
"reason": "<string>",
"message": "<string>"
}
]
},
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": null
}
]
}
]
}{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": null
}
]
},
"content": {
"data": null,
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": null
}
]
}
]
}{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": null
}
]
},
"content": {
"data": null,
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": null
}
]
}
]
}{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": null
}
]
},
"content": {
"data": null,
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": null
}
]
}
]
}Authorizations
FlowPayroll JWT (raw token, no Bearer prefix)
Headers
Your own key for this create, so a retry after a lost response finds what the first attempt made instead of making a second one. Any unique string up to 255 characters; a UUID is the usual choice. Send the same value on every retry of the same request, and a new value for a new one — reusing a key for a different body answers 409 idempotency_key_reused. Keys are remembered for 24 hours. Optional, and a request without one simply has no replay protection.
Maximum string length:
255Body
application/json
Adds several organisations to your account in one request: shared defaults plus per-entry overrides.
What every organisation in the request gets unless its own entry says otherwise.
Show child attributes
Show child attributes
The organisations to create, each processed exactly as POST /organisations would process it.
One Idempotency-Key covers the whole batch, and each entry claims under it by position.
Show child attributes
Show child attributes
Was this page helpful?
⌘I
Add several organisations at once
curl --request POST \
--url https://api.sandbox.flowpayroll.ai/v1/administration/organisations/bulk \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: <api-key>' \
--data '
{
"defaults": {
"registeredOfficeAddress": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"county": "<string>",
"postcode": "<string>",
"countryCode": "<string>"
},
"correspondenceAddress": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"county": "<string>",
"postcode": "<string>",
"countryCode": "<string>"
},
"primaryContactDetails": {
"name": "<string>",
"email": "<string>",
"phone": "<string>"
},
"companyContactDetails": {
"name": "<string>",
"email": "<string>",
"phone": "<string>"
}
},
"entries": [
{
"legalName": "<string>",
"tradingName": "<string>",
"companyRegistrationNumber": "<string>",
"registeredOfficeAddress": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"county": "<string>",
"postcode": "<string>",
"countryCode": "<string>"
},
"correspondenceAddress": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"county": "<string>",
"postcode": "<string>",
"countryCode": "<string>"
},
"primaryContactDetails": {
"name": "<string>",
"email": "<string>",
"phone": "<string>"
},
"companyContactDetails": {
"name": "<string>",
"email": "<string>",
"phone": "<string>"
}
}
]
}
'import requests
url = "https://api.sandbox.flowpayroll.ai/v1/administration/organisations/bulk"
payload = {
"defaults": {
"registeredOfficeAddress": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"county": "<string>",
"postcode": "<string>",
"countryCode": "<string>"
},
"correspondenceAddress": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"county": "<string>",
"postcode": "<string>",
"countryCode": "<string>"
},
"primaryContactDetails": {
"name": "<string>",
"email": "<string>",
"phone": "<string>"
},
"companyContactDetails": {
"name": "<string>",
"email": "<string>",
"phone": "<string>"
}
},
"entries": [
{
"legalName": "<string>",
"tradingName": "<string>",
"companyRegistrationNumber": "<string>",
"registeredOfficeAddress": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"county": "<string>",
"postcode": "<string>",
"countryCode": "<string>"
},
"correspondenceAddress": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"county": "<string>",
"postcode": "<string>",
"countryCode": "<string>"
},
"primaryContactDetails": {
"name": "<string>",
"email": "<string>",
"phone": "<string>"
},
"companyContactDetails": {
"name": "<string>",
"email": "<string>",
"phone": "<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({
defaults: {
registeredOfficeAddress: {
line1: '<string>',
line2: '<string>',
city: '<string>',
county: '<string>',
postcode: '<string>',
countryCode: '<string>'
},
correspondenceAddress: {
line1: '<string>',
line2: '<string>',
city: '<string>',
county: '<string>',
postcode: '<string>',
countryCode: '<string>'
},
primaryContactDetails: {name: '<string>', email: '<string>', phone: '<string>'},
companyContactDetails: {name: '<string>', email: '<string>', phone: '<string>'}
},
entries: [
{
legalName: '<string>',
tradingName: '<string>',
companyRegistrationNumber: '<string>',
registeredOfficeAddress: {
line1: '<string>',
line2: '<string>',
city: '<string>',
county: '<string>',
postcode: '<string>',
countryCode: '<string>'
},
correspondenceAddress: {
line1: '<string>',
line2: '<string>',
city: '<string>',
county: '<string>',
postcode: '<string>',
countryCode: '<string>'
},
primaryContactDetails: {name: '<string>', email: '<string>', phone: '<string>'},
companyContactDetails: {name: '<string>', email: '<string>', phone: '<string>'}
}
]
})
};
fetch('https://api.sandbox.flowpayroll.ai/v1/administration/organisations/bulk', 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/administration/organisations/bulk",
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([
'defaults' => [
'registeredOfficeAddress' => [
'line1' => '<string>',
'line2' => '<string>',
'city' => '<string>',
'county' => '<string>',
'postcode' => '<string>',
'countryCode' => '<string>'
],
'correspondenceAddress' => [
'line1' => '<string>',
'line2' => '<string>',
'city' => '<string>',
'county' => '<string>',
'postcode' => '<string>',
'countryCode' => '<string>'
],
'primaryContactDetails' => [
'name' => '<string>',
'email' => '<string>',
'phone' => '<string>'
],
'companyContactDetails' => [
'name' => '<string>',
'email' => '<string>',
'phone' => '<string>'
]
],
'entries' => [
[
'legalName' => '<string>',
'tradingName' => '<string>',
'companyRegistrationNumber' => '<string>',
'registeredOfficeAddress' => [
'line1' => '<string>',
'line2' => '<string>',
'city' => '<string>',
'county' => '<string>',
'postcode' => '<string>',
'countryCode' => '<string>'
],
'correspondenceAddress' => [
'line1' => '<string>',
'line2' => '<string>',
'city' => '<string>',
'county' => '<string>',
'postcode' => '<string>',
'countryCode' => '<string>'
],
'primaryContactDetails' => [
'name' => '<string>',
'email' => '<string>',
'phone' => '<string>'
],
'companyContactDetails' => [
'name' => '<string>',
'email' => '<string>',
'phone' => '<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/administration/organisations/bulk"
payload := strings.NewReader("{\n \"defaults\": {\n \"registeredOfficeAddress\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"county\": \"<string>\",\n \"postcode\": \"<string>\",\n \"countryCode\": \"<string>\"\n },\n \"correspondenceAddress\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"county\": \"<string>\",\n \"postcode\": \"<string>\",\n \"countryCode\": \"<string>\"\n },\n \"primaryContactDetails\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"companyContactDetails\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\"\n }\n },\n \"entries\": [\n {\n \"legalName\": \"<string>\",\n \"tradingName\": \"<string>\",\n \"companyRegistrationNumber\": \"<string>\",\n \"registeredOfficeAddress\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"county\": \"<string>\",\n \"postcode\": \"<string>\",\n \"countryCode\": \"<string>\"\n },\n \"correspondenceAddress\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"county\": \"<string>\",\n \"postcode\": \"<string>\",\n \"countryCode\": \"<string>\"\n },\n \"primaryContactDetails\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"companyContactDetails\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\"\n }\n }\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/administration/organisations/bulk")
.header("X-Auth-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"defaults\": {\n \"registeredOfficeAddress\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"county\": \"<string>\",\n \"postcode\": \"<string>\",\n \"countryCode\": \"<string>\"\n },\n \"correspondenceAddress\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"county\": \"<string>\",\n \"postcode\": \"<string>\",\n \"countryCode\": \"<string>\"\n },\n \"primaryContactDetails\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"companyContactDetails\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\"\n }\n },\n \"entries\": [\n {\n \"legalName\": \"<string>\",\n \"tradingName\": \"<string>\",\n \"companyRegistrationNumber\": \"<string>\",\n \"registeredOfficeAddress\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"county\": \"<string>\",\n \"postcode\": \"<string>\",\n \"countryCode\": \"<string>\"\n },\n \"correspondenceAddress\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"county\": \"<string>\",\n \"postcode\": \"<string>\",\n \"countryCode\": \"<string>\"\n },\n \"primaryContactDetails\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"companyContactDetails\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\"\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.flowpayroll.ai/v1/administration/organisations/bulk")
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 \"defaults\": {\n \"registeredOfficeAddress\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"county\": \"<string>\",\n \"postcode\": \"<string>\",\n \"countryCode\": \"<string>\"\n },\n \"correspondenceAddress\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"county\": \"<string>\",\n \"postcode\": \"<string>\",\n \"countryCode\": \"<string>\"\n },\n \"primaryContactDetails\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"companyContactDetails\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\"\n }\n },\n \"entries\": [\n {\n \"legalName\": \"<string>\",\n \"tradingName\": \"<string>\",\n \"companyRegistrationNumber\": \"<string>\",\n \"registeredOfficeAddress\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"county\": \"<string>\",\n \"postcode\": \"<string>\",\n \"countryCode\": \"<string>\"\n },\n \"correspondenceAddress\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"county\": \"<string>\",\n \"postcode\": \"<string>\",\n \"countryCode\": \"<string>\"\n },\n \"primaryContactDetails\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"companyContactDetails\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\"\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": null
}
]
},
"content": {
"data": {
"created": [
{
"organisationId": "<string>",
"complete": true,
"completedSteps": [
"<string>"
],
"outstandingSteps": [
"<string>"
]
}
],
"failed": [
{
"reference": "<string>",
"reason": "<string>",
"message": "<string>"
}
]
},
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": null
}
]
}
]
}{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": null
}
]
},
"content": {
"data": {
"created": [
{
"organisationId": "<string>",
"complete": true,
"completedSteps": [
"<string>"
],
"outstandingSteps": [
"<string>"
]
}
],
"failed": [
{
"reference": "<string>",
"reason": "<string>",
"message": "<string>"
}
]
},
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": null
}
]
}
]
}{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": null
}
]
},
"content": {
"data": {
"created": [
{
"organisationId": "<string>",
"complete": true,
"completedSteps": [
"<string>"
],
"outstandingSteps": [
"<string>"
]
}
],
"failed": [
{
"reference": "<string>",
"reason": "<string>",
"message": "<string>"
}
]
},
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": null
}
]
}
]
}{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": null
}
]
},
"content": {
"data": null,
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": null
}
]
}
]
}{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": null
}
]
},
"content": {
"data": null,
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": null
}
]
}
]
}{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": null
}
]
},
"content": {
"data": null,
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": null
}
]
}
]
}