Preview credit note
Checks the body of POST /v1/ec/credit-notes and computes the document as it would be issued today, without numbering, storing or sending anything. What is wrong with the body is refused with 422, as issuing would refuse it; what would stop issuing it right now (no plan, certificate or numbering, a business not live yet, the spending cap reached) comes back in warnings. Pass its preview_id to POST /v1/ec/credit-notes?preview_id=… to issue exactly this body.
Your API key, which acts for the one business it was created for: fb_sandbox_… issues in sandbox, fb_test_… in test, the tax authority's testing service, and fb_live_… in live.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
The issue date is always today in Ecuador: documents are transmitted when issued.
Who receives the credit. Omit it when modified_document is an invoice's document_id: it is that invoice's buyer.
Why the invoice is credited (motivo), in free text: the SRI has no codes for it. Such as a return, a discount granted afterwards or a correction of a price.
^[^\n\r]*$1 <= length <= 300What is credited: each line in full, or, when modified_document is an invoice's document_id, by the invoice line's code and the quantity credited.
1 <= itemsIVA refunded to an older adult (valorDevolucionIva, annex 20), by rate, as the SRI's DIG service authorized it. It is subtracted from the total; the buyer must identify with a cedula.
The fiscal machine the document is issued from (annex 13). Only when one issues it.
[]The establishment whose series numbers it, such as 001. Without it, the first active series of the document type.
^\d{3}$The emission point of that establishment, such as 001. Without it, the first active one.
^\d{3}$Up to 20 pairs of your own, such as your order id, returned as sent and never interpreted; lists filter by them (metadata[key]=value).
{}Only with a sandbox key (422 in test and live, where the SRI decides): the outcome the simulator gives this revision, to rehearse how your system handles each one. Without it, it is authorized.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://example.com/v1/ec/credit-notes/preview" \ -H "Content-Type: application/json" \ -d '{ "modified_document": { "document_id": "b792e8ae-2cb4-4209-85b9-32be4c2fcdd6" }, "reason": "string", "lines": [ { "description": "string", "quantity": "string", "unit_price": "string", "taxes": [ { "type": "iva", "rate": "iva_15" } ] } ] }'{ "object": "document_preview", "type": "credit_note", "preview_id": "stringstringstringstringstringstringstringstringstringstringstri", "environment": "sandbox", "entity_id": "8161163a-f227-466f-bc01-090a01e80165", "issue_date": "2019-08-24", "total": "string", "tax_total": "string", "warnings": [ { "code": "string", "message": "string", "detail": "string" } ], "document": { "lines": [ { "code": "string", "auxiliary_code": "string", "description": "string", "unit": "string", "quantity": "string", "unit_price": "string", "discount": "string", "net": "string", "taxes": [ { "type": "iva", "rate": "iva_15", "base": "string", "value": "string" } ], "additional_info": [ { "name": "string", "value": "string" } ] } ], "taxes": [ { "type": "iva", "rate": "iva_15", "base": "string", "value": "string", "additional_discount": "string", "refund": "string" } ], "subtotal": "string", "discount": "string", "iva": "string", "ice": "string", "irbpnr": "string", "total": "string", "issue_date": "string", "buyer": { "identification_type": "ruc", "identification": "string", "name": "string", "address": "string", "email": "string" }, "modified_document": { "document_type": "factura", "number": "string", "issue_date": "2019-08-24" }, "reason": "string", "compensations": [ { "code": "string", "rate": "string", "value": "string" } ], "fiscal_machine": { "brand": "string", "model": "string", "serial": "string" }, "additional_info": [ { "name": "string", "value": "string" } ] }}List credit notes GET
From newest to oldest, in your key's environment.
Retrieve credit note GET
The document with its current status and its access key, as Fiscalbase knows it. It only reads: it does not ask the SRI at that moment; for that there is `POST /v1/ec/documents/{id}/refresh-status`. Send `wait` to answer once the SRI decides on a `pending` or `submitted` one.