GetbeelDocs

Change a withholding (e.g. the day the fee was paid)

Changing the rate or the amounts recomputes withheld_amount unless you send it. 409 withholding_remitted once an F24 recorded in getbeel paid it (the CU and the 770 rely on it). Live keys only (403 livemode_required). Free.

PATCH
/withholdings/{id}

Changing the rate or the amounts recomputes withheld_amount unless you send it. 409 withholding_remitted once an F24 recorded in getbeel paid it (the CU and the 770 rely on it). Live keys only (403 livemode_required). Free.

Authorization

apiKey
headerAuthorizationBearer <token>

API key: gb_test_… or gb_live_…

Path Parameters

id*string

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
recipient?

The percipiente: the professional or agent the fee is paid to; only the fields sent change

document?

The invoice, parcella or notula (receipt for occasional work) the fee is billed on; only the fields sent change

invoice_id?|

The received invoice (GET /received-invoices) it pays; null unlinks it

type?string
Value in"RT01""RT02"
causale?string

CU causale (punto 1): A lavoro autonomo abituale, M occasionale, Q/R provvigioni agente mono/plurimandatario, … (CU 2026 instructions)

Value in"A""B""C""D""E""F""G""H""I""J""K""L""L1""M""M1""M2""N""O""O1""P""Q""R""S""T""U""V""V1""V2""W""X""Y""Z""ZO"
rate?unknown

Decimal string (or number)

gross_amount?unknown

Decimal string (or number)

not_subject_amount?unknown

Decimal string (or number)

withheld_amount?unknown

Omit when changing the rate or the amounts to recompute it

paid_on?|

The day the fee was paid (null: not paid yet)

notes?|

Free-text note, up to 500 characters (null clears it)

remitted?boolean

true: the ritenuta was paid with the month’s withholdings F24 already recorded as paid (e.g. prepared with a typed amount): links it to that F24 and locks it. 409 no_paid_filing when there is none

Response Body

OK

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

sdi: read from the DatiRitenuta of an invoice received from SDI; manual: typed in

Value in"sdi""manual"
invoice_id*string|null
recipient*
document*
type*string
Value in"RT01""RT02"
causale*string
rate*string

Decimal amount as a string

Match^-?\d+\.\d{2}$
gross_amount*string

CU punto 4

Match^-?\d+\.\d{2}$
not_subject_amount*string

CU punto 7

Match^-?\d+\.\d{2}$
taxable_amount*string

CU punto 8

Match^-?\d+\.\d{2}$
withheld_amount*string

CU punto 9

Match^-?\d+\.\d{2}$
tax_code*string
paid_on*|null
period*|

Month the ritenuta was made (the month of paid_on)

status*string
Value in"unpaid""withheld""remitted"
due_date*|

F24 deadline: the 16th of the next month, moved off holidays

overdue*boolean
filing_id*|

The withholdings F24 that paid it (status remitted)

needs_review*boolean

Read from an invoice whose figures need a check (notes says why)

notes*string|null
created_at*string
Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
Formatdate-time
updated_at*string
Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
Formatdate-time
Example Request
curl -X PATCH 'https://www.getbeel.com/api/v1/withholdings/string' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "id": "wht_3f2a…",  "object": "withholding",  "source": "sdi",  "invoice_id": "string",  "recipient": {    "name": "string",    "fiscal_code": "string",    "vat": "string"  },  "document": {    "number": "string",    "date": "2026-10-29"  },  "type": "RT01",  "causale": "string",  "rate": "122.00",  "gross_amount": "122.00",  "not_subject_amount": "122.00",  "taxable_amount": "122.00",  "withheld_amount": "122.00",  "tax_code": "1040",  "paid_on": "2026-10-29",  "period": "string",  "status": "unpaid",  "due_date": "2026-10-29",  "overdue": true,  "filing_id": "string",  "needs_review": true,  "notes": "string",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}