Issue a debit note

Authorizations

apiKey

Header Parameters

Idempotency-Key

string

>= 1 characters <= 255 characters /^[\x21-\x7E]+$/

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.

Accept-Language

string

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.

X-Correlation-Id

string

>= 1 characters <= 128 characters /^[A-Za-z0-9._:/+=-]{1,128}$/

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.

Request Body^required

application/json

A debit note (nota de débito) that increases the amount of a document, for example for interest or fees. Flashpi computes the taxes and the total.

object

issuerId

required

The issuer (taxpayer) that issues the document.

string format: uuid

establishment

required

Establishment code (3 digits) registered on the issuer.

string

/^\d{3}$/

emissionPoint

required

Emission point code (3 digits) registered on the establishment.

string

/^\d{3}$/

issueDate

Issue date, YYYY-MM-DD. Defaults to today in Ecuador; it cannot be later.

string format: date

sequential

Sequential to use instead of the next one, for example when migrating from another system. It must not be used yet; later automatic sequentials continue after the highest one used. Not accepted with the shared demo issuer (422 demo_issuer_sequential_not_allowed).

integer

>= 1 <= 999999999

additionalInfo

Additional information printed on the document (name → value, 1 to 300 characters each). A document carries at most 15 fields including the legends Flashpi adds (RUC Proveedor, and Gran Contribuyente for large taxpayers), so at most 13 or 14 of yours.

object

<= 15 properties

key

additional properties

string

>= 1 characters <= 300 characters

options

Delivery options.

object

sendEmail

Email the authorized document (PDF and XML) to the counterparty, when it has an email address. Defaults to the issuer’s sendEmailByDefault (true unless the issuer opted out).

boolean

waitForAuthorization

Sync mode: wait for the SRI before answering. The response is 200 with the document once it is authorized, rejected or failed, or 202 with its current status (usually pending_sri) when the wait ends first; the document then continues asynchronously. Defaults to false (202 at once).

boolean

waitTimeoutSeconds

Sync mode: the longest wait, in seconds, from 1 to 30. Defaults to 15. A longer wait is refused with out_of_range. Used only with waitForAuthorization.

integer

>= 1 <= 30

customer

required

The buyer of the modified document. It cannot be a final consumer.

object

idType

required

Identification type: ruc (13 digits ending in 001, format only), cedula (10 digits, check digit verified), passport, final_consumer (no identification; only invoices accept it) or foreign_id (issued by the tax authority of another country).

string

Allowed values: ruc cedula passport final_consumer foreign_id

id

Identification number. Required unless idType is final_consumer, whose number is always 9999999999999.

string

>= 1 characters <= 20 characters

name

Legal name or full name. Required unless idType is final_consumer (printed as CONSUMIDOR FINAL).

string

>= 1 characters <= 300 characters

address

Address. Credit and debit notes do not print it.

string

>= 1 characters <= 300 characters

email

Where the authorized document is emailed (see options.sendEmail).

string format: email

<= 320 characters

modifiedDocument

required

The document the note modifies.

object

type

Type of the modified document. Defaults to invoice.

string

Allowed values: invoice

number

required

Number of the modified document: establishment-emission point-sequential.

string

/^\d{3}-\d{3}-\d{9}$/

issueDate

required

Issue date of the modified document (on or before the note). Its VAT rates are the ones in force on this date.

string format: date

reasons

required

The reasons and their amounts.

Array<object>

>= 1 items <= 100 items

A reason for a debit note and its amount before taxes.

object

description

required

Reason.

string

>= 1 characters <= 300 characters

amount

required

Amount before taxes.

string

/^\d{1,12}(\.\d{1,2}0*)?$/

taxes

required

The VAT of this amount (exactly one vat).

Array<object>

>= 1 items <= 1 items

A tax of a line. Every line needs exactly one vat; invoices and credit notes accept one ad valorem ice too. Flashpi computes the bases and amounts.

object

type

required

vat (IVA) or ice (ICE).

string

Allowed values: vat ice

rate

required

For vat, the rate: 0, 5, 8 (differentiated, tourism), 12, 13, 14, 15, exempt or not_subject; it must be in force on the issue date (for credit and debit notes, on the modified document issue date). For ice, the ad valorem percentage with up to 2 decimals (for example 75).

string

code

For ice only (required): the 4-digit ICE code of TABLA 18.

string

/^\d{4}$/

payments

required

How the debit is paid; the payments must add up to the total.

Array<object>

>= 1 items <= 50 items

A payment. The payments must add up to the document total.

object

method

required

Payment method: cash (without the financial system), debt_offset, debit_card, electronic_money, prepaid_card, credit_card, other_financial_system (bank transfers, checks and other payments through the financial system) or securities_endorsement.

string

Allowed values: cash debt_offset debit_card electronic_money prepaid_card credit_card other_financial_system securities_endorsement

amount

required

Amount paid with this method.

string

/^\d{1,12}(\.\d{1,2}0*)?$/

term

Payment term in termUnit units. Required on purchase settlements.

string

/^\d{1,12}(\.\d{1,2}0*)?$/

termUnit

Unit of term: days or months.

string

Allowed values: days months

expectedTotal

The total you expect. Flashpi computes every total; when it differs from this value the request is refused with 422 total_mismatch, which shows both values.

string

/^\d{1,12}(\.\d{1,2}0*)?$/

Examples

example

A complete request

{
  "issuerId": "01a13eca-2e80-7c3d-9f21-5b8e4a6d0c17",
  "establishment": "001",
  "emissionPoint": "001",
  "customer": {
    "idType": "ruc",
    "id": "1790000000001",
    "name": "Supermercados La Pradera S.A.",
    "email": "compras@example.com"
  },
  "modifiedDocument": {
    "number": "001-001-000000123",
    "issueDate": "2026-10-15"
  },
  "reasons": [
    {
      "description": "Late payment interest",
      "amount": "10.00",
      "taxes": [
        {
          "type": "vat",
          "rate": "15"
        }
      ]
    }
  ],
  "payments": [
    {
      "method": "other_financial_system",
      "amount": "11.50"
    }
  ]
}

200

Sync mode only: the SRI settled the document within the wait (status authorized, rejected or failed).

application/json

An SRI document of any type.

object

id

required

string format: uuid

type

required

string

Allowed values: invoice purchase_settlement credit_note debit_note waybill withholding

environment

required

Mode of the API key that issued it: test (SRI pruebas) or live.

string

Allowed values: test live

status

required

Tax status: processing (being signed and sent), pending_sri (waiting for the SRI), authorized, rejected, failed or voided.

string

Allowed values: processing pending_sri authorized rejected failed voided

issuerId

required

string format: uuid

establishment

required

string

emissionPoint

required

string

sequential

required

number

number

required

Establishment-emission point-sequential.

string

accessKey

required

The 49-digit access key, also the authorization number.

string

issueDate

required

string format: date

xmlVersion

required

Version of the SRI XML.

string

counterparty

required

Any of:

object
null

The buyer, supplier, withheld subject or carrier.

object

id

required

string

name

required

string

totals

required

Any of:

object
null

Totals computed by Flashpi. Invoices have every field but withheld; purchase settlements and credit notes have no tip; debit notes have no discount nor tip; withholding receipts only have withheld.

object

subtotal

Sum of the line subtotals.

string

discount

Sum of the line discounts.

string

taxes

Array<object>

A tax total, grouped per tax and rate.

object

type

required

string

Allowed values: vat ice

