Skip to Content

List the held sales

GET
/v1/ec/held-documents

The live sales of your key's business refused at the month's quota (402 plan_quota_reached, with their held_document_id) that still wait, and those that failed once there was room, newest first. Nothing is charged above a plan: a held sale issues by itself, oldest first, once there is room, after the business moves to a plan with more documents or when the quota starts again on the first of the month.

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

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 held sales

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/held-documents'
Example Response
{
  "object": "list",
  "data": [
    {
      "object": "held_document",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "type": "invoice",
      "status": "held",
      "channel": "api",
      "request": {
        "property1": null,
        "property2": null
      },
      "document_id": "b792e8ae-2cb4-4209-85b9-32be4c2fcdd6",
      "failure": {
        "code": "string",
        "message": "string",
        "params": {
          "property1": "string",
          "property2": "string"
        }
      },
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "next_cursor": "string",
  "prev_cursor": "string"
}