Open a series
Opens a Fiscalbase series in your key's environment. Outside sandbox, the establishment must be listed as open for the RUC in the SRI registry; its address comes from there. One already there is 409 series_exists, with its series_id. A punto another system used in the last 24 months is 409 series_used_elsewhere, with suggested_establishment and suggested_emission_point, and the other system's series_id when its series of the type is there: take that one over with POST /v1/ec/series/{id}/continue. Send an Idempotency-Key to retry safely.
AuthorizationBearer <token>Your API key, which acts for the one business it was created for: fb_live_… keys work at api.fiscalbase.io and issue in live, and fb_sandbox_… keys work at api-sandbox.fiscalbase.io and issue in sandbox, on the simulated SRI. A key sent to the other host is refused with api_key_wrong_host, which names its host.
idempotency-key?stringSend the same key to retry safely: a repeat of the same request answers what the first answered, without doing it again. Keys are scoped to your key's business and environment; the same key with another request is 409 idempotency_key_reused.
1 <= length <= 255Fiscalbase-Environment?stringThe environment the call acts in. Required with a person's session; a key's own environment is the one that counts, so a key may leave it out, and naming another is 422 environment_mismatch.
"sandbox""test""live"Fiscalbase-Business?stringThe business the call acts for. With a person's session, the one the call is about (without it, a call about one business is 422 business_required and a list covers every business of the organization); a key acts for its own, so naming another is 422 business_mismatch.
uuidFiscalbase-Channel?stringWhich of Fiscalbase's own integrations a key's call comes from, recorded as the channel of the documents it issues: a record, not a permission. Without it, api. A person's call is always console.
"api""mcp"Fiscalbase-Agent?stringThe AI agent a key's call comes from, as its client names itself (the MCP server sets it); recorded with the request and shown in the console's request log.
application/json- body
type*string"invoice""credit_note""debit_note""withholding""delivery_note""purchase_settlement"establishment*string^\d{3}$emission_point*string^\d{3}$establishment_address?string1 <= length <= 300establishment_name?stringA name for the establishment, which is not printed on documents. All the establishment's series share it: it is stored on each one.
1 <= length <= 80emission_point_name?stringA name for the emission point, which is not printed.
1 <= length <= 80next_number?integerThe first number to hand out, if another system already used the earlier ones. 1 by default.
1 <= value <= 999999999Opened
application/json- response
id*stringuuidobject*"series""series"business_id*stringuuidenvironment*string"sandbox""test""live"type*string"invoice""credit_note""debit_note""withholding""delivery_note""purchase_settlement"establishment*stringemission_point*stringestablishment_address*string|nullestablishment_name*|What the issuer calls the establishment, so its teams recognize it. Null if it did not name it.
emission_point_name*|What the issuer calls the emission point, like the system that issues there. Null if it did not name it.
issued_by*stringWho issues on it: fiscalbase (documents issued here, or a series a person opened), facturador (documents that came as the SRI's Facturador downloads them) or other (another system, like an ERP). Only a fiscalbase series hands out numbers.
"fiscalbase""facturador""other"active*booleanWhether Fiscalbase hands out numbers from it now; always false on another system's series.
next_number*|The number Fiscalbase hands out next; null on another system's series.
1 <= value <= 999999999last_number_seen*|The highest number a document holds on it, whoever issued it; null before any.
last_seen_on*|The issue date of that document.
dateseen_this_month*integerDocuments on it issued this calendar month, Ecuador time, whoever issued them.
issued_today*integerDocuments on it with today's issue date, Ecuador time.
gaps*Numbers missing between the lowest and the highest seen, leaving out those the business settled as annulled or the SRI holds as annulled or not authorized, and runs closed less than three days ago, which a late document may still fill.
created_at*stringdate-timeupdated_at*stringThe last change a person or the API made to it: turned on or off, advanced, renamed, taken over, a settlement undone. Documents numbered on it don't change it.
date-timecurl -X POST 'https://api.fiscalbase.io/v1/ec/series' \ -H 'Content-Type: application/json' \ -d '{ "type": "invoice", "establishment": "string", "emission_point": "string"}'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "object": "series", "business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c", "environment": "sandbox", "type": "invoice", "establishment": "string", "emission_point": "string", "establishment_address": "string", "establishment_name": "string", "emission_point_name": "string", "issued_by": "fiscalbase", "active": true, "next_number": 1, "last_number_seen": 0, "last_seen_on": "2019-08-24", "seen_this_month": 0, "issued_today": 0, "gaps": { "count": 0, "oldest_missing": 0 }, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z"}List the series GET
Every series of your key's business in its environment, whoever issues on it: the series Fiscalbase hands numbers from, and the ones imports and brought-in documents showed other systems use, each with the last number seen, this month's documents and its gaps.
Activate, deactivate or advance series PATCH
One or several Fiscalbase series at once, in one transaction: a punto's numbers and switches saved together, or all its series turned off. Each change is a series' `id` with `active`, `next_number` or both. Only Fiscalbase series (`409 series_not_fiscalbase` otherwise: take another system's over with `POST /v1/ec/series/{id}/continue`). Documents already numbered keep their number. `next_number` only moves forward, like the initial sequence number of the SRI's Facturador: to continue after the last number another system used (`422` at `changes.<index>.next_number` if the series already handed it out). Turning one on outside `sandbox` checks that the SRI still lists its establishment as open. Any refusal changes no series. `series.updated` says what changed on each.