Administrative

Journal entries #

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

• operationId adminListEntries
• Authentication X-API-Key · scope accounting:read
• Idempotency-Key not applicable

Parameters

Responses

Example

client.admin.accounting.list_entries()

client.admin.accounting.listEntries()

$client->admin->accounting->listEntries()

await client.Admin.Accounting.ListEntriesAsync()

client.Admin.Accounting.ListEntries(ctx, …)

curl "https://sandbox.dev.compense.co/gw/v1/gateway/admin/accounting/entries/" \
  -H "X-API-Key: $COMPENSE_API_KEY"

Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.

Create a DRAFT journal entry #

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

• operationId adminCreateEntry
• Authentication X-API-Key · scope accounting:write
• Idempotency-Key recommended (the SDK generates it)

Parameters

Request body

Content type: application/json · required

Schema AdminEntryIn — Journal entry in DRAFT. external_id (the ERP id) makes it idempotent in the engine. post: true is rejected: the accountant posts it in the panel.

Accepts additional fields (additionalProperties): they're forwarded to the engine unchanged.

Responses

Example

client.admin.accounting.create_entry()

client.admin.accounting.createEntry()

$client->admin->accounting->createEntry()

await client.Admin.Accounting.CreateEntryAsync()

client.Admin.Accounting.CreateEntry(ctx, …)

curl -X POST "https://sandbox.dev.compense.co/gw/v1/gateway/admin/accounting/entries/" \
  -H "X-API-Key: $COMPENSE_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "external_id": "ERP-AS-2026-000123",
    "voucher_type": "CC",
    "date": "2026-11-02",
    "description": "<description>",
    "lines": [
      {
        "account": "13050501"
      }
    ]
  }'

Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.

Journal entry with its lines #

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

• operationId adminGetEntry
• Authentication X-API-Key · scope accounting:read
• Idempotency-Key not applicable

Parameters

Responses

Example

client.admin.accounting.get_entry()

client.admin.accounting.getEntry()

$client->admin->accounting->getEntry()

await client.Admin.Accounting.GetEntryAsync()

client.Admin.Accounting.GetEntry(ctx, …)

curl "https://sandbox.dev.compense.co/gw/v1/gateway/admin/accounting/entries/5c9d…/" \
  -H "X-API-Key: $COMPENSE_API_KEY"

Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.

Simulate taxes and withholdings #

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

• operationId adminComputeTaxes
• Authentication X-API-Key · scope accounting:read
• Idempotency-Key not applicable

Request body

Content type: application/json · required

Schema AdminTaxComputeIn

Accepts additional fields (additionalProperties): they're forwarded to the engine unchanged.

Responses

Example

client.admin.accounting.compute_taxes()

client.admin.accounting.computeTaxes()

$client->admin->accounting->computeTaxes()

await client.Admin.Accounting.ComputeTaxesAsync()

client.Admin.Accounting.ComputeTaxes(ctx, …)

curl -X POST "https://sandbox.dev.compense.co/gw/v1/gateway/admin/accounting/taxes/compute/" \
  -H "X-API-Key: $COMPENSE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "items": []
  }'

Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.

Search third parties #

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

• operationId adminListThirdParties
• Authentication X-API-Key · scope accounting:read
• Idempotency-Key not applicable

Parameters

Responses

Example

client.admin.accounting.list_third_parties()

client.admin.accounting.listThirdParties()

$client->admin->accounting->listThirdParties()

await client.Admin.Accounting.ListThirdPartiesAsync()

client.Admin.Accounting.ListThirdParties(ctx, …)

curl "https://sandbox.dev.compense.co/gw/v1/gateway/admin/accounting/third-parties/" \
  -H "X-API-Key: $COMPENSE_API_KEY"

Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.

Create or update a third party #

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

• operationId adminUpsertThirdParty
• Authentication X-API-Key · scope accounting:write
• Idempotency-Key recommended (the SDK generates it)

Parameters