rate

required

VAT: the rate (15, 0, exempt, …). ICE: the percentage.

string

code

ICE: the TABLA 18 code.

string

taxableBase

required

Taxable base.

string

amount

required

Tax amount.

string

tip

Tip.

string

total

Total (credited amount of a credit note, total of a debit note).

string

withheld

Total withheld.

string

authorization

required

The SRI authorization.

object

number

required

Authorization number (the access key), once authorized.

string | null

authorizedAt

required

string | null format: date-time

ride

required

The RIDE (printed PDF), generated once the document is authorized.

object

status

required

string

Allowed values: pending generated failed

template

required

string | null

Allowed values: modern classic minimal

generatedAt

required

string | null format: date-time

email

required

Email delivery, separate from the tax status: sent only once the document is authorized, when it was requested and there is a recipient.

object

requested

required

Whether the email was requested.

boolean

status

required

not_requested (opted out), skipped (no recipient), queued (sent once authorized), then sent, delivered, bounced, complained or failed.

string

Allowed values: not_requested skipped queued sent delivered bounced complained failed

deliveries

required

Array<object>

One email to one recipient.

object

id

required

string format: uuid

recipient

required

string

status

required

string

Allowed values: queued sent delivered bounced complained failed

sentAt

required

string | null format: date-time

lastEventAt

required

string | null format: date-time

error

required

Why the email failed or bounced, as a code: for example rejected, timeout, invalid_address, bounce_permanent, bounce_suppressed (the address is on the suppression list of Flashpi’s email provider after an earlier bounce or complaint), complaint, account_email_limit_reached (the account’s emails of the day were used up; nothing was sent), platform_email_limit_reached (Flashpi’s emails of the day across all accounts were used up; nothing was sent), email_sending_paused (the account’s emails of the mode are paused; nothing was sent), platform_email_sending_paused (Flashpi paused the emails of its email provider for every account after too many bounces or complaints; nothing was sent), test_recipient_not_allowed (a test document whose recipient is not a verified member of the account’s team; nothing was sent: download the RIDE and the XML to send them) or invalid_domain (the recipient’s domain does not exist or receives no mail: no MX, A or AAAA record, or a null MX; nothing was sent).

string | null

warnings

required

Warnings about the recipient’s address, computed when the document is read: empty when nothing looks wrong.

Array<object>

Something about the email that looks wrong. A warning never stops or changes the email.

object

code

required

recipient_domain_typo: the recipient’s domain looks like a typo of a common mail domain (for example gmial.com for gmail.com). The email is still sent to the address as given; nothing changes it.

string

Allowed values: recipient_domain_typo

message

required

Follows Accept-Language (English or Spanish).

string

suggestedRecipient

required

The address with the suggested domain.

string

sriMessages

required

Messages of the last SRI answer, mapped to Flashpi codes (the reasons of a rejection, or warnings of an authorization). Texts follow Accept-Language (English or Spanish).

Array<object>

A message of the SRI, mapped by Flashpi.

object

code

required

Flashpi error code.

string

message

required

string

severity

required

string

Allowed values: error warning

failure

required

Any of:

object
null

Why a failed document could not reach an SRI answer.

object

code

required

string

Allowed values: certificate_required certificate_expired certificate_not_yet_valid certificate_blocked certificate_revoked certificate_unusable document_too_large document_invalid signing_failed sri_unavailable sri_authorization_timeout sri_request_refused sri_environment_mismatch

message

required

string

voidedAt

required

string | null format: date-time

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

Example

{
  "id": "01a13fdf-9620-77a7-a18e-0b13542f5fed",
  "type": "invoice",
  "environment": "test",
  "status": "processing",
  "establishment": "001",
  "emissionPoint": "001",
  "sequential": 123,
  "number": "001-001-000000123",
  "accessKey": "1510202601179000000000110010010000001234152637411",
  "issueDate": "2026-10-15",
  "xmlVersion": "2.1.0",
  "counterparty": {
    "id": "1790000000001",
    "name": "Supermercados La Pradera S.A."
  },
  "totals": {
    "subtotal": "60.31",
    "discount": "0.75",
    "taxes": [
      {
        "type": "vat",
        "rate": "15",
        "code": "3031",
        "taxableBase": "57.50",
        "amount": "8.63"
      }
    ],
    "tip": "0.00",
    "total": "68.94",
    "withheld": "62.50"
  },
  "authorization": {
    "number": null,
    "authorizedAt": null
  },
  "ride": {
    "status": "pending",
    "template": "modern",
    "generatedAt": null
  },
  "email": {
    "requested": true,
    "status": "not_requested",
    "deliveries": [
      {
        "recipient": "compras@example.com",
        "status": "queued",
        "error": null
      }
    ],
    "warnings": [
      {
        "code": "recipient_domain_typo",
        "message": "The recipient's email address may be mistyped: did you mean compras@gmail.com?",
        "suggestedRecipient": "compras@gmail.com"
      }
    ]
  },
  "sriMessages": [
    {
      "code": "calculation_mismatch",
      "message": "The SRI found differences in the calculations.",
      "severity": "error"
    }
  ],
  "failure": {
    "code": "certificate_required",
    "message": "The issuer has no accepted signing certificate for this mode. Upload its .p12 certificate and issue the document again."
  }
}

Headers

Location

string

Path of the document: /v1/documents/{id}. Not sent on an idempotent replay (Idempotent-Replayed: true): build it from the body as shown.

Idempotent-Replayed

string

Allowed values: true

true when this is the stored answer of an earlier request with the same Idempotency-Key (same status and body, no Location). Absent otherwise.

X-Request-Id

string format: uuid

Flashpi’s ID of the request, a UUIDv7 (also requestId in errors). Include it when you contact support.

202

Accepted: the document is stored and is being processed (status processing, or pending_sri when a sync wait ended first).

application/json

An SRI document of any type.

object

id

required

string format: uuid

type

required

string

Allowed values: invoice purchase_settlement credit_note debit_note waybill withholding

environment

required

Mode of the API key that issued it: test (SRI pruebas) or live.

string

Allowed values: test live

status

required

Tax status: processing (being signed and sent), pending_sri (waiting for the SRI), authorized, rejected, failed or voided.

string

Allowed values: processing pending_sri authorized rejected failed voided

issuerId

required

string format: uuid

establishment

required

string

emissionPoint

required

string

sequential

required

number

number

required

Establishment-emission point-sequential.

string

accessKey

required

The 49-digit access key, also the authorization number.

string

issueDate

required

string format: date

xmlVersion

required

Version of the SRI XML.

string

counterparty

required

Any of:

object
null

The buyer, supplier, withheld subject or carrier.

object

id

required

string

name

required

string

totals

required

Any of:

object
null

Totals computed by Flashpi. Invoices have every field but withheld; purchase settlements and credit notes have no tip; debit notes have no discount nor tip; withholding receipts only have withheld.

object

subtotal

Sum of the line subtotals.

string

discount

Sum of the line discounts.

string

taxes

Array<object>

A tax total, grouped per tax and rate.

object

type

required

string

Allowed values: vat ice

rate

required

VAT: the rate (15, 0, exempt, …). ICE: the percentage.

string

code

ICE: the TABLA 18 code.

string

taxableBase

required

Taxable base.

string

amount

required

Tax amount.

string

tip

Tip.

string

total

Total (credited amount of a credit note, total of a debit note).

string

withheld

Total withheld.

string

authorization

required

