Reference
Queries#
paymentBatchPaymentRequests#
Requires: scope payment_batches:read · feature payment_batches.
paymentBatchPaymentRequests(profileId: ID!, paymentBatchId: ID!): [PaymentRequest!]!
| Argument | Type | |
|---|---|---|
profileId | ID! | |
paymentBatchId | ID! |
paymentBatchExport#
Requires: scope payment_batches:read · feature payment_batches.
paymentBatchExport(id: ID!, format: PaymentBatchExportFormat): PaymentBatchExport!
| Argument | Type | |
|---|---|---|
id | ID! | |
format | PaymentBatchExportFormat |
paymentBatch#
Requires: scope payment_batches:read · feature payment_batches.
paymentBatch(id: ID!): PaymentBatch!
| Argument | Type | |
|---|---|---|
id | ID! | The id of the record to find. |
paymentBatches#
Requires: scope payment_batches:read · feature payment_batches.
paymentBatches(paging: CursorPaging!, filter: PaymentBatchFilter!, sorting: [PaymentBatchSort!]!): PaymentBatchConnection!
| Argument | Type | |
|---|---|---|
paging | CursorPaging! | Limit or page results. |
filter | PaymentBatchFilter! | Specify to filter the records returned. |
sorting | [PaymentBatchSort!]! | Specify to sort results. |
paymentBatchLine#
Requires: scope payment_batches:read · feature payment_batches.
paymentBatchLine(id: ID!): PaymentBatchLine!
| Argument | Type | |
|---|---|---|
id | ID! | The id of the record to find. |
paymentBatchLines#
Requires: scope payment_batches:read · feature payment_batches.
paymentBatchLines(paging: CursorPaging!, filter: PaymentBatchLineFilter!, sorting: [PaymentBatchLineSort!]!): PaymentBatchLineConnection!
| Argument | Type | |
|---|---|---|
paging | CursorPaging! | Limit or page results. |
filter | PaymentBatchLineFilter! | Specify to filter the records returned. |
sorting | [PaymentBatchLineSort!]! | Specify to sort results. |
Mutations#
createPaymentBatchPaymentRequest#
Requires: scope payment_batches:write · feature payment_batches.
createPaymentBatchPaymentRequest(profileId: ID!, paymentBatchId: ID!): PaymentRequest!
| Argument | Type | |
|---|---|---|
profileId | ID! | |
paymentBatchId | ID! |
createPaymentBatchFromPayRun#
Requires: scope payment_batches:write · feature payment_batches.
createPaymentBatchFromPayRun(payRunId: ID!, debitMonetaryAccountId: ID): PaymentBatch!
| Argument | Type | |
|---|---|---|
payRunId | ID! | |
debitMonetaryAccountId | ID |
addPayRunToPaymentBatch#
Requires: scope payment_batches:write · feature payroll.
addPayRunToPaymentBatch(paymentBatchId: ID!, payRunId: ID!): PaymentBatch!
| Argument | Type | |
|---|---|---|
paymentBatchId | ID! | |
payRunId | ID! |
exportPaymentBatch#
Requires: scope payment_batches:write · feature payment_batches.
exportPaymentBatch(id: ID!, format: PaymentBatchExportFormat): PaymentBatchExport!
| Argument | Type | |
|---|---|---|
id | ID! | |
format | PaymentBatchExportFormat |
createOnePaymentBatch#
Requires: scope payment_batches:write · feature payment_batches.
createOnePaymentBatch(profileId: ID!, input: CreatePaymentBatchInput!): PaymentBatch!
| Argument | Type | |
|---|---|---|
profileId | ID! | |
input | CreatePaymentBatchInput! |
createManyPaymentBatches#
Requires: scope payment_batches:write · feature payment_batches.
createManyPaymentBatches(profileId: ID!, input: [CreatePaymentBatchInput!]!): [PaymentBatch!]!
| Argument | Type | |
|---|---|---|
profileId | ID! | |
input | [CreatePaymentBatchInput!]! |
createOnePaymentBatchLine#
Requires: scope payment_batches:write · feature payment_batches.
createOnePaymentBatchLine(paymentBatchId: ID!, input: CreatePaymentBatchLineInput!): PaymentBatchLine!
| Argument | Type | |
|---|---|---|
paymentBatchId | ID! | |
input | CreatePaymentBatchLineInput! |
createManyPaymentBatchLines#
Requires: scope payment_batches:write · feature payment_batches.
createManyPaymentBatchLines(paymentBatchId: ID!, input: [CreatePaymentBatchLineInput!]!): [PaymentBatchLine!]!
| Argument | Type | |
|---|---|---|
paymentBatchId | ID! | |
input | [CreatePaymentBatchLineInput!]! |
updateOnePaymentBatch#
Requires: scope payment_batches:write · feature payment_batches.
updateOnePaymentBatch(input: UpdateOnePaymentBatchInput!): PaymentBatch!
| Argument | Type | |
|---|---|---|
input | UpdateOnePaymentBatchInput! |
updateManyPaymentBatches#
Requires: scope payment_batches:write · feature payment_batches.
updateManyPaymentBatches(input: UpdateManyPaymentBatchesInput!): UpdateManyResponse!
| Argument | Type | |
|---|---|---|
input | UpdateManyPaymentBatchesInput! |
deleteOnePaymentBatch#
Requires: scope payment_batches:write · feature payment_batches.
deleteOnePaymentBatch(input: DeleteOnePaymentBatchInput!): PaymentBatchDeleteResponse!
| Argument | Type | |
|---|---|---|
input | DeleteOnePaymentBatchInput! |
deleteManyPaymentBatches#
Requires: scope payment_batches:write · feature payment_batches.
deleteManyPaymentBatches(input: DeleteManyPaymentBatchesInput!): DeleteManyResponse!
| Argument | Type | |
|---|---|---|
input | DeleteManyPaymentBatchesInput! |
updateOnePaymentBatchLine#
Requires: scope payment_batches:write · feature payment_batches.
updateOnePaymentBatchLine(input: UpdateOnePaymentBatchLineInput!): PaymentBatchLine!
| Argument | Type | |
|---|---|---|
input | UpdateOnePaymentBatchLineInput! |
updateManyPaymentBatchLines#
Requires: scope payment_batches:write · feature payment_batches.
updateManyPaymentBatchLines(input: UpdateManyPaymentBatchLinesInput!): UpdateManyResponse!
| Argument | Type | |
|---|---|---|
input | UpdateManyPaymentBatchLinesInput! |
deleteOnePaymentBatchLine#
Requires: scope payment_batches:write · feature payment_batches.
deleteOnePaymentBatchLine(input: DeleteOnePaymentBatchLineInput!): PaymentBatchLineDeleteResponse!
| Argument | Type | |
|---|---|---|
input | DeleteOnePaymentBatchLineInput! |
deleteManyPaymentBatchLines#
Requires: scope payment_batches:write · feature payment_batches.
deleteManyPaymentBatchLines(input: DeleteManyPaymentBatchLinesInput!): DeleteManyResponse!
| Argument | Type | |
|---|---|---|
input | DeleteManyPaymentBatchLinesInput! |