Ir al contenido

Lee un documento

GET
/v1/documents/{id}
curl https://api.boletura.com/v1/documents/0192f2c4-7d1e-7a3b-9c4d-5e6f7a8b9c0d \
--header 'Authorization: Bearer bol_test_TU_CLAVE'

El documento completo, con ítems, estados y enlaces.

Requiere el scope documents:read.

id
obligatorio
string format: uuid

UUID del documento. Uno que no existe en el tenant y ambiente de la clave, o que no es un UUID, responde 404 not_found.

Solicitud correcta.

Tipo de contenidoapplication/json

Comprobante electrónico: una boleta, una factura, una nota de crédito o una nota de débito.

object
id
obligatorio

UUID del documento.

string format: uuid
object
obligatorio

Siempre document.

string
environment
obligatorio

Ambiente del documento. Uno de test no se ve con una clave live, ni al revés.

Valores admitidos: test live
company_id
obligatorio

UUID de la empresa emisora.

string format: uuid
type
obligatorio

Tipo de comprobante.

Valores admitidos: factura boleta nota_credito nota_debito
series
obligatorio

Serie, como B001.

string
number
obligatorio

Correlativo dentro de la serie.

integer format: int64
full_number
obligatorio

Serie y correlativo, como B001-125.

string
issue_date
obligatorio

Fecha de emisión, en fecha civil de Lima.

string format: date
currency
obligatorio

Moneda; hoy siempre PEN.

string
customer
obligatorio

Cliente del comprobante.

object
document_type
obligatorio

Tipo de documento del cliente.

Valores admitidos: dni ruc ce pasaporte otros none
document_number
obligatorio

Número de documento; nulo si el cliente no tiene.

null | string
name
obligatorio

Nombre o razón social.

null | string
address
obligatorio

Dirección.

null | string
email
obligatorio

Correo.

null | string
items

Líneas del comprobante. No aparece en el listado.

Array<object> | null

Línea del comprobante, con los importes calculados por la plataforma.

object
line_number
obligatorio

Número de línea, desde 1.

integer format: int32
product_code
obligatorio

Código interno del integrador; nulo si el ítem no lo trajo.

null | string
description
obligatorio

Descripción de la línea.

string
quantity
obligatorio

Cantidad, sin ceros finales.

number
unit
obligatorio

Código de unidad de medida.

string
unit_price
obligatorio

Precio unitario con IGV, sin ceros finales.

number
unit_value
obligatorio

Valor unitario sin IGV, sin ceros finales.

number
tax_affectation
obligatorio

Afectación al IGV.

Valores admitidos: gravado exonerado inafecto
igv_rate
obligatorio

Tasa del IGV en porcentaje, como 18.

number
line_value
obligatorio

Valor de la línea sin IGV, con 2 decimales.

number
igv_amount
obligatorio

IGV de la línea, con 2 decimales.

number
line_total
obligatorio

Total de la línea con IGV, con 2 decimales.

number
totals
obligatorio

Totales calculados por la plataforma.

object
taxable
obligatorio

Total de operaciones gravadas, sin IGV.

number
exempt
obligatorio

Total de operaciones exoneradas.

number
unaffected
obligatorio

Total de operaciones inafectas.

number
discount
obligatorio

Total de descuentos; hoy siempre 0.00.

number
igv
obligatorio

IGV total.

number
total
obligatorio

Importe total con IGV.

number
amount_in_words
obligatorio

Importe total en letras.

string
status
obligatorio

Estado interno.

Valores admitidos: issued void_requested voided expired
sunat_status
obligatorio

Estado fiscal. Es el campo que dice si el documento es válido.

Valores admitidos: pending submitted accepted accepted_with_observations rejected deadline_missed
delivery_status
obligatorio

Estado de la entrega por webhook.

Valores admitidos: none pending delivered failed
sunat
obligatorio

Detalle del envío a SUNAT.

object
response_code
obligatorio

Código de respuesta de SUNAT; nulo hasta que responde.

null | string
description
obligatorio

Descripción de la respuesta de SUNAT; nula hasta que responde.

null | string
notes
obligatorio

Observaciones de SUNAT.

Array<string>
deadline_at
obligatorio

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.

string format: date-time
submitted_at
obligatorio

Envío a SUNAT; nulo si aún no se envió. Timestamp RFC 3339 en UTC, con seis decimales.

null | string format: date-time
accepted_at
obligatorio

Aceptación de SUNAT; nula si aún no se aceptó. Timestamp RFC 3339 en UTC, con seis decimales.

