Generate monthly statements for account holders. This command is broken down to GenerateMonthlyStatementForIndividualAccount. If accounts is provided, the command will only generate statements for those accounts. Otherwise, it will generate for all accounts for the given month. This command should only be called by CartaX market ops users.
structs::commands::GenerateMonthlyStatementsToAccountHolders
Generate monthly statements for account holders. This command is broken down to GenerateMonthlyStatementForIndividualAccount. If accounts is provided, the command will only generate statements for those accounts. Otherwise, it will generate for all accounts for the given month. This command should only be called by CartaX market ops users.
Fields
YearMonth: yearMonthsource
The year and month of the report
Accounts: Id<Account>[]source
Draft: boolsource
If set, the report will be generated, but not persisted in a way that will be visible to an external user of the system. For example, a Draft Monthly Statement could be generated and viewed by an operator for debugging purposes, but it would never be made available to the customer, and an email notification would not be sent.
CommandFromStaffTool: boolsource
This will be set if the report was generated from the Staff tool. When this is set, there will be no slack notifications sent for the report to reduce noise to those channels. Any error messages will be sent.
Result
Success
If successful, an OK outcome will be produced.
Error
If unsuccessful, one of the following error types will be produced:
- AuctionNotFoundError
- MonthlyStatementsTopLevelAccountFetchError
- TradeConfirmParentAccountFetchError
- TransactionBinderTradePairFetchError
- Unauthorised
Producers
Produced by the following services:
Consumers
Consumed by the following services: