Esta página se genera desde el contrato (data/gateway-v1.json): cada operación muestra su verbo, ruta, parámetros, cuerpo, respuestas, si lleva Idempotency-Key y el método equivalente en los cinco SDK. Para el flujo de punta a punta con ejemplos completos, ve a la guía de implementación.

Operaciones del tag admin #

Descripción en el contrato: Módulo Administrativo / ERP de la entidad: talento humano (colaboradores, contratos, novedades), nómina (novedades, periodos, desprendibles, nómina electrónica), contabilidad (comprobantes en borrador, terceros, impuestos) y tesorería (recaudos, egresos, cartera y extractos en borrador). Por API no se aprueba, liquida ni contabiliza: eso se hace en el panel.

MétodoRutaOperaciónScopeIdem.
GET/v1/gateway/admin/accounting/entries/Comprobantes contablesaccounting:read—
POST/v1/gateway/admin/accounting/entries/Crear un comprobante contable en BORRADORaccounting:writerecomendada
GET/v1/gateway/admin/accounting/entries/{entry_id}/Comprobante con sus líneasaccounting:read—
POST/v1/gateway/admin/accounting/taxes/compute/Simular impuestos y retencionesaccounting:read—
GET/v1/gateway/admin/accounting/third-parties/Buscar tercerosaccounting:read—
POST/v1/gateway/admin/accounting/third-parties/Alta o actualización de un terceroaccounting:writerecomendada
GET/v1/gateway/admin/accounting/third-parties/{third_party}/Tercero (por id o documento)accounting:read—
GET/v1/gateway/admin/hr/employees/Buscar colaboradoreshr:read—
POST/v1/gateway/admin/hr/employees/Alta o actualización de un colaborador (upsert por documento)hr:writerecomendada
GET/v1/gateway/admin/hr/employees/{employee}/Ficha de un colaboradorhr:read—
GET/v1/gateway/admin/hr/employees/{employee}/contracts/Contratos de un colaboradorhr:read—
GET/v1/gateway/admin/hr/novelties/Novedades de talento humanohr:read—
POST/v1/gateway/admin/hr/novelties/Registrar incapacidad, licencia, permiso o vacacioneshr:writerecomendada
GET/v1/gateway/admin/payroll/electronic/Estado de la nómina electrónica (DIAN) de un mespayroll:read—
GET/v1/gateway/admin/payroll/novelties/Novedades de nóminapayroll:read—
POST/v1/gateway/admin/payroll/novelties/Cargar novedades de nómina (una o un lote)payroll:writerecomendada
GET/v1/gateway/admin/payroll/payslips/{payslip_id}/Desprendible con sus conceptospayroll:read—
GET/v1/gateway/admin/payroll/periods/Periodos de nóminapayroll:read—
GET/v1/gateway/admin/payroll/periods/{period_id}/Detalle de un periodopayroll:read—
GET/v1/gateway/admin/payroll/periods/{period_id}/payslips/Desprendibles de un periodopayroll:read—
POST/v1/gateway/admin/treasury/payments/Registrar un egreso en BORRADORtreasury:writerecomendada
POST/v1/gateway/admin/treasury/receipts/Registrar un recaudo en BORRADORtreasury:writerecomendada
POST/v1/gateway/admin/treasury/receivables/Registrar una cuenta de cobro en BORRADORtreasury:writerecomendada
POST/v1/gateway/admin/treasury/statements/Cargar un extracto bancario para conciliacióntreasury:writerecomendada
POST/v1/gateway/admin/treasury/statements/{statement_id}/auto-match/Cruce automático del extractotreasury:writerecomendada

Comprobantes contables #

GET/v1/gateway/admin/accounting/entries/

  • operationId adminListEntries
  • Autenticación X-API-Key · scope accounting:read
  • Idempotency-Key no aplica

Parámetros

NombreEnTipoDescripción
statusquerystringDRAFT | POSTED | VOID
voucher_typequerystringTipo (CC…).
date_fromquerystringDesde.
date_toquerystringHasta.
external_idquerystringId del ERP.
sourcequerystringgateway = solo los creados por API.
qquerystringTexto o número.
offsetquerystringDesplazamiento (páginas de 100).

Respuestas

CódigoDescripciónCuerpo
200Lista.AdminResultList application/json
Errores posibles (400, 401, 403, 404, 409, 422, 429, 500, 502, 504) — application/problem+json
400Malformed request.about:blank
401Missing or invalid API key.about:blank
403The key is valid but lacks the required scope, or the source IP is not allow-listed.about:blank
404The requested resource does not exist.about:blank
409Idempotency conflict — same key, original still processing.https://errors.compense.co/gateway/idempotency-conflict
422Request body failed validation.https://errors.compense.co/gateway/validation
429Per-key rate limit or monthly quota exceeded; see Retry-After.https://errors.compense.co/gateway/rate-limited
500Unexpected gateway error; quote the trace_id to support.about:blank
502The processing engine returned an error.https://errors.compense.co/gateway/upstream-error
504The processing engine did not respond in time.https://errors.compense.co/gateway/upstream-error

Ver Errores problem+json para la excepción equivalente en cada SDK.

Ejemplo

Método del SDK y petición HTTP
client.admin.accounting.list_entries()

Los métodos de cada SDK salen de su suite de paridad con el contrato. El cURL va contra el sandbox; los valores <campo> son marcadores.

Crear un comprobante contable en BORRADOR #

POST/v1/gateway/admin/accounting/entries/

  • operationId adminCreateEntry
  • Autenticación X-API-Key · scope accounting:write
  • Idempotency-Key recomendada (el SDK la genera)
Idempotente por external_id: el mismo id devuelve el comprobante existente (created: false).

Parámetros

NombreEnTipoDescripción
Idempotency-KeycabecerastringClient-generated key that makes a write safely retryable. Replaying the same key returns the original result with idempotent_replay: true; a replay while the original is still in flight returns 409. Ej.: horizonte-2026-06-26-credit-000123

Cuerpo de la petición

Tipo de contenido: application/json · obligatorio

Esquema AdminEntryIn — Comprobante contable en BORRADOR. external_id (id del ERP) lo hace idempotente en el motor. post: true se rechaza: el contador contabiliza en el panel.

CampoTipoDescripción
date obligatoriostring (date)
description obligatoriostring
external_idstringEj.: "ERP-AS-2026-000123"
lines obligatorioarray de object
referencestring
third_partystringId o documento del tercero.
voucher_typestringEj.: "CC"

