Schemas
OnboardingChecklistItem
keymodestatusrequiredresolutionnoteevidenceverifiedByverifiedAtOnboardingResponse
onboardingIdtenantIdNumeric PayrollEngine tenant id used in subsequent public API paths.
tenantIdentifierStable human-readable PayrollEngine tenant identifier.
siret^[0-9]{14}$ · requireddisplayNamestatedeadlineDayemployeeIduserIddivisionIdpayrollIdpayrunIdcreatedAtblockingItemspartnerIdfailedStepfailureReasonrejectedReasonactivatedAtslaerrormessagePayrollResultSummary
schemaVersionresultSetIdcurrencypayrollIdpayrunIdpayrunJobIdemployeeIddivisionIdUser
idUnique identifier
identifierfirstNamelastNamecultureuserTypeCustom attributes
statusThe object status
createdupdatedUserCreate
identifierUnique identifier for the user (typically email)
firstNameUser's first name
lastNameUser's last name
cultureUser's culture/locale (e.g., fr-FR, en-US)
userTypeThe type of user
Employee
idUnique identifier
identifierfirstNamelastNameculturecalendarCalendar name
divisionsCustom attributes
statusThe object status
createdupdatedEmployeeCreate
identifierUnique identifier for the employee (typically email)
firstNameEmployee's first name
lastNameEmployee's last name
cultureEmployee's culture/locale (e.g., fr-FR, en-US)
divisionsDivision names to assign the employee to
Division
idUnique identifier
nameDivision name
Localized division names
culturecalendarCalendar name
Custom attributes
statusThe object status
createdupdatedCaseValue
caseFieldNameidstatusThe object status
createdupdateddivisionIdThe division identifier
employeeIdThe employee identifier
caseNameThe case name this value belongs to
Localized case names
Localized case field names
caseSlotLocalized case slot names
valueTypeThe payroll value types for cases
valuenumericValuecultureCulture/locale of the case value
Relationship to parent/related case
cancellationDatestartendforecasttagsValueType
The payroll value types for cases
DsnPeriod
yearDeclaration year
monthDeclaration month (1-12)
DsnMonthlyRequest
employeeIdOptional employee identifier to restrict the declaration to a single individual
DsnAmorcageRequest
DsnAnomaly
codeDSN-VAL control identifier
severityAnomaly severity
blocNEODeS bloc concerned (e.g. S21.G00.40)
rubriqueNEODeS rubrique concerned
messageHuman-readable description of the anomaly
DsnValidationResult
conformantTrue when no blocking anomaly was found (definition of done: zero anomalies)
DsnDeclaration
declarationIdUnique declaration identifier
typeDeclaration type
statusCurrent declaration status
submittedAtDsnStatus
declarationIdstatesimulatedTrue only for the deterministic partner-sandbox channel.
depotIdmessageDsnCrmResult
declarationIdList of comptes-rendus métier emitted by the receiving organisms
DsnImportResult
normDetected NEODeS norm version (e.g. CT2026.1.2)
Declarations parsed from the file
Payroll
idUnique identifier
namePayroll name
Localized payroll names
descriptiondivisionIdstatusThe object status
createdupdatedCase
caseTypeThe case type
nameidstatusThe object status
createdupdateddescriptionhiddenclustersCaseValueSetup
caseFieldNameidcaseSlotvalueTypeThe payroll value types for cases
valuenumericValuestartendforecasttagsCaseChangeSetup
userIdemployeeIddivisionIdcancellationIdforecastcreatedreasonCaseChange
userIdidstatusThe object status
createdupdatedemployeeIddivisionIdcancellationTypeThe case cancellation type
cancellationIdcancellationDatereasonforecastPayrun
nameidstatusThe object status
createdupdatedpayrollIddefaultReasonDefault reason for payrun jobs
retroTimeTypeThe retro pay time type
PayrunJobInvocation
payrunNameExact payrun name returned by GET /payruns
userIdentifierExact user identifier returned by GET /users
nameperiodStartreasonidpayrunJobIdparentJobIdownertagsforecastretroPayModeThe payrun retro pay mode
jobResultThe payrun job result
evaluationDatestoreEmptyResultslogLevelSpecifies the meaning and relative importance of a log event
employeeIdentifiersPayrunJob
namepayrunIdpayrollIdcreatedUserIdcycleNamecycleStartcycleEndperiodNameperiodStartperiodEndevaluationDatecreatedReasonjobStartidstatusThe object status
createdupdatedownerdivisionIdparentJobIdreleasedUserIdprocessedUserIdfinishedUserIdretroPayModeThe payrun retro pay mode
jobStatusThe payrun job status
jobResultThe payrun job result
tagsforecastculturereleasedprocessedfinishedreleasedReasonprocessedReasonfinishedReasontotalEmployeeCountprocessedEmployeeCountjobEndmessageerrorMessageEmployee details included in the payrun job
PayrollResult
idUnique identifier
payrollIdpayrunIdpayrunJobIdemployeeIddivisionIdcycleNameThe payroll cycle name (e.g., '2025')
cycleStartcycleEndperiodNameThe payroll period name (e.g., '2025-01')
periodStartperiodEndstatusThe object status
createdupdatedPayrollResultSet
payrollIdpayrunJobIdemployeeIddivisionIdcycleNamecycleStartcycleEndperiodNameperiodStartidstatusThe object status
createdupdatedpayrunIdperiodEndWageTypeResultSet
wageTypeIdwageTypeNumberwageTypeNamevaluestartendidstatusThe object status
payrollResultIdvalueTypeThe payroll value types for cases
culturetagsCollectorResultSet
collectorIdcollectorNamecollectModeThe collect mode
negatedvalueTypeThe payroll value types for cases
valuestartendidstatusThe object status
payrollResultIdculturetagsPayrunResult
sourcenamevalueTypeThe payroll value types for cases
valuestartendidstatusThe object status
payrollResultIdslotculturenumericValuetagsPayrunJobStatus
The payrun job status
LogLevel
Specifies the meaning and relative importance of a log event
WageTypeDefinition
idstatusThe object status
createdupdatedwageTypeNumbernamedescriptionStatic metadata: category, rate references, ceiling references
Lookup
idstatusThe object status
createdupdatednamedescriptionLookupValue
idstatusThe object status
createdupdatedkeyLookup entry key (e.g., 'vieillesse_plafonnee_salarial')
valueTop-level value string (e.g., '0.069')
rangeValuedescriptionMonthlyFromPayrunRequest
employeeIdyearmonthresultSetIdOptional exact result-set ID returned by payrollresults/sets?payrunJobId=... . Recommended after every recalculation so DSN operations cannot read an older same-period result while indexes converge. The set must belong to the requested employee and period.
userIdstrictAccepted for request compatibility. The control endpoint always forces strict mode.
DsnBuildFromPayrunResponse
tenantIdemployeeIdperiod^\d{4}-(0[1-9]|1[0-2… · requiredcotisationSourcecotisationCountpayrollResultIdwarningsvalidrubriqueCountcontentGenerated NEODeS flat file. This build endpoint does not submit it.
DsnDiagnosticSource
managedBypartner when a PayrollEngine Case correction is known; verso for support-managed diagnostics.
guidancecaseNamePayrollEngine Case name to update.
fieldField within the Case JSON payload, when the rubrique maps unambiguously.
slotPayrollEngine CaseSlot when it can be derived from the source diagnostic.
DsnDiagnostic
categoryscopecodemessagerubriquelibellevaleurlignesalarieDsnControlResponse
tenantIdstatusvalidreportIdOpaque archived official-control report id; null when no report was produced or archiving failed.
periodcotisationSourcepayrollResultIdwarningserrormessageengineblockingnonBlockingDsnPaymentPreviewLine
opsidentifiantOpsmodemontantblocEmittedDsnPaymentPreviewResponse
statusvalidreportIdAlways null: payment preview does not run the official control engine.
periodtotalMontantwarningsDsnMonthlyFromPayrunTransmitRequest
employeeIdyearmonthresultSetIdOptional exact result-set ID returned by payrollresults/sets?payrunJobId=... . Recommended after every recalculation so transmission cannot read an older same-period result while indexes converge. The set must belong to the requested employee and period.
userIddeclarationTypeallowSkippedControlExceptional override. The Indy sandbox normally runs the configured control engine.
DsnTransmitResponse
simulatedCurrent state derived from the AEE, certificat/BAN, BIS and CRM return stream.
DsnReturnsResponse
tenantIddepotIdsimulatedstatearchived