Catálogos: antes de empezar
Quién puede usarlo: cualquier usuario autenticado (administrador o vendedor).
Catálogos de solo lectura con los códigos que aceptan los campos *_id de comprobantes, pagos, guías de remisión, productos, clientes e inventario. Consúltalos al configurar la integración (y de vez en cuando para refrescarlos) en lugar de escribir los códigos fijos en tu sistema: cada empresa activa los que usa.
- Todos responden
{success: true, data: [{id, description, ...}]}sin paginación. - Por defecto solo vienen los registros activos de la empresa;
all=1incluye los inactivos (cada fila traeactive). - Los códigos SUNAT (
id) son texto: respeta los ceros a la izquierda (01,0101,150101). - El ubigeo se consulta por niveles: departamentos → provincias (
department_id) → distritos (province_id).
Formato de respuesta: estándar {success, data, message?} (registro único). Aquí data es la lista completa (sin paginación ni pagination): son catálogos cortos.
Qué catálogo usar en qué campo (el nombre del campo en la API CRUD/JSON en inglés · y en el JSON en español de la API de comprobantes y guías):
| Dato | Campo | Catálogo |
|---|---|---|
| Tipo de comprobante | document_type_id · codigo_tipo_documento |
catalogs/document-types |
| Tipo de documento de identidad (cliente, proveedor, conductor) | identity_document_type_id · codigo_tipo_documento_identidad |
catalogs/identity-document-types |
| Afectación del IGV del ítem / producto | affectation_igv_type_id, sale_affectation_igv_type_id, purchase_affectation_igv_type_id · codigo_tipo_afectacion_igv |
catalogs/affectation-igv-types |
| Tipo de operación | operation_type_id · codigo_tipo_operacion |
catalogs/operation-types |
| Motivo de nota de crédito | note_credit_or_debit_type_id · codigo_tipo_nota (comprobante 07) |
catalogs/credit-note-types |
| Motivo de nota de débito | note_credit_or_debit_type_id · codigo_tipo_nota (comprobante 08) |
catalogs/debit-note-types |
| Tipo de precio del ítem | price_type_id · codigo_tipo_precio |
catalogs/price-types |
| Sistema de cálculo del ISC | system_isc_type_id · codigo_tipo_sistema_isc |
catalogs/system-isc-types |
| Cargos y descuentos | charge_type_id, discount_type_id · cargos[].codigo, descuentos[].codigo |
catalogs/charge-discount-types |
| Moneda | currency_type_id · codigo_tipo_moneda |
catalogs/currency-types |
| Unidad de medida | unit_type_id · unidad_de_medida |
catalogs/unit-types |
| Atributos adicionales del ítem | attribute_type_id · items[].datos_adicionales[].codigo |
catalogs/attribute-types |
| Estado del comprobante (filtros de listados) | state_type_id |
catalogs/state-types |
| Bien o servicio sujeto a detracción | detraction.detraction_type_id · detraccion.codigo_tipo_detraccion |
catalogs/detraction-types |
| Medio de pago de la detracción | detraction.payment_method_id · detraccion.codigo_metodo_pago |
catalogs/detraction-payment-methods |
| Régimen de retención | retention_type_id · codigo_tipo_retencion |
catalogs/retention-types |
| Régimen de percepción | perception_type_id · codigo_tipo_percepcion |
catalogs/perception-types |
| Método de pago de un cobro o pago | payment_method_type_id · pagos[].codigo_metodo_pago, cuotas[].codigo_metodo_de_pago |
catalogs/payment-method-types |
| Destino del dinero (caja o cuenta) | payment_destination_id · pagos[].codigo_destino_pago |
catalogs/payment-destinations |
| Condición de pago | payment_condition_id · codigo_condicion_de_pago |
catalogs/payment-conditions |
| Banco de una cuenta bancaria | bank_id |
catalogs/banks |
| Marca de tarjeta del pago | card_brand_id |
catalogs/card-brands |
| Motivo de traslado (guía) | transfer_reason_type_id · codigo_motivo_traslado |
catalogs/transfer-reason-types |
| Modalidad de transporte (guía) | transport_mode_type_id · codigo_modo_transporte |
catalogs/transport-mode-types |
| Documento relacionado de la guía | related.document_type_id · documento_relacionado[].documento |
catalogs/related-document-types |
| País | country_id · codigo_pais |
catalogs/countries |
| Departamento | department_id |
catalogs/departments |
| Provincia | province_id |
catalogs/provinces?department_id= |
| Distrito / ubigeo | district_id, location_id · ubigeo |
catalogs/districts?province_id= |
| Tipo de cliente | person_type_id |
catalogs/person-types |
| Etiqueta de precio (lista de precios) | price_label_id |
catalogs/price-labels |
| Motivo de ajuste de inventario | inventory_transaction_id |
catalogs/inventory-transactions |