GetbeelDocs
API referenceCompanies

Change company data

Changes only the fields sent. sdi_readiness shows what is still missing to issue invoices through SDI. Live keys only (403 livemode_required with a test key): company data is real, there is no sandbox for it.

PATCH
/companies/{id}

Changes only the fields sent. sdi_readiness shows what is still missing to issue invoices through SDI. Live keys only (403 livemode_required with a test key): company data is real, there is no sandbox for it.

Authorization

apiKey
headerAuthorizationBearer <token>

API key: gb_test_… or gb_live_…

Path Parameters

id*string

A client company id, or the key's own account id

Formatuuid

Request Body

application/json
  1. body
name?string

Company name (ragione sociale)

Length1 <= length <= 255
country?string

ISO 3166-1 alpha-2 country. Default IT

Match^[A-Z]{2}$
vat_number?|

Partita IVA (Italy: 11 digits, without the IT prefix)

codice_fiscale?|

Codice fiscale (Italy: 16 characters for a person, or the 11 digits of the P.IVA for most companies)

regime_fiscale?|

Regime fiscale of the CedentePrestatore (FatturaPA 1.2.1.8): RF01 ordinario, RF19 forfettario…

address?|

Street (via, piazza…)

street_number?|

Numero civico

postal_code?|

CAP

city?|

Comune

province?|

Provincia (sigla)

Response Body

OK

application/json
  1. response
object*string
id*string

Send it as the Getbeel-Company header (or the MCP company_id argument) to act on this company

Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
name*string
slug*string|null
parent_id*|

The parent (platform) account, null for the parent itself and for standalone accounts

company*|null
sdi_readiness*
Example Request
curl -X PATCH 'https://www.getbeel.com/api/v1/companies/497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "object": "company",  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "slug": "string",  "parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",  "company": {    "name": "string",    "vat_number": "string",    "codice_fiscale": "string",    "regime_fiscale": "RF01",    "country": "string",    "address": "string",    "street_number": "string",    "postal_code": "string",    "city": "string",    "province": "string",    "preferred_currency": "string",    "sdi_configured": true  },  "sdi_readiness": {    "ready": true,    "missing": [      "name"    ]  }}