Reference
Queries#
aiBankRules#
Requires: scope monetary_accounts:read · feature banking.
aiBankRules(profileId: ID!): [BankRuleView!]!
| Argument | Type | |
|---|---|---|
profileId | ID! |
bankRules#
The company's own rules in the order they apply, then its platform's (read only).
Requires: scope monetary_accounts:read · feature banking.
bankRules(profileId: ID!): [BankRule!]!
| Argument | Type | |
|---|---|---|
profileId | ID! |
bankRulePreview#
Recent payments a rule would book, without booking them (at most 50).
Requires: scope monetary_accounts:read · feature banking.
bankRulePreview(profileId: ID!, input: BankRuleInput!, limit: Int): [MonetaryAccountPayment!]!
| Argument | Type | |
|---|---|---|
profileId | ID! | |
input | BankRuleInput! | |
limit | Int |
bankReconciliation#
Per day, the bank's closing balance against the books for one bank account (at most 400 days).
Requires: scope monetary_accounts:read · feature banking.
bankReconciliation(profileId: ID!, monetaryAccountId: ID!, from: String!, to: String!): [ReconciliationDay!]!
| Argument | Type | |
|---|---|---|
profileId | ID! | |
monetaryAccountId | ID! | |
from | String! | YYYY-MM-DD |
to | String! | YYYY-MM-DD |
monetaryAccountSpreadsheetImportTemplate#
Requires: scope monetary_accounts:read · feature banking.
monetaryAccountSpreadsheetImportTemplate(format: SpreadsheetFormat!): SpreadsheetTemplateExport!
| Argument | Type | |
|---|---|---|
format | SpreadsheetFormat! |
monetaryAccountPayment#
Requires: scope monetary_accounts:read · feature banking.
monetaryAccountPayment(id: ID!): MonetaryAccountPayment!
| Argument | Type | |
|---|---|---|
id | ID! | The id of the record to find. |
monetaryAccountPayments#
Requires: scope monetary_accounts:read · feature banking.
monetaryAccountPayments(paging: CursorPaging!, filter: MonetaryAccountPaymentFilter!, sorting: [MonetaryAccountPaymentSort!]!): MonetaryAccountPaymentConnection!
| Argument | Type | |
|---|---|---|
paging | CursorPaging! | Limit or page results. |
filter | MonetaryAccountPaymentFilter! | Specify to filter the records returned. |
sorting | [MonetaryAccountPaymentSort!]! | Specify to sort results. |
monetaryAccount#
Requires: scope monetary_accounts:read · feature banking.
monetaryAccount(id: ID!): MonetaryAccount!
| Argument | Type | |
|---|---|---|
id | ID! | The id of the record to find. |
monetaryAccounts#
Requires: scope monetary_accounts:read · feature banking.
monetaryAccounts(paging: CursorPaging!, filter: MonetaryAccountFilter!, sorting: [MonetaryAccountSort!]!): MonetaryAccountConnection!
| Argument | Type | |
|---|---|---|
paging | CursorPaging! | Limit or page results. |
filter | MonetaryAccountFilter! | Specify to filter the records returned. |
sorting | [MonetaryAccountSort!]! | Specify to sort results. |
monetaryAccountAutoProcess#
Requires: scope monetary_accounts:read · feature banking.
monetaryAccountAutoProcess(id: ID!): MonetaryAccountAutoProcess!
| Argument | Type | |
|---|---|---|
id | ID! | The id of the record to find. |
monetaryAccountAutoProcesses#
Requires: scope monetary_accounts:read · feature banking.
monetaryAccountAutoProcesses(paging: CursorPaging!, filter: MonetaryAccountAutoProcessFilter!, sorting: [MonetaryAccountAutoProcessSort!]!): MonetaryAccountAutoProcessConnection!
| Argument | Type | |
|---|---|---|
paging | CursorPaging! | Limit or page results. |
filter | MonetaryAccountAutoProcessFilter! | Specify to filter the records returned. |
sorting | [MonetaryAccountAutoProcessSort!]! | Specify to sort results. |
Mutations#
createAiBankRule#
Requires: scope monetary_accounts:write · feature banking.
createAiBankRule(profileId: ID!, input: CreateBankRuleInput!): BankRuleView!
| Argument | Type | |
|---|---|---|
profileId | ID! | |
input | CreateBankRuleInput! |
updateAiBankRule#
Requires: scope monetary_accounts:write · feature banking.
updateAiBankRule(profileId: ID!, id: ID!, input: UpdateBankRuleInput!): BankRuleView!
| Argument | Type | |
|---|---|---|
profileId | ID! | |
id | ID! | |
input | UpdateBankRuleInput! |
deleteAiBankRule#
Requires: scope monetary_accounts:write · feature banking.
deleteAiBankRule(profileId: ID!, id: ID!): Boolean!
| Argument | Type | |
|---|---|---|
profileId | ID! | |
id | ID! |
suggestAiBankRules#
Requires: scope monetary_accounts:write · feature banking.
suggestAiBankRules(profileId: ID!): SuggestBankRulesResultView!
| Argument | Type | |
|---|---|---|
profileId | ID! |
deleteMonetaryAccount#
Requires: scope monetary_accounts:write · feature banking.
deleteMonetaryAccount(id: ID!): ID!
| Argument | Type | |
|---|---|---|
id | ID! |
processMonetaryAccountPayment#
Requires: scope monetary_accounts:write · feature banking.
processMonetaryAccountPayment(id: ID!, input: ProcessMonetaryAccountPaymentInput!): MonetaryAccountPayment!
| Argument | Type | |
|---|---|---|
id | ID! | |
input | ProcessMonetaryAccountPaymentInput! |
unprocessMonetaryAccountPayment#
Requires: scope monetary_accounts:write · feature banking.
unprocessMonetaryAccountPayment(id: ID!): MonetaryAccountPayment!
| Argument | Type | |
|---|---|---|
id | ID! |
createBankRule#
Requires: scope monetary_accounts:write · feature banking.
createBankRule(profileId: ID!, input: BankRuleInput!): BankRule!
| Argument | Type | |
|---|---|---|
profileId | ID! | |
input | BankRuleInput! |
updateBankRule#
Requires: scope monetary_accounts:write · feature banking.
updateBankRule(id: ID!, input: BankRuleInput!): BankRule!
| Argument | Type | |
|---|---|---|
id | ID! | |
input | BankRuleInput! |
deleteBankRule#
Requires: scope monetary_accounts:write · feature banking.
deleteBankRule(id: ID!): Boolean!
| Argument | Type | |
|---|---|---|
id | ID! |
applyBankRules#
Books the unprocessed payments the rules match (at most 2000 per call). Returns how many were booked.
Requires: scope monetary_accounts:write · feature banking.
applyBankRules(profileId: ID!, monetaryAccountId: ID, from: DateTime, to: DateTime): Int!
| Argument | Type | |
|---|---|---|
profileId | ID! | |
monetaryAccountId | ID | |
from | DateTime | |
to | DateTime |
importMonetaryAccountSpreadsheet#
Requires: scope monetary_accounts:write · feature banking.
importMonetaryAccountSpreadsheet(monetaryAccountId: ID!, format: SpreadsheetFormat!, file: String!): SpreadsheetImportResult!
| Argument | Type | |
|---|---|---|
monetaryAccountId | ID! | |
format | SpreadsheetFormat! | |
file | String! |
importMonetaryAccountPayments#
Requires: scope monetary_accounts:write · feature banking.
importMonetaryAccountPayments(input: ImportMonetaryAccountPaymentsInput!): ImportMonetaryAccountPaymentsResult!
| Argument | Type | |
|---|---|---|
input | ImportMonetaryAccountPaymentsInput! |
createOneMonetaryAccountPayment#
Requires: scope monetary_accounts:write · feature banking.
createOneMonetaryAccountPayment(settlementId: ID, monetaryAccountId: ID, input: CreateMonetaryAccountPaymentInput!): MonetaryAccountPayment!
| Argument | Type | |
|---|---|---|
settlementId | ID | |
monetaryAccountId | ID | |
input | CreateMonetaryAccountPaymentInput! |
createManyMonetaryAccountPayments#
Requires: scope monetary_accounts:write · feature banking.
createManyMonetaryAccountPayments(settlementId: ID, monetaryAccountId: ID, input: [CreateMonetaryAccountPaymentInput!]!): [MonetaryAccountPayment!]!
| Argument | Type | |
|---|---|---|
settlementId | ID | |
monetaryAccountId | ID | |
input | [CreateMonetaryAccountPaymentInput!]! |
createOneMonetaryAccount#
Requires: scope monetary_accounts:write · feature banking.
createOneMonetaryAccount(profileId: ID!, input: CreateMonetaryAccountInput!): MonetaryAccount!
| Argument | Type | |
|---|---|---|
profileId | ID! | |
input | CreateMonetaryAccountInput! |
createManyMonetaryAccounts#
Requires: scope monetary_accounts:write · feature banking.
createManyMonetaryAccounts(profileId: ID!, input: [CreateMonetaryAccountInput!]!): [MonetaryAccount!]!
| Argument | Type | |
|---|---|---|
profileId | ID! | |
input | [CreateMonetaryAccountInput!]! |
createOneMonetaryAccountAutoProcess#
Requires: scope monetary_accounts:write · feature banking.
createOneMonetaryAccountAutoProcess(monetaryAccountId: ID!, input: CreateMonetaryAccountAutoProcessInput!): MonetaryAccountAutoProcess!
| Argument | Type | |
|---|---|---|
monetaryAccountId | ID! | |
input | CreateMonetaryAccountAutoProcessInput! |
createManyMonetaryAccountAutoProcesses#
Requires: scope monetary_accounts:write · feature banking.
createManyMonetaryAccountAutoProcesses(monetaryAccountId: ID!, input: [CreateMonetaryAccountAutoProcessInput!]!): [MonetaryAccountAutoProcess!]!
| Argument | Type | |
|---|---|---|
monetaryAccountId | ID! | |
input | [CreateMonetaryAccountAutoProcessInput!]! |
updateOneMonetaryAccountPayment#
Requires: scope monetary_accounts:write · feature banking.
updateOneMonetaryAccountPayment(input: UpdateOneMonetaryAccountPaymentInput!): MonetaryAccountPayment!
| Argument | Type | |
|---|---|---|
input | UpdateOneMonetaryAccountPaymentInput! |
updateManyMonetaryAccountPayments#
Requires: scope monetary_accounts:write · feature banking.
updateManyMonetaryAccountPayments(input: UpdateManyMonetaryAccountPaymentsInput!): UpdateManyResponse!
| Argument | Type | |
|---|---|---|
input | UpdateManyMonetaryAccountPaymentsInput! |
deleteOneMonetaryAccountPayment#
Requires: scope monetary_accounts:write · feature banking.
deleteOneMonetaryAccountPayment(input: DeleteOneMonetaryAccountPaymentInput!): MonetaryAccountPaymentDeleteResponse!
| Argument | Type | |
|---|---|---|
input | DeleteOneMonetaryAccountPaymentInput! |
deleteManyMonetaryAccountPayments#
Requires: scope monetary_accounts:write · feature banking.
deleteManyMonetaryAccountPayments(input: DeleteManyMonetaryAccountPaymentsInput!): DeleteManyResponse!
| Argument | Type | |
|---|---|---|
input | DeleteManyMonetaryAccountPaymentsInput! |
updateOneMonetaryAccount#
Requires: scope monetary_accounts:write · feature banking.
updateOneMonetaryAccount(input: UpdateOneMonetaryAccountInput!): MonetaryAccount!
| Argument | Type | |
|---|---|---|
input | UpdateOneMonetaryAccountInput! |
updateManyMonetaryAccounts#
Requires: scope monetary_accounts:write · feature banking.
updateManyMonetaryAccounts(input: UpdateManyMonetaryAccountsInput!): UpdateManyResponse!
| Argument | Type | |
|---|---|---|
input | UpdateManyMonetaryAccountsInput! |
deleteOneMonetaryAccount#
Requires: scope monetary_accounts:write · feature banking.
deleteOneMonetaryAccount(input: DeleteOneMonetaryAccountInput!): MonetaryAccountDeleteResponse!
| Argument | Type | |
|---|---|---|
input | DeleteOneMonetaryAccountInput! |
deleteManyMonetaryAccounts#
Requires: scope monetary_accounts:write · feature banking.
deleteManyMonetaryAccounts(input: DeleteManyMonetaryAccountsInput!): DeleteManyResponse!
| Argument | Type | |
|---|---|---|
input | DeleteManyMonetaryAccountsInput! |
updateOneMonetaryAccountAutoProcess#
Requires: scope monetary_accounts:write · feature banking.
updateOneMonetaryAccountAutoProcess(input: UpdateOneMonetaryAccountAutoProcessInput!): MonetaryAccountAutoProcess!
| Argument | Type | |
|---|---|---|
input | UpdateOneMonetaryAccountAutoProcessInput! |
updateManyMonetaryAccountAutoProcesses#
Requires: scope monetary_accounts:write · feature banking.
updateManyMonetaryAccountAutoProcesses(input: UpdateManyMonetaryAccountAutoProcessesInput!): UpdateManyResponse!
| Argument | Type | |
|---|---|---|
input | UpdateManyMonetaryAccountAutoProcessesInput! |
deleteOneMonetaryAccountAutoProcess#
Requires: scope monetary_accounts:write · feature banking.
deleteOneMonetaryAccountAutoProcess(input: DeleteOneMonetaryAccountAutoProcessInput!): MonetaryAccountAutoProcessDeleteResponse!
| Argument | Type | |
|---|---|---|
input | DeleteOneMonetaryAccountAutoProcessInput! |
deleteManyMonetaryAccountAutoProcesses#
Requires: scope monetary_accounts:write · feature banking.
deleteManyMonetaryAccountAutoProcesses(input: DeleteManyMonetaryAccountAutoProcessesInput!): DeleteManyResponse!
| Argument | Type | |
|---|---|---|
input | DeleteManyMonetaryAccountAutoProcessesInput! |