Request body

Content type: application/json · required

Schema AdminThirdPartyIn — Create or update a third party (upsert by document type and number). id_type accepts the DIAN code (31, 13…) or the alias (NIT, CC, CE, PA…). Bank details: panel only.

Accepts additional fields (additionalProperties): they're forwarded to the engine unchanged.

Responses

Example

client.admin.accounting.upsert_third_party()

client.admin.accounting.upsertThirdParty()

$client->admin->accounting->upsertThirdParty()

await client.Admin.Accounting.UpsertThirdPartyAsync()

client.Admin.Accounting.UpsertThirdParty(ctx, …)

curl -X POST "https://sandbox.dev.compense.co/gw/v1/gateway/admin/accounting/third-parties/" \
  -H "X-API-Key: $COMPENSE_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "id_type": "NIT",
    "id_number": "900123456"
  }'

Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.

Third party (by id or document) #

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

• operationId adminGetThirdParty
• Authentication X-API-Key · scope accounting:read
• Idempotency-Key not applicable

Parameters

Responses

Example

client.admin.accounting.get_third_party()

client.admin.accounting.getThirdParty()

$client->admin->accounting->getThirdParty()

await client.Admin.Accounting.GetThirdPartyAsync()

client.Admin.Accounting.GetThirdParty(ctx, …)

curl "https://sandbox.dev.compense.co/gw/v1/gateway/admin/accounting/third-parties/900123456/" \
  -H "X-API-Key: $COMPENSE_API_KEY"

Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.

Search employees #

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

• operationId adminListEmployees
• Authentication X-API-Key · scope hr:read
• Idempotency-Key not applicable

Parameters

Responses

Example

client.admin.hr.list_employees()

client.admin.hr.listEmployees()

$client->admin->hr->listEmployees()

await client.Admin.Hr.ListEmployeesAsync()

client.Admin.HR.ListEmployees(ctx, …)

curl "https://sandbox.dev.compense.co/gw/v1/gateway/admin/hr/employees/" \
  -H "X-API-Key: $COMPENSE_API_KEY"

Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.

Create or update an employee (upsert by document) #

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

• operationId adminUpsertEmployee
• Authentication X-API-Key · scope hr:write
• Idempotency-Key recommended (the SDK generates it)

Parameters

Request body

Content type: application/json · required

Schema AdminEmployeeIn — Create or update an employee (upsert by id_number). Bank details are only accepted on creation; changing them later is done in the panel. user_id is not accepted.

Accepts additional fields (additionalProperties): they're forwarded to the engine unchanged.

Responses

Example

client.admin.hr.upsert_employee()

client.admin.hr.upsertEmployee()

$client->admin->hr->upsertEmployee()

await client.Admin.Hr.UpsertEmployeeAsync()

client.Admin.HR.UpsertEmployee(ctx, …)

curl -X POST "https://sandbox.dev.compense.co/gw/v1/gateway/admin/hr/employees/" \
  -H "X-API-Key: $COMPENSE_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "id_number": "1032456789",
    "id_type": "CC",
    "first_name": "Laura",
    "last_name": "Pérez",
    "hire_date": "2025-02-01"
  }'

Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.

Employee profile #

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

• operationId adminGetEmployee
• Authentication X-API-Key · scope hr:read
• Idempotency-Key not applicable

Parameters

Responses

Example

client.admin.hr.get_employee()

client.admin.hr.getEmployee()

$client->admin->hr->getEmployee()

await client.Admin.Hr.GetEmployeeAsync()

client.Admin.HR.GetEmployee(ctx, …)

curl "https://sandbox.dev.compense.co/gw/v1/gateway/admin/hr/employees/1032456789/" \
  -H "X-API-Key: $COMPENSE_API_KEY"

Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.

Employee contracts #

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

• operationId adminListEmployeeContracts
• Authentication X-API-Key · scope hr:read
• Idempotency-Key not applicable

Parameters

Responses

Example

client.admin.hr.list_employee_contracts()

client.admin.hr.listEmployeeContracts()

$client->admin->hr->listEmployeeContracts()

await client.Admin.Hr.ListEmployeeContractsAsync()

client.Admin.HR.ListEmployeeContracts(ctx, …)

curl "https://sandbox.dev.compense.co/gw/v1/gateway/admin/hr/employees/1032456789/contracts/" \
  -H "X-API-Key: $COMPENSE_API_KEY"

Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.

HR adjustments #

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

• operationId adminListHrNovelties
• Authentication X-API-Key · scope hr:read
• Idempotency-Key not applicable

Parameters

Responses

Example

client.admin.hr.list_novelties()

client.admin.hr.listNovelties()

$client->admin->hr->listNovelties()

await client.Admin.Hr.ListNoveltiesAsync()

client.Admin.HR.ListNovelties(ctx, …)

curl "https://sandbox.dev.compense.co/gw/v1/gateway/admin/hr/novelties/" \
  -H "X-API-Key: $COMPENSE_API_KEY"

Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.

Record sick leave, leave of absence, time off or vacation #

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

• operationId adminCreateHrNovelty
• Authentication X-API-Key · scope hr:write
• Idempotency-Key recommended (the SDK generates it)

Parameters

Request body

Content type: application/json · required

Schema AdminHrNoveltyIn — Human resources novelty. It remains SOLICITADA until human resources validates it.

Accepts additional fields (additionalProperties): they're forwarded to the engine unchanged.

Responses

Example

client.admin.hr.create_novelty()

client.admin.hr.createNovelty()

$client->admin->hr->createNovelty()

await client.Admin.Hr.CreateNoveltyAsync()

client.Admin.HR.CreateNovelty(ctx, …)

curl -X POST "https://sandbox.dev.compense.co/gw/v1/gateway/admin/hr/novelties/" \
  -H "X-API-Key: $COMPENSE_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "employee": "1032456789",
    "type_code": "INCAPACIDAD_COMUN",
    "start_date": "2026-11-02"
  }'

Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.

Electronic payroll (DIAN) status for a month #

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

• operationId adminGetElectronicPayroll
• Authentication X-API-Key · scope payroll:read
• Idempotency-Key not applicable

Parameters

Responses

Example

client.admin.payroll.electronic()

client.admin.payroll.electronic()

$client->admin->payroll->electronic()

await client.Admin.Payroll.ElectronicAsync()

client.Admin.Payroll.Electronic(ctx, …)

curl "https://sandbox.dev.compense.co/gw/v1/gateway/admin/payroll/electronic/" \
  -H "X-API-Key: $COMPENSE_API_KEY"

Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.

Payroll adjustments #

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

• operationId adminListPayrollNovelties
• Authentication X-API-Key · scope payroll:read
• Idempotency-Key not applicable

Parameters

Responses

Example

client.admin.payroll.list_novelties()

client.admin.payroll.listNovelties()

$client->admin->payroll->listNovelties()

await client.Admin.Payroll.ListNoveltiesAsync()

client.Admin.Payroll.ListNovelties(ctx, …)

curl "https://sandbox.dev.compense.co/gw/v1/gateway/admin/payroll/novelties/" \
  -H "X-API-Key: $COMPENSE_API_KEY"

Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.

Upload payroll adjustments (one or a batch) #

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

• operationId adminCreatePayrollNovelties
• Authentication X-API-Key · scope payroll:write
• Idempotency-Key recommended (the SDK generates it)

Parameters

Request body

Content type: application/json · required

Schema AdminPayrollNoveltyIn — A single payroll adjustment (AdminPayrollNovelty fields at the root) or a batch in items (max. 500, all or nothing). period_id is optional: it validates that the period is open and that the date falls within it; without date, the period start is used.

Accepts additional fields (additionalProperties): they're forwarded to the engine unchanged.

Responses

Example

client.admin.payroll.create_novelties()

