Discard a held sale
Discards a sale that waits or failed: it never issues. Retrying its request with the same Idempotency-Key holds it again, or issues it when there is room.
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*stringuuididempotency-key?stringSend 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.
1 <= length <= 255Fiscalbase-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.
Discarded
application/json- response
object*"held_document""held_document"id*stringuuidtype*stringThe document it issues as: invoice, credit_note…
"invoice""credit_note""debit_note""withholding""delivery_note""purchase_settlement"status*stringheld: waiting for room in the month's quota; issued: it became document_id; discarded: someone discarded it; failed: once there was room, issuing it was refused for another reason, which failure names.
"held""issued""discarded""failed"channel*string"api""console""mcp"request*The request as it was sent: it issues as it is, dated the day it issues.
document_id*|uuidfailure*|Why issuing it was refused, when it failed.
created_at*stringdate-timeupdated_at*stringdate-timecurl -X POST 'https://api.fiscalbase.io/v1/ec/held-documents/497f6eca-6276-4993-bfeb-53cbbbba6f08/discard'{
"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"
}List the held sales GET
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.
Get the custom portal domain GET
The domain with its status, the portal address in use today and the two DNS records it needs, each with what public DNS holds for it right now.