null | string format: date-time
reconciliation_required
obligatorio

true si hay un envío con resultado desconocido y se está recuperando el CDR o el ticket. No reemitas mientras dure.

boolean
hash
obligatorio

Valor de resumen de la firma del XML (DigestValue).

string
qr_text
obligatorio

Texto del QR del comprobante, con sus campos separados por |.

string
qr_image

PNG del QR como data URI. No aparece en el listado.

null | string
links
obligatorio

Enlaces de descarga.

object
pdf
obligatorio

Ruta del PDF.

null | string
xml
obligatorio

Ruta del XML firmado.

null | string
cdr
obligatorio

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.

null | string
affected_document_id
obligatorio

En una nota de crédito o de débito, el documento que afecta; si no, nulo.

null | string format: uuid
credit_note
obligatorio

Motivo de la nota de crédito; nulo en los demás comprobantes.

object
reason_code
obligatorio

Motivo de la nota.

Valores admitidos: anulacion_operacion anulacion_error_ruc correccion_descripcion descuento_global descuento_item devolucion_total devolucion_item bonificacion disminucion_valor otros
reason
obligatorio

Descripción libre del motivo.

string
debit_note
obligatorio

Motivo de la nota de débito; nulo en los demás comprobantes.

object
reason_code
obligatorio

Motivo de la nota.

Valores admitidos: intereses_mora aumento_valor penalidades
reason
obligatorio

Descripción libre del motivo.

string
external_id
obligatorio

Identificador del integrador; nulo si no se envió.

null | string
replaces_document_id
obligatorio

Documento rechazado que este reemplaza; nulo si no reemplaza a ninguno.

null | string format: uuid
metadata
obligatorio

El objeto que envió el integrador; nulo si no envió ninguno.

object | null
created_at
obligatorio

Creación. Timestamp RFC 3339 en UTC, con seis decimales.

string format: date-time
updated_at
obligatorio

Última modificación. Timestamp RFC 3339 en UTC, con seis decimales.

string format: date-time

Ejemplos

EjemploBoleta

Boleta

{
"id": "0192f1a2-7c3e-7d4b-9a8f-2b6c1d0e4f5a",
"object": "document",
"environment": "test",
"company_id": "0192f0b1-2d4c-7a1e-8b3f-1c2d3e4f5a6b",
"type": "boleta",
"series": "B001",
"number": 125,
"full_number": "B001-125",
"issue_date": "2026-10-09",
"currency": "PEN",
"customer": {
"document_type": "dni",
"document_number": "45678912",
"name": "Juan Pérez",
"address": null,
"email": null
},
"items": [
{
"line_number": 1,
"product_code": null,
"description": "Estacionamiento 2 horas",
"quantity": 1,
"unit": "ZZ",
"unit_price": 12,
"unit_value": 10.1694915254,
"tax_affectation": "gravado",
"igv_rate": 18,
"line_value": 10.17,
"igv_amount": 1.83,
"line_total": 12
}
],
"totals": {
"taxable": 10.17,
"exempt": 0,
"unaffected": 0,
"discount": 0,
"igv": 1.83,
"total": 12,
"amount_in_words": "DOCE CON 00/100 SOLES"
},
"status": "issued",
"sunat_status": "pending",
"delivery_status": "none",
"sunat": {
"response_code": null,
"description": null,
"notes": [],
"deadline_at": "2026-10-17T04:59:59.000000Z",
"submitted_at": null,
"accepted_at": null,
"reconciliation_required": false
},
"hash": "2/tssig+2hIBSmZyIT0CWMhsTMnRKmApc0tdWRsDs4U=",
"qr_text": "20100066603|03|B001|125|1.83|12.00|2026-10-09|1|45678912|2/tssig+2hIBSmZyIT0CWMhsTMnRKmApc0tdWRsDs4U=",
"qr_image": "data:image/png;base64,iVBORw0KGgo=",
"links": {
"pdf": "/v1/documents/0192f1a2-7c3e-7d4b-9a8f-2b6c1d0e4f5a/pdf",
"xml": "/v1/documents/0192f1a2-7c3e-7d4b-9a8f-2b6c1d0e4f5a/xml",
"cdr": null
},
"affected_document_id": null,
"credit_note": null,
"debit_note": null,
"external_id": "venta-98231",
"replaces_document_id": null,
"metadata": {
"placa": "ABC-123"
},
"created_at": "2026-10-09T14:03:21.482913Z",
"updated_at": "2026-10-09T14:03:21.482913Z"
}
X-Request-Id
string

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.

