Skip to main content
POST
/
organizations
Create Orgs
curl --request POST \
  --url https://sandbox.intermezzo.ai/organizations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "validFrom": "2023-12-25",
  "validTo": "2023-12-25",
  "legalName": "<string>",
  "legalAddress": "<string>",
  "correspondenceAddress": "<string>",
  "dbaName": "<string>",
  "registrationCountry": "DE",
  "incorporationDate": "2023-12-25",
  "website": "<string>",
  "externalRef": "<string>",
  "workSites": [
    {
      "validFrom": "2023-12-25",
      "validTo": "2023-12-25",
      "name": "<string>",
      "address": "<string>",
      "correspondenceAddress": "<string>",
      "isActive": true,
      "isPrimary": true,
      "contacts": [
        {
          "name": "<string>",
          "email": "jsmith@example.com",
          "phone": {
            "phoneNumber": "<string>",
            "phoneType": "mobile"
          },
          "roles": [
            "<string>"
          ]
        }
      ],
      "taxIdentifiers": [
        {
          "validFrom": "2023-12-25",
          "validTo": "2023-12-25",
          "taxData": {
            "validFrom": "2023-12-25",
            "validTo": "2023-12-25",
            "country": "<string>",
            "businessType": "Sole Trader",
            "payeReferenceNumber": "<string>",
            "accountsOfficeReference": "<string>"
          }
        }
      ],
      "insuranceData": [
        {
          "validFrom": "2023-12-25",
          "validTo": "2023-12-25",
          "insuranceCountry": "<string>",
          "worksiteLocationNumber": "98797889",
          "accidentInsuranceCompanyNumber": "98797889",
          "accidentInsurancePin": "DE-WS-PIN-456",
          "payrollServiceProviderNumber": "98797889",
          "payrollProcessingLocationNumber": "98797889"
        }
      ]
    }
  ],
  "bankAccounts": [
    {
      "financialInstitutionName": "Deutsche Bank",
      "accountNumber": "DE89370400440532013000",
      "routingNumber": "<string>",
      "iban": "<string>",
      "isActive": true,
      "isPrimary": true
    }
  ],
  "contacts": [
    {
      "name": "<string>",
      "email": "jsmith@example.com",
      "phone": {
        "phoneNumber": "<string>",
        "phoneType": "mobile"
      },
      "roles": [
        "<string>"
      ]
    }
  ],
  "insuranceData": [
    {
      "validFrom": "2023-12-25",
      "validTo": "2023-12-25",
      "insuranceCountry": "<string>",
      "companyNumber": "98797889",
      "unrs": "DE987654321",
      "accidentInsuranceCompanyNumber": "98797889",
      "accidentInsurancePin": "12345",
      "payrollServiceProviderNumber": "98797889",
      "payrollProcessingLocationNumber": "98797889",
      "economicSector": 1,
      "u1Selected": true,
      "u2Selected": true,
      "u3Selected": true,
      "agencyId": "<string>",
      "alternateAgencyId": "<string>",
      "contactId": "<string>"
    }
  ],
  "sepaMandates": [
    {
      "validFrom": "2023-12-25",
      "validTo": "2023-12-25",
      "mandateReference": "<string>",
      "creditorId": "<string>",
      "bankAccountId": "<string>",
      "isRecurring": true
    }
  ],
  "taxIdentifiers": [],
  "preferences": {
    "isInsolvent": false,
    "insolvencyStartDate": "2023-12-25",
    "insolvencyEndDate": "2023-12-25",
    "insolvencyCompanyNumber": "<string>",
    "insuranceSubsidyMethod": "remuneration",
    "extraPaidLeaveDays": 123,
    "insuranceCreditPreference": "<string>",
    "firstPayrollDate": "2023-12-25",
    "lastPayrollDate": "2023-12-25",
    "firstPayrollIntermezzo": "2023-12-25",
    "daysForSicknessCertificate": 123,
    "additionalChildcareSickDaysReason": 0
  }
}'
{
  "validFrom": "2023-12-25",
  "validTo": "2023-12-25",
  "legalName": "<string>",
  "legalAddress": "<string>",
  "correspondenceAddress": "<string>",
  "dbaName": "<string>",
  "registrationCountry": "DE",
  "incorporationDate": "2023-12-25",
  "website": "<string>",
  "externalRef": "<string>",
  "id": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "shutdownDate": "2023-12-25",
  "workSites": [
    {
      "validFrom": "2023-12-25",
      "validTo": "2023-12-25",
      "name": "<string>",
      "address": "<string>",
      "correspondenceAddress": "<string>",
      "isActive": true,
      "isPrimary": true,
      "id": "<string>",
      "orgId": "<string>",
      "contacts": [
        {
          "name": "<string>",
          "email": "jsmith@example.com",
          "phone": {
            "phoneNumber": "<string>",
            "phoneType": "mobile"
          },
          "id": "<string>",
          "roles": [
            "<string>"
          ]
        }
      ],
      "taxIdentifiers": [],
      "insuranceData": [],
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "bankAccounts": [
    {
      "financialInstitutionName": "Deutsche Bank",
      "accountNumber": "DE89370400440532013000",
      "routingNumber": "<string>",
      "iban": "<string>",
      "isActive": true,
      "isPrimary": false,
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "contacts": [
    {
      "name": "<string>",
      "email": "jsmith@example.com",
      "phone": {
        "phoneNumber": "<string>",
        "phoneType": "mobile"
      },
      "id": "<string>",
      "roles": [
        "<string>"
      ]
    }
  ],
  "taxIdentifiers": [],
  "insuranceData": [],
  "sepaMandates": [],
  "preferences": {
    "isInsolvent": false,
    "insolvencyStartDate": "2023-12-25",
    "insolvencyEndDate": "2023-12-25",
    "insolvencyCompanyNumber": "<string>",
    "insuranceSubsidyMethod": "remuneration",
    "extraPaidLeaveDays": 123,
    "insuranceCreditPreference": "<string>",
    "firstPayrollDate": "2023-12-25",
    "lastPayrollDate": "2023-12-25",
    "firstPayrollIntermezzo": "2023-12-25",
    "daysForSicknessCertificate": 123,
    "additionalChildcareSickDaysReason": 0
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
  • GermanOrganizationRequest
  • GBOrganizationRequest
bankAccounts
BankAccountRequest · object[]
required
validFrom
string<date> | null
validTo
string<date> | null
correspondenceAddress
string | null
dbaName
string | null
registrationCountry
string
default:DE
Allowed value: "DE"
incorporationDate
string<date> | null
website
string | null
externalRef
string | null
Maximum length: 255
workSites
WorkSiteRequest · object[]
contacts
ContactRequest · object[] | null
insuranceData
GermanyOrganizationInsuranceDetailsRequest · object[] | null
sepaMandates
SepaMandateRequest · object[] | null
taxIdentifiers
TaxIdentifiersRequest · object[]
preferences
object | null

Response

Successful Response

registrationCountry
enum<string>
required

Enum for CountryAlpha2 codes

Available options:
DE,
IE,
GB,
US,
GB
id
string
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
workSites
WorkSiteResponse · object[] | null
required
bankAccounts
BankAccountResponse · object[] | null
required
validFrom
string<date> | null
validTo
string<date> | null
correspondenceAddress
string | null
dbaName
string | null
incorporationDate
string<date> | null
website
string | null
externalRef
string | null
Maximum length: 255
shutdownDate
string<date> | null
contacts
ContactResponse · object[] | null
taxIdentifiers
TaxIdentifiersResponse · object[]
insuranceData
GermanyOrganizationInsuranceDetailsResponse · object[]
sepaMandates
SepaMandateResponse · object[]
preferences
object | null
I