What can still be returned of an invoice
Each line the invoice sold and how much of it the credit notes already took, from the invoice and the credit notes that stand against it: what a return screen steps through. A credit note that returns more of a line than is left is refused (credited_quantity_exceeds_left). A credit note line is a return of an invoice line when it has the same code (or, without one, the same description) at the same unit price. Only an authorized invoice can be credited.
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.
id*stringuuidFiscalbase-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.
What is left, by line
application/json- response
object*"returnable""returnable"invoice_id*stringuuidcredit_balance*|The invoice's credit_balance, which caps a credit note by amount whatever its lines say. null for an invoice issued to consumidor_final, which takes no credit note.
lines*array<>curl -X GET 'https://api.fiscalbase.io/v1/ec/invoices/497f6eca-6276-4993-bfeb-53cbbbba6f08/returnable'{
"object": "returnable",
"invoice_id": "f4c4edb8-11e0-4b33-bcc1-482dc59ebb32",
"credit_balance": "string",
"lines": [
{
"line_index": 0,
"code": "string",
"description": "string",
"unit": "string",
"unit_price": "string",
"quantity_sold": "string",
"quantity_returned": "string",
"quantity_left": "string"
}
]
}Download the RIDE (PDF) GET
The printed representation, on A4. In `sandbox` and `test` it carries a watermark: it has no tax validity.
The journey of the document GET
Every step it went through, from newest to oldest: accepted, signed, received, authorized or returned, the RIDE generated, each email sent and each correction.