Acepta campos adicionales (additionalProperties): se reenvían al motor sin cambios.

Respuestas

CódigoDescripciónCuerpo
200Registrado (sobre estándar; data trae el objeto del motor).TransactionEnvelope application/json
Errores posibles (400, 401, 403, 404, 409, 422, 429, 500, 502, 504) — application/problem+json
400Malformed request.about:blank
401Missing or invalid API key.about:blank
403The key is valid but lacks the required scope, or the source IP is not allow-listed.about:blank
404The requested resource does not exist.about:blank
409Idempotency conflict — same key, original still processing.https://errors.compense.co/gateway/idempotency-conflict
422Request body failed validation.https://errors.compense.co/gateway/validation
429Per-key rate limit or monthly quota exceeded; see Retry-After.https://errors.compense.co/gateway/rate-limited
500Unexpected gateway error; quote the trace_id to support.about:blank
502The processing engine returned an error.https://errors.compense.co/gateway/upstream-error
504The processing engine did not respond in time.https://errors.compense.co/gateway/upstream-error

Ver Errores problem+json para la excepción equivalente en cada SDK.

Ejemplo

Método del SDK y petición HTTP
client.admin.accounting.create_entry()

Los métodos de cada SDK salen de su suite de paridad con el contrato. El cURL va contra el sandbox; los valores <campo> son marcadores.

Comprobante con sus líneas #

GET/v1/gateway/admin/accounting/entries/{entry_id}/

  • operationId adminGetEntry
  • Autenticación X-API-Key · scope accounting:read
  • Idempotency-Key no aplica

Parámetros

NombreEnTipoDescripción
entry_id obligatoriorutastringId del comprobante. Ej.: 5c9d…

Respuestas

CódigoDescripciónCuerpo
200Objeto.AdminObject application/json
Errores posibles (400, 401, 403, 404, 409, 422, 429, 500, 502, 504) — application/problem+json
400Malformed request.about:blank
401Missing or invalid API key.about:blank
403The key is valid but lacks the required scope, or the source IP is not allow-listed.about:blank
404The requested resource does not exist.about:blank
409Idempotency conflict — same key, original still processing.https://errors.compense.co/gateway/idempotency-conflict
422Request body failed validation.https://errors.compense.co/gateway/validation
429Per-key rate limit or monthly quota exceeded; see Retry-After.https://errors.compense.co/gateway/rate-limited
500Unexpected gateway error; quote the trace_id to support.about:blank
502The processing engine returned an error.https://errors.compense.co/gateway/upstream-error
504The processing engine did not respond in time.https://errors.compense.co/gateway/upstream-error

Ver Errores problem+json para la excepción equivalente en cada SDK.

Ejemplo

Método del SDK y petición HTTP
client.admin.accounting.get_entry()

Los métodos de cada SDK salen de su suite de paridad con el contrato. El cURL va contra el sandbox; los valores <campo> son marcadores.

Simular impuestos y retenciones #

POST/v1/gateway/admin/accounting/taxes/compute/

  • operationId adminComputeTaxes
  • Autenticación X-API-Key · scope accounting:read
  • Idempotency-Key no aplica
Consulta: no escribe, no consume cuota ni toma Idempotency-Key.

Cuerpo de la petición

Tipo de contenido: application/json · obligatorio

Esquema AdminTaxComputeIn

CampoTipoDescripción
datestring (date)
items obligatorioarray de object
third_partystring

Acepta campos adicionales (additionalProperties): se reenvían al motor sin cambios.

Respuestas

CódigoDescripciónCuerpo
200Lista.AdminResultList application/json
Errores posibles (400, 401, 403, 404, 409, 422, 429, 500, 502, 504) — application/problem+json
400Malformed request.about:blank
401Missing or invalid API key.about:blank
403The key is valid but lacks the required scope, or the source IP is not allow-listed.about:blank
404The requested resource does not exist.about:blank
409Idempotency conflict — same key, original still processing.https://errors.compense.co/gateway/idempotency-conflict
422Request body failed validation.https://errors.compense.co/gateway/validation
429Per-key rate limit or monthly quota exceeded; see Retry-After.https://errors.compense.co/gateway/rate-limited
500Unexpected gateway error; quote the trace_id to support.about:blank
502The processing engine returned an error.https://errors.compense.co/gateway/upstream-error
504The processing engine did not respond in time.https://errors.compense.co/gateway/upstream-error

Ver Errores problem+json para la excepción equivalente en cada SDK.

Ejemplo

Método del SDK y petición HTTP
client.admin.accounting.compute_taxes()

Los métodos de cada SDK salen de su suite de paridad con el contrato. El cURL va contra el sandbox; los valores <campo> son marcadores.

Buscar terceros #

GET/v1/gateway/admin/accounting/third-parties/

  • operationId adminListThirdParties
  • Autenticación X-API-Key · scope accounting:read
  • Idempotency-Key no aplica

Parámetros

NombreEnTipoDescripción
qquerystringNombre o documento.
rolequerystringcustomer | supplier | employee | associate
limitquerystringMáximo 500.
briefquerystring1 = solo identificación.

Respuestas

CódigoDescripciónCuerpo
200Lista.AdminResultList application/json
Errores posibles (400, 401, 403, 404, 409, 422, 429, 500, 502, 504) — application/problem+json
400Malformed request.about:blank
401Missing or invalid API key.about:blank
403The key is valid but lacks the required scope, or the source IP is not allow-listed.about:blank
404The requested resource does not exist.about:blank
409Idempotency conflict — same key, original still processing.https://errors.compense.co/gateway/idempotency-conflict
422Request body failed validation.https://errors.compense.co/gateway/validation
429Per-key rate limit or monthly quota exceeded; see Retry-After.https://errors.compense.co/gateway/rate-limited
500Unexpected gateway error; quote the trace_id to support.about:blank
502The processing engine returned an error.https://errors.compense.co/gateway/upstream-error
504The processing engine did not respond in time.https://errors.compense.co/gateway/upstream-error

Ver Errores problem+json para la excepción equivalente en cada SDK.

Ejemplo

Método del SDK y petición HTTP
client.admin.accounting.list_third_parties()

Los métodos de cada SDK salen de su suite de paridad con el contrato. El cURL va contra el sandbox; los valores <campo> son marcadores.

Alta o actualización de un tercero #

POST/v1/gateway/admin/accounting/third-parties/

  • operationId adminUpsertThirdParty
  • Autenticación X-API-Key · scope accounting:write
  • Idempotency-Key recomendada (el SDK la genera)

Parámetros

