Update an Entity

PUT

entities

{id}

Update a legal entity

curl --request PUT \
  --url https://billing.example.com/v1/entities/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "legal_name": "<string>",
  "invoice_prefix": "<string>",
  "country_code": "<string>",
  "country": "<string>"
}
'

import requests

url = "https://billing.example.com/v1/entities/{id}"

payload = {
    "name": "<string>",
    "legal_name": "<string>",
    "invoice_prefix": "<string>",
    "country_code": "<string>",
    "country": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    legal_name: '<string>',
    invoice_prefix: '<string>',
    country_code: '<string>',
    country: '<string>'
  })
};

fetch('https://billing.example.com/v1/entities/{id}', 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://billing.example.com/v1/entities/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'legal_name' => '<string>',
    'invoice_prefix' => '<string>',
    'country_code' => '<string>',
    'country' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://billing.example.com/v1/entities/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"legal_name\": \"<string>\",\n  \"invoice_prefix\": \"<string>\",\n  \"country_code\": \"<string>\",\n  \"country\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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.put("https://billing.example.com/v1/entities/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"legal_name\": \"<string>\",\n  \"invoice_prefix\": \"<string>\",\n  \"country_code\": \"<string>\",\n  \"country\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://billing.example.com/v1/entities/{id}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"legal_name\": \"<string>\",\n  \"invoice_prefix\": \"<string>\",\n  \"country_code\": \"<string>\",\n  \"country\": \"<string>\"\n}"

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

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "legal_name": "<string>",
    "is_primary": true,
    "tb_ledger_id": 123,
    "invoice_prefix": "<string>",
    "country_code": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": {
    "code": "validation_failed",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "validation_failed",
    "message": "<string>"
  }
}

Takes the same body as create. The entity’s ledger id and invoice sequence are system-managed and cannot be changed here.

Request body

Parameter	Type	Required	Description
`name`	string	Yes	Display name.
`legal_name`	string	No	Registered legal name.
`invoice_prefix`	string	No	Prefix for this entity’s invoice series.
`country_code`	string	No	ISO 3166-1 alpha-2. `country` is accepted as an alias; `country_code` wins if both are sent.

Example request

curl -X PUT https://api.recurso.dev/v1/entities/e1a7c3f9-8b2d-4e6a-9f0c-3d5b7a1e8c42 \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "ACME US",
    "legal_name": "ACME North America Inc.",
    "invoice_prefix": "ACME-US",
    "country_code": "US"
  }'

The updated entity comes back in the standard data envelope — same shape as Get an Entity.

Authorizations

Authorization

string

header

required

Tenant API key obtained from POST /auth/register or POST /v1/developer/keys.

Path Parameters

string<uuid>

required

Body

application/json

name

string

required

legal_name

string

invoice_prefix

string

Optional; defaults to a slug of the name.

country_code

string

ISO 3166-1 alpha-2. country is accepted as an alias; country_code wins if both are sent.

Required string length: 2

country

string

Alias for country_code (the field /auth/register uses).

Required string length: 2

Response

Entity updated.

data

object

A legal entity under a tenant (Multi-Entity Books). Each entity has its own ledger and invoice series; every tenant has exactly one primary entity.

Show child attributes

Update a legal entity

curl --request PUT \
  --url https://billing.example.com/v1/entities/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "legal_name": "<string>",
  "invoice_prefix": "<string>",
  "country_code": "<string>",
  "country": "<string>"
}
'

import requests

url = "https://billing.example.com/v1/entities/{id}"

payload = {
    "name": "<string>",
    "legal_name": "<string>",
    "invoice_prefix": "<string>",
    "country_code": "<string>",
    "country": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    legal_name: '<string>',
    invoice_prefix: '<string>',
    country_code: '<string>',
    country: '<string>'
  })
};

fetch('https://billing.example.com/v1/entities/{id}', 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://billing.example.com/v1/entities/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'legal_name' => '<string>',
    'invoice_prefix' => '<string>',
    'country_code' => '<string>',
    'country' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://billing.example.com/v1/entities/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"legal_name\": \"<string>\",\n  \"invoice_prefix\": \"<string>\",\n  \"country_code\": \"<string>\",\n  \"country\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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.put("https://billing.example.com/v1/entities/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"legal_name\": \"<string>\",\n  \"invoice_prefix\": \"<string>\",\n  \"country_code\": \"<string>\",\n  \"country\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://billing.example.com/v1/entities/{id}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"legal_name\": \"<string>\",\n  \"invoice_prefix\": \"<string>\",\n  \"country_code\": \"<string>\",\n  \"country\": \"<string>\"\n}"

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

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "legal_name": "<string>",
    "is_primary": true,
    "tb_ledger_id": 123,
    "invoice_prefix": "<string>",
    "country_code": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": {
    "code": "validation_failed",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "validation_failed",
    "message": "<string>"
  }
}

Getting Started

Core

Billing & Invoicing

Revenue & Finance

Growth & Recovery

Compliance (India)

Platform

Customer Portal API

Request body

Example request

Authorizations

Path Parameters

Body

Response

​Request body

​Example request

Authorizations

Path Parameters

Body

Response

Request body

Example request