The SRI authorization.

object

number

required

Authorization number (the access key), once authorized.

string | null

authorizedAt

required

string | null format: date-time

ride

required

The RIDE (printed PDF), generated once the document is authorized.

object

status

required

string

Allowed values: pending generated failed

template

required

string | null

Allowed values: modern classic minimal

generatedAt

required

string | null format: date-time

email

required

Email delivery, separate from the tax status: sent only once the document is authorized, when it was requested and there is a recipient.

object

requested

required

Whether the email was requested.

boolean

status

required

not_requested (opted out), skipped (no recipient), queued (sent once authorized), then sent, delivered, bounced, complained or failed.

string

Allowed values: not_requested skipped queued sent delivered bounced complained failed

deliveries

required

Array<object>

One email to one recipient.

object

id

required

string format: uuid

recipient

required

string

status

required

string

Allowed values: queued sent delivered bounced complained failed

sentAt

required

string | null format: date-time

lastEventAt

required

string | null format: date-time

error

required

Why the email failed or bounced, as a code: for example rejected, timeout, invalid_address, bounce_permanent, bounce_suppressed (the address is on the suppression list of Flashpi’s email provider after an earlier bounce or complaint), complaint, account_email_limit_reached (the account’s emails of the day were used up; nothing was sent), platform_email_limit_reached (Flashpi’s emails of the day across all accounts were used up; nothing was sent), email_sending_paused (the account’s emails of the mode are paused; nothing was sent), platform_email_sending_paused (Flashpi paused the emails of its email provider for every account after too many bounces or complaints; nothing was sent), test_recipient_not_allowed (a test document whose recipient is not a verified member of the account’s team; nothing was sent: download the RIDE and the XML to send them) or invalid_domain (the recipient’s domain does not exist or receives no mail: no MX, A or AAAA record, or a null MX; nothing was sent).

string | null

warnings

required

Warnings about the recipient’s address, computed when the document is read: empty when nothing looks wrong.

Array<object>

Something about the email that looks wrong. A warning never stops or changes the email.

object

code

required

recipient_domain_typo: the recipient’s domain looks like a typo of a common mail domain (for example gmial.com for gmail.com). The email is still sent to the address as given; nothing changes it.

string

Allowed values: recipient_domain_typo

message

required

Follows Accept-Language (English or Spanish).

string

suggestedRecipient

required

The address with the suggested domain.

string

sriMessages

required

Messages of the last SRI answer, mapped to Flashpi codes (the reasons of a rejection, or warnings of an authorization). Texts follow Accept-Language (English or Spanish).

Array<object>

A message of the SRI, mapped by Flashpi.

object

code

required

Flashpi error code.

string

message

required

string

severity

required

string

Allowed values: error warning

failure

required

Any of:

object
null

Why a failed document could not reach an SRI answer.

object

code

required

string

Allowed values: certificate_required certificate_expired certificate_not_yet_valid certificate_blocked certificate_revoked certificate_unusable document_too_large document_invalid signing_failed sri_unavailable sri_authorization_timeout sri_request_refused sri_environment_mismatch

message

required

string

voidedAt

required

string | null format: date-time

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

Example

{
  "id": "01a13fdf-9620-77a7-a18e-0b13542f5fed",
  "type": "invoice",
  "environment": "test",
  "status": "processing",
  "establishment": "001",
  "emissionPoint": "001",
  "sequential": 123,
  "number": "001-001-000000123",
  "accessKey": "1510202601179000000000110010010000001234152637411",
  "issueDate": "2026-10-15",
  "xmlVersion": "2.1.0",
  "counterparty": {
    "id": "1790000000001",
    "name": "Supermercados La Pradera S.A."
  },
  "totals": {
    "subtotal": "60.31",
    "discount": "0.75",
    "taxes": [
      {
        "type": "vat",
        "rate": "15",
        "code": "3031",
        "taxableBase": "57.50",
        "amount": "8.63"
      }
    ],
    "tip": "0.00",
    "total": "68.94",
    "withheld": "62.50"
  },
  "authorization": {
    "number": null,
    "authorizedAt": null
  },
  "ride": {
    "status": "pending",
    "template": "modern",
    "generatedAt": null
  },
  "email": {
    "requested": true,
    "status": "not_requested",
    "deliveries": [
      {
        "recipient": "compras@example.com",
        "status": "queued",
        "error": null
      }
    ],
    "warnings": [
      {
        "code": "recipient_domain_typo",
        "message": "The recipient's email address may be mistyped: did you mean compras@gmail.com?",
        "suggestedRecipient": "compras@gmail.com"
      }
    ]
  },
  "sriMessages": [
    {
      "code": "calculation_mismatch",
      "message": "The SRI found differences in the calculations.",
      "severity": "error"
    }
  ],
  "failure": {
    "code": "certificate_required",
    "message": "The issuer has no accepted signing certificate for this mode. Upload its .p12 certificate and issue the document again."
  }
}

Headers

Location

string

Path of the document: /v1/documents/{id}. Not sent on an idempotent replay (Idempotent-Replayed: true): build it from the body as shown.

Idempotent-Replayed

string

Allowed values: true

true when this is the stored answer of an earlier request with the same Idempotency-Key (same status and body, no Location). Absent otherwise.

X-Request-Id

string format: uuid

Flashpi’s ID of the request, a UUIDv7 (also requestId in errors). Include it when you contact support.

400

malformed_json: the body is not valid JSON. bad_request: the body does not decompress with its Content-Encoding. Or invalid_idempotency_key: the Idempotency-Key header is malformed.

application/problem+json

RFC 9457 problem details, in the language of Content-Language (en, or es with Accept-Language: es). Some codes add extension members, listed below; others may appear.

object

type

required

