Tax rules in force
Every rule value by date (origin code: shipped with getbeel; db: added since), the values missing in the next 13 months, and the proroghe in force. pending (the proposals of the rules watch) and watch_runs are null unless the key is a live key of a getbeel administrator. Both key modes.
Every rule value by date (origin code: shipped with getbeel; db: added since), the values missing in the next 13 months, and the proroghe in force. pending (the proposals of the rules watch) and watch_runs are null unless the key is a live key of a getbeel administrator. Both key modes.
apiKeyAuthorizationBearer <token>API key: gb_test_… or gb_live_…
Getbeel-Company?stringAct 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.
uuidOK
application/json- response
object*stringtoday*string^\d{4}-\d{2}-\d{2}$rule_values*array<>Every rule value, versioned by date
coverage*array<>Values missing in the next 13 months
overrides*array<>Proroghe in force
pending*|Proposals waiting for approval: only for a live key of a getbeel administrator, null otherwise
watch_runs*array<>|nullcurl -X GET 'https://www.getbeel.com/api/v1/tax-rules'{ "object": "tax_rules", "today": "string", "rule_values": [ { "key": "string", "values": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "valid_from": "string", "valid_to": "string", "value": 0, "origin": "code", "confirmed": true, "source": { "title": "string", "url": "string", "article": "string" } } ] } ], "coverage": [ { "key": "string", "missing_from": "string", "publication": { "prefix": "string", "source": "string", "expected_by": "string" }, "overdue": true } ], "overrides": [ { "object": "tax_calendar_override", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "deadline_kind": "all", "nominal_from": "string", "nominal_to": "string", "new_due_date": "string", "valid_from": "string", "source_url": "string", "source_title": "string", "source_quote": "string", "quote_verified": true, "note": "string", "status": "pending", "proposed_via": "admin", "decided_at": "string", "notified_at": "string", "created_at": "string", "filings_updated": -9007199254740991 } ], "pending": { "rule_values": [ { "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" } ], "overrides": [ { "object": "tax_calendar_override", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "deadline_kind": "all", "nominal_from": "string", "nominal_to": "string", "new_due_date": "string", "valid_from": "string", "source_url": "string", "source_title": "string", "source_quote": "string", "quote_verified": true, "note": "string", "status": "pending", "proposed_via": "admin", "decided_at": "string", "notified_at": "string", "created_at": "string", "filings_updated": -9007199254740991 } ] }, "watch_runs": [ { "week": "string", "status": "string", "items_read": -9007199254740991, "proposals": -9007199254740991, "error": "string", "started_at": "string", "finished_at": "string" } ]}Delete an AI rule DELETE
Deletes the rule and returns it as it was. To stop it for a while, pause it instead. The scope follows the rule type: invoice_scan rules take the received_invoices scopes, fattura_emessa rules the invoices scopes. Live keys only.
Add a rule value POST
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.