Update organisation information

POST

organisation

information

curl --request POST \
  --url https://api.sandbox.flowpayroll.ai/v1/organisation/information \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: <api-key>' \
  --data '
{
  "name": {
    "legalName": "Acme Corporation Ltd",
    "tradingName": "Acme Corp"
  },
  "organisationType": "LimitedCompany",
  "companyRegistrationNumber": "12345678",
  "businessType": "LimitedCompany",
  "registredOfficeAddress": {
    "line1": "123 Main Street",
    "line2": "Apt 4B",
    "city": "London",
    "county": "Greater London",
    "postcode": "SW1A 1AA",
    "countryCode": "UK"
  },
  "correspondenceAddress": {
    "line1": "123 Main Street",
    "line2": "Apt 4B",
    "city": "London",
    "county": "Greater London",
    "postcode": "SW1A 1AA",
    "countryCode": "UK"
  },
  "companyContactDetails": {
    "name": "HR Department",
    "email": "hr@acme.com",
    "phone": "0161 123 4567"
  },
  "primaryContactDetails": {
    "name": "HR Department",
    "email": "hr@acme.com",
    "phone": "0161 123 4567"
  }
}
'

{
  "message": {
    "text": "<string>",
    "token": "<string>",
    "tokenArguments": [
      {
        "name": "<string>",
        "value": "<string>"
      }
    ]
  },
  "content": {
    "data": {
      "name": {
        "legalName": "Acme Corporation Ltd",
        "tradingName": "Acme Corp"
      },
      "organisationType": "LimitedCompany",
      "companyRegistrationNumber": "12345678",
      "businessType": "LimitedCompany",
      "registredOfficeAddress": {
        "line1": "123 Main Street",
        "line2": "Apt 4B",
        "city": "London",
        "county": "Greater London",
        "postcode": "SW1A 1AA",
        "countryCode": "UK"
      },
      "correspondenceAddress": {
        "line1": "123 Main Street",
        "line2": "Apt 4B",
        "city": "London",
        "county": "Greater London",
        "postcode": "SW1A 1AA",
        "countryCode": "UK"
      },
      "companyContactDetails": {
        "name": "HR Department",
        "email": "hr@acme.com",
        "phone": "0161 123 4567"
      },
      "primaryContactDetails": {
        "name": "HR Department",
        "email": "hr@acme.com",
        "phone": "0161 123 4567"
      },
      "organisationId": "org_123",
      "createdBy": "user_123",
      "createdDate": "2025-01-01T00:00:00Z",
      "updatedBy": "user_456",
      "updatedDate": "2025-01-02T00:00:00Z"
    },
    "metadata": {
      "dateFormat": "yyyy-MM-dd",
      "dateTimeFormat": "yyyy-MM-ddTHH:mm:ss.fffZ",
      "paginationToken": "<string>"
    }
  },
  "validationIssues": [
    {
      "field": "<string>",
      "reason": "<string>",
      "reasonToken": "<string>",
      "reasonTokenArguments": [
        {
          "name": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "messageToken": "<string>"
}

Authorizations

X-Auth-Token

string

header

required

Access token obtained from OAuth2 client credentials flow

Body

application/json

name

object

required

Show child attributes

organisationType

enum<string>

required

Organisation type of the organisation

Available options:

Parent,

Subsidiary,

Independent,

Franchise,

Branch

Example:

"LimitedCompany"

companyRegistrationNumber

string

required

Company Registration Number (CRN), also known as a Companies House number, is a unique identifier assigned to a company when it's registered with Companies House. It's essentially a way to distinguish one company from another and verify its existence

Example:

"12345678"

businessType

enum<string>

required

Business type of the organisation

Available options:

LimitedCompany,

LimitedLiabilityPartnership,

SoleTrader,

Partnership,

Charity,

PublicSector

Example:

"LimitedCompany"

registredOfficeAddress

object

required

Show child attributes

correspondenceAddress

object

required

Show child attributes

companyContactDetails

object

required

Show child attributes

primaryContactDetails

object

required

Show child attributes

Response

The organisation information was updated

message

object

Show child attributes

content

object

Show child attributes

validationIssues

object[]

Show child attributes

messageToken

string

Get organisation information

Get multiple organisation information

⌘I

Update organisation information

curl --request POST \
  --url https://api.sandbox.flowpayroll.ai/v1/organisation/information \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: <api-key>' \
  --data '
{
  "name": {
    "legalName": "Acme Corporation Ltd",
    "tradingName": "Acme Corp"
  },
  "organisationType": "LimitedCompany",
  "companyRegistrationNumber": "12345678",
  "businessType": "LimitedCompany",
  "registredOfficeAddress": {
    "line1": "123 Main Street",
    "line2": "Apt 4B",
    "city": "London",
    "county": "Greater London",
    "postcode": "SW1A 1AA",
    "countryCode": "UK"
  },
  "correspondenceAddress": {
    "line1": "123 Main Street",
    "line2": "Apt 4B",
    "city": "London",
    "county": "Greater London",
    "postcode": "SW1A 1AA",
    "countryCode": "UK"
  },
  "companyContactDetails": {
    "name": "HR Department",
    "email": "hr@acme.com",
    "phone": "0161 123 4567"
  },
  "primaryContactDetails": {
    "name": "HR Department",
    "email": "hr@acme.com",
    "phone": "0161 123 4567"
  }
}
'

{
  "message": {
    "text": "<string>",
    "token": "<string>",
    "tokenArguments": [
      {
        "name": "<string>",
        "value": "<string>"
      }
    ]
  },
  "content": {
    "data": {
      "name": {
        "legalName": "Acme Corporation Ltd",
        "tradingName": "Acme Corp"
      },
      "organisationType": "LimitedCompany",
      "companyRegistrationNumber": "12345678",
      "businessType": "LimitedCompany",
      "registredOfficeAddress": {
        "line1": "123 Main Street",
        "line2": "Apt 4B",
        "city": "London",
        "county": "Greater London",
        "postcode": "SW1A 1AA",
        "countryCode": "UK"
      },
      "correspondenceAddress": {
        "line1": "123 Main Street",
        "line2": "Apt 4B",
        "city": "London",
        "county": "Greater London",
        "postcode": "SW1A 1AA",
        "countryCode": "UK"
      },
      "companyContactDetails": {
        "name": "HR Department",
        "email": "hr@acme.com",
        "phone": "0161 123 4567"
      },
      "primaryContactDetails": {
        "name": "HR Department",
        "email": "hr@acme.com",
        "phone": "0161 123 4567"
      },
      "organisationId": "org_123",
      "createdBy": "user_123",
      "createdDate": "2025-01-01T00:00:00Z",
      "updatedBy": "user_456",
      "updatedDate": "2025-01-02T00:00:00Z"
    },
    "metadata": {
      "dateFormat": "yyyy-MM-dd",
      "dateTimeFormat": "yyyy-MM-ddTHH:mm:ss.fffZ",
      "paginationToken": "<string>"
    }
  },
  "validationIssues": [
    {
      "field": "<string>",
      "reason": "<string>",
      "reasonToken": "<string>",
      "reasonTokenArguments": [
        {
          "name": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "messageToken": "<string>"
}

Documentation Index

Authorizations

Body

Response