GetbeelDocs
Riferimento APINumbering series

Create a numbering series

A prefix and/or suffix ("FT-", "/A"), restarting every year unless yearly_reset is false. Live keys only (403 livemode_required).

POST
/numbering-series

A prefix and/or suffix ("FT-", "/A"), restarting every year unless yearly_reset is false. Live keys only (403 livemode_required).

Autorizzazione

apiKey
headerAuthorizationBearer <token>

API key: gb_test_… or gb_live_…

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
name*string

Name of the series, e.g. "Estero"

Length1 <= length <= 60
prefix*string

Text before the number (e.g. "E"); empty for none

Match^([A-Za-z0-9/_.-]{0,9}[A-Za-z/_.-])?$
Default""
suffix*string

Text after the number (e.g. "/A"); empty for none

Match^([A-Za-z/_.-][A-Za-z0-9/_.-]{0,9})?$
Default""
yearly_reset*boolean
Defaulttrue
default_for_invoices*boolean
Defaultfalse
default_for_credit_notes*boolean
Defaultfalse

Corpo della risposta

OK

application/json
  1. response
object*string
id*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
name*string
prefix*string
suffix*string
yearly_reset*boolean

Numbers start again from 1 every year

default_for_invoices*boolean
default_for_credit_notes*boolean
archived*boolean
next_number*string

Next number in the key's mode for today

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
Esempio di richiesta
curl -X POST 'https://www.getbeel.com/api/v1/numbering-series' \  -H 'Content-Type: application/json' \  -d '{  "name": "string",  "prefix": "",  "suffix": "",  "yearly_reset": true,  "default_for_invoices": false,  "default_for_credit_notes": false}'
Esempio di risposta
{  "object": "numbering_series",  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "prefix": "FT-",  "suffix": "/A",  "yearly_reset": true,  "default_for_invoices": true,  "default_for_credit_notes": true,  "archived": true,  "next_number": "FT-13/A",  "created_at": "2019-08-24T14:15:22Z"}