Close Organization

curl --request POST \
  --url https://dev.intermezzo.ai/gb/organizations/{organization_id}/close \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://dev.intermezzo.ai/gb/organizations/{organization_id}/close"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://dev.intermezzo.ai/gb/organizations/{organization_id}/close', 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://dev.intermezzo.ai/gb/organizations/{organization_id}/close",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://dev.intermezzo.ai/gb/organizations/{organization_id}/close"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://dev.intermezzo.ai/gb/organizations/{organization_id}/close")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "client_id": "<string>",
  "country_code": "GB",
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": "<string>",
  "deleted_at": "2023-11-07T05:31:56Z",
  "external_ref": "<string>",
  "id": "<string>",
  "status": {},
  "address": {
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": "<string>",
    "edition": 123,
    "valid_from": "2023-12-25",
    "valid_to": "2023-12-25",
    "address": "<string>",
    "correspondence_address": "<string>"
  },
  "bank": {
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": "<string>",
    "edition": 123,
    "valid_from": "2023-12-25",
    "valid_to": "2023-12-25",
    "accounts": [
      {
        "account_number": "<string>",
        "financial_institution_name": "<string>",
        "is_active": true,
        "is_primary": false,
        "sort_code": "<string>"
      }
    ],
    "bacs_service_user_number": "<string>"
  },
  "contact": {
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": "<string>",
    "edition": 123,
    "valid_from": "2023-12-25",
    "valid_to": "2023-12-25",
    "contacts": [
      {
        "name": "Jane Smith",
        "email": "<string>",
        "is_primary": false,
        "phone": {
          "phone_number": "<string>",
          "phone_type": "MOBILE"
        },
        "roles": [
          "<string>"
        ]
      }
    ],
    "hmrc_sender_email": "<string>"
  },
  "core": {
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": "<string>",
    "edition": 123,
    "valid_from": "2023-12-25",
    "valid_to": "2023-12-25",
    "dba_name": "<string>",
    "incorporation_date": "2023-12-25",
    "legal_name": "<string>",
    "logo_id": "<string>",
    "shutdown_date": "2023-12-25",
    "website": "<string>"
  },
  "insurance": {
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": "<string>",
    "edition": 123,
    "valid_from": "2023-12-25",
    "valid_to": "2023-12-25",
    "employment_allowance_eligible": false
  },
  "tax": {
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": "<string>",
    "edition": 123,
    "valid_from": "2023-12-25",
    "valid_to": "2023-12-25",
    "accounts_office_reference": "<string>",
    "corporation_tax_reference": "<string>",
    "paye_reference_number": "<string>"
  }
}

POST

organizations

{organization_id}

Close Organization

curl --request POST \
  --url https://dev.intermezzo.ai/gb/organizations/{organization_id}/close \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://dev.intermezzo.ai/gb/organizations/{organization_id}/close"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://dev.intermezzo.ai/gb/organizations/{organization_id}/close', 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://dev.intermezzo.ai/gb/organizations/{organization_id}/close",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://dev.intermezzo.ai/gb/organizations/{organization_id}/close"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://dev.intermezzo.ai/gb/organizations/{organization_id}/close")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "client_id": "<string>",
  "country_code": "GB",
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": "<string>",
  "deleted_at": "2023-11-07T05:31:56Z",
  "external_ref": "<string>",
  "id": "<string>",
  "status": {},
  "address": {
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": "<string>",
    "edition": 123,
    "valid_from": "2023-12-25",
    "valid_to": "2023-12-25",
    "address": "<string>",
    "correspondence_address": "<string>"
  },
  "bank": {
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": "<string>",
    "edition": 123,
    "valid_from": "2023-12-25",
    "valid_to": "2023-12-25",
    "accounts": [
      {
        "account_number": "<string>",
        "financial_institution_name": "<string>",
        "is_active": true,
        "is_primary": false,
        "sort_code": "<string>"
      }
    ],
    "bacs_service_user_number": "<string>"
  },
  "contact": {
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": "<string>",
    "edition": 123,
    "valid_from": "2023-12-25",
    "valid_to": "2023-12-25",
    "contacts": [
      {
        "name": "Jane Smith",
        "email": "<string>",
        "is_primary": false,
        "phone": {
          "phone_number": "<string>",
          "phone_type": "MOBILE"
        },
        "roles": [
          "<string>"
        ]
      }
    ],
    "hmrc_sender_email": "<string>"
  },
  "core": {
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": "<string>",
    "edition": 123,
    "valid_from": "2023-12-25",
    "valid_to": "2023-12-25",
    "dba_name": "<string>",
    "incorporation_date": "2023-12-25",
    "legal_name": "<string>",
    "logo_id": "<string>",
    "shutdown_date": "2023-12-25",
    "website": "<string>"
  },
  "insurance": {
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": "<string>",
    "edition": 123,
    "valid_from": "2023-12-25",
    "valid_to": "2023-12-25",
    "employment_allowance_eligible": false
  },
  "tax": {
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": "<string>",
    "edition": 123,
    "valid_from": "2023-12-25",
    "valid_to": "2023-12-25",
    "accounts_office_reference": "<string>",
    "corporation_tax_reference": "<string>",
    "paye_reference_number": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Get token from Auth0 and paste it here

Path Parameters

organization_id

string

required

Response

Successful Response

The organization with every satellite as it reads on one date. A satellite never written, or with no slice on an explicit date, is null.

client_id

string

required

read-only

country_code

string

required

read-only

Allowed value: "GB"

created_at

string<date-time>

required

read-only

created_by

string

required

read-only

Who created the hub: the acting user (X-Acting-User, else the access credential), system for our own writes, or <authority>:<notice> for a write on an authority's behalf, e.g. hmrc:P6.

deleted_at

string<date-time> | null

required

When the hub was closed

external_ref

string | null

required

string

required

status

GBOrganizationStatus · object

required

The read-only status satellite. It carries no fields; it exists so that every organization read has a status object.

address

GBOrganizationAddressSatellite · object | null

Show child attributes

bank

GBOrganizationBankSatellite · object | null

Show child attributes

contact

GBOrganizationContactSatellite · object | null

Show child attributes

core

GBOrganizationCoreSatellite · object | null

Show child attributes

insurance

GBOrganizationInsuranceSatellite · object | null

Show child attributes

tax

GBOrganizationTaxSatellite · object | null

Show child attributes