Skip to Content

Read an invoice from the SRI

GET
/v1/ec/sri/invoices/{access_key}

Asks the SRI for an invoice addressed to anyone, including one whose annulment is pending, and reads it without storing it: enough to issue a withholding on it. A test key asks the SRI's testing service and a live key its real one; the access key must belong to the same environment. The SRI only answers for documents from the last 60 days. sandbox never asks it: its practice SRI answers for the practice business's received invoices (keyed ambiente 1), and any other key is not found. An answer may be kept for a minute (Cache-Control). To keep a document in your records, upload its XML or the SRI's report with POST /v1/ec/imports.

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.

Path Parameters

access_key*string

The 49 digits of the access key.

Match^\d{49}$

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 invoice the SRI holds

application/json
  1. response
object*"sri_invoice"
Value in"sri_invoice"
environment*string

Who answered: the SRI's test service, its live one, with tax validity, or sandbox's practice SRI, which holds the practice business's received invoices.

Value in"sandbox""test""live"
access_key*string
Length49 <= length <= 49
number*string
issue_date*string
Formatdate
issuer*
buyer*
issued_to_you*boolean

true if the invoice is addressed to your key's business.

authorization*
sri_status*string

annulment_pending when its issuer asked to annul it and the receiver hasn't accepted; it is still valid.

Value in"authorized""annulment_pending"
subtotal*string
taxes*array<||>
total*string
payments*array<>
description*|

The description of its first line.

Example Request
curl -X GET 'https://api.fiscalbase.io/v1/ec/sri/invoices/string'
Example Response
{
  "object": "sri_invoice",
  "environment": "sandbox",
  "access_key": "stringstringstringstringstringstringstringstrings",
  "number": "string",
  "issue_date": "2019-08-24",
  "issuer": {
    "ruc": "string",
    "name": "string",
    "trade_name": "string"
  },
  "buyer": {
    "identification_type": "ruc",
    "identification": "string",
    "name": "string",
    "address": "string",
    "email": "string"
  },
  "issued_to_you": true,
  "authorization": {
    "number": "string",
    "authorized_at": "2019-08-24T14:15:22Z"
  },
  "sri_status": "authorized",
  "subtotal": "string",
  "taxes": [
    {
      "type": "iva",
      "rate": "iva_15",
      "base": "string",
      "value": "string",
      "additional_discount": "string",
      "refund": "string"
    }
  ],
  "total": "string",
  "payments": [
    {
      "method": "sin_sistema_financiero",
      "amount": "string",
      "term": {
        "length": 0,
        "unit": "days"
      }
    }
  ],
  "description": "string"
}