URI of the problem type: the page that documents code, in the language of the response (https://flashpi.com.ec/docs/en/errors/{code} in English, https://flashpi.com.ec/docs/errors/{code} with Accept-Language: es). It changes with the language, so branch on code, never on type.

string format: uri

title

required

Localized summary of the type.

string

status

required

HTTP status code.

number

detail

required

Localized explanation of this occurrence.

string

instance

required

Path of the request.

string

code

required

Stable machine-readable error code, the same in every language. Branch on it, never on type, title or detail. New codes may be added: handle an unknown one by its HTTP status.

string

Allowed values: bad_request malformed_json invalid_correlation_id validation_failed authentication_required forbidden not_found method_not_allowed not_acceptable conflict payload_too_large unsupported_media_type rate_limited internal_error service_unavailable invalid_api_key key_scope_mismatch key_read_only ip_not_allowed invalid_idempotency_key idempotency_key_reused idempotency_key_in_progress issuer_already_exists establishment_already_exists emission_point_already_exists resource_in_use issuer_onboarding_not_ready issuer_onboarding_expired issuer_onboarding_completed issuer_onboarding_rejected total_mismatch sequential_already_used sequentials_exhausted document_schema_invalid document_too_large document_not_authorized ride_not_available email_recipient_missing email_already_queued email_resend_limit_reached account_email_limit_reached email_sending_paused test_recipient_not_allowed platform_email_limit_reached webhook_endpoint_disabled webhook_endpoint_already_verified webhook_endpoint_not_verified webhook_delivery_in_progress sandbox_not_enabled demo_issuer_quota_exceeded demo_issuer_unavailable account_suspended

errors

required

Field-level errors (may be empty).

Array<object>

object

field

required

Path of the invalid field.

string

code

required

Stable machine-readable reason. New codes may be added: treat an unknown one like invalid_value.

string

Allowed values: required unknown_field invalid_type invalid_format invalid_option too_short too_long out_of_range invalid_value unsupported_character not_found invalid_decimal invalid_identification invalid_check_digit final_consumer_not_allowed not_in_force too_many_additional_fields reserved_name amount_mismatch future_date date_too_early date_too_late discount_exceeds_amount duplicate vat_required unsupported_tax rate_mismatch incompatible_issuer_profile url_not_allowed demo_issuer_test_only demo_issuer_sequential_not_allowed ruc_mismatch

message

required

Localized message.

string

requestId

required

Request ID (UUIDv7); include it when contacting support.

string

documentId

idempotency_key_reused: the document the Idempotency-Key already created.

string format: uuid

limit

The daily limit that was reached (email_resend_limit_reached, account_email_limit_reached, demo_issuer_quota_exceeded).

integer

resetsAt

When the daily limit resets: the next midnight in Ecuador (the three codes above and platform_email_limit_reached). Retry-After gives the same in seconds.

string format: date-time

rideStatus

ride_not_available: the status of the RIDE.

string

Allowed values: pending generated failed

documentStatus

document_not_authorized: the status of the document.

string

Allowed values: processing pending_sri authorized rejected failed voided

environment

email_sending_paused: the mode whose email sending is paused.

string

Allowed values: test live

expectedTotal

total_mismatch: the expectedTotal you sent.

string

computedTotal

total_mismatch: the total Flashpi computed.

string

key

additional properties

any

Example

{
  "type": "https://flashpi.com.ec/docs/en/errors/validation_failed",
  "title": "Validation failed",
  "status": 422,
  "detail": "One or more fields are invalid. See errors for details.",
  "instance": "/v1/invoices",
  "code": "validation_failed",
  "errors": [
    {
      "field": "customer.id",
      "code": "required",
      "message": "This field is required."
    }
  ],
  "requestId": "017f22e2-79b0-7cc3-98c4-dc0c0c07398f",
  "rideStatus": "pending",
  "documentStatus": "processing",
  "environment": "test",
  "expectedTotal": "112.00",
  "computedTotal": "111.99"
}

401

authentication_required: no Authorization: Bearer header. invalid_api_key: the key is malformed, unknown or revoked.

application/problem+json

RFC 9457 problem details, in the language of Content-Language (en, or es with Accept-Language: es). Some codes add extension members, listed below; others may appear.

object

type

required

URI of the problem type: the page that documents code, in the language of the response (https://flashpi.com.ec/docs/en/errors/{code} in English, https://flashpi.com.ec/docs/errors/{code} with Accept-Language: es). It changes with the language, so branch on code, never on type.

string format: uri

title

required

Localized summary of the type.

string

status

required

HTTP status code.

number

detail

required

Localized explanation of this occurrence.

string

instance

required

Path of the request.

string

code

required

Stable machine-readable error code, the same in every language. Branch on it, never on type, title or detail. New codes may be added: handle an unknown one by its HTTP status.

string

Allowed values: bad_request malformed_json invalid_correlation_id validation_failed authentication_required forbidden not_found method_not_allowed not_acceptable conflict payload_too_large unsupported_media_type rate_limited internal_error service_unavailable invalid_api_key key_scope_mismatch key_read_only ip_not_allowed invalid_idempotency_key idempotency_key_reused idempotency_key_in_progress issuer_already_exists establishment_already_exists emission_point_already_exists resource_in_use issuer_onboarding_not_ready issuer_onboarding_expired issuer_onboarding_completed issuer_onboarding_rejected total_mismatch sequential_already_used sequentials_exhausted document_schema_invalid document_too_large document_not_authorized ride_not_available email_recipient_missing email_already_queued email_resend_limit_reached account_email_limit_reached email_sending_paused test_recipient_not_allowed platform_email_limit_reached webhook_endpoint_disabled webhook_endpoint_already_verified webhook_endpoint_not_verified webhook_delivery_in_progress sandbox_not_enabled demo_issuer_quota_exceeded demo_issuer_unavailable account_suspended

errors

required

Field-level errors (may be empty).

Array<object>

object

field

required

Path of the invalid field.

string

code

required

Stable machine-readable reason. New codes may be added: treat an unknown one like invalid_value.

string

Allowed values: required unknown_field invalid_type invalid_format invalid_option too_short too_long out_of_range invalid_value unsupported_character not_found invalid_decimal invalid_identification invalid_check_digit final_consumer_not_allowed not_in_force too_many_additional_fields reserved_name amount_mismatch future_date date_too_early date_too_late discount_exceeds_amount duplicate vat_required unsupported_tax rate_mismatch incompatible_issuer_profile url_not_allowed demo_issuer_test_only demo_issuer_sequential_not_allowed ruc_mismatch

message

required

Localized message.

string

requestId

required

Request ID (UUIDv7); include it when contacting support.

string

documentId

idempotency_key_reused: the document the Idempotency-Key already created.

string format: uuid

limit

The daily limit that was reached (email_resend_limit_reached, account_email_limit_reached, demo_issuer_quota_exceeded).

integer

resetsAt

When the daily limit resets: the next midnight in Ecuador (the three codes above and platform_email_limit_reached). Retry-After gives the same in seconds.

string format: date-time

rideStatus

ride_not_available: the status of the RIDE.

string

Allowed values: pending generated failed

documentStatus

document_not_authorized: the status of the document.

string

Allowed values: processing pending_sri authorized rejected failed voided

environment

email_sending_paused: the mode whose email sending is paused.

string

Allowed values: test live

expectedTotal

total_mismatch: the expectedTotal you sent.

string

computedTotal

total_mismatch: the total Flashpi computed.

string

key

additional properties

any

Example

{
  "type": "https://flashpi.com.ec/docs/en/errors/validation_failed",
  "title": "Validation failed",
  "status": 422,
  "detail": "One or more fields are invalid. See errors for details.",
  "instance": "/v1/invoices",
  "code": "validation_failed",
  "errors": [
    {
      "field": "customer.id",
      "code": "required",
      "message": "This field is required."
    }
  ],
  "requestId": "017f22e2-79b0-7cc3-98c4-dc0c0c07398f",
  "rideStatus": "pending",
  "documentStatus": "processing",
  "environment": "test",
  "expectedTotal": "112.00",
  "computedTotal": "111.99"
}

Headers

WWW-Authenticate

string

RFC 6750 challenge: Bearer realm="flashpi", plus error="invalid_token" with invalid_api_key.

403

The API key cannot perform this operation: key_scope_mismatch, key_read_only or ip_not_allowed; or its account is suspended (account_suspended). Or sandbox_not_enabled: issuerId is the shared demo issuer (sandbox) and the account’s sandbox is not enabled yet (its owner has not verified their email).

application/problem+json

RFC 9457 problem details, in the language of Content-Language (en, or es with Accept-Language: es). Some codes add extension members, listed below; others may appear.

object

type

required

URI of the problem type: the page that documents code, in the language of the response (https://flashpi.com.ec/docs/en/errors/{code} in English, https://flashpi.com.ec/docs/errors/{code} with Accept-Language: es). It changes with the language, so branch on code, never on type.

string format: uri

title

required

Localized summary of the type.

string

status

required

HTTP status code.

number

detail

required

Localized explanation of this occurrence.

string

instance

required

Path of the request.

string

code

required

Stable machine-readable error code, the same in every language. Branch on it, never on type, title or detail. New codes may be added: handle an unknown one by its HTTP status.

string

Allowed values: bad_request malformed_json invalid_correlation_id validation_failed authentication_required forbidden not_found method_not_allowed not_acceptable conflict payload_too_large unsupported_media_type rate_limited internal_error service_unavailable invalid_api_key key_scope_mismatch key_read_only ip_not_allowed invalid_idempotency_key idempotency_key_reused idempotency_key_in_progress issuer_already_exists establishment_already_exists emission_point_already_exists resource_in_use issuer_onboarding_not_ready issuer_onboarding_expired issuer_onboarding_completed issuer_onboarding_rejected total_mismatch sequential_already_used sequentials_exhausted document_schema_invalid document_too_large document_not_authorized ride_not_available email_recipient_missing email_already_queued email_resend_limit_reached account_email_limit_reached email_sending_paused test_recipient_not_allowed platform_email_limit_reached webhook_endpoint_disabled webhook_endpoint_already_verified webhook_endpoint_not_verified webhook_delivery_in_progress sandbox_not_enabled demo_issuer_quota_exceeded demo_issuer_unavailable account_suspended

errors

required

Field-level errors (may be empty).

Array<object>

object

field

required

Path of the invalid field.

string

code

required

Stable machine-readable reason. New codes may be added: treat an unknown one like invalid_value.

string

Allowed values: required unknown_field invalid_type invalid_format invalid_option too_short too_long out_of_range invalid_value unsupported_character not_found invalid_decimal invalid_identification invalid_check_digit final_consumer_not_allowed not_in_force too_many_additional_fields reserved_name amount_mismatch future_date date_too_early date_too_late discount_exceeds_amount duplicate vat_required unsupported_tax rate_mismatch incompatible_issuer_profile url_not_allowed demo_issuer_test_only demo_issuer_sequential_not_allowed ruc_mismatch

message

required

Localized message.

string

requestId

required

Request ID (UUIDv7); include it when contacting support.

string

documentId

idempotency_key_reused: the document the Idempotency-Key already created.

string format: uuid

limit

The daily limit that was reached (email_resend_limit_reached, account_email_limit_reached, demo_issuer_quota_exceeded).

integer

resetsAt

When the daily limit resets: the next midnight in Ecuador (the three codes above and platform_email_limit_reached). Retry-After gives the same in seconds.

string format: date-time

rideStatus

ride_not_available: the status of the RIDE.

string

Allowed values: pending generated failed

documentStatus

document_not_authorized: the status of the document.

string

Allowed values: processing pending_sri authorized rejected failed voided

environment

email_sending_paused: the mode whose email sending is paused.

string

Allowed values: test live

expectedTotal

total_mismatch: the expectedTotal you sent.

string

computedTotal

total_mismatch: the total Flashpi computed.

string

key

additional properties

any

Example

{
  "type": "https://flashpi.com.ec/docs/en/errors/validation_failed",
  "title": "Validation failed",
  "status": 422,
  "detail": "One or more fields are invalid. See errors for details.",
  "instance": "/v1/invoices",
  "code": "validation_failed",
  "errors": [
    {
      "field": "customer.id",
      "code": "required",
      "message": "This field is required."
    }
  ],
  "requestId": "017f22e2-79b0-7cc3-98c4-dc0c0c07398f",
  "rideStatus": "pending",
  "documentStatus": "processing",
  "environment": "test",
  "expectedTotal": "112.00",
  "computedTotal": "111.99"
}

409

Sequential_already_used: the requested sequential is taken. sequentials_exhausted: the emission point reached sequential 999999999 for this document type. Or idempotency_key_in_progress: a request with this Idempotency-Key is still running.

application/problem+json

RFC 9457 problem details, in the language of Content-Language (en, or es with Accept-Language: es). Some codes add extension members, listed below; others may appear.

object

type

required

URI of the problem type: the page that documents code, in the language of the response (https://flashpi.com.ec/docs/en/errors/{code} in English, https://flashpi.com.ec/docs/errors/{code} with Accept-Language: es). It changes with the language, so branch on code, never on type.

string format: uri

title

required

Localized summary of the type.

string

status

required

HTTP status code.

number

detail

required

Localized explanation of this occurrence.

string

instance

required

Path of the request.

string

code

required

Stable machine-readable error code, the same in every language. Branch on it, never on type, title or detail. New codes may be added: handle an unknown one by its HTTP status.

string

Allowed values: bad_request malformed_json invalid_correlation_id validation_failed authentication_required forbidden not_found method_not_allowed not_acceptable conflict payload_too_large unsupported_media_type rate_limited internal_error service_unavailable invalid_api_key key_scope_mismatch key_read_only ip_not_allowed invalid_idempotency_key idempotency_key_reused idempotency_key_in_progress issuer_already_exists establishment_already_exists emission_point_already_exists resource_in_use issuer_onboarding_not_ready issuer_onboarding_expired issuer_onboarding_completed issuer_onboarding_rejected total_mismatch sequential_already_used sequentials_exhausted document_schema_invalid document_too_large document_not_authorized ride_not_available email_recipient_missing email_already_queued email_resend_limit_reached account_email_limit_reached email_sending_paused test_recipient_not_allowed platform_email_limit_reached webhook_endpoint_disabled webhook_endpoint_already_verified webhook_endpoint_not_verified webhook_delivery_in_progress sandbox_not_enabled demo_issuer_quota_exceeded demo_issuer_unavailable account_suspended

errors

required

Field-level errors (may be empty).

Array<object>

object

field

required

Path of the invalid field.

string

code

required

Stable machine-readable reason. New codes may be added: treat an unknown one like invalid_value.

string

Allowed values: required unknown_field invalid_type invalid_format invalid_option too_short too_long out_of_range invalid_value unsupported_character not_found invalid_decimal invalid_identification invalid_check_digit final_consumer_not_allowed not_in_force too_many_additional_fields reserved_name amount_mismatch future_date date_too_early date_too_late discount_exceeds_amount duplicate vat_required unsupported_tax rate_mismatch incompatible_issuer_profile url_not_allowed demo_issuer_test_only demo_issuer_sequential_not_allowed ruc_mismatch

message

required

Localized message.

string

requestId

required

Request ID (UUIDv7); include it when contacting support.

string

documentId

idempotency_key_reused: the document the Idempotency-Key already created.

string format: uuid

limit

The daily limit that was reached (email_resend_limit_reached, account_email_limit_reached, demo_issuer_quota_exceeded).

integer

resetsAt

When the daily limit resets: the next midnight in Ecuador (the three codes above and platform_email_limit_reached). Retry-After gives the same in seconds.

string format: date-time

rideStatus

ride_not_available: the status of the RIDE.

string

Allowed values: pending generated failed

documentStatus

document_not_authorized: the status of the document.

string

Allowed values: processing pending_sri authorized rejected failed voided

environment

email_sending_paused: the mode whose email sending is paused.

string

Allowed values: test live

expectedTotal

total_mismatch: the expectedTotal you sent.

string

computedTotal

total_mismatch: the total Flashpi computed.

string

key

additional properties

any

Example

{
  "type": "https://flashpi.com.ec/docs/en/errors/validation_failed",
  "title": "Validation failed",
  "status": 422,
  "detail": "One or more fields are invalid. See errors for details.",
  "instance": "/v1/invoices",
  "code": "validation_failed",
  "errors": [
    {
      "field": "customer.id",
      "code": "required",
      "message": "This field is required."
    }
  ],
  "requestId": "017f22e2-79b0-7cc3-98c4-dc0c0c07398f",
  "rideStatus": "pending",
  "documentStatus": "processing",
  "environment": "test",
  "expectedTotal": "112.00",
  "computedTotal": "111.99"
}

413

payload_too_large: the JSON body is larger than 1 MB.

application/problem+json

RFC 9457 problem details, in the language of Content-Language (en, or es with Accept-Language: es). Some codes add extension members, listed below; others may appear.

object

type

required

URI of the problem type: the page that documents code, in the language of the response (https://flashpi.com.ec/docs/en/errors/{code} in English, https://flashpi.com.ec/docs/errors/{code} with Accept-Language: es). It changes with the language, so branch on code, never on type.

string format: uri

title

required

Localized summary of the type.

string

status

required

HTTP status code.

number

detail

required

Localized explanation of this occurrence.

string

instance

required

Path of the request.

string

code

required

Stable machine-readable error code, the same in every language. Branch on it, never on type, title or detail. New codes may be added: handle an unknown one by its HTTP status.

string

Allowed values: bad_request malformed_json invalid_correlation_id validation_failed authentication_required forbidden not_found method_not_allowed not_acceptable conflict payload_too_large unsupported_media_type rate_limited internal_error service_unavailable invalid_api_key key_scope_mismatch key_read_only ip_not_allowed invalid_idempotency_key idempotency_key_reused idempotency_key_in_progress issuer_already_exists establishment_already_exists emission_point_already_exists resource_in_use issuer_onboarding_not_ready issuer_onboarding_expired issuer_onboarding_completed issuer_onboarding_rejected total_mismatch sequential_already_used sequentials_exhausted document_schema_invalid document_too_large document_not_authorized ride_not_available email_recipient_missing email_already_queued email_resend_limit_reached account_email_limit_reached email_sending_paused test_recipient_not_allowed platform_email_limit_reached webhook_endpoint_disabled webhook_endpoint_already_verified webhook_endpoint_not_verified webhook_delivery_in_progress sandbox_not_enabled demo_issuer_quota_exceeded demo_issuer_unavailable account_suspended

errors

required

Field-level errors (may be empty).

Array<object>

object

field

required

Path of the invalid field.

string

code

required

Stable machine-readable reason. New codes may be added: treat an unknown one like invalid_value.

string

Allowed values: required unknown_field invalid_type invalid_format invalid_option too_short too_long out_of_range invalid_value unsupported_character not_found invalid_decimal invalid_identification invalid_check_digit final_consumer_not_allowed not_in_force too_many_additional_fields reserved_name amount_mismatch future_date date_too_early date_too_late discount_exceeds_amount duplicate vat_required unsupported_tax rate_mismatch incompatible_issuer_profile url_not_allowed demo_issuer_test_only demo_issuer_sequential_not_allowed ruc_mismatch

message

required

Localized message.

string

requestId

required

Request ID (UUIDv7); include it when contacting support.

string

documentId

idempotency_key_reused: the document the Idempotency-Key already created.

string format: uuid

limit

The daily limit that was reached (email_resend_limit_reached, account_email_limit_reached, demo_issuer_quota_exceeded).

integer

resetsAt

When the daily limit resets: the next midnight in Ecuador (the three codes above and platform_email_limit_reached). Retry-After gives the same in seconds.

string format: date-time

rideStatus

ride_not_available: the status of the RIDE.

string

Allowed values: pending generated failed

documentStatus

document_not_authorized: the status of the document.

string

Allowed values: processing pending_sri authorized rejected failed voided

environment

email_sending_paused: the mode whose email sending is paused.

string

Allowed values: test live

expectedTotal

total_mismatch: the expectedTotal you sent.

string

computedTotal

total_mismatch: the total Flashpi computed.

string

key

additional properties

any

Example

{
  "type": "https://flashpi.com.ec/docs/en/errors/validation_failed",
  "title": "Validation failed",
  "status": 422,
  "detail": "One or more fields are invalid. See errors for details.",
  "instance": "/v1/invoices",
  "code": "validation_failed",
  "errors": [
    {
      "field": "customer.id",
      "code": "required",
      "message": "This field is required."
    }
  ],
  "requestId": "017f22e2-79b0-7cc3-98c4-dc0c0c07398f",
  "rideStatus": "pending",
  "documentStatus": "processing",
  "environment": "test",
  "expectedTotal": "112.00",
  "computedTotal": "111.99"
}

415

unsupported_media_type: the body declares a charset that does not start with utf- (for example latin1, or utf8 without the hyphen) or a Content-Encoding other than gzip, deflate or br.

application/problem+json

RFC 9457 problem details, in the language of Content-Language (en, or es with Accept-Language: es). Some codes add extension members, listed below; others may appear.

object

type

required

URI of the problem type: the page that documents code, in the language of the response (https://flashpi.com.ec/docs/en/errors/{code} in English, https://flashpi.com.ec/docs/errors/{code} with Accept-Language: es). It changes with the language, so branch on code, never on type.

string format: uri

title

required

Localized summary of the type.

string

status

required

HTTP status code.

number

detail

required

Localized explanation of this occurrence.

string

instance

required

Path of the request.

string

code

required

Stable machine-readable error code, the same in every language. Branch on it, never on type, title or detail. New codes may be added: handle an unknown one by its HTTP status.

string

Allowed values: bad_request malformed_json invalid_correlation_id validation_failed authentication_required forbidden not_found method_not_allowed not_acceptable conflict payload_too_large unsupported_media_type rate_limited internal_error service_unavailable invalid_api_key key_scope_mismatch key_read_only ip_not_allowed invalid_idempotency_key idempotency_key_reused idempotency_key_in_progress issuer_already_exists establishment_already_exists emission_point_already_exists resource_in_use issuer_onboarding_not_ready issuer_onboarding_expired issuer_onboarding_completed issuer_onboarding_rejected total_mismatch sequential_already_used sequentials_exhausted document_schema_invalid document_too_large document_not_authorized ride_not_available email_recipient_missing email_already_queued email_resend_limit_reached account_email_limit_reached email_sending_paused test_recipient_not_allowed platform_email_limit_reached webhook_endpoint_disabled webhook_endpoint_already_verified webhook_endpoint_not_verified webhook_delivery_in_progress sandbox_not_enabled demo_issuer_quota_exceeded demo_issuer_unavailable account_suspended

errors

required

Field-level errors (may be empty).

Array<object>

object

field

required

Path of the invalid field.

string

code

required

Stable machine-readable reason. New codes may be added: treat an unknown one like invalid_value.

string

Allowed values: required unknown_field invalid_type invalid_format invalid_option too_short too_long out_of_range invalid_value unsupported_character not_found invalid_decimal invalid_identification invalid_check_digit final_consumer_not_allowed not_in_force too_many_additional_fields reserved_name amount_mismatch future_date date_too_early date_too_late discount_exceeds_amount duplicate vat_required unsupported_tax rate_mismatch incompatible_issuer_profile url_not_allowed demo_issuer_test_only demo_issuer_sequential_not_allowed ruc_mismatch

message

required

Localized message.

string

requestId

required

Request ID (UUIDv7); include it when contacting support.

string

documentId

idempotency_key_reused: the document the Idempotency-Key already created.

string format: uuid

limit

The daily limit that was reached (email_resend_limit_reached, account_email_limit_reached, demo_issuer_quota_exceeded).

integer

resetsAt

When the daily limit resets: the next midnight in Ecuador (the three codes above and platform_email_limit_reached). Retry-After gives the same in seconds.

string format: date-time

rideStatus

ride_not_available: the status of the RIDE.

string

Allowed values: pending generated failed

documentStatus

document_not_authorized: the status of the document.

string

Allowed values: processing pending_sri authorized rejected failed voided

environment

email_sending_paused: the mode whose email sending is paused.

string

Allowed values: test live

expectedTotal

total_mismatch: the expectedTotal you sent.

string

computedTotal

total_mismatch: the total Flashpi computed.

string

key

additional properties

any

Example

{
  "type": "https://flashpi.com.ec/docs/en/errors/validation_failed",
  "title": "Validation failed",
  "status": 422,
  "detail": "One or more fields are invalid. See errors for details.",
  "instance": "/v1/invoices",
  "code": "validation_failed",
  "errors": [
    {
      "field": "customer.id",
      "code": "required",
      "message": "This field is required."
    }
  ],
  "requestId": "017f22e2-79b0-7cc3-98c4-dc0c0c07398f",
  "rideStatus": "pending",
  "documentStatus": "processing",
  "environment": "test",
  "expectedTotal": "112.00",
  "computedTotal": "111.99"
}

422

Validation_failed (see errors; for example invalid_check_digit, final_consumer_not_allowed, not_in_force, unsupported_character, too_many_additional_fields, amount_mismatch, out_of_range for a sync wait above the maximum, demo_issuer_test_only or demo_issuer_sequential_not_allowed with the demo issuer), total_mismatch (expectedTotal differs from the computed total), document_too_large or document_schema_invalid. Or idempotency_key_reused: the Idempotency-Key was used with a different request.

application/problem+json

RFC 9457 problem details, in the language of Content-Language (en, or es with Accept-Language: es). Some codes add extension members, listed below; others may appear.

object

type

required

URI of the problem type: the page that documents code, in the language of the response (https://flashpi.com.ec/docs/en/errors/{code} in English, https://flashpi.com.ec/docs/errors/{code} with Accept-Language: es). It changes with the language, so branch on code, never on type.

string format: uri

title

required

Localized summary of the type.

string

status

required

HTTP status code.

number

detail

required

Localized explanation of this occurrence.

string

instance

required

Path of the request.

string

code

required

Stable machine-readable error code, the same in every language. Branch on it, never on type, title or detail. New codes may be added: handle an unknown one by its HTTP status.

string

Allowed values: bad_request malformed_json invalid_correlation_id validation_failed authentication_required forbidden not_found method_not_allowed not_acceptable conflict payload_too_large unsupported_media_type rate_limited internal_error service_unavailable invalid_api_key key_scope_mismatch key_read_only ip_not_allowed invalid_idempotency_key idempotency_key_reused idempotency_key_in_progress issuer_already_exists establishment_already_exists emission_point_already_exists resource_in_use issuer_onboarding_not_ready issuer_onboarding_expired issuer_onboarding_completed issuer_onboarding_rejected total_mismatch sequential_already_used sequentials_exhausted document_schema_invalid document_too_large document_not_authorized ride_not_available email_recipient_missing email_already_queued email_resend_limit_reached account_email_limit_reached email_sending_paused test_recipient_not_allowed platform_email_limit_reached webhook_endpoint_disabled webhook_endpoint_already_verified webhook_endpoint_not_verified webhook_delivery_in_progress sandbox_not_enabled demo_issuer_quota_exceeded demo_issuer_unavailable account_suspended

errors

required

Field-level errors (may be empty).

Array<object>

object

field

required

Path of the invalid field.

string

code

required

Stable machine-readable reason. New codes may be added: treat an unknown one like invalid_value.

string

Allowed values: required unknown_field invalid_type invalid_format invalid_option too_short too_long out_of_range invalid_value unsupported_character not_found invalid_decimal invalid_identification invalid_check_digit final_consumer_not_allowed not_in_force too_many_additional_fields reserved_name amount_mismatch future_date date_too_early date_too_late discount_exceeds_amount duplicate vat_required unsupported_tax rate_mismatch incompatible_issuer_profile url_not_allowed demo_issuer_test_only demo_issuer_sequential_not_allowed ruc_mismatch

message

required

Localized message.

string

requestId

required

Request ID (UUIDv7); include it when contacting support.

string

documentId

idempotency_key_reused: the document the Idempotency-Key already created.

string format: uuid

limit

The daily limit that was reached (email_resend_limit_reached, account_email_limit_reached, demo_issuer_quota_exceeded).

integer

resetsAt

When the daily limit resets: the next midnight in Ecuador (the three codes above and platform_email_limit_reached). Retry-After gives the same in seconds.

string format: date-time

rideStatus

ride_not_available: the status of the RIDE.

string

Allowed values: pending generated failed

documentStatus

document_not_authorized: the status of the document.

string

Allowed values: processing pending_sri authorized rejected failed voided

environment

email_sending_paused: the mode whose email sending is paused.

string

Allowed values: test live

expectedTotal

total_mismatch: the expectedTotal you sent.

string

computedTotal

total_mismatch: the total Flashpi computed.

string

key

additional properties

any

Example

{
  "type": "https://flashpi.com.ec/docs/en/errors/validation_failed",
  "title": "Validation failed",
  "status": 422,
  "detail": "One or more fields are invalid. See errors for details.",
  "instance": "/v1/invoices",
  "code": "validation_failed",
  "errors": [
    {
      "field": "customer.id",
      "code": "required",
      "message": "This field is required."
    }
  ],
  "requestId": "017f22e2-79b0-7cc3-98c4-dc0c0c07398f",
  "rideStatus": "pending",
  "documentStatus": "processing",
  "environment": "test",
  "expectedTotal": "112.00",
  "computedTotal": "111.99"
}

429

demo_issuer_quota_exceeded: issuerId is the shared demo issuer (sandbox) and the account already issued today’s test documents with it (days follow the calendar in Ecuador). It carries Retry-After, limit and resetsAt; use your own issuer to issue more.

application/problem+json

RFC 9457 problem details, in the language of Content-Language (en, or es with Accept-Language: es). Some codes add extension members, listed below; others may appear.

object

type

required

URI of the problem type: the page that documents code, in the language of the response (https://flashpi.com.ec/docs/en/errors/{code} in English, https://flashpi.com.ec/docs/errors/{code} with Accept-Language: es). It changes with the language, so branch on code, never on type.

string format: uri

title

required

Localized summary of the type.

string

status

required

HTTP status code.

number

detail

required

Localized explanation of this occurrence.

string

instance

required

Path of the request.

string

code

required

Stable machine-readable error code, the same in every language. Branch on it, never on type, title or detail. New codes may be added: handle an unknown one by its HTTP status.

string

Allowed values: bad_request malformed_json invalid_correlation_id validation_failed authentication_required forbidden not_found method_not_allowed not_acceptable conflict payload_too_large unsupported_media_type rate_limited internal_error service_unavailable invalid_api_key key_scope_mismatch key_read_only ip_not_allowed invalid_idempotency_key idempotency_key_reused idempotency_key_in_progress issuer_already_exists establishment_already_exists emission_point_already_exists resource_in_use issuer_onboarding_not_ready issuer_onboarding_expired issuer_onboarding_completed issuer_onboarding_rejected total_mismatch sequential_already_used sequentials_exhausted document_schema_invalid document_too_large document_not_authorized ride_not_available email_recipient_missing email_already_queued email_resend_limit_reached account_email_limit_reached email_sending_paused test_recipient_not_allowed platform_email_limit_reached webhook_endpoint_disabled webhook_endpoint_already_verified webhook_endpoint_not_verified webhook_delivery_in_progress sandbox_not_enabled demo_issuer_quota_exceeded demo_issuer_unavailable account_suspended

errors

required

Field-level errors (may be empty).

Array<object>

object

field

required

Path of the invalid field.

string

code

required

Stable machine-readable reason. New codes may be added: treat an unknown one like invalid_value.

string

Allowed values: required unknown_field invalid_type invalid_format invalid_option too_short too_long out_of_range invalid_value unsupported_character not_found invalid_decimal invalid_identification invalid_check_digit final_consumer_not_allowed not_in_force too_many_additional_fields reserved_name amount_mismatch future_date date_too_early date_too_late discount_exceeds_amount duplicate vat_required unsupported_tax rate_mismatch incompatible_issuer_profile url_not_allowed demo_issuer_test_only demo_issuer_sequential_not_allowed ruc_mismatch

message

required

Localized message.

string

requestId

required

Request ID (UUIDv7); include it when contacting support.

string

documentId

idempotency_key_reused: the document the Idempotency-Key already created.

string format: uuid

limit

The daily limit that was reached (email_resend_limit_reached, account_email_limit_reached, demo_issuer_quota_exceeded).

integer

resetsAt

When the daily limit resets: the next midnight in Ecuador (the three codes above and platform_email_limit_reached). Retry-After gives the same in seconds.

string format: date-time

rideStatus

ride_not_available: the status of the RIDE.

string

Allowed values: pending generated failed

documentStatus

document_not_authorized: the status of the document.

string

Allowed values: processing pending_sri authorized rejected failed voided

environment

email_sending_paused: the mode whose email sending is paused.

string

Allowed values: test live

expectedTotal

total_mismatch: the expectedTotal you sent.

string

computedTotal

total_mismatch: the total Flashpi computed.

string

key

additional properties

any

Example

{
  "type": "https://flashpi.com.ec/docs/en/errors/validation_failed",
  "title": "Validation failed",
  "status": 422,
  "detail": "One or more fields are invalid. See errors for details.",
  "instance": "/v1/invoices",
  "code": "validation_failed",
  "errors": [
    {
      "field": "customer.id",
      "code": "required",
      "message": "This field is required."
    }
  ],
  "requestId": "017f22e2-79b0-7cc3-98c4-dc0c0c07398f",
  "rideStatus": "pending",
  "documentStatus": "processing",
  "environment": "test",
  "expectedTotal": "112.00",
  "computedTotal": "111.99"
}

Headers

Retry-After

integer

>= 1

Whole seconds to wait before trying again.

503

demo_issuer_unavailable: issuerId is the shared demo issuer (sandbox) and it cannot sign test documents now (no usable test certificate). Nothing is created; retry later or use your own issuer.

application/problem+json

RFC 9457 problem details, in the language of Content-Language (en, or es with Accept-Language: es). Some codes add extension members, listed below; others may appear.

object

type

required

URI of the problem type: the page that documents code, in the language of the response (https://flashpi.com.ec/docs/en/errors/{code} in English, https://flashpi.com.ec/docs/errors/{code} with Accept-Language: es). It changes with the language, so branch on code, never on type.

string format: uri

title

required

Localized summary of the type.

string

status

required

HTTP status code.

number

detail

required

Localized explanation of this occurrence.

string

instance

required

Path of the request.

string

code

required

Stable machine-readable error code, the same in every language. Branch on it, never on type, title or detail. New codes may be added: handle an unknown one by its HTTP status.

string

Allowed values: bad_request malformed_json invalid_correlation_id validation_failed authentication_required forbidden not_found method_not_allowed not_acceptable conflict payload_too_large unsupported_media_type rate_limited internal_error service_unavailable invalid_api_key key_scope_mismatch key_read_only ip_not_allowed invalid_idempotency_key idempotency_key_reused idempotency_key_in_progress issuer_already_exists establishment_already_exists emission_point_already_exists resource_in_use issuer_onboarding_not_ready issuer_onboarding_expired issuer_onboarding_completed issuer_onboarding_rejected total_mismatch sequential_already_used sequentials_exhausted document_schema_invalid document_too_large document_not_authorized ride_not_available email_recipient_missing email_already_queued email_resend_limit_reached account_email_limit_reached email_sending_paused test_recipient_not_allowed platform_email_limit_reached webhook_endpoint_disabled webhook_endpoint_already_verified webhook_endpoint_not_verified webhook_delivery_in_progress sandbox_not_enabled demo_issuer_quota_exceeded demo_issuer_unavailable account_suspended

errors

required

Field-level errors (may be empty).

Array<object>

object

field

required

Path of the invalid field.

string

code

required

Stable machine-readable reason. New codes may be added: treat an unknown one like invalid_value.

string

Allowed values: required unknown_field invalid_type invalid_format invalid_option too_short too_long out_of_range invalid_value unsupported_character not_found invalid_decimal invalid_identification invalid_check_digit final_consumer_not_allowed not_in_force too_many_additional_fields reserved_name amount_mismatch future_date date_too_early date_too_late discount_exceeds_amount duplicate vat_required unsupported_tax rate_mismatch incompatible_issuer_profile url_not_allowed demo_issuer_test_only demo_issuer_sequential_not_allowed ruc_mismatch

message

required

Localized message.

string

requestId

required

Request ID (UUIDv7); include it when contacting support.

string

documentId

idempotency_key_reused: the document the Idempotency-Key already created.

string format: uuid

limit

The daily limit that was reached (email_resend_limit_reached, account_email_limit_reached, demo_issuer_quota_exceeded).

integer

resetsAt

When the daily limit resets: the next midnight in Ecuador (the three codes above and platform_email_limit_reached). Retry-After gives the same in seconds.

string format: date-time

rideStatus

ride_not_available: the status of the RIDE.

string

Allowed values: pending generated failed

documentStatus

document_not_authorized: the status of the document.

string

Allowed values: processing pending_sri authorized rejected failed voided

environment

email_sending_paused: the mode whose email sending is paused.

string

Allowed values: test live

expectedTotal

total_mismatch: the expectedTotal you sent.

string

computedTotal

total_mismatch: the total Flashpi computed.

string

key

additional properties

any

Example

{
  "type": "https://flashpi.com.ec/docs/en/errors/validation_failed",
  "title": "Validation failed",
  "status": 422,
  "detail": "One or more fields are invalid. See errors for details.",
  "instance": "/v1/invoices",
  "code": "validation_failed",
  "errors": [
    {
      "field": "customer.id",
      "code": "required",
      "message": "This field is required."
    }
  ],
  "requestId": "017f22e2-79b0-7cc3-98c4-dc0c0c07398f",
  "rideStatus": "pending",
  "documentStatus": "processing",
  "environment": "test",
  "expectedTotal": "112.00",
  "computedTotal": "111.99"
}

Issue a debit note

Authorizations

Parameters

Header Parameters

Request Bodyrequired

Examples

Responses

200

Example

Headers

202

Example

Headers

400

Example

401

Example

Headers

403

Example

409

Example

413

Example

415

Example

422

Example

429

Example

Headers

503

Example

Request Body^required