GetbeelDocs
API referenceTax rules

Add a rule value

Adds a value of a known key for its dates. status active puts it in force at once, only with an official source (agenziaentrate.gov.it, mef.gov.it, finanze.gov.it, gazzettaufficiale.it, inps.it, normattiva.it, fatturapa.gov.it; 400 official_source_required otherwise); pending (default) waits for approval. Two active values of a key never overlap (409 rule_value_overlap). Tax rules apply to every company: only getbeel administrators change them, with a live key that has the admin-only tax_rules:admin scope (created in the admin page; 403 insufficient_scope otherwise, 403 live_key_required with a test key, 403 super_admin_required when its creator is no longer an administrator). Recorded in the audit log.

POST
/tax-rules/values

Adds a value of a known key for its dates. status active puts it in force at once, only with an official source (agenziaentrate.gov.it, mef.gov.it, finanze.gov.it, gazzettaufficiale.it, inps.it, normattiva.it, fatturapa.gov.it; 400 official_source_required otherwise); pending (default) waits for approval. Two active values of a key never overlap (409 rule_value_overlap). Tax rules apply to every company: only getbeel administrators change them, with a live key that has the admin-only tax_rules:admin scope (created in the admin page; 403 insufficient_scope otherwise, 403 live_key_required with a test key, 403 super_admin_required when its creator is no longer an administrator). Recorded in the audit log.

Authorization

apiKey
headerAuthorizationBearer <token>

API key: gb_test_… or gb_live_…

Header Parameters

Getbeel-Company?string

Act on one of the account's client companies (its id from GET /companies) instead of the key's own account. 404 company_not_found when the key cannot act on it.

Formatuuid

Request Body

application/json
  1. body
key*string

A rule key getbeel knows (GET /v1/tax-rules lists them), e.g. inps.maternity_yearly

value*number

In the unit of the key: a % as 26.07, euros as 4604.2

valid_from*string

First day it applies (YYYY-MM-DD)

Match^\d{4}-\d{2}-\d{2}$
valid_to?|

Last day it applies; null: until changed

source_url*string

https link of the official source

Match^https:\/\/
Lengthlength <= 500
source_title*string

The act, e.g. INPS circolare n. 9 del 2 febbraio 2027

Length1 <= length <= 300
source_article?|

Article, paragraph or section of the source

quote?|

The sentence of the source that gives the value

status*string
Default"pending"
Value in"active""pending"

Response Body

OK

application/json
  1. response
object*string
id*string
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
key*string
value*number
valid_from*string
Match^\d{4}-\d{2}-\d{2}$
valid_to*|null
source_url*string
source_title*string
source_article*string|null
source_quote*|

The sentence of the source that gives the value

quote_verified*boolean

The quote was found word for word in the source getbeel read (false for a PDF or a value typed by hand)

status*string
Value in"pending""active""rejected"
proposed_via*string

Who added it: admin page, API, MCP, or the weekly rules watch (ai)

Value in"admin""api""mcp""ai"
decided_at*string|null
decision_note*string|null
created_at*string
Example Request
curl -X POST 'https://www.getbeel.com/api/v1/tax-rules/values' \  -H 'Content-Type: application/json' \  -d '{  "key": "string",  "value": 0,  "valid_from": "string",  "source_url": "string",  "source_title": "string",  "status": "active"}'
Example Response
{  "object": "tax_rule_value",  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "key": "inps.maternity_yearly",  "value": 0,  "valid_from": "string",  "valid_to": "string",  "source_url": "string",  "source_title": "string",  "source_article": "string",  "source_quote": "string",  "quote_verified": true,  "status": "pending",  "proposed_via": "admin",  "decided_at": "string",  "decision_note": "string",  "created_at": "string"}