Interfaces

Interfaces

AccountInterface

Field	Argument	Type	Description
status		AccountStatus
balance		Int
urn		String
billingName		String
billingAddress		String
billingAddressLine1		String
billingAddressLine2		String
billingAddressLine3		String
billingAddressLine4		String
billingAddressLine5		String
billingAddressPostcode		String
billingCountryCode		String
billingDeliveryPointIdentifier		String
splitBillingAddress		[String]
address		RichAddressType
number		String
ledgers		[LedgerType]
canRequestRefund		Boolean
payments		AccountPaymentConnectionTypeConnection
status		AccountPaymentStatusOptions
before		String
after		String
first		Int
last		Int
repayments		AccountRepaymentConnectionTypeConnection
statuses		[AccountRepaymentStatusOptions]
before		String
after		String
first		Int
last		Int
paymentSchedules		PaymentScheduleConnectionTypeConnection
activeOnDate		Date
active		Boolean
canCreatePayment		Boolean
ledgerType		Int
reason		PaymentScheduleReasonOptions
before		String
after		String
first		Int
last		Int
paymentForecast		[PaymentForecastType]
dateTo		Date!
ledgerId		Int
referrals		ReferralConnectionTypeConnection
before		String
after		String
first		Int
last		Int
activeReferralSchemes		ReferralSchemeTypes
transactions		TransactionConnectionTypeConnection
transactionTypes		[TransactionTypeFilter]
ledgerId		Int
before		String
after		String
first		Int
last		Int
provisionalTransactions		ProvisionalTransactionConnectionTypeConnection
before		String
after		String
first		Int
last		Int
annualStatements		AnnualStatementConnectionTypeConnection
before		String
after		String
first		Int
last		Int
bills		BillConnectionTypeConnection
includeBillsWithoutPDF		Boolean
includeOpenStatements		Boolean
onlyCurrentEmail		Boolean
before		String
after		String
first		Int
last		Int
billingOptions		BillingOptionsType
bill		BillInterface
id		ID
billType		BillTypeEnum
directDebitInstructions		DirectDebitInstructionConnectionTypeConnection
statuses		[DirectDebitInstructionStatus]
before		String
after		String
first		Int
last		Int
events		AccountEventConnectionTypeConnection
eventTypes		[AccountEventType]
before		String
after		String
first		Int
last		Int
applications		AccountApplicationConnectionTypeConnection
before		String
after		String
first		Int
last		Int
accountType		AccountTypeChoices
commsDeliveryPreference		CommsDeliveryPreference
communicationDeliveryPreference ⚠️		String	⚠️ DEPRECATED Use `commsDeliveryPreference` instead
references		[AccountReferenceType]
fileAttachments		[AccountFileAttachment]
maximumRefund		MaximumRefundType
campaigns		[AccountCampaignType]

BillInterface

Field	Argument	Type	Description
id		ID
billType		BillTypeEnum
fromDate		Date
toDate		Date
temporaryUrl		String
issuedDate		Date

FileAttachment

Field	Argument	Type	Description
isUploaded		Boolean
isReady		Boolean
fetchUrl		String
sizeInBytes		Int

LedgerInterface

Field	Argument	Type	Description
id		Int
name		String
ledgerType		String
balance		Int
affectsAccountBalance		Boolean

Node

Field	Argument	Type	Description
id		ID!

PropertyInterface

Field	Argument	Type	Description
id		String
address		String
splitAddress		[String]
occupancyPeriods		[OccupancyPeriodType]
coordinates		CoordinatesType

ReferralInterface

Field	Argument	Type	Description
referredUserName		String
paymentStatus		String
paymentDate		Date
referredUserJoinDate		DateTime
code		String

SupplementaryLedgerInterface

Field	Argument	Type	Description
id		ID
name		String
ledgerType		String
currentBalance		Int

TransactionType

Field	Argument	Type	Description
id		ID
postedDate		Date
amount		Int
balanceCarriedForward		Int
isCredit		Boolean
isAccountCharge		Boolean
isAccountPayment		Boolean
isHeld		Boolean
title		String
statementId		ID
isReversed		Boolean!