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).
A prefix and/or suffix ("FT-", "/A"), restarting every year unless yearly_reset is false. Live keys only (403 livemode_required).
apiKeyAuthorizationBearer <token>API key: gb_test_… or gb_live_…
Idempotency-Key?stringRecommended. 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.
length <= 255Getbeel-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.
uuidapplication/json- body
name*stringName of the series, e.g. "Estero"
1 <= length <= 60prefix*stringText before the number (e.g. "E"); empty for none
^([A-Za-z0-9/_.-]{0,9}[A-Za-z/_.-])?$""suffix*stringText after the number (e.g. "/A"); empty for none
^([A-Za-z/_.-][A-Za-z0-9/_.-]{0,9})?$""yearly_reset*booleantruedefault_for_invoices*booleanfalsedefault_for_credit_notes*booleanfalseOK
application/json- response
object*stringid*string^([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)$uuidname*stringprefix*stringsuffix*stringyearly_reset*booleanNumbers start again from 1 every year
default_for_invoices*booleandefault_for_credit_notes*booleanarchived*booleannext_number*stringNext number in the key's mode for today
created_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 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}'{ "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"}List numbering series with their next number GET
Next numbers are for today in the key's mode (test and live keys number separately). default_numbering is the numbering used without a series: plain numbers (1, 2, 3, no suffix) that restart every calendar year, or one sequence across years if yearly_reset is false. The number shown is always the XML Numero.
Retrieve a numbering series GET
Pagina successiva