Skip to main content
GET
Retrieve a stored calculation

Authorizations

Authorization
string
header
required

API key authentication. Send your API key as: Authorization: Bearer <your_api_key>

Path Parameters

calculation_id
string
required

Calculation id (ULID).

Query Parameters

include
string | null

Set to audit_trail to include the step-by-step trace.

Response

The stored calculation.

Full single-employee payroll calculation result.

All monetary values are JSON strings. Parse with your language's Decimal library before doing any arithmetic.

id
string
required

Globally unique calculation ID (ULID). Stable and sortable by time.

Example:

"01HX9B2KM3V4W5X6Y7Z8A9B0CD"

country
string
required
scheme
string
required
year
integer
required
period
Period · object
required

Payroll period definition.

employee_id
string
required

Employee ID echoed from the request.

summary
PayrollSummary · object
required

High-level financial summary of the payroll calculation.

perceptions
PerceptionResponse · object[]
required
deductions
DeductionResponse · object[]
required
taxable_bases
TaxableBaseResponse · object[]
required
employer_contributions
EmployerContributionResponse · object[]
required
dsl_version
string
required

Version string of the DSL rule set used for this calculation.

Example:

"2024.2"

computed_at
string<date-time>
required

UTC timestamp when this calculation was performed.

status
string
default:success
Allowed value: "success"
audit_trail
Audit Trail · object[] | null

Step-by-step calculation trace. Each step shows the formula, resolved inputs, and result. Null when include_audit_trail=false.

period_basis
PeriodBasis · object | null

Which slice of a liquidated month these figures are, and what the whole month came to. Present on every calculation.

record
StoredRecord · object | null

Storage and provenance of this calculation: what rules produced it, which engine build ran, and how to verify later that it has not changed.

warnings
WarningDetail · object[]

Non-fatal diagnostics about this calculation. Every amount above already reflects the request as sent; a warning flags an input that contradicts the salary the engine used, so the caller can check it. Empty when the request is coherent.