NombreEnTipoDescripción
Idempotency-KeycabecerastringClient-generated key that makes a write safely retryable. Replaying the same key returns the original result with idempotent_replay: true; a replay while the original is still in flight returns 409. Ej.: horizonte-2026-06-26-credit-000123

Cuerpo de la petición

Tipo de contenido: application/json · obligatorio

Esquema AdminThirdPartyIn — Alta o actualización de un tercero (upsert por tipo y número de documento). id_type acepta el código DIAN (31, 13…) o el alias (NIT, CC, CE, PA…). Datos bancarios: solo en el panel.

CampoTipoDescripción
business_namestring
emailstring
first_last_namestring
first_namestring
id_number obligatoriostringEj.: "900123456"
id_type obligatoriostringEj.: "NIT"
is_customerboolean
is_supplierboolean
phonestring
responsibilitiesarray de string
tax_regimestring

Acepta campos adicionales (additionalProperties): se reenvían al motor sin cambios.

Respuestas

CódigoDescripciónCuerpo
200Registrado (sobre estándar; data trae el objeto del motor).TransactionEnvelope application/json
Errores posibles (400, 401, 403, 404, 409, 422, 429, 500, 502, 504) — application/problem+json
400Malformed request.about:blank
401Missing or invalid API key.about:blank
403The key is valid but lacks the required scope, or the source IP is not allow-listed.about:blank
404The requested resource does not exist.about:blank
409Idempotency conflict — same key, original still processing.https://errors.compense.co/gateway/idempotency-conflict
422Request body failed validation.https://errors.compense.co/gateway/validation
429Per-key rate limit or monthly quota exceeded; see Retry-After.https://errors.compense.co/gateway/rate-limited
500Unexpected gateway error; quote the trace_id to support.about:blank
502The processing engine returned an error.https://errors.compense.co/gateway/upstream-error
504The processing engine did not respond in time.https://errors.compense.co/gateway/upstream-error

Ver Errores problem+json para la excepción equivalente en cada SDK.

Ejemplo

Método del SDK y petición HTTP
client.admin.accounting.upsert_third_party()

Los métodos de cada SDK salen de su suite de paridad con el contrato. El cURL va contra el sandbox; los valores <campo> son marcadores.

Tercero (por id o documento) #

GET/v1/gateway/admin/accounting/third-parties/{third_party}/

  • operationId adminGetThirdParty
  • Autenticación X-API-Key · scope accounting:read
  • Idempotency-Key no aplica

Parámetros

NombreEnTipoDescripción
third_party obligatoriorutastringId o documento del tercero. Ej.: 900123456

Respuestas

CódigoDescripciónCuerpo
200Objeto.AdminObject application/json
Errores posibles (400, 401, 403, 404, 409, 422, 429, 500, 502, 504) — application/problem+json
400Malformed request.about:blank
401Missing or invalid API key.about:blank
403The key is valid but lacks the required scope, or the source IP is not allow-listed.about:blank
404The requested resource does not exist.about:blank
409Idempotency conflict — same key, original still processing.https://errors.compense.co/gateway/idempotency-conflict
422Request body failed validation.https://errors.compense.co/gateway/validation
429Per-key rate limit or monthly quota exceeded; see Retry-After.https://errors.compense.co/gateway/rate-limited
500Unexpected gateway error; quote the trace_id to support.about:blank
502The processing engine returned an error.https://errors.compense.co/gateway/upstream-error
504The processing engine did not respond in time.https://errors.compense.co/gateway/upstream-error

Ver Errores problem+json para la excepción equivalente en cada SDK.

Ejemplo

Método del SDK y petición HTTP
client.admin.accounting.get_third_party()

Los métodos de cada SDK salen de su suite de paridad con el contrato. El cURL va contra el sandbox; los valores <campo> son marcadores.

Buscar colaboradores #

GET/v1/gateway/admin/hr/employees/

  • operationId adminListEmployees
  • Autenticación X-API-Key · scope hr:read
  • Idempotency-Key no aplica

Parámetros

NombreEnTipoDescripción
qquerystringTexto: nombre, documento, código o correo.
statusquerystringACTIVO | RETIRADO
documentquerystringDocumento exacto.
areaquerystringId del área.
positionquerystringId del cargo.

Respuestas

CódigoDescripciónCuerpo
200Lista.AdminResultList application/json
Errores posibles (400, 401, 403, 404, 409, 422, 429, 500, 502, 504) — application/problem+json
400Malformed request.about:blank
401Missing or invalid API key.about:blank
403The key is valid but lacks the required scope, or the source IP is not allow-listed.about:blank
404The requested resource does not exist.about:blank
409Idempotency conflict — same key, original still processing.https://errors.compense.co/gateway/idempotency-conflict
422Request body failed validation.https://errors.compense.co/gateway/validation
429Per-key rate limit or monthly quota exceeded; see Retry-After.https://errors.compense.co/gateway/rate-limited
500Unexpected gateway error; quote the trace_id to support.about:blank
502The processing engine returned an error.https://errors.compense.co/gateway/upstream-error
504The processing engine did not respond in time.https://errors.compense.co/gateway/upstream-error

Ver Errores problem+json para la excepción equivalente en cada SDK.

Ejemplo

Método del SDK y petición HTTP
client.admin.hr.list_employees()

Los métodos de cada SDK salen de su suite de paridad con el contrato. El cURL va contra el sandbox; los valores <campo> son marcadores.

Alta o actualización de un colaborador (upsert por documento) #

POST/v1/gateway/admin/hr/employees/

  • operationId adminUpsertEmployee
  • Autenticación X-API-Key · scope hr:write
  • Idempotency-Key recomendada (el SDK la genera)

Parámetros

NombreEnTipoDescripción
Idempotency-KeycabecerastringClient-generated key that makes a write safely retryable. Replaying the same key returns the original result with idempotent_replay: true; a replay while the original is still in flight returns 409. Ej.: horizonte-2026-06-26-credit-000123

Cuerpo de la petición

Tipo de contenido: application/json · obligatorio

Esquema AdminEmployeeIn — Alta o actualización de un colaborador (upsert por id_number). Los datos bancarios solo se aceptan en el alta; cambiarlos después se hace en el panel. user_id no se acepta.

CampoTipoDescripción
area_idstring
bank_account_numberstring
bank_account_typestring
bank_namestring
email_workstring
eps_codestring
first_namestringEj.: "Laura"
hire_datestring (date)Ej.: "2025-02-01"
id_number obligatoriostringEj.: "1032456789"
id_typestringEj.: "CC"
last_namestringEj.: "Pérez"
pension_fund_codestring
phonestring
position_idstring