client.admin.payroll.createNovelties()

$client->admin->payroll->createNovelties()

await client.Admin.Payroll.CreateNoveltiesAsync()

client.Admin.Payroll.CreateNovelties(ctx, …)

curl -X POST "https://sandbox.dev.compense.co/gw/v1/gateway/admin/payroll/novelties/" \
  -H "X-API-Key: $COMPENSE_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'

Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.

Payslip with its concepts #

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

• operationId adminGetPayslip
• Authentication X-API-Key · scope payroll:read
• Idempotency-Key not applicable

Parameters

Responses

Example

client.admin.payroll.get_payslip()

client.admin.payroll.getPayslip()

$client->admin->payroll->getPayslip()

await client.Admin.Payroll.GetPayslipAsync()

client.Admin.Payroll.GetPayslip(ctx, …)

curl "https://sandbox.dev.compense.co/gw/v1/gateway/admin/payroll/payslips/7a2e…/" \
  -H "X-API-Key: $COMPENSE_API_KEY"

Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.

Payroll periods #

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

• operationId adminListPayrollPeriods
• Authentication X-API-Key · scope payroll:read
• Idempotency-Key not applicable

Parameters

Responses

Example

client.admin.payroll.list_periods()

client.admin.payroll.listPeriods()

$client->admin->payroll->listPeriods()

await client.Admin.Payroll.ListPeriodsAsync()

client.Admin.Payroll.ListPeriods(ctx, …)

curl "https://sandbox.dev.compense.co/gw/v1/gateway/admin/payroll/periods/" \
  -H "X-API-Key: $COMPENSE_API_KEY"

Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.

Period detail #

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

• operationId adminGetPayrollPeriod
• Authentication X-API-Key · scope payroll:read
• Idempotency-Key not applicable

Parameters

Responses

Example

client.admin.payroll.get_period()

client.admin.payroll.getPeriod()

$client->admin->payroll->getPeriod()

await client.Admin.Payroll.GetPeriodAsync()

client.Admin.Payroll.GetPeriod(ctx, …)

curl "https://sandbox.dev.compense.co/gw/v1/gateway/admin/payroll/periods/3f1c…/" \
  -H "X-API-Key: $COMPENSE_API_KEY"

Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.

Payslips for a period #

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

• operationId adminListPeriodPayslips
• Authentication X-API-Key · scope payroll:read
• Idempotency-Key not applicable

Parameters

Responses

Example

client.admin.payroll.list_period_payslips()

client.admin.payroll.listPeriodPayslips()

$client->admin->payroll->listPeriodPayslips()

await client.Admin.Payroll.ListPeriodPayslipsAsync()

client.Admin.Payroll.ListPeriodPayslips(ctx, …)

curl "https://sandbox.dev.compense.co/gw/v1/gateway/admin/payroll/periods/3f1c…/payslips/" \
  -H "X-API-Key: $COMPENSE_API_KEY"

Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.

Register a DRAFT outgoing payment #

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

• operationId adminCreatePayment
• Authentication X-API-Key · scope treasury:write
• Idempotency-Key recommended (the SDK generates it)

Parameters

Request body

Content type: application/json · required

Schema AdminTreasuryDocIn — Collection / outgoing payment (third_party, bank_account id or number, date, amount, method, reference, applications) or billing statement (third_party, issue_date, description, income_account, subtotal, iva_concept). Always in DRAFT.

Accepts additional fields (additionalProperties): they're forwarded to the engine unchanged.

Responses

Example

client.admin.treasury.create_payment()

client.admin.treasury.createPayment()

$client->admin->treasury->createPayment()

await client.Admin.Treasury.CreatePaymentAsync()

client.Admin.Treasury.CreatePayment(ctx, …)

curl -X POST "https://sandbox.dev.compense.co/gw/v1/gateway/admin/treasury/payments/" \
  -H "X-API-Key: $COMPENSE_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "third_party": "<third_party>",
    "method": "TRANSFERENCIA"
  }'

Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.

