Referencia de endpoints
Esta referencia se genera automáticamente desde openapi.json. No editar manualmente.
Endpoints
Sección titulada «Endpoints»| Método | Ruta | Cuerpo | Respuesta |
|---|---|---|---|
| POST | /api/v1/credit-note/create | CreditNoteCreateRequest | CreateResponse |
| POST | /api/v1/debit-note/create | DebitNoteCreateRequest | CreateResponse |
| POST | /api/v1/invoice/create | InvoiceCreateRequest | CreateResponse |
| POST | /api/v1/perception/create | PerceptionCreateRequest | CreateResponse |
| POST | /api/v1/retention/create | RetentionCreateRequest | CreateResponse |
| POST | /api/v1/sign | — | SignedXmlResponse |
| POST | /api/v1/summary-documents/create | SummaryDocumentsCreateRequest | CreateResponse |
| GET | /api/v1/version | — | — |
| POST | /api/v1/voided-documents/create | VoidedDocumentsCreateRequest | CreateResponse |
Modelos
Sección titulada «Modelos»Address
Sección titulada «Address»Dirección según esquema UBL 2.1 de SUNAT.
| Propiedad | Tipo | Requerido | Constraints |
|---|---|---|---|
codigoPais | string | No | default: PE |
departamento | union | No | — |
direccion | union | No | — |
distrito | union | No | — |
provincia | union | No | — |
ubigeo | union | No | — |
urbanizacion | union | No | — |
Catalog1
Sección titulada «Catalog1»Tipo de Comprobante - Catálogo N.° 01
| Propiedad | Tipo | Requerido | Constraints |
|---|---|---|---|
| Valores | enum | — | 01, 03, 07, 08, 09, 20, 40 |
Catalog19
Sección titulada «Catalog19»Tipo de Operación - Resumen Diario - Catálogo N.° 19
| Propiedad | Tipo | Requerido | Constraints |
|---|---|---|---|
| Valores | enum | — | 1, 2, 3 |
Catalog2
Sección titulada «Catalog2»Tipo de Moneda - Catálogo N.° 02
| Propiedad | Tipo | Requerido | Constraints |
|---|---|---|---|
| Valores | enum | — | PEN, USD, EUR |
Catalog22
Sección titulada «Catalog22»Régimen de Percepción - Catálogo N.° 22
| Propiedad | Tipo | Requerido | Constraints |
|---|---|---|---|
| Valores | enum | — | 01, 02, 03 |
Catalog23
Sección titulada «Catalog23»Régimen de Retención - Catálogo N.° 23
| Propiedad | Tipo | Requerido | Constraints |
|---|---|---|---|
| Valores | enum | — | 01, 02, 03 |
Catalog51
Sección titulada «Catalog51»Tipo de Operación - Catálogo N.° 51
| Propiedad | Tipo | Requerido | Constraints |
|---|---|---|---|
| Valores | enum | — | 0101, 0102, 0103, 0104, 0105, 0106, 0107, 0108, 0110, 0200, 0201, 0202, 0203, 0204, 0205, 0206, 0207 |
Catalog6
Sección titulada «Catalog6»Tipo de Documento de Identidad - Catálogo N.° 06
| Propiedad | Tipo | Requerido | Constraints |
|---|---|---|---|
| Valores | enum | — | 0, 1, 4, 6, 7 |
Catalog7
Sección titulada «Catalog7»Tipo de Afectación del IGV - Catálogo N.° 07
| Propiedad | Tipo | Requerido | Constraints |
|---|---|---|---|
| Valores | enum | — | 10, 20, 30 |
Cliente
Sección titulada «Cliente»Datos del adquirente o usuario.
RS N° 300-2014/SUNAT, Anexo 1:
- Tipo de documento: Catálogo N.° 06
- Número de documento: según tipo
| Propiedad | Tipo | Requerido | Constraints |
|---|---|---|---|
nombre | string | Sí | — |
numeroDocumentoIdentidad | string | Sí | pattern; min 1 |
tipoDocumentoIdentidad | Catalog6 | Sí | — |
Comprobante
Sección titulada «Comprobante»Comprobante dentro del resumen diario.
| Propiedad | Tipo | Requerido | Constraints |
|---|---|---|---|
cliente | Cliente | Sí | — |
comprobanteAfectado | union | No | — |
impuestos | ComprobanteImpuestos | Sí | — |
serieNumero | string | Sí | — |
tipoComprobante | Catalog1 | Sí | — |
valorVenta | ComprobanteValorVenta | Sí | — |
ComprobanteImpuestos
Sección titulada «ComprobanteImpuestos»Impuestos del comprobante resumido.
| Propiedad | Tipo | Requerido | Constraints |
|---|---|---|---|
icb | union | No | — |
igv | union | Sí | — |
ComprobanteValorVenta
Sección titulada «ComprobanteValorVenta»Valores de venta del comprobante resumido.
| Propiedad | Tipo | Requerido | Constraints |
|---|---|---|---|
exonerado | union | No | — |
gravado | union | No | — |
importeTotal | union | Sí | — |
inafecto | union | No | — |
CreateResponse
Sección titulada «CreateResponse»Respuesta unificada de los endpoints /create.
| Propiedad | Tipo | Requerido | Constraints |
|---|---|---|---|
errors | union | No | — |
firmado | boolean | Sí | — |
valid | union | No | — |
validado_sunat | boolean | Sí | — |
xml | string | Sí | — |
Credentials
Sección titulada «Credentials»Credenciales para firma digital.
| Propiedad | Tipo | Requerido | Constraints |
|---|---|---|---|
cert_pem | union | No | — |
key_pem | union | No | — |
pfx_base64 | union | No | — |
pfx_password | union | No | — |
CreditNote
Sección titulada «CreditNote»Nota de Crédito Electrónica - Tipo 07.
RS N° 300-2014/SUNAT, Anexo 1:
- Serie: debe iniciar con B/C o F/E según tipo de documento afectado
- Debe referenciar el comprobante afectado
| Propiedad | Tipo | Requerido | Constraints |
|---|---|---|---|
cliente | Cliente | Sí | — |
comprobanteAfectadoSerieNumero | string | Sí | — |
detalles | array | Sí | — |
fechaEmision | union | No | — |
igvTotal | union | No | — |
importeTotal | union | No | — |
moneda | Catalog2 | No | default: PEN |
numero | integer | Sí | ≥ 1.0 |
proveedor | Proveedor | Sí | — |
serie | string | Sí | — |
sustentoDescripcion | string | Sí | — |
valorVentaTotal | union | No | — |
CreditNoteCreateRequest
Sección titulada «CreditNoteCreateRequest»Request para crear una nota de crédito.
| Propiedad | Tipo | Requerido | Constraints |
|---|---|---|---|
credenciales | union | No | — |
documento | CreditNote | Sí | — |
firmar | boolean | No | default: False |
signature_id | string | No | default: SignSUNAT |
validar_sunat | boolean | No | default: True |
DebitNote
Sección titulada «DebitNote»Nota de Débito Electrónica - Tipo 08.
RS N° 300-2014/SUNAT, Anexo 1:
- Serie: debe iniciar con B/C o F/E según tipo de documento afectado
- Debe referenciar el comprobante afectado
| Propiedad | Tipo | Requerido | Constraints |
|---|---|---|---|
cliente | Cliente | Sí | — |
comprobanteAfectadoSerieNumero | string | Sí | — |
detalles | array | Sí | — |
fechaEmision | union | No | — |
igvTotal | union | No | — |
importeTotal | union | No | — |
moneda | Catalog2 | No | default: PEN |
numero | integer | Sí | ≥ 1.0 |
proveedor | Proveedor | Sí | — |
serie | string | Sí | — |
sustentoDescripcion | string | Sí | — |
valorVentaTotal | union | No | — |
DebitNoteCreateRequest
Sección titulada «DebitNoteCreateRequest»Request para crear una nota de débito.
| Propiedad | Tipo | Requerido | Constraints |
|---|---|---|---|
credenciales | union | No | — |
documento | DebitNote | Sí | — |
firmar | boolean | No | default: False |
signature_id | string | No | default: SignSUNAT |
validar_sunat | boolean | No | default: True |
DocumentoVentaDetalle
Sección titulada «DocumentoVentaDetalle»Línea de detalle de un documento de venta.
RS N° 300-2014/SUNAT, Anexo 1:
- Descripción del bien o servicio
- Cantidad y unidad de medida (Catálogo N.° 03)
- Valor unitario (sin IGV)
- Tipo de afectación del IGV (Catálogo N.° 07)
| Propiedad | Tipo | Requerido | Constraints |
|---|---|---|---|
cantidad | union | Sí | — |
descripcion | string | Sí | — |
igv | union | No | — |
precio | union | Sí | — |
precioVenta | union | No | — |
tipoAfectacionIGV | Catalog7 | No | default: 10 |
unidadMedida | string | No | default: NIU |
valorVenta | union | No | — |
HTTPValidationError
Sección titulada «HTTPValidationError»| Propiedad | Tipo | Requerido | Constraints |
|---|---|---|---|
detail | array | No | — |
Invoice
Sección titulada «Invoice»Factura Electrónica - Tipo 01.
RS N° 300-2014/SUNAT, Anexo 1:
- Serie: debe iniciar con F (factura) o B (boleta)
- Número: correlativo
- Tipo de operación: Catálogo N.° 51, default 0101 (Venta interna)
| Propiedad | Tipo | Requerido | Constraints |
|---|---|---|---|
cliente | Cliente | Sí | — |
detalles | array | Sí | — |
fechaEmision | union | No | — |
igvTotal | union | No | — |
importeTotal | union | No | — |
moneda | Catalog2 | No | default: PEN |
numero | integer | Sí | ≥ 1.0 |
proveedor | Proveedor | Sí | — |
serie | string | Sí | min 1 |
tipoOperacion | Catalog51 | No | default: 0101 |
valorVentaTotal | union | No | — |
InvoiceCreateRequest
Sección titulada «InvoiceCreateRequest»Request para crear una factura.
| Propiedad | Tipo | Requerido | Constraints |
|---|---|---|---|
credenciales | union | No | — |
documento | Invoice | Sí | — |
firmar | boolean | No | default: False |
signature_id | string | No | default: SignSUNAT |
validar_sunat | boolean | No | default: True |
PercepcionRetencionOperacion
Sección titulada «PercepcionRetencionOperacion»Operación de percepción.
| Propiedad | Tipo | Requerido | Constraints |
|---|---|---|---|
comprobante | openubl__models__perception__ComprobanteAfectado | Sí | — |
fechaOperacion | string | Sí | — |
importeOperacion | union | Sí | — |
numeroOperacion | integer | Sí | — |
Perception
Sección titulada «Perception»Comprobante de Percepción Electrónico - Tipo 40.
RS N° 274-2015/SUNAT, Anexo 1:
- Serie: P### (P001, P002, etc.)
- Régimen: Catálogo N.° 22
| Propiedad | Tipo | Requerido | Constraints |
|---|---|---|---|
cliente | Cliente | Sí | — |
fechaEmision | string | Sí | — |
importeTotalCobrado | union | Sí | — |
importeTotalPercibido | union | Sí | — |
numero | integer | Sí | ≥ 1.0 |
operaciones | array | Sí | — |
proveedor | Proveedor | Sí | — |
serie | string | Sí | pattern |
tipoRegimen | Catalog22 | Sí | — |
tipoRegimenPorcentaje | union | Sí | — |
PerceptionCreateRequest
Sección titulada «PerceptionCreateRequest»Request para crear una percepción.
| Propiedad | Tipo | Requerido | Constraints |
|---|---|---|---|
credenciales | union | No | — |
documento | Perception | Sí | — |
firmar | boolean | No | default: False |
signature_id | string | No | default: SignSUNAT |
validar_sunat | boolean | No | default: True |
Proveedor
Sección titulada «Proveedor»Datos del emisor del comprobante.
RS N° 300-2014/SUNAT, Anexo 1:
- RUC del emisor: 11 dígitos numéricos (Catálogo N.° 06, valor 6)
- Razón social: obligatoria
| Propiedad | Tipo | Requerido | Constraints |
|---|---|---|---|
address | union | No | — |
nombreComercial | union | No | — |
razonSocial | string | Sí | — |
ruc | string | Sí | pattern; min 11; max 11 |
Retention
Sección titulada «Retention»Comprobante de Retención Electrónico - Tipo 20.
RS N° 274-2015/SUNAT, Anexo 1:
- Serie: R### (R001, R002, etc.)
- Régimen: Catálogo N.° 23
| Propiedad | Tipo | Requerido | Constraints |
|---|---|---|---|
cliente | Cliente | Sí | — |
fechaEmision | string | Sí | — |
importeTotalPagado | union | Sí | — |
importeTotalRetenido | union | Sí | — |
numero | integer | Sí | ≥ 1.0 |
operaciones | array | Sí | — |
proveedor | Proveedor | Sí | — |
serie | string | Sí | pattern |
tipoRegimen | Catalog23 | Sí | — |
tipoRegimenPorcentaje | union | Sí | — |
RetentionCreateRequest
Sección titulada «RetentionCreateRequest»Request para crear una retención.
| Propiedad | Tipo | Requerido | Constraints |
|---|---|---|---|
credenciales | union | No | — |
documento | Retention | Sí | — |
firmar | boolean | No | default: False |
signature_id | string | No | default: SignSUNAT |
validar_sunat | boolean | No | default: True |
SignedXmlResponse
Sección titulada «SignedXmlResponse»Response containing signed XML document.
| Propiedad | Tipo | Requerido | Constraints |
|---|---|---|---|
signed_xml | string | Sí | — |
SummaryDocuments
Sección titulada «SummaryDocuments»Resumen Diario - RC.
RS N° 300-2014/SUNAT, Anexo 1:
- Identificador: RC-YYYYMMDD-NNNN
- Fecha de emisión de los comprobantes resumidos
| Propiedad | Tipo | Requerido | Constraints |
|---|---|---|---|
comprobantes | array | Sí | — |
fechaEmisionComprobantes | string | Sí | — |
numero | integer | Sí | — |
proveedor | Proveedor | Sí | — |
SummaryDocumentsCreateRequest
Sección titulada «SummaryDocumentsCreateRequest»Request para crear un resumen diario.
| Propiedad | Tipo | Requerido | Constraints |
|---|---|---|---|
credenciales | union | No | — |
documento | SummaryDocuments | Sí | — |
firmar | boolean | No | default: False |
signature_id | string | No | default: SignSUNAT |
validar_sunat | boolean | No | default: True |
SummaryDocumentsItem
Sección titulada «SummaryDocumentsItem»Item del resumen diario.
RS N° 300-2014/SUNAT, Anexo 1:
- Tipo de operación: Catálogo N.° 19 (ADICIONAR, MODIFICAR, ANULADO)
| Propiedad | Tipo | Requerido | Constraints |
|---|---|---|---|
comprobante | Comprobante | Sí | — |
tipoOperacion | Catalog19 | Sí | — |
ValidationError
Sección titulada «ValidationError»| Propiedad | Tipo | Requerido | Constraints |
|---|---|---|---|
ctx | object | No | — |
input | — | No | — |
loc | array | Sí | — |
msg | string | Sí | — |
type | string | Sí | — |
VoidedDocuments
Sección titulada «VoidedDocuments»Comunicación de Baja - RA.
RS N° 300-2014/SUNAT, Anexo 1:
- Identificador: RA-YYYYMMDD-NNNN
- Fecha de emisión de los comprobantes que se dan de baja
| Propiedad | Tipo | Requerido | Constraints |
|---|---|---|---|
comprobantes | array | Sí | — |
fechaEmision | union | No | — |
fechaEmisionComprobantes | string | Sí | — |
numero | integer | Sí | ≥ 1.0 |
proveedor | Proveedor | Sí | — |
VoidedDocumentsCreateRequest
Sección titulada «VoidedDocumentsCreateRequest»Request para crear una comunicación de baja.
| Propiedad | Tipo | Requerido | Constraints |
|---|---|---|---|
credenciales | union | No | — |
documento | VoidedDocuments | Sí | — |
firmar | boolean | No | default: False |
signature_id | string | No | default: SignSUNAT |
validar_sunat | boolean | No | default: True |
VoidedDocumentsItem
Sección titulada «VoidedDocumentsItem»Item de comunicación de baja.
RS N° 300-2014/SUNAT, Anexo 1:
- Tipo de comprobante: Catálogo N.° 01
- Serie y número del comprobante a dar de baja
| Propiedad | Tipo | Requerido | Constraints |
|---|---|---|---|
descripcionSustento | string | Sí | — |
numero | integer | Sí | ≥ 1.0 |
serie | string | Sí | — |
tipoComprobante | Catalog1 | Sí | — |
openubl__models__perception__ComprobanteAfectado
Sección titulada «openubl__models__perception__ComprobanteAfectado»Comprobante afectado por la percepción.
| Propiedad | Tipo | Requerido | Constraints |
|---|---|---|---|
fechaEmision | string | Sí | — |
importeTotal | union | Sí | — |
moneda | Catalog2 | Sí | — |
serieNumero | string | Sí | — |
tipoComprobante | string | Sí | — |
openubl__models__summary__ComprobanteAfectado
Sección titulada «openubl__models__summary__ComprobanteAfectado»Comprobante afectado para notas.
| Propiedad | Tipo | Requerido | Constraints |
|---|---|---|---|
fechaEmision | string | Sí | — |
importeTotal | union | Sí | — |
moneda | string | Sí | — |
serieNumero | string | Sí | — |
tipoComprobante | Catalog1 | Sí | — |