Acepta campos adicionales (additionalProperties): se reenvían al motor sin cambios.

Respuestas

CódigoDescripciónCuerpo
200Registrado (sobre estándar; data trae el objeto del motor).TransactionEnvelope application/json
Errores posibles (400, 401, 403, 404, 409, 422, 429, 500, 502, 504) — application/problem+json
400Malformed request.about:blank
401Missing or invalid API key.about:blank
403The key is valid but lacks the required scope, or the source IP is not allow-listed.about:blank
404The requested resource does not exist.about:blank
409Idempotency conflict — same key, original still processing.https://errors.compense.co/gateway/idempotency-conflict
422Request body failed validation.https://errors.compense.co/gateway/validation
429Per-key rate limit or monthly quota exceeded; see Retry-After.https://errors.compense.co/gateway/rate-limited
500Unexpected gateway error; quote the trace_id to support.about:blank
502The processing engine returned an error.https://errors.compense.co/gateway/upstream-error
504The processing engine did not respond in time.https://errors.compense.co/gateway/upstream-error

Ver Errores problem+json para la excepción equivalente en cada SDK.

Ejemplo

Método del SDK y petición HTTP
client.admin.hr.upsert_employee()

Los métodos de cada SDK salen de su suite de paridad con el contrato. El cURL va contra el sandbox; los valores <campo> son marcadores.

Ficha de un colaborador #

GET/v1/gateway/admin/hr/employees/{employee}/

  • operationId adminGetEmployee
  • Autenticación X-API-Key · scope hr:read
  • Idempotency-Key no aplica

Parámetros

NombreEnTipoDescripción
employee obligatoriorutastringId del colaborador o su número de documento. Ej.: 1032456789

Respuestas

CódigoDescripciónCuerpo
200Objeto.AdminObject application/json
Errores posibles (400, 401, 403, 404, 409, 422, 429, 500, 502, 504) — application/problem+json
400Malformed request.about:blank
401Missing or invalid API key.about:blank
403The key is valid but lacks the required scope, or the source IP is not allow-listed.about:blank
404The requested resource does not exist.about:blank
409Idempotency conflict — same key, original still processing.https://errors.compense.co/gateway/idempotency-conflict
422Request body failed validation.https://errors.compense.co/gateway/validation
429Per-key rate limit or monthly quota exceeded; see Retry-After.https://errors.compense.co/gateway/rate-limited
500Unexpected gateway error; quote the trace_id to support.about:blank
502The processing engine returned an error.https://errors.compense.co/gateway/upstream-error
504The processing engine did not respond in time.https://errors.compense.co/gateway/upstream-error

Ver Errores problem+json para la excepción equivalente en cada SDK.

Ejemplo

Método del SDK y petición HTTP
client.admin.hr.get_employee()

Los métodos de cada SDK salen de su suite de paridad con el contrato. El cURL va contra el sandbox; los valores <campo> son marcadores.

Contratos de un colaborador #

GET/v1/gateway/admin/hr/employees/{employee}/contracts/

  • operationId adminListEmployeeContracts
  • Autenticación X-API-Key · scope hr:read
  • Idempotency-Key no aplica

Parámetros

NombreEnTipoDescripción
employee obligatoriorutastringId del colaborador o su número de documento. Ej.: 1032456789

Respuestas

CódigoDescripciónCuerpo
200Lista.AdminResultList application/json
Errores posibles (400, 401, 403, 404, 409, 422, 429, 500, 502, 504) — application/problem+json
400Malformed request.about:blank
401Missing or invalid API key.about:blank
403The key is valid but lacks the required scope, or the source IP is not allow-listed.about:blank
404The requested resource does not exist.about:blank
409Idempotency conflict — same key, original still processing.https://errors.compense.co/gateway/idempotency-conflict
422Request body failed validation.https://errors.compense.co/gateway/validation
429Per-key rate limit or monthly quota exceeded; see Retry-After.https://errors.compense.co/gateway/rate-limited
500Unexpected gateway error; quote the trace_id to support.about:blank
502The processing engine returned an error.https://errors.compense.co/gateway/upstream-error
504The processing engine did not respond in time.https://errors.compense.co/gateway/upstream-error

Ver Errores problem+json para la excepción equivalente en cada SDK.

Ejemplo

Método del SDK y petición HTTP
client.admin.hr.list_employee_contracts()

Los métodos de cada SDK salen de su suite de paridad con el contrato. El cURL va contra el sandbox; los valores <campo> son marcadores.

Novedades de talento humano #

GET/v1/gateway/admin/hr/novelties/

  • operationId adminListHrNovelties
  • Autenticación X-API-Key · scope hr:read
  • Idempotency-Key no aplica

Parámetros

NombreEnTipoDescripción
employeequerystringId o documento.
statusquerystringSOLICITADA, APROBADA… (coma)
categoryquerystringCategoría (coma).
fromquerystringDesde (AAAA-MM-DD).
toquerystringHasta (AAAA-MM-DD).

Respuestas

CódigoDescripciónCuerpo
200Lista.AdminResultList application/json
Errores posibles (400, 401, 403, 404, 409, 422, 429, 500, 502, 504) — application/problem+json
400Malformed request.about:blank
401Missing or invalid API key.about:blank
403The key is valid but lacks the required scope, or the source IP is not allow-listed.about:blank
404The requested resource does not exist.about:blank
409Idempotency conflict — same key, original still processing.https://errors.compense.co/gateway/idempotency-conflict
422Request body failed validation.https://errors.compense.co/gateway/validation
429Per-key rate limit or monthly quota exceeded; see Retry-After.https://errors.compense.co/gateway/rate-limited
500Unexpected gateway error; quote the trace_id to support.about:blank
502The processing engine returned an error.https://errors.compense.co/gateway/upstream-error
504The processing engine did not respond in time.https://errors.compense.co/gateway/upstream-error

Ver Errores problem+json para la excepción equivalente en cada SDK.

Ejemplo

Método del SDK y petición HTTP
client.admin.hr.list_novelties()

Los métodos de cada SDK salen de su suite de paridad con el contrato. El cURL va contra el sandbox; los valores <campo> son marcadores.

Registrar incapacidad, licencia, permiso o vacaciones #

POST/v1/gateway/admin/hr/novelties/

  • operationId adminCreateHrNovelty
  • Autenticación X-API-Key · scope hr:write
  • Idempotency-Key recomendada (el SDK la genera)
