GetbeelDocs

Change or end a POS–RT link

Before the link is communicated anything can change. After, only label and ended_on: setting ended_on (last day of use) makes the end the next thing to communicate (operation C, DataFine). 409 link_already_filed otherwise. Live keys only (403 livemode_required). Free.

PATCH
/pos-rt-links/{id}

Before the link is communicated anything can change. After, only label and ended_on: setting ended_on (last day of use) makes the end the next thing to communicate (operation C, DataFine). 409 link_already_filed otherwise. 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
label?|

Your own name for the till, e.g. "Cassa 1"

rt_serial?string

Matricola of the RT or Server RT (CSV Matricola)

Match^[A-Za-z0-9]{1,30}$
acquirer_country?string
Value in"IT""ES"
acquirer_id?string

IdentificativoAcquirer: the acquirer’s Italian codice fiscale (11 digits, leading zeros kept)

Match^[A-Za-z0-9]{1,30}$
acquirer_name?string

DenominazioneAcquirer

Match^(?![=+\-@])[^;"\r\n\t]*$
Length1 <= length <= 200
pos_type?string

TipoPos: 00 physical (incl. SoftPOS), 01 virtual

Value in"00""01"
terminal_id?|

TerminalId of the POS terminal: required when pos_type is 00 (physical), ignored when it is 01 (virtual)

contract_number?string

Convenzione: number of the contract with the acquirer

Match^[A-Za-z0-9._/-]{1,50}$
itinerant?boolean
province?|

Two-letter province code (sigla) of the place where the RT is used (CSV UbicazioneProv). Required unless itinerant

municipality?|

Municipality (comune) where the RT is used (CSV UbicazioneComune). Required unless itinerant

street?|

Street of the unità locale where the RT is used (CSV UbicazioneIndirizzo). Required unless itinerant

street_number?|

Street number (CSV UbicazioneCivico). Required unless itinerant

postal_code?|

Five-digit CAP (CSV UbicazioneCap). Required unless itinerant

active_from?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])))$
Formatdate
ended_on?|

Last day of use: the link is ended (CSV operation C, DataFine)

Response Body

OK

application/json
  1. response
id*string
object*string
label*string|null
rt_serial*string
acquirer_country*string
Value in"IT""ES"
acquirer_id*string
acquirer_name*string
pos_type*string
Value in"00""01"
terminal_id*string|null
contract_number*string
itinerant*boolean
province*string|null
municipality*string|null
street*string|null
street_number*string|null
postal_code*string|null
active_from*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])))$
Formatdate
ended_on*|null
status*string
Value in"to_file""filed""end_to_file""ended"
pending*|

What is still to communicate to the AdE, and by when

linked_filed_at*|null
end_filed_at*|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/pos-rt-links/string' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "id": "string",  "object": "pos_rt_link",  "label": "string",  "rt_serial": "string",  "acquirer_country": "IT",  "acquirer_id": "string",  "acquirer_name": "string",  "pos_type": "00",  "terminal_id": "string",  "contract_number": "string",  "itinerant": true,  "province": "string",  "municipality": "string",  "street": "string",  "street_number": "string",  "postal_code": "string",  "active_from": "2026-10-29",  "ended_on": "2026-10-29",  "status": "to_file",  "pending": {    "operation": "I",    "from": "2026-10-29",    "due": "2026-10-29",    "not_late_until": "2026-10-29",    "reference_month": "string",    "initial_window": true  },  "linked_filed_at": "2019-08-24T14:15:22Z",  "end_filed_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}