Reference
Queries#
payRun#
Requires: scope pay_runs:read · feature payroll.
payRun(id: ID!): PayRun!
| Argument | Type | |
|---|---|---|
id | ID! | The id of the record to find. |
payRuns#
Requires: scope pay_runs:read · feature payroll.
payRuns(paging: CursorPaging!, filter: PayRunFilter!, sorting: [PayRunSort!]!): PayRunConnection!
| Argument | Type | |
|---|---|---|
paging | CursorPaging! | Limit or page results. |
filter | PayRunFilter! | Specify to filter the records returned. |
sorting | [PayRunSort!]! | Specify to sort results. |
payRunEmploymentInput#
Requires: scope pay_runs:read · feature payroll.
payRunEmploymentInput(id: ID!): PayRunEmploymentInput!
| Argument | Type | |
|---|---|---|
id | ID! | The id of the record to find. |
payRunEmploymentInputs#
Requires: scope pay_runs:read · feature payroll.
payRunEmploymentInputs(paging: CursorPaging!, filter: PayRunEmploymentInputFilter!, sorting: [PayRunEmploymentInputSort!]!): PayRunEmploymentInputConnection!
| Argument | Type | |
|---|---|---|
paging | CursorPaging! | Limit or page results. |
filter | PayRunEmploymentInputFilter! | Specify to filter the records returned. |
sorting | [PayRunEmploymentInputSort!]! | Specify to sort results. |
payRunInclusion#
Requires: scope pay_runs:read · feature payroll.
payRunInclusion(payRunId: ID!): PayRunInclusionPreview!
| Argument | Type | |
|---|---|---|
payRunId | ID! |
payRunDriveFolderPath#
Requires: scope pay_runs:read · feature payroll.
payRunDriveFolderPath(payRunId: ID!): String
| Argument | Type | |
|---|---|---|
payRunId | ID! |
payRunJournalPdf#
Loonjournaalpost PDF for an approved+ pay run (base64). Same memorial as payRunMemorialJournal.
Requires: scope pay_runs:read · feature payroll.
payRunJournalPdf(payRunId: ID!): String!
| Argument | Type | |
|---|---|---|
payRunId | ID! |
payRunJournalCsv#
Loonjournaalpost CSV for an approved+ pay run. Same memorial as payRunMemorialJournal.
Requires: scope pay_runs:read · feature payroll.
payRunJournalCsv(payRunId: ID!): PaymentBatchExport!
| Argument | Type | |
|---|---|---|
payRunId | ID! |
payRunContractsCsv#
Overzicht van contracten CSV — employments active in the pay period.
Requires: scope pay_runs:read · feature payroll.
payRunContractsCsv(payRunId: ID!): PaymentBatchExport!
| Argument | Type | |
|---|---|---|
payRunId | ID! |
payRunLoonstaatPdf#
Period loonstaat / PeriodeOverzicht PDF for a calculated+ pay run (base64).
Requires: scope pay_runs:read · feature payroll.
payRunLoonstaatPdf(payRunId: ID!): String!
| Argument | Type | |
|---|---|---|
payRunId | ID! |
payRunEmployerCumulativesPdf#
Cumulatieven werkgever / employer cumulatives PDF for a calculated+ pay run (base64).
Requires: scope pay_runs:read · feature payroll.
payRunEmployerCumulativesPdf(payRunId: ID!): String!
| Argument | Type | |
|---|---|---|
payRunId | ID! |
payRunMemorialJournal#
Virtual memorial for an approved+ pay run (preview). Financials includes the booking only after lockPayRun / finalize. Null when not postable or no legs.
Requires: scope pay_runs:read · feature payroll.
payRunMemorialJournal(payRunId: ID!): JournalBooking
| Argument | Type | |
|---|---|---|
payRunId | ID! |
Mutations#
createOnePayRun#
Requires: scope pay_runs:write · feature payroll.
createOnePayRun(profileId: ID!, input: CreatePayRunInput!): PayRun!
| Argument | Type | |
|---|---|---|
profileId | ID! | |
input | CreatePayRunInput! |
createManyPayRuns#
Requires: scope pay_runs:write · feature payroll.
createManyPayRuns(profileId: ID!, input: [CreatePayRunInput!]!): [PayRun!]!
| Argument | Type | |
|---|---|---|
profileId | ID! | |
input | [CreatePayRunInput!]! |
createOnePayRunEmploymentInput#
Requires: scope pay_runs:write · feature payroll.
createOnePayRunEmploymentInput(profileId: ID!, input: CreatePayRunEmploymentInputInput!): PayRunEmploymentInput!
| Argument | Type | |
|---|---|---|
profileId | ID! | |
input | CreatePayRunEmploymentInputInput! |
createManyPayRunEmploymentInputs#
Requires: scope pay_runs:write · feature payroll.
createManyPayRunEmploymentInputs(profileId: ID!, input: [CreatePayRunEmploymentInputInput!]!): [PayRunEmploymentInput!]!
| Argument | Type | |
|---|---|---|
profileId | ID! | |
input | [CreatePayRunEmploymentInputInput!]! |
updateOnePayRun#
Requires: scope pay_runs:write · feature payroll.
updateOnePayRun(input: UpdateOnePayRunInput!): PayRun!
| Argument | Type | |
|---|---|---|
input | UpdateOnePayRunInput! |
updateManyPayRuns#
Requires: scope pay_runs:write · feature payroll.
updateManyPayRuns(input: UpdateManyPayRunsInput!): UpdateManyResponse!
| Argument | Type | |
|---|---|---|
input | UpdateManyPayRunsInput! |
updateOnePayRunEmploymentInput#
Requires: scope pay_runs:write · feature payroll.
updateOnePayRunEmploymentInput(input: UpdateOnePayRunEmploymentInputInput!): PayRunEmploymentInput!
| Argument | Type | |
|---|---|---|
input | UpdateOnePayRunEmploymentInputInput! |
updateManyPayRunEmploymentInputs#
Requires: scope pay_runs:write · feature payroll.
updateManyPayRunEmploymentInputs(input: UpdateManyPayRunEmploymentInputsInput!): UpdateManyResponse!
| Argument | Type | |
|---|---|---|
input | UpdateManyPayRunEmploymentInputsInput! |
deleteOnePayRunEmploymentInput#
Requires: scope pay_runs:write · feature payroll.
deleteOnePayRunEmploymentInput(input: DeleteOnePayRunEmploymentInputInput!): PayRunEmploymentInputDeleteResponse!
| Argument | Type | |
|---|---|---|
input | DeleteOnePayRunEmploymentInputInput! |
deleteManyPayRunEmploymentInputs#
Requires: scope pay_runs:write · feature payroll.
deleteManyPayRunEmploymentInputs(input: DeleteManyPayRunEmploymentInputsInput!): DeleteManyResponse!
| Argument | Type | |
|---|---|---|
input | DeleteManyPayRunEmploymentInputsInput! |
calculatePayRun#
Requires: scope pay_runs:write · feature payroll.
calculatePayRun(id: ID!): CalculatePayRunPayload!
| Argument | Type | |
|---|---|---|
id | ID! |
approvePayRun#
Requires: scope pay_runs:write · feature payroll.
approvePayRun(id: ID!): PayRun!
| Argument | Type | |
|---|---|---|
id | ID! |
markPaidPayRun#
Requires: scope pay_runs:write · feature payroll.
markPaidPayRun(id: ID!): PayRun!
| Argument | Type | |
|---|---|---|
id | ID! |
markFiledPayRun#
Requires: scope pay_runs:write · feature payroll.
markFiledPayRun(id: ID!): PayRun!
| Argument | Type | |
|---|---|---|
id | ID! |
lockPayRun#
Requires: scope pay_runs:write · feature payroll.
lockPayRun(id: ID!): PayRun!
| Argument | Type | |
|---|---|---|
id | ID! |
cancelPayRun#
Requires: scope pay_runs:write · feature payroll.
cancelPayRun(id: ID!): PayRun!
| Argument | Type | |
|---|---|---|
id | ID! |
deletePayRun#
Requires: scope pay_runs:write · feature payroll.
deletePayRun(id: ID!): ID!
| Argument | Type | |
|---|---|---|
id | ID! |
correctPayRun#
Requires: scope pay_runs:write · feature payroll.
correctPayRun(id: ID!): PayRun!
| Argument | Type | |
|---|---|---|
id | ID! |
createPayrollUpaFilingFromPayRun#
Requires: scope pay_runs:write · feature payroll.
createPayrollUpaFilingFromPayRun(payRunId: ID!): TAXFiling!
| Argument | Type | |
|---|---|---|
payRunId | ID! |