Queda SOLICITADA; talento humano la valida en el panel. Los diagnósticos nunca se devuelven.

Parámetros

NombreEnTipoDescripción
Idempotency-KeycabecerastringClient-generated key that makes a write safely retryable. Replaying the same key returns the original result with idempotent_replay: true; a replay while the original is still in flight returns 409. Ej.: horizonte-2026-06-26-credit-000123

Cuerpo de la petición

Tipo de contenido: application/json · obligatorio

Esquema AdminHrNoveltyIn — Novedad de talento humano. Queda SOLICITADA hasta que talento humano la valide.

CampoTipoDescripción
certificate_numberstring
daysinteger
diagnosis_codestringCIE-10; nunca se devuelve por API.
employee obligatoriostringId o documento del colaborador. Ej.: "1032456789"
end_datestring (date)
hoursnumber
issuing_entitystring
reasonstring
start_date obligatoriostring (date)
type_code obligatoriostringEj.: "INCAPACIDAD_COMUN"

Acepta campos adicionales (additionalProperties): se reenvían al motor sin cambios.

Respuestas

CódigoDescripciónCuerpo
200Registrado (sobre estándar; data trae el objeto del motor).TransactionEnvelope application/json
Errores posibles (400, 401, 403, 404, 409, 422, 429, 500, 502, 504) — application/problem+json
400Malformed request.about:blank
401Missing or invalid API key.about:blank
403The key is valid but lacks the required scope, or the source IP is not allow-listed.about:blank
404The requested resource does not exist.about:blank
409Idempotency conflict — same key, original still processing.https://errors.compense.co/gateway/idempotency-conflict
422Request body failed validation.https://errors.compense.co/gateway/validation
429Per-key rate limit or monthly quota exceeded; see Retry-After.https://errors.compense.co/gateway/rate-limited
500Unexpected gateway error; quote the trace_id to support.about:blank
502The processing engine returned an error.https://errors.compense.co/gateway/upstream-error
504The processing engine did not respond in time.https://errors.compense.co/gateway/upstream-error

Ver Errores problem+json para la excepción equivalente en cada SDK.

Ejemplo

Método del SDK y petición HTTP
client.admin.hr.create_novelty()

Los métodos de cada SDK salen de su suite de paridad con el contrato. El cURL va contra el sandbox; los valores <campo> son marcadores.

Estado de la nómina electrónica (DIAN) de un mes #

GET/v1/gateway/admin/payroll/electronic/

  • operationId adminGetElectronicPayroll
  • Autenticación X-API-Key · scope payroll:read
  • Idempotency-Key no aplica

Parámetros

NombreEnTipoDescripción
yearquerystringAño.
monthquerystringMes (1-12).
statusquerystringEstado.

Respuestas

CódigoDescripciónCuerpo
200Lista.AdminResultList application/json
Errores posibles (400, 401, 403, 404, 409, 422, 429, 500, 502, 504) — application/problem+json
400Malformed request.about:blank
401Missing or invalid API key.about:blank
403The key is valid but lacks the required scope, or the source IP is not allow-listed.about:blank
404The requested resource does not exist.about:blank
409Idempotency conflict — same key, original still processing.https://errors.compense.co/gateway/idempotency-conflict
422Request body failed validation.https://errors.compense.co/gateway/validation
429Per-key rate limit or monthly quota exceeded; see Retry-After.https://errors.compense.co/gateway/rate-limited
500Unexpected gateway error; quote the trace_id to support.about:blank
502The processing engine returned an error.https://errors.compense.co/gateway/upstream-error
504The processing engine did not respond in time.https://errors.compense.co/gateway/upstream-error

Ver Errores problem+json para la excepción equivalente en cada SDK.

Ejemplo

Método del SDK y petición HTTP
client.admin.payroll.electronic()

Los métodos de cada SDK salen de su suite de paridad con el contrato. El cURL va contra el sandbox; los valores <campo> son marcadores.

Novedades de nómina #

GET/v1/gateway/admin/payroll/novelties/

  • operationId adminListPayrollNovelties
  • Autenticación X-API-Key · scope payroll:read
  • Idempotency-Key no aplica

Parámetros

NombreEnTipoDescripción
employeequerystringId o documento.
periodquerystringId del periodo.
statusquerystringPENDIENTE | LIQUIDADA | ANULADA
conceptquerystringCódigo del concepto.
fromquerystringDesde.
toquerystringHasta.

Respuestas

CódigoDescripciónCuerpo
200Lista.AdminResultList application/json
Errores posibles (400, 401, 403, 404, 409, 422, 429, 500, 502, 504) — application/problem+json
400Malformed request.about:blank
401Missing or invalid API key.about:blank
403The key is valid but lacks the required scope, or the source IP is not allow-listed.about:blank
404The requested resource does not exist.about:blank
409Idempotency conflict — same key, original still processing.https://errors.compense.co/gateway/idempotency-conflict
422Request body failed validation.https://errors.compense.co/gateway/validation
429Per-key rate limit or monthly quota exceeded; see Retry-After.https://errors.compense.co/gateway/rate-limited
500Unexpected gateway error; quote the trace_id to support.about:blank
502The processing engine returned an error.https://errors.compense.co/gateway/upstream-error
504The processing engine did not respond in time.https://errors.compense.co/gateway/upstream-error

Ver Errores problem+json para la excepción equivalente en cada SDK.

Ejemplo

Método del SDK y petición HTTP
client.admin.payroll.list_novelties()

Los métodos de cada SDK salen de su suite de paridad con el contrato. El cURL va contra el sandbox; los valores <campo> son marcadores.

Cargar novedades de nómina (una o un lote) #

POST/v1/gateway/admin/payroll/novelties/

  • operationId adminCreatePayrollNovelties
  • Autenticación X-API-Key · scope payroll:write
  • Idempotency-Key recomendada (el SDK la genera)
Horas extra, recargos, bonificaciones y deducciones. Un lote es todo o nada. Los conceptos que calcula el motor se rechazan (422) y un periodo aprobado responde 409.

Parámetros

NombreEnTipoDescripción
Idempotency-KeycabecerastringClient-generated key that makes a write safely retryable. Replaying the same key returns the original result with idempotent_replay: true; a replay while the original is still in flight returns 409. Ej.: horizonte-2026-06-26-credit-000123

Cuerpo de la petición

Tipo de contenido: application/json · obligatorio

