Full schema of ACMC, refer to the rest of the site for examples
API Endpoints
https://api.acmc.uat.anzgcis.comQueries
bank
Response
Returns a Bank!
Example
Query
query Bank {
bank {
accounts {
pageInfo {
...PageInfoFragment
}
edges {
...AccountEdgeFragment
}
aggregates {
...AccountConnectionAggregateFragment
}
}
commands {
pageInfo {
...PageInfoFragment
}
edges {
...CommandEdgeFragment
}
}
customers {
pageInfo {
...PageInfoFragment
}
edges {
...CustomerEdgeFragment
}
aggregates {
...SimpleConnectionAggregateFragment
}
}
receipts {
pageInfo {
...PageInfoFragment
}
edges {
...ReceiptEdgeFragment
}
aggregates {
...SimpleConnectionAggregateFragment
}
}
payments {
pageInfo {
...PageInfoFragment
}
edges {
...PaymentEdgeFragment
}
aggregates {
...SimpleConnectionAggregateFragment
}
}
products {
pageInfo {
...PageInfoFragment
}
edges {
...ProductEdgeFragment
}
aggregates {
...SimpleConnectionAggregateFragment
}
}
namedRates {
pageInfo {
...PageInfoFragment
}
edges {
...NamedRateEdgeFragment
}
aggregates {
...SimpleConnectionAggregateFragment
}
}
unallocated {
pageInfo {
...PageInfoFragment
}
edges {
...AllocatableEdgeFragment
}
aggregates {
...AllocationAggregateFragment
}
}
deleted {
pageInfo {
...PageInfoFragment
}
edges {
...AllocatableEdgeFragment
}
aggregates {
...AllocationAggregateFragment
}
}
matchedReversals {
pageInfo {
...PageInfoFragment
}
edges {
...MatchedReversalEdgeFragment
}
aggregates {
...SimpleConnectionAggregateFragment
}
}
interestAccrued {
customer {
...AccrualAmountFragment
}
client {
...AccrualAmountFragment
}
margin {
...AccrualAmountFragment
}
}
sources {
pageInfo {
...PageInfoFragment
}
edges {
...SourceEdgeFragment
}
aggregates {
...SimpleConnectionAggregateFragment
}
}
pools {
pageInfo {
...PageInfoFragment
}
edges {
...PoolEdgeFragment
}
aggregates {
...PoolAggregateFragment
}
}
withholdingTax {
au {
...WithholdingTaxAUFragment
}
}
calendars {
pageInfo {
...PageInfoFragment
}
edges {
...CalendarEdgeFragment
}
aggregates {
...SimpleConnectionAggregateFragment
}
}
businessProcesses {
pageInfo {
...PageInfoFragment
}
edges {
...BusinessProcessEdgeFragment
}
aggregates {
...SimpleConnectionAggregateFragment
}
}
reports {
pageInfo {
...PageInfoFragment
}
edges {
...ReportEdgeFragment
}
aggregates {
...SimpleConnectionAggregateFragment
}
}
scheduledReports {
pageInfo {
...PageInfoFragment
}
edges {
...ScheduledReportEdgeFragment
}
aggregates {
...SimpleConnectionAggregateFragment
}
}
approvals {
pageInfo {
...PageInfoFragment
}
edges {
...ApprovalEdgeFragment
}
aggregates {
...SimpleConnectionAggregateFragment
}
}
}
}
Response
{
"data": {
"bank": {
"accounts": AccountConnection,
"commands": CommandConnection,
"customers": CustomerConnection,
"receipts": ReceiptConnection,
"payments": PaymentConnection,
"products": ProductConnection,
"namedRates": NamedRateConnection,
"unallocated": AllocatableConnection,
"deleted": AllocatableConnection,
"matchedReversals": MatchedReversalConnection,
"interestAccrued": CustomerProductAccrual,
"sources": SourceConnection,
"pools": PoolConnection,
"withholdingTax": WithholdingTaxConfig,
"calendars": CalendarConnection,
"businessProcesses": BusinessProcessConnection,
"reports": ReportConnection,
"scheduledReports": ScheduledReportConnection,
"approvals": ApprovalConnection
}
}
}
heartbeat
Response
Returns a Heartbeat
Example
Query
query Heartbeat {
heartbeat {
timestamp
}
}
Response
{
"data": {
"heartbeat": {"timestamp": "xyz789"}
}
}
models
Response
Returns a Models!
Example
Query
query Models {
models {
featureGraph {
features {
...FeatureFragment
}
}
titles
genders
countries {
countryShortCode
countryName
lat
lng
}
encryptedPayloadSchemas {
payment
paymentRequest
internalTransfer
aggregatePayment
}
auPostcodeMap {
state
city
postcode
}
counterpartyTypes
}
}
Response
{
"data": {
"models": {
"featureGraph": FeatureGraph,
"titles": ["abc123"],
"genders": [Gender],
"countries": [Country],
"encryptedPayloadSchemas": EncryptedPayloadSchemas,
"auPostcodeMap": [PostcodeAddress],
"counterpartyTypes": [CounterpartyType]
}
}
}
node
user
Response
Returns a UserWithScopes
Example
Query
query User {
user {
name
username
displayName
sub
scopes
}
}
Response
{
"data": {
"user": {
"name": "abc123",
"username": "abc123",
"displayName": "xyz789",
"sub": "xyz789",
"scopes": ["abc123"]
}
}
}
Mutations
allocate
Description
Allocate an unallocated transaction to a client account.
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - AllocateInput!
|
Example
Query
mutation Allocate($i: AllocateInput!) {
allocate(i: $i) {
commandId
}
}
Variables
{"i": AllocateInput}
Response
{"data": {"allocate": {"commandId": "4"}}}
approveRequest
Description
Send a approval for the command awaiting on approval. Overall approval depends on the approval config.
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - ApproveRequestInput!
|
Example
Query
mutation ApproveRequest($i: ApproveRequestInput!) {
approveRequest(i: $i) {
commandId
}
}
Variables
{"i": ApproveRequestInput}
Response
{
"data": {
"approveRequest": {"commandId": "4"}
}
}
associateCustomerParty
Description
Record company details of a customer. A customer must first be onboarded, a company party created with the customer company details and then the company is linked to the customer via this mutation.
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - AssociateCustomerPartyInput!
|
Example
Query
mutation AssociateCustomerParty($i: AssociateCustomerPartyInput!) {
associateCustomerParty(i: $i) {
commandId
}
}
Variables
{"i": AssociateCustomerPartyInput}
Response
{
"data": {
"associateCustomerParty": {
"commandId": "4"
}
}
}
closeAccount
Description
Close a client account. The request will be rejected if the account has any non-zero balances.
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - CloseAccountInput!
|
Example
Query
mutation CloseAccount($i: CloseAccountInput!) {
closeAccount(i: $i) {
commandId
}
}
Variables
{"i": CloseAccountInput}
Response
{"data": {"closeAccount": {"commandId": 4}}}
createBankPool
Description
Create a pool to group a collection of bank source accounts. A bank pool may hold funds managed by multiple customers.
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - BankPoolInput!
|
Example
Query
mutation CreateBankPool($i: BankPoolInput!) {
createBankPool(i: $i) {
commandId
}
}
Variables
{"i": BankPoolInput}
Response
{"data": {"createBankPool": {"commandId": 4}}}
createBaseProduct
Description
Create a new base product
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - CreateBaseProductInput!
|
Example
Query
mutation CreateBaseProduct($i: CreateBaseProductInput!) {
createBaseProduct(i: $i) {
commandId
}
}
Variables
{"i": CreateBaseProductInput}
Response
{
"data": {
"createBaseProduct": {"commandId": "4"}
}
}
createBenchmarkFixedNamedRate
Description
Create a fixed interest rate that is available for use by all customers. Benchmark rates can only be created and maintained by bank users.
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - BenchmarkFixedNamedRateInput!
|
Example
Query
mutation CreateBenchmarkFixedNamedRate($i: BenchmarkFixedNamedRateInput!) {
createBenchmarkFixedNamedRate(i: $i) {
commandId
}
}
Variables
{"i": BenchmarkFixedNamedRateInput}
Response
{"data": {"createBenchmarkFixedNamedRate": {"commandId": 4}}}
createBenchmarkMarginNamedRate
Description
Create a margin interest rate that is available for use by all customers. Benchmark rates can only be created and maintained by bank users.
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - BenchmarkMarginNamedRateInput!
|
Example
Query
mutation CreateBenchmarkMarginNamedRate($i: BenchmarkMarginNamedRateInput!) {
createBenchmarkMarginNamedRate(i: $i) {
commandId
}
}
Variables
{"i": BenchmarkMarginNamedRateInput}
Response
{
"data": {
"createBenchmarkMarginNamedRate": {
"commandId": "4"
}
}
}
createCustomerLinkedAccount
Description
Creates a customer linked account.
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - CreateCustomerLinkedAccountInput
|
Example
Query
mutation CreateCustomerLinkedAccount($i: CreateCustomerLinkedAccountInput) {
createCustomerLinkedAccount(i: $i) {
commandId
}
}
Variables
{"i": CreateCustomerLinkedAccountInput}
Response
{"data": {"createCustomerLinkedAccount": {"commandId": 4}}}
createCustomerPool
Description
Create a pool to group a collection of customer source accounts. A customer pool must only hold funds managed by a single customer.
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - CustomerPoolInput
|
Example
Query
mutation CreateCustomerPool($i: CustomerPoolInput) {
createCustomerPool(i: $i) {
commandId
}
}
Variables
{"i": CustomerPoolInput}
Response
{
"data": {
"createCustomerPool": {"commandId": "4"}
}
}
createCustomerSourceAccountAlias
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - CustomerSourceAccountAliasInput!
|
Example
Query
mutation CreateCustomerSourceAccountAlias($i: CustomerSourceAccountAliasInput!) {
createCustomerSourceAccountAlias(i: $i) {
commandId
}
}
Variables
{"i": CustomerSourceAccountAliasInput}
Response
{"data": {"createCustomerSourceAccountAlias": {"commandId": 4}}}
createFixedNamedRate
Description
Create an fixed interest rate, with the specified name, for use when defining interest on a product
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - FixedNamedRateInput!
|
Example
Query
mutation CreateFixedNamedRate($i: FixedNamedRateInput!) {
createFixedNamedRate(i: $i) {
commandId
}
}
Variables
{"i": FixedNamedRateInput}
Response
{
"data": {
"createFixedNamedRate": {
"commandId": "4"
}
}
}
createMarginNamedRate
Description
Create a margin interest rate, with the specified name, for use when defining interest on a product
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - MarginNamedRateInput!
|
Example
Query
mutation CreateMarginNamedRate($i: MarginNamedRateInput!) {
createMarginNamedRate(i: $i) {
commandId
}
}
Variables
{"i": MarginNamedRateInput}
Response
{"data": {"createMarginNamedRate": {"commandId": 4}}}
createMatchedReversal
Description
Matches an unallocated Payment or Receipt reversal with an opposing unallocated Payment or Receipt
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - CreateMatchedReversalInput!
|
Example
Query
mutation CreateMatchedReversal($i: CreateMatchedReversalInput!) {
createMatchedReversal(i: $i) {
commandId
}
}
Variables
{"i": CreateMatchedReversalInput}
Response
{"data": {"createMatchedReversal": {"commandId": 4}}}
createPartyAssociation
Description
Create an association that can be associated with an account.
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - CreatePartyAssociationInput!
|
Example
Query
mutation CreatePartyAssociation($i: CreatePartyAssociationInput!) {
createPartyAssociation(i: $i) {
commandId
}
}
Variables
{"i": CreatePartyAssociationInput}
Response
{"data": {"createPartyAssociation": {"commandId": 4}}}
createPartyCompany
Description
Create a company that can be associated directly with an account or as the company record for a customer.
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - CreatePartyCompanyInput!
|
Example
Query
mutation CreatePartyCompany($i: CreatePartyCompanyInput!) {
createPartyCompany(i: $i) {
commandId
}
}
Variables
{"i": CreatePartyCompanyInput}
Response
{"data": {"createPartyCompany": {"commandId": 4}}}
createPartyCooperative
Description
Create a cooperative that can be associated with an account
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - CreatePartyCooperativeInput!
|
Example
Query
mutation CreatePartyCooperative($i: CreatePartyCooperativeInput!) {
createPartyCooperative(i: $i) {
commandId
}
}
Variables
{"i": CreatePartyCooperativeInput}
Response
{"data": {"createPartyCooperative": {"commandId": 4}}}
createPartyGovernmentBody
Description
Create a government body that can be associated with an account
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - CreatePartyGovernmentBodyInput!
|
Example
Query
mutation CreatePartyGovernmentBody($i: CreatePartyGovernmentBodyInput!) {
createPartyGovernmentBody(i: $i) {
commandId
}
}
Variables
{"i": CreatePartyGovernmentBodyInput}
Response
{
"data": {
"createPartyGovernmentBody": {
"commandId": "4"
}
}
}
createPartyIndividual
Description
Create an individual that can be associated directly with an account or as a controlling person for a company or trust.
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - CreatePartyIndividualInput!
|
Example
Query
mutation CreatePartyIndividual($i: CreatePartyIndividualInput!) {
createPartyIndividual(i: $i) {
commandId
}
}
Variables
{"i": CreatePartyIndividualInput}
Response
{"data": {"createPartyIndividual": {"commandId": 4}}}
createPartyPartnership
Description
Create a partnership that can be associated with an account
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - CreatePartyPartnershipInput!
|
Example
Query
mutation CreatePartyPartnership($i: CreatePartyPartnershipInput!) {
createPartyPartnership(i: $i) {
commandId
}
}
Variables
{"i": CreatePartyPartnershipInput}
Response
{
"data": {
"createPartyPartnership": {
"commandId": "4"
}
}
}
createPartyTrust
Description
Create a trust that can be associated with an account.
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - CreatePartyTrustInput!
|
Example
Query
mutation CreatePartyTrust($i: CreatePartyTrustInput!) {
createPartyTrust(i: $i) {
commandId
}
}
Variables
{"i": CreatePartyTrustInput}
Response
{"data": {"createPartyTrust": {"commandId": 4}}}
createScheduledBankReport
Description
Schedules a bank level report. This mutation is only available for bank users.
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - CreateScheduledBankReportInput!
|
Example
Query
mutation CreateScheduledBankReport($i: CreateScheduledBankReportInput!) {
createScheduledBankReport(i: $i) {
commandId
}
}
Variables
{"i": CreateScheduledBankReportInput}
Response
{"data": {"createScheduledBankReport": {"commandId": 4}}}
createScheduledCustomerReport
Description
Schedules a customer level report. This mutation is only available for bank users.
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - CreateScheduledCustomerReportInput!
|
Example
Query
mutation CreateScheduledCustomerReport($i: CreateScheduledCustomerReportInput!) {
createScheduledCustomerReport(i: $i) {
commandId
}
}
Variables
{"i": CreateScheduledCustomerReportInput}
Response
{
"data": {
"createScheduledCustomerReport": {
"commandId": "4"
}
}
}
createWithinTierNamedRate
Description
Create a within tier rate. A within tier rate means that given a value of 100 if you have 3 tiers as so {lowerBound 0, rate A}, {lowerBound 50, rate B} and {lowerBound 100, rate C}. The rate will be applied as follows: (49 * A) + (50 * B) + (1 * C) So only the amount of balance within a tier (lowerBound being inclusive) will have the rate applied.
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - WithinTierNamedRateInput!
|
Example
Query
mutation CreateWithinTierNamedRate($i: WithinTierNamedRateInput!) {
createWithinTierNamedRate(i: $i) {
commandId
}
}
Variables
{"i": WithinTierNamedRateInput}
Response
{
"data": {
"createWithinTierNamedRate": {
"commandId": "4"
}
}
}
decideDeletion
Description
Approves or denies a movement of a Payment or Receipt to the deleted list.
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - DeletionDecisionInput!
|
Example
Query
mutation DecideDeletion($i: DeletionDecisionInput!) {
decideDeletion(i: $i) {
commandId
}
}
Variables
{"i": DeletionDecisionInput}
Response
{
"data": {
"decideDeletion": {"commandId": "4"}
}
}
decideRestoration
Description
Approves or denies unallocation of a deleted Payment or Receipt.
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - RestorationDecisionInput!
|
Example
Query
mutation DecideRestoration($i: RestorationDecisionInput!) {
decideRestoration(i: $i) {
commandId
}
}
Variables
{"i": RestorationDecisionInput}
Response
{"data": {"decideRestoration": {"commandId": 4}}}
deleteCustomerLinkedAccount
Description
Deletes a customer linked account.
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - DeleteCustomerLinkedAccountInput!
|
Example
Query
mutation DeleteCustomerLinkedAccount($i: DeleteCustomerLinkedAccountInput!) {
deleteCustomerLinkedAccount(i: $i) {
commandId
}
}
Variables
{"i": DeleteCustomerLinkedAccountInput}
Response
{"data": {"deleteCustomerLinkedAccount": {"commandId": 4}}}
deleteCustomerSourceAccountAlias
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - DeleteCustomerSourceAccountAliasInput!
|
Example
Query
mutation DeleteCustomerSourceAccountAlias($i: DeleteCustomerSourceAccountAliasInput!) {
deleteCustomerSourceAccountAlias(i: $i) {
commandId
}
}
Variables
{"i": DeleteCustomerSourceAccountAliasInput}
Response
{
"data": {
"deleteCustomerSourceAccountAlias": {
"commandId": "4"
}
}
}
deleteParty
Description
Delete an existing, unused party.
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - DeletePartyInput!
|
Example
Query
mutation DeleteParty($i: DeletePartyInput!) {
deleteParty(i: $i) {
commandId
}
}
Variables
{"i": DeletePartyInput}
Response
{"data": {"deleteParty": {"commandId": 4}}}
deleteScheduledReport
Description
Deletes a scheduled report.
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - DeleteScheduledReportInput!
|
Example
Query
mutation DeleteScheduledReport($i: DeleteScheduledReportInput!) {
deleteScheduledReport(i: $i) {
commandId
}
}
Variables
{"i": DeleteScheduledReportInput}
Response
{
"data": {
"deleteScheduledReport": {
"commandId": "4"
}
}
}
doEncrypted
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - EncryptedInput!
|
Example
Query
mutation DoEncrypted($i: EncryptedInput!) {
doEncrypted(i: $i) {
commandId
}
}
Variables
{"i": EncryptedInput}
Response
{
"data": {
"doEncrypted": {"commandId": "4"}
}
}
editCustomer
Description
Update the details of an existing customer. Only the fields to be updated need be provided in the request.
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - EditCustomerInput!
|
Example
Query
mutation EditCustomer($i: EditCustomerInput!) {
editCustomer(i: $i) {
commandId
}
}
Variables
{"i": EditCustomerInput}
Response
{"data": {"editCustomer": {"commandId": 4}}}
editPartyAssociation
Description
Edit an existing party association
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - EditPartyAssociationInput!
|
Example
Query
mutation EditPartyAssociation($i: EditPartyAssociationInput!) {
editPartyAssociation(i: $i) {
commandId
}
}
Variables
{"i": EditPartyAssociationInput}
Response
{"data": {"editPartyAssociation": {"commandId": 4}}}
editPartyCompany
Description
Edit an existing party company.
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - EditPartyCompanyInput!
|
Example
Query
mutation EditPartyCompany($i: EditPartyCompanyInput!) {
editPartyCompany(i: $i) {
commandId
}
}
Variables
{"i": EditPartyCompanyInput}
Response
{"data": {"editPartyCompany": {"commandId": 4}}}
editPartyCooperative
Description
Edit an existing party cooperative
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - EditPartyCooperativeInput!
|
Example
Query
mutation EditPartyCooperative($i: EditPartyCooperativeInput!) {
editPartyCooperative(i: $i) {
commandId
}
}
Variables
{"i": EditPartyCooperativeInput}
Response
{"data": {"editPartyCooperative": {"commandId": 4}}}
editPartyGovernmentBody
Description
Edit an existing government body
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - EditPartyGovernmentBodyInput!
|
Example
Query
mutation EditPartyGovernmentBody($i: EditPartyGovernmentBodyInput!) {
editPartyGovernmentBody(i: $i) {
commandId
}
}
Variables
{"i": EditPartyGovernmentBodyInput}
Response
{
"data": {
"editPartyGovernmentBody": {
"commandId": "4"
}
}
}
editPartyIndividual
Description
Edit an existing party individual.
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - EditPartyIndividualInput!
|
Example
Query
mutation EditPartyIndividual($i: EditPartyIndividualInput!) {
editPartyIndividual(i: $i) {
commandId
}
}
Variables
{"i": EditPartyIndividualInput}
Response
{
"data": {
"editPartyIndividual": {
"commandId": "4"
}
}
}
editPartyPartnership
Description
Edit an existing partnership
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - EditPartyPartnershipInput!
|
Example
Query
mutation EditPartyPartnership($i: EditPartyPartnershipInput!) {
editPartyPartnership(i: $i) {
commandId
}
}
Variables
{"i": EditPartyPartnershipInput}
Response
{
"data": {
"editPartyPartnership": {
"commandId": "4"
}
}
}
editPartyTrust
Description
Edit an existing party trust.
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - EditPartyTrustInput!
|
Example
Query
mutation EditPartyTrust($i: EditPartyTrustInput!) {
editPartyTrust(i: $i) {
commandId
}
}
Variables
{"i": EditPartyTrustInput}
Response
{
"data": {
"editPartyTrust": {"commandId": "4"}
}
}
editProduct
Description
Edit an existing product.
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - EditProductInput!
|
Example
Query
mutation EditProduct($i: EditProductInput!) {
editProduct(i: $i) {
commandId
}
}
Variables
{"i": EditProductInput}
Response
{"data": {"editProduct": {"commandId": 4}}}
executeAggregatePayment
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - ExecuteAggregatePaymentInput!
|
Example
Query
mutation ExecuteAggregatePayment($i: ExecuteAggregatePaymentInput!) {
executeAggregatePayment(i: $i) {
commandId
}
}
Variables
{"i": ExecuteAggregatePaymentInput}
Response
{"data": {"executeAggregatePayment": {"commandId": 4}}}
grantProductToCustomer
Description
Make a product, created and owned by the bank, available to a customer. The customer can then use the product when opening accounts or can further refine the capabilities of the product via specialiseProduct mutation.
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - GrantProductToCustomerInput!
|
Example
Query
mutation GrantProductToCustomer($i: GrantProductToCustomerInput!) {
grantProductToCustomer(i: $i) {
commandId
}
}
Variables
{"i": GrantProductToCustomerInput}
Response
{"data": {"grantProductToCustomer": {"commandId": 4}}}
holdUnallocated
Description
Place a hold on an unallocated payment/receipt
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - HoldUnallocatedInput!
|
Example
Query
mutation HoldUnallocated($i: HoldUnallocatedInput!) {
holdUnallocated(i: $i) {
commandId
}
}
Variables
{"i": HoldUnallocatedInput}
Response
{
"data": {
"holdUnallocated": {"commandId": "4"}
}
}
makeBankManualInterestAdjustment
This mutation is being replaced by makeManualInterestAdjustment
Description
Make a bank manual interest adjustment
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - BankManualInterestAdjustmentInput!
|
Example
Query
mutation MakeBankManualInterestAdjustment($i: BankManualInterestAdjustmentInput!) {
makeBankManualInterestAdjustment(i: $i) {
commandId
}
}
Variables
{"i": BankManualInterestAdjustmentInput}
Response
{"data": {"makeBankManualInterestAdjustment": {"commandId": 4}}}
makeCustomerLinkedAccountPayment
Description
Initiate a payment to a customer linked account
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - MakeCustomerLinkedAccountPaymentInput!
|
Example
Query
mutation MakeCustomerLinkedAccountPayment($i: MakeCustomerLinkedAccountPaymentInput!) {
makeCustomerLinkedAccountPayment(i: $i) {
commandId
}
}
Variables
{"i": MakeCustomerLinkedAccountPaymentInput}
Response
{"data": {"makeCustomerLinkedAccountPayment": {"commandId": 4}}}
makeCustomerManualInterestAdjustment
This mutation is being replaced by makeManualInterestAdjustment
Description
Make a manual interest adjustment by or on behalf of a customer
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - CustomerManualInterestAdjustmentInput!
|
Example
Query
mutation MakeCustomerManualInterestAdjustment($i: CustomerManualInterestAdjustmentInput!) {
makeCustomerManualInterestAdjustment(i: $i) {
commandId
}
}
Variables
{"i": CustomerManualInterestAdjustmentInput}
Response
{"data": {"makeCustomerManualInterestAdjustment": {"commandId": 4}}}
makeDEPayment
Description
Initiate a direct entry payment.
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - MakeDEPaymentInput!
|
Example
Query
mutation MakeDEPayment($i: MakeDEPaymentInput!) {
makeDEPayment(i: $i) {
commandId
}
}
Variables
{"i": MakeDEPaymentInput}
Response
{"data": {"makeDEPayment": {"commandId": 4}}}
makeInternalTransfer
Description
Transfer funds between two client accounts. Transfers are restricted to funds held within funds in the same pool.
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - MakeInternalTransferInput!
|
Example
Query
mutation MakeInternalTransfer($i: MakeInternalTransferInput!) {
makeInternalTransfer(i: $i) {
commandId
}
}
Variables
{"i": MakeInternalTransferInput}
Response
{
"data": {
"makeInternalTransfer": {
"commandId": "4"
}
}
}
makeManualInterestAdjustment
Description
Make a bank manual interest adjustment
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - ManualInterestAdjustmentInput!
|
Example
Query
mutation MakeManualInterestAdjustment($i: ManualInterestAdjustmentInput!) {
makeManualInterestAdjustment(i: $i) {
commandId
}
}
Variables
{"i": ManualInterestAdjustmentInput}
Response
{"data": {"makeManualInterestAdjustment": {"commandId": 4}}}
makeNPPPayment
Description
Initiate a NPP payment.
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - MakeNPPPaymentInput!
|
Example
Query
mutation MakeNPPPayment($i: MakeNPPPaymentInput!) {
makeNPPPayment(i: $i) {
commandId
}
}
Variables
{"i": MakeNPPPaymentInput}
Response
{"data": {"makeNPPPayment": {"commandId": 4}}}
makePayment
This mutation is misnamed and will be removed, use doEncrypted instead
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - MakePaymentInput!
|
Example
Query
mutation MakePayment($i: MakePaymentInput!) {
makePayment(i: $i) {
commandId
}
}
Variables
{"i": MakePaymentInput}
Response
{"data": {"makePayment": {"commandId": 4}}}
makeRTGSPayment
Description
Initiate an RTGS payment.
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - MakeRTGSPaymentInput!
|
Example
Query
mutation MakeRTGSPayment($i: MakeRTGSPaymentInput!) {
makeRTGSPayment(i: $i) {
commandId
}
}
Variables
{"i": MakeRTGSPaymentInput}
Response
{"data": {"makeRTGSPayment": {"commandId": 4}}}
moveAccount
Description
Move an client account to a another product
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - MoveAccountInput!
|
Example
Query
mutation MoveAccount($i: MoveAccountInput!) {
moveAccount(i: $i) {
commandId
}
}
Variables
{"i": MoveAccountInput}
Response
{"data": {"moveAccount": {"commandId": 4}}}
moveSplitAllocatedToCLA
Description
Move whats left of a partially split allocatable to to a CLA
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - MoveSplitAllocatedToCLAInput!
|
Example
Query
mutation MoveSplitAllocatedToCLA($i: MoveSplitAllocatedToCLAInput!) {
moveSplitAllocatedToCLA(i: $i) {
commandId
}
}
Variables
{"i": MoveSplitAllocatedToCLAInput}
Response
{"data": {"moveSplitAllocatedToCLA": {"commandId": 4}}}
moveUnallocatedToCLA
Description
Moves an unallocated Payment or Receipts to a designated CLA.
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - MoveUnallocatedToCLAInput!
|
Example
Query
mutation MoveUnallocatedToCLA($i: MoveUnallocatedToCLAInput!) {
moveUnallocatedToCLA(i: $i) {
commandId
}
}
Variables
{"i": MoveUnallocatedToCLAInput}
Response
{"data": {"moveUnallocatedToCLA": {"commandId": 4}}}
onboardCustomer
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - OnboardCustomerInput!
|
Example
Query
mutation OnboardCustomer($i: OnboardCustomerInput!) {
onboardCustomer(i: $i) {
commandId
}
}
Variables
{"i": OnboardCustomerInput}
Response
{"data": {"onboardCustomer": {"commandId": 4}}}
openAccount
Description
Open a client account with capabilities identified by a product. The account is operated by the customer on behalf of the parties.
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - OpenAccountInput!
|
Example
Query
mutation OpenAccount($i: OpenAccountInput!) {
openAccount(i: $i) {
commandId
}
}
Variables
{"i": OpenAccountInput}
Response
{
"data": {
"openAccount": {"commandId": "4"}
}
}
realiseAccountInterest
Description
Realise due interest for an account on demand
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - RealiseAccountInterestInput!
|
Example
Query
mutation RealiseAccountInterest($i: RealiseAccountInterestInput!) {
realiseAccountInterest(i: $i) {
commandId
}
}
Variables
{"i": RealiseAccountInterestInput}
Response
{"data": {"realiseAccountInterest": {"commandId": 4}}}
registerBankSourceAccount
Description
Register details of an existing source account, held on the banks platform, that is operated by the bank and may hold funds from more than one customer. Client accounts held within a bank source account are directly addressable via bank code of the source account plus account number of the client account.
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - BankSourceInput!
|
Example
Query
mutation RegisterBankSourceAccount($i: BankSourceInput!) {
registerBankSourceAccount(i: $i) {
commandId
}
}
Variables
{"i": BankSourceInput}
Response
{
"data": {
"registerBankSourceAccount": {
"commandId": "4"
}
}
}
registerCustomerSourceAccount
Description
Register details of an existing source account, held on the banks platform, that is operated by the bank and owned by a single customer. Client accounts held within a bank source account are typically addressable via bank code and account number of the source account plus reference of the client account.
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - CustomerSourceInput!
|
Example
Query
mutation RegisterCustomerSourceAccount($i: CustomerSourceInput!) {
registerCustomerSourceAccount(i: $i) {
commandId
}
}
Variables
{"i": CustomerSourceInput}
Response
{"data": {"registerCustomerSourceAccount": {"commandId": 4}}}
rejectRequest
Description
Send a rejection for the command awaiting approval. Overall rejection depends on the appproval config.
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - RejectRequestInput!
|
Example
Query
mutation RejectRequest($i: RejectRequestInput!) {
rejectRequest(i: $i) {
commandId
}
}
Variables
{"i": RejectRequestInput}
Response
{"data": {"rejectRequest": {"commandId": 4}}}
removeHoldUnallocated
Description
Remove hold on an unallocated payment/receipt
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - RemoveHoldUnallocatedInput!
|
Example
Query
mutation RemoveHoldUnallocated($i: RemoveHoldUnallocatedInput!) {
removeHoldUnallocated(i: $i) {
commandId
}
}
Variables
{"i": RemoveHoldUnallocatedInput}
Response
{"data": {"removeHoldUnallocated": {"commandId": 4}}}
requestDeletion
Description
Moves an unallocated Payment or Receipt to the deleted list.
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - RequestDeletionInput!
|
Example
Query
mutation RequestDeletion($i: RequestDeletionInput!) {
requestDeletion(i: $i) {
commandId
}
}
Variables
{"i": RequestDeletionInput}
Response
{"data": {"requestDeletion": {"commandId": 4}}}
requestPaymentFromCustomerLinkedAccount
Description
Sends a payment request to a customer linked account.
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - RequestPaymentFromCustomerLinkedAccountInput!
|
Example
Query
mutation RequestPaymentFromCustomerLinkedAccount($i: RequestPaymentFromCustomerLinkedAccountInput!) {
requestPaymentFromCustomerLinkedAccount(i: $i) {
commandId
}
}
Variables
{"i": RequestPaymentFromCustomerLinkedAccountInput}
Response
{"data": {"requestPaymentFromCustomerLinkedAccount": {"commandId": 4}}}
requestRestoration
Description
Unallocates a previously deleted Payment or Receipt.
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - RequestRestorationInput!
|
Example
Query
mutation RequestRestoration($i: RequestRestorationInput!) {
requestRestoration(i: $i) {
commandId
}
}
Variables
{"i": RequestRestorationInput}
Response
{"data": {"requestRestoration": {"commandId": 4}}}
requestWithholdingTaxRefund
Description
Request WHT Refund for single account
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - RequestWithholdingTaxRefund!
|
Example
Query
mutation RequestWithholdingTaxRefund($i: RequestWithholdingTaxRefund!) {
requestWithholdingTaxRefund(i: $i) {
commandId
}
}
Variables
{"i": RequestWithholdingTaxRefund}
Response
{
"data": {
"requestWithholdingTaxRefund": {
"commandId": "4"
}
}
}
rerunScheduledReport
Description
Reruns a previous run of a scheduled report.
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - RerunScheduledReportInput!
|
Example
Query
mutation RerunScheduledReport($i: RerunScheduledReportInput!) {
rerunScheduledReport(i: $i) {
commandId
}
}
Variables
{"i": RerunScheduledReportInput}
Response
{"data": {"rerunScheduledReport": {"commandId": 4}}}
resubmitPayment
Description
Initiates a new acknowledgable flow (submits a new pain 001) for a payment
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - ResubmitPaymentInput!
|
Example
Query
mutation ResubmitPayment($i: ResubmitPaymentInput!) {
resubmitPayment(i: $i) {
commandId
}
}
Variables
{"i": ResubmitPaymentInput}
Response
{
"data": {
"resubmitPayment": {"commandId": "4"}
}
}
resubmitPaymentRequest
Description
Initiates a new acknowledgable flow (submits a new pain 001) for a payment-request
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - ResubmitPaymentRequestInput!
|
Example
Query
mutation ResubmitPaymentRequest($i: ResubmitPaymentRequestInput!) {
resubmitPaymentRequest(i: $i) {
commandId
}
}
Variables
{"i": ResubmitPaymentRequestInput}
Response
{"data": {"resubmitPaymentRequest": {"commandId": 4}}}
retrieveArchivedStatement
Description
Request for an old, archived account statement to be retrieved from the archive so that it can be read. Does not return the statement itself - only makes it available through the normal endpoint
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - RetrieveArchivedStatementInput!
|
Example
Query
mutation RetrieveArchivedStatement($i: RetrieveArchivedStatementInput!) {
retrieveArchivedStatement(i: $i) {
commandId
}
}
Variables
{"i": RetrieveArchivedStatementInput}
Response
{"data": {"retrieveArchivedStatement": {"commandId": 4}}}
setCalendar
Description
Sets the calendar information
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - SetCalendarInput!
|
Example
Query
mutation SetCalendar($i: SetCalendarInput!) {
setCalendar(i: $i) {
commandId
}
}
Variables
{"i": SetCalendarInput}
Response
{"data": {"setCalendar": {"commandId": 4}}}
specialiseProduct
Description
Create a new product by refining the capabilities and/or restrictions of an existing product.
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - SpecialiseProductInput!
|
Example
Query
mutation SpecialiseProduct($i: SpecialiseProductInput!) {
specialiseProduct(i: $i) {
commandId
}
}
Variables
{"i": SpecialiseProductInput}
Response
{"data": {"specialiseProduct": {"commandId": 4}}}
splitAllocatable
Description
Splits an allocatable across accounts.
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - SplitAllocatableInput!
|
Example
Query
mutation SplitAllocatable($i: SplitAllocatableInput!) {
splitAllocatable(i: $i) {
commandId
}
}
Variables
{"i": SplitAllocatableInput}
Response
{"data": {"splitAllocatable": {"commandId": 4}}}
unallocate
Description
Unallocate a recently allocated payment or receipt back to its pool.
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - UnallocateInput!
|
Example
Query
mutation Unallocate($i: UnallocateInput!) {
unallocate(i: $i) {
commandId
}
}
Variables
{"i": UnallocateInput}
Response
{"data": {"unallocate": {"commandId": 4}}}
unallocateSplitElement
Description
Unallocate a recently allocated split element back to its pool.
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - UnallocateSplitElementInput!
|
Example
Query
mutation UnallocateSplitElement($i: UnallocateSplitElementInput!) {
unallocateSplitElement(i: $i) {
commandId
}
}
Variables
{"i": UnallocateSplitElementInput}
Response
{
"data": {
"unallocateSplitElement": {
"commandId": "4"
}
}
}
unmatchMatchedReversal
Description
Unmatches a matched reversal
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - UnmatchMatchedReversalInput!
|
Example
Query
mutation UnmatchMatchedReversal($i: UnmatchMatchedReversalInput!) {
unmatchMatchedReversal(i: $i) {
commandId
}
}
Variables
{"i": UnmatchMatchedReversalInput}
Response
{"data": {"unmatchMatchedReversal": {"commandId": 4}}}
updateAccount
Description
Add a new customer to the platform. A customer has a direct relation with the bank operating the platform. A customer directly manages client accounts using the platform services provided by the bank.
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - UpdateAccountInput!
|
Example
Query
mutation UpdateAccount($i: UpdateAccountInput!) {
updateAccount(i: $i) {
commandId
}
}
Variables
{"i": UpdateAccountInput}
Response
{"data": {"updateAccount": {"commandId": 4}}}
updateBankLevelAccountRestraint
Description
Updates the bank level restraint on an account
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - UpdateAccountRestraintInput!
|
Example
Query
mutation UpdateBankLevelAccountRestraint($i: UpdateAccountRestraintInput!) {
updateBankLevelAccountRestraint(i: $i) {
commandId
}
}
Variables
{"i": UpdateAccountRestraintInput}
Response
{"data": {"updateBankLevelAccountRestraint": {"commandId": 4}}}
updateCustomerAuthLink
Description
Update existing customer auth-link, auth-link must be provided
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - UpdateCustomerAuthLinkInput!
|
Example
Query
mutation UpdateCustomerAuthLink($i: UpdateCustomerAuthLinkInput!) {
updateCustomerAuthLink(i: $i) {
commandId
}
}
Variables
{"i": UpdateCustomerAuthLinkInput}
Response
{"data": {"updateCustomerAuthLink": {"commandId": 4}}}
updateCustomerAutoSweepConfig
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - UpdateCustomerAutoSweepConfigInput!
|
Example
Query
mutation UpdateCustomerAutoSweepConfig($i: UpdateCustomerAutoSweepConfigInput!) {
updateCustomerAutoSweepConfig(i: $i) {
commandId
}
}
Variables
{"i": UpdateCustomerAutoSweepConfigInput}
Response
{
"data": {
"updateCustomerAutoSweepConfig": {
"commandId": "4"
}
}
}
updateCustomerLevelAccountRestraint
Description
Updates the customer level restraint on an account
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - UpdateAccountRestraintInput!
|
Example
Query
mutation UpdateCustomerLevelAccountRestraint($i: UpdateAccountRestraintInput!) {
updateCustomerLevelAccountRestraint(i: $i) {
commandId
}
}
Variables
{"i": UpdateAccountRestraintInput}
Response
{"data": {"updateCustomerLevelAccountRestraint": {"commandId": 4}}}
updateCustomerLinkedAccount
Description
Updates the details of a customer linked account.
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - UpdateCustomerLinkedAccountInput!
|
Example
Query
mutation UpdateCustomerLinkedAccount($i: UpdateCustomerLinkedAccountInput!) {
updateCustomerLinkedAccount(i: $i) {
commandId
}
}
Variables
{"i": UpdateCustomerLinkedAccountInput}
Response
{"data": {"updateCustomerLinkedAccount": {"commandId": 4}}}
updateNamedRate
Description
Update the value of an existing fixed or margin interest rate. The date the new value comes into effect must be provided
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - UpdateNamedRateInput!
|
Example
Query
mutation UpdateNamedRate($i: UpdateNamedRateInput!) {
updateNamedRate(i: $i) {
commandId
}
}
Variables
{"i": UpdateNamedRateInput}
Response
{
"data": {
"updateNamedRate": {"commandId": "4"}
}
}
updatePartyDeceased
Description
Mark or unmark an individual as deceased. Deceased individuals may not be used when opening an account. Existing accounts are not affected.
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - DeceasedPartyInput!
|
Example
Query
mutation UpdatePartyDeceased($i: DeceasedPartyInput!) {
updatePartyDeceased(i: $i) {
commandId
}
}
Variables
{"i": DeceasedPartyInput}
Response
{
"data": {
"updatePartyDeceased": {
"commandId": "4"
}
}
}
updateProductState
Description
Updates the state of a product to either template, available or withdrawn
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - UpdateProductStateInput!
|
Example
Query
mutation UpdateProductState($i: UpdateProductStateInput!) {
updateProductState(i: $i) {
commandId
}
}
Variables
{"i": UpdateProductStateInput}
Response
{
"data": {
"updateProductState": {"commandId": "4"}
}
}
updateTieredNamedRate
Description
Update the value of an existing tiered interest rate. The date the new value comes into effect must be provided
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - UpdateTieredNamedRateInput!
|
Example
Query
mutation UpdateTieredNamedRate($i: UpdateTieredNamedRateInput!) {
updateTieredNamedRate(i: $i) {
commandId
}
}
Variables
{"i": UpdateTieredNamedRateInput}
Response
{"data": {"updateTieredNamedRate": {"commandId": 4}}}
updateWithholdingTaxAU
Description
Sets withholding tax upsert
Response
Returns a CommandResponse
Arguments
| Name | Description |
|---|---|
i - WithholdingTaxAUInput!
|
Example
Query
mutation UpdateWithholdingTaxAU($i: WithholdingTaxAUInput!) {
updateWithholdingTaxAU(i: $i) {
commandId
}
}
Variables
{"i": WithholdingTaxAUInput}
Response
{"data": {"updateWithholdingTaxAU": {"commandId": 4}}}
Subscriptions
account
Response
Returns an AccountSubscription
Arguments
| Name | Description |
|---|---|
accountId - ID!
|
Example
Query
subscription Account($accountId: ID!) {
account(accountId: $accountId) {
... on AccountBalanceUpdated {
account {
...AccountFragment
}
balance {
...BalanceFragment
}
}
... on AccountUpdated {
account {
...AccountFragment
}
}
}
}
Variables
{"accountId": 4}
Response
{"data": {"account": AccountBalanceUpdated}}
accountList
Response
Returns an AccountListSubscription
Arguments
| Name | Description |
|---|---|
customerId - ID
|
Example
Query
subscription AccountList($customerId: ID) {
accountList(customerId: $customerId) {
... on AccountOpened {
account {
...AccountFragment
}
}
... on AccountUpdated {
account {
...AccountFragment
}
}
}
}
Variables
{"customerId": "4"}
Response
{"data": {"accountList": AccountOpened}}
bankPoolList
Response
Returns a BankPoolListSubscription
Example
Query
subscription BankPoolList {
bankPoolList {
... on PoolCreated {
pool {
...PoolFragment
}
}
}
}
Response
{"data": {"bankPoolList": PoolCreated}}
commandList
Response
Returns a CommandSubscription
Example
Query
subscription CommandList {
commandList {
... on CommandUpdated {
command {
...CommandFragment
}
}
}
}
Response
{"data": {"commandList": CommandUpdated}}
customer
Response
Returns a CustomerSubscription
Arguments
| Name | Description |
|---|---|
customerId - ID!
|
Example
Query
subscription Customer($customerId: ID!) {
customer(customerId: $customerId) {
... on CustomerEdited {
customer {
...CustomerFragment
}
}
}
}
Variables
{"customerId": 4}
Response
{"data": {"customer": CustomerEdited}}
customerList
Response
Returns a CustomerListSubscription
Example
Query
subscription CustomerList {
customerList {
... on CustomerOnboarded {
customer {
...CustomerFragment
}
}
... on CustomerEdited {
customer {
...CustomerFragment
}
}
}
}
Response
{"data": {"customerList": CustomerOnboarded}}
customerPoolList
Response
Returns a CustomerPoolListSubscription
Arguments
| Name | Description |
|---|---|
customerId - ID!
|
Example
Query
subscription CustomerPoolList($customerId: ID!) {
customerPoolList(customerId: $customerId) {
... on PoolCreated {
pool {
...PoolFragment
}
}
}
}
Variables
{"customerId": "4"}
Response
{"data": {"customerPoolList": PoolCreated}}
deletedList
Response
Returns a DeletedListSubscription
Arguments
| Name | Description |
|---|---|
poolId - ID
|
Example
Query
subscription DeletedList($poolId: ID) {
deletedList(poolId: $poolId) {
... on ReceiptRemoved {
receipt {
...ReceiptFragment
}
}
... on PaymentRemoved {
payment {
...PaymentFragment
}
}
... on ReceiptUpdated {
receipt {
...ReceiptFragment
}
}
... on PaymentUpdated {
payment {
...PaymentFragment
}
}
}
}
Variables
{"poolId": "4"}
Response
{"data": {"deletedList": ReceiptRemoved}}
grantedProductToCustomerList
Response
Returns a GrantedProductToCustomerSubscription
Arguments
| Name | Description |
|---|---|
productId - ID!
|
Example
Query
subscription GrantedProductToCustomerList($productId: ID!) {
grantedProductToCustomerList(productId: $productId) {
... on GrantedProductToCustomer {
customer {
...CustomerFragment
}
}
}
}
Variables
{"productId": "4"}
Response
{
"data": {
"grantedProductToCustomerList": GrantedProductToCustomer
}
}
heartbeat
Response
Returns a Heartbeat
Example
Query
subscription Heartbeat {
heartbeat {
timestamp
}
}
Response
{
"data": {
"heartbeat": {"timestamp": "xyz789"}
}
}
matchedReversalList
Response
Returns a MatchedReversalListSubscription
Example
Query
subscription MatchedReversalList {
matchedReversalList {
... on MatchedReversalCreated {
matchedReversal {
...MatchedReversalFragment
}
}
... on MatchedReversalUnmatched {
matchedReversal {
...MatchedReversalFragment
}
}
}
}
Response
{"data": {"matchedReversalList": MatchedReversalCreated}}
movedToCLAList
Response
Returns a MovedToCLAListSubscription
Arguments
| Name | Description |
|---|---|
poolId - ID
|
Example
Query
subscription MovedToCLAList($poolId: ID) {
movedToCLAList(poolId: $poolId) {
... on ReceiptAdded {
receipt {
...ReceiptFragment
}
}
... on PaymentAdded {
payment {
...PaymentFragment
}
}
... on ReceiptRemoved {
receipt {
...ReceiptFragment
}
}
... on PaymentRemoved {
payment {
...PaymentFragment
}
}
}
}
Variables
{"poolId": 4}
Response
{"data": {"movedToCLAList": ReceiptAdded}}
namedRateList
Response
Returns a NamedRateListSubscription
Example
Query
subscription NamedRateList {
namedRateList {
... on NamedRateCreated {
namedRate {
...NamedRateFragment
}
}
... on NamedRateUpdated {
namedRate {
...NamedRateFragment
}
}
}
}
Response
{"data": {"namedRateList": NamedRateCreated}}
partyList
Response
Returns a PartyListSubscription
Arguments
| Name | Description |
|---|---|
customerId - ID!
|
Example
Query
subscription PartyList($customerId: ID!) {
partyList(customerId: $customerId) {
... on PartyCreated {
party {
...PartyFragment
}
}
... on PartyDeceased {
party {
...PartyFragment
}
}
... on PartyDeleted {
partyId
}
}
}
Variables
{"customerId": 4}
Response
{"data": {"partyList": PartyCreated}}
product
Response
Returns a ProductSubscription
Arguments
| Name | Description |
|---|---|
productId - ID!
|
Example
Query
subscription Product($productId: ID!) {
product(productId: $productId) {
... on GrantedProductToCustomer {
customer {
...CustomerFragment
}
}
... on ProductEdited {
product {
...ProductFragment
}
}
}
}
Variables
{"productId": 4}
Response
{"data": {"product": GrantedProductToCustomer}}
productList
Response
Returns a ProductListSubscription
Example
Query
subscription ProductList {
productList {
... on ProductCreated {
product {
...ProductFragment
}
}
}
}
Response
{"data": {"productList": ProductCreated}}
scheduledReportList
Response
Returns a ScheduledReportListSubscription
Arguments
| Name | Description |
|---|---|
customerId - ID
|
Example
Query
subscription ScheduledReportList($customerId: ID) {
scheduledReportList(customerId: $customerId) {
... on ScheduledReportCreated {
scheduledReport {
...ScheduledReportFragment
}
}
... on ScheduledReportDeleted {
scheduledReport {
...ScheduledReportFragment
}
}
}
}
Variables
{"customerId": 4}
Response
{"data": {"scheduledReportList": ScheduledReportCreated}}
sourceList
Response
Returns a SourceListSubscription
Arguments
| Name | Description |
|---|---|
poolId - ID!
|
Example
Query
subscription SourceList($poolId: ID!) {
sourceList(poolId: $poolId) {
... on SourceRegistered {
source {
...SourceFragment
}
}
}
}
Variables
{"poolId": 4}
Response
{"data": {"sourceList": SourceRegistered}}
unallocatedList
Response
Returns an UnallocatedListSubscription
Arguments
| Name | Description |
|---|---|
poolId - ID
|
Example
Query
subscription UnallocatedList($poolId: ID) {
unallocatedList(poolId: $poolId) {
... on ReceiptRemoved {
receipt {
...ReceiptFragment
}
}
... on PaymentRemoved {
payment {
...PaymentFragment
}
}
... on ReceiptUpdated {
receipt {
...ReceiptFragment
}
}
... on PaymentUpdated {
payment {
...PaymentFragment
}
}
}
}
Variables
{"poolId": "4"}
Response
{"data": {"unallocatedList": ReceiptRemoved}}
Types
AUAccountWithholdingTax
Fields
| Field Name | Description |
|---|---|
designation - AUWithholdingTaxDesignation!
|
Example
{"designation": "EXEMPT"}
AUWithholdingTaxDesignation
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"EXEMPT"
Account
Description
Full details of a bank account. In addition to balance and transaction details Account also provides information on parties associated with the account, capabilities of the account etc.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique ID of the account. |
name - String
|
The name of the account assigned by the financial institution. |
accountNumber - AccountNumber
|
The account number of the account. |
bankCode - BankCode
|
The bank code for the account. May be null in the case of a CUSTOMER account. |
internal - String
|
Populated only for internal accounts. Will contain the type of internal account. |
domicile - CountryShortCode!
|
The country code of the account domicile |
balances - [Balance!]
|
A list of balances, one per currency supported by the account. |
currencies - [CurrencyCode]!
|
A list of ISO currency codes supported by the account. |
interest - AccountInterestConnection!
|
|
Arguments |
|
customer - Customer
|
The customer operating the account. |
product - Product
|
The product that controls the capabilities supported by the account. |
openState - AccountOpenState!
|
The current state of the account - open, closed, etc. |
transactionEntries - TransactionEntryConnection!
|
An ordered list of transactions recorded against the account with most recent transactions returned first. |
Arguments
|
|
parties - [PartyAccountLink!]!
|
A list all individuals and/or non-individuals and roles associated with the account. |
pool - Pool
|
Details of the pool the account operates within. |
reference - String
|
A reference associated with the account. Transactions may be allocated to the account based on the presence of the reference in payments or receipts. |
secondaryReference - String
|
|
features - [FeatureConfig!]!
|
A list of capabilities supported by the account. |
withholdingTax - AccountWithholdingTax
|
The account specific choices of withholding tax configuration |
restraints - AccountRestraint
|
The restraints on the account |
openTimestamp - DateTime
|
When the account was opened |
closeTimestamp - DateTime
|
When the account was closed, if closed |
closeAccountProcesses - [CloseAccountProcess!]
|
A list of all close account attempts |
accountProductMovements - AccountProductMovementConnection!
|
An ordered list of account product movements recrded against the account with most recent account product movements returned first. |
Arguments |
|
Example
{
"id": "4",
"name": "abc123",
"accountNumber": "000000012345",
"bankCode": BankCode,
"internal": "xyz789",
"domicile": CountryShortCode,
"balances": [Balance],
"currencies": [CurrencyCode],
"interest": AccountInterestConnection,
"customer": Customer,
"product": Product,
"openState": "OPEN",
"transactionEntries": TransactionEntryConnection,
"parties": [PartyAccountLink],
"pool": Pool,
"reference": "abc123",
"secondaryReference": "xyz789",
"features": [FeatureConfig],
"withholdingTax": AUAccountWithholdingTax,
"restraints": AccountRestraint,
"openTimestamp": "2007-12-03T10:15:30Z",
"closeTimestamp": "2007-12-03T10:15:30Z",
"closeAccountProcesses": [CloseAccountProcess],
"accountProductMovements": AccountProductMovementConnection
}
AccountAccrual
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
type - AccrualType!
|
|
valueDate - Date!
|
|
currency - CurrencyCode!
|
|
amounts - InterestAmounts!
|
|
customer - Customer!
|
|
product - Product!
|
|
pool - Pool!
|
|
source - Source!
|
|
startDate - Date
|
|
endDate - Date!
|
|
realisation - Interest
|
|
parentAccrual - ProductAccrual
|
|
destination - DestinationAccount!
|
|
account - Account!
|
|
calculation - [AccountAccrualCalculationEntry!]!
|
|
Arguments
|
|
Example
{
"id": "4",
"type": "SCHEDULED",
"valueDate": "2007-12-03",
"currency": CurrencyCode,
"amounts": InterestAmounts,
"customer": Customer,
"product": Product,
"pool": Pool,
"source": Source,
"startDate": "2007-12-03",
"endDate": "2007-12-03",
"realisation": Interest,
"parentAccrual": ProductAccrual,
"destination": DestinationAccount,
"account": Account,
"calculation": [AccountAccrualCalculationEntry]
}
AccountAccrualCalculationEntry
Fields
| Field Name | Description |
|---|---|
accrual - AccountAccrual!
|
|
date - Date!
|
|
balance - Amount!
|
|
client - NamedRateAccrualCalculation
|
|
customer - NamedRateAccrualCalculation
|
Example
{
"accrual": AccountAccrual,
"date": "2007-12-03",
"balance": Amount,
"client": NamedRateAccrualCalculation,
"customer": NamedRateAccrualCalculation
}
AccountAccrualConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [AccountAccrualEdge]
|
Example
{
"pageInfo": PageInfo,
"edges": [AccountAccrualEdge]
}
AccountAccrualEdge
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
|
node - AccountAccrual!
|
Example
{
"cursor": "abc123",
"node": AccountAccrual
}
AccountBalanceUpdated
AccountClass
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"REGULAR"
AccountConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [AccountEdge]
|
|
aggregates - AccountConnectionAggregate!
|
Example
{
"pageInfo": PageInfo,
"edges": [AccountEdge],
"aggregates": AccountConnectionAggregate
}
AccountConnectionAggregate
Fields
| Field Name | Description |
|---|---|
count - Int!
|
This is the number of filtered edges that would be returned without paging. |
balances - [Balance!]
|
The summed balances of the unpaged results. |
Example
{"count": 987, "balances": [Balance]}
AccountEdge
AccountFilter
Description
A simple use of this filter might look like:
filter: {nameExact:"Account One"}
A filter with a top level 'or' might look like:
filter: {or: [{nameExact: "Account One"}, {accountNumberContains: "1234"}]}
Fields
| Input Field | Description |
|---|---|
and - [AccountFilter!]
|
|
or - [AccountFilter!]
|
|
nameContains - String
|
|
nameExact - String
|
|
internal - String
|
|
accountNumberExact - AccountNumber
|
|
accountNumberContains - String
|
|
bankCode - BankCode
|
|
accountReferenceContains - String
|
|
accountReferenceExact - String
|
|
showClasses - [AccountClass!]
|
|
openStates - [AccountOpenState!]
|
Example
{
"and": [AccountFilter],
"or": [AccountFilter],
"nameContains": "abc123",
"nameExact": "xyz789",
"internal": "abc123",
"accountNumberExact": "000000012345",
"accountNumberContains": "xyz789",
"bankCode": BankCode,
"accountReferenceContains": "abc123",
"accountReferenceExact": "xyz789",
"showClasses": ["REGULAR"],
"openStates": ["OPEN"]
}
AccountInterest
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
currency - CurrencyCode!
|
|
customerRate - NamedRate
|
|
clientRate - NamedRate
|
|
account - Account!
|
|
accrualCustomer - AccrualAmount
|
|
accrualClient - AccrualAmount
|
|
accrualMargin - AccrualAmount
|
|
latestRealisation - AccountRealisation
|
|
financialYearToDate - AccountYearlyTotal
|
|
previousFinancialYears - [AccountYearlyTotal!]
|
Example
{
"id": "4",
"currency": CurrencyCode,
"customerRate": NamedRate,
"clientRate": NamedRate,
"account": Account,
"accrualCustomer": AccrualAmount,
"accrualClient": AccrualAmount,
"accrualMargin": AccrualAmount,
"latestRealisation": AccountRealisation,
"financialYearToDate": AccountYearlyTotal,
"previousFinancialYears": [AccountYearlyTotal]
}
AccountInterestConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [AccountInterestEdge]
|
Example
{
"pageInfo": PageInfo,
"edges": [AccountInterestEdge]
}
AccountInterestEdge
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
|
node - AccountInterest!
|
Example
{
"cursor": "xyz789",
"node": AccountInterest
}
AccountInterestFilter
Fields
| Input Field | Description |
|---|---|
currencyExact - CurrencyCode
|
Example
{"currencyExact": CurrencyCode}
AccountListSubscription
Types
| Union Types |
|---|
Example
AccountOpened
AccountMoveDetails
Fields
| Field Name | Description |
|---|---|
account - Identifier
|
|
accountNode - Account
|
|
product - Identifier
|
|
productNode - Product
|
Example
{
"account": Identifier,
"accountNode": Account,
"product": Identifier,
"productNode": Product
}
AccountNumber
Description
The account number of a bank account.
Example
"000000012345"
AccountOpenDetails
Fields
| Field Name | Description |
|---|---|
customer - Identifier
|
|
customerNode - Customer
|
|
name - String
|
|
parties - [AccountPartyLink]
|
|
product - Identifier
|
|
productNode - Product
|
|
reference - String
|
|
secondaryReference - String
|
Example
{
"customer": Identifier,
"customerNode": Customer,
"name": "abc123",
"parties": [AccountPartyLink],
"product": Identifier,
"productNode": Product,
"reference": "abc123",
"secondaryReference": "xyz789"
}
AccountOpenState
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"OPEN"
AccountOpened
Fields
| Field Name | Description |
|---|---|
account - Account!
|
Example
{"account": Account}
AccountOrdering
Fields
| Input Field | Description |
|---|---|
sort - AccountSort!
|
|
direction - OrderingDirection!
|
Example
{"sort": "NAME", "direction": "ASC"}
AccountPartyLink
AccountProductMovement
AccountProductMovementConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [AccountProductMovementEdge]
|
Example
{
"pageInfo": PageInfo,
"edges": [AccountProductMovementEdge]
}
AccountProductMovementEdge
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
|
node - AccountProductMovement!
|
Example
{
"cursor": "xyz789",
"node": AccountProductMovement
}
AccountProductMovementOrdering
Fields
| Input Field | Description |
|---|---|
sort - AccountProductMovementSort!
|
|
direction - OrderingDirection!
|
Example
{"sort": "ORDER_NO", "direction": "ASC"}
AccountProductMovementSort
Values
| Enum Value | Description |
|---|---|
|
|
Example
"ORDER_NO"
AccountRealisation
AccountRequester
Fields
| Field Name | Description |
|---|---|
account - Identifier
|
|
accountNode - Account
|
Example
{
"account": Identifier,
"accountNode": Account
}
AccountRequesterSubledgerRequesterUnion
Types
| Union Types |
|---|
Example
AccountRequester
AccountRestraint
AccountSender
Fields
| Field Name | Description |
|---|---|
account - Identifier
|
|
accountNode - Account
|
Example
{
"account": Identifier,
"accountNode": Account
}
AccountSenderSubledgerSenderUnion
Types
| Union Types |
|---|
Example
AccountSender
AccountSort
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"NAME"
AccountSubscription
Types
| Union Types |
|---|
Example
AccountBalanceUpdated
AccountUpdated
Fields
| Field Name | Description |
|---|---|
account - Account!
|
Example
{"account": Account}
AccountWithholdingTax
Types
| Union Types |
|---|
Example
AUAccountWithholdingTax
AccountYearlyTotal
Fields
| Field Name | Description |
|---|---|
account - Account!
|
|
year - Year!
|
|
currency - CurrencyCode!
|
|
interest - Amount!
|
|
withholdingTax - Amount!
|
Example
{
"account": Account,
"year": Year,
"currency": CurrencyCode,
"interest": Amount,
"withholdingTax": Amount
}
Accrual
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
type - AccrualType!
|
|
valueDate - Date!
|
|
currency - CurrencyCode!
|
|
amounts - InterestAmounts!
|
|
customer - Customer!
|
|
product - Product!
|
|
pool - Pool!
|
|
source - Source!
|
|
endDate - Date!
|
|
realisation - Interest
|
|
destination - DestinationAccount!
|
Possible Types
| Accrual Types |
|---|
Example
{
"id": "4",
"type": "SCHEDULED",
"valueDate": "2007-12-03",
"currency": CurrencyCode,
"amounts": InterestAmounts,
"customer": Customer,
"product": Product,
"pool": Pool,
"source": Source,
"endDate": "2007-12-03",
"realisation": Interest,
"destination": DestinationAccount
}
AccrualAmount
Fields
| Field Name | Description |
|---|---|
value - AmountValue!
|
|
currency - CurrencyCode!
|
|
creditDebit - CreditDebit!
|
Example
{
"value": AmountValue,
"currency": CurrencyCode,
"creditDebit": "CREDIT"
}
AccrualProductBatchDetails
AccrualTime
Fields
| Field Name | Description |
|---|---|
currency - CurrencyCode!
|
|
timeZone - TimeZone!
|
|
time - Time!
|
Example
{
"currency": CurrencyCode,
"timeZone": "Etc/UTC",
"time": "10:15:30Z"
}
AccrualTimeInput
Fields
| Input Field | Description |
|---|---|
currency - CurrencyCode!
|
|
timeZone - TimeZone!
|
|
time - Time!
|
Example
{
"currency": CurrencyCode,
"timeZone": "Etc/UTC",
"time": "10:15:30Z"
}
AccrualType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"SCHEDULED"
AcknowledgeMessage
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
valueDate - Date
|
|
transactionTime - DateTime
|
|
realisationKey - String
|
|
businessProcess - BusinessProcess
|
Example
{
"id": 4,
"valueDate": "2007-12-03",
"transactionTime": "2007-12-03T10:15:30Z",
"realisationKey": "abc123",
"businessProcess": BusinessProcess
}
Action
Description
The actions that can be performed.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"AGGREGATE_PAYMENT_EXECUTE"
ActionControlDateLimitInput
Fields
| Input Field | Description |
|---|---|
matching - MatchingDateLimitInput
|
Number of business days allowed between two payments/receipts to enable a customer to successfully match. |
allocation - AllocationDateLimitInput
|
Number of business days that can elapse before the value-date on a payment/receipt is replaced with the new processing date on a manual allocation. |
unallocation - AllocationDateLimitInput
|
Number of business days that can elapse before a customer is restricted from manually unallocating a payment/receipt. |
Example
{
"matching": MatchingDateLimitInput,
"allocation": AllocationDateLimitInput,
"unallocation": AllocationDateLimitInput
}
ActionControlDateLimits
Fields
| Field Name | Description |
|---|---|
matching - MatchingDateLimit!
|
Number of business days allowed between two payments/receipts to enable a customer to successfully match. |
allocation - AllocationDateLimit!
|
Number of business days that can elapse before the value-date on a payment/receipt is replaced with the new processing date on a manual allocation. |
unallocation - AllocationDateLimit!
|
Number of business days that can elapse before a customer is restricted from manually unallocating a payment/receipt. |
Example
{
"matching": MatchingDateLimit,
"allocation": AllocationDateLimit,
"unallocation": AllocationDateLimit
}
Address
Description
An address.
Example
{
"line1": "xyz789",
"line2": "abc123",
"city": "abc123",
"state": "abc123",
"countryCode": CountryShortCode,
"postCode": "abc123"
}
AddressInput
Description
An address.
Example
{
"line1": "xyz789",
"line2": "abc123",
"city": "xyz789",
"state": "abc123",
"countryCode": CountryShortCode,
"postCode": "abc123"
}
AggregateInstruction
Fields
| Field Name | Description |
|---|---|
id - ID
|
|
account - Account
|
|
narrative - String
|
|
tracingId - String
|
|
amount - Amount
|
|
state - AggregateInstructionState
|
|
failure - [String]
|
|
transactionEntry - TransactionEntry
|
|
aggregatePayment - AggregatePayment
|
Example
{
"id": "4",
"account": Account,
"narrative": "xyz789",
"tracingId": "abc123",
"amount": Amount,
"state": "PROCESSING",
"failure": ["abc123"],
"transactionEntry": TransactionEntry,
"aggregatePayment": AggregatePayment
}
AggregateInstructionConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [AggregateInstructionEdge]
|
Example
{
"pageInfo": PageInfo,
"edges": [AggregateInstructionEdge]
}
AggregateInstructionEdge
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
|
node - AggregateInstruction!
|
Example
{
"cursor": "xyz789",
"node": AggregateInstruction
}
AggregateInstructionFilter
Description
A simple use of this filter might look like:
filter: {narrativeExact:"Narrative One"}
A filter with a top level 'or' might look like:
filter: {or: [{narrativeExact:"Narrative One"}, {tracingIdContains: "Tracing ID Two"}]}
Fields
| Input Field | Description |
|---|---|
or - [AggregateInstructionFilter!]
|
|
and - [AggregateInstructionFilter!]
|
|
narrativeContains - String
|
|
narrativeExact - String
|
|
tracingIdContains - String
|
|
tracingIdExact - String
|
|
state - AggregateInstructionState
|
Example
{
"or": [AggregateInstructionFilter],
"and": [AggregateInstructionFilter],
"narrativeContains": "xyz789",
"narrativeExact": "abc123",
"tracingIdContains": "xyz789",
"tracingIdExact": "abc123",
"state": "PROCESSING"
}
AggregateInstructionOrdering
Fields
| Input Field | Description |
|---|---|
sort - AggregateInstructionSort!
|
|
direction - OrderingDirection!
|
Example
{"sort": "TIMESTAMP", "direction": "ASC"}
AggregateInstructionSort
Values
| Enum Value | Description |
|---|---|
|
|
Example
"TIMESTAMP"
AggregateInstructionState
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"PROCESSING"
AggregatePayment
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
createdTimestamp - DateTime!
|
|
reference - String
|
|
customerTransactionReference - String
|
An optional reference that can later be used to search for the AggregatePayment |
state - AggregatePaymentState
|
|
externalAccount - AggregatePaymentDestination
|
|
count - Int
|
|
totalAmount - Amount
|
|
totalAmountProcessed - Amount
|
|
successfulCount - Int
|
|
totalAmountSuccessful - Amount
|
|
failedCount - Int
|
|
totalAmountFailed - Amount
|
|
instructions - AggregateInstructionConnection!
|
|
Arguments
|
|
payment - Payment
|
|
paymentState - PaymentState
|
|
paymentRequest - PaymentRequest
|
|
paymentRequestState - PaymentState
|
|
valueDate - Date!
|
|
transactions - TransactionConnection!
|
|
Example
{
"id": 4,
"createdTimestamp": "2007-12-03T10:15:30Z",
"reference": "abc123",
"customerTransactionReference": "abc123",
"state": "PROCESSING",
"externalAccount": CustomerLinkedAccount,
"count": 123,
"totalAmount": Amount,
"totalAmountProcessed": Amount,
"successfulCount": 987,
"totalAmountSuccessful": Amount,
"failedCount": 123,
"totalAmountFailed": Amount,
"instructions": AggregateInstructionConnection,
"payment": Payment,
"paymentState": "SUBMITTED",
"paymentRequest": PaymentRequest,
"paymentRequestState": "SUBMITTED",
"valueDate": "2007-12-03",
"transactions": TransactionConnection
}
AggregatePaymentAccountLink
Fields
| Field Name | Description |
|---|---|
accountNumber - String
|
|
bankCode - String
|
|
name - String
|
|
paymentMethod - AggregatePaymentMethod
|
Example
{
"accountNumber": "xyz789",
"bankCode": "abc123",
"name": "xyz789",
"paymentMethod": "DE"
}
AggregatePaymentAccountLinkAggregatePaymentClaLinkUnion
Types
| Union Types |
|---|
Example
AggregatePaymentAccountLink
AggregatePaymentClaLink
Fields
| Field Name | Description |
|---|---|
customerLinkedAccount - Identifier
|
|
customerLinkedAccountNode - CustomerLinkedAccount
|
Example
{
"customerLinkedAccount": Identifier,
"customerLinkedAccountNode": CustomerLinkedAccount
}
AggregatePaymentConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [AggregatePaymentEdge]
|
Example
{
"pageInfo": PageInfo,
"edges": [AggregatePaymentEdge]
}
AggregatePaymentDestination
Types
| Union Types |
|---|
Example
CustomerLinkedAccount
AggregatePaymentEdge
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
|
node - AggregatePayment!
|
Example
{
"cursor": "xyz789",
"node": AggregatePayment
}
AggregatePaymentExecuteCommand
Fields
| Field Name | Description |
|---|---|
action - String!
|
Use operation field, the operation field is an enumeration that makes it easier to query with |
aggregatePayment - AggregatePayment
|
|
approval - Approval
|
|
createdTimestamp - DateTime
|
|
id - ID!
|
|
inputJson - String
|
|
invalid - [CommandError]!
|
|
operation - Action!
|
|
state - CommandState!
|
|
step - String!
|
|
user - String!
|
Use userInfo, as this only details the sub |
userInfo - UserInfo!
|
|
userInput - AggregatePaymentExecuteDetails
|
Example
{
"action": "abc123",
"aggregatePayment": AggregatePayment,
"approval": Approval,
"createdTimestamp": "2007-12-03T10:15:30Z",
"id": 4,
"inputJson": "xyz789",
"invalid": [CommandError],
"operation": "AGGREGATE_PAYMENT_EXECUTE",
"state": "SUBMITTED",
"step": "abc123",
"user": "xyz789",
"userInfo": UserInfo,
"userInput": AggregatePaymentExecuteDetails
}
AggregatePaymentExecuteDetails
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
customerTransactionReference - String
|
This is an optional string specified on the mutation for the sole purpose of being able to search for the BusinessProcess by the string later |
externalAccount - AggregatePaymentAccountLinkAggregatePaymentClaLinkUnion
|
|
instructions - [AggregatePaymentInstruction]
|
|
reference - String
|
|
total - Amount
|
Example
{
"count": 987,
"customerTransactionReference": "abc123",
"externalAccount": AggregatePaymentAccountLink,
"instructions": [AggregatePaymentInstruction],
"reference": "abc123",
"total": Amount
}
AggregatePaymentExternalAccountInput
Fields
| Input Field | Description |
|---|---|
claId - ID
|
|
account - ExternalAccountInput
|
Example
{
"claId": "4",
"account": ExternalAccountInput
}
AggregatePaymentFilter
Fields
| Input Field | Description |
|---|---|
amount - AmountFilter
|
|
referenceContains - String
|
|
referenceExact - String
|
Example
{
"amount": AmountFilter,
"referenceContains": "abc123",
"referenceExact": "abc123"
}
AggregatePaymentInstruction
Fields
| Field Name | Description |
|---|---|
account - Identifier
|
|
accountNode - Account
|
|
amount - Amount
|
|
narrative - String
|
|
tracingId - String
|
Example
{
"account": Identifier,
"accountNode": Account,
"amount": Amount,
"narrative": "xyz789",
"tracingId": "xyz789"
}
AggregatePaymentMethod
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"DE"
AggregatePaymentOrdering
Fields
| Input Field | Description |
|---|---|
sort - BusinessProcessSort!
|
|
direction - OrderingDirection!
|
Example
{"sort": "CREATED_TIMESTAMP", "direction": "ASC"}
AggregatePaymentState
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"PROCESSING"
AggregatePaymentType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"DE"
Allocatable
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
createdTimestamp - DateTime!
|
|
valueDate - Date!
|
|
amount - Amount!
|
|
remainingUnallocated - Amount
|
|
allocationState - AllocationState!
|
|
split - AllocatableSplitConnection!
|
|
Arguments
|
|
allocation - Allocation
|
|
unallocatedReason - String
|
|
unallocatedReasonCode - UnallocatedReasonCode
|
|
unallocatable - Boolean!
|
|
pool - Pool!
|
|
accountAllocatedTo - Account
|
The account that the payment/receipt is allocated to. |
hold - Boolean!
|
Indicates if the payment/reciept is currently on hold. |
holdHistory - [HoldHistoryItem!]
|
Shows the state changes of the hold state. |
reversal - Boolean!
|
|
directDebit - Boolean!
|
|
instructions - [Instruction!]
|
|
businessProcess - BusinessProcess!
|
|
deleteMessage - String
|
Deprecated. Moved to movementHistory |
restoreMessage - String
|
Deprecated. Moved to movementHistory |
deleteRequestUserName - String
|
Deprecated. Moved to movementHistory |
deleteRequestUserId - String
|
Deprecated. Moved to movementHistory |
deleteRequestTimestamp - String
|
Deprecated. Moved to movementHistory |
deleteApprovalUserName - String
|
Deprecated. Moved to movementHistory |
deleteApprovalUserId - String
|
Deprecated. Moved to movementHistory |
deleteApprovalTimestamp - String
|
Deprecated. Moved to movementHistory |
restoreRequestUserName - String
|
Deprecated. Moved to movementHistory |
restoreRequestUserId - String
|
Deprecated. Moved to movementHistory |
restoreRequestTimestamp - String
|
Deprecated. Moved to movementHistory |
restoreApprovalUserName - String
|
Deprecated. Moved to movementHistory |
restoreApprovalUserId - String
|
Deprecated. Moved to movementHistory |
restoreApprovalTimestamp - String
|
Deprecated. Moved to movementHistory |
history - [AllocatableHistoryItem!]
|
Shows the movement activity for this Allocatable |
Possible Types
| Allocatable Types |
|---|
Example
{
"id": 4,
"createdTimestamp": "2007-12-03T10:15:30Z",
"valueDate": "2007-12-03",
"amount": Amount,
"remainingUnallocated": Amount,
"allocationState": "PENDING",
"split": AllocatableSplitConnection,
"allocation": Allocation,
"unallocatedReason": "abc123",
"unallocatedReasonCode": "MULTIPLE_DESTINATIONS",
"unallocatable": false,
"pool": Pool,
"accountAllocatedTo": Account,
"hold": true,
"holdHistory": [HoldHistoryItem],
"reversal": true,
"directDebit": false,
"instructions": [Instruction],
"businessProcess": BusinessProcess,
"deleteMessage": "abc123",
"restoreMessage": "abc123",
"deleteRequestUserName": "abc123",
"deleteRequestUserId": "abc123",
"deleteRequestTimestamp": "abc123",
"deleteApprovalUserName": "xyz789",
"deleteApprovalUserId": "xyz789",
"deleteApprovalTimestamp": "abc123",
"restoreRequestUserName": "abc123",
"restoreRequestUserId": "xyz789",
"restoreRequestTimestamp": "abc123",
"restoreApprovalUserName": "abc123",
"restoreApprovalUserId": "xyz789",
"restoreApprovalTimestamp": "abc123",
"history": [AllocatableHistoryItem]
}
AllocatableAllocateCommand
Fields
| Field Name | Description |
|---|---|
account - Account
|
|
action - String!
|
Use operation field, the operation field is an enumeration that makes it easier to query with |
allocatable - Allocatable
|
|
approval - Approval
|
|
createdTimestamp - DateTime
|
|
id - ID!
|
|
inputJson - String
|
|
invalid - [CommandError]!
|
|
operation - Action!
|
|
state - CommandState!
|
|
step - String!
|
|
user - String!
|
Use userInfo, as this only details the sub |
userInfo - UserInfo!
|
|
userInput - AllocatableAllocateDetails
|
Example
{
"account": Account,
"action": "xyz789",
"allocatable": Allocatable,
"approval": Approval,
"createdTimestamp": "2007-12-03T10:15:30Z",
"id": "4",
"inputJson": "abc123",
"invalid": [CommandError],
"operation": "AGGREGATE_PAYMENT_EXECUTE",
"state": "SUBMITTED",
"step": "abc123",
"user": "abc123",
"userInfo": UserInfo,
"userInput": AllocatableAllocateDetails
}
AllocatableAllocateDetails
Fields
| Field Name | Description |
|---|---|
account - Identifier
|
|
accountNode - Account
|
|
comment - String
|
|
id - String
|
Example
{
"account": Identifier,
"accountNode": Account,
"comment": "xyz789",
"id": "xyz789"
}
AllocatableConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [AllocatableEdge]
|
|
aggregates - AllocationAggregate!
|
Example
{
"pageInfo": PageInfo,
"edges": [AllocatableEdge],
"aggregates": AllocationAggregate
}
AllocatableEdge
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
|
node - Allocatable
|
Example
{
"cursor": "abc123",
"node": Allocatable
}
AllocatableFilter
Fields
| Input Field | Description |
|---|---|
allocationState - AllocationState
|
|
allocatableType - AllocatableType
|
|
narrativeContains - String
|
|
narrativeExact - String
|
|
hold - Boolean
|
|
reversal - Boolean
|
|
amount - AmountFilter
|
Example
{
"allocationState": "PENDING",
"allocatableType": "RECEIPT",
"narrativeContains": "abc123",
"narrativeExact": "xyz789",
"hold": false,
"reversal": true,
"amount": AmountFilter
}
AllocatableHistoryItem
Fields
| Field Name | Description |
|---|---|
userId - String!
|
User id of the user that instigated the allocatble change |
userName - String
|
Username of the user that instigated the allocatble change |
timestamp - String!
|
Timestamp of when the allocatble change was instigated |
operation - AllocationOperation!
|
The operation being performed, this does not determine if the state change was successful |
reason - String
|
Reason of the state change |
startState - AllocationState!
|
The start state of this change on the state of the allocatable |
endState - AllocationState
|
The end state of this change on the state of the allocatable |
reviewers - [AllocatableReviewer!]
|
Reviewers of this action, these can be rejections or acceptions. |
status - AllocatableHistoryItemStatus
|
Current status of this change, was it accepted or rejected |
Example
{
"userId": "abc123",
"userName": "xyz789",
"timestamp": "xyz789",
"operation": "DELETE",
"reason": "xyz789",
"startState": "PENDING",
"endState": "PENDING",
"reviewers": [AllocatableReviewer],
"status": "SUCCESSFUL"
}
AllocatableHistoryItemStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"SUCCESSFUL"
AllocatableMoveToClaDetails
Fields
| Field Name | Description |
|---|---|
customerLinkedAccount - Identifier
|
|
customerLinkedAccountNode - CustomerLinkedAccount
|
|
id - String
|
Example
{
"customerLinkedAccount": Identifier,
"customerLinkedAccountNode": CustomerLinkedAccount,
"id": "xyz789"
}
AllocatableOrdering
Fields
| Input Field | Description |
|---|---|
sort - AllocatableSort!
|
|
direction - OrderingDirection!
|
Example
{"sort": "CREATED_TIMESTAMP", "direction": "ASC"}
AllocatableReviewer
Fields
| Field Name | Description |
|---|---|
userId - String!
|
User id of the reviewer |
userName - String
|
User name of the reviewer |
timestamp - String!
|
Timestamp of decision from the reviewer |
decision - AllocatableReviewerDecision!
|
The decision made by this user to approve or deny the allocatable change |
Example
{
"userId": "xyz789",
"userName": "abc123",
"timestamp": "xyz789",
"decision": "APPROVED"
}
AllocatableReviewerDecision
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"APPROVED"
AllocatableSort
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"CREATED_TIMESTAMP"
AllocatableSplitAggregate
Fields
| Field Name | Description |
|---|---|
count - Int!
|
This is the number of filtered edges that would be returned without paging. |
allocation - [AllocationInfo!]
|
|
failedToCreate - [AllocationInfo!]
|
Example
{
"count": 123,
"allocation": [AllocationInfo],
"failedToCreate": [AllocationInfo]
}
AllocatableSplitConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [SplitElementEdge!]
|
|
aggregates - AllocatableSplitAggregate!
|
Example
{
"pageInfo": PageInfo,
"edges": [SplitElementEdge],
"aggregates": AllocatableSplitAggregate
}
AllocatableType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"RECEIPT"
AllocateInput
Description
Options for allocation of an unallocated payment or receipt to a client account.
Example
{
"unallocatedId": "4",
"accountId": 4,
"allocationComment": "xyz789"
}
Allocation
Fields
| Field Name | Description |
|---|---|
cause - AllocationCause!
|
|
comment - String
|
Example
{"cause": "MANUAL", "comment": "xyz789"}
AllocationAggregate
AllocationCause
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"MANUAL"
AllocationDateLimit
AllocationDateLimitInput
AllocationInfo
AllocationOperation
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"DELETE"
AllocationState
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"PENDING"
Amount
Fields
| Field Name | Description |
|---|---|
value - AmountValue!
|
|
currency - CurrencyCode!
|
|
creditDebit - CreditDebit!
|
Example
{
"value": AmountValue,
"currency": CurrencyCode,
"creditDebit": "CREDIT"
}
AmountFilter
Fields
| Input Field | Description |
|---|---|
greaterThan - AmountValue
|
Filters amount to be greater than the specified value. |
lessThan - AmountValue
|
Filters amount to be less than the specified value. |
equalTo - AmountValue
|
Filters amount to be equal to the specified value. |
creditDebit - CreditDebit
|
Filters on credit debit. |
currencies - [CurrencyCode!]
|
Filter on currencies |
Example
{
"greaterThan": AmountValue,
"lessThan": AmountValue,
"equalTo": AmountValue,
"creditDebit": "CREDIT",
"currencies": [CurrencyCode]
}
AmountMatchedInput
Fields
| Input Field | Description |
|---|---|
value - AmountValue
|
|
currency - CurrencyCode
|
Example
{
"value": AmountValue,
"currency": CurrencyCode
}
AmountValue
Description
An amount like "234.00", expressed as a string. Depending on the currency for this amount it can have up to 3 decimal places
Example
AmountValue
Approval
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
state - ApprovalState!
|
|
started - DateTime!
|
|
finished - DateTime
|
|
justification - String
|
|
approvals - [ApprovalApproved!]
|
|
rejections - [ApprovalRejected!]
|
|
config - ApprovalConfig!
|
|
command - Command!
|
|
instigatingUser - UserInfo!
|
|
participatingUsers - [ApprovalParticipant!]
|
Example
{
"id": "4",
"state": "PENDING",
"started": "2007-12-03T10:15:30Z",
"finished": "2007-12-03T10:15:30Z",
"justification": "abc123",
"approvals": [ApprovalApproved],
"rejections": [ApprovalRejected],
"config": ApprovalConfig,
"command": Command,
"instigatingUser": UserInfo,
"participatingUsers": [ApprovalParticipant]
}
ApprovalApproved
ApprovalConfig
Fields
| Field Name | Description |
|---|---|
approvalTokenRequirement - TokenRequirement!
|
|
rejectedTokenRequirement - TokenRequirement!
|
|
requiredApprovedCount - Int!
|
|
requiredRejectedCount - Int!
|
Example
{
"approvalTokenRequirement": "NONE",
"rejectedTokenRequirement": "NONE",
"requiredApprovedCount": 123,
"requiredRejectedCount": 987
}
ApprovalConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [ApprovalEdge]
|
|
aggregates - SimpleConnectionAggregate!
|
Example
{
"pageInfo": PageInfo,
"edges": [ApprovalEdge],
"aggregates": SimpleConnectionAggregate
}
ApprovalEdge
ApprovalFilter
Fields
| Input Field | Description |
|---|---|
operation - Action
|
Filter to the operation/action of the command |
operations - [Action!]
|
Filter to any operation/actions of the command |
state - ApprovalState
|
Filter to state of the approval |
states - [ApprovalState!]
|
Filter to any states of the approval |
commandId - ID
|
Filter to approvals linked to the command id |
startedFrom - DateTime
|
Approvals that have happened on or after datetime supplied (inclusive range) |
startedUntil - DateTime
|
Approvals that have happened before the datetime supplied (exclusive range) |
approvalLastStage - Boolean
|
Show only approvals that are on the final stage for approval |
rejectionLastStage - Boolean
|
Show only approvals that are on the final stage for rejection |
hasParticipatedIn - Boolean
|
Show only the approvals that I have or have not partitipated in |
approvalRequiresToken - Boolean
|
Shows approvals that require a token on the next approval |
rejectionRequiresToken - Boolean
|
Shows approvals that require a token on the next rejection |
Example
{
"operation": "AGGREGATE_PAYMENT_EXECUTE",
"operations": ["AGGREGATE_PAYMENT_EXECUTE"],
"state": "PENDING",
"states": ["PENDING"],
"commandId": "4",
"startedFrom": "2007-12-03T10:15:30Z",
"startedUntil": "2007-12-03T10:15:30Z",
"approvalLastStage": false,
"rejectionLastStage": true,
"hasParticipatedIn": true,
"approvalRequiresToken": true,
"rejectionRequiresToken": false
}
ApprovalParticipant
Fields
| Field Name | Description |
|---|---|
user - UserInfo!
|
|
role - ApprovalRole!
|
|
timestamp - DateTime!
|
Example
{
"user": UserInfo,
"role": "APPROVER",
"timestamp": "2007-12-03T10:15:30Z"
}
ApprovalRejected
ApprovalRole
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"APPROVER"
ApprovalState
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"PENDING"
ApproveRequestInput
Fields
| Input Field | Description |
|---|---|
id - String!
|
The id of the approval process, this is not the command id, please see the approvals list |
reason - String
|
Reason for the response you are giving |
tokenCode - String
|
Optional generated one time use token. This may be required for the overall approval as determined via the config |
Example
{
"id": "xyz789",
"reason": "xyz789",
"tokenCode": "xyz789"
}
AssociateCustomerPartyInput
AssociationSubType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"INCORPORATED"
AssociationType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"INCORPORATED"
AutoSweepDetails
AutoSweepDetailsInput
Balance
Fields
| Field Name | Description |
|---|---|
currency - CurrencyCode!
|
|
current - Amount!
|
|
available - Amount
|
Example
{
"currency": CurrencyCode,
"current": Amount,
"available": Amount
}
Bank
Fields
| Field Name | Description |
|---|---|
accounts - AccountConnection!
|
|
Arguments
|
|
commands - CommandConnection!
|
|
Arguments |
|
customers - CustomerConnection!
|
|
Arguments
|
|
receipts - ReceiptConnection!
|
|
Arguments |
|
payments - PaymentConnection!
|
|
Arguments |
|
products - ProductConnection!
|
|
Arguments
|
|
namedRates - NamedRateConnection!
|
|
Arguments |
|
unallocated - AllocatableConnection!
|
|
Arguments
|
|
deleted - AllocatableConnection!
|
|
Arguments
|
|
matchedReversals - MatchedReversalConnection!
|
|
Arguments |
|
interestAccrued - CustomerProductAccrual!
|
|
Arguments
|
|
sources - SourceConnection!
|
|
Arguments |
|
pools - PoolConnection!
|
|
Arguments |
|
withholdingTax - WithholdingTaxConfig!
|
|
calendars - CalendarConnection!
|
|
businessProcesses - BusinessProcessConnection!
|
|
Arguments
|
|
reports - ReportConnection!
|
|
Arguments |
|
scheduledReports - ScheduledReportConnection!
|
|
Arguments |
|
approvals - ApprovalConnection!
|
|
Arguments |
|
Example
{
"accounts": AccountConnection,
"commands": CommandConnection,
"customers": CustomerConnection,
"receipts": ReceiptConnection,
"payments": PaymentConnection,
"products": ProductConnection,
"namedRates": NamedRateConnection,
"unallocated": AllocatableConnection,
"deleted": AllocatableConnection,
"matchedReversals": MatchedReversalConnection,
"interestAccrued": CustomerProductAccrual,
"sources": SourceConnection,
"pools": PoolConnection,
"withholdingTax": WithholdingTaxConfig,
"calendars": CalendarConnection,
"businessProcesses": BusinessProcessConnection,
"reports": ReportConnection,
"scheduledReports": ScheduledReportConnection,
"approvals": ApprovalConnection
}
BankCode
Description
The bank code for a particular bank. The format is dependent on the country where the account is operated.
Example
BankCode
BankManualInterestAdjustmentInput
Fields
| Input Field | Description |
|---|---|
claId - ID!
|
|
accountId - ID!
|
|
clientAmount - FullAmountInput!
|
|
reason - String!
|
|
customerMargin - AmountValue!
|
|
webVoucherTxId - String!
|
Example
{
"claId": 4,
"accountId": "4",
"clientAmount": FullAmountInput,
"reason": "abc123",
"customerMargin": AmountValue,
"webVoucherTxId": "xyz789"
}
BankNamedRate
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
currentOrNext - NamedRateEntry!
|
|
history - NamedRateEntryConnection!
|
|
Arguments
|
|
Example
{
"id": "4",
"currentOrNext": NamedRateEntry,
"history": NamedRateEntryConnection
}
BankPool
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique id of the pool. |
sourceType - SourceType!
|
Will have value of BANK for a BankPool. |
accounts - AccountConnection!
|
Client accounts held within the pool. |
Arguments
|
|
name - String!
|
The name of the pool. |
sources - SourceConnection!
|
Source accounts which form the pool. |
Arguments
|
|
unallocated - AllocatableConnection!
|
Unallocated transactions over source accounts within the pool. |
Arguments
|
|
matchedReversals - MatchedReversalConnection!
|
Matched reversals composed of a reversal and an unallocated payment or receipt. |
Arguments |
|
movedToCLA - AllocatableConnection!
|
Previously unallocated payments/receipts that have been moved to a customer linked account. |
Arguments
|
|
deleted - AllocatableConnection!
|
Deleted payments/receipts |
Arguments
|
|
Example
{
"id": "4",
"sourceType": "BANK",
"accounts": AccountConnection,
"name": "abc123",
"sources": SourceConnection,
"unallocated": AllocatableConnection,
"matchedReversals": MatchedReversalConnection,
"movedToCLA": AllocatableConnection,
"deleted": AllocatableConnection
}
BankPoolInput
Description
Options when creating a bank pool.
Fields
| Input Field | Description |
|---|---|
name - String!
|
The name of the pool. |
Example
{"name": "xyz789"}
BankPoolListSubscription
Types
| Union Types |
|---|
Example
PoolCreated
BankProduct
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
parent - Product
|
|
name - String!
|
|
description - String
|
|
code - String
|
|
codeSuffix - String
|
|
billingId - String
|
|
currencies - [String!]
|
|
governmentGuaranteeApplies - Boolean
|
|
costCentre - String
|
|
rmSet - String
|
|
retailLookThrough - RetailLookThrough
|
|
activeFeatures - [FeatureConfig!]!
|
|
availableFeatures - [FeatureConfig!]!
|
|
accounts - AccountConnection!
|
|
Arguments
|
|
grantedToCustomers - CustomerConnection!
|
|
Arguments
|
|
state - ProductState!
|
|
Example
{
"id": 4,
"parent": Product,
"name": "xyz789",
"description": "xyz789",
"code": "xyz789",
"codeSuffix": "abc123",
"billingId": "abc123",
"currencies": ["abc123"],
"governmentGuaranteeApplies": false,
"costCentre": "xyz789",
"rmSet": "xyz789",
"retailLookThrough": RetailLookThrough,
"activeFeatures": [FeatureConfig],
"availableFeatures": [FeatureConfig],
"accounts": AccountConnection,
"grantedToCustomers": CustomerConnection,
"state": "TEMPLATE"
}
BankSource
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
sourceType - SourceType!
|
|
bankCode - BankCode!
|
|
currency - CurrencyCode!
|
|
name - String
|
|
pool - BankPool!
|
|
balances - SourceBalances!
|
|
internalAccounts - AccountConnection!
|
|
Arguments
|
|
Example
{
"id": "4",
"sourceType": "BANK",
"bankCode": BankCode,
"currency": CurrencyCode,
"name": "abc123",
"pool": BankPool,
"balances": SourceBalances,
"internalAccounts": AccountConnection
}
BankSourceInput
Description
Options for registration of a bank source account.
Fields
| Input Field | Description |
|---|---|
poolId - ID!
|
The id of the pool the source account is associated with. |
bankCode - BankCode!
|
The bank code of the account. |
currency - CurrencyCode!
|
The ISO currency of the account. |
name - String
|
The name of the source account. |
Example
{
"poolId": 4,
"bankCode": BankCode,
"currency": CurrencyCode,
"name": "xyz789"
}
BankUser
Fields
| Field Name | Description |
|---|---|
name - String
|
Deprecated in favour of username |
username - String
|
|
displayName - String
|
|
sub - String
|
|
scopes - [String!]!
|
Example
{
"name": "abc123",
"username": "xyz789",
"displayName": "xyz789",
"sub": "abc123",
"scopes": ["xyz789"]
}
BenchmarkFixedNamedRateInput
Description
Options when creating a fixed benchmark interest rate available for use by all customers.
Fields
| Input Field | Description |
|---|---|
name - String!
|
The name for the rate. |
currency - CurrencyCode!
|
The ISO currency code the rate is effective for. |
startDate - Date!
|
The date the rate is effective from. |
rate - RateValue!
|
The value of the rate. |
Example
{
"name": "xyz789",
"currency": CurrencyCode,
"startDate": "2007-12-03",
"rate": RateValue
}
BenchmarkMarginNamedRateInput
Description
Options when creating a margin benchmark interest rate available for use by all customers.
Fields
| Input Field | Description |
|---|---|
name - String!
|
The name for the rate. |
currency - CurrencyCode!
|
The ISO currency code the rate is effective for. |
startDate - Date!
|
The date the rate is effective from. |
baseRate - ID!
|
Id of a rate this rate is derived from. Any changes in the base rate will impact the effective value of this rate. |
margin - RateValue!
|
A margin, defined in basis points, applied to the base rate to derive the value for the rate being created. The margin may be positive or negative. |
Example
{
"name": "xyz789",
"currency": CurrencyCode,
"startDate": "2007-12-03",
"baseRate": 4,
"margin": RateValue
}
BenchmarkNamedRate
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
currentOrNext - NamedRateEntry!
|
|
history - NamedRateEntryConnection!
|
|
Arguments
|
|
Example
{
"id": "4",
"currentOrNext": NamedRateEntry,
"history": NamedRateEntryConnection
}
BlockType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"NONE"
Boolean
Description
The Boolean scalar type represents true or false.
BusinessProcess
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
createdTimestamp - DateTime!
|
|
transactions - TransactionConnection!
|
|
valueDate - Date!
|
Possible Types
| BusinessProcess Types |
|---|
Example
{
"id": 4,
"createdTimestamp": "2007-12-03T10:15:30Z",
"transactions": TransactionConnection,
"valueDate": "2007-12-03"
}
BusinessProcessConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [BusinessProcessEdge]
|
|
aggregates - SimpleConnectionAggregate!
|
Example
{
"pageInfo": PageInfo,
"edges": [BusinessProcessEdge],
"aggregates": SimpleConnectionAggregate
}
BusinessProcessEdge
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
|
node - BusinessProcess!
|
Example
{
"cursor": "abc123",
"node": BusinessProcess
}
BusinessProcessFilter
Description
A simple use of this filter might look like:
filter: {referenceExact:"Reference One"}
A filter with a top level 'or' might look like:
filter: {or: [{referenceExact: "Reference One"}, {referenceContains: "1234"}]}
Fields
| Input Field | Description |
|---|---|
and - [BusinessProcessFilter!]
|
|
or - [BusinessProcessFilter!]
|
|
customerTransactionReferenceExact - String
|
|
customerTransactionReferenceContains - String
|
|
referenceExact - String
|
|
referenceContains - String
|
|
createdTimestamp - DateTimeFilter
|
|
type - [BusinessProcessType!]
|
|
valueDate - DateFilter
|
|
paymentFilter - PaymentFilter
|
|
receiptFilter - ReceiptFilter
|
|
internalTransferFilter - InternalTransferFilter
|
|
aggregatePaymentFilter - AggregatePaymentFilter
|
|
manualInterestAdjustmentFilter - ManualInterestAdjustmentFilter
|
|
withholdingTaxAccountRefundFilter - WithholdingTaxAccountRefundFilter
|
|
paymentRequestFilter - PaymentRequestFilter
|
|
interestFilter - InterestFilter
|
Example
{
"and": [BusinessProcessFilter],
"or": [BusinessProcessFilter],
"customerTransactionReferenceExact": "xyz789",
"customerTransactionReferenceContains": "xyz789",
"referenceExact": "abc123",
"referenceContains": "xyz789",
"createdTimestamp": DateTimeFilter,
"type": ["RECEIPT"],
"valueDate": DateFilter,
"paymentFilter": PaymentFilter,
"receiptFilter": ReceiptFilter,
"internalTransferFilter": InternalTransferFilter,
"aggregatePaymentFilter": AggregatePaymentFilter,
"manualInterestAdjustmentFilter": ManualInterestAdjustmentFilter,
"withholdingTaxAccountRefundFilter": WithholdingTaxAccountRefundFilter,
"paymentRequestFilter": PaymentRequestFilter,
"interestFilter": InterestFilter
}
BusinessProcessOrdering
Fields
| Input Field | Description |
|---|---|
sort - BusinessProcessSort!
|
|
direction - OrderingDirection!
|
Example
{"sort": "CREATED_TIMESTAMP", "direction": "ASC"}
BusinessProcessSort
Values
| Enum Value | Description |
|---|---|
|
|
Example
"CREATED_TIMESTAMP"
BusinessProcessType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"RECEIPT"
CAMT
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
entries - [CAMTEntry!]
|
Example
{"id": 4, "entries": [CAMTEntry]}
CAMTEntry
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
camtType - CamtType!
|
|
valueDate - Date
|
|
transactionTime - DateTime
|
|
bookingDate - Date
|
|
narrative - String
|
|
status - String
|
|
entryReference - String
|
|
accountServicerReference - String
|
|
transactionIdentification - String
|
|
domain - String
|
|
family - String
|
|
subFamily - String
|
|
proprietary - String
|
|
value - String
|
|
currency - String
|
|
creditDebit - CreditDebit
|
|
recipientName - String
|
|
recipientAccountNumber - String
|
|
recipientBankCode - String
|
|
reference - String
|
|
directDebit - Boolean!
|
|
reversal - Boolean!
|
|
camt - CAMT!
|
|
failure - [CommandError!]
|
|
businessProcess - BusinessProcess
|
Example
{
"id": 4,
"camtType": "REPORT",
"valueDate": "2007-12-03",
"transactionTime": "2007-12-03T10:15:30Z",
"bookingDate": "2007-12-03",
"narrative": "xyz789",
"status": "xyz789",
"entryReference": "abc123",
"accountServicerReference": "xyz789",
"transactionIdentification": "abc123",
"domain": "abc123",
"family": "abc123",
"subFamily": "xyz789",
"proprietary": "abc123",
"value": "abc123",
"currency": "abc123",
"creditDebit": "CREDIT",
"recipientName": "xyz789",
"recipientAccountNumber": "xyz789",
"recipientBankCode": "xyz789",
"reference": "xyz789",
"directDebit": false,
"reversal": true,
"camt": CAMT,
"failure": [CommandError],
"businessProcess": BusinessProcess
}
Calendar
Fields
| Field Name | Description |
|---|---|
countryCode - CountryShortCode
|
|
weekendHolidays - Boolean
|
|
holidays - [Date]
|
|
forcedBusinessDays - [Date]
|
Example
{
"countryCode": CountryShortCode,
"weekendHolidays": true,
"holidays": ["2007-12-03"],
"forcedBusinessDays": ["2007-12-03"]
}
CalendarConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [CalendarEdge]
|
|
aggregates - SimpleConnectionAggregate!
|
Example
{
"pageInfo": PageInfo,
"edges": [CalendarEdge],
"aggregates": SimpleConnectionAggregate
}
CalendarEdge
CamtType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"REPORT"
ClientInterestFeatureConfig
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
rates - [NamedRate!]
|
Example
{
"id": "4",
"name": "abc123",
"rates": [NamedRate]
}
ClientInterestFeatureConfigInput
Fields
| Input Field | Description |
|---|---|
rates - [CurrencyRateInput!]
|
Example
{"rates": [CurrencyRateInput]}
CloseAccountCommand
Fields
| Field Name | Description |
|---|---|
account - Account
|
|
action - String!
|
Use operation field, the operation field is an enumeration that makes it easier to query with |
approval - Approval
|
|
createdTimestamp - DateTime
|
|
id - ID!
|
|
inputJson - String
|
|
invalid - [CommandError]!
|
|
operation - Action!
|
|
state - CommandState!
|
|
step - String!
|
|
user - String!
|
Use userInfo, as this only details the sub |
userInfo - UserInfo!
|
|
userInput - CloseAccountDetails
|
Example
{
"account": Account,
"action": "abc123",
"approval": Approval,
"createdTimestamp": "2007-12-03T10:15:30Z",
"id": "4",
"inputJson": "xyz789",
"invalid": [CommandError],
"operation": "AGGREGATE_PAYMENT_EXECUTE",
"state": "SUBMITTED",
"step": "abc123",
"user": "abc123",
"userInfo": UserInfo,
"userInput": CloseAccountDetails
}
CloseAccountDetails
Fields
| Field Name | Description |
|---|---|
fundsDestination - CloseAccountRecipient
|
|
id - String
|
Example
{
"fundsDestination": CloseAccountRecipient,
"id": "abc123"
}
CloseAccountInput
Description
Options when closing a client account.
Fields
| Input Field | Description |
|---|---|
accountId - ID!
|
The unique id of the account to be closed. |
fundsDestination - DERecipient
|
Example
{"accountId": 4, "fundsDestination": DERecipient}
CloseAccountInterestStageStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"PENDING"
CloseAccountProcess
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
createdTimestamp - DateTime!
|
|
restraintsStageStatus - CloseAccountStageStatus!
|
|
transactionsStageStatus - CloseAccountStageStatus!
|
|
interestStageStatus - CloseAccountInterestStageStatus!
|
|
manualInterestStageStatus - CloseAccountStageStatus!
|
|
emptyAccountStageStatus - CloseAccountStageStatus!
|
|
status - CloseAccountProcessStatus!
|
|
errors - [CommandError!]
|
Example
{
"id": "4",
"createdTimestamp": "2007-12-03T10:15:30Z",
"restraintsStageStatus": "PENDING",
"transactionsStageStatus": "PENDING",
"interestStageStatus": "PENDING",
"manualInterestStageStatus": "PENDING",
"emptyAccountStageStatus": "PENDING",
"status": "IN_PROGRESS",
"errors": [CommandError]
}
CloseAccountProcessStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"IN_PROGRESS"
CloseAccountRecipient
CloseAccountStageStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"PENDING"
Command
Description
Detailed information on a previously executed command.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The id of the command to query. |
action - String!
|
The type of operation that initiated the command. Due to be replaced by operation |
operation - Action!
|
The type of operation that initiated the command. |
step - String!
|
|
state - CommandState!
|
The last recorded state of the command. |
invalid - [CommandError]!
|
A list of errors in the case of a failure. |
user - String!
|
The user that performed the operation Due to be replaced by userInfo |
userInfo - UserInfo!
|
The user information that performed the operation |
createdTimestamp - DateTime
|
The date and time the command was processed |
inputJson - String
|
The input details of the command as a JSON string |
approval - Approval
|
The approval linked to the command |
Possible Types
| Command Types |
|---|
Example
{
"id": 4,
"action": "abc123",
"operation": "AGGREGATE_PAYMENT_EXECUTE",
"step": "xyz789",
"state": "SUBMITTED",
"invalid": [CommandError],
"user": "abc123",
"userInfo": UserInfo,
"createdTimestamp": "2007-12-03T10:15:30Z",
"inputJson": "abc123",
"approval": Approval
}
CommandConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [CommandEdge]
|
Example
{
"pageInfo": PageInfo,
"edges": [CommandEdge]
}
CommandEdge
CommandError
Description
Detailed error information for a command in the case of a failure.
Example
{
"field": "xyz789",
"reason": "xyz789",
"code": "abc123"
}
CommandFilter
Fields
| Input Field | Description |
|---|---|
states - [CommandState!]
|
An optional list of states to limit results to. |
from - DateTime
|
An instant on or before the time of the first command. |
until - DateTime
|
An instant after the time of the last command. |
userInfo - UserInfoInput
|
Allows filtering on userInfo |
operation - Action
|
Find all commands that are for this operation/action |
externalId - ExternalIdInput
|
Example
{
"states": ["SUBMITTED"],
"from": "2007-12-03T10:15:30Z",
"until": "2007-12-03T10:15:30Z",
"userInfo": UserInfoInput,
"operation": "AGGREGATE_PAYMENT_EXECUTE",
"externalId": ExternalIdInput
}
CommandResponse
Description
Processing of all mutations is asynchronous with a command id returned to acknowledge receipt of the request and to enable tracking of it's progress. The command id can be subsequently queried to determine if the request completed successfully. Basic schema validation is performed synchronously on receipt of the request.
Fields
| Field Name | Description |
|---|---|
commandId - ID!
|
The unique id generated in response to the request. This can be used to determine success of the operation using a query on a Command node. |
Example
{"commandId": 4}
CommandState
Description
The current processing state of a command.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"SUBMITTED"
CommandSubscription
Types
| Union Types |
|---|
Example
CommandUpdated
CommandUpdated
Fields
| Field Name | Description |
|---|---|
command - Command!
|
Example
{"command": Command}
CompanySubType
Description
Types of companies.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"PRIVATE"
CompletedTransaction
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
transactionType - String!
|
|
valueDate - Date!
|
|
currency - CurrencyCode!
|
|
entries - TransactionEntryConnection!
|
|
businessProcess - BusinessProcess
|
|
state - TransactionState!
|
|
initiatedTimestamp - DateTime!
|
|
statementTimestamp - DateTime!
|
|
balance - Amount
|
|
splitElement - SplitElement
|
|
Example
{
"id": 4,
"transactionType": "abc123",
"valueDate": "2007-12-03",
"currency": CurrencyCode,
"entries": TransactionEntryConnection,
"businessProcess": BusinessProcess,
"state": "PENDING",
"initiatedTimestamp": "2007-12-03T10:15:30Z",
"statementTimestamp": "2007-12-03T10:15:30Z",
"balance": Amount,
"splitElement": SplitElement
}
CompletedTransactionEntry
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
transactionType - String!
|
|
transaction - Transaction!
|
|
account - Account!
|
|
businessProcess - BusinessProcess
|
|
balance - Amount
|
|
instruction - AggregateInstruction
|
|
state - TransactionState!
|
|
initiatedTimestamp - DateTime!
|
|
statementTimestamp - DateTime!
|
|
value - AmountValue!
|
|
currency - CurrencyCode!
|
|
creditDebit - CreditDebit!
|
|
unallocatable - Boolean!
|
Example
{
"id": "4",
"transactionType": "abc123",
"transaction": Transaction,
"account": Account,
"businessProcess": BusinessProcess,
"balance": Amount,
"instruction": AggregateInstruction,
"state": "PENDING",
"initiatedTimestamp": "2007-12-03T10:15:30Z",
"statementTimestamp": "2007-12-03T10:15:30Z",
"value": AmountValue,
"currency": CurrencyCode,
"creditDebit": "CREDIT",
"unallocatable": false
}
CooperativeCreateDetails
Fields
| Field Name | Description |
|---|---|
alternateAddress - PartyCooperativeAlternateAddress
|
|
businessNumber - String
|
|
clientClassification - PartyNonIndividualClientClassification
|
|
countryOfEstablishment - String
|
|
customer - Identifier
|
|
customerNode - Customer
|
|
email - String
|
|
fullName - String
|
|
kycInformation - PartyKycInformation
|
|
reference - String
|
|
registeredBodyNumber - String
|
|
registeredOfficeAddress - PartyCooperativeOfficeAddress
|
|
roles - [Role]
|
|
taxResidencies - [TaxResidency]
|
|
workPhone - String
|
Example
{
"alternateAddress": PartyCooperativeAlternateAddress,
"businessNumber": "xyz789",
"clientClassification": "CHARITABLE_TRUST",
"countryOfEstablishment": "xyz789",
"customer": Identifier,
"customerNode": Customer,
"email": "abc123",
"fullName": "abc123",
"kycInformation": PartyKycInformation,
"reference": "abc123",
"registeredBodyNumber": "abc123",
"registeredOfficeAddress": PartyCooperativeOfficeAddress,
"roles": ["BENEFICIARY"],
"taxResidencies": [TaxResidency],
"workPhone": "xyz789"
}
CoreSystemDetails
CoreSystemDetailsInput
CounterpartyType
Description
A string matching one of the values in deploy/base/services/user-api/counterparty-types.yaml/counterparty-type.edn
Example
CounterpartyType
Country
Fields
| Field Name | Description |
|---|---|
countryShortCode - CountryShortCode!
|
|
countryName - String!
|
|
lat - Float
|
|
lng - Float
|
Example
{
"countryShortCode": CountryShortCode,
"countryName": "xyz789",
"lat": 987.65,
"lng": 987.65
}
CountryShortCode
Description
Two letter short code - string
Example
CountryShortCode
CreateBankPoolCommand
Fields
| Field Name | Description |
|---|---|
action - String!
|
Use operation field, the operation field is an enumeration that makes it easier to query with |
approval - Approval
|
|
createdTimestamp - DateTime
|
|
id - ID!
|
|
inputJson - String
|
|
invalid - [CommandError]!
|
|
operation - Action!
|
|
pool - Pool
|
|
state - CommandState!
|
|
step - String!
|
|
user - String!
|
Use userInfo, as this only details the sub |
userInfo - UserInfo!
|
|
userInput - CreateBankPoolDetails
|
Example
{
"action": "abc123",
"approval": Approval,
"createdTimestamp": "2007-12-03T10:15:30Z",
"id": "4",
"inputJson": "abc123",
"invalid": [CommandError],
"operation": "AGGREGATE_PAYMENT_EXECUTE",
"pool": Pool,
"state": "SUBMITTED",
"step": "abc123",
"user": "abc123",
"userInfo": UserInfo,
"userInput": CreateBankPoolDetails
}
CreateBankPoolDetails
Fields
| Field Name | Description |
|---|---|
name - String
|
Example
{"name": "xyz789"}
CreateBaseProductInput
Description
Base product creation.
Active features must include all active features of the parent product and may include available features from the parent product. Available features may only include features in the active features list.
Features which require configuration must have configurations supplied.
Fields
| Input Field | Description |
|---|---|
customerId - ID
|
The optional ID of the customer to make this product for. |
name - String!
|
The name of the new product. |
description - String
|
A short description of the new product. |
activeFeatures - [FeatureName!]
|
A list of the active feature names, EG ['PaymentFeatureConfig']. |
availableFeatures - [FeatureName!]
|
A list of the available feature names, EG ['DeFeatureConfig']. |
currencyFeatureConfig - CurrencyFeatureConfigInput
|
Currencies supported by the product. |
interestFeatureConfig - InterestFeatureConfigInput
|
Interest earning capabilities of the product. |
clientInterestFeatureConfig - ClientInterestFeatureConfigInput
|
Interest to be earned by client accounts opened with the product. |
customerInterestFeatureConfig - CustomerInterestFeatureConfigInput
|
Interest to be earned by the customer on balances held in client accounts opened with the product. |
poolFeatureConfig - PoolFeatureConfigInput
|
Details of the pool associated with clients accounts opened with the product. |
requiredRolesFeatureConfig - RequiredRolesFeatureConfigInput
|
Mandatory roles (beneficiary, trustee etc.) that must be supplied when opening an account with this product. |
defaultTrusteesFeatureConfig - DefaultTrusteesFeatureConfigInput
|
Default trustees (parties with role as a TRUSTEE) that must be supplied when opening an account with this product. |
statementsFeatureConfig - StatementsFeatureConfigInput
|
The frequency and time at which statements should run |
state - ProductState
|
The optional state to specialise a product with |
governmentGuaranteeApplies - Boolean
|
A label to indicate whether the Australian government guarantee applies to each individual account for this product. |
costCentre - String
|
The cost centre for the reporting of revenue associated with the product. |
rmSet - String
|
Used for MIS reporting and identifying the relationship manager. |
retailLookThrough - RetailLookThroughInput
|
Details of whether predominantly retail monies are being managed, and if so, the associated paramaters. |
billingId - String
|
The optional billing id for the new product within a bank |
Example
{
"customerId": 4,
"name": "xyz789",
"description": "xyz789",
"activeFeatures": ["CURRENCY"],
"availableFeatures": ["CURRENCY"],
"currencyFeatureConfig": CurrencyFeatureConfigInput,
"interestFeatureConfig": InterestFeatureConfigInput,
"clientInterestFeatureConfig": ClientInterestFeatureConfigInput,
"customerInterestFeatureConfig": CustomerInterestFeatureConfigInput,
"poolFeatureConfig": PoolFeatureConfigInput,
"requiredRolesFeatureConfig": RequiredRolesFeatureConfigInput,
"defaultTrusteesFeatureConfig": DefaultTrusteesFeatureConfigInput,
"statementsFeatureConfig": StatementsFeatureConfigInput,
"state": "TEMPLATE",
"governmentGuaranteeApplies": true,
"costCentre": "abc123",
"rmSet": "xyz789",
"retailLookThrough": RetailLookThroughInput,
"billingId": "xyz789"
}
CreateCustomerLinkedAccountInput
Description
Options for creating a customer linked account.
Fields
| Input Field | Description |
|---|---|
customerId - ID!
|
The id of the customer the linked account will be for. |
accountName - String!
|
The operating name of the account. |
accountHolder - String!
|
The entity/person controlling the account |
accountNumber - AccountNumber!
|
The account number of the account. |
bankCode - BankCode!
|
The bank code of the account. |
description - String
|
A short description of the linked account. |
Example
{
"customerId": "4",
"accountName": "xyz789",
"accountHolder": "abc123",
"accountNumber": "000000012345",
"bankCode": BankCode,
"description": "abc123"
}
CreateCustomerPoolCommand
Fields
| Field Name | Description |
|---|---|
action - String!
|
Use operation field, the operation field is an enumeration that makes it easier to query with |
approval - Approval
|
|
createdTimestamp - DateTime
|
|
customer - Customer
|
|
id - ID!
|
|
inputJson - String
|
|
invalid - [CommandError]!
|
|
operation - Action!
|
|
pool - Pool
|
|
state - CommandState!
|
|
step - String!
|
|
user - String!
|
Use userInfo, as this only details the sub |
userInfo - UserInfo!
|
|
userInput - CreateCustomerPoolDetails
|
Example
{
"action": "abc123",
"approval": Approval,
"createdTimestamp": "2007-12-03T10:15:30Z",
"customer": Customer,
"id": "4",
"inputJson": "abc123",
"invalid": [CommandError],
"operation": "AGGREGATE_PAYMENT_EXECUTE",
"pool": Pool,
"state": "SUBMITTED",
"step": "xyz789",
"user": "abc123",
"userInfo": UserInfo,
"userInput": CreateCustomerPoolDetails
}
CreateCustomerPoolDetails
Fields
| Field Name | Description |
|---|---|
customer - Identifier
|
|
customerNode - Customer
|
|
name - String
|
Example
{
"customer": Identifier,
"customerNode": Customer,
"name": "abc123"
}
CreateMatchedReversalInput
Example
{
"reversalId": "4",
"unallocatedId": "4",
"comment": "abc123"
}
CreatePartyAssociationInput
Fields
| Input Field | Description |
|---|---|
customerId - ID!
|
Customer the party will be created for |
roles - [Role!]!
|
The roles this party can be on an account |
reference - String
|
External party reference |
fullName - String!
|
Name of the association |
businessNumber - String
|
Australian Business Number issued by the Australian Tax Office |
email - String
|
|
workPhone - String
|
Work phone |
registeredOfficeAddress - AddressInput!
|
Registered Office Address. Cannot be a PO Box |
alternateAddress - AddressInput
|
Alternate address |
clientClassification - NonIndividualClientClassification
|
Client/Beneficiary classification |
taxResidencies - [NonIndividualTaxResidencyInput!]!
|
Tax residencies |
associationType - AssociationSubType!
|
The subtype of the association which determines allowed fields downstream |
registeredBodyNumber - String
|
Australian Registered Body Number provided by ASIC - 9 digits all numerical |
incorporationDate - Date
|
Date of Incorporation/Registration |
incorporationCountry - CountryShortCode
|
Country of Incorporation/Registration |
countryOfEstablishment - CountryShortCode
|
Country where the unincorporated association was established |
Example
{
"customerId": "4",
"roles": ["BENEFICIARY"],
"reference": "abc123",
"fullName": "xyz789",
"businessNumber": "abc123",
"email": "abc123",
"workPhone": "xyz789",
"registeredOfficeAddress": AddressInput,
"alternateAddress": AddressInput,
"clientClassification": "COMPANY",
"taxResidencies": [NonIndividualTaxResidencyInput],
"associationType": "INCORPORATED",
"registeredBodyNumber": "xyz789",
"incorporationDate": "2007-12-03",
"incorporationCountry": CountryShortCode,
"countryOfEstablishment": CountryShortCode
}
CreatePartyCompanyInput
Description
Options for creation of a company.
Fields
| Input Field | Description |
|---|---|
customerId - ID!
|
Customer the party will be created for |
roles - [Role!]!
|
The roles this party can be on an account |
reference - String
|
External party reference |
companyType - CompanySubType!
|
The subtype of the company which determines allowed fields downstream |
clientClassification - NonIndividualClientClassification
|
Client/Beneficiary classification |
fullName - String!
|
Name of the company |
companyNumber - String
|
Australian Company Number provided by ASIC as part of the registration process |
registeredBodyNumber - String
|
Australian Registered Body Number provided by ASIC - 9 digits all numerical |
businessNumber - String
|
Australian Business Number issued by the Australian Tax Office |
incorporationDate - Date
|
Date of Incorporation/Registration |
incorporationCountry - CountryShortCode
|
Country of Incorporation/Registration |
stockExchange - String
|
Name of Stock Exchange. Optional only to be used for public companies type |
tradingName - String
|
Could be different from the full legal name of the company on the registration certificate |
email - String
|
|
workPhone - String
|
Work phone |
registeredOfficeAddress - AddressInput!
|
Registered Office Address. Cannot be a PO Box |
alternateAddress - AddressInput
|
Alternate address |
taxResidencies - [NonIndividualTaxResidencyInput!]!
|
Tax residencies |
selfCertified - SelfCertifiedInput
|
Self-certification date |
taxReportingType - NonIndividualTaxReportingType
|
Tax reporting type |
noTaxResidency - Boolean
|
Whether the company has no residency for tax purposes |
giin - String
|
The Global Intermediary Identification Number |
countryOfEffectiveManagement - CountryShortCode
|
Country of effective management |
controllingPersons - [ID!]
|
A list of individual party ids who have the role of controlling person |
countryOfEstablishment - CountryShortCode
|
Country where the company was established |
Example
{
"customerId": 4,
"roles": ["BENEFICIARY"],
"reference": "xyz789",
"companyType": "PRIVATE",
"clientClassification": "COMPANY",
"fullName": "xyz789",
"companyNumber": "abc123",
"registeredBodyNumber": "abc123",
"businessNumber": "abc123",
"incorporationDate": "2007-12-03",
"incorporationCountry": CountryShortCode,
"stockExchange": "xyz789",
"tradingName": "xyz789",
"email": "xyz789",
"workPhone": "abc123",
"registeredOfficeAddress": AddressInput,
"alternateAddress": AddressInput,
"taxResidencies": [NonIndividualTaxResidencyInput],
"selfCertified": SelfCertifiedInput,
"taxReportingType": "EXEMPT_ENTITY",
"noTaxResidency": true,
"giin": "xyz789",
"countryOfEffectiveManagement": CountryShortCode,
"controllingPersons": ["4"],
"countryOfEstablishment": CountryShortCode
}
CreatePartyCooperativeInput
Fields
| Input Field | Description |
|---|---|
customerId - ID!
|
Customer the party will be created for |
roles - [Role!]!
|
The roles this party can be on an account |
reference - String
|
External party reference |
fullName - String!
|
Name of the association |
businessNumber - String
|
Australian Business Number issued by the Australian Tax Office |
email - String
|
|
workPhone - String
|
Work phone |
registeredOfficeAddress - AddressInput!
|
Registered Office Address. Cannot be a PO Box |
alternateAddress - AddressInput
|
Alternate address |
clientClassification - NonIndividualClientClassification
|
Client/Beneficiary classification |
taxResidencies - [NonIndividualTaxResidencyInput!]!
|
Tax residencies |
registeredBodyNumber - String
|
Australian Registered Body Number provided by ASIC - 9 digits all numerical |
countryOfEstablishment - CountryShortCode!
|
Country where the cooperation was established |
Example
{
"customerId": 4,
"roles": ["BENEFICIARY"],
"reference": "abc123",
"fullName": "abc123",
"businessNumber": "abc123",
"email": "xyz789",
"workPhone": "xyz789",
"registeredOfficeAddress": AddressInput,
"alternateAddress": AddressInput,
"clientClassification": "COMPANY",
"taxResidencies": [NonIndividualTaxResidencyInput],
"registeredBodyNumber": "xyz789",
"countryOfEstablishment": CountryShortCode
}
CreatePartyGovernmentBodyInput
Fields
| Input Field | Description |
|---|---|
customerId - ID!
|
Customer the party will be created for |
roles - [Role!]!
|
The roles this party can be on an account |
reference - String
|
External party reference |
fullName - String!
|
Name of the gov body |
businessNumber - String
|
Australian Business Number issued by the Australian Tax Office |
email - String
|
|
workPhone - String
|
Work phone |
registeredOfficeAddress - AddressInput!
|
Registered Office Address. Cannot be a PO Box |
alternateAddress - AddressInput
|
Alternate address |
taxResidencies - [NonIndividualTaxResidencyInput!]!
|
Tax residencies |
clientClassification - NonIndividualClientClassification
|
Client/Beneficiary classification |
governmentBodyType - GovernmentBodySubType!
|
The subtype of the gov body |
countryOfEstablishment - CountryShortCode!
|
Country where the gov body was established |
Example
{
"customerId": "4",
"roles": ["BENEFICIARY"],
"reference": "abc123",
"fullName": "abc123",
"businessNumber": "xyz789",
"email": "abc123",
"workPhone": "xyz789",
"registeredOfficeAddress": AddressInput,
"alternateAddress": AddressInput,
"taxResidencies": [NonIndividualTaxResidencyInput],
"clientClassification": "COMPANY",
"governmentBodyType": "OFFSHORE",
"countryOfEstablishment": CountryShortCode
}
CreatePartyIndividualInput
Description
Options for creation of an individual.
Fields
| Input Field | Description |
|---|---|
title - String
|
The individuals title. |
givenName - String!
|
The individuals given (first) name. |
otherGivenNames - [String!]
|
List of names, other than given or family, for the individual. |
familyName - String!
|
The individuals family (last) name. |
reference - String
|
Customer provided reference for the individual. This must be unique over all individuals of the customer. |
gender - Gender
|
The individuals gender. |
dateOfBirth - Date
|
The individuals date of birth. Must be provided if the individual is being registered as 'self-certified'. |
residentialAddress - AddressInput!
|
The individuals main residential address. Must not be a PO Box or other restricted address for KYC compliance. |
alternateAddress - AddressInput
|
Alternate address for the individual. |
taxResidencies - [IndividualTaxResidencyInput!]!
|
List of all countries the individual has tax residency obligations in. |
selfCertified - SelfCertifiedInput
|
Is the individual being registered as self certified for tax reporting purposes. |
roles - [Role!]!
|
List of roles the individual may perform on accounts or companies (Beneficiary, Trustee or Controlling Person). |
customerId - ID!
|
The customer the individual is client of. |
Example
{
"title": "abc123",
"givenName": "xyz789",
"otherGivenNames": ["abc123"],
"familyName": "xyz789",
"reference": "xyz789",
"gender": Gender,
"dateOfBirth": "2007-12-03",
"residentialAddress": AddressInput,
"alternateAddress": AddressInput,
"taxResidencies": [IndividualTaxResidencyInput],
"selfCertified": SelfCertifiedInput,
"roles": ["BENEFICIARY"],
"customerId": "4"
}
CreatePartyPartnershipInput
Fields
| Input Field | Description |
|---|---|
customerId - ID!
|
Customer the party will be created for |
roles - [Role!]!
|
The roles this party can be on an account |
reference - String
|
External party reference |
fullName - String!
|
Name of the association |
businessNumber - String
|
Australian Business Number issued by the Australian Tax Office |
email - String
|
|
workPhone - String
|
Work phone |
registeredOfficeAddress - AddressInput!
|
Registered Office Address. Cannot be a PO Box |
alternateAddress - AddressInput
|
Alternate address |
taxResidencies - [NonIndividualTaxResidencyInput!]!
|
Tax residencies |
clientClassification - NonIndividualClientClassification
|
Client/Beneficiary classification |
partnershipType - PartnershipSubType!
|
The subtype of the partnership |
countryOfEstablishment - CountryShortCode!
|
Country where the partnership was established |
Example
{
"customerId": 4,
"roles": ["BENEFICIARY"],
"reference": "abc123",
"fullName": "abc123",
"businessNumber": "abc123",
"email": "xyz789",
"workPhone": "xyz789",
"registeredOfficeAddress": AddressInput,
"alternateAddress": AddressInput,
"taxResidencies": [NonIndividualTaxResidencyInput],
"clientClassification": "COMPANY",
"partnershipType": "REGULATED",
"countryOfEstablishment": CountryShortCode
}
CreatePartyTrustInput
Description
Options for creation of a trust.
Fields
| Input Field | Description |
|---|---|
customerId - ID!
|
Customer the party will be created for |
roles - [Role!]!
|
The roles this party can be on an account |
fullName - String!
|
Name of the trust |
reference - String
|
External party reference |
trustType - TrustSubType!
|
The subtype of the trust which determines allowed subfields downstream |
clientClassification - NonIndividualClientClassification
|
Client/Beneficiary classification |
businessNumber - String
|
Australian Business Number issued by the Australian Tax Office |
registeredSchemeNumber - String
|
Australian Registered Scheme Number provided by the ASIC to Australian Managed Investments Schemes |
countryOfEstablishment - CountryShortCode!
|
Country where the trust was established |
registeredOfficeAddress - AddressInput!
|
Registered Office Address. Cannot be a PO Box |
alternateAddress - AddressInput
|
Alternate address |
email - String
|
|
workPhone - String
|
Work phone |
taxResidencies - [NonIndividualTaxResidencyInput!]!
|
Tax residencies |
selfCertified - SelfCertifiedInput
|
Self-certification date |
taxReportingType - NonIndividualTaxReportingType
|
Tax reporting type |
noTaxResidency - Boolean
|
Whether the trust has no residency for tax purposes |
giin - String
|
The Global Intermediary Identification Number |
countryOfEffectiveManagement - CountryShortCode
|
Country of effective management |
controllingPersons - [ID!]
|
A list of individual party ids who have the role of controlling person |
Example
{
"customerId": "4",
"roles": ["BENEFICIARY"],
"fullName": "xyz789",
"reference": "abc123",
"trustType": "REGULATED_SELF_MANAGED_SUPER_FUND",
"clientClassification": "COMPANY",
"businessNumber": "abc123",
"registeredSchemeNumber": "xyz789",
"countryOfEstablishment": CountryShortCode,
"registeredOfficeAddress": AddressInput,
"alternateAddress": AddressInput,
"email": "xyz789",
"workPhone": "xyz789",
"taxResidencies": [NonIndividualTaxResidencyInput],
"selfCertified": SelfCertifiedInput,
"taxReportingType": "EXEMPT_ENTITY",
"noTaxResidency": false,
"giin": "xyz789",
"countryOfEffectiveManagement": CountryShortCode,
"controllingPersons": ["4"]
}
CreateScheduledBankReportInput
Fields
| Input Field | Description |
|---|---|
reportId - ID!
|
Unique id of the report to be scheduled. |
scheduleParameters - ScheduleParametersInput!
|
The parameters used to specify the schedule. |
Example
{
"reportId": 4,
"scheduleParameters": ScheduleParametersInput
}
CreateScheduledCustomerReportInput
Fields
| Input Field | Description |
|---|---|
reportId - ID!
|
Unique id of the report to be scheduled. |
customerId - ID!
|
The customer to schedule the report for. |
scheduleParameters - ScheduleParametersInput!
|
The parameters used to specify the schedule. |
Example
{
"reportId": 4,
"customerId": 4,
"scheduleParameters": ScheduleParametersInput
}
CreditAmount
Fields
| Field Name | Description |
|---|---|
creditDebit - CreditAmountType
|
|
currency - CurrencyCode
|
|
value - String
|
Example
{
"creditDebit": "CREDIT",
"currency": CurrencyCode,
"value": "abc123"
}
CreditAmountType
Values
| Enum Value | Description |
|---|---|
|
|
Example
"CREDIT"
CreditDebit
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"CREDIT"
CurrencyCode
Description
ISO 4217 alphabetic three letter currency code, for example GBP.
Example
CurrencyCode
CurrencyFeatureConfig
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
currencies - [CurrencyCode!]
|
Example
{
"id": "4",
"name": "xyz789",
"currencies": [CurrencyCode]
}
CurrencyFeatureConfigInput
Fields
| Input Field | Description |
|---|---|
currencies - [CurrencyCode!]
|
Example
{"currencies": [CurrencyCode]}
CurrencyRateInput
Fields
| Input Field | Description |
|---|---|
currency - CurrencyCode!
|
|
namedRate - ID!
|
Example
{"currency": CurrencyCode, "namedRate": 4}
CurrentWithholdingTaxAU
Fields
| Field Name | Description |
|---|---|
effectiveTimestamp - DateTime!
|
|
nonResidentRate - RateValue!
|
|
resident - WithholdingTaxAUResident!
|
|
nominatedAccount - WithholdingTaxNominatedAccount!
|
|
financialYearStart - DateWithoutYear!
|
|
apcaId - String
|
Example
{
"effectiveTimestamp": "2007-12-03T10:15:30Z",
"nonResidentRate": RateValue,
"resident": WithholdingTaxAUResident,
"nominatedAccount": WithholdingTaxNominatedAccount,
"financialYearStart": DateWithoutYear,
"apcaId": "abc123"
}
Customer
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
fullName - String!
|
|
displayName - String!
|
|
apcaDirectEntryDebitId - String
|
|
apcaDirectEntryCreditId - String
|
|
authLink - String
|
|
designatedInterestAccount - DesignatedInterestAccount
|
|
reportingFinancialInstitution - ReportingFinancialInstitution!
|
Whether the customer is Reporting Financial Institution |
usFinancialInstitution - Boolean!
|
Whether the customer is a US Financial Institution |
giin - String
|
The Global Intermediary Identification Number |
reporter - Reporter!
|
Whether the bank or customer is responsible for producing the Annual Investment Income Report |
associatedParty - Party
|
The party which represents this customer |
billingId - String
|
The billing id for this customer within the bank |
blockDirectDebits - Boolean!
|
A flag specifying whether direct debits are allocatable by the customer. |
knowYourCustomerId - String
|
Know Your Customer (KYC) ID |
accounts - AccountConnection!
|
|
Arguments
|
|
namedRates - NamedRateConnection!
|
|
Arguments |
|
products - ProductConnection!
|
|
Arguments
|
|
pools - CustomerPoolConnection!
|
|
Arguments
|
|
sources - CustomerSourceConnection!
|
|
Arguments
|
|
parties - PartyConnection!
|
|
Arguments
|
|
linkedAccounts - [CustomerLinkedAccount!]
|
|
Arguments
|
|
aggregateTransactions - AggregatePaymentConnection!
|
|
Arguments
|
|
businessProcesses - BusinessProcessConnection!
|
|
Arguments
|
|
scheduledReports - ScheduledReportConnection!
|
The scheduled customer reports for the customer. |
Arguments |
|
actionControlDateLimits - ActionControlDateLimits!
|
Date limit controls for customer actions on payments/receipts. |
interest - [CustomerInterest!]!
|
|
coreSystemDetails - CoreSystemDetails
|
|
sourceAccountAliases - CustomerSourceAccountAliasConnection!
|
|
Arguments |
|
autoSweepAvailable - Boolean!
|
|
autoSweepEnabled - Boolean!
|
|
autoSweepDetails - AutoSweepDetails
|
|
counterpartyType - CounterpartyType
|
|
approvals - ApprovalConnection!
|
|
Arguments |
|
Example
{
"id": "4",
"fullName": "abc123",
"displayName": "abc123",
"apcaDirectEntryDebitId": "xyz789",
"apcaDirectEntryCreditId": "xyz789",
"authLink": "xyz789",
"designatedInterestAccount": DesignatedInterestAccount,
"reportingFinancialInstitution": "YES",
"usFinancialInstitution": false,
"giin": "abc123",
"reporter": "BANK",
"associatedParty": Party,
"billingId": "xyz789",
"blockDirectDebits": false,
"knowYourCustomerId": "xyz789",
"accounts": AccountConnection,
"namedRates": NamedRateConnection,
"products": ProductConnection,
"pools": CustomerPoolConnection,
"sources": CustomerSourceConnection,
"parties": PartyConnection,
"linkedAccounts": [CustomerLinkedAccount],
"aggregateTransactions": AggregatePaymentConnection,
"businessProcesses": BusinessProcessConnection,
"scheduledReports": ScheduledReportConnection,
"actionControlDateLimits": ActionControlDateLimits,
"interest": [CustomerInterest],
"coreSystemDetails": CoreSystemDetails,
"sourceAccountAliases": CustomerSourceAccountAliasConnection,
"autoSweepAvailable": false,
"autoSweepEnabled": false,
"autoSweepDetails": AutoSweepDetails,
"counterpartyType": CounterpartyType,
"approvals": ApprovalConnection
}
CustomerConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [CustomerEdge]
|
|
aggregates - SimpleConnectionAggregate!
|
Example
{
"pageInfo": PageInfo,
"edges": [CustomerEdge],
"aggregates": SimpleConnectionAggregate
}
CustomerEdge
CustomerEdited
Description
Update containing details of an edited customer, including the latest changes made to the customer.
Fields
| Field Name | Description |
|---|---|
customer - Customer!
|
Example
{"customer": Customer}
CustomerFilter
Description
A simple use of this filter might look like:
filter: {fullNameExact:"Santa Claus"}
A filter with a top level 'or' might look like:
filter: {or: [{fullNameExact: "Santa Claus"}, {displayNameExact: "Father Christmas"}]}
Fields
| Input Field | Description |
|---|---|
or - [CustomerFilter!]
|
|
fullNameContains - String
|
|
fullNameExact - String
|
|
displayNameContains - String
|
|
displayNameExact - String
|
Example
{
"or": [CustomerFilter],
"fullNameContains": "abc123",
"fullNameExact": "abc123",
"displayNameContains": "abc123",
"displayNameExact": "abc123"
}
CustomerInterest
Fields
| Field Name | Description |
|---|---|
currency - CurrencyCode!
|
|
financialYearToDate - CustomerYearlyTotal
|
|
previousFinancialYears - [CustomerYearlyTotal!]
|
Example
{
"currency": CurrencyCode,
"financialYearToDate": CustomerYearlyTotal,
"previousFinancialYears": [CustomerYearlyTotal]
}
CustomerInterestFeatureConfig
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
rates - [NamedRate!]
|
Example
{
"id": 4,
"name": "xyz789",
"rates": [NamedRate]
}
CustomerInterestFeatureConfigInput
Fields
| Input Field | Description |
|---|---|
rates - [CurrencyRateInput!]
|
Example
{"rates": [CurrencyRateInput]}
CustomerLinkedAccount
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The id of the customer linked account |
customerId - ID!
|
The id of the customer the linked account is for. |
accountName - String!
|
The operating name of the account. |
accountHolder - String!
|
The entity/person controlling the account |
accountNumber - AccountNumber!
|
The account number of the account. |
bankCode - BankCode!
|
The bank code of the account. |
description - String
|
A short description of the linked account. |
paymentRequests - PaymentRequestConnection!
|
The payment requests associated with this customer linked account. Due to be replaced by businessProcesses list |
Arguments
|
|
businessProcesses - BusinessProcessConnection!
|
The business processes associated with this customer linked account. |
Arguments
|
|
Example
{
"id": 4,
"customerId": 4,
"accountName": "abc123",
"accountHolder": "xyz789",
"accountNumber": "000000012345",
"bankCode": BankCode,
"description": "xyz789",
"paymentRequests": PaymentRequestConnection,
"businessProcesses": BusinessProcessConnection
}
CustomerLinkedAccountDebtorOrigin
Fields
| Field Name | Description |
|---|---|
customerLinkedAccount - Identifier
|
|
customerLinkedAccountNode - CustomerLinkedAccount
|
Example
{
"customerLinkedAccount": Identifier,
"customerLinkedAccountNode": CustomerLinkedAccount
}
CustomerLinkedAccountDebtorOriginUnionableEnumWithholdingTaxNominatedAccountDebtorOriginUnion
Example
CustomerLinkedAccountDebtorOrigin
CustomerLinkedAccountFilter
CustomerListSubscription
Description
General subscription for any new or edited customers.
Types
| Union Types |
|---|
Example
CustomerOnboarded
CustomerManualInterestAdjustmentInput
Fields
| Input Field | Description |
|---|---|
claId - ID!
|
|
accountId - ID!
|
|
clientAmount - FullAmountInput!
|
|
reason - String!
|
Example
{
"claId": 4,
"accountId": "4",
"clientAmount": FullAmountInput,
"reason": "abc123"
}
CustomerNamedRate
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
currentOrNext - NamedRateEntry!
|
|
history - NamedRateEntryConnection!
|
|
Arguments
|
|
customer - Customer!
|
|
Example
{
"id": 4,
"currentOrNext": NamedRateEntry,
"history": NamedRateEntryConnection,
"customer": Customer
}
CustomerOnboarded
Description
Update containing details of a newly onboarded customer.
Fields
| Field Name | Description |
|---|---|
customer - Customer!
|
Example
{"customer": Customer}
CustomerOrdering
Fields
| Input Field | Description |
|---|---|
sort - CustomerSort!
|
|
direction - OrderingDirection!
|
Example
{"sort": "FULL_NAME", "direction": "ASC"}
CustomerPool
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique id of the pool. |
sourceType - SourceType!
|
Will have value of CUSTOMER for a BankPool. |
accounts - AccountConnection!
|
Source accounts which form the pool. |
Arguments
|
|
name - String!
|
The name of the pool. |
customer - Customer!
|
The customer that operates the pool. |
sources - SourceConnection!
|
Source accounts which form the pool. |
Arguments
|
|
internalAccounts - AccountConnection!
|
|
Arguments
|
|
unallocated - AllocatableConnection!
|
Unallocated transactions over source accounts within the pool. |
Arguments
|
|
matchedReversals - MatchedReversalConnection!
|
Matched reversals composed of a reversal and an unallocated payment or receipt. |
Arguments |
|
movedToCLA - AllocatableConnection!
|
Previously unallocated payments/receipts that have been moved to a customer linked account. |
Arguments
|
|
deleted - AllocatableConnection!
|
Deleted payments/receipts |
Arguments
|
|
Example
{
"id": "4",
"sourceType": "BANK",
"accounts": AccountConnection,
"name": "abc123",
"customer": Customer,
"sources": SourceConnection,
"internalAccounts": AccountConnection,
"unallocated": AllocatableConnection,
"matchedReversals": MatchedReversalConnection,
"movedToCLA": AllocatableConnection,
"deleted": AllocatableConnection
}
CustomerPoolConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [CustomerPoolEdge]
|
|
aggregates - PoolAggregate!
|
Example
{
"pageInfo": PageInfo,
"edges": [CustomerPoolEdge],
"aggregates": PoolAggregate
}
CustomerPoolEdge
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
|
node - CustomerPool!
|
Example
{
"cursor": "xyz789",
"node": CustomerPool
}
CustomerPoolFilter
CustomerPoolInput
CustomerPoolListSubscription
Types
| Union Types |
|---|
Example
PoolCreated
CustomerProduct
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
parent - Product
|
|
name - String!
|
|
description - String
|
|
code - String
|
|
codeSuffix - String
|
|
billingId - String
|
|
currencies - [String!]
|
|
governmentGuaranteeApplies - Boolean
|
|
costCentre - String
|
|
rmSet - String
|
|
retailLookThrough - RetailLookThrough
|
|
activeFeatures - [FeatureConfig!]!
|
|
availableFeatures - [FeatureConfig!]!
|
|
accounts - AccountConnection!
|
|
Arguments
|
|
customer - Customer!
|
|
grantedToCustomers - CustomerConnection!
|
|
Arguments
|
|
state - ProductState!
|
|
Example
{
"id": "4",
"parent": Product,
"name": "xyz789",
"description": "abc123",
"code": "xyz789",
"codeSuffix": "abc123",
"billingId": "xyz789",
"currencies": ["abc123"],
"governmentGuaranteeApplies": false,
"costCentre": "abc123",
"rmSet": "xyz789",
"retailLookThrough": RetailLookThrough,
"activeFeatures": [FeatureConfig],
"availableFeatures": [FeatureConfig],
"accounts": AccountConnection,
"customer": Customer,
"grantedToCustomers": CustomerConnection,
"state": "TEMPLATE"
}
CustomerProductAccrual
Fields
| Field Name | Description |
|---|---|
customer - AccrualAmount
|
|
client - AccrualAmount
|
|
margin - AccrualAmount
|
Example
{
"customer": AccrualAmount,
"client": AccrualAmount,
"margin": AccrualAmount
}
CustomerSort
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"FULL_NAME"
CustomerSource
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
sourceType - SourceType!
|
|
bankCode - BankCode!
|
|
currency - CurrencyCode!
|
|
name - String
|
|
accountNumber - AccountNumber
|
|
pool - CustomerPool!
|
|
balances - SourceBalances!
|
|
internalAccounts - AccountConnection!
|
|
Arguments
|
|
sourceAccountAliases - CustomerSourceAccountAliasConnection!
|
|
Arguments |
|
Example
{
"id": 4,
"sourceType": "BANK",
"bankCode": BankCode,
"currency": CurrencyCode,
"name": "abc123",
"accountNumber": "000000012345",
"pool": CustomerPool,
"balances": SourceBalances,
"internalAccounts": AccountConnection,
"sourceAccountAliases": CustomerSourceAccountAliasConnection
}
CustomerSourceAccountAlias
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
aliasBankCode - BankCode!
|
|
description - String
|
|
source - CustomerSource!
|
Example
{
"id": 4,
"aliasBankCode": BankCode,
"description": "xyz789",
"source": CustomerSource
}
CustomerSourceAccountAliasConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [CustomerSourceAccountAliasEdge]
|
|
aggregates - SimpleConnectionAggregate!
|
Example
{
"pageInfo": PageInfo,
"edges": [CustomerSourceAccountAliasEdge],
"aggregates": SimpleConnectionAggregate
}
CustomerSourceAccountAliasEdge
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
|
node - CustomerSourceAccountAlias!
|
Example
{
"cursor": "xyz789",
"node": CustomerSourceAccountAlias
}
CustomerSourceAccountAliasFilter
Fields
| Input Field | Description |
|---|---|
and - [CustomerSourceAccountAliasFilter!]
|
|
or - [CustomerSourceAccountAliasFilter!]
|
|
descriptionContains - String
|
|
aliasBankCodeExact - BankCode
|
|
aliasBankCodeContains - String
|
Example
{
"and": [CustomerSourceAccountAliasFilter],
"or": [CustomerSourceAccountAliasFilter],
"descriptionContains": "abc123",
"aliasBankCodeExact": BankCode,
"aliasBankCodeContains": "abc123"
}
CustomerSourceAccountAliasInput
CustomerSourceConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [CustomerSourceEdge]
|
|
aggregates - SimpleConnectionAggregate!
|
Example
{
"pageInfo": PageInfo,
"edges": [CustomerSourceEdge],
"aggregates": SimpleConnectionAggregate
}
CustomerSourceEdge
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
|
node - CustomerSource!
|
Example
{
"cursor": "xyz789",
"node": CustomerSource
}
CustomerSourceFilter
Fields
| Input Field | Description |
|---|---|
bankCode - BankCode
|
|
accountNumber - AccountNumber
|
|
nameExact - String
|
|
nameContains - String
|
Example
{
"bankCode": BankCode,
"accountNumber": "000000012345",
"nameExact": "xyz789",
"nameContains": "abc123"
}
CustomerSourceInput
Description
Options for registration of a bank source account.
Fields
| Input Field | Description |
|---|---|
poolId - ID!
|
The id of the pool the source account is associated with. |
bankCode - BankCode!
|
The bank code of the account. |
accountNumber - AccountNumber!
|
The account number of the account. |
currency - CurrencyCode!
|
The ISO currency of the account. |
name - String
|
The name of the source account. |
Example
{
"poolId": 4,
"bankCode": BankCode,
"accountNumber": "000000012345",
"currency": CurrencyCode,
"name": "abc123"
}
CustomerSubscription
Description
Specific subscription for edits to a single customer.
Types
| Union Types |
|---|
Example
CustomerEdited
CustomerUser
Example
{
"name": "xyz789",
"username": "xyz789",
"displayName": "xyz789",
"sub": "xyz789",
"scopes": ["abc123"],
"customer": Customer
}
CustomerYearlyTotal
Fields
| Field Name | Description |
|---|---|
year - Year!
|
|
currency - CurrencyCode!
|
|
interest - Amount!
|
|
margin - Amount!
|
Example
{
"year": Year,
"currency": CurrencyCode,
"interest": Amount,
"margin": Amount
}
DEPurpose
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CASH"
DERecipient
Description
Identifying details for the recipient of a Direct Entry payment.
Fields
| Input Field | Description |
|---|---|
name - String!
|
The recipients name. |
accountNumber - AccountNumber!
|
The account number the Direct Entry payment is to be sent to. |
bankCode - BankCode!
|
The bank code of the account the Direct Entry payment is to be sent to. |
Example
{
"name": "abc123",
"accountNumber": "000000012345",
"bankCode": BankCode
}
DESender
Description
Identifying details for the sender of a Direct Entry payment.
Fields
| Input Field | Description |
|---|---|
accountId - ID!
|
The unique id of the account the Direct Entry payment is initiated from. |
Example
{"accountId": "4"}
Date
Description
Date in YYYY-MM-DD format.
Example
"2007-12-03"
DateFilter
DateTime
Description
DateTime in ISO 8601 format.
Example
"2007-12-03T10:15:30Z"
DateTimeFilter
DateWithoutYear
Description
Date without year in ISO 8601 format (--MM-DD).
Example
DateWithoutYear
DayCountConvention
Description
Day count convention to be applied when calculating interest.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ACTUAL_365"
DeClaRecipient
Fields
| Field Name | Description |
|---|---|
customerLinkedAccount - Identifier
|
|
customerLinkedAccountNode - CustomerLinkedAccount
|
Example
{
"customerLinkedAccount": Identifier,
"customerLinkedAccountNode": CustomerLinkedAccount
}
DeClaRecipientNonClaDeRecipientUnion
Types
| Union Types |
|---|
Example
DeClaRecipient
DePaymentFeatureConfig
DebitAmount
Fields
| Field Name | Description |
|---|---|
creditDebit - DebitAmountType
|
|
currency - CurrencyCode
|
|
value - String
|
Example
{
"creditDebit": "DEBIT",
"currency": CurrencyCode,
"value": "abc123"
}
DebitAmountType
Values
| Enum Value | Description |
|---|---|
|
|
Example
"DEBIT"
DeceasedPartyInput
Description
Options when recording a party as deceased.
Example
{
"partyId": "4",
"dateOfDeath": "2007-12-03"
}
DefaultTrusteesFeatureConfig
DefaultTrusteesFeatureConfigInput
Fields
| Input Field | Description |
|---|---|
trustees - [ID!]!
|
Example
{"trustees": ["4"]}
DeleteCustomerLinkedAccountInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The id of the linked account to be deleted. |
Example
{"id": 4}
DeleteCustomerSourceAccountAliasInput
Fields
| Input Field | Description |
|---|---|
sourceAliasId - ID!
|
Example
{"sourceAliasId": 4}
DeletePartyInput
Description
Options when deleting a party.
Fields
| Input Field | Description |
|---|---|
partyId - ID!
|
The id of the individual to be deleted. |
Example
{"partyId": "4"}
DeleteScheduledReportInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The id of the scheduled report to delete. |
Example
{"id": 4}
DeletedListSubscription
Types
| Union Types |
|---|
Example
ReceiptRemoved
DeletionDecisionInput
Fields
| Input Field | Description |
|---|---|
allocatableId - ID!
|
Unique id of the Payment or Receipt that was requested to be deleted. |
decision - DeletionDecisionType!
|
Whether to approve or deny the request. |
Example
{"allocatableId": 4, "decision": "APPROVE"}
DeletionDecisionType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"APPROVE"
DesignatedInterestAccount
Fields
| Field Name | Description |
|---|---|
name - String!
|
|
accountNumber - AccountNumber!
|
|
bankCode - BankCode!
|
Example
{
"name": "xyz789",
"accountNumber": "000000012345",
"bankCode": BankCode
}
DestinationAccount
Fields
| Field Name | Description |
|---|---|
name - String
|
|
accountNumber - AccountNumber
|
|
bankCode - BankCode
|
Example
{
"name": "abc123",
"accountNumber": "000000012345",
"bankCode": BankCode
}
DoEncryptedCommandDetails
Fields
| Field Name | Description |
|---|---|
customer - Identifier
|
|
customerNode - Customer
|
|
payload - String
|
Example
{
"customer": Identifier,
"customerNode": Customer,
"payload": "abc123"
}
EditCustomerInput
Description
Options when updating details of a customer.
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The id of the customer to be updated. |
fullName - String
|
The new full legal name to apply to the customer. |
apcaDirectEntryDebitId - String
|
The new APCA id for use with direct debits. |
apcaDirectEntryCreditId - String
|
The new APCA id for use with direct credits. |
designatedInterestAccount - EditExtAccountInput
|
New details of the account customer interest is to be paid to. |
reportingFinancialInstitution - ReportingFinancialInstitution
|
Whether the customer is Reporting Financial Institution |
usFinancialInstitution - Boolean
|
Whether the customer is a US Financial Institution |
giin - String
|
The Global Intermediary Identification Number |
reporter - Reporter
|
Whether the bank or customer is responsible for producing the Annual Investment Income Report |
billingId - String
|
The billing id for this customer within the bank |
blockDirectDebits - Boolean
|
Controls whether direct debits will be allocatable by the customer. |
actionControlDateLimits - ActionControlDateLimitInput
|
Allows configurable date limit control for customer actions on payments/receipts. |
knowYourCustomerId - String
|
Know Your Customer (KYC) ID |
coreSystemDetails - CoreSystemDetailsInput
|
Details of the (external) core system that a customer resides on. E.g. ANZ's Cache |
autoSweepAvailable - Boolean
|
Determines whether the auto-sweep functionality is available for customers to enable. |
counterpartyType - CounterpartyType
|
Counterparty type for the customer |
Example
{
"id": "4",
"fullName": "xyz789",
"apcaDirectEntryDebitId": "xyz789",
"apcaDirectEntryCreditId": "abc123",
"designatedInterestAccount": EditExtAccountInput,
"reportingFinancialInstitution": "YES",
"usFinancialInstitution": false,
"giin": "abc123",
"reporter": "BANK",
"billingId": "xyz789",
"blockDirectDebits": false,
"actionControlDateLimits": ActionControlDateLimitInput,
"knowYourCustomerId": "xyz789",
"coreSystemDetails": CoreSystemDetailsInput,
"autoSweepAvailable": false,
"counterpartyType": CounterpartyType
}
EditExtAccountInput
Fields
| Input Field | Description |
|---|---|
name - String
|
|
accountNumber - AccountNumber
|
|
bankCode - BankCode
|
Example
{
"name": "xyz789",
"accountNumber": "000000012345",
"bankCode": BankCode
}
EditPartyAssociationInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The id of the party association to be updated. |
roles - [Role!]
|
The roles this party can be on an account |
reference - String
|
External party reference |
fullName - String
|
Name of the association |
businessNumber - String
|
Australian Business Number issued by the Australian Tax Office |
email - String
|
|
workPhone - String
|
Work phone |
registeredOfficeAddress - AddressInput
|
Registered Office Address. Cannot be a PO Box |
alternateAddress - AddressInput
|
Alternate address |
clientClassification - NonIndividualClientClassification
|
Client/Beneficiary classification |
taxResidencies - [NonIndividualTaxResidencyInput!]
|
Tax residencies |
associationType - AssociationSubType
|
The subtype of the association which determines allowed fields downstream |
registeredBodyNumber - String
|
Australian Registered Body Number provided by ASIC - 9 digits all numerical |
incorporationDate - Date
|
Date of Incorporation/Registration |
incorporationCountry - CountryShortCode
|
Country of Incorporation/Registration |
countryOfEstablishment - CountryShortCode
|
Country where the unincorporated association was established |
Example
{
"id": 4,
"roles": ["BENEFICIARY"],
"reference": "abc123",
"fullName": "abc123",
"businessNumber": "abc123",
"email": "abc123",
"workPhone": "abc123",
"registeredOfficeAddress": AddressInput,
"alternateAddress": AddressInput,
"clientClassification": "COMPANY",
"taxResidencies": [NonIndividualTaxResidencyInput],
"associationType": "INCORPORATED",
"registeredBodyNumber": "xyz789",
"incorporationDate": "2007-12-03",
"incorporationCountry": CountryShortCode,
"countryOfEstablishment": CountryShortCode
}
EditPartyCompanyInput
Description
Options when updating details of a party company.
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The id of the party company to be updated. |
roles - [Role!]
|
The roles this party can be on an account |
reference - String
|
External party reference |
companyType - CompanySubType
|
The subtype of the company which determines allowed fields downstream |
clientClassification - NonIndividualClientClassification
|
Client/Beneficiary classification |
fullName - String
|
Name of the company |
companyNumber - String
|
Australian Company Number provided by ASIC as part of the registration process |
registeredBodyNumber - String
|
Australian Registered Body Number provided by ASIC - 9 digits all numerical |
businessNumber - String
|
Australian Business Number issued by the Australian Tax Office |
incorporationDate - Date
|
Date of Incorporation/Registration |
incorporationCountry - CountryShortCode
|
Country of Incorporation/Registration |
stockExchange - String
|
Name of Stock Exchange. Optional only to be used for public companies type |
tradingName - String
|
Could be different from the full legal name of the company on the registration certificate |
email - String
|
|
workPhone - String
|
Work phone |
registeredOfficeAddress - AddressInput
|
Registered Office Address. Cannot be a PO Box |
alternateAddress - AddressInput
|
Alternate address |
taxResidencies - [NonIndividualTaxResidencyInput!]
|
Tax residencies |
selfCertified - SelfCertifiedInput
|
Self-certification date |
taxReportingType - NonIndividualTaxReportingType
|
Tax reporting type |
noTaxResidency - Boolean
|
Whether the company has no residency for tax purposes |
giin - String
|
The Global Intermediary Identification Number |
countryOfEffectiveManagement - CountryShortCode
|
Country of effective management |
controllingPersons - [ID!]
|
A list of individual party ids who have the role of controlling person |
countryOfEstablishment - CountryShortCode
|
Country where the company was established |
Example
{
"id": 4,
"roles": ["BENEFICIARY"],
"reference": "abc123",
"companyType": "PRIVATE",
"clientClassification": "COMPANY",
"fullName": "xyz789",
"companyNumber": "abc123",
"registeredBodyNumber": "abc123",
"businessNumber": "abc123",
"incorporationDate": "2007-12-03",
"incorporationCountry": CountryShortCode,
"stockExchange": "abc123",
"tradingName": "abc123",
"email": "xyz789",
"workPhone": "xyz789",
"registeredOfficeAddress": AddressInput,
"alternateAddress": AddressInput,
"taxResidencies": [NonIndividualTaxResidencyInput],
"selfCertified": SelfCertifiedInput,
"taxReportingType": "EXEMPT_ENTITY",
"noTaxResidency": true,
"giin": "xyz789",
"countryOfEffectiveManagement": CountryShortCode,
"controllingPersons": ["4"],
"countryOfEstablishment": CountryShortCode
}
EditPartyCooperativeInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The id of the party cooperative to be updated. |
roles - [Role!]
|
The roles this party can be on an account |
reference - String
|
External party reference |
fullName - String
|
Name of the cooperative |
businessNumber - String
|
Australian Business Number issued by the Australian Tax Office |
email - String
|
|
workPhone - String
|
Work phone |
registeredOfficeAddress - AddressInput
|
Registered Office Address. Cannot be a PO Box |
alternateAddress - AddressInput
|
Alternate address |
clientClassification - NonIndividualClientClassification
|
Client/Beneficiary classification |
taxResidencies - [NonIndividualTaxResidencyInput!]
|
Tax residencies |
registeredBodyNumber - String
|
Australian Registered Body Number provided by ASIC - 9 digits all numerical |
countryOfEstablishment - CountryShortCode
|
Country where the unincorporated cooperative was established |
Example
{
"id": "4",
"roles": ["BENEFICIARY"],
"reference": "xyz789",
"fullName": "xyz789",
"businessNumber": "xyz789",
"email": "xyz789",
"workPhone": "abc123",
"registeredOfficeAddress": AddressInput,
"alternateAddress": AddressInput,
"clientClassification": "COMPANY",
"taxResidencies": [NonIndividualTaxResidencyInput],
"registeredBodyNumber": "abc123",
"countryOfEstablishment": CountryShortCode
}
EditPartyGovernmentBodyInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The id of the party gov body to be updated. |
roles - [Role!]
|
The roles this party can be on an account |
reference - String
|
External party reference |
fullName - String
|
Name of the gov body |
businessNumber - String
|
Australian Business Number issued by the Australian Tax Office |
email - String
|
|
workPhone - String
|
Work phone |
registeredOfficeAddress - AddressInput
|
Registered Office Address. Cannot be a PO Box |
alternateAddress - AddressInput
|
Alternate address |
taxResidencies - [NonIndividualTaxResidencyInput!]
|
Tax residencies |
clientClassification - NonIndividualClientClassification
|
Client/Beneficiary classification |
governmentBodyType - GovernmentBodySubType
|
The subtype of the gov body |
countryOfEstablishment - CountryShortCode
|
Country where the gov body was established |
Example
{
"id": "4",
"roles": ["BENEFICIARY"],
"reference": "xyz789",
"fullName": "abc123",
"businessNumber": "xyz789",
"email": "xyz789",
"workPhone": "abc123",
"registeredOfficeAddress": AddressInput,
"alternateAddress": AddressInput,
"taxResidencies": [NonIndividualTaxResidencyInput],
"clientClassification": "COMPANY",
"governmentBodyType": "OFFSHORE",
"countryOfEstablishment": CountryShortCode
}
EditPartyIndividualInput
Description
Options when updating details of a party individual.
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The id of the party individual to be updated. |
title - String
|
The individuals title. |
givenName - String
|
The individuals given (first) name. |
otherGivenNames - [String!]
|
List of names, other than given or family, for the individual. |
familyName - String
|
The individuals family (last) name. |
reference - String
|
Customer provided reference for the individual. This must be unique over all individuals of the customer. |
gender - Gender
|
The individuals gender. |
dateOfBirth - Date
|
The individuals date of birth. Must be provided if the individual is being registered as 'self-certified'. |
residentialAddress - AddressInput
|
The individuals main residential address. Must not be a PO Box or other restricted address for KYC compliance. |
alternateAddress - AddressInput
|
Alternate address for the individual. |
taxResidencies - [IndividualTaxResidencyInput!]
|
List of all countries the individual has tax residency obligations in. |
selfCertified - SelfCertifiedInput
|
Is the individual being registered as self certified for tax reporting purposes. |
roles - [Role!]
|
List of roles the individual may perform on accounts or companies (Beneficiary, Trustee or Controlling Person). |
Example
{
"id": 4,
"title": "abc123",
"givenName": "abc123",
"otherGivenNames": ["abc123"],
"familyName": "xyz789",
"reference": "xyz789",
"gender": Gender,
"dateOfBirth": "2007-12-03",
"residentialAddress": AddressInput,
"alternateAddress": AddressInput,
"taxResidencies": [IndividualTaxResidencyInput],
"selfCertified": SelfCertifiedInput,
"roles": ["BENEFICIARY"]
}
EditPartyPartnershipInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The id of the party partnership to be updated. |
roles - [Role!]
|
The roles this party can be on an account |
reference - String
|
External party reference |
fullName - String
|
Name of the cooperative |
businessNumber - String
|
Australian Business Number issued by the Australian Tax Office |
email - String
|
|
workPhone - String
|
Work phone |
registeredOfficeAddress - AddressInput
|
Registered Office Address. Cannot be a PO Box |
alternateAddress - AddressInput
|
Alternate address |
clientClassification - NonIndividualClientClassification
|
Client/Beneficiary classification |
taxResidencies - [NonIndividualTaxResidencyInput!]
|
Tax residencies |
partnershipType - PartnershipSubType
|
Subtype of the partnership |
countryOfEstablishment - CountryShortCode
|
Country where the unincorporated cooperative was established |
Example
{
"id": "4",
"roles": ["BENEFICIARY"],
"reference": "abc123",
"fullName": "xyz789",
"businessNumber": "xyz789",
"email": "abc123",
"workPhone": "xyz789",
"registeredOfficeAddress": AddressInput,
"alternateAddress": AddressInput,
"clientClassification": "COMPANY",
"taxResidencies": [NonIndividualTaxResidencyInput],
"partnershipType": "REGULATED",
"countryOfEstablishment": CountryShortCode
}
EditPartyTrustInput
Description
Options when updating details of a party trust.
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The id of the party trust to be updated. |
roles - [Role!]
|
The roles this party can be on an account |
fullName - String
|
Name of the trust |
reference - String
|
External party reference |
trustType - TrustSubType
|
The subtype of the trust which determines allowed subfields downstream |
clientClassification - NonIndividualClientClassification
|
Client/Beneficiary classification |
businessNumber - String
|
Australian Business Number issued by the Australian Tax Office |
registeredSchemeNumber - String
|
Australian Registered Scheme Number similar to the ABRN for companies |
countryOfEstablishment - CountryShortCode
|
Country where the trust was established |
registeredOfficeAddress - AddressInput
|
Registered Office Address. Cannot be a PO Box |
alternateAddress - AddressInput
|
Alternate address |
email - String
|
|
workPhone - String
|
Work phone |
taxResidencies - [NonIndividualTaxResidencyInput!]
|
Tax residencies |
selfCertified - SelfCertifiedInput
|
Self-certification date |
taxReportingType - NonIndividualTaxReportingType
|
Tax reporting type |
noTaxResidency - Boolean
|
Whether the trust has no residency for tax purposes |
giin - String
|
The Global Intermediary Identification Number |
countryOfEffectiveManagement - CountryShortCode
|
Country of effective management |
controllingPersons - [ID!]
|
A list of individual party ids who have the role of controlling person |
Example
{
"id": 4,
"roles": ["BENEFICIARY"],
"fullName": "xyz789",
"reference": "xyz789",
"trustType": "REGULATED_SELF_MANAGED_SUPER_FUND",
"clientClassification": "COMPANY",
"businessNumber": "abc123",
"registeredSchemeNumber": "xyz789",
"countryOfEstablishment": CountryShortCode,
"registeredOfficeAddress": AddressInput,
"alternateAddress": AddressInput,
"email": "abc123",
"workPhone": "xyz789",
"taxResidencies": [NonIndividualTaxResidencyInput],
"selfCertified": SelfCertifiedInput,
"taxReportingType": "EXEMPT_ENTITY",
"noTaxResidency": false,
"giin": "abc123",
"countryOfEffectiveManagement": CountryShortCode,
"controllingPersons": ["4"]
}
EditProductInput
Fields
| Input Field | Description |
|---|---|
productId - ID!
|
|
name - String
|
|
description - String
|
|
codeSuffix - String
|
|
billingId - String
|
|
governmentGuaranteeApplies - Boolean
|
|
costCentre - String
|
|
rmSet - String
|
|
retailLookThrough - RetailLookThroughInput
|
|
featureAvailability - [FeatureName!]
|
List of features to make available, constrained by features available in the parent product |
featureActivation - FeatureActivationInput
|
Map of features to make active, as long as the feature is available. Limited to payment features only |
featureEdit - FeatureEditInput
|
|
featureRemove - [FeatureRemove!]
|
Example
{
"productId": 4,
"name": "xyz789",
"description": "abc123",
"codeSuffix": "xyz789",
"billingId": "xyz789",
"governmentGuaranteeApplies": false,
"costCentre": "abc123",
"rmSet": "abc123",
"retailLookThrough": RetailLookThroughInput,
"featureAvailability": ["CURRENCY"],
"featureActivation": FeatureActivationInput,
"featureEdit": FeatureEditInput,
"featureRemove": ["SELF_CERTIFICATION_REQUIRED"]
}
EditableAddress
EncryptedCommand
Fields
| Field Name | Description |
|---|---|
action - String!
|
Use operation field, the operation field is an enumeration that makes it easier to query with |
approval - Approval
|
|
createdTimestamp - DateTime
|
|
customer - Customer
|
|
id - ID!
|
|
inputJson - String
|
|
invalid - [CommandError]!
|
|
operation - Action!
|
|
state - CommandState!
|
|
step - String!
|
|
unencryptedCommand - Command
|
|
user - String!
|
Use userInfo, as this only details the sub |
userInfo - UserInfo!
|
|
userInput - DoEncryptedCommandDetails
|
Example
{
"action": "xyz789",
"approval": Approval,
"createdTimestamp": "2007-12-03T10:15:30Z",
"customer": Customer,
"id": 4,
"inputJson": "xyz789",
"invalid": [CommandError],
"operation": "AGGREGATE_PAYMENT_EXECUTE",
"state": "SUBMITTED",
"step": "xyz789",
"unencryptedCommand": Command,
"user": "xyz789",
"userInfo": UserInfo,
"userInput": DoEncryptedCommandDetails
}
EncryptedInput
Description
Payload for an encrypted request.
Example
{
"encryptedPayload": "abc123",
"customerId": "4"
}
EncryptedPayloadSchemas
ExecuteAggregatePaymentInput
Fields
| Input Field | Description |
|---|---|
externalAccount - AggregatePaymentExternalAccountInput!
|
|
reference - String!
|
common reference to be associated with all transactions included in the aggregate-payment |
customerTransactionReference - String
|
An optional reference that can later be used to search for the AggregatePayment |
count - Int!
|
total count of instructions |
totalAmount - FullAmountInput!
|
sum of all instructions |
instructions - [InstructionInput!]!
|
Example
{
"externalAccount": AggregatePaymentExternalAccountInput,
"reference": "xyz789",
"customerTransactionReference": "abc123",
"count": 987,
"totalAmount": FullAmountInput,
"instructions": [InstructionInput]
}
ExternalAccountInput
Fields
| Input Field | Description |
|---|---|
name - String!
|
|
accountNumber - AccountNumber!
|
|
bankCode - BankCode!
|
|
paymentType - AggregatePaymentType!
|
Example
{
"name": "xyz789",
"accountNumber": "000000012345",
"bankCode": BankCode,
"paymentType": "DE"
}
ExternalIdInput
Feature
Fields
| Field Name | Description |
|---|---|
name - FeatureName!
|
|
subfeatures - [FeatureName!]!
|
Example
{"name": "CURRENCY", "subfeatures": ["CURRENCY"]}
FeatureActivationInput
Fields
| Input Field | Description |
|---|---|
payment - Boolean
|
|
dePayment - Boolean
|
|
rtgsPayment - Boolean
|
|
statements - StatementsFeatureConfigInput
|
Example
{
"payment": false,
"dePayment": true,
"rtgsPayment": false,
"statements": StatementsFeatureConfigInput
}
FeatureConfig
Possible Types
| FeatureConfig Types |
|---|
Example
{"id": 4, "name": "xyz789"}
FeatureEditInput
Fields
| Input Field | Description |
|---|---|
statements - StatementsFeatureConfigInput
|
Example
{"statements": StatementsFeatureConfigInput}
FeatureGraph
Description
Use this to determine valid product specialisations.
Fields
| Field Name | Description |
|---|---|
features - [Feature!]!
|
Example
{"features": [Feature]}
FeatureName
Values
| Enum Value | Description |
|---|---|
|
|
Enables a list of supported currencies to be configured for the product. |
|
|
|
|
|
Enable restrictions on roles that must be provided when opening accounts with the product. |
|
|
Configure trustees (parties) that would be automatically added when opening accounts with the product. |
|
|
Enable payments to be initiated from accounts created with the product. |
|
|
Avalability of Direct Entry payments. |
|
|
Avalability of RTGS payments. |
|
|
Enable interest to be configured on the product. |
|
|
Availability of client interest on the product. |
|
|
Availability of customer interest on the product. |
|
|
This feature detects and prevents transactions, initiated within the platform, that would result in a negative balance on an account. |
|
|
This feature is part of a mechanism to ensure the required data for financial accounts is captured to be compliant with the Common Reporting Standard |
|
|
Example
"CURRENCY"
FeatureRemove
Values
| Enum Value | Description |
|---|---|
|
|
Example
"SELF_CERTIFICATION_REQUIRED"
FixedNamedRateEntry
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
currency - CurrencyCode!
|
|
startDate - Date!
|
|
rate - RateValue!
|
|
namedRate - NamedRate!
|
Example
{
"id": 4,
"name": "xyz789",
"currency": CurrencyCode,
"startDate": "2007-12-03",
"rate": RateValue,
"namedRate": NamedRate
}
FixedNamedRateInput
Description
Options when creating a fixed interest rate.
Fields
| Input Field | Description |
|---|---|
name - String!
|
The name for the rate. |
currency - CurrencyCode!
|
The ISO currency code the rate is effective for. |
startDate - Date!
|
The date the rate is effective from. |
rate - RateValue!
|
The value of the rate. |
customerId - ID
|
Id of a customer the rate is created on behalf of. If provided the customer will have permission to maintain future values of the rate. |
Example
{
"name": "abc123",
"currency": CurrencyCode,
"startDate": "2007-12-03",
"rate": RateValue,
"customerId": "4"
}
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
123.45
FullAmountInput
Fields
| Input Field | Description |
|---|---|
value - AmountValue!
|
|
currency - CurrencyCode!
|
|
creditDebit - CreditDebit!
|
Example
{
"value": AmountValue,
"currency": CurrencyCode,
"creditDebit": "CREDIT"
}
Gender
Description
Uppercase, single letter code for gender.
Example
Gender
GenericAllocatable
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
createdTimestamp - DateTime!
|
|
valueDate - Date!
|
|
amount - Amount!
|
|
remainingUnallocated - Amount
|
|
allocationState - AllocationState!
|
|
allocation - Allocation
|
|
unallocatedReason - String
|
|
unallocatedReasonCode - UnallocatedReasonCode
|
|
unallocatable - Boolean!
|
|
pool - Pool!
|
|
instructions - [Instruction!]
|
|
hold - Boolean!
|
|
holdHistory - [HoldHistoryItem!]
|
|
reversal - Boolean!
|
|
split - AllocatableSplitConnection!
|
|
Arguments
|
|
directDebit - Boolean!
|
|
businessProcess - BusinessProcess!
|
|
accountAllocatedTo - Account
|
|
deleteMessage - String
|
Deprecated. Moved to movementHistory |
restoreMessage - String
|
Deprecated. Moved to movementHistory |
deleteRequestUserName - String
|
Deprecated. Moved to movementHistory |
deleteRequestUserId - String
|
Deprecated. Moved to movementHistory |
deleteRequestTimestamp - String
|
Deprecated. Moved to movementHistory |
deleteApprovalUserName - String
|
Deprecated. Moved to movementHistory |
deleteApprovalUserId - String
|
Deprecated. Moved to movementHistory |
deleteApprovalTimestamp - String
|
Deprecated. Moved to movementHistory |
restoreRequestUserName - String
|
Deprecated. Moved to movementHistory |
restoreRequestUserId - String
|
Deprecated. Moved to movementHistory |
restoreRequestTimestamp - String
|
Deprecated. Moved to movementHistory |
restoreApprovalUserName - String
|
Deprecated. Moved to movementHistory |
restoreApprovalUserId - String
|
Deprecated. Moved to movementHistory |
restoreApprovalTimestamp - String
|
Deprecated. Moved to movementHistory |
history - [AllocatableHistoryItem!]
|
Shows the movement activity for this Allocatable |
Example
{
"id": 4,
"createdTimestamp": "2007-12-03T10:15:30Z",
"valueDate": "2007-12-03",
"amount": Amount,
"remainingUnallocated": Amount,
"allocationState": "PENDING",
"allocation": Allocation,
"unallocatedReason": "abc123",
"unallocatedReasonCode": "MULTIPLE_DESTINATIONS",
"unallocatable": true,
"pool": Pool,
"instructions": [Instruction],
"hold": false,
"holdHistory": [HoldHistoryItem],
"reversal": false,
"split": AllocatableSplitConnection,
"directDebit": false,
"businessProcess": BusinessProcess,
"accountAllocatedTo": Account,
"deleteMessage": "xyz789",
"restoreMessage": "abc123",
"deleteRequestUserName": "xyz789",
"deleteRequestUserId": "abc123",
"deleteRequestTimestamp": "xyz789",
"deleteApprovalUserName": "xyz789",
"deleteApprovalUserId": "abc123",
"deleteApprovalTimestamp": "xyz789",
"restoreRequestUserName": "xyz789",
"restoreRequestUserId": "abc123",
"restoreRequestTimestamp": "abc123",
"restoreApprovalUserName": "xyz789",
"restoreApprovalUserId": "abc123",
"restoreApprovalTimestamp": "abc123",
"history": [AllocatableHistoryItem]
}
GenericCommand
Fields
| Field Name | Description |
|---|---|
action - String!
|
Use operation field, the operation field is an enumeration that makes it easier to query with |
approval - Approval
|
|
createdTimestamp - DateTime
|
|
id - ID!
|
|
inputJson - String
|
|
invalid - [CommandError]!
|
|
operation - Action!
|
|
state - CommandState!
|
|
step - String!
|
|
user - String!
|
Use userInfo, as this only details the sub |
userInfo - UserInfo!
|
Example
{
"action": "abc123",
"approval": Approval,
"createdTimestamp": "2007-12-03T10:15:30Z",
"id": 4,
"inputJson": "abc123",
"invalid": [CommandError],
"operation": "AGGREGATE_PAYMENT_EXECUTE",
"state": "SUBMITTED",
"step": "xyz789",
"user": "abc123",
"userInfo": UserInfo
}
GovernmentBodySubType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"OFFSHORE"
GovernmentBodyType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"DOMESTIC"
GrantProductToCustomerInput
GrantedProductToCustomer
Description
Product Subscriptions
Fields
| Field Name | Description |
|---|---|
customer - Customer!
|
Example
{"customer": Customer}
GrantedProductToCustomerSubscription
Types
| Union Types |
|---|
Example
GrantedProductToCustomer
Heartbeat
Fields
| Field Name | Description |
|---|---|
timestamp - String!
|
Example
{"timestamp": "xyz789"}
HistoryWithholdingTaxAU
Fields
| Field Name | Description |
|---|---|
effectiveTimestamp - DateTime!
|
|
nonResidentRate - RateValue!
|
|
resident - WithholdingTaxAUResident!
|
|
nominatedAccount - WithholdingTaxNominatedAccount!
|
|
financialYearStart - DateWithoutYear!
|
|
apcaId - String
|
Example
{
"effectiveTimestamp": "2007-12-03T10:15:30Z",
"nonResidentRate": RateValue,
"resident": WithholdingTaxAUResident,
"nominatedAccount": WithholdingTaxNominatedAccount,
"financialYearStart": DateWithoutYear,
"apcaId": "xyz789"
}
HistoryWithholdingTaxAUConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [HistoryWithholdingTaxAUEdge]
|
Example
{
"pageInfo": PageInfo,
"edges": [HistoryWithholdingTaxAUEdge]
}
HistoryWithholdingTaxAUEdge
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
|
node - HistoryWithholdingTaxAU!
|
Example
{
"cursor": "abc123",
"node": HistoryWithholdingTaxAU
}
HoldHistoryItem
Example
{
"hold": true,
"reason": "xyz789",
"timestamp": "2007-12-03T10:15:30Z"
}
HoldUnallocatedInput
ID
Description
The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.
Example
4
Identifier
Fields
| Field Name | Description |
|---|---|
id - String
|
Example
{"id": "xyz789"}
IncorporatedAssociationCreateDetails
Fields
| Field Name | Description |
|---|---|
alternateAddress - PartyCompanyAlternateAddress
|
|
associationType - IncorporatedAssociationType
|
|
businessNumber - String
|
|
clientClassification - PartyNonIndividualClientClassification
|
|
customer - Identifier
|
|
customerNode - Customer
|
|
email - String
|
|
fullName - String
|
|
incorporationCountry - String
|
|
incorporationDate - Date
|
|
kycInformation - PartyKycInformation
|
|
reference - String
|
|
registeredBodyNumber - String
|
|
registeredOfficeAddress - PartyCompanyRegisteredOfficeAddress
|
|
roles - [Role]
|
|
taxResidencies - [TaxResidency]
|
|
workPhone - String
|
Example
{
"alternateAddress": PartyCompanyAlternateAddress,
"associationType": "INCORPORATED",
"businessNumber": "xyz789",
"clientClassification": "CHARITABLE_TRUST",
"customer": Identifier,
"customerNode": Customer,
"email": "abc123",
"fullName": "xyz789",
"incorporationCountry": "xyz789",
"incorporationDate": "2007-12-03",
"kycInformation": PartyKycInformation,
"reference": "xyz789",
"registeredBodyNumber": "xyz789",
"registeredOfficeAddress": PartyCompanyRegisteredOfficeAddress,
"roles": ["BENEFICIARY"],
"taxResidencies": [TaxResidency],
"workPhone": "abc123"
}
IncorporatedAssociationType
Values
| Enum Value | Description |
|---|---|
|
|
Example
"INCORPORATED"
IndividualTINMissingReason
Values
| Enum Value | Description |
|---|---|
|
|
TIN |
|
|
TIN |
|
|
TIN |
|
|
TIN |
|
|
TFN (AU) |
|
|
TFN (AU) |
|
|
TFN (AU) |
|
|
TFN (AU) |
|
|
TFN (AU) |
Example
"NOT_ISSUED"
IndividualTaxReportingType
Description
Tax reporting types applicable for individuals.
Values
| Enum Value | Description |
|---|---|
|
|
Example
"INDIVIDUAL"
IndividualTaxResidency
Description
Details of an individuals tax residency.
Fields
| Field Name | Description |
|---|---|
countryCode - CountryShortCode!
|
The corresponding country the tax residency represents as an ISO two character country code. |
tin - String
|
The TIN |
tinMissingReason - IndividualTINMissingReason
|
The reason a TIN cannot be submitted for the tax residency |
tinMissingExplanation - String
|
The explanation for when the TIN is unobtainable |
Example
{
"countryCode": CountryShortCode,
"tin": "xyz789",
"tinMissingReason": "NOT_ISSUED",
"tinMissingExplanation": "xyz789"
}
IndividualTaxResidencyInput
Description
Details when declaring an individuals tax residency
Fields
| Input Field | Description |
|---|---|
countryCode - CountryShortCode!
|
The corresponding country the tax residency represents as an ISO 2 character country code. |
tin - String
|
The TIN |
tinMissingReason - IndividualTINMissingReason
|
The reason a TIN cannot be submitted for the tax residency |
tinMissingExplanation - String
|
The explanation for when the TIN is unobtainable |
Example
{
"countryCode": CountryShortCode,
"tin": "xyz789",
"tinMissingReason": "NOT_ISSUED",
"tinMissingExplanation": "abc123"
}
Instruction
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
businessProcess - BusinessProcess
|
Possible Types
| Instruction Types |
|---|
Example
{"id": 4, "businessProcess": BusinessProcess}
InstructionInput
Fields
| Input Field | Description |
|---|---|
tracingId - String!
|
unique id to be used in exception processing |
accountId - ID!
|
|
narrative - String!
|
|
amount - FullAmountInput!
|
Example
{
"tracingId": "xyz789",
"accountId": 4,
"narrative": "abc123",
"amount": FullAmountInput
}
Int
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
123
Interest
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
createdTimestamp - DateTime!
|
|
pool - Pool!
|
|
customer - Customer!
|
|
product - Product!
|
|
status - InterestStatus!
|
|
realisationKey - String!
|
|
valueDate - Date!
|
|
customerAmount - Amount
|
|
clientAmount - Amount
|
|
acknowledged - Boolean!
|
|
bankUnpaidAmount - Amount!
|
|
customerUnpaidAmount - Amount!
|
|
instructions - [Instruction!]
|
|
transactions - TransactionConnection!
|
|
customerMarginPayment - Payment
|
|
customerMarginPaymentRequest - PaymentRequest
|
|
accrual - Accrual
|
Example
{
"id": 4,
"createdTimestamp": "2007-12-03T10:15:30Z",
"pool": Pool,
"customer": Customer,
"product": Product,
"status": "SUBMITTED",
"realisationKey": "xyz789",
"valueDate": "2007-12-03",
"customerAmount": Amount,
"clientAmount": Amount,
"acknowledged": true,
"bankUnpaidAmount": Amount,
"customerUnpaidAmount": Amount,
"instructions": [Instruction],
"transactions": TransactionConnection,
"customerMarginPayment": Payment,
"customerMarginPaymentRequest": PaymentRequest,
"accrual": Accrual
}
InterestAccruedInput
Fields
| Input Field | Description |
|---|---|
customerId - ID
|
|
productId - ID
|
|
currency - CurrencyCode!
|
Example
{
"customerId": 4,
"productId": "4",
"currency": CurrencyCode
}
InterestAmounts
InterestFeatureConfig
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
accrualTimes - [AccrualTime!]
|
|
realisationFrequencies - [RealisationFrequencies!]
|
|
dayCountConvention - DayCountConvention!
|
Example
{
"id": "4",
"name": "abc123",
"accrualTimes": [AccrualTime],
"realisationFrequencies": [RealisationFrequencies],
"dayCountConvention": "ACTUAL_365"
}
InterestFeatureConfigInput
Fields
| Input Field | Description |
|---|---|
dayCountConvention - DayCountConvention
|
|
accrualTimes - [AccrualTimeInput!]
|
|
realisationFrequencies - [RealisationFrequenciesInput!]
|
Example
{
"dayCountConvention": "ACTUAL_365",
"accrualTimes": [AccrualTimeInput],
"realisationFrequencies": [RealisationFrequenciesInput]
}
InterestFilter
Fields
| Input Field | Description |
|---|---|
clientAmount - AmountFilter
|
|
customerAmount - AmountFilter
|
|
realisationKeyExact - String
|
|
realisationKeyContains - String
|
Example
{
"clientAmount": AmountFilter,
"customerAmount": AmountFilter,
"realisationKeyExact": "abc123",
"realisationKeyContains": "abc123"
}
InterestStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"SUBMITTED"
InternalAccountFilter
Description
A simple use of this filter might look like:
filter: {internal:"One"}
A filter with a top level 'or' might look like:
filter: {or: [{internal: "One"}, {internal: "Two"}]}
Fields
| Input Field | Description |
|---|---|
and - [AccountFilter!]
|
|
or - [AccountFilter!]
|
|
internal - String
|
Example
{
"and": [AccountFilter],
"or": [AccountFilter],
"internal": "abc123"
}
InternalTransfer
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
createdTimestamp - DateTime!
|
|
transactions - TransactionConnection!
|
|
valueDate - Date!
|
Value date to applied to the transfer. |
creditingAccount - Account!
|
|
debitingAccount - Account!
|
|
pool - Pool!
|
|
amount - Amount!
|
|
customerTransactionReference - String
|
|
payerReference - String
|
Reference for account being paid from |
payeeReference - String
|
Reference for account being paid to |
Example
{
"id": "4",
"createdTimestamp": "2007-12-03T10:15:30Z",
"transactions": TransactionConnection,
"valueDate": "2007-12-03",
"creditingAccount": Account,
"debitingAccount": Account,
"pool": Pool,
"amount": Amount,
"customerTransactionReference": "xyz789",
"payerReference": "xyz789",
"payeeReference": "abc123"
}
InternalTransferFilter
Fields
| Input Field | Description |
|---|---|
amount - AmountFilter
|
Example
{"amount": AmountFilter}
KYCInformation
Fields
| Field Name | Description |
|---|---|
bankUniqueId - ID
|
|
kycId - ID
|
|
kycStatus - KYCStatus
|
|
verificationStatus - VerificationStatus
|
Example
{
"bankUniqueId": "4",
"kycId": "4",
"kycStatus": "COMPLETE",
"verificationStatus": "NON_VERIFIED"
}
KYCStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"COMPLETE"
KycStatuses
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"COMPLETE"
LoadCamtCommand
Fields
| Field Name | Description |
|---|---|
action - String!
|
Use operation field, the operation field is an enumeration that makes it easier to query with |
approval - Approval
|
|
camt - CAMT
|
|
createdTimestamp - DateTime
|
|
id - ID!
|
|
inputJson - String
|
|
invalid - [CommandError]!
|
|
operation - Action!
|
|
state - CommandState!
|
|
step - String!
|
|
user - String!
|
Use userInfo, as this only details the sub |
userInfo - UserInfo!
|
|
userInput - LoadCamtDetails
|
Example
{
"action": "xyz789",
"approval": Approval,
"camt": CAMT,
"createdTimestamp": "2007-12-03T10:15:30Z",
"id": "4",
"inputJson": "abc123",
"invalid": [CommandError],
"operation": "AGGREGATE_PAYMENT_EXECUTE",
"state": "SUBMITTED",
"step": "abc123",
"user": "abc123",
"userInfo": UserInfo,
"userInput": LoadCamtDetails
}
LoadCamtDetails
Example
{
"camtType": "REPORT",
"originalFileName": "abc123",
"xml": "xyz789"
}
MakeCustomerLinkedAccountPaymentInput
Fields
| Input Field | Description |
|---|---|
customerLinkedAccountId - ID!
|
ID of the customer linked account wanting to make payment to. |
sender - DESender!
|
The CCM account ID that the funds will be paid from. |
paymentAmount - PaymentAmountInput!
|
Value of the payment. |
reference - String
|
A message about the payment. The reference will be sent to the recipient of the payment. |
customerTransactionReference - String
|
An optional reference that can later be used to search for the Payment |
valueDate - Date
|
Value date to be applied to the payment. |
Example
{
"customerLinkedAccountId": "4",
"sender": DESender,
"paymentAmount": PaymentAmountInput,
"reference": "abc123",
"customerTransactionReference": "xyz789",
"valueDate": "2007-12-03"
}
MakeDEPaymentInput
Description
Options when making a Direct Entry payment.
Fields
| Input Field | Description |
|---|---|
sender - DESender!
|
Details of the party initiating the payment request whose account is to be debited. |
valueDate - Date
|
Value date to be applied to the payment. |
paymentAmount - PaymentAmountInput!
|
Value of the payment. |
recipient - DERecipient!
|
Details of the party to payment is to be credited to. |
reference - String
|
A message about the payment. The reference will be sent to the recipient of the payment. |
purpose - DEPurpose
|
Additional description describing the purpose of the payment. |
customerTransactionReference - String
|
An optional reference that can later be used to search for the Payment |
Example
{
"sender": DESender,
"valueDate": "2007-12-03",
"paymentAmount": PaymentAmountInput,
"recipient": DERecipient,
"reference": "abc123",
"purpose": "CASH",
"customerTransactionReference": "abc123"
}
MakeDePaymentCommand
Fields
| Field Name | Description |
|---|---|
action - String!
|
Use operation field, the operation field is an enumeration that makes it easier to query with |
approval - Approval
|
|
createdTimestamp - DateTime
|
|
id - ID!
|
|
inputJson - String
|
|
invalid - [CommandError]!
|
|
operation - Action!
|
|
payment - Payment
|
|
state - CommandState!
|
|
step - String!
|
|
user - String!
|
Use userInfo, as this only details the sub |
userInfo - UserInfo!
|
|
userInput - MakeDePaymentDetails
|
Example
{
"action": "xyz789",
"approval": Approval,
"createdTimestamp": "2007-12-03T10:15:30Z",
"id": 4,
"inputJson": "abc123",
"invalid": [CommandError],
"operation": "AGGREGATE_PAYMENT_EXECUTE",
"payment": Payment,
"state": "SUBMITTED",
"step": "abc123",
"user": "xyz789",
"userInfo": UserInfo,
"userInput": MakeDePaymentDetails
}
MakeDePaymentDetails
Fields
| Field Name | Description |
|---|---|
amount - DebitAmount
|
|
customerTransactionReference - String
|
This is an optional string specified on the mutation for the sole purpose of being able to search for the BusinessProcess by the string later |
internallyTriggered - Boolean
|
|
narrative - String
|
|
purpose - DEPurpose
|
|
reSubmittable - Boolean
|
Re_submittable means you can initiate a new acknowledgable flow (submit a new pain 001). This keeps the transactions open until the payment has a successful acknowledgable flow. |
recipient - DeClaRecipientNonClaDeRecipientUnion
|
|
reference - String
|
|
sender - AccountSenderSubledgerSenderUnion
|
|
transaction - Identifier
|
|
transactionBusinessProcess - PaymentTransactionBusinessProcessIdentifier
|
|
transactionBusinessProcessNode - BusinessProcess
|
|
transactionNode - Transaction
|
|
valueDate - Date
|
Example
{
"amount": DebitAmount,
"customerTransactionReference": "xyz789",
"internallyTriggered": true,
"narrative": "abc123",
"purpose": "CASH",
"reSubmittable": true,
"recipient": DeClaRecipient,
"reference": "xyz789",
"sender": AccountSender,
"transaction": Identifier,
"transactionBusinessProcess": PaymentTransactionBusinessProcessIdentifier,
"transactionBusinessProcessNode": BusinessProcess,
"transactionNode": Transaction,
"valueDate": "2007-12-03"
}
MakeInternalTransferInput
Description
Options for transfer of funds between two client accounts within the same pool.
Fields
| Input Field | Description |
|---|---|
pool - ID!
|
The pool the accounts are held under. |
debitingAccount - AccountNumber!
|
The account number of the account to be debited. |
creditingAccount - AccountNumber!
|
The account number of the account to be credited. |
transferAmount - PaymentAmountInput!
|
The value of the transfer. |
valueDate - Date
|
Value date to be applied to the transfers. |
customerTransactionReference - String
|
A message about the transfer. The reference will be available to the recipient of the transfer. |
payerReference - String
|
TBD |
payeeReference - String
|
TBD |
Example
{
"pool": "4",
"debitingAccount": "000000012345",
"creditingAccount": "000000012345",
"transferAmount": PaymentAmountInput,
"valueDate": "2007-12-03",
"customerTransactionReference": "xyz789",
"payerReference": "abc123",
"payeeReference": "xyz789"
}
MakeManualInterestAdjustmentCommand
Fields
| Field Name | Description |
|---|---|
account - Account
|
|
action - String!
|
Use operation field, the operation field is an enumeration that makes it easier to query with |
approval - Approval
|
|
cla - CustomerLinkedAccount
|
|
createdTimestamp - DateTime
|
|
id - ID!
|
|
inputJson - String
|
|
invalid - [CommandError]!
|
|
operation - Action!
|
|
state - CommandState!
|
|
step - String!
|
|
user - String!
|
Use userInfo, as this only details the sub |
userInfo - UserInfo!
|
|
userInput - MakeManualInterestAdjustmentDetails
|
Example
{
"account": Account,
"action": "xyz789",
"approval": Approval,
"cla": CustomerLinkedAccount,
"createdTimestamp": "2007-12-03T10:15:30Z",
"id": "4",
"inputJson": "abc123",
"invalid": [CommandError],
"operation": "AGGREGATE_PAYMENT_EXECUTE",
"state": "SUBMITTED",
"step": "abc123",
"user": "abc123",
"userInfo": UserInfo,
"userInput": MakeManualInterestAdjustmentDetails
}
MakeManualInterestAdjustmentDetails
Fields
| Field Name | Description |
|---|---|
account - Identifier
|
|
accountNode - Account
|
|
cla - Identifier
|
|
claNode - CustomerLinkedAccount
|
|
clientAmount - Amount
|
|
reason - String
|
Example
{
"account": Identifier,
"accountNode": Account,
"cla": Identifier,
"claNode": CustomerLinkedAccount,
"clientAmount": Amount,
"reason": "abc123"
}
MakeNPPPaymentInput
Description
Options when making a NPP payment.
Fields
| Input Field | Description |
|---|---|
sender - NPPSender!
|
Details of the party initiating the payment request whose account is to be debited. |
valueDate - Date
|
Value date to be applied to the payment. |
paymentAmount - PaymentAmountInput!
|
Value of the payment. |
recipient - NPPRecipient!
|
Details of the party to payment is to be credited to. |
reference - String
|
A message about the payment. The reference will be sent to the recipient of the payment. |
purpose - NPPPurpose
|
Additional description describing the purpose of the payment. |
customerTransactionReference - String
|
An optional reference that can later be used to search for the Payment |
Example
{
"sender": NPPSender,
"valueDate": "2007-12-03",
"paymentAmount": PaymentAmountInput,
"recipient": NPPRecipient,
"reference": "abc123",
"purpose": "CASH",
"customerTransactionReference": "abc123"
}
MakeNppPaymentCommand
Fields
| Field Name | Description |
|---|---|
action - String!
|
Use operation field, the operation field is an enumeration that makes it easier to query with |
approval - Approval
|
|
createdTimestamp - DateTime
|
|
id - ID!
|
|
inputJson - String
|
|
invalid - [CommandError]!
|
|
operation - Action!
|
|
payment - Payment
|
|
state - CommandState!
|
|
step - String!
|
|
user - String!
|
Use userInfo, as this only details the sub |
userInfo - UserInfo!
|
|
userInput - MakeNppPaymentDetails
|
Example
{
"action": "xyz789",
"approval": Approval,
"createdTimestamp": "2007-12-03T10:15:30Z",
"id": "4",
"inputJson": "abc123",
"invalid": [CommandError],
"operation": "AGGREGATE_PAYMENT_EXECUTE",
"payment": Payment,
"state": "SUBMITTED",
"step": "abc123",
"user": "abc123",
"userInfo": UserInfo,
"userInput": MakeNppPaymentDetails
}
MakeNppPaymentDetails
Fields
| Field Name | Description |
|---|---|
amount - DebitAmount
|
|
customerTransactionReference - String
|
This is an optional string specified on the mutation for the sole purpose of being able to search for the BusinessProcess by the string later |
internallyTriggered - Boolean
|
|
narrative - String
|
|
purpose - DEPurpose
|
|
reSubmittable - Boolean
|
Re_submittable means you can initiate a new acknowledgable flow (submit a new pain 001). This keeps the transactions open until the payment has a successful acknowledgable flow. |
recipient - NonClanppRecipientNppClaRecipientUnion
|
|
reference - String
|
|
sender - AccountSenderSubledgerSenderUnion
|
|
transaction - Identifier
|
|
transactionBusinessProcess - PaymentTransactionBusinessProcessIdentifier
|
|
transactionBusinessProcessNode - BusinessProcess
|
|
transactionNode - Transaction
|
|
valueDate - Date
|
Example
{
"amount": DebitAmount,
"customerTransactionReference": "xyz789",
"internallyTriggered": false,
"narrative": "abc123",
"purpose": "CASH",
"reSubmittable": true,
"recipient": NPPClaRecipient,
"reference": "xyz789",
"sender": AccountSender,
"transaction": Identifier,
"transactionBusinessProcess": PaymentTransactionBusinessProcessIdentifier,
"transactionBusinessProcessNode": BusinessProcess,
"transactionNode": Transaction,
"valueDate": "2007-12-03"
}
MakePaymentInput
Description
Payload for an encrypted request.
Example
{
"encryptedPayload": "abc123",
"customerId": "4"
}
MakePaymentRequestDetails
Fields
| Field Name | Description |
|---|---|
amount - CreditAmount
|
|
apcaId - String
|
|
customerTransactionReference - String
|
This is an optional string specified on the mutation for the sole purpose of being able to search for the BusinessProcess by the string later |
debtor - CustomerLinkedAccountDebtorOriginUnionableEnumWithholdingTaxNominatedAccountDebtorOriginUnion
|
|
paymentMethod - PaymentRequestMethod
|
|
reSubmittable - Boolean
|
Re_submittable means you can initiate a new acknowledgable flow (submit a new pain 001). This keeps the transactions open until the payment_request has a successful acknowledgable flow. |
reference - String
|
|
requester - AccountRequesterSubledgerRequesterUnion
|
|
transaction - Identifier
|
|
transactionBusinessProcess - PaymentRequestTransactionBusinessProcessIdentifier
|
|
transactionBusinessProcessNode - BusinessProcess
|
|
transactionNode - Transaction
|
|
valueDate - Date
|
Example
{
"amount": CreditAmount,
"apcaId": "xyz789",
"customerTransactionReference": "abc123",
"debtor": CustomerLinkedAccountDebtorOrigin,
"paymentMethod": "DE",
"reSubmittable": false,
"reference": "xyz789",
"requester": AccountRequester,
"transaction": Identifier,
"transactionBusinessProcess": PaymentRequestTransactionBusinessProcessIdentifier,
"transactionBusinessProcessNode": BusinessProcess,
"transactionNode": Transaction,
"valueDate": "2007-12-03"
}
MakeRTGSPaymentInput
Description
Options for initiating an RTGS payment.
Fields
| Input Field | Description |
|---|---|
sender - RTGSSender!
|
Details of the party initiating the payment request whose account is to be debited. |
valueDate - Date
|
Value date to be applied to the payment. |
paymentAmount - PaymentAmountInput!
|
Value of the payment. |
recipient - RTGSRecipient!
|
Details of the party to payment is to be credited to. |
reference - String
|
A message about the payment. The reference will be sent to the recipient of the payment. |
narrative - String
|
Narrative details for the payment. The narrative will be sent to the recipient of the payment. |
customerTransactionReference - String
|
An optional reference that can later be used to search for the Payment |
Example
{
"sender": RTGSSender,
"valueDate": "2007-12-03",
"paymentAmount": PaymentAmountInput,
"recipient": RTGSRecipient,
"reference": "abc123",
"narrative": "abc123",
"customerTransactionReference": "abc123"
}
MakeRtgsPaymentCommand
Fields
| Field Name | Description |
|---|---|
action - String!
|
Use operation field, the operation field is an enumeration that makes it easier to query with |
approval - Approval
|
|
createdTimestamp - DateTime
|
|
id - ID!
|
|
inputJson - String
|
|
invalid - [CommandError]!
|
|
operation - Action!
|
|
payment - Payment
|
|
state - CommandState!
|
|
step - String!
|
|
user - String!
|
Use userInfo, as this only details the sub |
userInfo - UserInfo!
|
|
userInput - MakeRtgsPaymentDetails
|
Example
{
"action": "abc123",
"approval": Approval,
"createdTimestamp": "2007-12-03T10:15:30Z",
"id": "4",
"inputJson": "xyz789",
"invalid": [CommandError],
"operation": "AGGREGATE_PAYMENT_EXECUTE",
"payment": Payment,
"state": "SUBMITTED",
"step": "abc123",
"user": "abc123",
"userInfo": UserInfo,
"userInput": MakeRtgsPaymentDetails
}
MakeRtgsPaymentDetails
Fields
| Field Name | Description |
|---|---|
amount - DebitAmount
|
|
customerTransactionReference - String
|
This is an optional string specified on the mutation for the sole purpose of being able to search for the BusinessProcess by the string later |
narrative - String
|
|
reSubmittable - Boolean
|
Re_submittable means you can initiate a new acknowledgable flow (submit a new pain 001). This keeps the transactions open until the payment has a successful acknowledgable flow. |
recipient - RtgsRecipient
|
|
reference - String
|
|
sender - AccountSenderSubledgerSenderUnion
|
|
transaction - Identifier
|
|
transactionBusinessProcess - PaymentTransactionBusinessProcessIdentifier
|
|
transactionBusinessProcessNode - BusinessProcess
|
|
transactionNode - Transaction
|
|
valueDate - Date
|
Example
{
"amount": DebitAmount,
"customerTransactionReference": "abc123",
"narrative": "abc123",
"reSubmittable": true,
"recipient": RtgsRecipient,
"reference": "xyz789",
"sender": AccountSender,
"transaction": Identifier,
"transactionBusinessProcess": PaymentTransactionBusinessProcessIdentifier,
"transactionBusinessProcessNode": BusinessProcess,
"transactionNode": Transaction,
"valueDate": "2007-12-03"
}
ManualInterestAdjustment
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
createdTimestamp - DateTime!
|
|
transactions - TransactionConnection!
|
|
account - Account!
|
|
customer - Customer!
|
|
cla - CustomerLinkedAccount!
|
|
source - Source!
|
|
clientAmount - Amount!
|
|
valueDate - Date!
|
|
reason - String!
|
|
state - TransactionState!
|
Example
{
"id": "4",
"createdTimestamp": "2007-12-03T10:15:30Z",
"transactions": TransactionConnection,
"account": Account,
"customer": Customer,
"cla": CustomerLinkedAccount,
"source": Source,
"clientAmount": Amount,
"valueDate": "2007-12-03",
"reason": "abc123",
"state": "PENDING"
}
ManualInterestAdjustmentFilter
Fields
| Input Field | Description |
|---|---|
clientAmount - AmountFilter
|
Example
{"clientAmount": AmountFilter}
ManualInterestAdjustmentInput
Fields
| Input Field | Description |
|---|---|
claId - ID!
|
|
accountId - ID!
|
|
clientAmount - FullAmountInput!
|
|
reason - String!
|
Example
{
"claId": 4,
"accountId": 4,
"clientAmount": FullAmountInput,
"reason": "abc123"
}
MarginNamedRateEntry
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
currency - CurrencyCode!
|
|
startDate - Date!
|
|
baseRate - NamedRate!
|
|
margin - RateValue!
|
|
rate - RateValue!
|
|
namedRate - NamedRate!
|
Example
{
"id": "4",
"name": "abc123",
"currency": CurrencyCode,
"startDate": "2007-12-03",
"baseRate": NamedRate,
"margin": RateValue,
"rate": RateValue,
"namedRate": NamedRate
}
MarginNamedRateInput
Description
Options when creating a margin based interest rate.
Fields
| Input Field | Description |
|---|---|
name - String!
|
The name for the rate. |
currency - CurrencyCode!
|
The ISO currency code the rate is effective for. |
startDate - Date!
|
The date the rate is effective from. |
baseRate - ID!
|
Id of a rate this rate is derived from. Any changes in the base rate will impact the effective value of this rate. |
margin - RateValue!
|
A margin, defined in basis points, applied to the base rate to derive the value for the rate being created. The margin may be positive or negative. |
customerId - ID
|
Id of a customer the rate is created on behalf of. If provided the customer will have permission to maintain future values of the rate. |
Example
{
"name": "xyz789",
"currency": CurrencyCode,
"startDate": "2007-12-03",
"baseRate": 4,
"margin": RateValue,
"customerId": 4
}
MatchedReversal
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
original - Allocatable!
|
|
reversal - Allocatable!
|
|
pool - Pool!
|
|
customer - Customer!
|
|
createdTimestamp - DateTime!
|
|
comment - String
|
|
state - MatchedReversalState!
|
Example
{
"id": 4,
"original": Allocatable,
"reversal": Allocatable,
"pool": Pool,
"customer": Customer,
"createdTimestamp": "2007-12-03T10:15:30Z",
"comment": "xyz789",
"state": "MATCHED"
}
MatchedReversalConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [MatchedReversalEdge]
|
|
aggregates - SimpleConnectionAggregate!
|
Example
{
"pageInfo": PageInfo,
"edges": [MatchedReversalEdge],
"aggregates": SimpleConnectionAggregate
}
MatchedReversalCreated
Fields
| Field Name | Description |
|---|---|
matchedReversal - MatchedReversal!
|
Example
{"matchedReversal": MatchedReversal}
MatchedReversalEdge
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
|
node - MatchedReversal
|
Example
{
"cursor": "abc123",
"node": MatchedReversal
}
MatchedReversalFilter
Fields
| Input Field | Description |
|---|---|
amount - AmountMatchedInput
|
|
createdDate - Date
|
Example
{
"amount": AmountMatchedInput,
"createdDate": "2007-12-03"
}
MatchedReversalListSubscription
Types
| Union Types |
|---|
Example
MatchedReversalCreated
MatchedReversalState
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"MATCHED"
MatchedReversalUnmatched
Fields
| Field Name | Description |
|---|---|
matchedReversal - MatchedReversal!
|
Example
{"matchedReversal": MatchedReversal}
MatchingDateLimit
Fields
| Field Name | Description |
|---|---|
dateRange - Int!
|
Example
{"dateRange": 987}
MatchingDateLimitInput
Fields
| Input Field | Description |
|---|---|
dateRange - Int
|
Example
{"dateRange": 123}
Models
Fields
| Field Name | Description |
|---|---|
featureGraph - FeatureGraph!
|
|
titles - [String]!
|
|
genders - [Gender]!
|
|
countries - [Country!]!
|
|
encryptedPayloadSchemas - EncryptedPayloadSchemas!
|
|
auPostcodeMap - [PostcodeAddress!]
|
|
Arguments
|
|
counterpartyTypes - [CounterpartyType]!
|
|
Example
{
"featureGraph": FeatureGraph,
"titles": ["abc123"],
"genders": [Gender],
"countries": [Country],
"encryptedPayloadSchemas": EncryptedPayloadSchemas,
"auPostcodeMap": [PostcodeAddress],
"counterpartyTypes": [CounterpartyType]
}
MoveAccountCommand
Fields
| Field Name | Description |
|---|---|
account - Account
|
|
action - String!
|
Use operation field, the operation field is an enumeration that makes it easier to query with |
approval - Approval
|
|
createdTimestamp - DateTime
|
|
id - ID!
|
|
inputJson - String
|
|
invalid - [CommandError]!
|
|
operation - Action!
|
|
product - Product
|
|
state - CommandState!
|
|
step - String!
|
|
user - String!
|
Use userInfo, as this only details the sub |
userInfo - UserInfo!
|
|
userInput - AccountMoveDetails
|
Example
{
"account": Account,
"action": "xyz789",
"approval": Approval,
"createdTimestamp": "2007-12-03T10:15:30Z",
"id": 4,
"inputJson": "xyz789",
"invalid": [CommandError],
"operation": "AGGREGATE_PAYMENT_EXECUTE",
"product": Product,
"state": "SUBMITTED",
"step": "xyz789",
"user": "abc123",
"userInfo": UserInfo,
"userInput": AccountMoveDetails
}
MoveAccountInput
MoveSplitAllocatableToClaDetails
Fields
| Field Name | Description |
|---|---|
customerLinkedAccount - Identifier
|
|
customerLinkedAccountNode - CustomerLinkedAccount
|
|
id - String
|
Example
{
"customerLinkedAccount": Identifier,
"customerLinkedAccountNode": CustomerLinkedAccount,
"id": "xyz789"
}
MoveSplitAllocatedToCLAInput
MoveSplitElementToCLACommand
Fields
| Field Name | Description |
|---|---|
action - String!
|
Use operation field, the operation field is an enumeration that makes it easier to query with |
allocatable - Allocatable
|
|
approval - Approval
|
|
createdTimestamp - DateTime
|
|
customerLinkedAccount - CustomerLinkedAccount
|
|
id - ID!
|
|
inputJson - String
|
|
invalid - [CommandError]!
|
|
operation - Action!
|
|
payment - Payment
|
|
paymentRequest - PaymentRequest
|
|
state - CommandState!
|
|
step - String!
|
|
user - String!
|
Use userInfo, as this only details the sub |
userInfo - UserInfo!
|
|
userInput - MoveSplitAllocatableToClaDetails
|
Example
{
"action": "xyz789",
"allocatable": Allocatable,
"approval": Approval,
"createdTimestamp": "2007-12-03T10:15:30Z",
"customerLinkedAccount": CustomerLinkedAccount,
"id": 4,
"inputJson": "xyz789",
"invalid": [CommandError],
"operation": "AGGREGATE_PAYMENT_EXECUTE",
"payment": Payment,
"paymentRequest": PaymentRequest,
"state": "SUBMITTED",
"step": "abc123",
"user": "xyz789",
"userInfo": UserInfo,
"userInput": MoveSplitAllocatableToClaDetails
}
MoveToCLACommand
Fields
| Field Name | Description |
|---|---|
action - String!
|
Use operation field, the operation field is an enumeration that makes it easier to query with |
allocatable - Allocatable
|
|
approval - Approval
|
|
createdTimestamp - DateTime
|
|
customerLinkedAccount - CustomerLinkedAccount
|
|
id - ID!
|
|
inputJson - String
|
|
invalid - [CommandError]!
|
|
operation - Action!
|
|
payment - Payment
|
|
paymentRequest - PaymentRequest
|
|
state - CommandState!
|
|
step - String!
|
|
user - String!
|
Use userInfo, as this only details the sub |
userInfo - UserInfo!
|
|
userInput - AllocatableMoveToClaDetails
|
Example
{
"action": "abc123",
"allocatable": Allocatable,
"approval": Approval,
"createdTimestamp": "2007-12-03T10:15:30Z",
"customerLinkedAccount": CustomerLinkedAccount,
"id": 4,
"inputJson": "xyz789",
"invalid": [CommandError],
"operation": "AGGREGATE_PAYMENT_EXECUTE",
"payment": Payment,
"paymentRequest": PaymentRequest,
"state": "SUBMITTED",
"step": "xyz789",
"user": "xyz789",
"userInfo": UserInfo,
"userInput": AllocatableMoveToClaDetails
}
MoveUnallocatedToCLAInput
MovedToCLAListSubscription
Types
| Union Types |
|---|
Example
ReceiptAdded
MovementToCLAPayment
Fields
| Field Name | Description |
|---|---|
customerLinkedAccount - CustomerLinkedAccount!
|
|
payment - Payment!
|
Example
{
"customerLinkedAccount": CustomerLinkedAccount,
"payment": Payment
}
MovementToCLAPaymentRequest
Fields
| Field Name | Description |
|---|---|
customerLinkedAccount - CustomerLinkedAccount!
|
|
paymentRequest - PaymentRequest!
|
Example
{
"customerLinkedAccount": CustomerLinkedAccount,
"paymentRequest": PaymentRequest
}
NPPClaRecipient
Fields
| Field Name | Description |
|---|---|
customerLinkedAccount - Identifier
|
|
customerLinkedAccountNode - CustomerLinkedAccount
|
Example
{
"customerLinkedAccount": Identifier,
"customerLinkedAccountNode": CustomerLinkedAccount
}
NPPPurpose
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CASH"
NPPRecipient
Description
Identifying details for the recipient of a Direct Entry payment.
Fields
| Input Field | Description |
|---|---|
name - String!
|
The recipients name. |
accountNumber - AccountNumber!
|
The account number the Direct Entry payment is to be sent to. |
bankCode - BankCode!
|
The bank code of the account the Direct Entry payment is to be sent to. |
Example
{
"name": "xyz789",
"accountNumber": "000000012345",
"bankCode": BankCode
}
NPPSender
Description
Identifying details for the sender of a Direct Entry payment.
Fields
| Input Field | Description |
|---|---|
accountId - ID!
|
The unique id of the account the Direct Entry payment is initiated from. |
Example
{"accountId": "4"}
NamedRate
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
currentOrNext - NamedRateEntry!
|
|
history - NamedRateEntryConnection!
|
|
Arguments
|
|
Possible Types
| NamedRate Types |
|---|
Example
{
"id": "4",
"currentOrNext": NamedRateEntry,
"history": NamedRateEntryConnection
}
NamedRateAccrualCalculation
Fields
| Field Name | Description |
|---|---|
rate - String!
|
|
namedRate - NamedRate!
|
|
cumulativeAmount - Amount!
|
|
dailyAccrual - String!
|
Example
{
"rate": "abc123",
"namedRate": NamedRate,
"cumulativeAmount": Amount,
"dailyAccrual": "xyz789"
}
NamedRateConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [NamedRateEdge]
|
|
aggregates - SimpleConnectionAggregate!
|
Example
{
"pageInfo": PageInfo,
"edges": [NamedRateEdge],
"aggregates": SimpleConnectionAggregate
}
NamedRateCreated
Fields
| Field Name | Description |
|---|---|
namedRate - NamedRate!
|
Example
{"namedRate": NamedRate}
NamedRateEdge
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
|
node - NamedRate!
|
Example
{
"cursor": "abc123",
"node": NamedRate
}
NamedRateEntry
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
currency - CurrencyCode!
|
|
startDate - Date!
|
|
namedRate - NamedRate!
|
Possible Types
| NamedRateEntry Types |
|---|
Example
{
"id": 4,
"name": "xyz789",
"currency": CurrencyCode,
"startDate": "2007-12-03",
"namedRate": NamedRate
}
NamedRateEntryConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [NamedRateEntryEdge]
|
Example
{
"pageInfo": PageInfo,
"edges": [NamedRateEntryEdge]
}
NamedRateEntryEdge
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
|
node - NamedRateEntry!
|
Example
{
"cursor": "abc123",
"node": NamedRateEntry
}
NamedRateEntryFilter
Fields
| Input Field | Description |
|---|---|
nameContains - String
|
|
nameExact - String
|
|
currencyExact - CurrencyCode
|
Example
{
"nameContains": "xyz789",
"nameExact": "abc123",
"currencyExact": CurrencyCode
}
NamedRateEntryOrdering
Fields
| Input Field | Description |
|---|---|
sort - NamedRateEntrySort!
|
|
direction - OrderingDirection!
|
Example
{"sort": "START_DATE", "direction": "ASC"}
NamedRateEntrySort
Values
| Enum Value | Description |
|---|---|
|
|
Example
"START_DATE"
NamedRateFilter
Description
A simple use of this filter might look like:
filter: {currentOrNextFilter: {nameExact: "Customer Rate One"}}
A filter with a top level 'or' might look like:
filter: {or: [{currentOrNextFilter: {nameExact: "Customer Rate One"}}, {currentOrNextFilter: {nameContains: "Bank Rate"}}]}
Fields
| Input Field | Description |
|---|---|
and - [NamedRateFilter!]
|
|
or - [NamedRateFilter!]
|
|
ownedBy - [Owners!]
|
|
benchmarksOnly - Boolean
|
|
customerId - ID
|
|
currentOrNextFilter - NamedRateEntryFilter
|
Example
{
"and": [NamedRateFilter],
"or": [NamedRateFilter],
"ownedBy": ["BANK"],
"benchmarksOnly": false,
"customerId": "4",
"currentOrNextFilter": NamedRateEntryFilter
}
NamedRateListSubscription
Types
| Union Types |
|---|
Example
NamedRateCreated
NamedRateUpdated
Fields
| Field Name | Description |
|---|---|
namedRate - NamedRate!
|
Example
{"namedRate": NamedRate}
Node
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Possible Types
| Node Types |
|---|
Example
{"id": 4}
NonCLADeRecipient
Fields
| Field Name | Description |
|---|---|
accountNumber - String
|
|
bankCode - String
|
|
name - String
|
|
origin - UnionableEnumWithholdingTaxNominatedAccountRecipientOriginUnion
|
Example
{
"accountNumber": "abc123",
"bankCode": "xyz789",
"name": "xyz789",
"origin": UnionableEnum
}
NonCLANPPRecipient
Fields
| Field Name | Description |
|---|---|
accountNumber - String
|
|
bankCode - String
|
|
name - String
|
|
origin - UnionableEnumWithholdingTaxNominatedAccountRecipientOriginUnion
|
Example
{
"accountNumber": "xyz789",
"bankCode": "abc123",
"name": "abc123",
"origin": UnionableEnum
}
NonClanppRecipientNppClaRecipientUnion
Types
| Union Types |
|---|
Example
NPPClaRecipient
NonIndividualClientClassification
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"COMPANY"
NonIndividualTINMissingReason
Values
| Enum Value | Description |
|---|---|
|
|
TIN |
|
|
TIN |
|
|
TIN |
|
|
TIN |
|
|
TFN (AU) |
|
|
TFN (AU) |
|
|
TFN (AU) |
Example
"NOT_ISSUED"
NonIndividualTaxReportingType
Description
Tax reporting types applicable for companies or trusts.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"EXEMPT_ENTITY"
NonIndividualTaxResidency
Description
Details of a non-individuals tax residency.
Fields
| Field Name | Description |
|---|---|
countryCode - CountryShortCode!
|
The corresponding country the tax residency represents as an ISO two character country code. |
tin - String
|
The TIN |
tinMissingReason - NonIndividualTINMissingReason
|
The reason a TIN cannot be submitted for the tax residency |
tinMissingExplanation - String
|
The explanation for when the TIN is unobtainable |
Example
{
"countryCode": CountryShortCode,
"tin": "abc123",
"tinMissingReason": "NOT_ISSUED",
"tinMissingExplanation": "xyz789"
}
NonIndividualTaxResidencyInput
Description
Details when declaring a non-individuals tax residency
Fields
| Input Field | Description |
|---|---|
countryCode - CountryShortCode!
|
The corresponding country the tax residency represents as an ISO two character country code. |
tin - String
|
The TIN |
tinMissingReason - NonIndividualTINMissingReason
|
The reason a TIN cannot be submitted for the tax residency |
tinMissingExplanation - String
|
The explanation for when the TIN is unobtainable |
Example
{
"countryCode": CountryShortCode,
"tin": "abc123",
"tinMissingReason": "NOT_ISSUED",
"tinMissingExplanation": "abc123"
}
NumberWithUpTo2DecimalPlaces
Description
A number with up to 2 decimal places
Example
NumberWithUpTo2DecimalPlaces
OnboardCustomerInput
Description
Options when adding a new customer to the platform.
Fields
| Input Field | Description |
|---|---|
fullName - String!
|
The full legal name of the customer |
displayName - String!
|
The name of the customer, often shortened or abbreviated, that will typically be used in the user interface. |
apcaDirectEntryDebitId - String
|
APCA id for use with direct debits. |
apcaDirectEntryCreditId - String
|
APCA id for use with direct credits. |
authLink - String
|
The unique identification string used when resolving requests from the customer for authentication and authorisation. |
designatedInterestAccount - DERecipient
|
Details of the account customer interest is to be paid to. |
reportingFinancialInstitution - ReportingFinancialInstitution
|
Whether the customer is Reporting Financial Institution |
usFinancialInstitution - Boolean!
|
Whether the customer is a US Financial Institution |
giin - String
|
The Global Intermediary Identification Number |
reporter - Reporter!
|
Whether the bank or customer is responsible for producing the Annual Investment Income Report |
billingId - String!
|
The billing id for this customer within the bank |
blockDirectDebits - Boolean
|
Controls whether direct debits will be allocatable by the customer. Defaults to true |
actionControlDateLimits - ActionControlDateLimitInput
|
Allows configurable date limit control for customer actions on payments/receipts. If not provided defaults will apply. |
knowYourCustomerId - String!
|
Know Your Customer (KYC) ID |
coreSystemDetails - CoreSystemDetailsInput
|
Details of the (external) core system that a customer resides on. E.g. ANZ's Cache |
autoSweepAvailable - Boolean
|
Determines whether auto-sweep is available for customer usage |
counterpartyType - CounterpartyType
|
Counterparty type for the customer |
Example
{
"fullName": "abc123",
"displayName": "xyz789",
"apcaDirectEntryDebitId": "abc123",
"apcaDirectEntryCreditId": "abc123",
"authLink": "abc123",
"designatedInterestAccount": DERecipient,
"reportingFinancialInstitution": "YES",
"usFinancialInstitution": false,
"giin": "abc123",
"reporter": "BANK",
"billingId": "xyz789",
"blockDirectDebits": false,
"actionControlDateLimits": ActionControlDateLimitInput,
"knowYourCustomerId": "xyz789",
"coreSystemDetails": CoreSystemDetailsInput,
"autoSweepAvailable": false,
"counterpartyType": CounterpartyType
}
OpenAccountCommand
Fields
| Field Name | Description |
|---|---|
account - Account
|
|
action - String!
|
Use operation field, the operation field is an enumeration that makes it easier to query with |
approval - Approval
|
|
createdTimestamp - DateTime
|
|
customer - Customer
|
|
id - ID!
|
|
inputJson - String
|
|
invalid - [CommandError]!
|
|
operation - Action!
|
|
product - Product
|
|
state - CommandState!
|
|
step - String!
|
|
user - String!
|
Use userInfo, as this only details the sub |
userInfo - UserInfo!
|
|
userInput - AccountOpenDetails
|
Example
{
"account": Account,
"action": "abc123",
"approval": Approval,
"createdTimestamp": "2007-12-03T10:15:30Z",
"customer": Customer,
"id": 4,
"inputJson": "abc123",
"invalid": [CommandError],
"operation": "AGGREGATE_PAYMENT_EXECUTE",
"product": Product,
"state": "SUBMITTED",
"step": "abc123",
"user": "xyz789",
"userInfo": UserInfo,
"userInput": AccountOpenDetails
}
OpenAccountInput
Description
Options when opening a client account.
Fields
| Input Field | Description |
|---|---|
name - String!
|
The operating name of the account. |
currency - CurrencyCode
|
Deprecated. Ignored if supplied. Currency is controlled by the product the account is opened with. |
customerId - ID!
|
The customer that manages the account on behalf of a client. |
product - ID!
|
The product that controls the capabilities and restrictions the account follows. |
parties - [PartyAccountLinkInput!]!
|
List of one or more beneficiaries, trustees etc. associated with the account. |
reference - String
|
An optional reference for the account that may be used in auto allocation of transactions to the account. |
secondaryReference - String
|
Example
{
"name": "xyz789",
"currency": CurrencyCode,
"customerId": "4",
"product": 4,
"parties": [PartyAccountLinkInput],
"reference": "xyz789",
"secondaryReference": "abc123"
}
OrderingDirection
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ASC"
Owners
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"BANK"
PAIN001
Example
{
"id": "4",
"messageId": "abc123",
"instructionId": "abc123",
"paymentInformationId": "abc123",
"endToEndId": "xyz789",
"businessProcess": BusinessProcess
}
PageInfo
PartnershipSubType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"REGULATED"
PartnershipType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"REGULATED"
Party
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
shortId - String!
|
|
customer - Customer!
|
|
reference - String
|
|
roles - [Role!]!
|
|
selfCertified - SelfCertified
|
|
linkedAccounts - PartyLinkedAccountConnection!
|
|
Arguments |
|
kycInformation - KYCInformation
|
|
previousDomesticTin - String
|
|
dateOfResidencyChange - DateTime
|
|
previousSelfCertified - [SelfCertifiedHistory]
|
|
Possible Types
| Party Types |
|---|
Example
{
"id": 4,
"shortId": "abc123",
"customer": Customer,
"reference": "abc123",
"roles": ["BENEFICIARY"],
"selfCertified": SelfCertified,
"linkedAccounts": PartyLinkedAccountConnection,
"kycInformation": KYCInformation,
"previousDomesticTin": "abc123",
"dateOfResidencyChange": "2007-12-03T10:15:30Z",
"previousSelfCertified": [SelfCertifiedHistory]
}
PartyAccountLink
PartyAccountLinkInput
PartyAssociation
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
shortId - String!
|
|
customer - Customer!
|
|
reference - String
|
|
roles - [Role!]!
|
|
selfCertified - SelfCertified
|
|
linkedAccounts - PartyLinkedAccountConnection!
|
|
Arguments |
|
kycInformation - KYCInformation
|
|
previousDomesticTin - String
|
|
dateOfResidencyChange - DateTime
|
|
previousSelfCertified - [SelfCertifiedHistory]
|
|
fullName - String!
|
|
businessNumber - String
|
|
email - String
|
|
workPhone - String
|
|
registeredOfficeAddress - Address!
|
|
alternateAddress - Address
|
|
clientClassification - NonIndividualClientClassification
|
|
taxResidencies - [NonIndividualTaxResidency!]!
|
|
associationType - AssociationSubType!
|
|
registeredBodyNumber - String
|
|
incorporationDate - Date
|
|
incorporationCountry - String
|
|
countryOfEstablishment - String
|
|
Example
{
"id": "4",
"shortId": "abc123",
"customer": Customer,
"reference": "xyz789",
"roles": ["BENEFICIARY"],
"selfCertified": SelfCertified,
"linkedAccounts": PartyLinkedAccountConnection,
"kycInformation": KYCInformation,
"previousDomesticTin": "abc123",
"dateOfResidencyChange": "2007-12-03T10:15:30Z",
"previousSelfCertified": [SelfCertifiedHistory],
"fullName": "abc123",
"businessNumber": "abc123",
"email": "xyz789",
"workPhone": "abc123",
"registeredOfficeAddress": Address,
"alternateAddress": Address,
"clientClassification": "COMPANY",
"taxResidencies": [NonIndividualTaxResidency],
"associationType": "INCORPORATED",
"registeredBodyNumber": "abc123",
"incorporationDate": "2007-12-03",
"incorporationCountry": "xyz789",
"countryOfEstablishment": "xyz789"
}
PartyAssociationCreateCommand
Fields
| Field Name | Description |
|---|---|
action - String!
|
Use operation field, the operation field is an enumeration that makes it easier to query with |
approval - Approval
|
|
createdTimestamp - DateTime
|
|
id - ID!
|
|
inputJson - String
|
|
invalid - [CommandError]!
|
|
operation - Action!
|
|
party - Party
|
|
state - CommandState!
|
|
step - String!
|
|
user - String!
|
Use userInfo, as this only details the sub |
userInfo - UserInfo!
|
|
userInput - PartyAssociationCreateDetailsUnion
|
Example
{
"action": "xyz789",
"approval": Approval,
"createdTimestamp": "2007-12-03T10:15:30Z",
"id": "4",
"inputJson": "abc123",
"invalid": [CommandError],
"operation": "AGGREGATE_PAYMENT_EXECUTE",
"party": Party,
"state": "SUBMITTED",
"step": "xyz789",
"user": "xyz789",
"userInfo": UserInfo,
"userInput": IncorporatedAssociationCreateDetails
}
PartyAssociationCreateDetailsUnion
Types
| Union Types |
|---|
Example
IncorporatedAssociationCreateDetails
PartyAssociationUpdateCommand
Fields
| Field Name | Description |
|---|---|
action - String!
|
Use operation field, the operation field is an enumeration that makes it easier to query with |
approval - Approval
|
|
createdTimestamp - DateTime
|
|
id - ID!
|
|
inputJson - String
|
|
invalid - [CommandError]!
|
|
operation - Action!
|
|
party - Party
|
|
state - CommandState!
|
|
step - String!
|
|
user - String!
|
Use userInfo, as this only details the sub |
userInfo - UserInfo!
|
|
userInput - PartyAssociationUpdateDetails
|
Example
{
"action": "abc123",
"approval": Approval,
"createdTimestamp": "2007-12-03T10:15:30Z",
"id": 4,
"inputJson": "xyz789",
"invalid": [CommandError],
"operation": "AGGREGATE_PAYMENT_EXECUTE",
"party": Party,
"state": "SUBMITTED",
"step": "abc123",
"user": "xyz789",
"userInfo": UserInfo,
"userInput": PartyAssociationUpdateDetails
}
PartyAssociationUpdateDetails
Fields
| Field Name | Description |
|---|---|
alternateAddress - PartyCompanyAlternateAddressUnionableEnumUnion
|
|
associationType - AssociationType
|
|
businessNumber - UnionableEnumUnionableStringUnion
|
|
clientClassification - UnionableEnum
|
|
countryOfEstablishment - UnionableEnumUnionableStringUnion
|
|
email - UnionableEnumUnionableStringUnion
|
|
fullName - String
|
|
id - String
|
|
incorporationCountry - UnionableEnumUnionableStringUnion
|
|
incorporationDate - UnionableDateUnionableEnumUnion
|
|
reference - UnionableEnumUnionableStringUnion
|
|
registeredBodyNumber - UnionableEnumUnionableStringUnion
|
|
registeredOfficeAddress - EditableAddress
|
|
roles - [Role]
|
|
taxResidencies - [TaxResidency]
|
|
workPhone - UnionableEnumUnionableStringUnion
|
Example
{
"alternateAddress": PartyCompanyAlternateAddress,
"associationType": "INCORPORATED",
"businessNumber": UnionableEnum,
"clientClassification": UnionableEnum,
"countryOfEstablishment": UnionableEnum,
"email": UnionableEnum,
"fullName": "abc123",
"id": "xyz789",
"incorporationCountry": UnionableEnum,
"incorporationDate": UnionableDate,
"reference": UnionableEnum,
"registeredBodyNumber": UnionableEnum,
"registeredOfficeAddress": EditableAddress,
"roles": ["BENEFICIARY"],
"taxResidencies": [TaxResidency],
"workPhone": UnionableEnum
}
PartyCompany
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
customer - Customer!
|
|
roles - [Role!]!
|
|
clientClassification - NonIndividualClientClassification
|
|
linkedAccounts - PartyLinkedAccountConnection!
|
|
Arguments |
|
fullName - String!
|
|
reference - String
|
|
companyType - CompanySubType!
|
|
companyNumber - String
|
|
registeredBodyNumber - String
|
|
businessNumber - String
|
|
incorporationDate - Date
|
|
incorporationCountry - String
|
|
registeredOfficeAddress - Address!
|
|
alternateAddress - Address
|
|
tradingName - String
|
|
stockExchange - String
|
|
email - String
|
|
workPhone - String
|
|
taxResidencies - [NonIndividualTaxResidency!]!
|
|
selfCertified - SelfCertified
|
|
taxReportingType - NonIndividualTaxReportingType
|
|
noTaxResidency - Boolean
|
Whether the company has no residency for tax purposes |
giin - String
|
|
countryOfEffectiveManagement - String
|
|
controllingPersons - PartyConnection!
|
|
kycInformation - KYCInformation
|
|
shortId - String!
|
|
previousDomesticTin - String
|
|
dateOfResidencyChange - DateTime
|
|
previousSelfCertified - [SelfCertifiedHistory]
|
|
countryOfEstablishment - String
|
|
Example
{
"id": "4",
"customer": Customer,
"roles": ["BENEFICIARY"],
"clientClassification": "COMPANY",
"linkedAccounts": PartyLinkedAccountConnection,
"fullName": "xyz789",
"reference": "xyz789",
"companyType": "PRIVATE",
"companyNumber": "xyz789",
"registeredBodyNumber": "abc123",
"businessNumber": "abc123",
"incorporationDate": "2007-12-03",
"incorporationCountry": "abc123",
"registeredOfficeAddress": Address,
"alternateAddress": Address,
"tradingName": "xyz789",
"stockExchange": "xyz789",
"email": "abc123",
"workPhone": "abc123",
"taxResidencies": [NonIndividualTaxResidency],
"selfCertified": SelfCertified,
"taxReportingType": "EXEMPT_ENTITY",
"noTaxResidency": true,
"giin": "xyz789",
"countryOfEffectiveManagement": "xyz789",
"controllingPersons": PartyConnection,
"kycInformation": KYCInformation,
"shortId": "xyz789",
"previousDomesticTin": "abc123",
"dateOfResidencyChange": "2007-12-03T10:15:30Z",
"previousSelfCertified": [SelfCertifiedHistory],
"countryOfEstablishment": "xyz789"
}
PartyCompanyAlternateAddress
PartyCompanyAlternateAddressUnionableEnumUnion
Types
| Union Types |
|---|
Example
PartyCompanyAlternateAddress
PartyCompanyCreateCommand
Fields
| Field Name | Description |
|---|---|
action - String!
|
Use operation field, the operation field is an enumeration that makes it easier to query with |
approval - Approval
|
|
createdTimestamp - DateTime
|
|
customer - Customer
|
|
id - ID!
|
|
inputJson - String
|
|
invalid - [CommandError]!
|
|
operation - Action!
|
|
party - Party
|
|
state - CommandState!
|
|
step - String!
|
|
user - String!
|
Use userInfo, as this only details the sub |
userInfo - UserInfo!
|
|
userInput - PartyCompanyInterface
|
Example
{
"action": "xyz789",
"approval": Approval,
"createdTimestamp": "2007-12-03T10:15:30Z",
"customer": Customer,
"id": 4,
"inputJson": "abc123",
"invalid": [CommandError],
"operation": "AGGREGATE_PAYMENT_EXECUTE",
"party": Party,
"state": "SUBMITTED",
"step": "abc123",
"user": "abc123",
"userInfo": UserInfo,
"userInput": PartyCompanyInterface
}
PartyCompanyEditableAlternateAddress
PartyCompanyEditableAlternateAddressUnionableEnumUnion
Types
| Union Types |
|---|
Example
PartyCompanyEditableAlternateAddress
PartyCompanyEditableRegisteredOfficeAddress
PartyCompanyForeignRegisteredPrivateCreateDetails
Fields
| Field Name | Description |
|---|---|
alternateAddress - PartyCompanyAlternateAddress
|
|
businessNumber - String
|
|
clientClassification - PartyNonIndividualClientClassification
|
|
companyType - PartyCompanyForeignRegisteredPrivateType
|
|
controllingPersons - [String]
|
|
countryOfEffectiveManagement - String
|
|
customer - Identifier
|
|
customerNode - Customer
|
|
email - String
|
|
fullName - String
|
|
giin - String
|
|
incorporationCountry - String
|
|
incorporationDate - Date
|
|
kycInformation - PartyKycInformation
|
|
noTaxResidency - Boolean
|
|
reference - String
|
|
registeredBodyNumber - String
|
|
registeredOfficeAddress - PartyCompanyRegisteredOfficeAddress
|
|
roles - [Role]
|
|
selfCertified - SelfCertified
|
|
taxReportingType - PartyNonIndividualTaxReportingType
|
|
taxResidencies - [TaxResidency]
|
|
tradingName - String
|
|
workPhone - String
|
Example
{
"alternateAddress": PartyCompanyAlternateAddress,
"businessNumber": "xyz789",
"clientClassification": "CHARITABLE_TRUST",
"companyType": "FOREIGN_REGISTERED_PRIVATE",
"controllingPersons": ["abc123"],
"countryOfEffectiveManagement": "xyz789",
"customer": Identifier,
"customerNode": Customer,
"email": "xyz789",
"fullName": "abc123",
"giin": "xyz789",
"incorporationCountry": "xyz789",
"incorporationDate": "2007-12-03",
"kycInformation": PartyKycInformation,
"noTaxResidency": true,
"reference": "abc123",
"registeredBodyNumber": "xyz789",
"registeredOfficeAddress": PartyCompanyRegisteredOfficeAddress,
"roles": ["BENEFICIARY"],
"selfCertified": SelfCertified,
"taxReportingType": "ACTIVE_NON_FINANCIAL_ENTITY",
"taxResidencies": [TaxResidency],
"tradingName": "xyz789",
"workPhone": "xyz789"
}
PartyCompanyForeignRegisteredPrivateType
Values
| Enum Value | Description |
|---|---|
|
|
Example
"FOREIGN_REGISTERED_PRIVATE"
PartyCompanyForeignRegisteredPublicCreateDetails
Fields
| Field Name | Description |
|---|---|
alternateAddress - PartyCompanyAlternateAddress
|
|
businessNumber - String
|
|
clientClassification - PartyNonIndividualClientClassification
|
|
companyType - PartyCompanyForeignRegisteredPublicType
|
|
controllingPersons - [String]
|
|
countryOfEffectiveManagement - String
|
|
customer - Identifier
|
|
customerNode - Customer
|
|
email - String
|
|
fullName - String
|
|
giin - String
|
|
incorporationCountry - String
|
|
incorporationDate - Date
|
|
kycInformation - PartyKycInformation
|
|
noTaxResidency - Boolean
|
|
reference - String
|
|
registeredBodyNumber - String
|
|
registeredOfficeAddress - PartyCompanyRegisteredOfficeAddress
|
|
roles - [Role]
|
|
selfCertified - SelfCertified
|
|
stockExchange - String
|
|
taxReportingType - PartyNonIndividualTaxReportingType
|
|
taxResidencies - [TaxResidency]
|
|
tradingName - String
|
|
workPhone - String
|
Example
{
"alternateAddress": PartyCompanyAlternateAddress,
"businessNumber": "xyz789",
"clientClassification": "CHARITABLE_TRUST",
"companyType": "FOREIGN_REGISTERED_PUBLIC",
"controllingPersons": ["xyz789"],
"countryOfEffectiveManagement": "xyz789",
"customer": Identifier,
"customerNode": Customer,
"email": "abc123",
"fullName": "xyz789",
"giin": "abc123",
"incorporationCountry": "xyz789",
"incorporationDate": "2007-12-03",
"kycInformation": PartyKycInformation,
"noTaxResidency": false,
"reference": "abc123",
"registeredBodyNumber": "xyz789",
"registeredOfficeAddress": PartyCompanyRegisteredOfficeAddress,
"roles": ["BENEFICIARY"],
"selfCertified": SelfCertified,
"stockExchange": "xyz789",
"taxReportingType": "ACTIVE_NON_FINANCIAL_ENTITY",
"taxResidencies": [TaxResidency],
"tradingName": "xyz789",
"workPhone": "xyz789"
}
PartyCompanyForeignRegisteredPublicType
Values
| Enum Value | Description |
|---|---|
|
|
Example
"FOREIGN_REGISTERED_PUBLIC"
PartyCompanyForeignUnregisteredPrivateCreateDetails
Fields
| Field Name | Description |
|---|---|
alternateAddress - PartyCompanyAlternateAddress
|
|
businessNumber - String
|
|
clientClassification - PartyNonIndividualClientClassification
|
|
companyType - PartyCompanyForeignUnregisteredPrivateType
|
|
controllingPersons - [String]
|
|
countryOfEffectiveManagement - String
|
|
countryOfEstablishment - String
|
|
customer - Identifier
|
|
customerNode - Customer
|
|
email - String
|
|
fullName - String
|
|
giin - String
|
|
kycInformation - PartyKycInformation
|
|
noTaxResidency - Boolean
|
|
reference - String
|
|
registeredOfficeAddress - PartyCompanyRegisteredOfficeAddress
|
|
roles - [Role]
|
|
selfCertified - SelfCertified
|
|
taxReportingType - PartyNonIndividualTaxReportingType
|
|
taxResidencies - [TaxResidency]
|
|
tradingName - String
|
|
workPhone - String
|
Example
{
"alternateAddress": PartyCompanyAlternateAddress,
"businessNumber": "xyz789",
"clientClassification": "CHARITABLE_TRUST",
"companyType": "FOREIGN_UNREGISTERED_PRIVATE",
"controllingPersons": ["abc123"],
"countryOfEffectiveManagement": "xyz789",
"countryOfEstablishment": "abc123",
"customer": Identifier,
"customerNode": Customer,
"email": "xyz789",
"fullName": "abc123",
"giin": "xyz789",
"kycInformation": PartyKycInformation,
"noTaxResidency": false,
"reference": "xyz789",
"registeredOfficeAddress": PartyCompanyRegisteredOfficeAddress,
"roles": ["BENEFICIARY"],
"selfCertified": SelfCertified,
"taxReportingType": "ACTIVE_NON_FINANCIAL_ENTITY",
"taxResidencies": [TaxResidency],
"tradingName": "abc123",
"workPhone": "abc123"
}
PartyCompanyForeignUnregisteredPrivateType
Values
| Enum Value | Description |
|---|---|
|
|
Example
"FOREIGN_UNREGISTERED_PRIVATE"
PartyCompanyForeignUnregisteredPublicCreateDetails
Fields
| Field Name | Description |
|---|---|
alternateAddress - PartyCompanyAlternateAddress
|
|
businessNumber - String
|
|
clientClassification - PartyNonIndividualClientClassification
|
|
companyType - PartyCompanyForeignUnregisteredPublicType
|
|
controllingPersons - [String]
|
|
countryOfEffectiveManagement - String
|
|
countryOfEstablishment - String
|
|
customer - Identifier
|
|
customerNode - Customer
|
|
email - String
|
|
fullName - String
|
|
giin - String
|
|
kycInformation - PartyKycInformation
|
|
noTaxResidency - Boolean
|
|
reference - String
|
|
registeredOfficeAddress - PartyCompanyRegisteredOfficeAddress
|
|
roles - [Role]
|
|
selfCertified - SelfCertified
|
|
stockExchange - String
|
|
taxReportingType - PartyNonIndividualTaxReportingType
|
|
taxResidencies - [TaxResidency]
|
|
tradingName - String
|
|
workPhone - String
|
Example
{
"alternateAddress": PartyCompanyAlternateAddress,
"businessNumber": "abc123",
"clientClassification": "CHARITABLE_TRUST",
"companyType": "FOREIGN_UNREGISTERED_PUBLIC",
"controllingPersons": ["xyz789"],
"countryOfEffectiveManagement": "xyz789",
"countryOfEstablishment": "xyz789",
"customer": Identifier,
"customerNode": Customer,
"email": "abc123",
"fullName": "xyz789",
"giin": "xyz789",
"kycInformation": PartyKycInformation,
"noTaxResidency": false,
"reference": "xyz789",
"registeredOfficeAddress": PartyCompanyRegisteredOfficeAddress,
"roles": ["BENEFICIARY"],
"selfCertified": SelfCertified,
"stockExchange": "abc123",
"taxReportingType": "ACTIVE_NON_FINANCIAL_ENTITY",
"taxResidencies": [TaxResidency],
"tradingName": "xyz789",
"workPhone": "xyz789"
}
PartyCompanyForeignUnregisteredPublicType
Values
| Enum Value | Description |
|---|---|
|
|
Example
"FOREIGN_UNREGISTERED_PUBLIC"
PartyCompanyInterface
Fields
| Field Name | Description |
|---|---|
alternateAddress - PartyCompanyAlternateAddress
|
|
businessNumber - String
|
|
clientClassification - PartyNonIndividualClientClassification
|
|
controllingPersons - [String]
|
|
countryOfEffectiveManagement - String
|
|
customer - Identifier
|
|
customerNode - Customer
|
|
email - String
|
|
fullName - String
|
|
giin - String
|
|
kycInformation - PartyKycInformation
|
|
noTaxResidency - Boolean
|
|
reference - String
|
|
registeredOfficeAddress - PartyCompanyRegisteredOfficeAddress
|
|
roles - [Role]
|
|
selfCertified - SelfCertified
|
|
taxReportingType - PartyNonIndividualTaxReportingType
|
|
taxResidencies - [TaxResidency]
|
|
tradingName - String
|
|
workPhone - String
|
Possible Types
| PartyCompanyInterface Types |
|---|
Example
{
"alternateAddress": PartyCompanyAlternateAddress,
"businessNumber": "xyz789",
"clientClassification": "CHARITABLE_TRUST",
"controllingPersons": ["abc123"],
"countryOfEffectiveManagement": "xyz789",
"customer": Identifier,
"customerNode": Customer,
"email": "xyz789",
"fullName": "abc123",
"giin": "xyz789",
"kycInformation": PartyKycInformation,
"noTaxResidency": true,
"reference": "xyz789",
"registeredOfficeAddress": PartyCompanyRegisteredOfficeAddress,
"roles": ["BENEFICIARY"],
"selfCertified": SelfCertified,
"taxReportingType": "ACTIVE_NON_FINANCIAL_ENTITY",
"taxResidencies": [TaxResidency],
"tradingName": "xyz789",
"workPhone": "abc123"
}
PartyCompanyPrivateCreateDetails
Fields
| Field Name | Description |
|---|---|
alternateAddress - PartyCompanyAlternateAddress
|
|
businessNumber - String
|
|
clientClassification - PartyNonIndividualClientClassification
|
|
companyNumber - String
|
|
companyType - PartyCompanyPrivateType
|
|
controllingPersons - [String]
|
|
countryOfEffectiveManagement - String
|
|
customer - Identifier
|
|
customerNode - Customer
|
|
email - String
|
|
fullName - String
|
|
giin - String
|
|
incorporationCountry - String
|
|
incorporationDate - Date
|
|
kycInformation - PartyKycInformation
|
|
noTaxResidency - Boolean
|
|
reference - String
|
|
registeredOfficeAddress - PartyCompanyRegisteredOfficeAddress
|
|
roles - [Role]
|
|
selfCertified - SelfCertified
|
|
taxReportingType - PartyNonIndividualTaxReportingType
|
|
taxResidencies - [TaxResidency]
|
|
tradingName - String
|
|
workPhone - String
|
Example
{
"alternateAddress": PartyCompanyAlternateAddress,
"businessNumber": "xyz789",
"clientClassification": "CHARITABLE_TRUST",
"companyNumber": "xyz789",
"companyType": "PRIVATE",
"controllingPersons": ["xyz789"],
"countryOfEffectiveManagement": "abc123",
"customer": Identifier,
"customerNode": Customer,
"email": "xyz789",
"fullName": "xyz789",
"giin": "xyz789",
"incorporationCountry": "abc123",
"incorporationDate": "2007-12-03",
"kycInformation": PartyKycInformation,
"noTaxResidency": false,
"reference": "abc123",
"registeredOfficeAddress": PartyCompanyRegisteredOfficeAddress,
"roles": ["BENEFICIARY"],
"selfCertified": SelfCertified,
"taxReportingType": "ACTIVE_NON_FINANCIAL_ENTITY",
"taxResidencies": [TaxResidency],
"tradingName": "abc123",
"workPhone": "xyz789"
}
PartyCompanyPrivateType
Values
| Enum Value | Description |
|---|---|
|
|
Example
"PRIVATE"
PartyCompanyPublicCreateDetails
Fields
| Field Name | Description |
|---|---|
alternateAddress - PartyCompanyAlternateAddress
|
|
businessNumber - String
|
|
clientClassification - PartyNonIndividualClientClassification
|
|
companyNumber - String
|
|
companyType - PartyCompanyPublicType
|
|
controllingPersons - [String]
|
|
countryOfEffectiveManagement - String
|
|
customer - Identifier
|
|
customerNode - Customer
|
|
email - String
|
|
fullName - String
|
|
giin - String
|
|
incorporationCountry - String
|
|
incorporationDate - Date
|
|
kycInformation - PartyKycInformation
|
|
noTaxResidency - Boolean
|
|
reference - String
|
|
registeredOfficeAddress - PartyCompanyRegisteredOfficeAddress
|
|
roles - [Role]
|
|
selfCertified - SelfCertified
|
|
stockExchange - String
|
|
taxReportingType - PartyNonIndividualTaxReportingType
|
|
taxResidencies - [TaxResidency]
|
|
tradingName - String
|
|
workPhone - String
|
Example
{
"alternateAddress": PartyCompanyAlternateAddress,
"businessNumber": "xyz789",
"clientClassification": "CHARITABLE_TRUST",
"companyNumber": "abc123",
"companyType": "PUBLIC",
"controllingPersons": ["xyz789"],
"countryOfEffectiveManagement": "xyz789",
"customer": Identifier,
"customerNode": Customer,
"email": "abc123",
"fullName": "abc123",
"giin": "xyz789",
"incorporationCountry": "abc123",
"incorporationDate": "2007-12-03",
"kycInformation": PartyKycInformation,
"noTaxResidency": true,
"reference": "abc123",
"registeredOfficeAddress": PartyCompanyRegisteredOfficeAddress,
"roles": ["BENEFICIARY"],
"selfCertified": SelfCertified,
"stockExchange": "abc123",
"taxReportingType": "ACTIVE_NON_FINANCIAL_ENTITY",
"taxResidencies": [TaxResidency],
"tradingName": "abc123",
"workPhone": "abc123"
}
PartyCompanyPublicType
Values
| Enum Value | Description |
|---|---|
|
|
Example
"PUBLIC"
PartyCompanyRegisteredOfficeAddress
PartyCompanyType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"FOREIGN_REGISTERED_PRIVATE"
PartyCompanyUpdateCommand
Fields
| Field Name | Description |
|---|---|
action - String!
|
Use operation field, the operation field is an enumeration that makes it easier to query with |
approval - Approval
|
|
createdTimestamp - DateTime
|
|
id - ID!
|
|
inputJson - String
|
|
invalid - [CommandError]!
|
|
operation - Action!
|
|
party - Party
|
|
state - CommandState!
|
|
step - String!
|
|
user - String!
|
Use userInfo, as this only details the sub |
userInfo - UserInfo!
|
|
userInput - PartyCompanyUpdateDetails
|
Example
{
"action": "abc123",
"approval": Approval,
"createdTimestamp": "2007-12-03T10:15:30Z",
"id": "4",
"inputJson": "xyz789",
"invalid": [CommandError],
"operation": "AGGREGATE_PAYMENT_EXECUTE",
"party": Party,
"state": "SUBMITTED",
"step": "xyz789",
"user": "abc123",
"userInfo": UserInfo,
"userInput": PartyCompanyUpdateDetails
}
PartyCompanyUpdateDetails
Fields
Example
{
"alternateAddress": PartyCompanyEditableAlternateAddress,
"businessNumber": UnionableEnum,
"clientClassification": UnionableEnum,
"companyNumber": UnionableEnum,
"companyType": "FOREIGN_REGISTERED_PRIVATE",
"controllingPersons": UnionableEnum,
"countryOfEffectiveManagement": UnionableEnum,
"countryOfEstablishment": UnionableEnum,
"email": UnionableEnum,
"fullName": "xyz789",
"giin": UnionableEnum,
"id": "xyz789",
"incorporationCountry": UnionableEnum,
"incorporationDate": UnionableDate,
"noTaxResidency": false,
"reference": UnionableEnum,
"registeredBodyNumber": UnionableEnum,
"registeredOfficeAddress": PartyCompanyEditableRegisteredOfficeAddress,
"roles": ["BENEFICIARY"],
"selfCertified": SelfCertified,
"stockExchange": UnionableEnum,
"taxReportingType": UnionableEnum,
"taxResidencies": [TaxResidency],
"tradingName": UnionableEnum,
"workPhone": UnionableEnum
}
PartyConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [PartyEdge]
|
|
aggregates - SimpleConnectionAggregate!
|
Example
{
"pageInfo": PageInfo,
"edges": [PartyEdge],
"aggregates": SimpleConnectionAggregate
}
PartyCooperative
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
shortId - String!
|
|
customer - Customer!
|
|
reference - String
|
|
roles - [Role!]!
|
|
selfCertified - SelfCertified
|
|
linkedAccounts - PartyLinkedAccountConnection!
|
|
Arguments |
|
kycInformation - KYCInformation
|
|
previousDomesticTin - String
|
|
dateOfResidencyChange - DateTime
|
|
previousSelfCertified - [SelfCertifiedHistory]
|
|
fullName - String!
|
|
businessNumber - String
|
|
email - String
|
|
workPhone - String
|
|
registeredOfficeAddress - Address!
|
|
alternateAddress - Address
|
|
clientClassification - NonIndividualClientClassification
|
|
taxResidencies - [NonIndividualTaxResidency!]!
|
|
registeredBodyNumber - String
|
|
countryOfEstablishment - String!
|
|
Example
{
"id": "4",
"shortId": "abc123",
"customer": Customer,
"reference": "xyz789",
"roles": ["BENEFICIARY"],
"selfCertified": SelfCertified,
"linkedAccounts": PartyLinkedAccountConnection,
"kycInformation": KYCInformation,
"previousDomesticTin": "xyz789",
"dateOfResidencyChange": "2007-12-03T10:15:30Z",
"previousSelfCertified": [SelfCertifiedHistory],
"fullName": "xyz789",
"businessNumber": "abc123",
"email": "xyz789",
"workPhone": "xyz789",
"registeredOfficeAddress": Address,
"alternateAddress": Address,
"clientClassification": "COMPANY",
"taxResidencies": [NonIndividualTaxResidency],
"registeredBodyNumber": "abc123",
"countryOfEstablishment": "xyz789"
}
PartyCooperativeAlternateAddress
PartyCooperativeAlternateAddressUnionableEnumUnion
Types
| Union Types |
|---|
Example
PartyCooperativeAlternateAddress
PartyCooperativeCreateCommand
Fields
| Field Name | Description |
|---|---|
action - String!
|
Use operation field, the operation field is an enumeration that makes it easier to query with |
approval - Approval
|
|
createdTimestamp - DateTime
|
|
customer - Customer
|
|
id - ID!
|
|
inputJson - String
|
|
invalid - [CommandError]!
|
|
operation - Action!
|
|
party - Party
|
|
state - CommandState!
|
|
step - String!
|
|
user - String!
|
Use userInfo, as this only details the sub |
userInfo - UserInfo!
|
|
userInput - CooperativeCreateDetails
|
Example
{
"action": "xyz789",
"approval": Approval,
"createdTimestamp": "2007-12-03T10:15:30Z",
"customer": Customer,
"id": "4",
"inputJson": "abc123",
"invalid": [CommandError],
"operation": "AGGREGATE_PAYMENT_EXECUTE",
"party": Party,
"state": "SUBMITTED",
"step": "xyz789",
"user": "abc123",
"userInfo": UserInfo,
"userInput": CooperativeCreateDetails
}
PartyCooperativeOfficeAddress
PartyCooperativeUpdateCommand
Fields
| Field Name | Description |
|---|---|
action - String!
|
Use operation field, the operation field is an enumeration that makes it easier to query with |
approval - Approval
|
|
createdTimestamp - DateTime
|
|
id - ID!
|
|
inputJson - String
|
|
invalid - [CommandError]!
|
|
operation - Action!
|
|
party - Party
|
|
state - CommandState!
|
|
step - String!
|
|
user - String!
|
Use userInfo, as this only details the sub |
userInfo - UserInfo!
|
|
userInput - PartyCooperativeUpdateDetails
|
Example
{
"action": "xyz789",
"approval": Approval,
"createdTimestamp": "2007-12-03T10:15:30Z",
"id": 4,
"inputJson": "xyz789",
"invalid": [CommandError],
"operation": "AGGREGATE_PAYMENT_EXECUTE",
"party": Party,
"state": "SUBMITTED",
"step": "abc123",
"user": "xyz789",
"userInfo": UserInfo,
"userInput": PartyCooperativeUpdateDetails
}
PartyCooperativeUpdateDetails
Fields
| Field Name | Description |
|---|---|
alternateAddress - PartyCooperativeAlternateAddressUnionableEnumUnion
|
|
businessNumber - UnionableEnumUnionableStringUnion
|
|
clientClassification - UnionableEnum
|
|
countryOfEstablishment - String
|
|
email - UnionableEnumUnionableStringUnion
|
|
fullName - String
|
|
id - String
|
|
reference - UnionableEnumUnionableStringUnion
|
|
registeredBodyNumber - UnionableEnumUnionableStringUnion
|
|
registeredOfficeAddress - EditableAddress
|
|
roles - [Role]
|
|
taxResidencies - [TaxResidency]
|
|
workPhone - UnionableEnumUnionableStringUnion
|
Example
{
"alternateAddress": PartyCooperativeAlternateAddress,
"businessNumber": UnionableEnum,
"clientClassification": UnionableEnum,
"countryOfEstablishment": "abc123",
"email": UnionableEnum,
"fullName": "abc123",
"id": "xyz789",
"reference": UnionableEnum,
"registeredBodyNumber": UnionableEnum,
"registeredOfficeAddress": EditableAddress,
"roles": ["BENEFICIARY"],
"taxResidencies": [TaxResidency],
"workPhone": UnionableEnum
}
PartyCreated
Fields
| Field Name | Description |
|---|---|
party - Party!
|
Example
{"party": Party}
PartyDeceaseCommand
Fields
| Field Name | Description |
|---|---|
action - String!
|
Use operation field, the operation field is an enumeration that makes it easier to query with |
approval - Approval
|
|
createdTimestamp - DateTime
|
|
id - ID!
|
|
inputJson - String
|
|
invalid - [CommandError]!
|
|
operation - Action!
|
|
party - Party
|
|
state - CommandState!
|
|
step - String!
|
|
user - String!
|
Use userInfo, as this only details the sub |
userInfo - UserInfo!
|
|
userInput - PartyDeceaseDetails
|
Example
{
"action": "xyz789",
"approval": Approval,
"createdTimestamp": "2007-12-03T10:15:30Z",
"id": 4,
"inputJson": "xyz789",
"invalid": [CommandError],
"operation": "AGGREGATE_PAYMENT_EXECUTE",
"party": Party,
"state": "SUBMITTED",
"step": "abc123",
"user": "abc123",
"userInfo": UserInfo,
"userInput": PartyDeceaseDetails
}
PartyDeceaseDetails
Fields
| Field Name | Description |
|---|---|
dateOfDeath - UnionableDateUnionableEnumUnion
|
|
id - String
|
Example
{
"dateOfDeath": UnionableDate,
"id": "xyz789"
}
PartyDeceased
Fields
| Field Name | Description |
|---|---|
party - Party!
|
Example
{"party": Party}
PartyDeleteCommand
Fields
| Field Name | Description |
|---|---|
action - String!
|
Use operation field, the operation field is an enumeration that makes it easier to query with |
approval - Approval
|
|
createdTimestamp - DateTime
|
|
id - ID!
|
|
inputJson - String
|
|
invalid - [CommandError]!
|
|
operation - Action!
|
|
party - Party
|
|
state - CommandState!
|
|
step - String!
|
|
user - String!
|
Use userInfo, as this only details the sub |
userInfo - UserInfo!
|
|
userInput - PartyDeleteDetails
|
Example
{
"action": "abc123",
"approval": Approval,
"createdTimestamp": "2007-12-03T10:15:30Z",
"id": "4",
"inputJson": "abc123",
"invalid": [CommandError],
"operation": "AGGREGATE_PAYMENT_EXECUTE",
"party": Party,
"state": "SUBMITTED",
"step": "abc123",
"user": "abc123",
"userInfo": UserInfo,
"userInput": PartyDeleteDetails
}
PartyDeleteDetails
Fields
| Field Name | Description |
|---|---|
id - String
|
Example
{"id": "abc123"}
PartyDeleted
Fields
| Field Name | Description |
|---|---|
partyId - ID!
|
Example
{"partyId": "4"}
PartyEdge
PartyFilter
Description
A simple use of this filter might look like:
filter: {partyReferenceExact:"Party Ref"}
A filter with a top level 'or' might look like:
filter: {or: [{partyReferenceExact: "Party Ref"}, {shortIdContains: "1234"}]}
Fields
| Input Field | Description |
|---|---|
or - [PartyFilter!]
|
|
partyType - PartyType
|
|
partyReferenceContains - String
|
|
partyReferenceExact - String
|
|
shortIdContains - String
|
|
shortIdExact - String
|
|
hasRoles - [Role!]
|
|
givenNameExact - String
|
|
givenNameContains - String
|
|
familyNameExact - String
|
|
familyNameContains - String
|
|
individualDeceased - Boolean
|
|
companyFullNameExact - String
|
|
companyFullNameContains - String
|
|
companySubType - CompanySubType
|
|
trustFullNameExact - String
|
|
trustFullNameContains - String
|
|
trustSubType - TrustSubType
|
Example
{
"or": [PartyFilter],
"partyType": "INDIVIDUAL",
"partyReferenceContains": "abc123",
"partyReferenceExact": "abc123",
"shortIdContains": "xyz789",
"shortIdExact": "abc123",
"hasRoles": ["BENEFICIARY"],
"givenNameExact": "xyz789",
"givenNameContains": "xyz789",
"familyNameExact": "xyz789",
"familyNameContains": "abc123",
"individualDeceased": false,
"companyFullNameExact": "abc123",
"companyFullNameContains": "abc123",
"companySubType": "PRIVATE",
"trustFullNameExact": "abc123",
"trustFullNameContains": "abc123",
"trustSubType": "REGULATED_SELF_MANAGED_SUPER_FUND"
}
PartyGovernmentBody
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
shortId - String!
|
|
customer - Customer!
|
|
reference - String
|
|
roles - [Role!]!
|
|
selfCertified - SelfCertified
|
|
linkedAccounts - PartyLinkedAccountConnection!
|
|
Arguments |
|
kycInformation - KYCInformation
|
|
previousDomesticTin - String
|
|
dateOfResidencyChange - DateTime
|
|
previousSelfCertified - [SelfCertifiedHistory]
|
|
fullName - String!
|
|
businessNumber - String
|
|
email - String
|
|
workPhone - String
|
|
registeredOfficeAddress - Address!
|
|
alternateAddress - Address
|
|
clientClassification - NonIndividualClientClassification
|
|
taxResidencies - [NonIndividualTaxResidency!]!
|
|
governmentBodyType - GovernmentBodySubType!
|
|
countryOfEstablishment - String!
|
|
Example
{
"id": "4",
"shortId": "xyz789",
"customer": Customer,
"reference": "abc123",
"roles": ["BENEFICIARY"],
"selfCertified": SelfCertified,
"linkedAccounts": PartyLinkedAccountConnection,
"kycInformation": KYCInformation,
"previousDomesticTin": "abc123",
"dateOfResidencyChange": "2007-12-03T10:15:30Z",
"previousSelfCertified": [SelfCertifiedHistory],
"fullName": "abc123",
"businessNumber": "abc123",
"email": "xyz789",
"workPhone": "abc123",
"registeredOfficeAddress": Address,
"alternateAddress": Address,
"clientClassification": "COMPANY",
"taxResidencies": [NonIndividualTaxResidency],
"governmentBodyType": "OFFSHORE",
"countryOfEstablishment": "xyz789"
}
PartyGovernmentBodyAlternateAddress
PartyGovernmentBodyAlternateAddressUnionableEnumUnion
Types
| Union Types |
|---|
Example
PartyGovernmentBodyAlternateAddress
PartyGovernmentBodyCreateCommand
Fields
| Field Name | Description |
|---|---|
action - String!
|
Use operation field, the operation field is an enumeration that makes it easier to query with |
approval - Approval
|
|
createdTimestamp - DateTime
|
|
customer - Customer
|
|
id - ID!
|
|
inputJson - String
|
|
invalid - [CommandError]!
|
|
operation - Action!
|
|
party - Party
|
|
state - CommandState!
|
|
step - String!
|
|
user - String!
|
Use userInfo, as this only details the sub |
userInfo - UserInfo!
|
|
userInput - PartyGovernmentBodyCreateDetails
|
Example
{
"action": "abc123",
"approval": Approval,
"createdTimestamp": "2007-12-03T10:15:30Z",
"customer": Customer,
"id": 4,
"inputJson": "abc123",
"invalid": [CommandError],
"operation": "AGGREGATE_PAYMENT_EXECUTE",
"party": Party,
"state": "SUBMITTED",
"step": "abc123",
"user": "xyz789",
"userInfo": UserInfo,
"userInput": PartyGovernmentBodyCreateDetails
}
PartyGovernmentBodyCreateDetails
Fields
| Field Name | Description |
|---|---|
alternateAddress - PartyGovernmentBodyAlternateAddress
|
|
businessNumber - String
|
|
clientClassification - PartyNonIndividualClientClassification
|
|
countryOfEstablishment - String
|
|
customer - Identifier
|
|
customerNode - Customer
|
|
email - String
|
|
fullName - String
|
|
governmentBodyType - GovernmentBodyType
|
|
kycInformation - PartyKycInformation
|
|
reference - String
|
|
registeredOfficeAddress - PartyGovernmentBodyOfficeAddress
|
|
roles - [Role]
|
|
taxResidencies - [TaxResidency]
|
|
workPhone - String
|
Example
{
"alternateAddress": PartyGovernmentBodyAlternateAddress,
"businessNumber": "xyz789",
"clientClassification": "CHARITABLE_TRUST",
"countryOfEstablishment": "abc123",
"customer": Identifier,
"customerNode": Customer,
"email": "xyz789",
"fullName": "xyz789",
"governmentBodyType": "DOMESTIC",
"kycInformation": PartyKycInformation,
"reference": "xyz789",
"registeredOfficeAddress": PartyGovernmentBodyOfficeAddress,
"roles": ["BENEFICIARY"],
"taxResidencies": [TaxResidency],
"workPhone": "xyz789"
}
PartyGovernmentBodyOfficeAddress
PartyGovernmentBodyUpdateCommand
Fields
| Field Name | Description |
|---|---|
action - String!
|
Use operation field, the operation field is an enumeration that makes it easier to query with |
approval - Approval
|
|
createdTimestamp - DateTime
|
|
id - ID!
|
|
inputJson - String
|
|
invalid - [CommandError]!
|
|
operation - Action!
|
|
party - Party
|
|
state - CommandState!
|
|
step - String!
|
|
user - String!
|
Use userInfo, as this only details the sub |
userInfo - UserInfo!
|
|
userInput - PartyGovernmentBodyUpdateDetails
|
Example
{
"action": "abc123",
"approval": Approval,
"createdTimestamp": "2007-12-03T10:15:30Z",
"id": 4,
"inputJson": "xyz789",
"invalid": [CommandError],
"operation": "AGGREGATE_PAYMENT_EXECUTE",
"party": Party,
"state": "SUBMITTED",
"step": "abc123",
"user": "abc123",
"userInfo": UserInfo,
"userInput": PartyGovernmentBodyUpdateDetails
}
PartyGovernmentBodyUpdateDetails
Fields
| Field Name | Description |
|---|---|
alternateAddress - PartyGovernmentBodyAlternateAddressUnionableEnumUnion
|
|
businessNumber - UnionableEnumUnionableStringUnion
|
|
clientClassification - UnionableEnum
|
|
countryOfEstablishment - String
|
|
email - UnionableEnumUnionableStringUnion
|
|
fullName - String
|
|
governmentBodyType - GovernmentBodyType
|
|
id - String
|
|
reference - UnionableEnumUnionableStringUnion
|
|
registeredOfficeAddress - PartyGovernmentBodyOfficeAddress
|
|
roles - [Role]
|
|
taxResidencies - [TaxResidency]
|
|
workPhone - UnionableEnumUnionableStringUnion
|
Example
{
"alternateAddress": PartyGovernmentBodyAlternateAddress,
"businessNumber": UnionableEnum,
"clientClassification": UnionableEnum,
"countryOfEstablishment": "abc123",
"email": UnionableEnum,
"fullName": "abc123",
"governmentBodyType": "DOMESTIC",
"id": "abc123",
"reference": UnionableEnum,
"registeredOfficeAddress": PartyGovernmentBodyOfficeAddress,
"roles": ["BENEFICIARY"],
"taxResidencies": [TaxResidency],
"workPhone": UnionableEnum
}
PartyIndividual
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
customer - Customer!
|
|
title - String
|
|
givenName - String!
|
|
otherGivenNames - [String!]
|
|
familyName - String!
|
|
reference - String
|
|
gender - Gender
|
|
dateOfBirth - Date
|
|
residentialAddress - Address!
|
|
alternateAddress - Address
|
|
taxResidencies - [IndividualTaxResidency!]!
|
|
roles - [Role!]!
|
|
taxReportingType - IndividualTaxReportingType
|
|
selfCertified - SelfCertified
|
|
linkedAccounts - PartyLinkedAccountConnection!
|
|
Arguments |
|
deceased - Boolean!
|
|
dateOfDeath - Date
|
|
controlledParties - PartyConnection!
|
|
kycInformation - KYCInformation
|
|
shortId - String!
|
|
previousDomesticTin - String
|
|
dateOfResidencyChange - DateTime
|
|
previousSelfCertified - [SelfCertifiedHistory]
|
|
Example
{
"id": "4",
"customer": Customer,
"title": "abc123",
"givenName": "abc123",
"otherGivenNames": ["xyz789"],
"familyName": "xyz789",
"reference": "xyz789",
"gender": Gender,
"dateOfBirth": "2007-12-03",
"residentialAddress": Address,
"alternateAddress": Address,
"taxResidencies": [IndividualTaxResidency],
"roles": ["BENEFICIARY"],
"taxReportingType": "INDIVIDUAL",
"selfCertified": SelfCertified,
"linkedAccounts": PartyLinkedAccountConnection,
"deceased": true,
"dateOfDeath": "2007-12-03",
"controlledParties": PartyConnection,
"kycInformation": KYCInformation,
"shortId": "xyz789",
"previousDomesticTin": "abc123",
"dateOfResidencyChange": "2007-12-03T10:15:30Z",
"previousSelfCertified": [SelfCertifiedHistory]
}
PartyIndividualAlternateAddress
PartyIndividualCreateCommand
Fields
| Field Name | Description |
|---|---|
action - String!
|
Use operation field, the operation field is an enumeration that makes it easier to query with |
approval - Approval
|
|
createdTimestamp - DateTime
|
|
customer - Customer
|
|
id - ID!
|
|
inputJson - String
|
|
invalid - [CommandError]!
|
|
operation - Action!
|
|
party - Party
|
|
state - CommandState!
|
|
step - String!
|
|
user - String!
|
Use userInfo, as this only details the sub |
userInfo - UserInfo!
|
|
userInput - PartyIndividualCreateDetails
|
Example
{
"action": "xyz789",
"approval": Approval,
"createdTimestamp": "2007-12-03T10:15:30Z",
"customer": Customer,
"id": "4",
"inputJson": "abc123",
"invalid": [CommandError],
"operation": "AGGREGATE_PAYMENT_EXECUTE",
"party": Party,
"state": "SUBMITTED",
"step": "xyz789",
"user": "xyz789",
"userInfo": UserInfo,
"userInput": PartyIndividualCreateDetails
}
PartyIndividualCreateDetails
Fields
| Field Name | Description |
|---|---|
alternateAddress - PartyIndividualAlternateAddress
|
|
customer - Identifier
|
|
customerNode - Customer
|
|
dateOfBirth - Date
|
|
familyName - String
|
|
gender - String
|
|
givenName - String
|
|
kycInformation - KYCInformation
|
|
otherGivenNames - [String]
|
|
reference - String
|
|
residentialAddress - PartyIndividualResidentialAddress
|
|
roles - [Role]
|
|
selfCertified - SelfCertified
|
|
taxResidencies - [TaxResidency]
|
|
title - String
|
Example
{
"alternateAddress": PartyIndividualAlternateAddress,
"customer": Identifier,
"customerNode": Customer,
"dateOfBirth": "2007-12-03",
"familyName": "abc123",
"gender": "xyz789",
"givenName": "xyz789",
"kycInformation": KYCInformation,
"otherGivenNames": ["abc123"],
"reference": "xyz789",
"residentialAddress": PartyIndividualResidentialAddress,
"roles": ["BENEFICIARY"],
"selfCertified": SelfCertified,
"taxResidencies": [TaxResidency],
"title": "abc123"
}
PartyIndividualEditableAlternateAddress
PartyIndividualEditableAlternateAddressUnionableEnumUnion
Types
| Union Types |
|---|
Example
PartyIndividualEditableAlternateAddress
PartyIndividualEditableResidentialAddress
PartyIndividualResidentialAddress
PartyIndividualUpdateCommand
Fields
| Field Name | Description |
|---|---|
action - String!
|
Use operation field, the operation field is an enumeration that makes it easier to query with |
approval - Approval
|
|
createdTimestamp - DateTime
|
|
id - ID!
|
|
inputJson - String
|
|
invalid - [CommandError]!
|
|
operation - Action!
|
|
party - Party
|
|
state - CommandState!
|
|
step - String!
|
|
user - String!
|
Use userInfo, as this only details the sub |
userInfo - UserInfo!
|
|
userInput - PartyIndividualUpdateDetails
|
Example
{
"action": "abc123",
"approval": Approval,
"createdTimestamp": "2007-12-03T10:15:30Z",
"id": 4,
"inputJson": "abc123",
"invalid": [CommandError],
"operation": "AGGREGATE_PAYMENT_EXECUTE",
"party": Party,
"state": "SUBMITTED",
"step": "abc123",
"user": "xyz789",
"userInfo": UserInfo,
"userInput": PartyIndividualUpdateDetails
}
PartyIndividualUpdateDetails
Fields
| Field Name | Description |
|---|---|
alternateAddress - PartyIndividualEditableAlternateAddressUnionableEnumUnion
|
|
dateOfBirth - UnionableDateUnionableEnumUnion
|
|
familyName - String
|
|
gender - UnionableEnumUnionableStringUnion
|
|
givenName - String
|
|
id - String
|
|
otherGivenNames - UnionableEnum
|
|
reference - UnionableEnumUnionableStringUnion
|
|
residentialAddress - PartyIndividualEditableResidentialAddress
|
|
roles - [Role]
|
|
selfCertified - SelfCertified
|
|
taxResidencies - [TaxResidency]
|
|
title - UnionableEnumUnionableStringUnion
|
Example
{
"alternateAddress": PartyIndividualEditableAlternateAddress,
"dateOfBirth": UnionableDate,
"familyName": "xyz789",
"gender": UnionableEnum,
"givenName": "xyz789",
"id": "xyz789",
"otherGivenNames": UnionableEnum,
"reference": UnionableEnum,
"residentialAddress": PartyIndividualEditableResidentialAddress,
"roles": ["BENEFICIARY"],
"selfCertified": SelfCertified,
"taxResidencies": [TaxResidency],
"title": UnionableEnum
}
PartyKycInformation
Fields
| Field Name | Description |
|---|---|
bankUniqueId - String
|
|
kycId - String
|
|
kycStatus - KycStatuses
|
|
verificationStatus - VerificationStatuses
|
Example
{
"bankUniqueId": "xyz789",
"kycId": "xyz789",
"kycStatus": "COMPLETE",
"verificationStatus": "ESCALATE"
}
PartyLinkedAccountConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [PartyLinkedAccountEdge]
|
|
aggregates - SimpleConnectionAggregate!
|
Example
{
"pageInfo": PageInfo,
"edges": [PartyLinkedAccountEdge],
"aggregates": SimpleConnectionAggregate
}
PartyLinkedAccountEdge
PartyListSubscription
Types
| Union Types |
|---|
Example
PartyCreated
PartyNonIndividualClientClassification
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CHARITABLE_TRUST"
PartyNonIndividualTaxReportingType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ACTIVE_NON_FINANCIAL_ENTITY"
PartyOrdering
Fields
| Input Field | Description |
|---|---|
sort - PartySort!
|
|
direction - OrderingDirection!
|
Example
{"sort": "GIVEN_NAME", "direction": "ASC"}
PartyPartnership
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
shortId - String!
|
|
customer - Customer!
|
|
reference - String
|
|
roles - [Role!]!
|
|
selfCertified - SelfCertified
|
|
linkedAccounts - PartyLinkedAccountConnection!
|
|
Arguments |
|
kycInformation - KYCInformation
|
|
previousDomesticTin - String
|
|
dateOfResidencyChange - DateTime
|
|
previousSelfCertified - [SelfCertifiedHistory]
|
|
fullName - String!
|
|
businessNumber - String
|
|
email - String
|
|
workPhone - String
|
|
registeredOfficeAddress - Address!
|
|
alternateAddress - Address
|
|
clientClassification - NonIndividualClientClassification
|
|
taxResidencies - [NonIndividualTaxResidency!]!
|
|
partnershipType - PartnershipSubType!
|
|
countryOfEstablishment - String!
|
|
Example
{
"id": 4,
"shortId": "abc123",
"customer": Customer,
"reference": "abc123",
"roles": ["BENEFICIARY"],
"selfCertified": SelfCertified,
"linkedAccounts": PartyLinkedAccountConnection,
"kycInformation": KYCInformation,
"previousDomesticTin": "abc123",
"dateOfResidencyChange": "2007-12-03T10:15:30Z",
"previousSelfCertified": [SelfCertifiedHistory],
"fullName": "abc123",
"businessNumber": "abc123",
"email": "xyz789",
"workPhone": "abc123",
"registeredOfficeAddress": Address,
"alternateAddress": Address,
"clientClassification": "COMPANY",
"taxResidencies": [NonIndividualTaxResidency],
"partnershipType": "REGULATED",
"countryOfEstablishment": "xyz789"
}
PartyPartnershipAlternateAddress
PartyPartnershipCreateCommand
Fields
| Field Name | Description |
|---|---|
action - String!
|
Use operation field, the operation field is an enumeration that makes it easier to query with |
approval - Approval
|
|
createdTimestamp - DateTime
|
|
customer - Customer
|
|
id - ID!
|
|
inputJson - String
|
|
invalid - [CommandError]!
|
|
operation - Action!
|
|
party - Party
|
|
state - CommandState!
|
|
step - String!
|
|
user - String!
|
Use userInfo, as this only details the sub |
userInfo - UserInfo!
|
|
userInput - PartyPartnershipCreateDetails
|
Example
{
"action": "xyz789",
"approval": Approval,
"createdTimestamp": "2007-12-03T10:15:30Z",
"customer": Customer,
"id": 4,
"inputJson": "abc123",
"invalid": [CommandError],
"operation": "AGGREGATE_PAYMENT_EXECUTE",
"party": Party,
"state": "SUBMITTED",
"step": "xyz789",
"user": "xyz789",
"userInfo": UserInfo,
"userInput": PartyPartnershipCreateDetails
}
PartyPartnershipCreateDetails
Fields
| Field Name | Description |
|---|---|
alternateAddress - PartyPartnershipAlternateAddress
|
|
businessNumber - String
|
|
clientClassification - PartyNonIndividualClientClassification
|
|
countryOfEstablishment - String
|
|
customer - Identifier
|
|
customerNode - Customer
|
|
email - String
|
|
fullName - String
|
|
kycInformation - PartyKycInformation
|
|
partnershipType - PartnershipType
|
|
reference - String
|
|
registeredOfficeAddress - PartyPartnershipOfficeAddress
|
|
roles - [Role]
|
|
taxResidencies - [TaxResidency]
|
|
workPhone - String
|
Example
{
"alternateAddress": PartyPartnershipAlternateAddress,
"businessNumber": "xyz789",
"clientClassification": "CHARITABLE_TRUST",
"countryOfEstablishment": "abc123",
"customer": Identifier,
"customerNode": Customer,
"email": "abc123",
"fullName": "xyz789",
"kycInformation": PartyKycInformation,
"partnershipType": "REGULATED",
"reference": "xyz789",
"registeredOfficeAddress": PartyPartnershipOfficeAddress,
"roles": ["BENEFICIARY"],
"taxResidencies": [TaxResidency],
"workPhone": "xyz789"
}
PartyPartnershipEditableAlternateAddress
PartyPartnershipEditableAlternateAddressUnionableEnumUnion
Types
| Union Types |
|---|
Example
PartyPartnershipEditableAlternateAddress
PartyPartnershipEditableRegisteredOfficeAddress
PartyPartnershipOfficeAddress
PartyPartnershipUpdateCommand
Fields
| Field Name | Description |
|---|---|
action - String!
|
Use operation field, the operation field is an enumeration that makes it easier to query with |
approval - Approval
|
|
createdTimestamp - DateTime
|
|
id - ID!
|
|
inputJson - String
|
|
invalid - [CommandError]!
|
|
operation - Action!
|
|
party - Party
|
|
state - CommandState!
|
|
step - String!
|
|
user - String!
|
Use userInfo, as this only details the sub |
userInfo - UserInfo!
|
|
userInput - PartyPartnershipUpdateDetails
|
Example
{
"action": "xyz789",
"approval": Approval,
"createdTimestamp": "2007-12-03T10:15:30Z",
"id": "4",
"inputJson": "abc123",
"invalid": [CommandError],
"operation": "AGGREGATE_PAYMENT_EXECUTE",
"party": Party,
"state": "SUBMITTED",
"step": "abc123",
"user": "abc123",
"userInfo": UserInfo,
"userInput": PartyPartnershipUpdateDetails
}
PartyPartnershipUpdateDetails
Fields
| Field Name | Description |
|---|---|
alternateAddress - PartyPartnershipEditableAlternateAddressUnionableEnumUnion
|
|
businessNumber - UnionableEnumUnionableStringUnion
|
|
clientClassification - UnionableEnum
|
|
countryOfEstablishment - String
|
|
email - UnionableEnumUnionableStringUnion
|
|
fullName - String
|
|
id - String
|
|
partnershipType - PartnershipType
|
|
reference - UnionableEnumUnionableStringUnion
|
|
registeredOfficeAddress - PartyPartnershipEditableRegisteredOfficeAddress
|
|
roles - [Role]
|
|
taxResidencies - [TaxResidency]
|
|
workPhone - UnionableEnumUnionableStringUnion
|
Example
{
"alternateAddress": PartyPartnershipEditableAlternateAddress,
"businessNumber": UnionableEnum,
"clientClassification": UnionableEnum,
"countryOfEstablishment": "xyz789",
"email": UnionableEnum,
"fullName": "abc123",
"id": "xyz789",
"partnershipType": "REGULATED",
"reference": UnionableEnum,
"registeredOfficeAddress": PartyPartnershipEditableRegisteredOfficeAddress,
"roles": ["BENEFICIARY"],
"taxResidencies": [TaxResidency],
"workPhone": UnionableEnum
}
PartySort
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"GIVEN_NAME"
PartyTrust
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
customer - Customer!
|
|
roles - [Role!]!
|
|
clientClassification - NonIndividualClientClassification
|
|
linkedAccounts - PartyLinkedAccountConnection!
|
|
Arguments |
|
fullName - String!
|
|
reference - String
|
|
trustType - TrustSubType!
|
|
businessNumber - String
|
|
countryOfEstablishment - String!
|
|
email - String
|
|
workPhone - String
|
|
registeredOfficeAddress - Address!
|
|
alternateAddress - Address
|
|
customerId - ID!
|
|
taxResidencies - [NonIndividualTaxResidency!]!
|
|
selfCertified - SelfCertified
|
|
taxReportingType - NonIndividualTaxReportingType
|
|
noTaxResidency - Boolean
|
Whether the company has no residency for tax purposes |
giin - String
|
|
countryOfEffectiveManagement - String
|
|
controllingPersons - PartyConnection!
|
|
kycInformation - KYCInformation
|
|
shortId - String!
|
|
previousDomesticTin - String
|
|
dateOfResidencyChange - DateTime
|
|
previousSelfCertified - [SelfCertifiedHistory]
|
|
registeredSchemeNumber - String
|
|
Example
{
"id": "4",
"customer": Customer,
"roles": ["BENEFICIARY"],
"clientClassification": "COMPANY",
"linkedAccounts": PartyLinkedAccountConnection,
"fullName": "abc123",
"reference": "xyz789",
"trustType": "REGULATED_SELF_MANAGED_SUPER_FUND",
"businessNumber": "xyz789",
"countryOfEstablishment": "xyz789",
"email": "abc123",
"workPhone": "abc123",
"registeredOfficeAddress": Address,
"alternateAddress": Address,
"customerId": "4",
"taxResidencies": [NonIndividualTaxResidency],
"selfCertified": SelfCertified,
"taxReportingType": "EXEMPT_ENTITY",
"noTaxResidency": false,
"giin": "xyz789",
"countryOfEffectiveManagement": "abc123",
"controllingPersons": PartyConnection,
"kycInformation": KYCInformation,
"shortId": "abc123",
"previousDomesticTin": "abc123",
"dateOfResidencyChange": "2007-12-03T10:15:30Z",
"previousSelfCertified": [SelfCertifiedHistory],
"registeredSchemeNumber": "xyz789"
}
PartyTrustAlternateAddress
PartyTrustCreateCommand
Fields
| Field Name | Description |
|---|---|
action - String!
|
Use operation field, the operation field is an enumeration that makes it easier to query with |
approval - Approval
|
|
createdTimestamp - DateTime
|
|
customer - Customer
|
|
id - ID!
|
|
inputJson - String
|
|
invalid - [CommandError]!
|
|
operation - Action!
|
|
party - Party
|
|
state - CommandState!
|
|
step - String!
|
|
user - String!
|
Use userInfo, as this only details the sub |
userInfo - UserInfo!
|
|
userInput - PartyTrustInterface
|
Example
{
"action": "xyz789",
"approval": Approval,
"createdTimestamp": "2007-12-03T10:15:30Z",
"customer": Customer,
"id": 4,
"inputJson": "abc123",
"invalid": [CommandError],
"operation": "AGGREGATE_PAYMENT_EXECUTE",
"party": Party,
"state": "SUBMITTED",
"step": "abc123",
"user": "xyz789",
"userInfo": UserInfo,
"userInput": PartyTrustInterface
}
PartyTrustEditableAlternateAddress
PartyTrustEditableAlternateAddressUnionableEnumUnion
Types
| Union Types |
|---|
Example
PartyTrustEditableAlternateAddress
PartyTrustEditableRegisteredOfficeAddress
PartyTrustInterface
Fields
| Field Name | Description |
|---|---|
alternateAddress - PartyTrustAlternateAddress
|
|
businessNumber - String
|
|
clientClassification - PartyNonIndividualClientClassification
|
|
controllingPersons - [String]
|
|
countryOfEffectiveManagement - String
|
|
countryOfEstablishment - String
|
|
customer - Identifier
|
|
customerNode - Customer
|
|
email - String
|
|
fullName - String
|
|
giin - String
|
|
kycInformation - PartyKycInformation
|
|
noTaxResidency - Boolean
|
|
reference - String
|
|
registeredOfficeAddress - PartyTrustRegisteredOfficeAddress
|
|
roles - [Role]
|
|
selfCertified - SelfCertified
|
|
taxReportingType - PartyNonIndividualTaxReportingType
|
|
taxResidencies - [TaxResidency]
|
|
workPhone - String
|
Possible Types
| PartyTrustInterface Types |
|---|
Example
{
"alternateAddress": PartyTrustAlternateAddress,
"businessNumber": "xyz789",
"clientClassification": "CHARITABLE_TRUST",
"controllingPersons": ["xyz789"],
"countryOfEffectiveManagement": "abc123",
"countryOfEstablishment": "xyz789",
"customer": Identifier,
"customerNode": Customer,
"email": "xyz789",
"fullName": "xyz789",
"giin": "xyz789",
"kycInformation": PartyKycInformation,
"noTaxResidency": false,
"reference": "abc123",
"registeredOfficeAddress": PartyTrustRegisteredOfficeAddress,
"roles": ["BENEFICIARY"],
"selfCertified": SelfCertified,
"taxReportingType": "ACTIVE_NON_FINANCIAL_ENTITY",
"taxResidencies": [TaxResidency],
"workPhone": "abc123"
}
PartyTrustOffshoreUnregulatedDiscretionaryCreateDetails
Fields
| Field Name | Description |
|---|---|
alternateAddress - PartyTrustAlternateAddress
|
|
businessNumber - String
|
|
clientClassification - PartyNonIndividualClientClassification
|
|
controllingPersons - [String]
|
|
countryOfEffectiveManagement - String
|
|
countryOfEstablishment - String
|
|
customer - Identifier
|
|
customerNode - Customer
|
|
email - String
|
|
fullName - String
|
|
giin - String
|
|
kycInformation - PartyKycInformation
|
|
noTaxResidency - Boolean
|
|
reference - String
|
|
registeredOfficeAddress - PartyTrustRegisteredOfficeAddress
|
|
roles - [Role]
|
|
selfCertified - SelfCertified
|
|
taxReportingType - PartyNonIndividualTaxReportingType
|
|
taxResidencies - [TaxResidency]
|
|
trustType - PartyTrustOffshoreUnregulatedDiscretionaryType
|
|
workPhone - String
|
Example
{
"alternateAddress": PartyTrustAlternateAddress,
"businessNumber": "xyz789",
"clientClassification": "CHARITABLE_TRUST",
"controllingPersons": ["abc123"],
"countryOfEffectiveManagement": "xyz789",
"countryOfEstablishment": "abc123",
"customer": Identifier,
"customerNode": Customer,
"email": "abc123",
"fullName": "xyz789",
"giin": "xyz789",
"kycInformation": PartyKycInformation,
"noTaxResidency": true,
"reference": "xyz789",
"registeredOfficeAddress": PartyTrustRegisteredOfficeAddress,
"roles": ["BENEFICIARY"],
"selfCertified": SelfCertified,
"taxReportingType": "ACTIVE_NON_FINANCIAL_ENTITY",
"taxResidencies": [TaxResidency],
"trustType": "OFFSHORE_UNREGULATED_DISCRETIONARY",
"workPhone": "abc123"
}
PartyTrustOffshoreUnregulatedDiscretionaryType
Values
| Enum Value | Description |
|---|---|
|
|
Example
"OFFSHORE_UNREGULATED_DISCRETIONARY"
PartyTrustOffshoreUnregulatedFamilyCreateDetails
Fields
| Field Name | Description |
|---|---|
alternateAddress - PartyTrustAlternateAddress
|
|
businessNumber - String
|
|
clientClassification - PartyNonIndividualClientClassification
|
|
controllingPersons - [String]
|
|
countryOfEffectiveManagement - String
|
|
countryOfEstablishment - String
|
|
customer - Identifier
|
|
customerNode - Customer
|
|
email - String
|
|
fullName - String
|
|
giin - String
|
|
kycInformation - PartyKycInformation
|
|
noTaxResidency - Boolean
|
|
reference - String
|
|
registeredOfficeAddress - PartyTrustRegisteredOfficeAddress
|
|
roles - [Role]
|
|
selfCertified - SelfCertified
|
|
taxReportingType - PartyNonIndividualTaxReportingType
|
|
taxResidencies - [TaxResidency]
|
|
trustType - PartyTrustOffshoreUnregulatedFamilyType
|
|
workPhone - String
|
Example
{
"alternateAddress": PartyTrustAlternateAddress,
"businessNumber": "xyz789",
"clientClassification": "CHARITABLE_TRUST",
"controllingPersons": ["xyz789"],
"countryOfEffectiveManagement": "abc123",
"countryOfEstablishment": "abc123",
"customer": Identifier,
"customerNode": Customer,
"email": "xyz789",
"fullName": "abc123",
"giin": "xyz789",
"kycInformation": PartyKycInformation,
"noTaxResidency": true,
"reference": "abc123",
"registeredOfficeAddress": PartyTrustRegisteredOfficeAddress,
"roles": ["BENEFICIARY"],
"selfCertified": SelfCertified,
"taxReportingType": "ACTIVE_NON_FINANCIAL_ENTITY",
"taxResidencies": [TaxResidency],
"trustType": "OFFSHORE_UNREGULATED_FAMILY",
"workPhone": "xyz789"
}
PartyTrustOffshoreUnregulatedFamilyType
Values
| Enum Value | Description |
|---|---|
|
|
Example
"OFFSHORE_UNREGULATED_FAMILY"
PartyTrustOffshoreUnregulatedTestamentaryCreateDetails
Fields
| Field Name | Description |
|---|---|
alternateAddress - PartyTrustAlternateAddress
|
|
businessNumber - String
|
|
clientClassification - PartyNonIndividualClientClassification
|
|
controllingPersons - [String]
|
|
countryOfEffectiveManagement - String
|
|
countryOfEstablishment - String
|
|
customer - Identifier
|
|
customerNode - Customer
|
|
email - String
|
|
fullName - String
|
|
giin - String
|
|
kycInformation - PartyKycInformation
|
|
noTaxResidency - Boolean
|
|
reference - String
|
|
registeredOfficeAddress - PartyTrustRegisteredOfficeAddress
|
|
roles - [Role]
|
|
selfCertified - SelfCertified
|
|
taxReportingType - PartyNonIndividualTaxReportingType
|
|
taxResidencies - [TaxResidency]
|
|
trustType - PartyTrustOffshoreUnregulatedTestamentaryType
|
|
workPhone - String
|
Example
{
"alternateAddress": PartyTrustAlternateAddress,
"businessNumber": "xyz789",
"clientClassification": "CHARITABLE_TRUST",
"controllingPersons": ["xyz789"],
"countryOfEffectiveManagement": "abc123",
"countryOfEstablishment": "abc123",
"customer": Identifier,
"customerNode": Customer,
"email": "xyz789",
"fullName": "abc123",
"giin": "xyz789",
"kycInformation": PartyKycInformation,
"noTaxResidency": false,
"reference": "xyz789",
"registeredOfficeAddress": PartyTrustRegisteredOfficeAddress,
"roles": ["BENEFICIARY"],
"selfCertified": SelfCertified,
"taxReportingType": "ACTIVE_NON_FINANCIAL_ENTITY",
"taxResidencies": [TaxResidency],
"trustType": "OFFSHORE_UNREGULATED_TESTAMENTARY",
"workPhone": "xyz789"
}
PartyTrustOffshoreUnregulatedTestamentaryType
Values
| Enum Value | Description |
|---|---|
|
|
Example
"OFFSHORE_UNREGULATED_TESTAMENTARY"
PartyTrustOffshoreUnregulatedUnitCreateDetails
Fields
| Field Name | Description |
|---|---|
alternateAddress - PartyTrustAlternateAddress
|
|
businessNumber - String
|
|
clientClassification - PartyNonIndividualClientClassification
|
|
controllingPersons - [String]
|
|
countryOfEffectiveManagement - String
|
|
countryOfEstablishment - String
|
|
customer - Identifier
|
|
customerNode - Customer
|
|
email - String
|
|
fullName - String
|
|
giin - String
|
|
kycInformation - PartyKycInformation
|
|
noTaxResidency - Boolean
|
|
reference - String
|
|
registeredOfficeAddress - PartyTrustRegisteredOfficeAddress
|
|
roles - [Role]
|
|
selfCertified - SelfCertified
|
|
taxReportingType - PartyNonIndividualTaxReportingType
|
|
taxResidencies - [TaxResidency]
|
|
trustType - PartyTrustOffshoreUnregulatedUnitType
|
|
workPhone - String
|
Example
{
"alternateAddress": PartyTrustAlternateAddress,
"businessNumber": "xyz789",
"clientClassification": "CHARITABLE_TRUST",
"controllingPersons": ["xyz789"],
"countryOfEffectiveManagement": "abc123",
"countryOfEstablishment": "xyz789",
"customer": Identifier,
"customerNode": Customer,
"email": "xyz789",
"fullName": "xyz789",
"giin": "abc123",
"kycInformation": PartyKycInformation,
"noTaxResidency": false,
"reference": "xyz789",
"registeredOfficeAddress": PartyTrustRegisteredOfficeAddress,
"roles": ["BENEFICIARY"],
"selfCertified": SelfCertified,
"taxReportingType": "ACTIVE_NON_FINANCIAL_ENTITY",
"taxResidencies": [TaxResidency],
"trustType": "OFFSHORE_UNREGULATED_UNIT",
"workPhone": "xyz789"
}
PartyTrustOffshoreUnregulatedUnitType
Values
| Enum Value | Description |
|---|---|
|
|
Example
"OFFSHORE_UNREGULATED_UNIT"
PartyTrustRegisteredOfficeAddress
PartyTrustRegulatedGovernmentSuperFundCreateDetails
Fields
| Field Name | Description |
|---|---|
alternateAddress - PartyTrustAlternateAddress
|
|
businessNumber - String
|
|
clientClassification - PartyNonIndividualClientClassification
|
|
controllingPersons - [String]
|
|
countryOfEffectiveManagement - String
|
|
countryOfEstablishment - String
|
|
customer - Identifier
|
|
customerNode - Customer
|
|
email - String
|
|
fullName - String
|
|
giin - String
|
|
kycInformation - PartyKycInformation
|
|
noTaxResidency - Boolean
|
|
reference - String
|
|
registeredOfficeAddress - PartyTrustRegisteredOfficeAddress
|
|
roles - [Role]
|
|
selfCertified - SelfCertified
|
|
taxReportingType - PartyNonIndividualTaxReportingType
|
|
taxResidencies - [TaxResidency]
|
|
trustType - PartyTrustRegulatedGovernmentSuperFundType
|
|
workPhone - String
|
Example
{
"alternateAddress": PartyTrustAlternateAddress,
"businessNumber": "abc123",
"clientClassification": "CHARITABLE_TRUST",
"controllingPersons": ["xyz789"],
"countryOfEffectiveManagement": "abc123",
"countryOfEstablishment": "abc123",
"customer": Identifier,
"customerNode": Customer,
"email": "xyz789",
"fullName": "xyz789",
"giin": "abc123",
"kycInformation": PartyKycInformation,
"noTaxResidency": true,
"reference": "xyz789",
"registeredOfficeAddress": PartyTrustRegisteredOfficeAddress,
"roles": ["BENEFICIARY"],
"selfCertified": SelfCertified,
"taxReportingType": "ACTIVE_NON_FINANCIAL_ENTITY",
"taxResidencies": [TaxResidency],
"trustType": "REGULATED_GOVERNMENT_SUPER_FUND",
"workPhone": "abc123"
}
PartyTrustRegulatedGovernmentSuperFundType
Values
| Enum Value | Description |
|---|---|
|
|
Example
"REGULATED_GOVERNMENT_SUPER_FUND"
PartyTrustRegulatedMisExternallyManagedCreateDetails
Fields
| Field Name | Description |
|---|---|
alternateAddress - PartyTrustAlternateAddress
|
|
businessNumber - String
|
|
clientClassification - PartyNonIndividualClientClassification
|
|
controllingPersons - [String]
|
|
countryOfEffectiveManagement - String
|
|
countryOfEstablishment - String
|
|
customer - Identifier
|
|
customerNode - Customer
|
|
email - String
|
|
fullName - String
|
|
giin - String
|
|
kycInformation - PartyKycInformation
|
|
noTaxResidency - Boolean
|
|
reference - String
|
|
registeredOfficeAddress - PartyTrustRegisteredOfficeAddress
|
|
registeredSchemeNumber - String
|
|
roles - [Role]
|
|
selfCertified - SelfCertified
|
|
taxReportingType - PartyNonIndividualTaxReportingType
|
|
taxResidencies - [TaxResidency]
|
|
trustType - PartyTrustRegulatedMisExternallyManagedType
|
|
workPhone - String
|
Example
{
"alternateAddress": PartyTrustAlternateAddress,
"businessNumber": "abc123",
"clientClassification": "CHARITABLE_TRUST",
"controllingPersons": ["abc123"],
"countryOfEffectiveManagement": "abc123",
"countryOfEstablishment": "abc123",
"customer": Identifier,
"customerNode": Customer,
"email": "abc123",
"fullName": "abc123",
"giin": "xyz789",
"kycInformation": PartyKycInformation,
"noTaxResidency": false,
"reference": "xyz789",
"registeredOfficeAddress": PartyTrustRegisteredOfficeAddress,
"registeredSchemeNumber": "abc123",
"roles": ["BENEFICIARY"],
"selfCertified": SelfCertified,
"taxReportingType": "ACTIVE_NON_FINANCIAL_ENTITY",
"taxResidencies": [TaxResidency],
"trustType": "REGULATED_MIS_EXTERNALLY_MANAGED",
"workPhone": "abc123"
}
PartyTrustRegulatedMisExternallyManagedType
Values
| Enum Value | Description |
|---|---|
|
|
Example
"REGULATED_MIS_EXTERNALLY_MANAGED"
PartyTrustRegulatedMisInternallyManagedCreateDetails
Fields
| Field Name | Description |
|---|---|
alternateAddress - PartyTrustAlternateAddress
|
|
businessNumber - String
|
|
clientClassification - PartyNonIndividualClientClassification
|
|
controllingPersons - [String]
|
|
countryOfEffectiveManagement - String
|
|
countryOfEstablishment - String
|
|
customer - Identifier
|
|
customerNode - Customer
|
|
email - String
|
|
fullName - String
|
|
giin - String
|
|
kycInformation - PartyKycInformation
|
|
noTaxResidency - Boolean
|
|
reference - String
|
|
registeredOfficeAddress - PartyTrustRegisteredOfficeAddress
|
|
registeredSchemeNumber - String
|
|
roles - [Role]
|
|
selfCertified - SelfCertified
|
|
taxReportingType - PartyNonIndividualTaxReportingType
|
|
taxResidencies - [TaxResidency]
|
|
trustType - PartyTrustRegulatedMisInternallyManagedType
|
|
workPhone - String
|
Example
{
"alternateAddress": PartyTrustAlternateAddress,
"businessNumber": "abc123",
"clientClassification": "CHARITABLE_TRUST",
"controllingPersons": ["xyz789"],
"countryOfEffectiveManagement": "xyz789",
"countryOfEstablishment": "abc123",
"customer": Identifier,
"customerNode": Customer,
"email": "abc123",
"fullName": "abc123",
"giin": "abc123",
"kycInformation": PartyKycInformation,
"noTaxResidency": true,
"reference": "xyz789",
"registeredOfficeAddress": PartyTrustRegisteredOfficeAddress,
"registeredSchemeNumber": "xyz789",
"roles": ["BENEFICIARY"],
"selfCertified": SelfCertified,
"taxReportingType": "ACTIVE_NON_FINANCIAL_ENTITY",
"taxResidencies": [TaxResidency],
"trustType": "REGULATED_MIS_INTERNALLY_MANAGED",
"workPhone": "abc123"
}
PartyTrustRegulatedMisInternallyManagedType
Values
| Enum Value | Description |
|---|---|
|
|
Example
"REGULATED_MIS_INTERNALLY_MANAGED"
PartyTrustRegulatedSelfManagedSuperFundCreateDetails
Fields
| Field Name | Description |
|---|---|
alternateAddress - PartyTrustAlternateAddress
|
|
businessNumber - String
|
|
clientClassification - PartyNonIndividualClientClassification
|
|
controllingPersons - [String]
|
|
countryOfEffectiveManagement - String
|
|
countryOfEstablishment - String
|
|
customer - Identifier
|
|
customerNode - Customer
|
|
email - String
|
|
fullName - String
|
|
giin - String
|
|
kycInformation - PartyKycInformation
|
|
noTaxResidency - Boolean
|
|
reference - String
|
|
registeredOfficeAddress - PartyTrustRegisteredOfficeAddress
|
|
roles - [Role]
|
|
selfCertified - SelfCertified
|
|
taxReportingType - PartyNonIndividualTaxReportingType
|
|
taxResidencies - [TaxResidency]
|
|
trustType - PartyTrustRegulatedSelfManagedSuperFundType
|
|
workPhone - String
|
Example
{
"alternateAddress": PartyTrustAlternateAddress,
"businessNumber": "abc123",
"clientClassification": "CHARITABLE_TRUST",
"controllingPersons": ["abc123"],
"countryOfEffectiveManagement": "abc123",
"countryOfEstablishment": "xyz789",
"customer": Identifier,
"customerNode": Customer,
"email": "xyz789",
"fullName": "abc123",
"giin": "xyz789",
"kycInformation": PartyKycInformation,
"noTaxResidency": false,
"reference": "xyz789",
"registeredOfficeAddress": PartyTrustRegisteredOfficeAddress,
"roles": ["BENEFICIARY"],
"selfCertified": SelfCertified,
"taxReportingType": "ACTIVE_NON_FINANCIAL_ENTITY",
"taxResidencies": [TaxResidency],
"trustType": "REGULATED_SELF_MANAGED_SUPER_FUND",
"workPhone": "abc123"
}
PartyTrustRegulatedSelfManagedSuperFundType
Values
| Enum Value | Description |
|---|---|
|
|
Example
"REGULATED_SELF_MANAGED_SUPER_FUND"
PartyTrustType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"OFFSHORE_UNREGULATED_DISCRETIONARY"
PartyTrustUnregulatedDomesticDiscretionaryCreateDetails
Fields
| Field Name | Description |
|---|---|
alternateAddress - PartyTrustAlternateAddress
|
|
businessNumber - String
|
|
clientClassification - PartyNonIndividualClientClassification
|
|
controllingPersons - [String]
|
|
countryOfEffectiveManagement - String
|
|
countryOfEstablishment - String
|
|
customer - Identifier
|
|
customerNode - Customer
|
|
email - String
|
|
fullName - String
|
|
giin - String
|
|
kycInformation - PartyKycInformation
|
|
noTaxResidency - Boolean
|
|
reference - String
|
|
registeredOfficeAddress - PartyTrustRegisteredOfficeAddress
|
|
roles - [Role]
|
|
selfCertified - SelfCertified
|
|
taxReportingType - PartyNonIndividualTaxReportingType
|
|
taxResidencies - [TaxResidency]
|
|
trustType - PartyTrustUnregulatedDomesticDiscretionaryType
|
|
workPhone - String
|
Example
{
"alternateAddress": PartyTrustAlternateAddress,
"businessNumber": "abc123",
"clientClassification": "CHARITABLE_TRUST",
"controllingPersons": ["xyz789"],
"countryOfEffectiveManagement": "xyz789",
"countryOfEstablishment": "abc123",
"customer": Identifier,
"customerNode": Customer,
"email": "abc123",
"fullName": "xyz789",
"giin": "xyz789",
"kycInformation": PartyKycInformation,
"noTaxResidency": true,
"reference": "xyz789",
"registeredOfficeAddress": PartyTrustRegisteredOfficeAddress,
"roles": ["BENEFICIARY"],
"selfCertified": SelfCertified,
"taxReportingType": "ACTIVE_NON_FINANCIAL_ENTITY",
"taxResidencies": [TaxResidency],
"trustType": "UNREGULATED_DOMESTIC_DISCRETIONARY",
"workPhone": "abc123"
}
PartyTrustUnregulatedDomesticDiscretionaryType
Values
| Enum Value | Description |
|---|---|
|
|
Example
"UNREGULATED_DOMESTIC_DISCRETIONARY"
PartyTrustUnregulatedDomesticFamilyCreateDetails
Fields
| Field Name | Description |
|---|---|
alternateAddress - PartyTrustAlternateAddress
|
|
businessNumber - String
|
|
clientClassification - PartyNonIndividualClientClassification
|
|
controllingPersons - [String]
|
|
countryOfEffectiveManagement - String
|
|
countryOfEstablishment - String
|
|
customer - Identifier
|
|
customerNode - Customer
|
|
email - String
|
|
fullName - String
|
|
giin - String
|
|
kycInformation - PartyKycInformation
|
|
noTaxResidency - Boolean
|
|
reference - String
|
|
registeredOfficeAddress - PartyTrustRegisteredOfficeAddress
|
|
roles - [Role]
|
|
selfCertified - SelfCertified
|
|
taxReportingType - PartyNonIndividualTaxReportingType
|
|
taxResidencies - [TaxResidency]
|
|
trustType - PartyTrustUnregulatedDomesticFamilyType
|
|
workPhone - String
|
Example
{
"alternateAddress": PartyTrustAlternateAddress,
"businessNumber": "xyz789",
"clientClassification": "CHARITABLE_TRUST",
"controllingPersons": ["abc123"],
"countryOfEffectiveManagement": "xyz789",
"countryOfEstablishment": "abc123",
"customer": Identifier,
"customerNode": Customer,
"email": "xyz789",
"fullName": "xyz789",
"giin": "xyz789",
"kycInformation": PartyKycInformation,
"noTaxResidency": false,
"reference": "xyz789",
"registeredOfficeAddress": PartyTrustRegisteredOfficeAddress,
"roles": ["BENEFICIARY"],
"selfCertified": SelfCertified,
"taxReportingType": "ACTIVE_NON_FINANCIAL_ENTITY",
"taxResidencies": [TaxResidency],
"trustType": "UNREGULATED_DOMESTIC_FAMILY",
"workPhone": "xyz789"
}
PartyTrustUnregulatedDomesticFamilyType
Values
| Enum Value | Description |
|---|---|
|
|
Example
"UNREGULATED_DOMESTIC_FAMILY"
PartyTrustUnregulatedDomesticTestamentaryCreateDetails
Fields
| Field Name | Description |
|---|---|
alternateAddress - PartyTrustAlternateAddress
|
|
businessNumber - String
|
|
clientClassification - PartyNonIndividualClientClassification
|
|
controllingPersons - [String]
|
|
countryOfEffectiveManagement - String
|
|
countryOfEstablishment - String
|
|
customer - Identifier
|
|
customerNode - Customer
|
|
email - String
|
|
fullName - String
|
|
giin - String
|
|
kycInformation - PartyKycInformation
|
|
noTaxResidency - Boolean
|
|
reference - String
|
|
registeredOfficeAddress - PartyTrustRegisteredOfficeAddress
|
|
roles - [Role]
|
|
selfCertified - SelfCertified
|
|
taxReportingType - PartyNonIndividualTaxReportingType
|
|
taxResidencies - [TaxResidency]
|
|
trustType - PartyTrustUnregulatedDomesticTestamentaryType
|
|
workPhone - String
|
Example
{
"alternateAddress": PartyTrustAlternateAddress,
"businessNumber": "abc123",
"clientClassification": "CHARITABLE_TRUST",
"controllingPersons": ["abc123"],
"countryOfEffectiveManagement": "abc123",
"countryOfEstablishment": "abc123",
"customer": Identifier,
"customerNode": Customer,
"email": "abc123",
"fullName": "xyz789",
"giin": "xyz789",
"kycInformation": PartyKycInformation,
"noTaxResidency": false,
"reference": "abc123",
"registeredOfficeAddress": PartyTrustRegisteredOfficeAddress,
"roles": ["BENEFICIARY"],
"selfCertified": SelfCertified,
"taxReportingType": "ACTIVE_NON_FINANCIAL_ENTITY",
"taxResidencies": [TaxResidency],
"trustType": "UNREGULATED_DOMESTIC_TESTAMENTARY",
"workPhone": "xyz789"
}
PartyTrustUnregulatedDomesticTestamentaryType
Values
| Enum Value | Description |
|---|---|
|
|
Example
"UNREGULATED_DOMESTIC_TESTAMENTARY"
PartyTrustUnregulatedDomesticUnitCreateDetails
Fields
| Field Name | Description |
|---|---|
alternateAddress - PartyTrustAlternateAddress
|
|
businessNumber - String
|
|
clientClassification - PartyNonIndividualClientClassification
|
|
controllingPersons - [String]
|
|
countryOfEffectiveManagement - String
|
|
countryOfEstablishment - String
|
|
customer - Identifier
|
|
customerNode - Customer
|
|
email - String
|
|
fullName - String
|
|
giin - String
|
|
kycInformation - PartyKycInformation
|
|
noTaxResidency - Boolean
|
|
reference - String
|
|
registeredOfficeAddress - PartyTrustRegisteredOfficeAddress
|
|
roles - [Role]
|
|
selfCertified - SelfCertified
|
|
taxReportingType - PartyNonIndividualTaxReportingType
|
|
taxResidencies - [TaxResidency]
|
|
trustType - PartyTrustUnregulatedDomesticUnitType
|
|
workPhone - String
|
Example
{
"alternateAddress": PartyTrustAlternateAddress,
"businessNumber": "abc123",
"clientClassification": "CHARITABLE_TRUST",
"controllingPersons": ["abc123"],
"countryOfEffectiveManagement": "abc123",
"countryOfEstablishment": "abc123",
"customer": Identifier,
"customerNode": Customer,
"email": "abc123",
"fullName": "abc123",
"giin": "abc123",
"kycInformation": PartyKycInformation,
"noTaxResidency": false,
"reference": "abc123",
"registeredOfficeAddress": PartyTrustRegisteredOfficeAddress,
"roles": ["BENEFICIARY"],
"selfCertified": SelfCertified,
"taxReportingType": "ACTIVE_NON_FINANCIAL_ENTITY",
"taxResidencies": [TaxResidency],
"trustType": "UNREGULATED_DOMESTIC_UNIT",
"workPhone": "xyz789"
}
PartyTrustUnregulatedDomesticUnitType
Values
| Enum Value | Description |
|---|---|
|
|
Example
"UNREGULATED_DOMESTIC_UNIT"
PartyTrustUpdateCommand
Fields
| Field Name | Description |
|---|---|
action - String!
|
Use operation field, the operation field is an enumeration that makes it easier to query with |
approval - Approval
|
|
createdTimestamp - DateTime
|
|
id - ID!
|
|
inputJson - String
|
|
invalid - [CommandError]!
|
|
operation - Action!
|
|
party - Party
|
|
state - CommandState!
|
|
step - String!
|
|
user - String!
|
Use userInfo, as this only details the sub |
userInfo - UserInfo!
|
|
userInput - PartyTrustUpdateDetails
|
Example
{
"action": "xyz789",
"approval": Approval,
"createdTimestamp": "2007-12-03T10:15:30Z",
"id": 4,
"inputJson": "xyz789",
"invalid": [CommandError],
"operation": "AGGREGATE_PAYMENT_EXECUTE",
"party": Party,
"state": "SUBMITTED",
"step": "xyz789",
"user": "xyz789",
"userInfo": UserInfo,
"userInput": PartyTrustUpdateDetails
}
PartyTrustUpdateDetails
Fields
| Field Name | Description |
|---|---|
alternateAddress - PartyTrustEditableAlternateAddressUnionableEnumUnion
|
|
businessNumber - UnionableEnumUnionableStringUnion
|
|
clientClassification - UnionableEnum
|
|
controllingPersons - UnionableEnum
|
|
countryOfEffectiveManagement - UnionableEnumUnionableStringUnion
|
|
countryOfEstablishment - String
|
|
email - UnionableEnumUnionableStringUnion
|
|
fullName - String
|
|
giin - UnionableEnumUnionableStringUnion
|
|
id - String
|
|
noTaxResidency - Boolean
|
|
reference - UnionableEnumUnionableStringUnion
|
|
registeredOfficeAddress - PartyTrustEditableRegisteredOfficeAddress
|
|
registeredSchemeNumber - UnionableEnumUnionableStringUnion
|
|
roles - [Role]
|
|
selfCertified - SelfCertified
|
|
taxReportingType - UnionableEnum
|
|
taxResidencies - [TaxResidency]
|
|
trustType - PartyTrustType
|
|
workPhone - UnionableEnumUnionableStringUnion
|
Example
{
"alternateAddress": PartyTrustEditableAlternateAddress,
"businessNumber": UnionableEnum,
"clientClassification": UnionableEnum,
"controllingPersons": UnionableEnum,
"countryOfEffectiveManagement": UnionableEnum,
"countryOfEstablishment": "abc123",
"email": UnionableEnum,
"fullName": "abc123",
"giin": UnionableEnum,
"id": "abc123",
"noTaxResidency": false,
"reference": UnionableEnum,
"registeredOfficeAddress": PartyTrustEditableRegisteredOfficeAddress,
"registeredSchemeNumber": UnionableEnum,
"roles": ["BENEFICIARY"],
"selfCertified": SelfCertified,
"taxReportingType": UnionableEnum,
"taxResidencies": [TaxResidency],
"trustType": "OFFSHORE_UNREGULATED_DISCRETIONARY",
"workPhone": UnionableEnum
}
PartyType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"INDIVIDUAL"
Payment
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
createdTimestamp - DateTime!
|
|
amount - Amount!
|
|
remainingUnallocated - Amount
|
|
allocationState - AllocationState!
|
|
allocation - Allocation
|
|
unallocatable - Boolean!
|
|
unallocatedReason - String
|
|
unallocatedReasonCode - UnallocatedReasonCode
|
|
transactions - TransactionConnection!
|
|
valueDate - Date!
|
Value date applied to the payment. |
recipient - Recipient
|
|
paymentMethod - String
|
|
reference - String
|
|
customerTransactionReference - String
|
|
purpose - DEPurpose
|
|
narrative - String
|
|
status - String
|
|
reason - String
|
|
entryReference - String
|
|
accountServicerReference - String
|
|
domain - String
|
|
family - String
|
|
subFamily - String
|
|
proprietary - String
|
|
split - AllocatableSplitConnection!
|
|
Arguments
|
|
bookingDate - Date
|
|
customerLinkedAccount - CustomerLinkedAccount
|
|
pool - Pool!
|
|
accountAllocatedTo - Account
|
|
deleteMessage - String
|
Deprecated. Moved to movementHistory |
restoreMessage - String
|
Deprecated. Moved to movementHistory |
deleteRequestUserName - String
|
Deprecated. Moved to movementHistory |
deleteRequestUserId - String
|
Deprecated. Moved to movementHistory |
deleteRequestTimestamp - String
|
Deprecated. Moved to movementHistory |
deleteApprovalUserName - String
|
Deprecated. Moved to movementHistory |
deleteApprovalUserId - String
|
Deprecated. Moved to movementHistory |
deleteApprovalTimestamp - String
|
Deprecated. Moved to movementHistory |
restoreRequestUserName - String
|
Deprecated. Moved to movementHistory |
restoreRequestUserId - String
|
Deprecated. Moved to movementHistory |
restoreRequestTimestamp - String
|
Deprecated. Moved to movementHistory |
restoreApprovalUserName - String
|
Deprecated. Moved to movementHistory |
restoreApprovalUserId - String
|
Deprecated. Moved to movementHistory |
restoreApprovalTimestamp - String
|
Deprecated. Moved to movementHistory |
history - [AllocatableHistoryItem!]
|
Shows the movement activity for this Allocatable |
camtReceived - Boolean!
|
|
instructions - [Instruction!]
|
|
hold - Boolean!
|
|
holdHistory - [HoldHistoryItem!]
|
|
reversal - Boolean!
|
|
directDebit - Boolean!
|
|
businessProcess - BusinessProcess!
|
|
movementToCLA - MovementToCLAPaymentRequest
|
|
reSubmittable - Boolean!
|
Re-submittable means you can initiate a new acknowledgable flow (submit a new pain 001). This keeps the transactions open until the payment has a successful acknowledgable flow. |
aggregatePayment - AggregatePayment
|
|
Example
{
"id": "4",
"createdTimestamp": "2007-12-03T10:15:30Z",
"amount": Amount,
"remainingUnallocated": Amount,
"allocationState": "PENDING",
"allocation": Allocation,
"unallocatable": true,
"unallocatedReason": "xyz789",
"unallocatedReasonCode": "MULTIPLE_DESTINATIONS",
"transactions": TransactionConnection,
"valueDate": "2007-12-03",
"recipient": Recipient,
"paymentMethod": "abc123",
"reference": "xyz789",
"customerTransactionReference": "xyz789",
"purpose": "CASH",
"narrative": "xyz789",
"status": "xyz789",
"reason": "xyz789",
"entryReference": "xyz789",
"accountServicerReference": "abc123",
"domain": "xyz789",
"family": "xyz789",
"subFamily": "abc123",
"proprietary": "xyz789",
"split": AllocatableSplitConnection,
"bookingDate": "2007-12-03",
"customerLinkedAccount": CustomerLinkedAccount,
"pool": Pool,
"accountAllocatedTo": Account,
"deleteMessage": "abc123",
"restoreMessage": "xyz789",
"deleteRequestUserName": "xyz789",
"deleteRequestUserId": "xyz789",
"deleteRequestTimestamp": "abc123",
"deleteApprovalUserName": "abc123",
"deleteApprovalUserId": "abc123",
"deleteApprovalTimestamp": "xyz789",
"restoreRequestUserName": "abc123",
"restoreRequestUserId": "xyz789",
"restoreRequestTimestamp": "abc123",
"restoreApprovalUserName": "abc123",
"restoreApprovalUserId": "xyz789",
"restoreApprovalTimestamp": "xyz789",
"history": [AllocatableHistoryItem],
"camtReceived": true,
"instructions": [Instruction],
"hold": true,
"holdHistory": [HoldHistoryItem],
"reversal": false,
"directDebit": true,
"businessProcess": BusinessProcess,
"movementToCLA": MovementToCLAPaymentRequest,
"reSubmittable": false,
"aggregatePayment": AggregatePayment
}
PaymentAdded
Fields
| Field Name | Description |
|---|---|
payment - Payment!
|
Example
{"payment": Payment}
PaymentAmountInput
Description
Amount of a payment request.
Fields
| Input Field | Description |
|---|---|
value - AmountValue!
|
The numeric value of the payment. |
currency - CurrencyCode!
|
The currency of the payment. |
Example
{
"value": AmountValue,
"currency": CurrencyCode
}
PaymentConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [PaymentEdge]
|
|
aggregates - SimpleConnectionAggregate!
|
Example
{
"pageInfo": PageInfo,
"edges": [PaymentEdge],
"aggregates": SimpleConnectionAggregate
}
PaymentEdge
PaymentFeatureConfig
PaymentFilter
Fields
| Input Field | Description |
|---|---|
allocationState - AllocationState
|
|
statusContains - String
|
|
statusExact - String
|
|
narrativeContains - String
|
|
narrativeExact - String
|
|
camtReceived - Boolean
|
|
customerLinkedAccountPayment - Boolean
|
|
customerLinkedAccountId - ID
|
|
reSubmittable - Boolean
|
|
amount - AmountFilter
|
Example
{
"allocationState": "PENDING",
"statusContains": "abc123",
"statusExact": "xyz789",
"narrativeContains": "abc123",
"narrativeExact": "xyz789",
"camtReceived": false,
"customerLinkedAccountPayment": true,
"customerLinkedAccountId": 4,
"reSubmittable": false,
"amount": AmountFilter
}
PaymentOrPaymentRequest
Types
| Union Types |
|---|
Example
Payment
PaymentRemoved
Fields
| Field Name | Description |
|---|---|
payment - Payment!
|
Example
{"payment": Payment}
PaymentRequest
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
createdTimestamp - DateTime!
|
|
transactions - TransactionConnection!
|
|
requesterAccount - Account
|
|
requesterCustomer - Customer
|
|
requesterSource - Source
|
|
requesterName - String
|
|
customerLinkedAccount - CustomerLinkedAccount
|
|
pool - Pool!
|
|
source - Source!
|
|
amount - Amount!
|
|
valueDate - Date!
|
|
paymentMethod - String!
|
|
reference - String
|
|
customerTransactionReference - String
|
|
status - PaymentRequestStatus!
|
|
reason - String
|
|
instructions - [Instruction!]
|
|
debtor - PaymentRequestDebtor!
|
|
reSubmittable - Boolean!
|
Re-submittable means you can initiate a new acknowledgable flow (submit a new pain 001). This keeps the transactions open until the payment has a successful acknowledgable flow. |
aggregatePayment - AggregatePayment
|
Example
{
"id": "4",
"createdTimestamp": "2007-12-03T10:15:30Z",
"transactions": TransactionConnection,
"requesterAccount": Account,
"requesterCustomer": Customer,
"requesterSource": Source,
"requesterName": "xyz789",
"customerLinkedAccount": CustomerLinkedAccount,
"pool": Pool,
"source": Source,
"amount": Amount,
"valueDate": "2007-12-03",
"paymentMethod": "xyz789",
"reference": "abc123",
"customerTransactionReference": "abc123",
"status": "SUBMITTED",
"reason": "abc123",
"instructions": [Instruction],
"debtor": PaymentRequestDebtor,
"reSubmittable": true,
"aggregatePayment": AggregatePayment
}
PaymentRequestAcknowledgeMessage
Example
{
"id": 4,
"painId": "abc123",
"status": "xyz789",
"statusCode": "xyz789",
"reason": "abc123",
"paymentId": "xyz789",
"messageId": "xyz789",
"instructionId": "xyz789",
"endToEndId": "abc123",
"requestedExecutionDate": "2007-12-03",
"failureReasons": ["abc123"],
"businessProcess": BusinessProcess
}
PaymentRequestCommand
Fields
| Field Name | Description |
|---|---|
action - String!
|
Use operation field, the operation field is an enumeration that makes it easier to query with |
approval - Approval
|
|
createdTimestamp - DateTime
|
|
id - ID!
|
|
inputJson - String
|
|
invalid - [CommandError]!
|
|
operation - Action!
|
|
paymentRequest - PaymentRequest
|
|
state - CommandState!
|
|
step - String!
|
|
user - String!
|
Use userInfo, as this only details the sub |
userInfo - UserInfo!
|
|
userInput - MakePaymentRequestDetails
|
Example
{
"action": "xyz789",
"approval": Approval,
"createdTimestamp": "2007-12-03T10:15:30Z",
"id": 4,
"inputJson": "xyz789",
"invalid": [CommandError],
"operation": "AGGREGATE_PAYMENT_EXECUTE",
"paymentRequest": PaymentRequest,
"state": "SUBMITTED",
"step": "xyz789",
"user": "xyz789",
"userInfo": UserInfo,
"userInput": MakePaymentRequestDetails
}
PaymentRequestConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [PaymentRequestEdge]
|
|
aggregates - SimpleConnectionAggregate!
|
Example
{
"pageInfo": PageInfo,
"edges": [PaymentRequestEdge],
"aggregates": SimpleConnectionAggregate
}
PaymentRequestDebtor
Fields
| Field Name | Description |
|---|---|
name - String!
|
|
accountNumber - AccountNumber!
|
|
bankCode - BankCode!
|
Example
{
"name": "xyz789",
"accountNumber": "000000012345",
"bankCode": BankCode
}
PaymentRequestEdge
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
|
node - PaymentRequest
|
Example
{
"cursor": "xyz789",
"node": PaymentRequest
}
PaymentRequestFilter
Example
{
"amount": AmountFilter,
"referenceContains": "abc123",
"referenceExact": "xyz789",
"reSubmittable": false,
"statusContains": "abc123",
"statusExact": "xyz789"
}
PaymentRequestMethod
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"DE"
PaymentRequestStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"SUBMITTED"
PaymentRequestTransactionBusinessProcessIdentifier
Fields
| Field Name | Description |
|---|---|
id - String
|
|
kind - PaymentRequestTransactionBusinessProcessType
|
Example
{
"id": "xyz789",
"kind": "MANUAL_INTEREST_ADJUSTMENT"
}
PaymentRequestTransactionBusinessProcessType
Values
| Enum Value | Description |
|---|---|
|
|
Example
"MANUAL_INTEREST_ADJUSTMENT"
PaymentState
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"SUBMITTED"
PaymentTransactionBusinessProcessIdentifier
Fields
| Field Name | Description |
|---|---|
id - String
|
|
kind - PaymentTransactionBusinessProcessType
|
Example
{
"id": "xyz789",
"kind": "MANUAL_INTEREST_ADJUSTMENT"
}
PaymentTransactionBusinessProcessType
Values
| Enum Value | Description |
|---|---|
|
|
Example
"MANUAL_INTEREST_ADJUSTMENT"
PaymentUpdated
Fields
| Field Name | Description |
|---|---|
payment - Payment!
|
Example
{"payment": Payment}
PendingTransaction
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
state - TransactionState!
|
|
transactionType - String!
|
|
valueDate - Date!
|
|
currency - CurrencyCode!
|
|
entries - TransactionEntryConnection!
|
|
businessProcess - BusinessProcess
|
|
initiatedTimestamp - DateTime!
|
|
splitElement - SplitElement
|
|
Example
{
"id": 4,
"state": "PENDING",
"transactionType": "abc123",
"valueDate": "2007-12-03",
"currency": CurrencyCode,
"entries": TransactionEntryConnection,
"businessProcess": BusinessProcess,
"initiatedTimestamp": "2007-12-03T10:15:30Z",
"splitElement": SplitElement
}
PendingTransactionEntry
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
transactionType - String!
|
|
transaction - Transaction!
|
|
account - Account!
|
|
businessProcess - BusinessProcess
|
|
balance - Amount
|
|
instruction - AggregateInstruction
|
|
state - TransactionState!
|
|
initiatedTimestamp - DateTime!
|
|
value - AmountValue!
|
|
currency - CurrencyCode!
|
|
creditDebit - CreditDebit!
|
|
unallocatable - Boolean!
|
Example
{
"id": "4",
"transactionType": "xyz789",
"transaction": Transaction,
"account": Account,
"businessProcess": BusinessProcess,
"balance": Amount,
"instruction": AggregateInstruction,
"state": "PENDING",
"initiatedTimestamp": "2007-12-03T10:15:30Z",
"value": AmountValue,
"currency": CurrencyCode,
"creditDebit": "CREDIT",
"unallocatable": true
}
PeriodType
Values
| Enum Value | Description |
|---|---|
|
|
Example
"DAY_OF_MONTH"
Pool
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique id of the pool. |
sourceType - SourceType!
|
Does the pool operate over bank or customer source accounts. |
accounts - AccountConnection!
|
Client accounts held within the pool. |
Arguments
|
|
name - String!
|
The name of the pool. |
unallocated - AllocatableConnection!
|
Unallocated transactions over source accounts within the pool. |
Arguments
|
|
matchedReversals - MatchedReversalConnection!
|
Matched reversals composed of a reversal and an unallocated payment or receipt. |
Arguments |
|
movedToCLA - AllocatableConnection!
|
Previously unallocated payments/receipts that have been moved to a customer linked account. |
Arguments
|
|
deleted - AllocatableConnection!
|
Deleted payments/receipts |
Arguments
|
|
Possible Types
| Pool Types |
|---|
Example
{
"id": "4",
"sourceType": "BANK",
"accounts": AccountConnection,
"name": "xyz789",
"unallocated": AllocatableConnection,
"matchedReversals": MatchedReversalConnection,
"movedToCLA": AllocatableConnection,
"deleted": AllocatableConnection
}
PoolAggregate
PoolConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [PoolEdge]
|
|
aggregates - PoolAggregate!
|
Example
{
"pageInfo": PageInfo,
"edges": [PoolEdge],
"aggregates": PoolAggregate
}
PoolCreated
Fields
| Field Name | Description |
|---|---|
pool - Pool!
|
Example
{"pool": Pool}
PoolEdge
PoolFeatureConfig
PoolFeatureConfigInput
Fields
| Input Field | Description |
|---|---|
poolId - ID!
|
Example
{"poolId": 4}
PoolFilter
Fields
| Input Field | Description |
|---|---|
sourceType - SourceType
|
|
nameExact - String
|
|
nameContains - String
|
Example
{
"sourceType": "BANK",
"nameExact": "xyz789",
"nameContains": "xyz789"
}
PostcodeAddress
PostcodeAddressFilter
Example
{
"stateExact": "xyz789",
"stateContains": "abc123",
"cityExact": "abc123",
"cityContains": "abc123",
"postcodeExact": "xyz789",
"postcodeContains": "xyz789"
}
PreventNegativeBalanceFeatureConfig
Product
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
parent - Product
|
|
name - String!
|
|
description - String
|
|
code - String
|
|
codeSuffix - String
|
|
billingId - String
|
|
currencies - [String!]
|
|
governmentGuaranteeApplies - Boolean
|
|
costCentre - String
|
|
rmSet - String
|
|
retailLookThrough - RetailLookThrough
|
|
activeFeatures - [FeatureConfig!]!
|
|
availableFeatures - [FeatureConfig!]!
|
|
accounts - AccountConnection!
|
|
Arguments
|
|
grantedToCustomers - CustomerConnection!
|
|
Arguments
|
|
state - ProductState!
|
|
Possible Types
| Product Types |
|---|
Example
{
"id": 4,
"parent": Product,
"name": "abc123",
"description": "abc123",
"code": "xyz789",
"codeSuffix": "abc123",
"billingId": "abc123",
"currencies": ["xyz789"],
"governmentGuaranteeApplies": true,
"costCentre": "abc123",
"rmSet": "xyz789",
"retailLookThrough": RetailLookThrough,
"activeFeatures": [FeatureConfig],
"availableFeatures": [FeatureConfig],
"accounts": AccountConnection,
"grantedToCustomers": CustomerConnection,
"state": "TEMPLATE"
}
ProductAccrual
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
type - AccrualType!
|
|
valueDate - Date!
|
|
currency - CurrencyCode!
|
|
amounts - InterestAmounts!
|
|
customer - Customer!
|
|
product - Product!
|
|
pool - Pool!
|
|
source - Source!
|
|
endDate - Date!
|
|
realisation - Interest
|
|
destination - DestinationAccount!
|
|
batch - AccrualProductBatchDetails!
|
|
accountAccruals - AccountAccrualConnection!
|
Example
{
"id": "4",
"type": "SCHEDULED",
"valueDate": "2007-12-03",
"currency": CurrencyCode,
"amounts": InterestAmounts,
"customer": Customer,
"product": Product,
"pool": Pool,
"source": Source,
"endDate": "2007-12-03",
"realisation": Interest,
"destination": DestinationAccount,
"batch": AccrualProductBatchDetails,
"accountAccruals": AccountAccrualConnection
}
ProductConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [ProductEdge]
|
|
aggregates - SimpleConnectionAggregate!
|
Example
{
"pageInfo": PageInfo,
"edges": [ProductEdge],
"aggregates": SimpleConnectionAggregate
}
ProductCreated
Fields
| Field Name | Description |
|---|---|
product - Product!
|
Example
{"product": Product}
ProductEdge
ProductEdited
Fields
| Field Name | Description |
|---|---|
product - Product!
|
Example
{"product": Product}
ProductFilter
Description
A simple use of this filter might look like:
filter: {nameExact:"Product One"}
A filter with a top level 'or' might look like:
filter: {or: [{nameExact: "Product One"}, {codeContains: "1234"}]}
Fields
| Input Field | Description |
|---|---|
and - [ProductFilter!]
|
|
or - [ProductFilter!]
|
|
nameContains - String
|
|
nameExact - String
|
|
codeContains - String
|
|
customerId - ID
|
|
granted - Boolean
|
|
ownedBy - [Owners!]
|
|
state - ProductState
|
Example
{
"and": [ProductFilter],
"or": [ProductFilter],
"nameContains": "abc123",
"nameExact": "abc123",
"codeContains": "xyz789",
"customerId": 4,
"granted": true,
"ownedBy": ["BANK"],
"state": "TEMPLATE"
}
ProductListSubscription
Types
| Union Types |
|---|
Example
ProductCreated
ProductOrdering
Fields
| Input Field | Description |
|---|---|
sort - ProductSort!
|
|
direction - OrderingDirection!
|
Example
{"sort": "NAME", "direction": "ASC"}
ProductSort
Values
| Enum Value | Description |
|---|---|
|
|
Example
"NAME"
ProductState
Values
| Enum Value | Description |
|---|---|
|
|
Can be further specialised but not used to open an account |
|
|
Can be used to open an account |
|
|
Withdrawn from further use, cannot be used to open new accounts |
Example
"TEMPLATE"
ProductSubscription
Types
| Union Types |
|---|
Example
GrantedProductToCustomer
RTGSRecipient
Description
Identifying details for the recipient of an RTGS payment.
Fields
| Input Field | Description |
|---|---|
name - String!
|
The recipients name. |
accountNumber - AccountNumber!
|
The account number the RTGS payment is to be sent to. |
bankCode - BankCode!
|
The bank code of the account the RTGS payment is to be sent to. |
Example
{
"name": "abc123",
"accountNumber": "000000012345",
"bankCode": BankCode
}
RTGSSender
Description
Identifying details for the sender of an RTGS payment.
Fields
| Input Field | Description |
|---|---|
accountId - ID!
|
The unique id of the account an RTGS payment is initiated from. |
Example
{"accountId": "4"}
RateValue
Description
A rate represented to 5 decimal places.
Example
RateValue
RealisationFrequencies
Fields
| Field Name | Description |
|---|---|
currency - CurrencyCode!
|
|
periodType - PeriodType!
|
|
day - Int
|
Example
{
"currency": CurrencyCode,
"periodType": "DAY_OF_MONTH",
"day": 987
}
RealisationFrequenciesInput
Fields
| Input Field | Description |
|---|---|
currency - CurrencyCode!
|
|
periodType - PeriodType!
|
|
day - Int
|
Example
{
"currency": CurrencyCode,
"periodType": "DAY_OF_MONTH",
"day": 987
}
RealiseAccountInterestCommand
Fields
| Field Name | Description |
|---|---|
account - Account
|
|
accrual - Accrual
|
|
action - String!
|
Use operation field, the operation field is an enumeration that makes it easier to query with |
approval - Approval
|
|
createdTimestamp - DateTime
|
|
id - ID!
|
|
inputJson - String
|
|
invalid - [CommandError]!
|
|
operation - Action!
|
|
realisation - Interest
|
|
state - CommandState!
|
|
step - String!
|
|
user - String!
|
Use userInfo, as this only details the sub |
userInfo - UserInfo!
|
|
userInput - RealiseAccountInterestDetails
|
Example
{
"account": Account,
"accrual": Accrual,
"action": "abc123",
"approval": Approval,
"createdTimestamp": "2007-12-03T10:15:30Z",
"id": 4,
"inputJson": "xyz789",
"invalid": [CommandError],
"operation": "AGGREGATE_PAYMENT_EXECUTE",
"realisation": Interest,
"state": "SUBMITTED",
"step": "xyz789",
"user": "abc123",
"userInfo": UserInfo,
"userInput": RealiseAccountInterestDetails
}
RealiseAccountInterestDetails
Fields
| Field Name | Description |
|---|---|
currency - CurrencyCode
|
|
id - String
|
Example
{
"currency": CurrencyCode,
"id": "abc123"
}
RealiseAccountInterestInput
Fields
| Input Field | Description |
|---|---|
accountId - ID!
|
|
currency - CurrencyCode!
|
Example
{"accountId": 4, "currency": CurrencyCode}
Receipt
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
createdTimestamp - DateTime!
|
|
amount - Amount!
|
|
remainingUnallocated - Amount
|
|
allocationState - AllocationState!
|
|
allocation - Allocation
|
|
unallocatable - Boolean!
|
|
unallocatedReason - String
|
|
unallocatedReasonCode - UnallocatedReasonCode
|
|
transactions - TransactionConnection!
|
|
valueDate - Date!
|
Value date applied to the receipt. |
recipient - Recipient
|
|
bookingDate - Date
|
|
narrative - String
|
|
status - String
|
|
entryReference - String
|
|
accountServicerReference - String
|
|
domain - String
|
|
family - String
|
|
split - AllocatableSplitConnection!
|
|
Arguments
|
|
subFamily - String
|
|
proprietary - String
|
|
pool - Pool!
|
|
accountAllocatedTo - Account
|
|
deleteMessage - String
|
Deprecated. Moved to movementHistory |
restoreMessage - String
|
Deprecated. Moved to movementHistory |
deleteRequestUserName - String
|
Deprecated. Moved to movementHistory |
deleteRequestUserId - String
|
Deprecated. Moved to movementHistory |
deleteRequestTimestamp - String
|
Deprecated. Moved to movementHistory |
deleteApprovalUserName - String
|
Deprecated. Moved to movementHistory |
deleteApprovalUserId - String
|
Deprecated. Moved to movementHistory |
deleteApprovalTimestamp - String
|
Deprecated. Moved to movementHistory |
restoreRequestUserName - String
|
Deprecated. Moved to movementHistory |
restoreRequestUserId - String
|
Deprecated. Moved to movementHistory |
restoreRequestTimestamp - String
|
Deprecated. Moved to movementHistory |
restoreApprovalUserName - String
|
Deprecated. Moved to movementHistory |
restoreApprovalUserId - String
|
Deprecated. Moved to movementHistory |
restoreApprovalTimestamp - String
|
Deprecated. Moved to movementHistory |
history - [AllocatableHistoryItem!]
|
Shows the movement activity for this Allocatable |
camtReceived - Boolean!
|
|
instructions - [Instruction!]
|
|
hold - Boolean!
|
|
holdHistory - [HoldHistoryItem!]
|
|
reversal - Boolean!
|
|
directDebit - Boolean!
|
|
businessProcess - BusinessProcess!
|
|
movementToCLA - MovementToCLAPayment
|
|
Example
{
"id": "4",
"createdTimestamp": "2007-12-03T10:15:30Z",
"amount": Amount,
"remainingUnallocated": Amount,
"allocationState": "PENDING",
"allocation": Allocation,
"unallocatable": true,
"unallocatedReason": "abc123",
"unallocatedReasonCode": "MULTIPLE_DESTINATIONS",
"transactions": TransactionConnection,
"valueDate": "2007-12-03",
"recipient": Recipient,
"bookingDate": "2007-12-03",
"narrative": "abc123",
"status": "abc123",
"entryReference": "abc123",
"accountServicerReference": "xyz789",
"domain": "xyz789",
"family": "abc123",
"split": AllocatableSplitConnection,
"subFamily": "xyz789",
"proprietary": "xyz789",
"pool": Pool,
"accountAllocatedTo": Account,
"deleteMessage": "xyz789",
"restoreMessage": "abc123",
"deleteRequestUserName": "abc123",
"deleteRequestUserId": "xyz789",
"deleteRequestTimestamp": "xyz789",
"deleteApprovalUserName": "xyz789",
"deleteApprovalUserId": "xyz789",
"deleteApprovalTimestamp": "xyz789",
"restoreRequestUserName": "abc123",
"restoreRequestUserId": "abc123",
"restoreRequestTimestamp": "abc123",
"restoreApprovalUserName": "abc123",
"restoreApprovalUserId": "abc123",
"restoreApprovalTimestamp": "xyz789",
"history": [AllocatableHistoryItem],
"camtReceived": false,
"instructions": [Instruction],
"hold": true,
"holdHistory": [HoldHistoryItem],
"reversal": false,
"directDebit": false,
"businessProcess": BusinessProcess,
"movementToCLA": MovementToCLAPayment
}
ReceiptAdded
Fields
| Field Name | Description |
|---|---|
receipt - Receipt!
|
Example
{"receipt": Receipt}
ReceiptConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [ReceiptEdge]
|
|
aggregates - SimpleConnectionAggregate!
|
Example
{
"pageInfo": PageInfo,
"edges": [ReceiptEdge],
"aggregates": SimpleConnectionAggregate
}
ReceiptEdge
ReceiptFilter
Fields
| Input Field | Description |
|---|---|
allocationState - AllocationState
|
|
narrativeContains - String
|
|
narrativeExact - String
|
|
camtReceived - Boolean
|
|
amount - AmountFilter
|
Example
{
"allocationState": "PENDING",
"narrativeContains": "abc123",
"narrativeExact": "xyz789",
"camtReceived": false,
"amount": AmountFilter
}
ReceiptRemoved
Fields
| Field Name | Description |
|---|---|
receipt - Receipt!
|
Example
{"receipt": Receipt}
ReceiptUpdated
Fields
| Field Name | Description |
|---|---|
receipt - Receipt!
|
Example
{"receipt": Receipt}
Recipient
RejectRequestInput
Fields
| Input Field | Description |
|---|---|
id - String!
|
The id of the approval process, this is not the command id, please see the approvals list |
reason - String
|
Reason for the response you are giving |
tokenCode - String
|
Optional generated one time use token. This may be required for the overall approval as determined via the config |
Example
{
"id": "abc123",
"reason": "xyz789",
"tokenCode": "xyz789"
}
RemoveHoldUnallocatedInput
Report
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
displayName - String!
|
|
type - ReportType!
|
|
frequency - ReportFrequency!
|
Example
{
"id": "4",
"displayName": "abc123",
"type": "BANK_REPORT",
"frequency": "DAILY"
}
ReportConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [ReportEdge]
|
|
aggregates - SimpleConnectionAggregate!
|
Example
{
"pageInfo": PageInfo,
"edges": [ReportEdge],
"aggregates": SimpleConnectionAggregate
}
ReportEdge
ReportFilter
ReportFrequency
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DAILY"
ReportType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"BANK_REPORT"
Reporter
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"BANK"
ReportingFinancialInstitution
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"YES"
RequestDeletionInput
RequestPaymentFromCustomerLinkedAccountInput
Fields
| Input Field | Description |
|---|---|
customerLinkedAccountId - ID!
|
ID of the customer linked account the money is to be sent from |
requesterAccountId - ID!
|
ID of the CCM account making the request |
paymentAmount - PaymentAmountInput!
|
Value of the payment. |
reference - String
|
A message about the payment. The reference will be sent to the recipient of the payment. |
valueDate - Date
|
Value date to be applied to the payment. |
customerTransactionReference - String
|
An optional reference that can later be used to search for the PaymentRequest |
Example
{
"customerLinkedAccountId": 4,
"requesterAccountId": "4",
"paymentAmount": PaymentAmountInput,
"reference": "abc123",
"valueDate": "2007-12-03",
"customerTransactionReference": "abc123"
}
RequestRestorationInput
RequestWithholdingTaxRefund
Fields
| Input Field | Description |
|---|---|
accountId - ID!
|
account id for account requesting refund. |
Example
{"accountId": "4"}
RequiredRolesFeatureConfig
RequiredRolesFeatureConfigInput
Fields
| Input Field | Description |
|---|---|
roles - [Role!]!
|
Example
{"roles": ["BENEFICIARY"]}
RerunScheduledReportInput
Fields
| Input Field | Description |
|---|---|
runId - ID!
|
The id of the specific scheduled report run to rerun. |
Example
{"runId": 4}
RestorationDecisionInput
Fields
| Input Field | Description |
|---|---|
allocatableId - ID!
|
Unique id of the Payment or Receipt that was requested to be restored. |
decision - RestorationDecisionType!
|
Whether to approve or deny the request. |
Example
{"allocatableId": 4, "decision": "APPROVE"}
RestorationDecisionType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"APPROVE"
ResubmitPaymentCommand
Fields
| Field Name | Description |
|---|---|
action - String!
|
Use operation field, the operation field is an enumeration that makes it easier to query with |
approval - Approval
|
|
createdTimestamp - DateTime
|
|
id - ID!
|
|
inputJson - String
|
|
invalid - [CommandError]!
|
|
operation - Action!
|
|
payment - Payment
|
|
state - CommandState!
|
|
step - String!
|
|
user - String!
|
Use userInfo, as this only details the sub |
userInfo - UserInfo!
|
|
userInput - ResubmitPaymentDetails
|
Example
{
"action": "abc123",
"approval": Approval,
"createdTimestamp": "2007-12-03T10:15:30Z",
"id": 4,
"inputJson": "xyz789",
"invalid": [CommandError],
"operation": "AGGREGATE_PAYMENT_EXECUTE",
"payment": Payment,
"state": "SUBMITTED",
"step": "xyz789",
"user": "xyz789",
"userInfo": UserInfo,
"userInput": ResubmitPaymentDetails
}
ResubmitPaymentDetails
Fields
| Field Name | Description |
|---|---|
id - String
|
Example
{"id": "abc123"}
ResubmitPaymentInput
Fields
| Input Field | Description |
|---|---|
paymentId - ID!
|
Example
{"paymentId": 4}
ResubmitPaymentRequestCommand
Fields
| Field Name | Description |
|---|---|
action - String!
|
Use operation field, the operation field is an enumeration that makes it easier to query with |
approval - Approval
|
|
createdTimestamp - DateTime
|
|
id - ID!
|
|
inputJson - String
|
|
invalid - [CommandError]!
|
|
operation - Action!
|
|
paymentRequest - PaymentRequest
|
|
state - CommandState!
|
|
step - String!
|
|
user - String!
|
Use userInfo, as this only details the sub |
userInfo - UserInfo!
|
|
userInput - ResubmitPaymentRequestDetails
|
Example
{
"action": "xyz789",
"approval": Approval,
"createdTimestamp": "2007-12-03T10:15:30Z",
"id": 4,
"inputJson": "xyz789",
"invalid": [CommandError],
"operation": "AGGREGATE_PAYMENT_EXECUTE",
"paymentRequest": PaymentRequest,
"state": "SUBMITTED",
"step": "abc123",
"user": "abc123",
"userInfo": UserInfo,
"userInput": ResubmitPaymentRequestDetails
}
ResubmitPaymentRequestDetails
Fields
| Field Name | Description |
|---|---|
id - String
|
Example
{"id": "xyz789"}
ResubmitPaymentRequestInput
Fields
| Input Field | Description |
|---|---|
paymentRequestId - ID!
|
Example
{"paymentRequestId": 4}
RetailLookThrough
RetailLookThroughInput
Fields
| Input Field | Description |
|---|---|
enabled - Boolean!
|
Indicates whether predominantly retail monies are being managed. |
percentageThreshold - NumberWithUpTo2DecimalPlaces
|
Maximum allowable percentage for non-retail monies managed. |
balanceThreshold - AmountValue
|
Maximum allowable amount of non-retail monies managed. |
Example
{
"enabled": true,
"percentageThreshold": NumberWithUpTo2DecimalPlaces,
"balanceThreshold": AmountValue
}
RetrieveArchivedStatementInput
Role
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"BENEFICIARY"
RtgsPaymentFeatureConfig
RtgsRecipient
Fields
| Field Name | Description |
|---|---|
accountNumber - String
|
|
bankCode - String
|
|
name - String
|
|
origin - UserDefinedRecipientOrigin
|
The origin of where the details for the recipient were pulled from, null represents user defined. |
Example
{
"accountNumber": "xyz789",
"bankCode": "abc123",
"name": "xyz789",
"origin": "USER_DEFINED"
}
ScheduleParameters
Fields
| Field Name | Description |
|---|---|
time - Time!
|
|
timeZone - TimeZone!
|
|
dayOfMonth - Int
|
|
startMonth - Int
|
|
frequency - ReportFrequency
|
Example
{
"time": "10:15:30Z",
"timeZone": "Etc/UTC",
"dayOfMonth": 123,
"startMonth": 123,
"frequency": "DAILY"
}
ScheduleParametersInput
ScheduledReport
Example
{
"id": "4",
"report": Report,
"customer": Customer,
"scheduleParameters": ScheduleParameters,
"createdTimestamp": "2007-12-03T10:15:30Z",
"deleted": true,
"product": Product,
"runs": ScheduledReportRunConnection
}
ScheduledReportConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [ScheduledReportEdge]
|
|
aggregates - SimpleConnectionAggregate!
|
Example
{
"pageInfo": PageInfo,
"edges": [ScheduledReportEdge],
"aggregates": SimpleConnectionAggregate
}
ScheduledReportCreated
Fields
| Field Name | Description |
|---|---|
scheduledReport - ScheduledReport!
|
Example
{"scheduledReport": ScheduledReport}
ScheduledReportDeleted
Fields
| Field Name | Description |
|---|---|
scheduledReport - ScheduledReport!
|
Example
{"scheduledReport": ScheduledReport}
ScheduledReportEdge
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
|
node - ScheduledReport!
|
Example
{
"cursor": "abc123",
"node": ScheduledReport
}
ScheduledReportFilter
ScheduledReportListSubscription
Types
| Union Types |
|---|
Example
ScheduledReportCreated
ScheduledReportRun
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
scheduledReport - ScheduledReport!
|
|
runTime - DateTime!
|
|
runType - ScheduledReportRunType!
|
|
state - ScheduledReportRunState!
|
|
errors - [CommandError!]
|
Example
{
"id": "4",
"scheduledReport": ScheduledReport,
"runTime": "2007-12-03T10:15:30Z",
"runType": "SCHEDULED_RUN",
"state": "PENDING",
"errors": [CommandError]
}
ScheduledReportRunConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [ScheduledReportRunEdge]
|
|
aggregates - SimpleConnectionAggregate!
|
Example
{
"pageInfo": PageInfo,
"edges": [ScheduledReportRunEdge],
"aggregates": SimpleConnectionAggregate
}
ScheduledReportRunEdge
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
|
node - ScheduledReportRun!
|
Example
{
"cursor": "abc123",
"node": ScheduledReportRun
}
ScheduledReportRunState
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"PENDING"
ScheduledReportRunType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"SCHEDULED_RUN"
SelfCertificationRequiredFeatureConfig
SelfCertified
Description
Tax self certification details.
Fields
| Field Name | Description |
|---|---|
certificationDate - Date!
|
The date the party declared self certification. |
Example
{"certificationDate": "2007-12-03"}
SelfCertifiedHistory
Fields
| Field Name | Description |
|---|---|
dateOfChange - DateTime
|
|
selfCertified - SelfCertified
|
Example
{
"dateOfChange": "2007-12-03T10:15:30Z",
"selfCertified": SelfCertified
}
SelfCertifiedInput
Description
Tax self certification details.
Fields
| Input Field | Description |
|---|---|
certificationDate - Date!
|
The date the party declared self certification. |
Example
{"certificationDate": "2007-12-03"}
SetCalendarInput
Fields
| Input Field | Description |
|---|---|
countryCode - CountryShortCode!
|
|
weekendHolidays - Boolean!
|
|
holidays - [Date!]
|
|
forcedBusinessDays - [Date!]
|
Example
{
"countryCode": CountryShortCode,
"weekendHolidays": false,
"holidays": ["2007-12-03"],
"forcedBusinessDays": ["2007-12-03"]
}
SimpleConnectionAggregate
Fields
| Field Name | Description |
|---|---|
count - Int!
|
This is the number of filtered edges that would be returned without paging. |
Example
{"count": 123}
Source
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
sourceType - SourceType!
|
|
bankCode - BankCode!
|
|
currency - CurrencyCode!
|
|
name - String
|
|
balances - SourceBalances!
|
|
internalAccounts - AccountConnection!
|
|
Arguments
|
|
Possible Types
| Source Types |
|---|
Example
{
"id": "4",
"sourceType": "BANK",
"bankCode": BankCode,
"currency": CurrencyCode,
"name": "abc123",
"balances": SourceBalances,
"internalAccounts": AccountConnection
}
SourceBalances
Fields
| Field Name | Description |
|---|---|
calculatedCurrent - Amount
|
This is the calculated balance of the source account, this should tally with the actual balance reported by the bank. This may be out due to pending transactions that we are awaiting confirmation on |
Example
{"calculatedCurrent": Amount}
SourceConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [SourceEdge]
|
|
aggregates - SimpleConnectionAggregate!
|
Example
{
"pageInfo": PageInfo,
"edges": [SourceEdge],
"aggregates": SimpleConnectionAggregate
}
SourceEdge
SourceFilter
Fields
| Input Field | Description |
|---|---|
bankCode - BankCode
|
|
accountNumber - AccountNumber
|
|
nameExact - String
|
|
nameContains - String
|
Example
{
"bankCode": BankCode,
"accountNumber": "000000012345",
"nameExact": "abc123",
"nameContains": "abc123"
}
SourceListSubscription
Types
| Union Types |
|---|
Example
SourceRegistered
SourceRegistered
Fields
| Field Name | Description |
|---|---|
source - Source!
|
Example
{"source": Source}
SourceType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"BANK"
SpecialiseProductInput
Description
Product specialisation (creation).
Active features must include all active features of the parent product and may include available features from the parent product. Available features may only include available features of the parent product or subfeatures of features being added to the active list.
Features which require configuration must have configurations supplied, which are valid specialisations of the feature's configuration on the parent.
Fields
| Input Field | Description |
|---|---|
parent - ID!
|
The ID of the base product. |
customerId - ID
|
The optional ID of the customer to make this product for. |
name - String!
|
The name of the new product. |
codeSuffix - String!
|
The suffix code of the new product |
description - String
|
A short description of the new product. |
activeFeatures - [FeatureName!]
|
A list of the active feature names, EG ['PaymentFeatureConfig']. |
availableFeatures - [FeatureName!]
|
A list of the available feature names, EG ['DeFeatureConfig']. |
currencyFeatureConfig - CurrencyFeatureConfigInput
|
Currencies supported by the product. |
interestFeatureConfig - InterestFeatureConfigInput
|
Interest earning capabilities of the product. |
clientInterestFeatureConfig - ClientInterestFeatureConfigInput
|
Interest to be earned by client accounts opened with the product. |
customerInterestFeatureConfig - CustomerInterestFeatureConfigInput
|
Interest to be earned by the customer on balances held in client accounts opened with the product. |
poolFeatureConfig - PoolFeatureConfigInput
|
Details of the pool associated with clients accounts opened with the product. |
requiredRolesFeatureConfig - RequiredRolesFeatureConfigInput
|
Mandatory roles (beneficiary, trustee etc.) that must be supplied when opening an account with this product. |
defaultTrusteesFeatureConfig - DefaultTrusteesFeatureConfigInput
|
Default trustees (parties with role as a TRUSTEE) that must be supplied when opening an account with this product. |
statementsFeatureConfig - StatementsFeatureConfigInput
|
The frequency and time at which statements should run |
state - ProductState
|
The optional state to specialise a product with |
governmentGuaranteeApplies - Boolean
|
A label to indicate whether the Australian government guarantee applies to each individual account for this product. |
costCentre - String
|
The cost centre for the reporting of revenue associated with the product. |
rmSet - String
|
Used for MIS reporting and identifying the relationship manager. |
retailLookThrough - RetailLookThroughInput
|
Details of whether predominantly retail monies are being managed, and if so, the associated paramaters. |
billingId - String
|
The optional billing id for the new product within a bank |
Example
{
"parent": "4",
"customerId": 4,
"name": "xyz789",
"codeSuffix": "xyz789",
"description": "abc123",
"activeFeatures": ["CURRENCY"],
"availableFeatures": ["CURRENCY"],
"currencyFeatureConfig": CurrencyFeatureConfigInput,
"interestFeatureConfig": InterestFeatureConfigInput,
"clientInterestFeatureConfig": ClientInterestFeatureConfigInput,
"customerInterestFeatureConfig": CustomerInterestFeatureConfigInput,
"poolFeatureConfig": PoolFeatureConfigInput,
"requiredRolesFeatureConfig": RequiredRolesFeatureConfigInput,
"defaultTrusteesFeatureConfig": DefaultTrusteesFeatureConfigInput,
"statementsFeatureConfig": StatementsFeatureConfigInput,
"state": "TEMPLATE",
"governmentGuaranteeApplies": true,
"costCentre": "abc123",
"rmSet": "abc123",
"retailLookThrough": RetailLookThroughInput,
"billingId": "abc123"
}
SplitAllocatableCommand
Fields
| Field Name | Description |
|---|---|
action - String!
|
Use operation field, the operation field is an enumeration that makes it easier to query with |
allocatable - Allocatable
|
|
approval - Approval
|
|
createdTimestamp - DateTime
|
|
id - ID!
|
|
inputJson - String
|
|
invalid - [CommandError]!
|
|
operation - Action!
|
|
split - AllocatableSplitConnection
|
|
Arguments
|
|
state - CommandState!
|
|
step - String!
|
|
user - String!
|
Use userInfo, as this only details the sub |
userInfo - UserInfo!
|
|
userInput - SplitAllocatableDetails
|
|
Example
{
"action": "abc123",
"allocatable": Allocatable,
"approval": Approval,
"createdTimestamp": "2007-12-03T10:15:30Z",
"id": "4",
"inputJson": "abc123",
"invalid": [CommandError],
"operation": "AGGREGATE_PAYMENT_EXECUTE",
"split": AllocatableSplitConnection,
"state": "SUBMITTED",
"step": "xyz789",
"user": "abc123",
"userInfo": UserInfo,
"userInput": SplitAllocatableDetails
}
SplitAllocatableDetails
Fields
| Field Name | Description |
|---|---|
allocatable - Identifier
|
|
allocatableNode - Allocatable
|
|
reference - String
|
|
splits - [SplitElement]
|
Example
{
"allocatable": Identifier,
"allocatableNode": Allocatable,
"reference": "abc123",
"splits": [SplitElement]
}
SplitAllocatableElementInput
Description
Individual element of an allocatable split accross accounts
Fields
| Input Field | Description |
|---|---|
accountId - ID!
|
Unique id of the account that the split allocatable element is moving to |
value - AmountValue!
|
The value of the split allocatable element |
customerTransactionReference - String
|
A reference for the individual split allocatable element. |
Example
{
"accountId": "4",
"value": AmountValue,
"customerTransactionReference": "abc123"
}
SplitAllocatableInput
Fields
| Input Field | Description |
|---|---|
allocatableId - ID!
|
Unique id of the Payment or Reciept that is being split |
reference - String!
|
A reference associated with the allocatable to be split. |
splits - [SplitAllocatableElementInput!]!
|
The list of account ids and the respective values the Payment or Receipt is split into |
Example
{
"allocatableId": 4,
"reference": "xyz789",
"splits": [SplitAllocatableElementInput]
}
SplitElement
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
allocatable - Allocatable
|
|
account - Account
|
|
customerLinkedAccount - CustomerLinkedAccount
|
|
amount - Amount!
|
|
reference - String
|
|
state - SplitElementState!
|
|
customerTransactionReference - String
|
|
groupId - ID
|
|
allocationTransaction - Transaction
|
|
unallocationTransaction - Transaction
|
|
history - SplitElementHistoryConnection!
|
|
Arguments |
|
Example
{
"id": 4,
"allocatable": Allocatable,
"account": Account,
"customerLinkedAccount": CustomerLinkedAccount,
"amount": Amount,
"reference": "xyz789",
"state": "ALLOCATED",
"customerTransactionReference": "abc123",
"groupId": "4",
"allocationTransaction": Transaction,
"unallocationTransaction": Transaction,
"history": SplitElementHistoryConnection
}
SplitElementEdge
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
|
node - SplitElement!
|
Example
{
"cursor": "xyz789",
"node": SplitElement
}
SplitElementFilter
Fields
| Input Field | Description |
|---|---|
state - SplitElementState
|
Example
{"state": "ALLOCATED"}
SplitElementHistoryConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [SplitElementHistoryEdge!]
|
|
aggregates - SimpleConnectionAggregate!
|
Example
{
"pageInfo": PageInfo,
"edges": [SplitElementHistoryEdge],
"aggregates": SimpleConnectionAggregate
}
SplitElementHistoryEdge
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
|
node - SplitElementHistoryItem!
|
Example
{
"cursor": "abc123",
"node": SplitElementHistoryItem
}
SplitElementHistoryItem
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
command - Command!
|
|
action - String!
|
|
timestamp - DateTime!
|
|
transaction - Transaction
|
|
failedReason - String
|
|
payment - Payment
|
|
paymentRequest - PaymentRequest
|
Example
{
"id": 4,
"command": Command,
"action": "abc123",
"timestamp": "2007-12-03T10:15:30Z",
"transaction": Transaction,
"failedReason": "abc123",
"payment": Payment,
"paymentRequest": PaymentRequest
}
SplitElementHistoryOrdering
Fields
| Input Field | Description |
|---|---|
sort - SplitElementHistorySort!
|
|
direction - OrderingDirection!
|
Example
{"sort": "TIMESTAMP", "direction": "ASC"}
SplitElementHistorySort
Values
| Enum Value | Description |
|---|---|
|
|
Example
"TIMESTAMP"
SplitElementOrdering
Fields
| Input Field | Description |
|---|---|
sort - SplitElementSort!
|
|
direction - OrderingDirection!
|
Example
{"sort": "AMOUNT", "direction": "ASC"}
SplitElementSort
Values
| Enum Value | Description |
|---|---|
|
|
Example
"AMOUNT"
SplitElementState
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"ALLOCATED"
StatementFrequency
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"MONTHLY"
StatementsConfig
Fields
| Field Name | Description |
|---|---|
frequency - StatementFrequency!
|
|
time - Time!
|
|
timezone - TimeZone!
|
Example
{
"frequency": "MONTHLY",
"time": "10:15:30Z",
"timezone": "Etc/UTC"
}
StatementsFeatureConfig
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
statements - StatementsConfig!
|
Example
{
"id": "4",
"name": "xyz789",
"statements": StatementsConfig
}
StatementsFeatureConfigInput
Fields
| Input Field | Description |
|---|---|
frequency - StatementFrequency!
|
|
time - Time!
|
|
timezone - TimeZone!
|
Example
{
"frequency": "MONTHLY",
"time": "10:15:30Z",
"timezone": "Etc/UTC"
}
String
Description
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example
"abc123"
SubledgerRequester
Fields
| Field Name | Description |
|---|---|
customer - Identifier
|
|
customerNode - Customer
|
|
source - Identifier
|
|
sourceNode - Source
|
|
subledger - String
|
Example
{
"customer": Identifier,
"customerNode": Customer,
"source": Identifier,
"sourceNode": Source,
"subledger": "abc123"
}
SubledgerSender
Fields
| Field Name | Description |
|---|---|
customer - Identifier
|
|
customerNode - Customer
|
|
source - Identifier
|
|
sourceNode - Source
|
|
subledger - String
|
Example
{
"customer": Identifier,
"customerNode": Customer,
"source": Identifier,
"sourceNode": Source,
"subledger": "xyz789"
}
TaxResidency
Fields
| Field Name | Description |
|---|---|
countryCode - String
|
|
tin - String
|
|
tinMissingExplanation - String
|
|
tinMissingReason - TinMissingReason
|
Example
{
"countryCode": "xyz789",
"tin": "abc123",
"tinMissingExplanation": "xyz789",
"tinMissingReason": "APPLIED_FOR"
}
Tier
Fields
| Field Name | Description |
|---|---|
namedRate - NamedRate!
|
|
lowerBound - AmountValue!
|
Example
{
"namedRate": NamedRate,
"lowerBound": AmountValue
}
TierInput
Fields
| Input Field | Description |
|---|---|
namedRateId - ID!
|
The id of the rate to be applied within this tier, currently this can only be a fixed or margin rate ID |
lowerBound - AmountValue!
|
Inclusive lower bound for this tier, if no tier is setup above this value consider this to apply to the remainder of the balance |
Example
{
"namedRateId": "4",
"lowerBound": AmountValue
}
Time
Description
Time in HH:mm:ss.nnnnnnnnn format, where each section after mm is optional.
Example
"10:15:30Z"
TimeZone
Description
A time zone identifier
Example
"Etc/UTC"
TinMissingReason
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"APPLIED_FOR"
TokenRequirement
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"NONE"
Transaction
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
transactionType - String!
|
|
valueDate - Date!
|
|
currency - CurrencyCode!
|
|
entries - TransactionEntryConnection!
|
|
businessProcess - BusinessProcess
|
|
initiatedTimestamp - DateTime!
|
|
state - TransactionState!
|
|
splitElement - SplitElement
|
|
Possible Types
| Transaction Types |
|---|
Example
{
"id": 4,
"transactionType": "abc123",
"valueDate": "2007-12-03",
"currency": CurrencyCode,
"entries": TransactionEntryConnection,
"businessProcess": BusinessProcess,
"initiatedTimestamp": "2007-12-03T10:15:30Z",
"state": "PENDING",
"splitElement": SplitElement
}
TransactionConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [TransactionEdge]
|
|
aggregates - SimpleConnectionAggregate!
|
Example
{
"pageInfo": PageInfo,
"edges": [TransactionEdge],
"aggregates": SimpleConnectionAggregate
}
TransactionEdge
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
|
node - Transaction!
|
Example
{
"cursor": "xyz789",
"node": Transaction
}
TransactionEntry
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
transactionType - String!
|
|
account - Account!
|
|
businessProcess - BusinessProcess
|
|
transaction - Transaction!
|
|
balance - Amount
|
|
instruction - AggregateInstruction
|
|
state - TransactionState!
|
|
initiatedTimestamp - DateTime!
|
|
value - AmountValue!
|
|
currency - CurrencyCode!
|
|
creditDebit - CreditDebit!
|
|
unallocatable - Boolean!
|
Possible Types
| TransactionEntry Types |
|---|
Example
{
"id": "4",
"transactionType": "xyz789",
"account": Account,
"businessProcess": BusinessProcess,
"transaction": Transaction,
"balance": Amount,
"instruction": AggregateInstruction,
"state": "PENDING",
"initiatedTimestamp": "2007-12-03T10:15:30Z",
"value": AmountValue,
"currency": CurrencyCode,
"creditDebit": "CREDIT",
"unallocatable": true
}
TransactionEntryConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [TransactionEntryEdge]
|
|
aggregates - SimpleConnectionAggregate!
|
Example
{
"pageInfo": PageInfo,
"edges": [TransactionEntryEdge],
"aggregates": SimpleConnectionAggregate
}
TransactionEntryEdge
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
|
node - TransactionEntry!
|
Example
{
"cursor": "abc123",
"node": TransactionEntry
}
TransactionEntryOrdering
Fields
| Input Field | Description |
|---|---|
sort - TransactionEntrySort!
|
|
direction - OrderingDirection!
|
Example
{"sort": "PENDING_FIRST", "direction": "ASC"}
TransactionEntrySort
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"PENDING_FIRST"
TransactionFilter
Fields
| Input Field | Description |
|---|---|
from - DateTime
|
An instant on or before the time of the first transaction to show. |
until - DateTime
|
An instant after the time of the last transaction to show. |
currencies - [CurrencyCode!]
|
An list of currencies to limit results to. |
states - [TransactionState!]
|
An list of states to limit results to. |
amount - AmountFilter
|
Limits transactions returned according to their amount. |
businessProcessTypes - [BusinessProcessType!]
|
Limits transactions to those linked to a business process of one of these types. |
Example
{
"from": "2007-12-03T10:15:30Z",
"until": "2007-12-03T10:15:30Z",
"currencies": [CurrencyCode],
"states": ["PENDING"],
"amount": AmountFilter,
"businessProcessTypes": ["RECEIPT"]
}
TransactionState
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"PENDING"
TransferPerformCommand
Fields
| Field Name | Description |
|---|---|
action - String!
|
Use operation field, the operation field is an enumeration that makes it easier to query with |
approval - Approval
|
|
createdTimestamp - DateTime
|
|
id - ID!
|
|
inputJson - String
|
|
invalid - [CommandError]!
|
|
operation - Action!
|
|
pool - Pool
|
|
state - CommandState!
|
|
step - String!
|
|
transfer - InternalTransfer
|
|
user - String!
|
Use userInfo, as this only details the sub |
userInfo - UserInfo!
|
|
userInput - TransferPerformDetails
|
Example
{
"action": "xyz789",
"approval": Approval,
"createdTimestamp": "2007-12-03T10:15:30Z",
"id": "4",
"inputJson": "abc123",
"invalid": [CommandError],
"operation": "AGGREGATE_PAYMENT_EXECUTE",
"pool": Pool,
"state": "SUBMITTED",
"step": "xyz789",
"transfer": InternalTransfer,
"user": "xyz789",
"userInfo": UserInfo,
"userInput": TransferPerformDetails
}
TransferPerformDetails
Fields
| Field Name | Description |
|---|---|
amount - CreditAmount
|
|
customerTransactionReference - String
|
This is an optional string specified on the mutation for the sole purpose of being able to search for the BusinessProcess by the string later |
fromAccountNumber - String
|
|
payeeReference - String
|
|
payerReference - String
|
|
pool - Identifier
|
|
poolNode - Pool
|
|
toAccountNumber - String
|
|
valueDate - Date
|
Example
{
"amount": CreditAmount,
"customerTransactionReference": "xyz789",
"fromAccountNumber": "abc123",
"payeeReference": "xyz789",
"payerReference": "abc123",
"pool": Identifier,
"poolNode": Pool,
"toAccountNumber": "abc123",
"valueDate": "2007-12-03"
}
TrustSubType
Description
Types of trusts.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"REGULATED_SELF_MANAGED_SUPER_FUND"
UnallocateCommand
Fields
| Field Name | Description |
|---|---|
action - String!
|
Use operation field, the operation field is an enumeration that makes it easier to query with |
allocatable - Allocatable
|
|
approval - Approval
|
|
createdTimestamp - DateTime
|
|
id - ID!
|
|
inputJson - String
|
|
invalid - [CommandError]!
|
|
operation - Action!
|
|
state - CommandState!
|
|
step - String!
|
|
user - String!
|
Use userInfo, as this only details the sub |
userInfo - UserInfo!
|
|
userInput - UnallocateDetails
|
Example
{
"action": "xyz789",
"allocatable": Allocatable,
"approval": Approval,
"createdTimestamp": "2007-12-03T10:15:30Z",
"id": "4",
"inputJson": "abc123",
"invalid": [CommandError],
"operation": "AGGREGATE_PAYMENT_EXECUTE",
"state": "SUBMITTED",
"step": "xyz789",
"user": "abc123",
"userInfo": UserInfo,
"userInput": UnallocateDetails
}
UnallocateDetails
Fields
| Field Name | Description |
|---|---|
account - Identifier
|
|
accountNode - Account
|
|
id - String
|
Example
{
"account": Identifier,
"accountNode": Account,
"id": "xyz789"
}
UnallocateInput
Description
Options for unallocation of an allocated payment or receipt back to its pool.
Fields
| Input Field | Description |
|---|---|
unallocatableId - ID!
|
Unique id of the Payment or Receipt to be unallocated. |
accountId - ID
|
Account the allocatable is currently under, this is used to ensure the unallocation you are wanting to perform is correct as of the data you are viewing. If the allocatable has moved from this account the unallocate command will fail. |
Example
{"unallocatableId": 4, "accountId": 4}
UnallocateSplitElementCommand
Fields
| Field Name | Description |
|---|---|
action - String!
|
Use operation field, the operation field is an enumeration that makes it easier to query with |
approval - Approval
|
|
createdTimestamp - DateTime
|
|
element - SplitElement
|
|
id - ID!
|
|
inputJson - String
|
|
invalid - [CommandError]!
|
|
operation - Action!
|
|
state - CommandState!
|
|
step - String!
|
|
transaction - Transaction
|
|
user - String!
|
Use userInfo, as this only details the sub |
userInfo - UserInfo!
|
|
userInput - UnallocateSplitElementDetails
|
Example
{
"action": "xyz789",
"approval": Approval,
"createdTimestamp": "2007-12-03T10:15:30Z",
"element": SplitElement,
"id": "4",
"inputJson": "abc123",
"invalid": [CommandError],
"operation": "AGGREGATE_PAYMENT_EXECUTE",
"state": "SUBMITTED",
"step": "abc123",
"transaction": Transaction,
"user": "xyz789",
"userInfo": UserInfo,
"userInput": UnallocateSplitElementDetails
}
UnallocateSplitElementDetails
Fields
| Field Name | Description |
|---|---|
id - String
|
Example
{"id": "xyz789"}
UnallocateSplitElementInput
Fields
| Input Field | Description |
|---|---|
unallocatableSplitElementId - ID!
|
Unique id of the split element to be unallocated. |
Example
{"unallocatableSplitElementId": 4}
UnallocatedListSubscription
Types
| Union Types |
|---|
Example
ReceiptRemoved
UnallocatedReasonCode
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"MULTIPLE_DESTINATIONS"
UnincorporatedAssociationCreateDetails
Fields
| Field Name | Description |
|---|---|
alternateAddress - PartyCompanyAlternateAddress
|
|
associationType - UnincorporatedAssociationType
|
|
businessNumber - String
|
|
clientClassification - PartyNonIndividualClientClassification
|
|
countryOfEstablishment - String
|
|
customer - Identifier
|
|
customerNode - Customer
|
|
email - String
|
|
fullName - String
|
|
kycInformation - PartyKycInformation
|
|
reference - String
|
|
registeredOfficeAddress - PartyCompanyRegisteredOfficeAddress
|
|
roles - [String]
|
|
taxResidencies - [String]
|
|
workPhone - String
|
Example
{
"alternateAddress": PartyCompanyAlternateAddress,
"associationType": "UNINCORPORATED",
"businessNumber": "xyz789",
"clientClassification": "CHARITABLE_TRUST",
"countryOfEstablishment": "abc123",
"customer": Identifier,
"customerNode": Customer,
"email": "abc123",
"fullName": "abc123",
"kycInformation": PartyKycInformation,
"reference": "xyz789",
"registeredOfficeAddress": PartyCompanyRegisteredOfficeAddress,
"roles": ["xyz789"],
"taxResidencies": ["abc123"],
"workPhone": "xyz789"
}
UnincorporatedAssociationType
Values
| Enum Value | Description |
|---|---|
|
|
Example
"UNINCORPORATED"
UnionableDate
Fields
| Field Name | Description |
|---|---|
val - Date
|
Example
{"val": "2007-12-03"}
UnionableDateUnionableEnumUnion
Types
| Union Types |
|---|
Example
UnionableDate
UnionableEnum
Fields
| Field Name | Description |
|---|---|
val - String
|
Example
{"val": "xyz789"}
UnionableEnumUnionableStringUnion
Types
| Union Types |
|---|
Example
UnionableEnum
UnionableEnumWithholdingTaxNominatedAccountRecipientOriginUnion
Types
| Union Types |
|---|
Example
UnionableEnum
UnionableString
Fields
| Field Name | Description |
|---|---|
val - String
|
Example
{"val": "abc123"}
UnmatchMatchedReversalInput
Fields
| Input Field | Description |
|---|---|
matchedReversalId - ID!
|
The ID of the matched reversal |
Example
{"matchedReversalId": "4"}
UpdateAccountCommand
Fields
| Field Name | Description |
|---|---|
account - Account
|
|
action - String!
|
Use operation field, the operation field is an enumeration that makes it easier to query with |
approval - Approval
|
|
createdTimestamp - DateTime
|
|
id - ID!
|
|
inputJson - String
|
|
invalid - [CommandError]!
|
|
operation - Action!
|
|
state - CommandState!
|
|
step - String!
|
|
user - String!
|
Use userInfo, as this only details the sub |
userInfo - UserInfo!
|
|
userInput - UpdateAccountDetails
|
Example
{
"account": Account,
"action": "abc123",
"approval": Approval,
"createdTimestamp": "2007-12-03T10:15:30Z",
"id": 4,
"inputJson": "xyz789",
"invalid": [CommandError],
"operation": "AGGREGATE_PAYMENT_EXECUTE",
"state": "SUBMITTED",
"step": "abc123",
"user": "xyz789",
"userInfo": UserInfo,
"userInput": UpdateAccountDetails
}
UpdateAccountDetails
Fields
| Field Name | Description |
|---|---|
id - String
|
|
name - String
|
|
reference - UnionableEnumUnionableStringUnion
|
|
secondaryReference - UnionableEnumUnionableStringUnion
|
Example
{
"id": "xyz789",
"name": "abc123",
"reference": UnionableEnum,
"secondaryReference": UnionableEnum
}
UpdateAccountInput
Description
Options for updating account name and reference
Example
{
"accountId": "4",
"name": "xyz789",
"reference": "abc123",
"secondaryReference": "abc123"
}
UpdateAccountRestraintInput
Fields
| Input Field | Description |
|---|---|
accountId - ID!
|
|
block - BlockType!
|
Example
{"accountId": "4", "block": "NONE"}
UpdateCustomerAuthLinkInput
UpdateCustomerAutoSweepConfigInput
Fields
| Input Field | Description |
|---|---|
customerId - String!
|
|
autoSweepEnabled - Boolean!
|
|
autoSweepDetails - AutoSweepDetailsInput!
|
Example
{
"customerId": "xyz789",
"autoSweepEnabled": true,
"autoSweepDetails": AutoSweepDetailsInput
}
UpdateCustomerLinkedAccountInput
Description
Options for updating a customer linked account.
Example
{
"id": 4,
"accountName": "xyz789",
"accountHolder": "xyz789",
"description": "xyz789"
}
UpdateNamedRateInput
Description
Options when updating the value of an existing interest rate.
Example
{
"id": "4",
"startDate": "2007-12-03",
"rate": RateValue,
"margin": RateValue
}
UpdateProductStateInput
Fields
| Input Field | Description |
|---|---|
productId - ID!
|
|
state - ProductState!
|
Example
{"productId": "4", "state": "TEMPLATE"}
UpdateTieredNamedRateInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The id of the rate to be updated. |
startDate - Date!
|
The date the rate is effective from. |
tiers - [TierInput!]!
|
The tiers setup for this rate |
Example
{
"id": 4,
"startDate": "2007-12-03",
"tiers": [TierInput]
}
UserDefinedRecipientOrigin
Values
| Enum Value | Description |
|---|---|
|
|
Example
"USER_DEFINED"
UserInfo
UserInfoInput
UserWithScopes
Description
Description of a user.
Both name and displayName are optional as not all users have them. In particular API users will likely not have either.
Fields
| Field Name | Description |
|---|---|
name - String
|
Deprecated in favour of username |
username - String
|
|
displayName - String
|
|
sub - String
|
|
scopes - [String!]!
|
Possible Types
| UserWithScopes Types |
|---|
Example
{
"name": "xyz789",
"username": "abc123",
"displayName": "abc123",
"sub": "abc123",
"scopes": ["xyz789"]
}
VerificationStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NON_VERIFIED"
VerificationStatuses
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ESCALATE"
WithholdingTaxAU
Fields
| Field Name | Description |
|---|---|
current - CurrentWithholdingTaxAU
|
|
history - HistoryWithholdingTaxAUConnection
|
Example
{
"current": CurrentWithholdingTaxAU,
"history": HistoryWithholdingTaxAUConnection
}
WithholdingTaxAUEntry
Fields
| Field Name | Description |
|---|---|
effectiveTimestamp - DateTime!
|
|
nonResidentRate - RateValue!
|
|
resident - WithholdingTaxAUResident!
|
|
nominatedAccount - WithholdingTaxNominatedAccount!
|
|
financialYearStart - DateWithoutYear!
|
|
apcaId - String
|
Possible Types
| WithholdingTaxAUEntry Types |
|---|
Example
{
"effectiveTimestamp": "2007-12-03T10:15:30Z",
"nonResidentRate": RateValue,
"resident": WithholdingTaxAUResident,
"nominatedAccount": WithholdingTaxNominatedAccount,
"financialYearStart": DateWithoutYear,
"apcaId": "abc123"
}
WithholdingTaxAUInput
Fields
| Input Field | Description |
|---|---|
effectiveTimestamp - DateTime!
|
The timestamp from when the upsert takes effect |
nonResidentRate - String!
|
Non resident WHT rate |
resident - WithholdingTaxAUResidentInput!
|
WHT AU resident |
nominatedAccount - WithholdingTaxNominatedAccountInput!
|
Nominated account for WHT |
financialYearStart - DateWithoutYear!
|
Start date of the financial year |
apcaId - String
|
APCA Id |
Example
{
"effectiveTimestamp": "2007-12-03T10:15:30Z",
"nonResidentRate": "xyz789",
"resident": WithholdingTaxAUResidentInput,
"nominatedAccount": WithholdingTaxNominatedAccountInput,
"financialYearStart": DateWithoutYear,
"apcaId": "abc123"
}
WithholdingTaxAUResident
Fields
| Field Name | Description |
|---|---|
rate - RateValue!
|
|
medicareLevy - RateValue!
|
|
threshold - WithholdingTaxAUResidentThreshold!
|
Example
{
"rate": RateValue,
"medicareLevy": RateValue,
"threshold": WithholdingTaxAUResidentThreshold
}
WithholdingTaxAUResidentInput
Fields
| Input Field | Description |
|---|---|
rate - RateValue!
|
|
medicareLevy - RateValue!
|
|
threshold - WithholdingTaxAUResidentThresholdInput!
|
Example
{
"rate": RateValue,
"medicareLevy": RateValue,
"threshold": WithholdingTaxAUResidentThresholdInput
}
WithholdingTaxAUResidentThreshold
Fields
| Field Name | Description |
|---|---|
amount - AmountValue!
|
|
currency - CurrencyCode!
|
Example
{
"amount": AmountValue,
"currency": CurrencyCode
}
WithholdingTaxAUResidentThresholdInput
Fields
| Input Field | Description |
|---|---|
amount - AmountValue!
|
|
currency - CurrencyCode!
|
Example
{
"amount": AmountValue,
"currency": CurrencyCode
}
WithholdingTaxAccountRefund
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
account - Account!
|
|
customer - Customer!
|
|
source - Source!
|
|
valueDate - Date!
|
|
amount - Amount
|
|
failure - [CommandError!]
|
|
externalTransfer - PaymentOrPaymentRequest
|
|
events - [WithholdingTaxAccountRefundEvent!]
|
|
createdTimestamp - DateTime!
|
|
transactions - TransactionConnection!
|
Example
{
"id": 4,
"account": Account,
"customer": Customer,
"source": Source,
"valueDate": "2007-12-03",
"amount": Amount,
"failure": [CommandError],
"externalTransfer": Payment,
"events": [WithholdingTaxAccountRefundEvent],
"createdTimestamp": "2007-12-03T10:15:30Z",
"transactions": TransactionConnection
}
WithholdingTaxAccountRefundEvent
WithholdingTaxAccountRefundFilter
Fields
| Input Field | Description |
|---|---|
amount - AmountFilter
|
Example
{"amount": AmountFilter}
WithholdingTaxConfig
Fields
| Field Name | Description |
|---|---|
au - WithholdingTaxAU
|
Example
{"au": WithholdingTaxAU}
WithholdingTaxNominatedAccount
Fields
| Field Name | Description |
|---|---|
name - String!
|
|
accountNumber - AccountNumber!
|
|
bankCode - BankCode!
|
Example
{
"name": "xyz789",
"accountNumber": "000000012345",
"bankCode": BankCode
}
WithholdingTaxNominatedAccountDebtorOrigin
Fields
| Field Name | Description |
|---|---|
withholdingTaxTimestamp - DateTime
|
Example
{
"withholdingTaxTimestamp": "2007-12-03T10:15:30Z"
}
WithholdingTaxNominatedAccountInput
Fields
| Input Field | Description |
|---|---|
name - String!
|
|
accountNumber - AccountNumber!
|
|
bankCode - BankCode!
|
Example
{
"name": "xyz789",
"accountNumber": "000000012345",
"bankCode": BankCode
}
WithholdingTaxNominatedAccountRecipientOrigin
Fields
| Field Name | Description |
|---|---|
withholdingTaxTimestamp - DateTime
|
Example
{
"withholdingTaxTimestamp": "2007-12-03T10:15:30Z"
}
WithinTierNamedRateEntry
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
currency - CurrencyCode!
|
|
startDate - Date!
|
|
namedRate - NamedRate!
|
|
tiers - [Tier!]!
|
Example
{
"id": 4,
"name": "abc123",
"currency": CurrencyCode,
"startDate": "2007-12-03",
"namedRate": NamedRate,
"tiers": [Tier]
}
WithinTierNamedRateInput
Fields
| Input Field | Description |
|---|---|
name - String!
|
The name for the rate. |
currency - CurrencyCode!
|
The ISO currency code the rate is effective for. |
startDate - Date!
|
The date the rate is effective from. |
customerId - ID
|
Id of a customer the rate is created on behalf of. If provided the customer will have permission to maintain future values of the rate. |
tiers - [TierInput!]!
|
The tiers setup for this rate |
Example
{
"name": "xyz789",
"currency": CurrencyCode,
"startDate": "2007-12-03",
"customerId": 4,
"tiers": [TierInput]
}
Year
Description
Year in ISO 8601 format.
Example
Year