GetbeelDocs

Record a payment (mark as paid)

Records a payment on an issued invoice (or proforma). Without amount it records everything still due (amount_due − amount_paid) and the invoice becomes paid (webhook invoice.paid); a smaller amount makes it partially_paid. amount_due is the total less the ritenuta d'acconto.

POST
/invoices/{id}/payments

Records a payment on an issued invoice (or proforma). Without amount it records everything still due (amount_due − amount_paid) and the invoice becomes paid (webhook invoice.paid); a smaller amount makes it partially_paid. amount_due is the total less the ritenuta d'acconto.

Autorizzazione

apiKey
headerAuthorizationBearer <token>

API key: gb_test_… or gb_live_…

id*string
Idempotency-Key?string

Recommended. Retrying with the same key and body within 24 hours replays the first response (header Idempotent-Replayed: true) instead of acting twice. The same key with a different body returns 422 idempotency_key_reused.

Lengthlength <= 255
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
application/json
  1. body
amount?unknown

Decimal string; default: everything still due (marks the invoice paid)

date?string

Payment date (YYYY-MM-DD); default today

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
method*string
Default"bank_transfer"
Value in"bank_transfer""card""cash""stripe""other"
note?string

Internal note stored with the payment, up to 500 characters (not sent to the customer)

Lengthlength <= 500

Corpo della risposta

OK

application/json
  1. response
payment*
invoice*
Esempio di richiesta
curl -X POST 'https://www.getbeel.com/api/v1/invoices/string/payments' \  -H 'Content-Type: application/json' \  -d '{  "method": "bank_transfer"}'
Esempio di risposta
{  "payment": {    "object": "invoice_payment",    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "invoice_id": "string",    "amount": "122.00",    "date": "2026-10-29",    "method": "bank_transfer",    "source": "app",    "note": "string",    "created_at": "2019-08-24T14:15:22Z"  },  "invoice": {    "object": "invoice",    "id": "fe_3f1c…",    "livemode": true,    "number": "string",    "tipo_documento": "TD01",    "invoice_date": "2026-10-29",    "due_date": "2026-10-29",    "status": "draft",    "is_proforma": true,    "currency": "string",    "amount_subtotal": "122.00",    "amount_tax": "122.00",    "amount_total": "122.00",    "customer": {      "name": "string",      "vat_number": "string",      "codice_fiscale": "string",      "codice_destinatario": "string",      "pec": "string",      "email": "string",      "country": "string",      "address": "string",      "postal_code": "string",      "city": "string",      "province": "string"    },    "sdi": {      "identificativo_sdi": "string",      "file_name": "string",      "error_message": "string",      "error_codes": [        "00404"      ],      "errors": [        {          "code": "00305",          "description": "1.4.1.1.2 <IdCodice> non valido"        }      ],      "available_since": "2026-10-31",      "updated_at": "2019-08-24T14:15:22Z"    },    "payment_status": "unpaid",    "amount_due": "122.00",    "amount_credited": "122.00",    "withholdings": [      {        "type": "RT01",        "rate": "122.00",        "amount": "122.00",        "reason": "A"      }    ],    "related_invoice_id": "string",    "series_id": "0f6582ac-1e7e-41dc-a63a-24fccd074d0c",    "amount_paid": "122.00",    "paid_at": "2026-10-29",    "overdue": true,    "payment_link_url": "string",    "lines": [      {        "description": "string",        "quantity": "1",        "unit_price": "100.00",        "amount": "122.00",        "vat_rate": "22.00",        "natura": "N2.2"      }    ],    "created_at": "2019-08-24T14:15:22Z",    "updated_at": "2019-08-24T14:15:22Z"  }}