Skip to Content

List the series

GET
/v1/ec/series

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.

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.

Query Parameters

limit?integer

How many per page, from 1 to 100.

Range1 <= value <= 100
Default20
cursor?string

The next_cursor or prev_cursor of a previous response. Without a cursor, the first page.

Lengthlength <= 200
issued_by?string
Value in"fiscalbase""facturador""other"
type?string
Value in"invoice""credit_note""debit_note""withholding""delivery_note""purchase_settlement"
establishment?string
Match^\d{3}$
has_gaps?string

Only those with (true) or without (false) gaps.

Value in"true""false"
updated_at[gte]?string

Only what changed at or after this moment, ISO 8601 with its offset: poll with the time of your last read to get what changed since.

Formatdate-time

Header Parameters

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.

Response Body

The series

application/json
  1. response
object*"list"
Value in"list"
data*array<>
next_cursor*|

The next page (older); null if there are no more.

prev_cursor*|

The previous page (newer); null on the first.

Example Request
curl -X GET 'https://api.fiscalbase.io/v1/ec/series'
Example Response
{
  "object": "list",
  "data": [
    {
      "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"
    }
  ],
  "next_cursor": "string",
  "prev_cursor": "string"
}