RateLimit-Limit
integer

Solicitudes admitidas en la ventana de un minuto, de la clave o de la IP.

RateLimit-Remaining
integer

Solicitudes que quedan en la ventana.

RateLimit-Reset
integer

Segundos hasta la ventana siguiente.

Sin una API key válida. Códigos: unauthorized, invalid_api_key, revoked_api_key, expired_api_key.

Tipo de contenidoapplication/json

Formato único de los errores de la API.

object
error
obligatorio

El error principal.

object
type
obligatorio

Familia del error, como validation_error, conflict o unavailable.

string
code
obligatorio

Código estable, para programar contra él.

string
message
obligatorio

Mensaje en español, apto para mostrar a un operador. Puede cambiar: no se programa contra él.

string
param

Ruta del campo en el JSON, con índices entre corchetes, como items[2].unit_price. Solo cuando el error apunta a un campo.

null | string
request_id
obligatorio

Identificador de la solicitud, el mismo de X-Request-Id. Inclúyelo al escribir a soporte.

string
document_id

Documento con el que choca la solicitud. Solo en external_id_conflict y document_already_replaced.

null | string format: uuid
errors

Todos los problemas. Solo aparece cuando hay varios.

Array<object> | null

Uno de los problemas de la solicitud.

object
code
obligatorio

Código estable, para programar contra él.

string
message
obligatorio

Mensaje en español, apto para mostrar a un operador.

string
param

Ruta del campo en el JSON, si el error apunta a uno.

null | string

Ejemplos

Ejemploinvalid_api_key

invalid_api_key

{
"error": {
"type": "unauthorized",
"code": "invalid_api_key",
"message": "La API key no es válida.",
"request_id": "req_0192f1a27c3e7d4b9a8f2b6c1d0e4f5a"
}
}
X-Request-Id
string

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.

RateLimit-Limit
integer

Solicitudes admitidas en la ventana de un minuto, de la clave o de la IP.

RateLimit-Remaining
integer

Solicitudes que quedan en la ventana.

RateLimit-Reset
integer

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ó).

Tipo de contenidoapplication/json

Formato único de los errores de la API.

object
error
obligatorio

El error principal.

object
type
obligatorio

Familia del error, como validation_error, conflict o unavailable.

string
code
obligatorio

Código estable, para programar contra él.

string
message
obligatorio

Mensaje en español, apto para mostrar a un operador. Puede cambiar: no se programa contra él.

string
param

Ruta del campo en el JSON, con índices entre corchetes, como items[2].unit_price. Solo cuando el error apunta a un campo.

null | string
request_id
obligatorio

Identificador de la solicitud, el mismo de X-Request-Id. Inclúyelo al escribir a soporte.

string
document_id

Documento con el que choca la solicitud. Solo en external_id_conflict y document_already_replaced.

null | string format: uuid
errors

Todos los problemas. Solo aparece cuando hay varios.

Array<object> | null

Uno de los problemas de la solicitud.

object
code
obligatorio

Código estable, para programar contra él.

string
message
obligatorio

Mensaje en español, apto para mostrar a un operador.

string
param

Ruta del campo en el JSON, si el error apunta a uno.

null | string

Ejemplos

Ejemploforbidden

forbidden

{
"error": {
"type": "forbidden",
"code": "forbidden",
"message": "La API key no tiene el scope documents:read que exige este endpoint.",
"request_id": "req_0192f1a27c3e7d4b9a8f2b6c1d0e4f5a"
}
}
X-Request-Id
string

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.

RateLimit-Limit
integer

Solicitudes admitidas en la ventana de un minuto, de la clave o de la IP.

RateLimit-Remaining
integer

Solicitudes que quedan en la ventana.

RateLimit-Reset
integer

Segundos hasta la ventana siguiente.

not_found: no existe en el tenant y ambiente de la clave.

Tipo de contenidoapplication/json

Formato único de los errores de la API.

object
error
obligatorio

El error principal.

object
type
obligatorio

Familia del error, como validation_error, conflict o unavailable.

string
code
obligatorio

Código estable, para programar contra él.

string
message
obligatorio

Mensaje en español, apto para mostrar a un operador. Puede cambiar: no se programa contra él.

string
param

Ruta del campo en el JSON, con índices entre corchetes, como items[2].unit_price. Solo cuando el error apunta a un campo.

null | string
request_id
obligatorio

