Skip to main content

Statement

A statement represent metadata around a banking document that list all of the BOOKED banking transactions that have happened between startDate and endDate

type Statement {
id: ID!
account: Account!
openingBalance: Amount!
closingBalance: Amount!
openingDate: DateTime!
closingDate: DateTime!
status: StatementStatus!
statusInfo: AccountStatementStatusInfo!
period: StatementPeriod
totalCredits: Amount!
totalDebits: Amount!
fees: Amount!
feeCredits: Amount!
feeDebits: Amount!
type: [StatementInfo]!
format: AccountStatementFormat!
createdAt: DateTime!
updatedAt: DateTime!
}

Fields

Statement.id ● ID! non-null scalar

unique identifier of the statement

Statement.account ● Account! non-null object

account of the statement

Statement.openingBalance ● Amount! non-null object

booked balance at the start of the window

Statement.closingBalance ● Amount! non-null object

booked balance at the end of the window

Statement.openingDate ● DateTime! non-null scalar

starting date of the date window

Statement.closingDate ● DateTime! non-null scalar

ending date of the date window

Statement.status ● StatementStatus! non-null enum

[DEPRECATED] status of the statement

Statement.statusInfo ● AccountStatementStatusInfo! non-null interface

[NEW] status of the statement

Statement.period ● StatementPeriod enum

period of statement (either custom or monthly)

Statement.totalCredits ● Amount! non-null object

the sum of credit transactions during the window

Statement.totalDebits ● Amount! non-null object

the sum of debit transactions during the window

Statement.fees ● Amount! non-null object

[DEPRECATED] the sum of fee transactions during the window

Statement.feeCredits ● Amount! non-null object

[NEW] the sum of credit fee transactions during the window

Statement.feeDebits ● Amount! non-null object

[NEW] the sum of debit fee transactions during the window

Statement.type ● [StatementInfo]! non-null interface

[DEPRECATED] type of statements (ex: PDF)

Statement.format ● AccountStatementFormat! non-null enum

[NEW] format of statements (ex: PDF)

Statement.createdAt ● DateTime! non-null scalar

created date

Statement.updatedAt ● DateTime! non-null scalar

updated date

Returned By

accountStatement query ● generateAccountStatement mutation

Member Of

StatementEdge object