Reference
Queries#
settlementAttachment#
Requires: scope settlements:read · feature settlements.
settlementAttachment(id: ID!): SettlementAttachment!
| Argument | Type | |
|---|---|---|
id | ID! |
settlement#
Requires: scope settlements:read · feature settlements.
settlement(id: ID!): Settlement!
| Argument | Type | |
|---|---|---|
id | ID! | The id of the record to find. |
settlements#
Requires: scope settlements:read · feature settlements.
settlements(paging: CursorPaging!, filter: SettlementFilter!, sorting: [SettlementSort!]!): SettlementConnection!
| Argument | Type | |
|---|---|---|
paging | CursorPaging! | Limit or page results. |
filter | SettlementFilter! | Specify to filter the records returned. |
sorting | [SettlementSort!]! | Specify to sort results. |
Mutations#
createOneSettlementAttachment#
Requires: scope settlements:write · feature settlements.
createOneSettlementAttachment(settlementId: ID!, input: CreateSettlementAttachmentInput!): SettlementAttachment!
| Argument | Type | |
|---|---|---|
settlementId | ID! | |
input | CreateSettlementAttachmentInput! |
deleteOneSettlementAttachment#
Requires: scope settlements:write · feature settlements.
deleteOneSettlementAttachment(input: DeleteOneSettlementAttachmentInput!): SettlementAttachment!
| Argument | Type | |
|---|---|---|
input | DeleteOneSettlementAttachmentInput! |
createSettlement#
Requires: scope settlements:write · feature settlements.
createSettlement(input: CreateSettlementBatchInput!, profileId: String!): Settlement!
| Argument | Type | |
|---|---|---|
input | CreateSettlementBatchInput! | |
profileId | String! |
createSettlementFromPayment#
Requires: scope settlements:write · feature settlements.
createSettlementFromPayment(input: CreateSettlementFromPaymentInput!, profileId: String!): Settlement!
| Argument | Type | |
|---|---|---|
input | CreateSettlementFromPaymentInput! | |
profileId | String! |
updateSettlement#
Requires: scope settlements:write · feature settlements.
updateSettlement(input: UpdateSettlementBatchInput!, profileId: String!): Settlement!
| Argument | Type | |
|---|---|---|
input | UpdateSettlementBatchInput! | |
profileId | String! |
deleteOneSettlement#
Requires: scope settlements:write · feature settlements.
deleteOneSettlement(input: DeleteOneSettlementInput!): SettlementDeleteResponse!
| Argument | Type | |
|---|---|---|
input | DeleteOneSettlementInput! |
createOneSettlement#
Requires: scope settlements:write · feature settlements.
createOneSettlement(profileId: ID!, input: CreateSettlementInput!): Settlement!
| Argument | Type | |
|---|---|---|
profileId | ID! | |
input | CreateSettlementInput! |
createManySettlements#
Requires: scope settlements:write · feature settlements.
createManySettlements(profileId: ID!, input: [CreateSettlementInput!]!): [Settlement!]!
| Argument | Type | |
|---|---|---|
profileId | ID! | |
input | [CreateSettlementInput!]! |
updateOneSettlement#
Requires: scope settlements:write · feature settlements.
updateOneSettlement(input: UpdateOneSettlementInput!): Settlement!
| Argument | Type | |
|---|---|---|
input | UpdateOneSettlementInput! |
updateManySettlements#
Requires: scope settlements:write · feature settlements.
updateManySettlements(input: UpdateManySettlementsInput!): UpdateManyResponse!
| Argument | Type | |
|---|---|---|
input | UpdateManySettlementsInput! |