Identificador de la solicitud, el mismo de X-Request-Id. Inclúyelo al escribir a soporte.

string
document_id

Documento con el que choca la solicitud. Solo en external_id_conflict y document_already_replaced.

null | string format: uuid
errors

Todos los problemas. Solo aparece cuando hay varios.

Array<object> | null

Uno de los problemas de la solicitud.

object
code
obligatorio

Código estable, para programar contra él.

string
message
obligatorio

Mensaje en español, apto para mostrar a un operador.

string
param

Ruta del campo en el JSON, si el error apunta a uno.

null | string

Ejemplos

Ejemplonot_found

not_found

{
"error": {
"type": "not_found",
"code": "not_found",
"message": "El documento no existe.",
"request_id": "req_0192f1a27c3e7d4b9a8f2b6c1d0e4f5a"
}
}
X-Request-Id
string

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.

RateLimit-Limit
integer

Solicitudes admitidas en la ventana de un minuto, de la clave o de la IP.

RateLimit-Remaining
integer

Solicitudes que quedan en la ventana.

RateLimit-Reset
integer

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.

Tipo de contenidoapplication/json

Formato único de los errores de la API.

object
error
obligatorio

El error principal.

object
type
obligatorio

Familia del error, como validation_error, conflict o unavailable.

string
code
obligatorio

Código estable, para programar contra él.

string
message
obligatorio

Mensaje en español, apto para mostrar a un operador. Puede cambiar: no se programa contra él.

string
param

Ruta del campo en el JSON, con índices entre corchetes, como items[2].unit_price. Solo cuando el error apunta a un campo.

null | string
request_id
obligatorio

Identificador de la solicitud, el mismo de X-Request-Id. Inclúyelo al escribir a soporte.

string
document_id

Documento con el que choca la solicitud. Solo en external_id_conflict y document_already_replaced.

null | string format: uuid
errors

Todos los problemas. Solo aparece cuando hay varios.

Array<object> | null

Uno de los problemas de la solicitud.

object
code
obligatorio

Código estable, para programar contra él.

string
message
obligatorio

Mensaje en español, apto para mostrar a un operador.

string
param

Ruta del campo en el JSON, si el error apunta a uno.

null | string

Ejemplos

Ejemplorate_limited

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"
}
}
X-Request-Id
string

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.

RateLimit-Limit
integer

Solicitudes admitidas en la ventana de un minuto, de la clave o de la IP.

RateLimit-Remaining
integer

Solicitudes que quedan en la ventana.

RateLimit-Reset
integer

Segundos hasta la ventana siguiente.

Retry-After
integer

Segundos que conviene esperar antes de reintentar.

Falla transitoria, como database_unavailable o storage_unavailable. Se reintenta con una espera creciente.

Tipo de contenidoapplication/json

Formato único de los errores de la API.

object
error
obligatorio

El error principal.

object
type
obligatorio

Familia del error, como validation_error, conflict o unavailable.

string
code
obligatorio

Código estable, para programar contra él.

string
message
obligatorio

Mensaje en español, apto para mostrar a un operador. Puede cambiar: no se programa contra él.

string
param

Ruta del campo en el JSON, con índices entre corchetes, como items[2].unit_price. Solo cuando el error apunta a un campo.

null | string
request_id
obligatorio

Identificador de la solicitud, el mismo de X-Request-Id. Inclúyelo al escribir a soporte.

string
document_id

Documento con el que choca la solicitud. Solo en external_id_conflict y document_already_replaced.

null | string format: uuid
errors

Todos los problemas. Solo aparece cuando hay varios.

Array<object> | null

Uno de los problemas de la solicitud.

object
code
obligatorio

Código estable, para programar contra él.

string
message
obligatorio

Mensaje en español, apto para mostrar a un operador.

string
param

Ruta del campo en el JSON, si el error apunta a uno.

null | string

Ejemplos

Ejemplodatabase_unavailable

database_unavailable

{
"error": {
"type": "unavailable",
"code": "database_unavailable",
"message": "La base de datos no está disponible. Reintente en unos segundos.",
"request_id": "req_0192f1a27c3e7d4b9a8f2b6c1d0e4f5a"
}
}
X-Request-Id
string

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.

RateLimit-Limit
integer

Solicitudes admitidas en la ventana de un minuto, de la clave o de la IP.

RateLimit-Remaining
integer

Solicitudes que quedan en la ventana.

RateLimit-Reset
integer

Segundos hasta la ventana siguiente.