Skip to Content

Open a series

POST
/v1/ec/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.

Authorization

headerAuthorizationBearer <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.

Header Parameters

idempotency-key?string

Send 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.

Length1 <= length <= 255
Fiscalbase-Environment?string

The 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.

Value in"sandbox""test""live"
Fiscalbase-Business?string

The 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.

Formatuuid
Fiscalbase-Channel?string

Which 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.

Value in"api""mcp"
Fiscalbase-Agent?string

The 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.

Request Body

application/json
  1. body
type*string
Value in"invoice""credit_note""debit_note""withholding""delivery_note""purchase_settlement"
establishment*string
Match^\d{3}$
emission_point*string
Match^\d{3}$
establishment_address?string
Length1 <= length <= 300
establishment_name?string

A name for the establishment, which is not printed on documents. All the establishment's series share it: it is stored on each one.

Length1 <= length <= 80
emission_point_name?string

A name for the emission point, which is not printed.

Length1 <= length <= 80
next_number?integer

The first number to hand out, if another system already used the earlier ones. 1 by default.

Range1 <= value <= 999999999

Response Body

Opened

application/json
  1. response
id*string
Formatuuid
object*"series"
Value in"series"
business_id*string
Formatuuid
environment*string
Value in"sandbox""test""live"
type*string
Value in"invoice""credit_note""debit_note""withholding""delivery_note""purchase_settlement"
establishment*string
emission_point*string
establishment_address*string|null
establishment_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*string

Who 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.

Value in"fiscalbase""facturador""other"
active*boolean

Whether 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.

Range1 <= value <= 999999999
last_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.

Formatdate
seen_this_month*integer

Documents on it issued this calendar month, Ecuador time, whoever issued them.

issued_today*integer

Documents 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*string
Formatdate-time
updated_at*string

The 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.

Formatdate-time
Example Request
curl -X POST 'https://api.fiscalbase.io/v1/ec/series' \  -H 'Content-Type: application/json' \  -d '{  "type": "invoice",  "establishment": "string",  "emission_point": "string"}'
Example Response
{  "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"}