Esquema AdminPayrollNoveltyIn — Una novedad (campos de AdminPayrollNovelty en la raíz) o un lote en items (máx. 500, todo o nada). period_id opcional: valida que el periodo esté abierto y que la fecha caiga dentro; sin date, se usa el inicio del periodo.

CampoTipoDescripción
amountnumber | string
concept_codestring
datestring (date)
employeestring
itemsarray de AdminPayrollNovelty
period_idstring
quantitynumber | string

Acepta campos adicionales (additionalProperties): se reenvían al motor sin cambios.

Respuestas

CódigoDescripciónCuerpo
200Registrado (sobre estándar; data trae el objeto del motor).TransactionEnvelope application/json
Errores posibles (400, 401, 403, 404, 409, 422, 429, 500, 502, 504) — application/problem+json
400Malformed request.about:blank
401Missing or invalid API key.about:blank
403The key is valid but lacks the required scope, or the source IP is not allow-listed.about:blank
404The requested resource does not exist.about:blank
409Idempotency conflict — same key, original still processing.https://errors.compense.co/gateway/idempotency-conflict
422Request body failed validation.https://errors.compense.co/gateway/validation
429Per-key rate limit or monthly quota exceeded; see Retry-After.https://errors.compense.co/gateway/rate-limited
500Unexpected gateway error; quote the trace_id to support.about:blank
502The processing engine returned an error.https://errors.compense.co/gateway/upstream-error
504The processing engine did not respond in time.https://errors.compense.co/gateway/upstream-error

Ver Errores problem+json para la excepción equivalente en cada SDK.

Ejemplo

Método del SDK y petición HTTP
client.admin.payroll.create_novelties()

Los métodos de cada SDK salen de su suite de paridad con el contrato. El cURL va contra el sandbox; los valores <campo> son marcadores.

Desprendible con sus conceptos #

GET/v1/gateway/admin/payroll/payslips/{payslip_id}/

  • operationId adminGetPayslip
  • Autenticación X-API-Key · scope payroll:read
  • Idempotency-Key no aplica

Parámetros

NombreEnTipoDescripción
payslip_id obligatoriorutastringId del desprendible. Ej.: 7a2e…

Respuestas

CódigoDescripciónCuerpo
200Objeto.AdminObject application/json
Errores posibles (400, 401, 403, 404, 409, 422, 429, 500, 502, 504) — application/problem+json
400Malformed request.about:blank
401Missing or invalid API key.about:blank
403The key is valid but lacks the required scope, or the source IP is not allow-listed.about:blank
404The requested resource does not exist.about:blank
409Idempotency conflict — same key, original still processing.https://errors.compense.co/gateway/idempotency-conflict
422Request body failed validation.https://errors.compense.co/gateway/validation
429Per-key rate limit or monthly quota exceeded; see Retry-After.https://errors.compense.co/gateway/rate-limited
500Unexpected gateway error; quote the trace_id to support.about:blank
502The processing engine returned an error.https://errors.compense.co/gateway/upstream-error
504The processing engine did not respond in time.https://errors.compense.co/gateway/upstream-error

Ver Errores problem+json para la excepción equivalente en cada SDK.

Ejemplo

Método del SDK y petición HTTP
client.admin.payroll.get_payslip()

Los métodos de cada SDK salen de su suite de paridad con el contrato. El cURL va contra el sandbox; los valores <campo> son marcadores.

Periodos de nómina #

GET/v1/gateway/admin/payroll/periods/

  • operationId adminListPayrollPeriods
  • Autenticación X-API-Key · scope payroll:read
  • Idempotency-Key no aplica

Parámetros

NombreEnTipoDescripción
statusquerystringABIERTO | CALCULADO | APROBADO | REVERTIDO
kindquerystringORDINARIA, PRIMA…
yearquerystringAño.

Respuestas

CódigoDescripciónCuerpo
200Lista.AdminResultList application/json
Errores posibles (400, 401, 403, 404, 409, 422, 429, 500, 502, 504) — application/problem+json
400Malformed request.about:blank
401Missing or invalid API key.about:blank
403The key is valid but lacks the required scope, or the source IP is not allow-listed.about:blank
404The requested resource does not exist.about:blank
409Idempotency conflict — same key, original still processing.https://errors.compense.co/gateway/idempotency-conflict
422Request body failed validation.https://errors.compense.co/gateway/validation
429Per-key rate limit or monthly quota exceeded; see Retry-After.https://errors.compense.co/gateway/rate-limited
500Unexpected gateway error; quote the trace_id to support.about:blank
502The processing engine returned an error.https://errors.compense.co/gateway/upstream-error
504The processing engine did not respond in time.https://errors.compense.co/gateway/upstream-error

Ver Errores problem+json para la excepción equivalente en cada SDK.

Ejemplo

Método del SDK y petición HTTP
client.admin.payroll.list_periods()

Los métodos de cada SDK salen de su suite de paridad con el contrato. El cURL va contra el sandbox; los valores <campo> son marcadores.

Detalle de un periodo #

GET/v1/gateway/admin/payroll/periods/{period_id}/

  • operationId adminGetPayrollPeriod
  • Autenticación X-API-Key · scope payroll:read
  • Idempotency-Key no aplica

Parámetros

NombreEnTipoDescripción
period_id obligatoriorutastringId del periodo de nómina. Ej.: 3f1c…

Respuestas

CódigoDescripciónCuerpo
200Objeto.AdminObject application/json
Errores posibles (400, 401, 403, 404, 409, 422, 429, 500, 502, 504) — application/problem+json
400Malformed request.about:blank
401Missing or invalid API key.about:blank
403The key is valid but lacks the required scope, or the source IP is not allow-listed.about:blank
404The requested resource does not exist.about:blank
409Idempotency conflict — same key, original still processing.https://errors.compense.co/gateway/idempotency-conflict
422Request body failed validation.https://errors.compense.co/gateway/validation
429Per-key rate limit or monthly quota exceeded; see Retry-After.https://errors.compense.co/gateway/rate-limited
500Unexpected gateway error; quote the trace_id to support.about:blank
502The processing engine returned an error.https://errors.compense.co/gateway/upstream-error
504The processing engine did not respond in time.https://errors.compense.co/gateway/upstream-error

Ver Errores problem+json para la excepción equivalente en cada SDK.

Ejemplo

Método del SDK y petición HTTP
client.admin.payroll.get_period()

Los métodos de cada SDK salen de su suite de paridad con el contrato. El cURL va contra el sandbox; los valores <campo> son marcadores.

Desprendibles de un periodo #

