Reference
Queries#
payrollEmployerSettings#
Requires: scope payroll:read · feature payroll.
payrollEmployerSettings(paging: CursorPaging!, filter: PayrollEmployerSettingsFilter!, sorting: [PayrollEmployerSettingsSort!]!): PayrollEmployerSettingsConnection!
| Argument | Type | |
|---|---|---|
paging | CursorPaging! | Limit or page results. |
filter | PayrollEmployerSettingsFilter! | Specify to filter the records returned. |
sorting | [PayrollEmployerSettingsSort!]! | Specify to sort results. |
nlPayrollEmployerSettings#
Requires: scope payroll:read · feature payroll.
nlPayrollEmployerSettings(paging: CursorPaging!, filter: NlPayrollEmployerSettingsFilter!, sorting: [NlPayrollEmployerSettingsSort!]!): NlPayrollEmployerSettingsConnection!
| Argument | Type | |
|---|---|---|
paging | CursorPaging! | Limit or page results. |
filter | NlPayrollEmployerSettingsFilter! | Specify to filter the records returned. |
sorting | [NlPayrollEmployerSettingsSort!]! | Specify to sort results. |
vehiclePayrollAttrs#
Requires: scope payroll:read · feature vehicles.
vehiclePayrollAttrs(paging: CursorPaging!, filter: VehiclePayrollAttrsFilter!, sorting: [VehiclePayrollAttrsSort!]!): VehiclePayrollAttrsConnection!
| Argument | Type | |
|---|---|---|
paging | CursorPaging! | Limit or page results. |
filter | VehiclePayrollAttrsFilter! | Specify to filter the records returned. |
sorting | [VehiclePayrollAttrsSort!]! | Specify to sort results. |
payrollDeliveryLog#
Requires: scope payroll:read · feature payroll.
payrollDeliveryLog(profileId: ID!, limit: Int): [PayrollDeliveryLogEntry!]!
| Argument | Type | |
|---|---|---|
profileId | ID! | |
limit | Int |
myPayslips#
The finalised payslips of the employee the session is bound to, newest first.
Requires: scope payroll:read · feature employee_self_service.
myPayslips(profileId: ID!): [MyPayslip!]!
| Argument | Type | |
|---|---|---|
profileId | ID! |
myPayslipPdf#
The PDF (base64) of one of the employee's own finalised payslips.
Requires: scope payroll:read · feature employee_self_service.
myPayslipPdf(id: ID!): String!
| Argument | Type | |
|---|---|---|
id | ID! |
myYearDocuments#
The annual statements (jaaropgaaf) of the employee the session is bound to.
Requires: scope payroll:read · feature employee_self_service.
myYearDocuments(profileId: ID!): [MyYearDocument!]!
| Argument | Type | |
|---|---|---|
profileId | ID! |
myYearDocumentPdf#
The PDF (base64) of one of the employee's own annual statements.
Requires: scope payroll:read · feature employee_self_service.
myYearDocumentPdf(id: ID!): String!
| Argument | Type | |
|---|---|---|
id | ID! |
payrollYtdImport#
Requires: scope payroll:read · feature payroll.
payrollYtdImport(id: ID!): PayrollYtdImport!
| Argument | Type | |
|---|---|---|
id | ID! | The id of the record to find. |
payrollYtdImports#
Requires: scope payroll:read · feature payroll.
payrollYtdImports(paging: CursorPaging!, filter: PayrollYtdImportFilter!, sorting: [PayrollYtdImportSort!]!): PayrollYtdImportConnection!
| Argument | Type | |
|---|---|---|
paging | CursorPaging! | Limit or page results. |
filter | PayrollYtdImportFilter! | Specify to filter the records returned. |
sorting | [PayrollYtdImportSort!]! | Specify to sort results. |
payrollRuleKb#
Requires: scope payroll:read · feature payroll.
payrollRuleKb(ruleRef: String!, asOf: String): PayrollRuleKbEntry
| Argument | Type | |
|---|---|---|
ruleRef | String! | |
asOf | String |
payrollRuleKbEntries#
Requires: scope payroll:read · feature payroll.
payrollRuleKbEntries(asOf: String): [PayrollRuleKbEntry!]!
| Argument | Type | |
|---|---|---|
asOf | String |
payrollPeriodAuditExport#
Requires: scope payroll:read · feature payroll.
payrollPeriodAuditExport(payPeriodId: ID!): PayrollPeriodAuditExport!
| Argument | Type | |
|---|---|---|
payPeriodId | ID! |
Mutations#
setProfilePayrollAddon#
Requires: scope payroll:write · feature payroll.
setProfilePayrollAddon(profileId: ID!, enabled: Boolean!): ProfileSubscription!
| Argument | Type | |
|---|---|---|
profileId | ID! | |
enabled | Boolean! |
setBookkeeperPayrollModule#
Turn the firm payroll module (€75 / month) on or off. Needed before any client can be set to bookkeeping + payroll or payroll only.
Requires: scope payroll:write · feature payroll.
setBookkeeperPayrollModule(bookkeeperId: ID!, enabled: Boolean!): BookkeeperSubscription!
| Argument | Type | |
|---|---|---|
bookkeeperId | ID! | |
enabled | Boolean! |
createOnePayrollEmployerSettings#
Requires: scope payroll:write · feature payroll.
createOnePayrollEmployerSettings(profileId: ID!, input: CreatePayrollEmployerSettingsInput!): PayrollEmployerSettings!
| Argument | Type | |
|---|---|---|
profileId | ID! | |
input | CreatePayrollEmployerSettingsInput! |
createManyPayrollEmployerSettings#
Requires: scope payroll:write · feature payroll.
createManyPayrollEmployerSettings(profileId: ID!, input: [CreatePayrollEmployerSettingsInput!]!): [PayrollEmployerSettings!]!
| Argument | Type | |
|---|---|---|
profileId | ID! | |
input | [CreatePayrollEmployerSettingsInput!]! |
createOneNlPayrollEmployerSettings#
Requires: scope payroll:write · feature payroll.
createOneNlPayrollEmployerSettings(profileId: ID!, input: CreateNlPayrollEmployerSettingsInput!): NlPayrollEmployerSettings!
| Argument | Type | |
|---|---|---|
profileId | ID! | |
input | CreateNlPayrollEmployerSettingsInput! |
createManyNlPayrollEmployerSettings#
Requires: scope payroll:write · feature payroll.
createManyNlPayrollEmployerSettings(profileId: ID!, input: [CreateNlPayrollEmployerSettingsInput!]!): [NlPayrollEmployerSettings!]!
| Argument | Type | |
|---|---|---|
profileId | ID! | |
input | [CreateNlPayrollEmployerSettingsInput!]! |
createOneVehiclePayrollAttrs#
Requires: scope payroll:write · feature vehicles.
createOneVehiclePayrollAttrs(profileId: ID!, input: CreateVehiclePayrollAttrsInput!): VehiclePayrollAttrs!
| Argument | Type | |
|---|---|---|
profileId | ID! | |
input | CreateVehiclePayrollAttrsInput! |
createManyVehiclePayrollAttrs#
Requires: scope payroll:write · feature vehicles.
createManyVehiclePayrollAttrs(profileId: ID!, input: [CreateVehiclePayrollAttrsInput!]!): [VehiclePayrollAttrs!]!
| Argument | Type | |
|---|---|---|
profileId | ID! | |
input | [CreateVehiclePayrollAttrsInput!]! |
updateOnePayrollEmployerSettings#
Requires: scope payroll:write · feature payroll.
updateOnePayrollEmployerSettings(input: UpdateOnePayrollEmployerSettingsInput!): PayrollEmployerSettings!
| Argument | Type | |
|---|---|---|
input | UpdateOnePayrollEmployerSettingsInput! |
updateManyPayrollEmployerSettings#
Requires: scope payroll:write · feature payroll.
updateManyPayrollEmployerSettings(input: UpdateManyPayrollEmployerSettingsInput!): UpdateManyResponse!
| Argument | Type | |
|---|---|---|
input | UpdateManyPayrollEmployerSettingsInput! |
deleteOnePayrollEmployerSettings#
Requires: scope payroll:write · feature payroll.
deleteOnePayrollEmployerSettings(input: DeleteOnePayrollEmployerSettingsInput!): PayrollEmployerSettingsDeleteResponse!
| Argument | Type | |
|---|---|---|
input | DeleteOnePayrollEmployerSettingsInput! |
deleteManyPayrollEmployerSettings#
Requires: scope payroll:write · feature payroll.
deleteManyPayrollEmployerSettings(input: DeleteManyPayrollEmployerSettingsInput!): DeleteManyResponse!
| Argument | Type | |
|---|---|---|
input | DeleteManyPayrollEmployerSettingsInput! |
updateOneNlPayrollEmployerSettings#
Requires: scope payroll:write · feature payroll.
updateOneNlPayrollEmployerSettings(input: UpdateOneNlPayrollEmployerSettingsInput!): NlPayrollEmployerSettings!
| Argument | Type | |
|---|---|---|
input | UpdateOneNlPayrollEmployerSettingsInput! |
updateManyNlPayrollEmployerSettings#
Requires: scope payroll:write · feature payroll.
updateManyNlPayrollEmployerSettings(input: UpdateManyNlPayrollEmployerSettingsInput!): UpdateManyResponse!
| Argument | Type | |
|---|---|---|
input | UpdateManyNlPayrollEmployerSettingsInput! |
deleteOneNlPayrollEmployerSettings#
Requires: scope payroll:write · feature payroll.
deleteOneNlPayrollEmployerSettings(input: DeleteOneNlPayrollEmployerSettingsInput!): NlPayrollEmployerSettingsDeleteResponse!
| Argument | Type | |
|---|---|---|
input | DeleteOneNlPayrollEmployerSettingsInput! |
deleteManyNlPayrollEmployerSettings#
Requires: scope payroll:write · feature payroll.
deleteManyNlPayrollEmployerSettings(input: DeleteManyNlPayrollEmployerSettingsInput!): DeleteManyResponse!
| Argument | Type | |
|---|---|---|
input | DeleteManyNlPayrollEmployerSettingsInput! |
updateOneVehiclePayrollAttrs#
Requires: scope payroll:write · feature vehicles.
updateOneVehiclePayrollAttrs(input: UpdateOneVehiclePayrollAttrsInput!): VehiclePayrollAttrs!
| Argument | Type | |
|---|---|---|
input | UpdateOneVehiclePayrollAttrsInput! |
updateManyVehiclePayrollAttrs#
Requires: scope payroll:write · feature vehicles.
updateManyVehiclePayrollAttrs(input: UpdateManyVehiclePayrollAttrsInput!): UpdateManyResponse!
| Argument | Type | |
|---|---|---|
input | UpdateManyVehiclePayrollAttrsInput! |
deleteOneVehiclePayrollAttrs#
Requires: scope payroll:write · feature vehicles.
deleteOneVehiclePayrollAttrs(input: DeleteOneVehiclePayrollAttrsInput!): VehiclePayrollAttrsDeleteResponse!
| Argument | Type | |
|---|---|---|
input | DeleteOneVehiclePayrollAttrsInput! |
deleteManyVehiclePayrollAttrs#
Requires: scope payroll:write · feature vehicles.
deleteManyVehiclePayrollAttrs(input: DeleteManyVehiclePayrollAttrsInput!): DeleteManyResponse!
| Argument | Type | |
|---|---|---|
input | DeleteManyVehiclePayrollAttrsInput! |
createOnePayrollYtdImport#
Requires: scope payroll:write · feature payroll.
createOnePayrollYtdImport(profileId: ID!, input: CreatePayrollYtdImportInput!): PayrollYtdImport!
| Argument | Type | |
|---|---|---|
profileId | ID! | |
input | CreatePayrollYtdImportInput! |
createManyPayrollYtdImports#
Requires: scope payroll:write · feature payroll.
createManyPayrollYtdImports(profileId: ID!, input: [CreatePayrollYtdImportInput!]!): [PayrollYtdImport!]!
| Argument | Type | |
|---|---|---|
profileId | ID! | |
input | [CreatePayrollYtdImportInput!]! |
submitPayrollUpaFiling#
Requires: scope payroll:write · feature payroll.
submitPayrollUpaFiling(id: ID!): TAXFiling!
| Argument | Type | |
|---|---|---|
id | ID! |
createPayrollUpaFilingCorrection#
Requires: scope payroll:write · feature payroll.
createPayrollUpaFilingCorrection(correctsFilingId: ID!): TAXFiling!
| Argument | Type | |
|---|---|---|
correctsFilingId | ID! |