A withholding
apiKeyAuthorizationBearer <token>API key: gb_test_… or gb_live_…
id*stringGetbeel-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
id*stringobject*stringsource*stringsdi: read from the DatiRitenuta of an invoice received from SDI; manual: typed in
"sdi""manual"invoice_id*string|nullrecipient*document*type*string"RT01""RT02"causale*stringrate*stringDecimal amount as a string
^-?\d+\.\d{2}$gross_amount*stringCU punto 4
^-?\d+\.\d{2}$not_subject_amount*stringCU punto 7
^-?\d+\.\d{2}$taxable_amount*stringCU punto 8
^-?\d+\.\d{2}$withheld_amount*stringCU punto 9
^-?\d+\.\d{2}$tax_code*stringpaid_on*|nullperiod*|Month the ritenuta was made (the month of paid_on)
status*string"unpaid""withheld""remitted"due_date*|F24 deadline: the 16th of the next month, moved off holidays
overdue*booleanfiling_id*|The withholdings F24 that paid it (status remitted)
needs_review*booleanRead from an invoice whose figures need a check (notes says why)
notes*string|nullcreated_at*string^(?:(?:\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))$date-timeupdated_at*string^(?:(?:\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))$date-timecurl -X GET 'https://www.getbeel.com/api/v1/withholdings/string'{ "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"}Record a fee subject to withholding POST
A fee not received through SDI (paper invoice, notula of occasional work). withheld_amount is computed when left out. Live keys only (403 livemode_required). Free.
Change a withholding (e.g. the day the fee was paid) PATCH
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.