GET/v1/gateway/admin/payroll/periods/{period_id}/payslips/

  • operationId adminListPeriodPayslips
  • Autenticación X-API-Key · scope payroll:read
  • Idempotency-Key no aplica

Parámetros

NombreEnTipoDescripción
period_id obligatoriorutastringId del periodo de nómina. Ej.: 3f1c…
employeequerystringId o documento.

Respuestas

CódigoDescripciónCuerpo
200Lista.AdminResultList application/json
Errores posibles (400, 401, 403, 404, 409, 422, 429, 500, 502, 504) — application/problem+json
400Malformed request.about:blank
401Missing or invalid API key.about:blank
403The key is valid but lacks the required scope, or the source IP is not allow-listed.about:blank
404The requested resource does not exist.about:blank
409Idempotency conflict — same key, original still processing.https://errors.compense.co/gateway/idempotency-conflict
422Request body failed validation.https://errors.compense.co/gateway/validation
429Per-key rate limit or monthly quota exceeded; see Retry-After.https://errors.compense.co/gateway/rate-limited
500Unexpected gateway error; quote the trace_id to support.about:blank
502The processing engine returned an error.https://errors.compense.co/gateway/upstream-error
504The processing engine did not respond in time.https://errors.compense.co/gateway/upstream-error

Ver Errores problem+json para la excepción equivalente en cada SDK.

Ejemplo

Método del SDK y petición HTTP
client.admin.payroll.list_period_payslips()

Los métodos de cada SDK salen de su suite de paridad con el contrato. El cURL va contra el sandbox; los valores <campo> son marcadores.

Registrar un egreso en BORRADOR #

POST/v1/gateway/admin/treasury/payments/

  • operationId adminCreatePayment
  • Autenticación X-API-Key · scope treasury:write
  • Idempotency-Key recomendada (el SDK la genera)

Parámetros

NombreEnTipoDescripción
Idempotency-KeycabecerastringClient-generated key that makes a write safely retryable. Replaying the same key returns the original result with idempotent_replay: true; a replay while the original is still in flight returns 409. Ej.: horizonte-2026-06-26-credit-000123

Cuerpo de la petición

Tipo de contenido: application/json · obligatorio

Esquema AdminTreasuryDocIn — Recaudo / egreso (third_party, bank_account id o número, date, amount, method, reference, applications) o cuenta de cobro (third_party, issue_date, description, income_account, subtotal, iva_concept). Siempre en BORRADOR.

CampoTipoDescripción
amountnumber | string
applicationsarray de object
bank_accountstring
datestring (date)
descriptionstring
income_accountstring
issue_datestring (date)
methodstringEj.: "TRANSFERENCIA"
referencestring
subtotalnumber | string
third_party obligatoriostring

Acepta campos adicionales (additionalProperties): se reenvían al motor sin cambios.

Respuestas

CódigoDescripciónCuerpo
200Registrado (sobre estándar; data trae el objeto del motor).TransactionEnvelope application/json
Errores posibles (400, 401, 403, 404, 409, 422, 429, 500, 502, 504) — application/problem+json
400Malformed request.about:blank
401Missing or invalid API key.about:blank
403The key is valid but lacks the required scope, or the source IP is not allow-listed.about:blank
404The requested resource does not exist.about:blank
409Idempotency conflict — same key, original still processing.https://errors.compense.co/gateway/idempotency-conflict
422Request body failed validation.https://errors.compense.co/gateway/validation
429Per-key rate limit or monthly quota exceeded; see Retry-After.https://errors.compense.co/gateway/rate-limited
500Unexpected gateway error; quote the trace_id to support.about:blank
502The processing engine returned an error.https://errors.compense.co/gateway/upstream-error
504The processing engine did not respond in time.https://errors.compense.co/gateway/upstream-error

Ver Errores problem+json para la excepción equivalente en cada SDK.

Ejemplo

Método del SDK y petición HTTP
client.admin.treasury.create_payment()

Los métodos de cada SDK salen de su suite de paridad con el contrato. El cURL va contra el sandbox; los valores <campo> son marcadores.

Registrar un recaudo en BORRADOR #

POST/v1/gateway/admin/treasury/receipts/

  • operationId adminCreateReceipt
  • Autenticación X-API-Key · scope treasury:write
  • Idempotency-Key recomendada (el SDK la genera)

Parámetros

NombreEnTipoDescripción
Idempotency-KeycabecerastringClient-generated key that makes a write safely retryable. Replaying the same key returns the original result with idempotent_replay: true; a replay while the original is still in flight returns 409. Ej.: horizonte-2026-06-26-credit-000123

Cuerpo de la petición

Tipo de contenido: application/json · obligatorio

Esquema AdminTreasuryDocIn — Recaudo / egreso (third_party, bank_account id o número, date, amount, method, reference, applications) o cuenta de cobro (third_party, issue_date, description, income_account, subtotal, iva_concept). Siempre en BORRADOR.

CampoTipoDescripción
amountnumber | string
applicationsarray de object
bank_accountstring
datestring (date)
descriptionstring
income_accountstring
issue_datestring (date)
methodstringEj.: "TRANSFERENCIA"
referencestring
subtotalnumber | string
third_party obligatoriostring

Acepta campos adicionales (additionalProperties): se reenvían al motor sin cambios.

Respuestas

CódigoDescripciónCuerpo
200Registrado (sobre estándar; data trae el objeto del motor).TransactionEnvelope application/json
Errores posibles (400, 401, 403, 404, 409, 422, 429, 500, 502, 504) — application/problem+json
400Malformed request.about:blank
401Missing or invalid API key.about:blank
403The key is valid but lacks the required scope, or the source IP is not allow-listed.about:blank
404The requested resource does not exist.about:blank
409Idempotency conflict — same key, original still processing.https://errors.compense.co/gateway/idempotency-conflict
422Request body failed validation.https://errors.compense.co/gateway/validation
429Per-key rate limit or monthly quota exceeded; see Retry-After.https://errors.compense.co/gateway/rate-limited
500Unexpected gateway error; quote the trace_id to support.about:blank
502The processing engine returned an error.https://errors.compense.co/gateway/upstream-error
504The processing engine did not respond in time.https://errors.compense.co/gateway/upstream-error

Ver Errores problem+json para la excepción equivalente en cada SDK.

Ejemplo

Método del SDK y petición HTTP
client.admin.treasury.create_receipt()

Los métodos de cada SDK salen de su suite de paridad con el contrato. El cURL va contra el sandbox; los valores <campo> son marcadores.

Registrar una cuenta de cobro en BORRADOR #