Register a DRAFT collection #

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

• operationId adminCreateReceipt
• Authentication X-API-Key · scope treasury:write
• Idempotency-Key recommended (the SDK generates it)

Parameters

Request body

Content type: application/json · required

Schema AdminTreasuryDocIn — Collection / outgoing payment (third_party, bank_account id or number, date, amount, method, reference, applications) or billing statement (third_party, issue_date, description, income_account, subtotal, iva_concept). Always in DRAFT.

Accepts additional fields (additionalProperties): they're forwarded to the engine unchanged.

Responses

Example

client.admin.treasury.create_receipt()

client.admin.treasury.createReceipt()

$client->admin->treasury->createReceipt()

await client.Admin.Treasury.CreateReceiptAsync()

client.Admin.Treasury.CreateReceipt(ctx, …)

curl -X POST "https://sandbox.dev.compense.co/gw/v1/gateway/admin/treasury/receipts/" \
  -H "X-API-Key: $COMPENSE_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "third_party": "<third_party>",
    "method": "TRANSFERENCIA"
  }'

Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.

Register a DRAFT billing statement (cuenta de cobro) #

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

• operationId adminCreateReceivable
• Authentication X-API-Key · scope treasury:write
• Idempotency-Key recommended (the SDK generates it)

Parameters

Request body

Content type: application/json · required

Schema AdminTreasuryDocIn — Collection / outgoing payment (third_party, bank_account id or number, date, amount, method, reference, applications) or billing statement (third_party, issue_date, description, income_account, subtotal, iva_concept). Always in DRAFT.

Accepts additional fields (additionalProperties): they're forwarded to the engine unchanged.

Responses

Example

client.admin.treasury.create_receivable()

client.admin.treasury.createReceivable()

$client->admin->treasury->createReceivable()

await client.Admin.Treasury.CreateReceivableAsync()

client.Admin.Treasury.CreateReceivable(ctx, …)

curl -X POST "https://sandbox.dev.compense.co/gw/v1/gateway/admin/treasury/receivables/" \
  -H "X-API-Key: $COMPENSE_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "third_party": "<third_party>",
    "method": "TRANSFERENCIA"
  }'

Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.

Upload a bank statement for reconciliation #

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

• operationId adminImportStatement
• Authentication X-API-Key · scope treasury:write
• Idempotency-Key recommended (the SDK generates it)

Parameters

Request body

Content type: application/json · required

Schema AdminStatementIn — Bank statement: lines (JSON) or content (CSV with date and amount).

Accepts additional fields (additionalProperties): they're forwarded to the engine unchanged.

Responses

Example

client.admin.treasury.import_statement()

client.admin.treasury.importStatement()

$client->admin->treasury->importStatement()

await client.Admin.Treasury.ImportStatementAsync()

client.Admin.Treasury.ImportStatement(ctx, …)

curl -X POST "https://sandbox.dev.compense.co/gw/v1/gateway/admin/treasury/statements/" \
  -H "X-API-Key: $COMPENSE_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "bank_account": "<bank_account>"
  }'

Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.

Automatic statement matching #

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

• operationId adminAutoMatchStatement
• Authentication X-API-Key · scope treasury:write
• Idempotency-Key recommended (the SDK generates it)

Parameters

Responses

Example

client.admin.treasury.auto_match_statement()

client.admin.treasury.autoMatchStatement()

$client->admin->treasury->autoMatchStatement()

await client.Admin.Treasury.AutoMatchStatementAsync()

client.Admin.Treasury.AutoMatchStatement(ctx, …)

curl -X POST "https://sandbox.dev.compense.co/gw/v1/gateway/admin/treasury/statements/8b1f…/auto-match/" \
  -H "X-API-Key: $COMPENSE_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

Each SDK's methods come from its contract parity suite. The cURL runs against the sandbox; <field> values are placeholders.