GetbeelDocs

List issued invoices, newest invoice_date first

GET
/invoices

Autorizzazione

apiKey
headerAuthorizationBearer <token>

API key: gb_test_… or gb_live_…

Parametri query

limit?integer

Page size, 1–100

Range1 <= value <= 100
Default20
cursor?string

next_cursor of the previous page

Length1 <= length <= 200
status?string
Value in"draft""sending""sent""delivered""not_delivered""rejected"
date_from?string

invoice_date on or after (YYYY-MM-DD)

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
date_to?string

invoice_date on or before (YYYY-MM-DD)

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
payment_status?string
Value in"unpaid""partially_paid""paid"
overdue?string

true: only overdue invoices (issued, unpaid, due_date before today)

Value in"true""false"
search?string

Customer name, subject or number as shown ("12", "12/A", "12/2026"), case-insensitive

Length1 <= length <= 100
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

Corpo della risposta

OK

application/json
  1. response
object*string
data*array<>
has_more*boolean
next_cursor*string|null
Esempio di richiesta
curl -X GET 'https://www.getbeel.com/api/v1/invoices'
Esempio di risposta
{  "object": "list",  "data": [    {      "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"    }  ],  "has_more": true,  "next_cursor": "string"}