POST/v1/gateway/admin/treasury/receivables/

  • operationId adminCreateReceivable
  • Autenticación X-API-Key · scope treasury:write
  • Idempotency-Key recomendada (el SDK la genera)

Parámetros

NombreEnTipoDescripción
Idempotency-KeycabecerastringClient-generated key that makes a write safely retryable. Replaying the same key returns the original result with idempotent_replay: true; a replay while the original is still in flight returns 409. Ej.: horizonte-2026-06-26-credit-000123

Cuerpo de la petición

Tipo de contenido: application/json · obligatorio

Esquema AdminTreasuryDocIn — Recaudo / egreso (third_party, bank_account id o número, date, amount, method, reference, applications) o cuenta de cobro (third_party, issue_date, description, income_account, subtotal, iva_concept). Siempre en BORRADOR.

CampoTipoDescripción
amountnumber | string
applicationsarray de object
bank_accountstring
datestring (date)
descriptionstring
income_accountstring
issue_datestring (date)
methodstringEj.: "TRANSFERENCIA"
referencestring
subtotalnumber | string
third_party obligatoriostring

Acepta campos adicionales (additionalProperties): se reenvían al motor sin cambios.

Respuestas

CódigoDescripciónCuerpo
200Registrado (sobre estándar; data trae el objeto del motor).TransactionEnvelope application/json
Errores posibles (400, 401, 403, 404, 409, 422, 429, 500, 502, 504) — application/problem+json
400Malformed request.about:blank
401Missing or invalid API key.about:blank
403The key is valid but lacks the required scope, or the source IP is not allow-listed.about:blank
404The requested resource does not exist.about:blank
409Idempotency conflict — same key, original still processing.https://errors.compense.co/gateway/idempotency-conflict
422Request body failed validation.https://errors.compense.co/gateway/validation
429Per-key rate limit or monthly quota exceeded; see Retry-After.https://errors.compense.co/gateway/rate-limited
500Unexpected gateway error; quote the trace_id to support.about:blank
502The processing engine returned an error.https://errors.compense.co/gateway/upstream-error
504The processing engine did not respond in time.https://errors.compense.co/gateway/upstream-error

Ver Errores problem+json para la excepción equivalente en cada SDK.

Ejemplo

Método del SDK y petición HTTP
client.admin.treasury.create_receivable()

Los métodos de cada SDK salen de su suite de paridad con el contrato. El cURL va contra el sandbox; los valores <campo> son marcadores.

Cargar un extracto bancario para conciliación #

POST/v1/gateway/admin/treasury/statements/

  • operationId adminImportStatement
  • Autenticación X-API-Key · scope treasury:write
  • Idempotency-Key recomendada (el SDK la genera)

Parámetros

NombreEnTipoDescripción
Idempotency-KeycabecerastringClient-generated key that makes a write safely retryable. Replaying the same key returns the original result with idempotent_replay: true; a replay while the original is still in flight returns 409. Ej.: horizonte-2026-06-26-credit-000123

Cuerpo de la petición

Tipo de contenido: application/json · obligatorio

Esquema AdminStatementIn — Extracto bancario: lines (JSON) o content (CSV con fecha y valor).

CampoTipoDescripción
bank_account obligatoriostring
closing_balancenumber | string
contentstring
date_fromstring (date)
date_tostring (date)
linesarray de object
opening_balancenumber | string

Acepta campos adicionales (additionalProperties): se reenvían al motor sin cambios.

Respuestas

CódigoDescripciónCuerpo
200Registrado (sobre estándar; data trae el objeto del motor).TransactionEnvelope application/json
Errores posibles (400, 401, 403, 404, 409, 422, 429, 500, 502, 504) — application/problem+json
400Malformed request.about:blank
401Missing or invalid API key.about:blank
403The key is valid but lacks the required scope, or the source IP is not allow-listed.about:blank
404The requested resource does not exist.about:blank
409Idempotency conflict — same key, original still processing.https://errors.compense.co/gateway/idempotency-conflict
422Request body failed validation.https://errors.compense.co/gateway/validation
429Per-key rate limit or monthly quota exceeded; see Retry-After.https://errors.compense.co/gateway/rate-limited
500Unexpected gateway error; quote the trace_id to support.about:blank
502The processing engine returned an error.https://errors.compense.co/gateway/upstream-error
504The processing engine did not respond in time.https://errors.compense.co/gateway/upstream-error

Ver Errores problem+json para la excepción equivalente en cada SDK.

Ejemplo

Método del SDK y petición HTTP
client.admin.treasury.import_statement()

Los métodos de cada SDK salen de su suite de paridad con el contrato. El cURL va contra el sandbox; los valores <campo> son marcadores.

Cruce automático del extracto #

POST/v1/gateway/admin/treasury/statements/{statement_id}/auto-match/

  • operationId adminAutoMatchStatement
  • Autenticación X-API-Key · scope treasury:write
  • Idempotency-Key recomendada (el SDK la genera)

Parámetros

NombreEnTipoDescripción
statement_id obligatoriorutastringId del extracto. Ej.: 8b1f…
Idempotency-KeycabecerastringClient-generated key that makes a write safely retryable. Replaying the same key returns the original result with idempotent_replay: true; a replay while the original is still in flight returns 409. Ej.: horizonte-2026-06-26-credit-000123

Respuestas

CódigoDescripciónCuerpo
200Registrado (sobre estándar; data trae el objeto del motor).TransactionEnvelope application/json
Errores posibles (400, 401, 403, 404, 409, 422, 429, 500, 502, 504) — application/problem+json
400Malformed request.about:blank
401Missing or invalid API key.about:blank
403The key is valid but lacks the required scope, or the source IP is not allow-listed.about:blank
404The requested resource does not exist.about:blank
409Idempotency conflict — same key, original still processing.https://errors.compense.co/gateway/idempotency-conflict
422Request body failed validation.https://errors.compense.co/gateway/validation
429Per-key rate limit or monthly quota exceeded; see Retry-After.https://errors.compense.co/gateway/rate-limited
500Unexpected gateway error; quote the trace_id to support.about:blank
502The processing engine returned an error.https://errors.compense.co/gateway/upstream-error
504The processing engine did not respond in time.https://errors.compense.co/gateway/upstream-error

Ver Errores problem+json para la excepción equivalente en cada SDK.

Ejemplo

Método del SDK y petición HTTP
client.admin.treasury.auto_match_statement()

Los métodos de cada SDK salen de su suite de paridad con el contrato. El cURL va contra el sandbox; los valores <campo> son marcadores.