Datos de inicio (empresa, series, cobros)
GET /api/company
Autenticación: Bearer del usuario del tenant (Authorization: Bearer <api_token>).
Datos para iniciar una caja o app de ventas: series del usuario, su establecimiento, datos de la empresa, hasta 2000 clientes habilitados (formato API de comprobantes), métodos de pago que se pueden usar para cobrar y destinos del dinero (caja y cuentas que reciben cobros).
Quién puede usarlo: cualquier usuario autenticado (administrador o vendedor).
Formato de respuesta: heredado sin envoltura: devuelve directamente el objeto o arreglo (sin success).
Reglas:
- Para buscar clientes usa Buscar clientes (formato API de comprobantes) en lugar de la lista inicial.
- En cada método de pago,
goes_to_cash_draweryallowed_destination_typeindican a qué destino debe ir el cobro.
Datos de la empresa: el objeto company trae los datos públicos de la empresa (id, RUC number, razón social name, trade_name, logo, tipo de documento, entorno soap_type_id...). No incluye credenciales SOL/OSE/PSE, certificado, claves de API ni tokens; la configuración SUNAT (sin secretos) se consulta en Ver configuración SUNAT (GET /api/company/sunat-config, solo administradores).
Respuestas
200 — Datos
{
"series": [
{
"id": 1,
"document_type_id": "01",
"number": "F001",
"establishment_id": 1
}
],
"establishments": [
{
"id": 1,
"description": "Oficina Principal",
"country_id": "PE",
"department_id": "15",
"province_id": "1501",
"district_id": "150101",
"address": "AV. PRINCIPAL 123",
"email": "ventas@miempresa.pe",
"telephone": "014567890",
"code": "0000",
"customer_id": null
}
],
"company": {
"id": 1,
"identity_document_type_id": "6",
"number": "20123456789",
"name": "MI EMPRESA S.A.C.",
"trade_name": "MI EMPRESA",
"logo": "logo_20123456789.png"
},
"customers": [
{
"id": 25,
"codigo_tipo_documento_identidad": "6",
"numero_documento": "20601234567",
"apellidos_y_nombres_o_razon_social": "COMERCIAL NORTE E.I.R.L.",
"codigo_pais": "PE",
"direccion": "AV. PRINCIPAL 123, LIMA",
"correo_electronico": "compras@comercialnorte.pe",
"telefono": "987654321"
}
],
"payment_method_types": [
{
"id": "01",
"description": "Efectivo",
"goes_to_cash_drawer": true,
"allowed_destination_type": "cash"
},
{
"id": "05",
"description": "Yape",
"goes_to_cash_drawer": false,
"allowed_destination_type": "bank_account"
}
],
"payment_destinations": [
{
"id": "cash",
"description": "CAJA GENERAL"
},
{
"id": 2,
"description": "BCP - Cta. corriente 191-1234567-0-12"
}
]
}
Pruébalo
Prueba este endpoint con tu empresa y tu token: elige la URL en Servers, pega el token en Authorize y haz clic en Try it out.