Verso Sandbox API
string · requiredstringstringstringstring · enuminteger · int32stringstringstringstringstringstring · enumstring · requiredstringstringstringstring[]integer · int32stringstringstringstringstring[]string · enuminteger · int32stringstringstring · enuminteger · int32stringinteger · int32string · enuminteger · int32integer · int32integer · int32integer · int32integer · int32integer · int32string · date-timestring · date-timestring · enumstring · enum · requiredstring · maxLength: 128 · requiredinteger · int32string · enumstring · date-timestring · date-timestringbooleanstring[]string · maxLength: 128 · requiredinteger · int32string · maxLength: 128string · enumstringnumber · doublestring · date-timestring · date-timestring · maxLength: 128string[]integer · int32 · requiredinteger · int32integer · int32integer · int32stringstring · date-timestringinteger · int32 · requiredinteger · int32string · enumstring · date-timestring · date-timeinteger · int32integer · int32string · enuminteger · int32string · date-timestringstringstring · maxLength: 128 · requiredinteger · int32string · enumstring · date-timestring · date-timestring · maxLength: 128string · maxLength: 128string · enumstringnumber · doublestring · date-timestring · date-timestring · maxLength: 128string[]integer · int32 · requiredinteger · int32 · requiredstring · requiredstring · date-time · requiredstring · requiredinteger · int32integer · int32integer · int32stringstring[]stringstring · enumstring · enumstring · date-timebooleanstring · enumstring[]string · maxLength: 128 · requiredinteger · int32 · requiredinteger · int32 · requiredinteger · int32 · requiredstring · requiredstring · date-time · requiredstring · date-time · requiredstring · requiredstring · date-time · requiredstring · date-time · requiredstring · date-time · requiredstring · requiredstring · date-time · requiredinteger · int32string · enumstring · date-timestring · date-timestringinteger · int32integer · int32integer · int32integer · int32integer · int32string · enumstring · enumstring · enumstring[]string · maxLength: 128stringstring · date-timestring · date-timestring · date-timestringstringstringinteger · int32integer · int32string · date-timestringstringinteger · int32 · requiredinteger · int32 · requiredinteger · int32 · requiredinteger · int32 · requiredstring · requiredstring · date-time · requiredstring · date-time · requiredstring · requiredstring · date-time · requiredinteger · int32string · enumstring · date-timestring · date-timeinteger · int32string · date-timeinteger · int32 · requirednumber · double · requiredstring · requirednumber · double · requiredstring · date-time · requiredstring · date-time · requiredinteger · int32string · enuminteger · int32string · enumstringstring[]integer · int32 · requiredstring · requiredstring · enum · requiredboolean · requiredstring · enum · requirednumber · double · requiredstring · date-time · requiredstring · date-time · requiredinteger · int32string · enuminteger · int32stringstring[]string · requiredstring · requiredstring · enum · requiredstring · requiredstring · date-time · requiredstring · date-time · requiredinteger · int32string · enuminteger · int32stringstringnumber · doublestring[]
UserCreate
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
Enum values:
User
Supervisor
Administrator
User
idUnique identifier
identifierfirstNamelastNamecultureuserTypestatusThe object status
Enum values:
Active
Inactive
EmployeeCreate
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
Employee
idUnique identifier
identifierfirstNamelastNameculturedivisionsstatusThe object status
Enum values:
Active
Inactive
Division
idUnique identifier
nameDivision name
culturestatusThe object status
Enum values:
Active
Inactive
Payroll
idUnique identifier
namePayroll name
divisionIdstatusThe object status
Enum values:
Active
Inactive
PayrollResult
idUnique identifier
payrollIdpayrunIdpayrunJobIdemployeeIddivisionIdperiodStartperiodEndstatusThe object status
Enum values:
Active
Inactive
ValueType
string · enum
Enum values:
String
Boolean
Integer
NumericBoolean
Decimal
DateTime
None
Date
The payroll value types for cases
PayrunJobStatus
string · enum
Enum values:
Draft
Release
Process
Complete
Forecast
Abort
Cancel
The payrun job status
LogLevel
string · enum
Enum values:
Verbose
Debug
Information
Warning
Error
Fatal
Specifies the meaning and relative importance of a log event
Case
caseTypeThe case type
Enum values:
Global
National
Company
Employee
nameidstatusThe object status
Enum values:
Active
Inactive
createdupdatedobject
descriptionobject
hiddenobject
clustersCaseValueSetup
caseFieldNameidcaseSlotvalueTypeThe payroll value types for cases
Enum values:
String
Boolean
Integer
NumericBoolean
Decimal
DateTime
None
Date
valuenumericValuestartendforecasttagsobject
CaseChangeSetup
userIdobject · required
employeeIddivisionIdcancellationIdforecastcreatedreasonCaseChange
userIdidstatusThe object status
Enum values:
Active
Inactive
createdupdatedemployeeIddivisionIdcancellationTypeThe case cancellation type
Enum values:
None
Case
cancellationIdcancellationDatereasonforecastobject[]
CaseValue
caseFieldNameidstatusThe object status
Enum values:
Active
Inactive
createdupdatedcaseNamecaseSlotvalueTypeThe payroll value types for cases
Enum values:
String
Boolean
Integer
NumericBoolean
Decimal
DateTime
None
Date
valuenumericValuestartendforecasttagsobject
PayrunJobInvocation
payrunIduserIdnameperiodStartreasonidpayrunJobIdparentJobIdownertagsforecastretroPayModeThe payrun retro pay mode
Enum values:
None
ValueChange
jobResultThe payrun job result
Enum values:
Full
Incremental
evaluationDatestoreEmptyResultslogLevelSpecifies the meaning and relative importance of a log event
Enum values:
Verbose
Debug
Information
Warning
Error
Fatal
employeeIdentifiersobject
PayrunJob
namepayrunIdpayrollIdcreatedUserIdcycleNamecycleStartcycleEndperiodNameperiodStartperiodEndevaluationDatecreatedReasonjobStartidstatusThe object status
Enum values:
Active
Inactive
createdupdatedownerdivisionIdparentJobIdreleasedUserIdprocessedUserIdfinishedUserIdretroPayModeThe payrun retro pay mode
Enum values:
None
ValueChange
jobStatusThe payrun job status
Enum values:
Draft
Release
Process
Complete
Forecast
Abort
Cancel
jobResultThe payrun job result
Enum values:
Full
Incremental
tagsforecastculturereleasedprocessedfinishedreleasedReasonprocessedReasonfinishedReasontotalEmployeeCountprocessedEmployeeCountjobEndmessageerrorMessageobject
PayrollResultSet
payrollIdpayrunJobIdemployeeIddivisionIdcycleNamecycleStartcycleEndperiodNameperiodStartidstatusThe object status
Enum values:
Active
Inactive
createdupdatedpayrunIdperiodEndobject[]
object[]
object[]
WageTypeResultSet
wageTypeIdwageTypeNumberwageTypeNamevaluestartendidstatusThe object status
Enum values:
Active
Inactive
payrollResultIdobject
valueTypeThe payroll value types for cases
Enum values:
String
Boolean
Integer
NumericBoolean
Decimal
DateTime
None
Date
culturetagsobject
CollectorResultSet
collectorIdcollectorNamecollectModeThe collect mode
Enum values:
Summary
Minimum
Maximum
Average
Range
Count
negatedvalueTypeThe payroll value types for cases
Enum values:
String
Boolean
Integer
NumericBoolean
Decimal
DateTime
None
Date
valuestartendidstatusThe object status
Enum values:
Active
Inactive
payrollResultIdobject
culturetagsobject
PayrunResult
sourcenamevalueTypeThe payroll value types for cases
Enum values:
String
Boolean
Integer
NumericBoolean
Decimal
DateTime
None
Date
valuestartendidstatusThe object status
Enum values:
Active
Inactive
payrollResultIdobject
slotculturenumericValuetagsobject
RemunerationCase
Remuneration case
heuresTravailleesHours worked
tauxHoraireHourly rate
FraisCase
Expenses case
nombreRepasNumber of meals
montantRepasMeal amount
indemniteKilometriqueMileage allowance
regularisationRegularization amount
PrevoyanceMutuelleCase
Insurance and mutual fund case
mutuelleObligatoireMandatory health insurance
tauxPrevoyanceWelfare rate
mutuelleFacultativeOptional health insurance
SimplifiedCaseChangeSetup
Simplified payload for creating payroll case changes. Use flat key-value sections instead of nested case/values structure.
userIdThe user identifier
employeeIdThe employee identifier
divisionIdThe division identifier
forecastThe forecast identifier
reasonReason for the case change
startShared start date for all case values (applied to every field)
object
Identity information case
object
Remuneration case
object
Expenses case
object
Withholding tax case (Prelevement A la Source)
object
Insurance and mutual fund case
SimplifiedCaseChangeResponse
Simplified response for case change operations
idThe case change identifier
userIdemployeeIddivisionIdforecastreasonstartShared start date (present if all values have the same start)
statusThe object status
Enum values:
Active
Inactive
createdupdatedobject
Identity information case
object
Remuneration case
object
Expenses case
object
Withholding tax case (Prelevement A la Source)
object
Insurance and mutual fund case