Solicita la baja de un documento aceptado
curl https://api.boletura.com/v1/documents/0192f2c4-7d1e-7a3b-9c4d-5e6f7a8b9c0d/void \ --request POST \ --header 'Authorization: Bearer bol_test_TU_CLAVE' \ --header 'Idempotency-Key: 5c91bda0-35a6-4683-a840-5998813e2e13' \ --header 'Content-Type: application/json' \ --data '{ "reason": "Error en los datos del cliente"}'$ch = curl_init("https://api.boletura.com/v1/documents/0192f2c4-7d1e-7a3b-9c4d-5e6f7a8b9c0d/void");
curl_setopt($ch, CURLOPT_POST, true);curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: Bearer bol_test_TU_CLAVE', 'Idempotency-Key: 5c91bda0-35a6-4683-a840-5998813e2e13', 'Content-Type: application/json']);curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([ 'reason' => 'Error en los datos del cliente']));
curl_exec($ch);
curl_close($ch);import http.clientimport json
conn = http.client.HTTPSConnection("api.boletura.com")
payload = json.dumps({ "reason": "Error en los datos del cliente"})headers = { "Authorization": "Bearer bol_test_TU_CLAVE", "Idempotency-Key": "5c91bda0-35a6-4683-a840-5998813e2e13", "Content-Type": "application/json"}
conn.request( "POST", "/v1/documents/0192f2c4-7d1e-7a3b-9c4d-5e6f7a8b9c0d/void", body=payload, headers=headers,)
response = conn.getresponse()print(response.read().decode())
conn.close()using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://api.boletura.com/v1/documents/0192f2c4-7d1e-7a3b-9c4d-5e6f7a8b9c0d/void");request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", "bol_test_TU_CLAVE");request.Headers.TryAddWithoutValidation("Idempotency-Key", "5c91bda0-35a6-4683-a840-5998813e2e13");request.Content = new StringContent("""{ "reason": "Error en los datos del cliente"}""",System.Text.Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);java.io.ByteArrayOutputStream body = new java.io.ByteArrayOutputStream();body.write("{\n \"reason\": \"Error en los datos del cliente\"\n}".getBytes(java.nio.charset.StandardCharsets.UTF_8));
HttpClient client = HttpClient.newHttpClient();HttpRequest request = HttpRequest.newBuilder() .uri(java.net.URI.create("https://api.boletura.com/v1/documents/0192f2c4-7d1e-7a3b-9c4d-5e6f7a8b9c0d/void")) .header("Authorization", "Bearer bol_test_TU_CLAVE") .header("Idempotency-Key", "5c91bda0-35a6-4683-a840-5998813e2e13") .header("Content-Type", "application/json") .method("POST", HttpRequest.BodyPublishers.ofByteArray(body.toByteArray())) .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());System.out.println(response.body());fetch('https://api.boletura.com/v1/documents/0192f2c4-7d1e-7a3b-9c4d-5e6f7a8b9c0d/void', { method: 'POST', headers: { Authorization: 'Bearer bol_test_TU_CLAVE', 'Idempotency-Key': '5c91bda0-35a6-4683-a840-5998813e2e13', 'Content-Type': 'application/json' }, body: JSON.stringify({ reason: 'Error en los datos del cliente' })})Solo documentos ya aceptados por SUNAT; uno pendiente, con resultado desconocido o fuera de plazo responde 409 document_not_voidable, y uno ya anulado o en anulación, 409 document_already_voided. Una factura o una nota sobre factura se admite hasta 3 horas antes del fin del séptimo día de su emisión; una boleta o una nota sobre boleta, si SUNAT recibe el resumen dentro de los 7 días de su emisión. El resultado llega por status y sunat_status, y por los webhooks document.voided o document.void_rejected.
Requiere el scope documents:write.
Autorización
Sección titulada «Autorización»Parámetros
Sección titulada «Parámetros»Parámetros de la ruta
Sección titulada «Parámetros de la ruta»UUID del documento que se anula. Uno que no existe en el tenant y ambiente de la clave, o que no es un UUID, responde 404 not_found.
Parámetros de cabecera
Sección titulada «Parámetros de cabecera»Identifica la operación para reintentarla sin duplicarla durante 24 horas desde la respuesta final; se recomienda un UUID. De 1 a 128 caracteres [A-Za-z0-9._:-]. Sin ella responde 400 idempotency_key_required, y con otro formato, 400 idempotency_key_invalid. La misma clave con otra solicitud responde 422 idempotency_key_reused, y con la primera aún en curso, 409 idempotency_in_progress.
Cuerpo de la solicitudobligatorio
Sección titulada «Cuerpo de la solicitudobligatorio»Solicitud de baja.
object
Motivo de la baja, de 3 a 100 caracteres, sin saltos de línea ni tabuladores (422 field_required, 422 field_too_short, 422 field_too_long, 422 field_invalid_characters).
Ejemplos
Baja
{ "reason": "Error en los datos del cliente"}Respuestas
Sección titulada «Respuestas»Baja solicitada: el documento queda en status = void_requested.
Comprobante electrónico: una boleta, una factura, una nota de crédito o una nota de débito.
object
UUID del documento.
Siempre document.
Ambiente del documento. Uno de test no se ve con una clave live, ni al revés.
UUID de la empresa emisora.
Tipo de comprobante.
Serie, como B001.
Correlativo dentro de la serie.
Serie y correlativo, como B001-125.
Fecha de emisión, en fecha civil de Lima.
Moneda; hoy siempre PEN.
Cliente del comprobante.
object
Tipo de documento del cliente.
Número de documento; nulo si el cliente no tiene.
Nombre o razón social.
Dirección.
Correo.
Líneas del comprobante. No aparece en el listado.
Línea del comprobante, con los importes calculados por la plataforma.
object
Número de línea, desde 1.
Código interno del integrador; nulo si el ítem no lo trajo.
Descripción de la línea.
Cantidad, sin ceros finales.
Código de unidad de medida.
Precio unitario con IGV, sin ceros finales.
Valor unitario sin IGV, sin ceros finales.
Afectación al IGV.
Tasa del IGV en porcentaje, como 18.
Valor de la línea sin IGV, con 2 decimales.
IGV de la línea, con 2 decimales.
Total de la línea con IGV, con 2 decimales.
Totales calculados por la plataforma.
object
Total de operaciones gravadas, sin IGV.
Total de operaciones exoneradas.
Total de operaciones inafectas.
Total de descuentos; hoy siempre 0.00.
IGV total.
Importe total con IGV.
Importe total en letras.
Estado interno.
Estado fiscal. Es el campo que dice si el documento es válido.
Estado de la entrega por webhook.
Detalle del envío a SUNAT.
object
Código de respuesta de SUNAT; nulo hasta que responde.
Descripción de la respuesta de SUNAT; nula hasta que responde.
Observaciones de SUNAT.
Fin del plazo de envío: la fecha de emisión más 3 días en facturas y sus notas, y más 7 en boletas y sus notas, al final del día de Lima. No limita la llegada del CDR.
Envío a SUNAT; nulo si aún no se envió. Timestamp RFC 3339 en UTC, con seis decimales.
Aceptación de SUNAT; nula si aún no se aceptó. Timestamp RFC 3339 en UTC, con seis decimales.
true si hay un envío con resultado desconocido y se está recuperando el CDR o el ticket. No reemitas mientras dure.
Valor de resumen de la firma del XML (DigestValue).
Texto del QR del comprobante, con sus campos separados por |.
PNG del QR como data URI. No aparece en el listado.
Enlaces de descarga.
object
Ruta del PDF.
Ruta del XML firmado.
Ruta del CDR; nula hasta que SUNAT responde, y en una boleta confirmada con una revisión manual de su resumen, que no tiene CDR.
En una nota de crédito o de débito, el documento que afecta; si no, nulo.
Motivo de la nota de crédito; nulo en los demás comprobantes.
object
Motivo de la nota.
Descripción libre del motivo.
Motivo de la nota de débito; nulo en los demás comprobantes.
object
Motivo de la nota.
Descripción libre del motivo.
Identificador del integrador; nulo si no se envió.
Documento rechazado que este reemplaza; nulo si no reemplaza a ninguno.
El objeto que envió el integrador; nulo si no envió ninguno.
Creación. Timestamp RFC 3339 en UTC, con seis decimales.
Última modificación. Timestamp RFC 3339 en UTC, con seis decimales.
Ejemplos
Baja solicitada
{ "id": "0192f1a2-7c3e-7d4b-9a8f-2b6c1d0e4f5b", "object": "document", "environment": "test", "company_id": "0192f0b1-2d4c-7a1e-8b3f-1c2d3e4f5a6b", "type": "factura", "series": "F001", "number": 42, "full_number": "F001-42", "issue_date": "2026-10-09", "currency": "PEN", "customer": { "document_type": "ruc", "document_number": "20131312955", "name": "Cliente S.A.C.", "address": null, "email": null }, "items": [ { "line_number": 1, "product_code": null, "description": "Servicio mensual", "quantity": 2, "unit": "ZZ", "unit_price": 118, "unit_value": 100, "tax_affectation": "gravado", "igv_rate": 18, "line_value": 200, "igv_amount": 36, "line_total": 236 } ], "totals": { "taxable": 200, "exempt": 0, "unaffected": 0, "discount": 0, "igv": 36, "total": 236, "amount_in_words": "DOSCIENTOS TREINTA Y SEIS CON 00/100 SOLES" }, "status": "void_requested", "sunat_status": "accepted", "delivery_status": "none", "sunat": { "response_code": "0", "description": "La Factura numero F001-42, ha sido aceptada", "notes": [], "deadline_at": "2026-10-13T04:59:59.000000Z", "submitted_at": "2026-10-09T14:03:25.102938Z", "accepted_at": "2026-10-09T14:03:27.562910Z", "reconciliation_required": false }, "hash": "2/tssig+2hIBSmZyIT0CWMhsTMnRKmApc0tdWRsDs4U=", "qr_text": "20100066603|01|F001|42|36.00|236.00|2026-10-09|6|20131312955|2/tssig+2hIBSmZyIT0CWMhsTMnRKmApc0tdWRsDs4U=", "qr_image": "data:image/png;base64,iVBORw0KGgo=", "links": { "pdf": "/v1/documents/0192f1a2-7c3e-7d4b-9a8f-2b6c1d0e4f5b/pdf", "xml": "/v1/documents/0192f1a2-7c3e-7d4b-9a8f-2b6c1d0e4f5b/xml", "cdr": "/v1/documents/0192f1a2-7c3e-7d4b-9a8f-2b6c1d0e4f5b/cdr" }, "affected_document_id": null, "credit_note": null, "debit_note": null, "external_id": null, "replaces_document_id": null, "metadata": null, "created_at": "2026-10-09T14:03:21.482913Z", "updated_at": "2026-10-09T16:10:04.318204Z"}Cabeceras
Sección titulada «Cabeceras»El del cliente si tiene de 1 a 128 caracteres [A-Za-z0-9._-]; si no, uno generado. Es el request_id de los errores.
Solicitudes admitidas en la ventana de un minuto, de la clave o de la IP.
Solicitudes que quedan en la ventana.
Segundos hasta la ventana siguiente.
true cuando la respuesta es la guardada de una solicitud anterior con la misma Idempotency-Key.
Solicitud mal formada. Códigos: invalid_json, bad_request, idempotency_key_required, idempotency_key_invalid. No se reintenta sin corregirla.
Formato único de los errores de la API.
object
El error principal.
object
Familia del error, como validation_error, conflict o unavailable.
Código estable, para programar contra él.
Mensaje en español, apto para mostrar a un operador. Puede cambiar: no se programa contra él.
Ruta del campo en el JSON, con índices entre corchetes, como items[2].unit_price. Solo cuando el error apunta a un campo.
Identificador de la solicitud, el mismo de X-Request-Id. Inclúyelo al escribir a soporte.
Documento con el que choca la solicitud. Solo en external_id_conflict y document_already_replaced.
Todos los problemas. Solo aparece cuando hay varios.
Uno de los problemas de la solicitud.
object
Código estable, para programar contra él.
Mensaje en español, apto para mostrar a un operador.
Ruta del campo en el JSON, si el error apunta a uno.
Ejemplos
idempotency_key_required
{ "error": { "type": "bad_request", "code": "idempotency_key_required", "message": "Falta la cabecera Idempotency-Key.", "request_id": "req_0192f1a27c3e7d4b9a8f2b6c1d0e4f5a" }}Cabeceras
Sección titulada «Cabeceras»El del cliente si tiene de 1 a 128 caracteres [A-Za-z0-9._-]; si no, uno generado. Es el request_id de los errores.
Solicitudes admitidas en la ventana de un minuto, de la clave o de la IP.
Solicitudes que quedan en la ventana.
Segundos hasta la ventana siguiente.
Sin una API key válida. Códigos: unauthorized, invalid_api_key, revoked_api_key, expired_api_key.
Formato único de los errores de la API.
object
El error principal.
object
Familia del error, como validation_error, conflict o unavailable.
Código estable, para programar contra él.
Mensaje en español, apto para mostrar a un operador. Puede cambiar: no se programa contra él.
Ruta del campo en el JSON, con índices entre corchetes, como items[2].unit_price. Solo cuando el error apunta a un campo.
Identificador de la solicitud, el mismo de X-Request-Id. Inclúyelo al escribir a soporte.
Documento con el que choca la solicitud. Solo en external_id_conflict y document_already_replaced.
Todos los problemas. Solo aparece cuando hay varios.
Uno de los problemas de la solicitud.
object
Código estable, para programar contra él.
Mensaje en español, apto para mostrar a un operador.
Ruta del campo en el JSON, si el error apunta a uno.
Ejemplos
invalid_api_key
{ "error": { "type": "unauthorized", "code": "invalid_api_key", "message": "La API key no es válida.", "request_id": "req_0192f1a27c3e7d4b9a8f2b6c1d0e4f5a" }}Cabeceras
Sección titulada «Cabeceras»El del cliente si tiene de 1 a 128 caracteres [A-Za-z0-9._-]; si no, uno generado. Es el request_id de los errores.
Solicitudes admitidas en la ventana de un minuto, de la clave o de la IP.
Solicitudes que quedan en la ventana.
Segundos hasta la ventana siguiente.
La clave no puede operar. Códigos: forbidden (no tiene el scope), tenant_suspended, plan_without_api (el plan de la cuenta no incluye la API), account_not_activated (emisión en live de una cuenta que Boletura todavía no activó).
Formato único de los errores de la API.
object
El error principal.
object
Familia del error, como validation_error, conflict o unavailable.
Código estable, para programar contra él.
Mensaje en español, apto para mostrar a un operador. Puede cambiar: no se programa contra él.
Ruta del campo en el JSON, con índices entre corchetes, como items[2].unit_price. Solo cuando el error apunta a un campo.
Identificador de la solicitud, el mismo de X-Request-Id. Inclúyelo al escribir a soporte.
Documento con el que choca la solicitud. Solo en external_id_conflict y document_already_replaced.
Todos los problemas. Solo aparece cuando hay varios.
Uno de los problemas de la solicitud.
object
Código estable, para programar contra él.
Mensaje en español, apto para mostrar a un operador.
Ruta del campo en el JSON, si el error apunta a uno.
Ejemplos
forbidden
{ "error": { "type": "forbidden", "code": "forbidden", "message": "La API key no tiene el scope documents:write que exige este endpoint.", "request_id": "req_0192f1a27c3e7d4b9a8f2b6c1d0e4f5a" }}Cabeceras
Sección titulada «Cabeceras»El del cliente si tiene de 1 a 128 caracteres [A-Za-z0-9._-]; si no, uno generado. Es el request_id de los errores.
Solicitudes admitidas en la ventana de un minuto, de la clave o de la IP.
Solicitudes que quedan en la ventana.
Segundos hasta la ventana siguiente.
not_found: no existe en el tenant y ambiente de la clave.
Formato único de los errores de la API.
object
El error principal.
object
Familia del error, como validation_error, conflict o unavailable.
Código estable, para programar contra él.
Mensaje en español, apto para mostrar a un operador. Puede cambiar: no se programa contra él.
Ruta del campo en el JSON, con índices entre corchetes, como items[2].unit_price. Solo cuando el error apunta a un campo.
Identificador de la solicitud, el mismo de X-Request-Id. Inclúyelo al escribir a soporte.
Documento con el que choca la solicitud. Solo en external_id_conflict y document_already_replaced.
Todos los problemas. Solo aparece cuando hay varios.
Uno de los problemas de la solicitud.
object
Código estable, para programar contra él.
Mensaje en español, apto para mostrar a un operador.
Ruta del campo en el JSON, si el error apunta a uno.
Ejemplos
not_found
{ "error": { "type": "not_found", "code": "not_found", "message": "El documento no existe.", "request_id": "req_0192f1a27c3e7d4b9a8f2b6c1d0e4f5a" }}Cabeceras
Sección titulada «Cabeceras»El del cliente si tiene de 1 a 128 caracteres [A-Za-z0-9._-]; si no, uno generado. Es el request_id de los errores.
Solicitudes admitidas en la ventana de un minuto, de la clave o de la IP.
Solicitudes que quedan en la ventana.
Segundos hasta la ventana siguiente.
Conflicto con el estado del documento. idempotency_in_progress se reintenta con la misma clave unos segundos después. document_not_voidable y document_already_voided no se reintentan mientras ese estado no cambie.
Formato único de los errores de la API.
object
El error principal.
object
Familia del error, como validation_error, conflict o unavailable.
Código estable, para programar contra él.
Mensaje en español, apto para mostrar a un operador. Puede cambiar: no se programa contra él.
Ruta del campo en el JSON, con índices entre corchetes, como items[2].unit_price. Solo cuando el error apunta a un campo.
Identificador de la solicitud, el mismo de X-Request-Id. Inclúyelo al escribir a soporte.
Documento con el que choca la solicitud. Solo en external_id_conflict y document_already_replaced.
Todos los problemas. Solo aparece cuando hay varios.
Uno de los problemas de la solicitud.
object
Código estable, para programar contra él.
Mensaje en español, apto para mostrar a un operador.
Ruta del campo en el JSON, si el error apunta a uno.
Ejemplos
document_not_voidable
{ "error": { "type": "conflict", "code": "document_not_voidable", "message": "El documento todavía no está aceptado por SUNAT: se anula después de que lo acepte, o no se anula si lo rechazó.", "request_id": "req_0192f1a27c3e7d4b9a8f2b6c1d0e4f5a" }}Cabeceras
Sección titulada «Cabeceras»El del cliente si tiene de 1 a 128 caracteres [A-Za-z0-9._-]; si no, uno generado. Es el request_id de los errores.
Solicitudes admitidas en la ventana de un minuto, de la clave o de la IP.
Solicitudes que quedan en la ventana.
Segundos hasta la ventana siguiente.
payload_too_large: el cuerpo supera 256 KiB.
Formato único de los errores de la API.
object
El error principal.
object
Familia del error, como validation_error, conflict o unavailable.
Código estable, para programar contra él.
Mensaje en español, apto para mostrar a un operador. Puede cambiar: no se programa contra él.
Ruta del campo en el JSON, con índices entre corchetes, como items[2].unit_price. Solo cuando el error apunta a un campo.
Identificador de la solicitud, el mismo de X-Request-Id. Inclúyelo al escribir a soporte.
Documento con el que choca la solicitud. Solo en external_id_conflict y document_already_replaced.
Todos los problemas. Solo aparece cuando hay varios.
Uno de los problemas de la solicitud.
object
Código estable, para programar contra él.
Mensaje en español, apto para mostrar a un operador.
Ruta del campo en el JSON, si el error apunta a uno.
Ejemplos
payload_too_large
{ "error": { "type": "payload_too_large", "code": "payload_too_large", "message": "El cuerpo supera el tamaño máximo: 256 KiB, o 2 MiB al subir un certificado, un logo o un CDR.", "request_id": "req_0192f1a27c3e7d4b9a8f2b6c1d0e4f5a" }}Cabeceras
Sección titulada «Cabeceras»El del cliente si tiene de 1 a 128 caracteres [A-Za-z0-9._-]; si no, uno generado. Es el request_id de los errores.
Solicitudes admitidas en la ventana de un minuto, de la clave o de la IP.
Solicitudes que quedan en la ventana.
Segundos hasta la ventana siguiente.
unsupported_media_type: el cuerpo no llega con Content-Type: application/json.
Formato único de los errores de la API.
object
El error principal.
object
Familia del error, como validation_error, conflict o unavailable.
Código estable, para programar contra él.
Mensaje en español, apto para mostrar a un operador. Puede cambiar: no se programa contra él.
Ruta del campo en el JSON, con índices entre corchetes, como items[2].unit_price. Solo cuando el error apunta a un campo.
Identificador de la solicitud, el mismo de X-Request-Id. Inclúyelo al escribir a soporte.
Documento con el que choca la solicitud. Solo en external_id_conflict y document_already_replaced.
Todos los problemas. Solo aparece cuando hay varios.
Uno de los problemas de la solicitud.
object
Código estable, para programar contra él.
Mensaje en español, apto para mostrar a un operador.
Ruta del campo en el JSON, si el error apunta a uno.
Ejemplos
unsupported_media_type
{ "error": { "type": "unsupported_media_type", "code": "unsupported_media_type", "message": "El cuerpo debe enviarse con Content-Type application/json.", "request_id": "req_0192f1a27c3e7d4b9a8f2b6c1d0e4f5a" }}Cabeceras
Sección titulada «Cabeceras»El del cliente si tiene de 1 a 128 caracteres [A-Za-z0-9._-]; si no, uno generado. Es el request_id de los errores.
Solicitudes admitidas en la ventana de un minuto, de la clave o de la IP.
Solicitudes que quedan en la ventana.
Segundos hasta la ventana siguiente.
Datos no válidos: error.param señala el campo y errors lista todos los problemas si hay varios. El cuerpo corregido se envía con la misma Idempotency-Key, salvo en idempotency_key_reused: esa clave ya es de otra solicitud y repetirla devuelve el mismo error, así que se envía el cuerpo original o se usa una clave nueva.
Formato único de los errores de la API.
object
El error principal.
object
Familia del error, como validation_error, conflict o unavailable.
Código estable, para programar contra él.
Mensaje en español, apto para mostrar a un operador. Puede cambiar: no se programa contra él.
Ruta del campo en el JSON, con índices entre corchetes, como items[2].unit_price. Solo cuando el error apunta a un campo.
Identificador de la solicitud, el mismo de X-Request-Id. Inclúyelo al escribir a soporte.
Documento con el que choca la solicitud. Solo en external_id_conflict y document_already_replaced.
Todos los problemas. Solo aparece cuando hay varios.
Uno de los problemas de la solicitud.
object
Código estable, para programar contra él.
Mensaje en español, apto para mostrar a un operador.
Ruta del campo en el JSON, si el error apunta a uno.
Ejemplos
field_required
{ "error": { "type": "validation_error", "code": "field_required", "message": "El campo es obligatorio.", "param": "reason", "request_id": "req_0192f1a27c3e7d4b9a8f2b6c1d0e4f5a" }}Cabeceras
Sección titulada «Cabeceras»El del cliente si tiene de 1 a 128 caracteres [A-Za-z0-9._-]; si no, uno generado. Es el request_id de los errores.
Solicitudes admitidas en la ventana de un minuto, de la clave o de la IP.
Solicitudes que quedan en la ventana.
Segundos hasta la ventana siguiente.
rate_limited: se superó el límite de 600 solicitudes por minuto por clave o 1200 por IP. Se reintenta después de Retry-After.
Formato único de los errores de la API.
object
El error principal.
object
Familia del error, como validation_error, conflict o unavailable.
Código estable, para programar contra él.
Mensaje en español, apto para mostrar a un operador. Puede cambiar: no se programa contra él.
Ruta del campo en el JSON, con índices entre corchetes, como items[2].unit_price. Solo cuando el error apunta a un campo.
Identificador de la solicitud, el mismo de X-Request-Id. Inclúyelo al escribir a soporte.
Documento con el que choca la solicitud. Solo en external_id_conflict y document_already_replaced.
Todos los problemas. Solo aparece cuando hay varios.
Uno de los problemas de la solicitud.
object
Código estable, para programar contra él.
Mensaje en español, apto para mostrar a un operador.
Ruta del campo en el JSON, si el error apunta a uno.
Ejemplos
rate_limited
{ "error": { "type": "rate_limited", "code": "rate_limited", "message": "Demasiadas solicitudes. Reintente después de los segundos que indica Retry-After.", "request_id": "req_0192f1a27c3e7d4b9a8f2b6c1d0e4f5a" }}Cabeceras
Sección titulada «Cabeceras»El del cliente si tiene de 1 a 128 caracteres [A-Za-z0-9._-]; si no, uno generado. Es el request_id de los errores.
Solicitudes admitidas en la ventana de un minuto, de la clave o de la IP.
Solicitudes que quedan en la ventana.
Segundos hasta la ventana siguiente.
Segundos que conviene esperar antes de reintentar.
Falla transitoria, como database_unavailable, storage_unavailable o encryption_unavailable. Se reintenta con la misma Idempotency-Key y una espera creciente.
Formato único de los errores de la API.
object
El error principal.
object
Familia del error, como validation_error, conflict o unavailable.
Código estable, para programar contra él.
Mensaje en español, apto para mostrar a un operador. Puede cambiar: no se programa contra él.
Ruta del campo en el JSON, con índices entre corchetes, como items[2].unit_price. Solo cuando el error apunta a un campo.
Identificador de la solicitud, el mismo de X-Request-Id. Inclúyelo al escribir a soporte.
Documento con el que choca la solicitud. Solo en external_id_conflict y document_already_replaced.
Todos los problemas. Solo aparece cuando hay varios.
Uno de los problemas de la solicitud.
object
Código estable, para programar contra él.
Mensaje en español, apto para mostrar a un operador.
Ruta del campo en el JSON, si el error apunta a uno.
Ejemplos
database_unavailable
{ "error": { "type": "unavailable", "code": "database_unavailable", "message": "La base de datos no está disponible. Reintente en unos segundos.", "request_id": "req_0192f1a27c3e7d4b9a8f2b6c1d0e4f5a" }}Cabeceras
Sección titulada «Cabeceras»El del cliente si tiene de 1 a 128 caracteres [A-Za-z0-9._-]; si no, uno generado. Es el request_id de los errores.
Solicitudes admitidas en la ventana de un minuto, de la clave o de la IP.
Solicitudes que quedan en la ventana.
Segundos hasta la ventana siguiente.