{ "item": [ { "name": "Status", "description": "", "item": [ { "name": "Service status", "request": { "name": "Service status", "description": { "content": "Public status of Flashpi. Placeholder: it reports `operational` while the API answers; component and SRI availability arrive with the status page.", "type": "text/plain" }, "url": { "path": [ "v1", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": { "content": "Language of error messages and of the localized texts of resources (SRI messages, failures, certificate rejections): Spanish when the entry with the highest q-value is `es` or `es-` plus a region (`es-EC`, `es-419`), English otherwise. Errors state it in Content-Language.", "type": "text/plain" }, "key": "Accept-Language", "value": "" }, { "disabled": true, "description": { "content": "Your own ID for the request (letters, digits and `-_.:/+=`), echoed back in the X-Correlation-Id response header and logged next to the request ID. An invalid value gets 400 invalid_correlation_id.", "type": "text/plain" }, "key": "X-Correlation-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "noauth" } }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Issuers", "description": "", "item": [ { "name": "Create an issuer", "request": { "name": "Create an issuer", "description": { "content": "Registers a taxpayer (RUC) with its tax profile. Requires an account-scoped (global) API key with read_write access.", "type": "text/plain" }, "url": { "path": [ "v1", "issuers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Makes the request safe to retry: 1 to 255 visible ASCII characters (a UUID works well), remembered for 24 hours per account and mode. A retry with the same key and the same request returns the first successful response again, with the header `Idempotent-Replayed: true`. The same key with a different request gets 422 idempotency_key_reused; while the first request still runs, 409 idempotency_key_in_progress. A failed request does not keep its key.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "{{$guid}}" }, { "disabled": true, "description": { "content": "Language of error messages and of the localized texts of resources (SRI messages, failures, certificate rejections): Spanish when the entry with the highest q-value is `es` or `es-` plus a region (`es-EC`, `es-419`), English otherwise. Errors state it in Content-Language.", "type": "text/plain" }, "key": "Accept-Language", "value": "" }, { "disabled": true, "description": { "content": "Your own ID for the request (letters, digits and `-_.:/+=`), echoed back in the X-Correlation-Id response header and logged next to the request ID. An invalid value gets 400 invalid_correlation_id.", "type": "text/plain" }, "key": "X-Correlation-Id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ruc\": \"1790000000001\",\n \"legalName\": \"Supermercados La Pradera S.A.\",\n \"tradeName\": \"La Pradera\",\n \"headOfficeAddress\": \"Av. Amazonas N34-12 y Av. Atahualpa, Quito\",\n \"taxProfile\": {\n \"keepsAccounting\": false,\n \"specialTaxpayerNumber\": \"5368\",\n \"withholdingAgentResolution\": \"1\",\n \"rimpeRegime\": null,\n \"largeTaxpayerResolution\": \"NAC-GCFOIOC21-00000868-E\"\n },\n \"branding\": {\n \"brandColor\": \"#0f766e\"\n },\n \"sendEmailByDefault\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "List issuers", "request": { "name": "List issuers", "description": { "content": "Newest first. Requires an account-scoped (global) API key with read_write access.", "type": "text/plain" }, "url": { "path": [ "v1", "issuers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Maximum number of items to return.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": true, "description": { "content": "The `pagination.nextCursor` of the previous page. Omit it for the first page.", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "disabled": true, "description": { "content": "Language of error messages and of the localized texts of resources (SRI messages, failures, certificate rejections): Spanish when the entry with the highest q-value is `es` or `es-` plus a region (`es-EC`, `es-419`), English otherwise. Errors state it in Content-Language.", "type": "text/plain" }, "key": "Accept-Language", "value": "" }, { "disabled": true, "description": { "content": "Your own ID for the request (letters, digits and `-_.:/+=`), echoed back in the X-Correlation-Id response header and logged next to the request ID. An invalid value gets 400 invalid_correlation_id.", "type": "text/plain" }, "key": "X-Correlation-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get an issuer", "request": { "name": "Get an issuer", "description": { "content": "Requires an account-scoped (global) API key with read_write access.", "type": "text/plain" }, "url": { "path": [ "v1", "issuers", ":issuerId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "{{issuerId}}", "key": "issuerId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": true, "description": { "content": "Language of error messages and of the localized texts of resources (SRI messages, failures, certificate rejections): Spanish when the entry with the highest q-value is `es` or `es-` plus a region (`es-EC`, `es-419`), English otherwise. Errors state it in Content-Language.", "type": "text/plain" }, "key": "Accept-Language", "value": "" }, { "disabled": true, "description": { "content": "Your own ID for the request (letters, digits and `-_.:/+=`), echoed back in the X-Correlation-Id response header and logged next to the request ID. An invalid value gets 400 invalid_correlation_id.", "type": "text/plain" }, "key": "X-Correlation-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Update an issuer", "request": { "name": "Update an issuer", "description": { "content": "Changes the fields sent; null clears an optional field. The RUC cannot change. Requires an account-scoped (global) API key with read_write access.", "type": "text/plain" }, "url": { "path": [ "v1", "issuers", ":issuerId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "{{issuerId}}", "key": "issuerId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": true, "description": { "content": "Language of error messages and of the localized texts of resources (SRI messages, failures, certificate rejections): Spanish when the entry with the highest q-value is `es` or `es-` plus a region (`es-EC`, `es-419`), English otherwise. Errors state it in Content-Language.", "type": "text/plain" }, "key": "Accept-Language", "value": "" }, { "disabled": true, "description": { "content": "Your own ID for the request (letters, digits and `-_.:/+=`), echoed back in the X-Correlation-Id response header and logged next to the request ID. An invalid value gets 400 invalid_correlation_id.", "type": "text/plain" }, "key": "X-Correlation-Id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"legalName\": \"Supermercados La Pradera S.A.\",\n \"tradeName\": \"La Pradera\",\n \"headOfficeAddress\": \"Av. Amazonas N34-12 y Av. Atahualpa, Quito\",\n \"taxProfile\": {\n \"keepsAccounting\": false,\n \"specialTaxpayerNumber\": \"5368\",\n \"withholdingAgentResolution\": \"1\",\n \"rimpeRegime\": null,\n \"largeTaxpayerResolution\": \"NAC-GCFOIOC21-00000868-E\"\n },\n \"branding\": {\n \"brandColor\": \"#0f766e\"\n },\n \"sendEmailByDefault\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Delete an issuer", "request": { "name": "Delete an issuer", "description": { "content": "Deletes the issuer with its establishments, emission points and issuer-scoped API keys. An issuer with documents or certificates cannot be deleted. Requires an account-scoped (global) API key with read_write access.", "type": "text/plain" }, "url": { "path": [ "v1", "issuers", ":issuerId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "{{issuerId}}", "key": "issuerId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": true, "description": { "content": "Language of error messages and of the localized texts of resources (SRI messages, failures, certificate rejections): Spanish when the entry with the highest q-value is `es` or `es-` plus a region (`es-EC`, `es-419`), English otherwise. Errors state it in Content-Language.", "type": "text/plain" }, "key": "Accept-Language", "value": "" }, { "disabled": true, "description": { "content": "Your own ID for the request (letters, digits and `-_.:/+=`), echoed back in the X-Correlation-Id response header and logged next to the request ID. An invalid value gets 400 invalid_correlation_id.", "type": "text/plain" }, "key": "X-Correlation-Id", "value": "" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Create an establishment", "request": { "name": "Create an establishment", "description": { "content": "Requires an account-scoped (global) API key with read_write access.", "type": "text/plain" }, "url": { "path": [ "v1", "issuers", ":issuerId", "establishments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "{{issuerId}}", "key": "issuerId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Makes the request safe to retry: 1 to 255 visible ASCII characters (a UUID works well), remembered for 24 hours per account and mode. A retry with the same key and the same request returns the first successful response again, with the header `Idempotent-Replayed: true`. The same key with a different request gets 422 idempotency_key_reused; while the first request still runs, 409 idempotency_key_in_progress. A failed request does not keep its key.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "{{$guid}}" }, { "disabled": true, "description": { "content": "Language of error messages and of the localized texts of resources (SRI messages, failures, certificate rejections): Spanish when the entry with the highest q-value is `es` or `es-` plus a region (`es-EC`, `es-419`), English otherwise. Errors state it in Content-Language.", "type": "text/plain" }, "key": "Accept-Language", "value": "" }, { "disabled": true, "description": { "content": "Your own ID for the request (letters, digits and `-_.:/+=`), echoed back in the X-Correlation-Id response header and logged next to the request ID. An invalid value gets 400 invalid_correlation_id.", "type": "text/plain" }, "key": "X-Correlation-Id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"001\",\n \"address\": \"Av. 9 de Octubre 1234 y Malecón, Guayaquil\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "List establishments", "request": { "name": "List establishments", "description": { "content": "By code. Requires an account-scoped (global) API key with read_write access.", "type": "text/plain" }, "url": { "path": [ "v1", "issuers", ":issuerId", "establishments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Maximum number of items to return.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": true, "description": { "content": "The `pagination.nextCursor` of the previous page. Omit it for the first page.", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [ { "type": "any", "value": "{{issuerId}}", "key": "issuerId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": true, "description": { "content": "Language of error messages and of the localized texts of resources (SRI messages, failures, certificate rejections): Spanish when the entry with the highest q-value is `es` or `es-` plus a region (`es-EC`, `es-419`), English otherwise. Errors state it in Content-Language.", "type": "text/plain" }, "key": "Accept-Language", "value": "" }, { "disabled": true, "description": { "content": "Your own ID for the request (letters, digits and `-_.:/+=`), echoed back in the X-Correlation-Id response header and logged next to the request ID. An invalid value gets 400 invalid_correlation_id.", "type": "text/plain" }, "key": "X-Correlation-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get an establishment", "request": { "name": "Get an establishment", "description": { "content": "Requires an account-scoped (global) API key with read_write access.", "type": "text/plain" }, "url": { "path": [ "v1", "issuers", ":issuerId", "establishments", ":establishmentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "{{issuerId}}", "key": "issuerId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "{{establishmentId}}", "key": "establishmentId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": true, "description": { "content": "Language of error messages and of the localized texts of resources (SRI messages, failures, certificate rejections): Spanish when the entry with the highest q-value is `es` or `es-` plus a region (`es-EC`, `es-419`), English otherwise. Errors state it in Content-Language.", "type": "text/plain" }, "key": "Accept-Language", "value": "" }, { "disabled": true, "description": { "content": "Your own ID for the request (letters, digits and `-_.:/+=`), echoed back in the X-Correlation-Id response header and logged next to the request ID. An invalid value gets 400 invalid_correlation_id.", "type": "text/plain" }, "key": "X-Correlation-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Update an establishment", "request": { "name": "Update an establishment", "description": { "content": "Changes the address. The code cannot change. Requires an account-scoped (global) API key with read_write access.", "type": "text/plain" }, "url": { "path": [ "v1", "issuers", ":issuerId", "establishments", ":establishmentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "{{issuerId}}", "key": "issuerId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "{{establishmentId}}", "key": "establishmentId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": true, "description": { "content": "Language of error messages and of the localized texts of resources (SRI messages, failures, certificate rejections): Spanish when the entry with the highest q-value is `es` or `es-` plus a region (`es-EC`, `es-419`), English otherwise. Errors state it in Content-Language.", "type": "text/plain" }, "key": "Accept-Language", "value": "" }, { "disabled": true, "description": { "content": "Your own ID for the request (letters, digits and `-_.:/+=`), echoed back in the X-Correlation-Id response header and logged next to the request ID. An invalid value gets 400 invalid_correlation_id.", "type": "text/plain" }, "key": "X-Correlation-Id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"address\": \"Av. 9 de Octubre 1234 y Malecón, Guayaquil\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Delete an establishment", "request": { "name": "Delete an establishment", "description": { "content": "Deletes it with its emission points; refused when documents use it. Requires an account-scoped (global) API key with read_write access.", "type": "text/plain" }, "url": { "path": [ "v1", "issuers", ":issuerId", "establishments", ":establishmentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "{{issuerId}}", "key": "issuerId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "{{establishmentId}}", "key": "establishmentId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": true, "description": { "content": "Language of error messages and of the localized texts of resources (SRI messages, failures, certificate rejections): Spanish when the entry with the highest q-value is `es` or `es-` plus a region (`es-EC`, `es-419`), English otherwise. Errors state it in Content-Language.", "type": "text/plain" }, "key": "Accept-Language", "value": "" }, { "disabled": true, "description": { "content": "Your own ID for the request (letters, digits and `-_.:/+=`), echoed back in the X-Correlation-Id response header and logged next to the request ID. An invalid value gets 400 invalid_correlation_id.", "type": "text/plain" }, "key": "X-Correlation-Id", "value": "" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Create an emission point", "request": { "name": "Create an emission point", "description": { "content": "Requires an account-scoped (global) API key with read_write access.", "type": "text/plain" }, "url": { "path": [ "v1", "issuers", ":issuerId", "establishments", ":establishmentId", "emission-points" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "{{issuerId}}", "key": "issuerId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "{{establishmentId}}", "key": "establishmentId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Makes the request safe to retry: 1 to 255 visible ASCII characters (a UUID works well), remembered for 24 hours per account and mode. A retry with the same key and the same request returns the first successful response again, with the header `Idempotent-Replayed: true`. The same key with a different request gets 422 idempotency_key_reused; while the first request still runs, 409 idempotency_key_in_progress. A failed request does not keep its key.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "{{$guid}}" }, { "disabled": true, "description": { "content": "Language of error messages and of the localized texts of resources (SRI messages, failures, certificate rejections): Spanish when the entry with the highest q-value is `es` or `es-` plus a region (`es-EC`, `es-419`), English otherwise. Errors state it in Content-Language.", "type": "text/plain" }, "key": "Accept-Language", "value": "" }, { "disabled": true, "description": { "content": "Your own ID for the request (letters, digits and `-_.:/+=`), echoed back in the X-Correlation-Id response header and logged next to the request ID. An invalid value gets 400 invalid_correlation_id.", "type": "text/plain" }, "key": "X-Correlation-Id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"001\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "List emission points", "request": { "name": "List emission points", "description": { "content": "By code. Requires an account-scoped (global) API key with read_write access.", "type": "text/plain" }, "url": { "path": [ "v1", "issuers", ":issuerId", "establishments", ":establishmentId", "emission-points" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Maximum number of items to return.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": true, "description": { "content": "The `pagination.nextCursor` of the previous page. Omit it for the first page.", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [ { "type": "any", "value": "{{issuerId}}", "key": "issuerId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "{{establishmentId}}", "key": "establishmentId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": true, "description": { "content": "Language of error messages and of the localized texts of resources (SRI messages, failures, certificate rejections): Spanish when the entry with the highest q-value is `es` or `es-` plus a region (`es-EC`, `es-419`), English otherwise. Errors state it in Content-Language.", "type": "text/plain" }, "key": "Accept-Language", "value": "" }, { "disabled": true, "description": { "content": "Your own ID for the request (letters, digits and `-_.:/+=`), echoed back in the X-Correlation-Id response header and logged next to the request ID. An invalid value gets 400 invalid_correlation_id.", "type": "text/plain" }, "key": "X-Correlation-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get an emission point", "request": { "name": "Get an emission point", "description": { "content": "Requires an account-scoped (global) API key with read_write access.", "type": "text/plain" }, "url": { "path": [ "v1", "issuers", ":issuerId", "establishments", ":establishmentId", "emission-points", ":emissionPointId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "{{issuerId}}", "key": "issuerId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "{{establishmentId}}", "key": "establishmentId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "{{emissionPointId}}", "key": "emissionPointId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": true, "description": { "content": "Language of error messages and of the localized texts of resources (SRI messages, failures, certificate rejections): Spanish when the entry with the highest q-value is `es` or `es-` plus a region (`es-EC`, `es-419`), English otherwise. Errors state it in Content-Language.", "type": "text/plain" }, "key": "Accept-Language", "value": "" }, { "disabled": true, "description": { "content": "Your own ID for the request (letters, digits and `-_.:/+=`), echoed back in the X-Correlation-Id response header and logged next to the request ID. An invalid value gets 400 invalid_correlation_id.", "type": "text/plain" }, "key": "X-Correlation-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Delete an emission point", "request": { "name": "Delete an emission point", "description": { "content": "Refused when documents use it. Requires an account-scoped (global) API key with read_write access.", "type": "text/plain" }, "url": { "path": [ "v1", "issuers", ":issuerId", "establishments", ":establishmentId", "emission-points", ":emissionPointId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "{{issuerId}}", "key": "issuerId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "{{establishmentId}}", "key": "establishmentId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "{{emissionPointId}}", "key": "emissionPointId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": true, "description": { "content": "Language of error messages and of the localized texts of resources (SRI messages, failures, certificate rejections): Spanish when the entry with the highest q-value is `es` or `es-` plus a region (`es-EC`, `es-419`), English otherwise. Errors state it in Content-Language.", "type": "text/plain" }, "key": "Accept-Language", "value": "" }, { "disabled": true, "description": { "content": "Your own ID for the request (letters, digits and `-_.:/+=`), echoed back in the X-Correlation-Id response header and logged next to the request ID. An invalid value gets 400 invalid_correlation_id.", "type": "text/plain" }, "key": "X-Correlation-Id", "value": "" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Certificates", "description": "", "item": [ { "name": "Upload an issuer's signing certificate", "request": { "name": "Upload an issuer's signing certificate", "description": { "content": "Uploads the .p12 (PKCS#12) file and its password as multipart/form-data. Flashpi encrypts both at once and checks them asynchronously (password, signing key, validity, trusted Ecuadorian certification authority, revocation): the certificate starts `processing`, then becomes `accepted` or `rejected`; follow it with GET. The password is never stored in clear nor returned. Requires an account-scoped (global) API key with read_write access. Test keys manage test certificates and live keys live ones; a certificate of the issuer onboarding serves both modes (`allModes`) and both read it.", "type": "text/plain" }, "url": { "path": [ "v1", "issuers", ":issuerId", "certificates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "{{issuerId}}", "key": "issuerId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Makes the request safe to retry: 1 to 255 visible ASCII characters (a UUID works well), remembered for 24 hours per account and mode. A retry with the same key and the same request returns the first successful response again, with the header `Idempotent-Replayed: true`. The same key with a different request gets 422 idempotency_key_reused; while the first request still runs, 409 idempotency_key_in_progress. A failed request does not keep its key.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "{{$guid}}" }, { "disabled": true, "description": { "content": "Language of error messages and of the localized texts of resources (SRI messages, failures, certificate rejections): Spanish when the entry with the highest q-value is `es` or `es-` plus a region (`es-EC`, `es-419`), English otherwise. Errors state it in Content-Language.", "type": "text/plain" }, "key": "Accept-Language", "value": "" }, { "disabled": true, "description": { "content": "Your own ID for the request (letters, digits and `-_.:/+=`), echoed back in the X-Correlation-Id response header and logged next to the request ID. An invalid value gets 400 invalid_correlation_id.", "type": "text/plain" }, "key": "X-Correlation-Id", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) The .p12 file, at most 1048576 bytes.", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "(Required) Its password, at most 1024 bytes in UTF-8.", "type": "text/plain" }, "key": "password", "value": "", "type": "text" } ] } }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "List an issuer's certificates", "request": { "name": "List an issuer's certificates", "description": { "content": "Newest first. Requires an account-scoped (global) API key with read_write access. Test keys manage test certificates and live keys live ones; a certificate of the issuer onboarding serves both modes (`allModes`) and both read it.", "type": "text/plain" }, "url": { "path": [ "v1", "issuers", ":issuerId", "certificates" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Maximum number of items to return.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": true, "description": { "content": "The `pagination.nextCursor` of the previous page. Omit it for the first page.", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [ { "type": "any", "value": "{{issuerId}}", "key": "issuerId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": true, "description": { "content": "Language of error messages and of the localized texts of resources (SRI messages, failures, certificate rejections): Spanish when the entry with the highest q-value is `es` or `es-` plus a region (`es-EC`, `es-419`), English otherwise. Errors state it in Content-Language.", "type": "text/plain" }, "key": "Accept-Language", "value": "" }, { "disabled": true, "description": { "content": "Your own ID for the request (letters, digits and `-_.:/+=`), echoed back in the X-Correlation-Id response header and logged next to the request ID. An invalid value gets 400 invalid_correlation_id.", "type": "text/plain" }, "key": "X-Correlation-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get a certificate", "request": { "name": "Get a certificate", "description": { "content": "Requires an account-scoped (global) API key with read_write access. Test keys manage test certificates and live keys live ones; a certificate of the issuer onboarding serves both modes (`allModes`) and both read it.", "type": "text/plain" }, "url": { "path": [ "v1", "issuers", ":issuerId", "certificates", ":certificateId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "{{issuerId}}", "key": "issuerId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "{{certificateId}}", "key": "certificateId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": true, "description": { "content": "Language of error messages and of the localized texts of resources (SRI messages, failures, certificate rejections): Spanish when the entry with the highest q-value is `es` or `es-` plus a region (`es-EC`, `es-419`), English otherwise. Errors state it in Content-Language.", "type": "text/plain" }, "key": "Accept-Language", "value": "" }, { "disabled": true, "description": { "content": "Your own ID for the request (letters, digits and `-_.:/+=`), echoed back in the X-Correlation-Id response header and logged next to the request ID. An invalid value gets 400 invalid_correlation_id.", "type": "text/plain" }, "key": "X-Correlation-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Issuer onboardings", "description": "", "item": [ { "name": "Start an issuer onboarding from a .p12", "request": { "name": "Start an issuer onboarding from a .p12", "description": { "content": "Uploads the .p12 (PKCS#12) file and its password as multipart/form-data. Flashpi encrypts both at once and verifies them asynchronously (password, signing key, validity, trusted Ecuadorian certification authority, revocation): the onboarding starts `verifying`; retrieve it until it is `ready` (with the RUC and the holder, plus the SRI's profile when the registry lookup is on: see `sri.status`) or `rejected`, then complete it within 6 days. The password is never stored in clear nor returned. Requires an account-scoped (global) API key with read_write access, of either mode: the certificate serves test and live documents.", "type": "text/plain" }, "url": { "path": [ "v1", "issuer-onboardings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Makes the request safe to retry: 1 to 255 visible ASCII characters (a UUID works well), remembered for 24 hours per account and mode. A retry with the same key and the same request returns the first successful response again, with the header `Idempotent-Replayed: true`. The same key with a different request gets 422 idempotency_key_reused; while the first request still runs, 409 idempotency_key_in_progress. A failed request does not keep its key.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "{{$guid}}" }, { "disabled": true, "description": { "content": "Language of error messages and of the localized texts of resources (SRI messages, failures, certificate rejections): Spanish when the entry with the highest q-value is `es` or `es-` plus a region (`es-EC`, `es-419`), English otherwise. Errors state it in Content-Language.", "type": "text/plain" }, "key": "Accept-Language", "value": "" }, { "disabled": true, "description": { "content": "Your own ID for the request (letters, digits and `-_.:/+=`), echoed back in the X-Correlation-Id response header and logged next to the request ID. An invalid value gets 400 invalid_correlation_id.", "type": "text/plain" }, "key": "X-Correlation-Id", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) The .p12 file, at most 1048576 bytes.", "type": "text/plain" }, "key": "file", "type": "file" }, { "description": { "content": "(Required) Its password, at most 1024 bytes in UTF-8.", "type": "text/plain" }, "key": "password", "value": "", "type": "text" } ] } }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get an issuer onboarding", "request": { "name": "Get an issuer onboarding", "description": { "content": "Poll it while `verifying` (every few seconds; verification usually takes under a minute). An onboarding is deleted 30 days after it is completed, expires or is rejected, and then answers 404 `not_found`. Requires an account-scoped (global) API key with read_write access, of either mode: the certificate serves test and live documents.", "type": "text/plain" }, "url": { "path": [ "v1", "issuer-onboardings", ":onboardingId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "{{onboardingId}}", "key": "onboardingId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": true, "description": { "content": "Language of error messages and of the localized texts of resources (SRI messages, failures, certificate rejections): Spanish when the entry with the highest q-value is `es` or `es-` plus a region (`es-EC`, `es-419`), English otherwise. Errors state it in Content-Language.", "type": "text/plain" }, "key": "Accept-Language", "value": "" }, { "disabled": true, "description": { "content": "Your own ID for the request (letters, digits and `-_.:/+=`), echoed back in the X-Correlation-Id response header and logged next to the request ID. An invalid value gets 400 invalid_correlation_id.", "type": "text/plain" }, "key": "X-Correlation-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Complete an issuer onboarding", "request": { "name": "Complete an issuer onboarding", "description": { "content": "Creates the issuer with the tax profile sent (the same fields as POST /v1/issuers; start from `prefill`), its establishment 001 at the head office and emission point 001; or, when the account already has the certificate's RUC (`existingIssuer`), adds the certificate to that issuer without changing it (the body may be `{}`). The certificate serves test and live documents and starts `processing`: retrieve it under the issuer. The tax profile is the customer's responsibility. Requires an account-scoped (global) API key with read_write access, of either mode: the certificate serves test and live documents.", "type": "text/plain" }, "url": { "path": [ "v1", "issuer-onboardings", ":onboardingId", "complete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "{{onboardingId}}", "key": "onboardingId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Makes the request safe to retry: 1 to 255 visible ASCII characters (a UUID works well), remembered for 24 hours per account and mode. A retry with the same key and the same request returns the first successful response again, with the header `Idempotent-Replayed: true`. The same key with a different request gets 422 idempotency_key_reused; while the first request still runs, 409 idempotency_key_in_progress. A failed request does not keep its key.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "{{$guid}}" }, { "disabled": true, "description": { "content": "Language of error messages and of the localized texts of resources (SRI messages, failures, certificate rejections): Spanish when the entry with the highest q-value is `es` or `es-` plus a region (`es-EC`, `es-419`), English otherwise. Errors state it in Content-Language.", "type": "text/plain" }, "key": "Accept-Language", "value": "" }, { "disabled": true, "description": { "content": "Your own ID for the request (letters, digits and `-_.:/+=`), echoed back in the X-Correlation-Id response header and logged next to the request ID. An invalid value gets 400 invalid_correlation_id.", "type": "text/plain" }, "key": "X-Correlation-Id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ruc\": \"1712345678001\",\n \"legalName\": \"\",\n \"tradeName\": null,\n \"headOfficeAddress\": \"\",\n \"taxProfile\": {\n \"keepsAccounting\": false,\n \"specialTaxpayerNumber\": \"5368\",\n \"withholdingAgentResolution\": \"1\",\n \"rimpeRegime\": null,\n \"largeTaxpayerResolution\": \"NAC-GCFOIOC21-00000868-E\"\n },\n \"branding\": {\n \"brandColor\": \"#0f766e\"\n },\n \"sendEmailByDefault\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Invoices", "description": "", "item": [ { "name": "Issue an invoice", "request": { "name": "Issue an invoice", "description": { "content": "Issues an invoice (factura, XML 2.1.0). Flashpi computes the line subtotals, the taxes per rate, the tip and the total with the SRI rounding rules; send expectedTotal to have a different total refused. Issuing is asynchronous: the document is validated, numbered (sequential and access key) and stored with status `processing`, and the response is 202 Accepted. Flashpi then signs it and sends it to the SRI; follow it with GET /v1/documents/{id} or webhooks. With `options.waitForAuthorization` the request waits for the SRI (15 s by default, 30 s at most) and answers 200 with the authorized, rejected or failed document, or 202 when the wait ends first. Requires a read_write API key; an issuer-scoped key can only issue for its issuer. fp_test_ keys issue in the SRI test environment, fp_live_ keys in production.", "type": "text/plain" }, "url": { "path": [ "v1", "invoices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Makes the request safe to retry: 1 to 255 visible ASCII characters (a UUID works well), remembered for 24 hours per account and mode. A retry with the same key and the same request returns the first successful response again, with the header `Idempotent-Replayed: true`. The same key with a different request gets 422 idempotency_key_reused; while the first request still runs, 409 idempotency_key_in_progress. A failed request does not keep its key.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "{{$guid}}" }, { "disabled": true, "description": { "content": "Language of error messages and of the localized texts of resources (SRI messages, failures, certificate rejections): Spanish when the entry with the highest q-value is `es` or `es-` plus a region (`es-EC`, `es-419`), English otherwise. Errors state it in Content-Language.", "type": "text/plain" }, "key": "Accept-Language", "value": "" }, { "disabled": true, "description": { "content": "Your own ID for the request (letters, digits and `-_.:/+=`), echoed back in the X-Correlation-Id response header and logged next to the request ID. An invalid value gets 400 invalid_correlation_id.", "type": "text/plain" }, "key": "X-Correlation-Id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"issuerId\": \"{{issuerId}}\",\n \"establishment\": \"001\",\n \"emissionPoint\": \"001\",\n \"issueDate\": \"2026-10-15\",\n \"customer\": {\n \"idType\": \"ruc\",\n \"id\": \"1790000000001\",\n \"name\": \"Supermercados La Pradera S.A.\",\n \"email\": \"{{buyerEmail}}\",\n \"address\": \"Av. Amazonas N34-12, Quito\"\n },\n \"items\": [\n {\n \"code\": \"SKU-001\",\n \"description\": \"Ground coffee 500 g\",\n \"quantity\": \"2\",\n \"unitPrice\": \"4.50\",\n \"taxes\": [\n {\n \"type\": \"vat\",\n \"rate\": \"15\"\n }\n ]\n }\n ],\n \"payments\": [\n {\n \"method\": \"credit_card\",\n \"amount\": \"10.35\"\n }\n ],\n \"additionalInfo\": {\n \"Order\": \"PO-4812\"\n },\n \"expectedTotal\": \"10.35\",\n \"options\": {\n \"sendEmail\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Credit notes", "description": "", "item": [ { "name": "Issue a credit note", "request": { "name": "Issue a credit note", "description": { "content": "Issues a credit note (nota de crédito, XML 1.1.0) that modifies an invoice. Its VAT rates are the ones in force on the invoice date. Issuing is asynchronous: the document is validated, numbered (sequential and access key) and stored with status `processing`, and the response is 202 Accepted. Flashpi then signs it and sends it to the SRI; follow it with GET /v1/documents/{id} or webhooks. With `options.waitForAuthorization` the request waits for the SRI (15 s by default, 30 s at most) and answers 200 with the authorized, rejected or failed document, or 202 when the wait ends first. Requires a read_write API key; an issuer-scoped key can only issue for its issuer. fp_test_ keys issue in the SRI test environment, fp_live_ keys in production.", "type": "text/plain" }, "url": { "path": [ "v1", "credit-notes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Makes the request safe to retry: 1 to 255 visible ASCII characters (a UUID works well), remembered for 24 hours per account and mode. A retry with the same key and the same request returns the first successful response again, with the header `Idempotent-Replayed: true`. The same key with a different request gets 422 idempotency_key_reused; while the first request still runs, 409 idempotency_key_in_progress. A failed request does not keep its key.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "{{$guid}}" }, { "disabled": true, "description": { "content": "Language of error messages and of the localized texts of resources (SRI messages, failures, certificate rejections): Spanish when the entry with the highest q-value is `es` or `es-` plus a region (`es-EC`, `es-419`), English otherwise. Errors state it in Content-Language.", "type": "text/plain" }, "key": "Accept-Language", "value": "" }, { "disabled": true, "description": { "content": "Your own ID for the request (letters, digits and `-_.:/+=`), echoed back in the X-Correlation-Id response header and logged next to the request ID. An invalid value gets 400 invalid_correlation_id.", "type": "text/plain" }, "key": "X-Correlation-Id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"issuerId\": \"{{issuerId}}\",\n \"establishment\": \"001\",\n \"emissionPoint\": \"001\",\n \"customer\": {\n \"idType\": \"ruc\",\n \"id\": \"1790000000001\",\n \"name\": \"Supermercados La Pradera S.A.\",\n \"email\": \"{{buyerEmail}}\"\n },\n \"modifiedDocument\": {\n \"type\": \"invoice\",\n \"number\": \"001-001-000000123\",\n \"issueDate\": \"2026-10-15\"\n },\n \"reason\": \"Return of damaged goods\",\n \"items\": [\n {\n \"code\": \"SKU-001\",\n \"description\": \"Ground coffee 500 g\",\n \"quantity\": \"1\",\n \"unitPrice\": \"4.50\",\n \"taxes\": [\n {\n \"type\": \"vat\",\n \"rate\": \"15\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Debit notes", "description": "", "item": [ { "name": "Issue a debit note", "request": { "name": "Issue a debit note", "description": { "content": "Issues a debit note (nota de débito, XML 1.0.0) that modifies an invoice. Its VAT rates are the ones in force on the invoice date. Issuing is asynchronous: the document is validated, numbered (sequential and access key) and stored with status `processing`, and the response is 202 Accepted. Flashpi then signs it and sends it to the SRI; follow it with GET /v1/documents/{id} or webhooks. With `options.waitForAuthorization` the request waits for the SRI (15 s by default, 30 s at most) and answers 200 with the authorized, rejected or failed document, or 202 when the wait ends first. Requires a read_write API key; an issuer-scoped key can only issue for its issuer. fp_test_ keys issue in the SRI test environment, fp_live_ keys in production.", "type": "text/plain" }, "url": { "path": [ "v1", "debit-notes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Makes the request safe to retry: 1 to 255 visible ASCII characters (a UUID works well), remembered for 24 hours per account and mode. A retry with the same key and the same request returns the first successful response again, with the header `Idempotent-Replayed: true`. The same key with a different request gets 422 idempotency_key_reused; while the first request still runs, 409 idempotency_key_in_progress. A failed request does not keep its key.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "{{$guid}}" }, { "disabled": true, "description": { "content": "Language of error messages and of the localized texts of resources (SRI messages, failures, certificate rejections): Spanish when the entry with the highest q-value is `es` or `es-` plus a region (`es-EC`, `es-419`), English otherwise. Errors state it in Content-Language.", "type": "text/plain" }, "key": "Accept-Language", "value": "" }, { "disabled": true, "description": { "content": "Your own ID for the request (letters, digits and `-_.:/+=`), echoed back in the X-Correlation-Id response header and logged next to the request ID. An invalid value gets 400 invalid_correlation_id.", "type": "text/plain" }, "key": "X-Correlation-Id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"issuerId\": \"{{issuerId}}\",\n \"establishment\": \"001\",\n \"emissionPoint\": \"001\",\n \"customer\": {\n \"idType\": \"ruc\",\n \"id\": \"1790000000001\",\n \"name\": \"Supermercados La Pradera S.A.\",\n \"email\": \"{{buyerEmail}}\"\n },\n \"modifiedDocument\": {\n \"number\": \"001-001-000000123\",\n \"issueDate\": \"2026-10-15\"\n },\n \"reasons\": [\n {\n \"description\": \"Late payment interest\",\n \"amount\": \"10.00\",\n \"taxes\": [\n {\n \"type\": \"vat\",\n \"rate\": \"15\"\n }\n ]\n }\n ],\n \"payments\": [\n {\n \"method\": \"other_financial_system\",\n \"amount\": \"11.50\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Purchase settlements", "description": "", "item": [ { "name": "Issue a purchase settlement", "request": { "name": "Issue a purchase settlement", "description": { "content": "Issues a purchase settlement (liquidación de compra, XML 1.1.0) for a purchase from a supplier who cannot issue invoices. Issuing is asynchronous: the document is validated, numbered (sequential and access key) and stored with status `processing`, and the response is 202 Accepted. Flashpi then signs it and sends it to the SRI; follow it with GET /v1/documents/{id} or webhooks. With `options.waitForAuthorization` the request waits for the SRI (15 s by default, 30 s at most) and answers 200 with the authorized, rejected or failed document, or 202 when the wait ends first. Requires a read_write API key; an issuer-scoped key can only issue for its issuer. fp_test_ keys issue in the SRI test environment, fp_live_ keys in production.", "type": "text/plain" }, "url": { "path": [ "v1", "purchase-settlements" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Makes the request safe to retry: 1 to 255 visible ASCII characters (a UUID works well), remembered for 24 hours per account and mode. A retry with the same key and the same request returns the first successful response again, with the header `Idempotent-Replayed: true`. The same key with a different request gets 422 idempotency_key_reused; while the first request still runs, 409 idempotency_key_in_progress. A failed request does not keep its key.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "{{$guid}}" }, { "disabled": true, "description": { "content": "Language of error messages and of the localized texts of resources (SRI messages, failures, certificate rejections): Spanish when the entry with the highest q-value is `es` or `es-` plus a region (`es-EC`, `es-419`), English otherwise. Errors state it in Content-Language.", "type": "text/plain" }, "key": "Accept-Language", "value": "" }, { "disabled": true, "description": { "content": "Your own ID for the request (letters, digits and `-_.:/+=`), echoed back in the X-Correlation-Id response header and logged next to the request ID. An invalid value gets 400 invalid_correlation_id.", "type": "text/plain" }, "key": "X-Correlation-Id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"issuerId\": \"{{issuerId}}\",\n \"establishment\": \"001\",\n \"emissionPoint\": \"001\",\n \"supplier\": {\n \"idType\": \"cedula\",\n \"id\": \"1700000001\",\n \"name\": \"María Fernanda Quishpe\",\n \"address\": \"Recinto La Esperanza, Balzar\"\n },\n \"items\": [\n {\n \"code\": \"CACAO\",\n \"description\": \"Dried cocoa beans\",\n \"unit\": \"KILOGRAM\",\n \"quantity\": \"150.5\",\n \"unitPrice\": \"2.35\",\n \"taxes\": [\n {\n \"type\": \"vat\",\n \"rate\": \"0\"\n }\n ]\n }\n ],\n \"payments\": [\n {\n \"method\": \"cash\",\n \"amount\": \"353.68\",\n \"term\": \"0\",\n \"termUnit\": \"days\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Waybills", "description": "", "item": [ { "name": "Issue a waybill", "request": { "name": "Issue a waybill", "description": { "content": "Issues a waybill (guía de remisión, XML 1.1.0) for the transport of goods. Issuing is asynchronous: the document is validated, numbered (sequential and access key) and stored with status `processing`, and the response is 202 Accepted. Flashpi then signs it and sends it to the SRI; follow it with GET /v1/documents/{id} or webhooks. With `options.waitForAuthorization` the request waits for the SRI (15 s by default, 30 s at most) and answers 200 with the authorized, rejected or failed document, or 202 when the wait ends first. Requires a read_write API key; an issuer-scoped key can only issue for its issuer. fp_test_ keys issue in the SRI test environment, fp_live_ keys in production.", "type": "text/plain" }, "url": { "path": [ "v1", "waybills" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Makes the request safe to retry: 1 to 255 visible ASCII characters (a UUID works well), remembered for 24 hours per account and mode. A retry with the same key and the same request returns the first successful response again, with the header `Idempotent-Replayed: true`. The same key with a different request gets 422 idempotency_key_reused; while the first request still runs, 409 idempotency_key_in_progress. A failed request does not keep its key.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "{{$guid}}" }, { "disabled": true, "description": { "content": "Language of error messages and of the localized texts of resources (SRI messages, failures, certificate rejections): Spanish when the entry with the highest q-value is `es` or `es-` plus a region (`es-EC`, `es-419`), English otherwise. Errors state it in Content-Language.", "type": "text/plain" }, "key": "Accept-Language", "value": "" }, { "disabled": true, "description": { "content": "Your own ID for the request (letters, digits and `-_.:/+=`), echoed back in the X-Correlation-Id response header and logged next to the request ID. An invalid value gets 400 invalid_correlation_id.", "type": "text/plain" }, "key": "X-Correlation-Id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"issuerId\": \"{{issuerId}}\",\n \"establishment\": \"001\",\n \"emissionPoint\": \"001\",\n \"issueDate\": \"2026-10-15\",\n \"departureAddress\": \"Km 12 vía a Daule, Guayaquil\",\n \"carrier\": {\n \"idType\": \"ruc\",\n \"id\": \"0190000000001\",\n \"name\": \"Transportes Andinos Cía. Ltda.\"\n },\n \"licensePlate\": \"GBA1234\",\n \"transportStartDate\": \"2026-10-15\",\n \"transportEndDate\": \"2026-10-16\",\n \"recipients\": [\n {\n \"id\": \"1790000000001\",\n \"name\": \"Supermercados La Pradera S.A.\",\n \"address\": \"Av. Amazonas N34-12, Quito\",\n \"transferReason\": \"Sale\",\n \"supportingDocument\": {\n \"type\": \"invoice\",\n \"number\": \"001-001-000000123\",\n \"issueDate\": \"2026-10-15\"\n },\n \"items\": [\n {\n \"code\": \"SKU-001\",\n \"description\": \"Ground coffee 500 g\",\n \"quantity\": \"24\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Withholdings", "description": "", "item": [ { "name": "Issue a withholding receipt", "request": { "name": "Issue a withholding receipt", "description": { "content": "Issues a withholding receipt (comprobante de retención, XML 2.0.0). Flashpi computes every withheld amount and the total withheld. Issuing is asynchronous: the document is validated, numbered (sequential and access key) and stored with status `processing`, and the response is 202 Accepted. Flashpi then signs it and sends it to the SRI; follow it with GET /v1/documents/{id} or webhooks. With `options.waitForAuthorization` the request waits for the SRI (15 s by default, 30 s at most) and answers 200 with the authorized, rejected or failed document, or 202 when the wait ends first. Requires a read_write API key; an issuer-scoped key can only issue for its issuer. fp_test_ keys issue in the SRI test environment, fp_live_ keys in production.", "type": "text/plain" }, "url": { "path": [ "v1", "withholdings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Makes the request safe to retry: 1 to 255 visible ASCII characters (a UUID works well), remembered for 24 hours per account and mode. A retry with the same key and the same request returns the first successful response again, with the header `Idempotent-Replayed: true`. The same key with a different request gets 422 idempotency_key_reused; while the first request still runs, 409 idempotency_key_in_progress. A failed request does not keep its key.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "{{$guid}}" }, { "disabled": true, "description": { "content": "Language of error messages and of the localized texts of resources (SRI messages, failures, certificate rejections): Spanish when the entry with the highest q-value is `es` or `es-` plus a region (`es-EC`, `es-419`), English otherwise. Errors state it in Content-Language.", "type": "text/plain" }, "key": "Accept-Language", "value": "" }, { "disabled": true, "description": { "content": "Your own ID for the request (letters, digits and `-_.:/+=`), echoed back in the X-Correlation-Id response header and logged next to the request ID. An invalid value gets 400 invalid_correlation_id.", "type": "text/plain" }, "key": "X-Correlation-Id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"issuerId\": \"{{issuerId}}\",\n \"establishment\": \"001\",\n \"emissionPoint\": \"001\",\n \"subject\": {\n \"idType\": \"ruc\",\n \"id\": \"0990000000001\",\n \"name\": \"Distribuidora del Pacífico S.A.\",\n \"relatedParty\": false\n },\n \"supportingDocuments\": [\n {\n \"taxSupportCode\": \"01\",\n \"documentTypeCode\": \"01\",\n \"number\": \"001-002-000004567\",\n \"issueDate\": \"2026-10-10\",\n \"subtotal\": \"1000.00\",\n \"total\": \"1150.00\",\n \"taxes\": [\n {\n \"type\": \"vat\",\n \"rate\": \"15\",\n \"taxableBase\": \"1000.00\"\n }\n ],\n \"withholdings\": [\n {\n \"tax\": \"income_tax\",\n \"code\": \"312\",\n \"taxableBase\": \"1000.00\",\n \"rate\": \"1.75\"\n },\n {\n \"tax\": \"vat\",\n \"code\": \"1\",\n \"taxableBase\": \"150.00\"\n }\n ],\n \"payments\": [\n {\n \"method\": \"other_financial_system\",\n \"amount\": \"1150.00\"\n }\n ]\n }\n ],\n \"expectedTotal\": \"62.50\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Documents", "description": "", "item": [ { "name": "List documents", "request": { "name": "List documents", "description": { "content": "Documents of every type, newest first, with optional filters. Any API key can read (read_only included); an issuer-scoped key only sees its issuer. Test keys see test documents and live keys live documents.", "type": "text/plain" }, "url": { "path": [ "v1", "documents" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Maximum number of items to return.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": true, "description": { "content": "The `pagination.nextCursor` of the previous page. Omit it for the first page.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": true, "description": { "content": "Only documents of this issuer.", "type": "text/plain" }, "key": "issuerId", "value": "" }, { "disabled": true, "description": { "content": "Only this document type. (This can only be one of invoice,purchase_settlement,credit_note,debit_note,waybill,withholding)", "type": "text/plain" }, "key": "type", "value": "invoice" }, { "disabled": true, "description": { "content": "Only this tax status. (This can only be one of processing,pending_sri,authorized,rejected,failed,voided)", "type": "text/plain" }, "key": "status", "value": "processing" }, { "disabled": true, "description": { "content": "Only documents issued on or after this date.", "type": "text/plain" }, "key": "issueDateFrom", "value": "2026-10-01" }, { "disabled": true, "description": { "content": "Only documents issued on or before this date.", "type": "text/plain" }, "key": "issueDateTo", "value": "2026-10-31" }, { "disabled": true, "description": { "content": "Only documents of this buyer, supplier, withheld subject or carrier.", "type": "text/plain" }, "key": "counterpartyId", "value": "1790000000001" }, { "disabled": true, "description": { "content": "The document with this access key.", "type": "text/plain" }, "key": "accessKey", "value": "" } ], "variable": [] }, "header": [ { "disabled": true, "description": { "content": "Language of error messages and of the localized texts of resources (SRI messages, failures, certificate rejections): Spanish when the entry with the highest q-value is `es` or `es-` plus a region (`es-EC`, `es-419`), English otherwise. Errors state it in Content-Language.", "type": "text/plain" }, "key": "Accept-Language", "value": "" }, { "disabled": true, "description": { "content": "Your own ID for the request (letters, digits and `-_.:/+=`), echoed back in the X-Correlation-Id response header and logged next to the request ID. An invalid value gets 400 invalid_correlation_id.", "type": "text/plain" }, "key": "X-Correlation-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get a document", "request": { "name": "Get a document", "description": { "content": "Any API key can read (read_only included); an issuer-scoped key only sees its issuer. Test keys see test documents and live keys live documents.", "type": "text/plain" }, "url": { "path": [ "v1", "documents", ":documentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "{{documentId}}", "key": "documentId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": true, "description": { "content": "Language of error messages and of the localized texts of resources (SRI messages, failures, certificate rejections): Spanish when the entry with the highest q-value is `es` or `es-` plus a region (`es-EC`, `es-419`), English otherwise. Errors state it in Content-Language.", "type": "text/plain" }, "key": "Accept-Language", "value": "" }, { "disabled": true, "description": { "content": "Your own ID for the request (letters, digits and `-_.:/+=`), echoed back in the X-Correlation-Id response header and logged next to the request ID. An invalid value gets 400 invalid_correlation_id.", "type": "text/plain" }, "key": "X-Correlation-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get the XML of a document", "request": { "name": "Get the XML of a document", "description": { "content": "The most advanced XML available: the authorized XML once the SRI authorized the document, else the signed XML, else the unsigned XML Flashpi built. The `Flashpi-Xml-Kind` header says which one (authorized, signed or unsigned). Any API key can read (read_only included); an issuer-scoped key only sees its issuer. Test keys see test documents and live keys live documents.", "type": "text/plain" }, "url": { "path": [ "v1", "documents", ":documentId", "xml" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "{{documentId}}", "key": "documentId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": true, "description": { "content": "Language of error messages and of the localized texts of resources (SRI messages, failures, certificate rejections): Spanish when the entry with the highest q-value is `es` or `es-` plus a region (`es-EC`, `es-419`), English otherwise. Errors state it in Content-Language.", "type": "text/plain" }, "key": "Accept-Language", "value": "" }, { "disabled": true, "description": { "content": "Your own ID for the request (letters, digits and `-_.:/+=`), echoed back in the X-Correlation-Id response header and logged next to the request ID. An invalid value gets 400 invalid_correlation_id.", "type": "text/plain" }, "key": "X-Correlation-Id", "value": "" }, { "key": "Accept", "value": "application/xml" } ], "method": "GET", "body": {} }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get the RIDE (PDF) of a document", "request": { "name": "Get the RIDE (PDF) of a document", "description": { "content": "The RIDE, the printed representation of the authorized document, in the template of the account (`modern` unless the account chose `classic` or `minimal`) with the issuer's branding. It is generated once the SRI authorizes the document; until then, or when its generation failed, the answer is 409 `ride_not_available` with the `rideStatus`. Any API key can read (read_only included); an issuer-scoped key only sees its issuer. Test keys see test documents and live keys live documents.", "type": "text/plain" }, "url": { "path": [ "v1", "documents", ":documentId", "pdf" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "{{documentId}}", "key": "documentId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": true, "description": { "content": "Language of error messages and of the localized texts of resources (SRI messages, failures, certificate rejections): Spanish when the entry with the highest q-value is `es` or `es-` plus a region (`es-EC`, `es-419`), English otherwise. Errors state it in Content-Language.", "type": "text/plain" }, "key": "Accept-Language", "value": "" }, { "disabled": true, "description": { "content": "Your own ID for the request (letters, digits and `-_.:/+=`), echoed back in the X-Correlation-Id response header and logged next to the request ID. An invalid value gets 400 invalid_correlation_id.", "type": "text/plain" }, "key": "X-Correlation-Id", "value": "" }, { "key": "Accept", "value": "application/pdf" } ], "method": "GET", "body": {} }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Email a document again", "request": { "name": "Email a document again", "description": { "content": "Emails the authorized document (RIDE PDF and XML) to the email address of its request, also when the email was not requested when it was issued. A new delivery appears in `email.deliveries` and `email.status` becomes `queued`; the email goes out once the RIDE exists (a failed RIDE is generated again first). Follow it with GET /v1/documents/{id} or the `document.email.*` events. Requires a read_write API key; an issuer-scoped key only reaches its issuer.\n\nDaily limits (calendar days in Ecuador, UTC-5): a document can be emailed again at most 3 times a day in test mode, and an account queues at most 20 test emails a day (automatic emails of authorized documents and resends together). Live limits default to 10 resends per document and 200 emails per account a day, and Flashpi queues a limited number of emails a day across all accounts. Beyond them the answer is 429 with `Retry-After` and `resetsAt` (the next midnight in Ecuador), plus the `limit` of an account or document limit; an automatic email beyond a limit becomes a failed delivery with the error `account_email_limit_reached` or `platform_email_limit_reached`.\n\nTest mode: documents are only emailed to verified email addresses of the account's team members (console users who verified their address). Any other recipient is never emailed: the automatic email becomes a failed delivery with the error `test_recipient_not_allowed`, and this endpoint answers 409. Live documents are not restricted this way.", "type": "text/plain" }, "url": { "path": [ "v1", "documents", ":documentId", "email" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "{{documentId}}", "key": "documentId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Makes the request safe to retry: 1 to 255 visible ASCII characters (a UUID works well), remembered for 24 hours per account and mode. A retry with the same key and the same request returns the first successful response again, with the header `Idempotent-Replayed: true`. The same key with a different request gets 422 idempotency_key_reused; while the first request still runs, 409 idempotency_key_in_progress. A failed request does not keep its key.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "{{$guid}}" }, { "disabled": true, "description": { "content": "Language of error messages and of the localized texts of resources (SRI messages, failures, certificate rejections): Spanish when the entry with the highest q-value is `es` or `es-` plus a region (`es-EC`, `es-419`), English otherwise. Errors state it in Content-Language.", "type": "text/plain" }, "key": "Accept-Language", "value": "" }, { "disabled": true, "description": { "content": "Your own ID for the request (letters, digits and `-_.:/+=`), echoed back in the X-Correlation-Id response header and logged next to the request ID. An invalid value gets 400 invalid_correlation_id.", "type": "text/plain" }, "key": "X-Correlation-Id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Webhooks", "description": "", "item": [ { "name": "Create a webhook endpoint", "request": { "name": "Create a webhook endpoint", "description": { "content": "Registers a public HTTPS URL for the chosen event types. The endpoint starts `pending_verification`: Flashpi POSTs a signed `webhook_endpoint.verification` body with a `challenge`, and the endpoint must answer 2xx echoing it (`{\"challenge\": \"...\"}`, or the challenge as plain text) before it receives events. Read its signing secret with GET .../secret. Requires an account-scoped (global) API key with read_write access. Test keys manage the endpoints of test events and live keys those of live events.", "type": "text/plain" }, "url": { "path": [ "v1", "webhook-endpoints" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Makes the request safe to retry: 1 to 255 visible ASCII characters (a UUID works well), remembered for 24 hours per account and mode. A retry with the same key and the same request returns the first successful response again, with the header `Idempotent-Replayed: true`. The same key with a different request gets 422 idempotency_key_reused; while the first request still runs, 409 idempotency_key_in_progress. A failed request does not keep its key.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "{{$guid}}" }, { "disabled": true, "description": { "content": "Language of error messages and of the localized texts of resources (SRI messages, failures, certificate rejections): Spanish when the entry with the highest q-value is `es` or `es-` plus a region (`es-EC`, `es-419`), English otherwise. Errors state it in Content-Language.", "type": "text/plain" }, "key": "Accept-Language", "value": "" }, { "disabled": true, "description": { "content": "Your own ID for the request (letters, digits and `-_.:/+=`), echoed back in the X-Correlation-Id response header and logged next to the request ID. An invalid value gets 400 invalid_correlation_id.", "type": "text/plain" }, "key": "X-Correlation-Id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"https://hooks.example.com/flashpi\",\n \"description\": \"ERP production receiver\",\n \"enabledEvents\": [\n \"invoice.authorized\",\n \"invoice.rejected\"\n ],\n \"payloadMode\": \"full\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "List webhook endpoints", "request": { "name": "List webhook endpoints", "description": { "content": "Newest first. Requires an account-scoped (global) API key with read_write access. Test keys manage the endpoints of test events and live keys those of live events.", "type": "text/plain" }, "url": { "path": [ "v1", "webhook-endpoints" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Maximum number of items to return.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": true, "description": { "content": "The `pagination.nextCursor` of the previous page. Omit it for the first page.", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "disabled": true, "description": { "content": "Language of error messages and of the localized texts of resources (SRI messages, failures, certificate rejections): Spanish when the entry with the highest q-value is `es` or `es-` plus a region (`es-EC`, `es-419`), English otherwise. Errors state it in Content-Language.", "type": "text/plain" }, "key": "Accept-Language", "value": "" }, { "disabled": true, "description": { "content": "Your own ID for the request (letters, digits and `-_.:/+=`), echoed back in the X-Correlation-Id response header and logged next to the request ID. An invalid value gets 400 invalid_correlation_id.", "type": "text/plain" }, "key": "X-Correlation-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get a webhook endpoint", "request": { "name": "Get a webhook endpoint", "description": { "content": "Requires an account-scoped (global) API key with read_write access. Test keys manage the endpoints of test events and live keys those of live events.", "type": "text/plain" }, "url": { "path": [ "v1", "webhook-endpoints", ":endpointId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "{{endpointId}}", "key": "endpointId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": true, "description": { "content": "Language of error messages and of the localized texts of resources (SRI messages, failures, certificate rejections): Spanish when the entry with the highest q-value is `es` or `es-` plus a region (`es-EC`, `es-419`), English otherwise. Errors state it in Content-Language.", "type": "text/plain" }, "key": "Accept-Language", "value": "" }, { "disabled": true, "description": { "content": "Your own ID for the request (letters, digits and `-_.:/+=`), echoed back in the X-Correlation-Id response header and logged next to the request ID. An invalid value gets 400 invalid_correlation_id.", "type": "text/plain" }, "key": "X-Correlation-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Update a webhook endpoint", "request": { "name": "Update a webhook endpoint", "description": { "content": "Changes the fields sent. A new URL goes back to `pending_verification` and gets a new handshake; `disabled: true` stops deliveries (pending ones end) and `disabled: false` enables the endpoint again. Requires an account-scoped (global) API key with read_write access. Test keys manage the endpoints of test events and live keys those of live events.", "type": "text/plain" }, "url": { "path": [ "v1", "webhook-endpoints", ":endpointId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "{{endpointId}}", "key": "endpointId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": true, "description": { "content": "Language of error messages and of the localized texts of resources (SRI messages, failures, certificate rejections): Spanish when the entry with the highest q-value is `es` or `es-` plus a region (`es-EC`, `es-419`), English otherwise. Errors state it in Content-Language.", "type": "text/plain" }, "key": "Accept-Language", "value": "" }, { "disabled": true, "description": { "content": "Your own ID for the request (letters, digits and `-_.:/+=`), echoed back in the X-Correlation-Id response header and logged next to the request ID. An invalid value gets 400 invalid_correlation_id.", "type": "text/plain" }, "key": "X-Correlation-Id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"url\": \"https://hooks.example.com/flashpi\",\n \"description\": \"ERP production receiver\",\n \"enabledEvents\": [\n \"invoice.authorized\",\n \"invoice.rejected\"\n ],\n \"payloadMode\": \"full\",\n \"disabled\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Delete a webhook endpoint", "request": { "name": "Delete a webhook endpoint", "description": { "content": "Deletes the endpoint and its delivery log; the events stay. Requires an account-scoped (global) API key with read_write access. Test keys manage the endpoints of test events and live keys those of live events.", "type": "text/plain" }, "url": { "path": [ "v1", "webhook-endpoints", ":endpointId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "{{endpointId}}", "key": "endpointId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": true, "description": { "content": "Language of error messages and of the localized texts of resources (SRI messages, failures, certificate rejections): Spanish when the entry with the highest q-value is `es` or `es-` plus a region (`es-EC`, `es-419`), English otherwise. Errors state it in Content-Language.", "type": "text/plain" }, "key": "Accept-Language", "value": "" }, { "disabled": true, "description": { "content": "Your own ID for the request (letters, digits and `-_.:/+=`), echoed back in the X-Correlation-Id response header and logged next to the request ID. An invalid value gets 400 invalid_correlation_id.", "type": "text/plain" }, "key": "X-Correlation-Id", "value": "" }, { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {} }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get the signing secret of a webhook endpoint", "request": { "name": "Get the signing secret of a webhook endpoint", "description": { "content": "The whsec_ secret that signs the deliveries (Standard Webhooks, HMAC-SHA256). It is stored encrypted and only returned here. Requires an account-scoped (global) API key with read_write access. Test keys manage the endpoints of test events and live keys those of live events.", "type": "text/plain" }, "url": { "path": [ "v1", "webhook-endpoints", ":endpointId", "secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "{{endpointId}}", "key": "endpointId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": true, "description": { "content": "Language of error messages and of the localized texts of resources (SRI messages, failures, certificate rejections): Spanish when the entry with the highest q-value is `es` or `es-` plus a region (`es-EC`, `es-419`), English otherwise. Errors state it in Content-Language.", "type": "text/plain" }, "key": "Accept-Language", "value": "" }, { "disabled": true, "description": { "content": "Your own ID for the request (letters, digits and `-_.:/+=`), echoed back in the X-Correlation-Id response header and logged next to the request ID. An invalid value gets 400 invalid_correlation_id.", "type": "text/plain" }, "key": "X-Correlation-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Rotate the signing secret of a webhook endpoint", "request": { "name": "Rotate the signing secret of a webhook endpoint", "description": { "content": "Creates a new secret (read it with GET .../secret). Until previousSecretExpiresAt, every delivery carries a signature with each secret, so receivers can switch without losing events. Requires an account-scoped (global) API key with read_write access. Test keys manage the endpoints of test events and live keys those of live events.", "type": "text/plain" }, "url": { "path": [ "v1", "webhook-endpoints", ":endpointId", "rotate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "{{endpointId}}", "key": "endpointId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Makes the request safe to retry: 1 to 255 visible ASCII characters (a UUID works well), remembered for 24 hours per account and mode. A retry with the same key and the same request returns the first successful response again, with the header `Idempotent-Replayed: true`. The same key with a different request gets 422 idempotency_key_reused; while the first request still runs, 409 idempotency_key_in_progress. A failed request does not keep its key.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "{{$guid}}" }, { "disabled": true, "description": { "content": "Language of error messages and of the localized texts of resources (SRI messages, failures, certificate rejections): Spanish when the entry with the highest q-value is `es` or `es-` plus a region (`es-EC`, `es-419`), English otherwise. Errors state it in Content-Language.", "type": "text/plain" }, "key": "Accept-Language", "value": "" }, { "disabled": true, "description": { "content": "Your own ID for the request (letters, digits and `-_.:/+=`), echoed back in the X-Correlation-Id response header and logged next to the request ID. An invalid value gets 400 invalid_correlation_id.", "type": "text/plain" }, "key": "X-Correlation-Id", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"previousSecretExpiresInHours\": 24\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Send the verification challenge again", "request": { "name": "Send the verification challenge again", "description": { "content": "Starts a new handshake for an endpoint that is still `pending_verification` (for example after fixing the receiver); follow it with GET. Requires an account-scoped (global) API key with read_write access. Test keys manage the endpoints of test events and live keys those of live events.", "type": "text/plain" }, "url": { "path": [ "v1", "webhook-endpoints", ":endpointId", "verify" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "{{endpointId}}", "key": "endpointId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Makes the request safe to retry: 1 to 255 visible ASCII characters (a UUID works well), remembered for 24 hours per account and mode. A retry with the same key and the same request returns the first successful response again, with the header `Idempotent-Replayed: true`. The same key with a different request gets 422 idempotency_key_reused; while the first request still runs, 409 idempotency_key_in_progress. A failed request does not keep its key.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "{{$guid}}" }, { "disabled": true, "description": { "content": "Language of error messages and of the localized texts of resources (SRI messages, failures, certificate rejections): Spanish when the entry with the highest q-value is `es` or `es-` plus a region (`es-EC`, `es-419`), English otherwise. Errors state it in Content-Language.", "type": "text/plain" }, "key": "Accept-Language", "value": "" }, { "disabled": true, "description": { "content": "Your own ID for the request (letters, digits and `-_.:/+=`), echoed back in the X-Correlation-Id response header and logged next to the request ID. An invalid value gets 400 invalid_correlation_id.", "type": "text/plain" }, "key": "X-Correlation-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "List the deliveries of a webhook endpoint", "request": { "name": "List the deliveries of a webhook endpoint", "description": { "content": "The delivery log, newest first. Requires an account-scoped (global) API key with read_write access. Test keys manage the endpoints of test events and live keys those of live events.", "type": "text/plain" }, "url": { "path": [ "v1", "webhook-endpoints", ":endpointId", "deliveries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Maximum number of items to return.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": true, "description": { "content": "The `pagination.nextCursor` of the previous page. Omit it for the first page.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": true, "description": { "content": "Only deliveries in this status. (This can only be one of pending,succeeded,failed)", "type": "text/plain" }, "key": "status", "value": "pending" }, { "disabled": true, "description": { "content": "Only deliveries of this event type. (This can only be one of invoice.authorized,invoice.rejected,purchase_settlement.authorized,purchase_settlement.rejected,credit_note.authorized,credit_note.rejected,debit_note.authorized,debit_note.rejected,waybill.authorized,waybill.rejected,withholding.authorized,withholding.rejected,certificate.verified,certificate.pending,certificate.blocked,certificate.revoked,certificate.reactivated,document.ride.generated,document.ride.failed,document.email.sent,document.email.delivered,document.email.bounced,document.email.complained,document.email.failed,account.email_paused,account.email_resumed)", "type": "text/plain" }, "key": "eventType", "value": "invoice.authorized" }, { "disabled": true, "description": { "content": "Only the delivery of this event.", "type": "text/plain" }, "key": "eventId", "value": "" } ], "variable": [ { "type": "any", "value": "{{endpointId}}", "key": "endpointId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": true, "description": { "content": "Language of error messages and of the localized texts of resources (SRI messages, failures, certificate rejections): Spanish when the entry with the highest q-value is `es` or `es-` plus a region (`es-EC`, `es-419`), English otherwise. Errors state it in Content-Language.", "type": "text/plain" }, "key": "Accept-Language", "value": "" }, { "disabled": true, "description": { "content": "Your own ID for the request (letters, digits and `-_.:/+=`), echoed back in the X-Correlation-Id response header and logged next to the request ID. An invalid value gets 400 invalid_correlation_id.", "type": "text/plain" }, "key": "X-Correlation-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get a webhook delivery", "request": { "name": "Get a webhook delivery", "description": { "content": "A delivery with every attempt (status, duration, error). Requires an account-scoped (global) API key with read_write access. Test keys manage the endpoints of test events and live keys those of live events.", "type": "text/plain" }, "url": { "path": [ "v1", "webhook-endpoints", ":endpointId", "deliveries", ":deliveryId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "{{endpointId}}", "key": "endpointId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "{{deliveryId}}", "key": "deliveryId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": true, "description": { "content": "Language of error messages and of the localized texts of resources (SRI messages, failures, certificate rejections): Spanish when the entry with the highest q-value is `es` or `es-` plus a region (`es-EC`, `es-419`), English otherwise. Errors state it in Content-Language.", "type": "text/plain" }, "key": "Accept-Language", "value": "" }, { "disabled": true, "description": { "content": "Your own ID for the request (letters, digits and `-_.:/+=`), echoed back in the X-Correlation-Id response header and logged next to the request ID. An invalid value gets 400 invalid_correlation_id.", "type": "text/plain" }, "key": "X-Correlation-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Replay a webhook delivery", "request": { "name": "Replay a webhook delivery", "description": { "content": "Sends a delivery that succeeded or failed again, once, right away: the same event and webhook-id with a new timestamp and signature. Requires an account-scoped (global) API key with read_write access. Test keys manage the endpoints of test events and live keys those of live events.", "type": "text/plain" }, "url": { "path": [ "v1", "webhook-endpoints", ":endpointId", "deliveries", ":deliveryId", "replay" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "{{endpointId}}", "key": "endpointId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "{{deliveryId}}", "key": "deliveryId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Makes the request safe to retry: 1 to 255 visible ASCII characters (a UUID works well), remembered for 24 hours per account and mode. A retry with the same key and the same request returns the first successful response again, with the header `Idempotent-Replayed: true`. The same key with a different request gets 422 idempotency_key_reused; while the first request still runs, 409 idempotency_key_in_progress. A failed request does not keep its key.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "{{$guid}}" }, { "disabled": true, "description": { "content": "Language of error messages and of the localized texts of resources (SRI messages, failures, certificate rejections): Spanish when the entry with the highest q-value is `es` or `es-` plus a region (`es-EC`, `es-419`), English otherwise. Errors state it in Content-Language.", "type": "text/plain" }, "key": "Accept-Language", "value": "" }, { "disabled": true, "description": { "content": "Your own ID for the request (letters, digits and `-_.:/+=`), echoed back in the X-Correlation-Id response header and logged next to the request ID. An invalid value gets 400 invalid_correlation_id.", "type": "text/plain" }, "key": "X-Correlation-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Events", "description": "", "item": [ { "name": "List events", "request": { "name": "List events", "description": { "content": "Newest first; the same objects the webhooks deliver. Any API key can read the events of its mode; an issuer-scoped key only those of its issuer.", "type": "text/plain" }, "url": { "path": [ "v1", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Maximum number of items to return.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": true, "description": { "content": "The `pagination.nextCursor` of the previous page. Omit it for the first page.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": true, "description": { "content": "Only events of this type. (This can only be one of invoice.authorized,invoice.rejected,purchase_settlement.authorized,purchase_settlement.rejected,credit_note.authorized,credit_note.rejected,debit_note.authorized,debit_note.rejected,waybill.authorized,waybill.rejected,withholding.authorized,withholding.rejected,certificate.verified,certificate.pending,certificate.blocked,certificate.revoked,certificate.reactivated,document.ride.generated,document.ride.failed,document.email.sent,document.email.delivered,document.email.bounced,document.email.complained,document.email.failed,account.email_paused,account.email_resumed)", "type": "text/plain" }, "key": "type", "value": "invoice.authorized" }, { "disabled": true, "description": { "content": "Only events of this issuer.", "type": "text/plain" }, "key": "issuerId", "value": "" }, { "disabled": true, "description": { "content": "Only events of this document.", "type": "text/plain" }, "key": "documentId", "value": "" }, { "disabled": true, "description": { "content": "Only events of this certificate.", "type": "text/plain" }, "key": "certificateId", "value": "" } ], "variable": [] }, "header": [ { "disabled": true, "description": { "content": "Language of error messages and of the localized texts of resources (SRI messages, failures, certificate rejections): Spanish when the entry with the highest q-value is `es` or `es-` plus a region (`es-EC`, `es-419`), English otherwise. Errors state it in Content-Language.", "type": "text/plain" }, "key": "Accept-Language", "value": "" }, { "disabled": true, "description": { "content": "Your own ID for the request (letters, digits and `-_.:/+=`), echoed back in the X-Correlation-Id response header and logged next to the request ID. An invalid value gets 400 invalid_correlation_id.", "type": "text/plain" }, "key": "X-Correlation-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get an event", "request": { "name": "Get an event", "description": { "content": "The event with its snapshot (thin webhook endpoints read it here). Any API key can read the events of its mode; an issuer-scoped key only those of its issuer.", "type": "text/plain" }, "url": { "path": [ "v1", "events", ":eventId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "{{eventId}}", "key": "eventId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": true, "description": { "content": "Language of error messages and of the localized texts of resources (SRI messages, failures, certificate rejections): Spanish when the entry with the highest q-value is `es` or `es-` plus a region (`es-EC`, `es-419`), English otherwise. Errors state it in Content-Language.", "type": "text/plain" }, "key": "Accept-Language", "value": "" }, { "disabled": true, "description": { "content": "Your own ID for the request (letters, digits and `-_.:/+=`), echoed back in the X-Correlation-Id response header and logged next to the request ID. An invalid value gets 400 invalid_correlation_id.", "type": "text/plain" }, "key": "X-Correlation-Id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ], "event": [], "variable": [ { "key": "baseUrl", "value": "https://api.flashpi.com.ec", "type": "string" }, { "key": "apiKey", "value": "", "type": "string" }, { "key": "buyerEmail", "value": "", "type": "string" }, { "key": "certificateId", "value": "", "type": "string" }, { "key": "deliveryId", "value": "", "type": "string" }, { "key": "documentId", "value": "", "type": "string" }, { "key": "emissionPointId", "value": "", "type": "string" }, { "key": "endpointId", "value": "", "type": "string" }, { "key": "establishmentId", "value": "", "type": "string" }, { "key": "eventId", "value": "", "type": "string" }, { "key": "issuerId", "value": "", "type": "string" }, { "key": "onboardingId", "value": "", "type": "string" } ], "info": { "name": "Flashpi Invoicing API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "Issue and query electronic tax documents authorized by Ecuador's SRI. Authenticate with an API key as a Bearer token: fp_test_ keys use the SRI test environment and fp_live_ keys use SRI production. Errors follow RFC 9457 (application/problem+json), in Spanish with Accept-Language: es. Any operation can also answer 500 internal_error (unexpected: retry with backoff, reusing the Idempotency-Key on a POST, and give requestId to support); 502, 503 and 504 answers from the edge may carry no Problem Details body. Every response carries an X-Request-Id header (a UUIDv7, also returned as requestId in errors). Send an optional X-Correlation-Id header (1 to 128 letters, digits and -_.:/+=) to tie a request to your own records: it is echoed back, and an invalid value is rejected with 400 invalid_correlation_id. JSON bodies are limited to 1 MB; a larger body gets 413 payload_too_large.\n\nGenerated from the Flashpi invoicing OpenAPI document (version 0.0.0). Set the apiKey variable to a test (fp_test_) key, issuerId to your issuer and buyerEmail to your own address before sending requests: https://flashpi.com.ec/docs/postman/", "type": "text/plain" } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] } }