OBJECT
BankAccount

A bank account.
GraphQL Schema definition

type BankAccount implements AddressableInterface, NoteableInterface, LoggableInterface, AccessloggableInterface {
#   The ID of the entity.
id: Int64Bit! 
#   An ID that uniquely identifies this entity across the whole Sonar system.
sonar_unique_id: ID! 
#   The date and time this entity was created.
created_at: Datetime! 
#   The last date and time this entity was modified.
updated_at: Datetime! 
#   A string that shows the version of this entity. It will be incremented whenever 
#   the entity is modified.
_version: String! 
#   The ID of an Account.
account_id: Int64Bit! 
#   Whether or not this payment method is enabled for automatic payments.
auto: Boolean! 
#   The ID of a BankProcessor.
bank_account_processor_id: Int64Bit! 
#   The type of bank account this is.
bank_account_type: BankAccountType! 
#   The profile ID provided by a credit card processing service.
customer_profile_id: String 
#   A partial account number that can be used for identification.
masked_account_number: String! 
#   The name on the account.
name_on_account: String 
#   The bank routing number.
routing_number: String 
#   The tokenized value that represents a credit card, provided by a credit card 
#   processing service.
token: String 
#   The tokenized credit card ID
token_id: String 
#   A customer account.
# 
# Arguments
#   id: The ID of the entity.
#   sonar_unique_id: An ID that uniquely identifies this entity 
#   across the whole Sonar system.
#   created_at: The date and time this entity was created.
#   updated_at: The last date and time this entity was modified.
#   _version: A string that shows the version of this entity. It 
#   will be incremented whenever the entity is modified.
#   account_status_id: The ID of an AccountStatus.
#   account_type_id: The ID of an AccountType.
#   activation_date: The date an account was first activated.
#   activation_time: The time an account was first activated.
#   archived_at: The date and time this entity was archived.
#   archived_by_user_id: The ID of the `User` that archived this 
#   entity.
#   company_id: The ID of the company that this entity operates 
#   under.
#   data_usage_percentage: The percentage of the data usage cap 
#   that this account has consumed this month, taking into account any data usage 
#   top offs.
#   disconnection_reason_id: Disconnection Reason ID
#   geopoint: A geo-point.
#   is_delinquent: Whether or not this account is delinquent.
#   is_eligible_for_archive: Whether or not the Account meets the 
#   eligibility criteria for archiving.
#   name: A descriptive name.
#   next_bill_date: The next date this service will bill. If this 
#   is null, it will bill on the next account billing date.
#   next_recurring_charge_amount: The next recurring charge amount 
#   for an account. This is the sum of data, expiring, recurring, and voice services 
#   of an account for this billing cycle, including tax.
#   parent_account_id: The ID of the `Account` that is this 
#   `Account`s master.
#   include_archived: Whether or not to include archived entities 
#   in the results.
#   paginator: Provides the ability to paginate through results.
#   sorter: Provides the ability to sort results.
#   search: Complex search parameters.
#   general_search: Search across all string fields with partial 
#   matching.
#   aggregation: Provides the ability to return aggregated 
#   mathematical data about your results.
#   reverse_relation_filters: Reverse relation filters allow you to 
#   filter the result of a relation, and use that filter to affect the returned root 
#   elements.
account(
id: Int64Bit,
sonar_unique_id: ID,
created_at: Datetime,
updated_at: Datetime,
_version: String,
account_status_id: Int64Bit,
account_type_id: Int64Bit,
activation_date: Date,
activation_time: Time,
archived_at: Datetime,
archived_by_user_id: Int64Bit,
company_id: Int64Bit,
data_usage_percentage: Int,
disconnection_reason_id: Int64Bit,
geopoint: Geopoint,
is_delinquent: Boolean,
is_eligible_for_archive: Boolean,
name: String,
next_bill_date: Date,
next_recurring_charge_amount: Int,
parent_account_id: Int64Bit,
include_archived: Boolean,
paginator: Paginator,
sorter: [Sorter],
search: [Search],
general_search: String,
aggregation: [Aggregator],
reverse_relation_filters: [ReverseRelationFilter]
): Account 
#   A processor or method of processing bank account payments.
# 
# Arguments
#   id: The ID of the entity.
#   sonar_unique_id: An ID that uniquely identifies this entity 
#   across the whole Sonar system.
#   created_at: The date and time this entity was created.
#   updated_at: The last date and time this entity was modified.
#   _version: A string that shows the version of this entity. It 
#   will be incremented whenever the entity is modified.
#   enabled: Whether or not this is enabled.
#   primary: Whether or not this is the primary type of entity.
#   provider: The provider for this processor.
#   paginator: Provides the ability to paginate through results.
#   sorter: Provides the ability to sort results.
#   search: Complex search parameters.
#   general_search: Search across all string fields with partial 
#   matching.
#   aggregation: Provides the ability to return aggregated 
#   mathematical data about your results.
#   reverse_relation_filters: Reverse relation filters allow you to 
#   filter the result of a relation, and use that filter to affect the returned root 
#   elements.
bank_account_processor(
id: Int64Bit,
sonar_unique_id: ID,
created_at: Datetime,
updated_at: Datetime,
_version: String,
enabled: Boolean,
primary: Boolean,
provider: BankAccountProvider,
paginator: Paginator,
sorter: [Sorter],
search: [Search],
general_search: String,
aggregation: [Aggregator],
reverse_relation_filters: [ReverseRelationFilter]
): BankAccountProcessor 
#   A geographical address.
# 
# Arguments
#   id: The ID of the entity.
#   sonar_unique_id: An ID that uniquely identifies this entity 
#   across the whole Sonar system.
#   created_at: The date and time this entity was created.
#   updated_at: The last date and time this entity was modified.
#   _version: A string that shows the version of this entity. It 
#   will be incremented whenever the entity is modified.
#   address_status_id: Address status ID.
#   addressable_id: The ID of the entity that owns this address.
#   addressable_type: The type of entity that owns this address.
#   anchor_address_id: The address ID for the Anchor address
#   attainable_download_speed: The attainable download speed in 
#   kilobits per second.
#   attainable_upload_speed: The attainable upload speed in 
#   kilobits per second.
#   avalara_pcode: Avalara PCode.
#   billing_default_id: The ID of a BillingDefault.
#   census_year: The year used for calculating fips and census 
#   tract information.
#   city: A city.
#   country: A two character country code.
#   county: A US county. Only used for US addresses.
#   fips: Only used in the USA, this is the census tract 
#   information used for calculating things like FCC Form 477.
#   fips_source: Identifies the source used to obtain the FIPS code
#   is_anchor: Whether or not this address is an anchor
#   latitude: A decimal latitude.
#   line1: Address line 1.
#   line2: Address line 2.
#   longitude: A decimal longitude.
#   serviceable: Whether or not the address is serviceable, and can 
#   be used for new accounts.
#   subdivision: A state, province, or other country subdivision.
#   timezone: The timezone you want times in the system displayed 
#   in.
#   type: The type.
#   zip: A ZIP or postal code.
#   paginator: Provides the ability to paginate through results.
#   sorter: Provides the ability to sort results.
#   search: Complex search parameters.
#   general_search: Search across all string fields with partial 
#   matching.
#   aggregation: Provides the ability to return aggregated 
#   mathematical data about your results.
#   reverse_relation_filters: Reverse relation filters allow you to 
#   filter the result of a relation, and use that filter to affect the returned root 
#   elements.
addresses(
id: Int64Bit,
sonar_unique_id: ID,
created_at: Datetime,
updated_at: Datetime,
_version: String,
address_status_id: Int64Bit,
addressable_id: Int64Bit,
addressable_type: AddressableType,
anchor_address_id: Int64Bit,
attainable_download_speed: Int,
attainable_upload_speed: Int,
avalara_pcode: String,
billing_default_id: Int64Bit,
census_year: Int,
city: String,
country: Country,
county: UsCounty,
fips: String,
fips_source: FipsSource,
is_anchor: Boolean,
latitude: Latitude,
line1: String,
line2: String,
longitude: Longitude,
serviceable: Boolean,
subdivision: Subdivision,
timezone: Timezone,
type: AddressType,
zip: String,
paginator: Paginator,
sorter: [Sorter],
search: [Search],
general_search: String,
aggregation: [Aggregator],
reverse_relation_filters: [ReverseRelationFilter]
): AddressConnection! 
#   A note.
# 
# Arguments
#   id: The ID of the entity.
#   sonar_unique_id: An ID that uniquely identifies this entity 
#   across the whole Sonar system.
#   created_at: The date and time this entity was created.
#   updated_at: The last date and time this entity was modified.
#   _version: A string that shows the version of this entity. It 
#   will be incremented whenever the entity is modified.
#   message: The message.
#   noteable_id: The ID of the entity that owns this note.
#   noteable_type: The type of entity that owns this note.
#   priority: The priority of this item.
#   user_id: The ID of a User.
#   paginator: Provides the ability to paginate through results.
#   sorter: Provides the ability to sort results.
#   search: Complex search parameters.
#   general_search: Search across all string fields with partial 
#   matching.
#   aggregation: Provides the ability to return aggregated 
#   mathematical data about your results.
#   reverse_relation_filters: Reverse relation filters allow you to 
#   filter the result of a relation, and use that filter to affect the returned root 
#   elements.
notes(
id: Int64Bit,
sonar_unique_id: ID,
created_at: Datetime,
updated_at: Datetime,
_version: String,
message: Text,
noteable_id: Int64Bit,
noteable_type: NoteableType,
priority: NotePriority,
user_id: Int64Bit,
paginator: Paginator,
sorter: [Sorter],
search: [Search],
general_search: String,
aggregation: [Aggregator],
reverse_relation_filters: [ReverseRelationFilter]
): NoteConnection! 
#   A log entry.
# 
# Arguments
#   id: The ID of the entity.
#   sonar_unique_id: An ID that uniquely identifies this entity 
#   across the whole Sonar system.
#   created_at: The date and time this entity was created.
#   updated_at: The last date and time this entity was modified.
#   _version: A string that shows the version of this entity. It 
#   will be incremented whenever the entity is modified.
#   current: Current data.
#   legacy: Whether or not this log was transferred from a Sonar v1 
#   instance. If so, the formatting will not match current version logs.
#   legacy_title: A title which is only populated on logs that were 
#   imported from Sonar v1.
#   level: The severity level.
#   loggable_id: The ID of the entity that this log is attached to.
#   loggable_type: The type of entity that this log is attached to.
#   logged_entity_id: The entity ID that triggered the log.
#   logged_entity_type: The entity that triggered the log.
#   message: The message.
#   previous: Previous data.
#   relation_data: Data from objects related to this change.
#   type: The type.
#   user_id: The ID of a User.
#   paginator: Provides the ability to paginate through results.
#   sorter: Provides the ability to sort results.
#   search: Complex search parameters.
#   general_search: Search across all string fields with partial 
#   matching.
#   aggregation: Provides the ability to return aggregated 
#   mathematical data about your results.
#   reverse_relation_filters: Reverse relation filters allow you to 
#   filter the result of a relation, and use that filter to affect the returned root 
#   elements.
logs(
id: Int64Bit,
sonar_unique_id: ID,
created_at: Datetime,
updated_at: Datetime,
_version: String,
current: Text,
legacy: Boolean,
legacy_title: String,
level: LogLevel,
loggable_id: Int64Bit,
loggable_type: String,
logged_entity_id: Int64Bit,
logged_entity_type: String,
message: Text,
previous: Text,
relation_data: Text,
type: LogType,
user_id: Int64Bit,
paginator: Paginator,
sorter: [Sorter],
search: [Search],
general_search: String,
aggregation: [Aggregator],
reverse_relation_filters: [ReverseRelationFilter]
): LogConnection! 
#   An access log history on an entity.
# 
# Arguments
#   id: The ID of the entity.
#   sonar_unique_id: An ID that uniquely identifies this entity 
#   across the whole Sonar system.
#   created_at: The date and time this entity was created.
#   updated_at: The last date and time this entity was modified.
#   _version: A string that shows the version of this entity. It 
#   will be incremented whenever the entity is modified.
#   access_datetime: The date and time that this entity was 
#   accessed.
#   accessloggable_id: The ID of the entity that this access log 
#   belongs to.
#   accessloggable_type: The entity that this access log belongs 
#   to.
#   entity_id: The ID of the entity that this access log belongs 
#   to.
#   entity_name: The entity that this access log belongs to.
#   user_id: The ID of the user that accessed this entity.
#   paginator: Provides the ability to paginate through results.
#   sorter: Provides the ability to sort results.
#   search: Complex search parameters.
#   general_search: Search across all string fields with partial 
#   matching.
#   aggregation: Provides the ability to return aggregated 
#   mathematical data about your results.
#   reverse_relation_filters: Reverse relation filters allow you to 
#   filter the result of a relation, and use that filter to affect the returned root 
#   elements.
access_logs(
id: Int64Bit,
sonar_unique_id: ID,
created_at: Datetime,
updated_at: Datetime,
_version: String,
access_datetime: Datetime,
accessloggable_id: Int64Bit,
accessloggable_type: String,
entity_id: Int64Bit,
entity_name: String,
user_id: Int64Bit,
paginator: Paginator,
sorter: [Sorter],
search: [Search],
general_search: String,
aggregation: [Aggregator],
reverse_relation_filters: [ReverseRelationFilter]
): AccessLogConnection! 
#   A payment.
# 
# Arguments
#   id: The ID of the entity.
#   sonar_unique_id: An ID that uniquely identifies this entity 
#   across the whole Sonar system.
#   created_at: The date and time this entity was created.
#   updated_at: The last date and time this entity was modified.
#   _version: A string that shows the version of this entity. It 
#   will be incremented whenever the entity is modified.
#   account_id: The ID of an Account.
#   amount: The amount of the payment, in the smallest currency 
#   value.
#   amount_remaining: The amount remaining that can be used.
#   bank_account_id: The ID of a BankAccount.
#   company_id: The ID of the company that this entity operates 
#   under.
#   creation_token: A token sent to the payment provider during 
#   payment creation.
#   credit_card_id: The ID of a CreditCard.
#   deposit_slip_id: The deposit slip ID.
#   description: A description of the payment, used for internal 
#   reference.
#   fee: The fee for this transaction.
#   fractional_fee: The fee for this transaction in fractional 
#   cents
#   full_processor_response: The entire response back from the 
#   company that processed the transaction. Not typically human readable.
#   is_autopay: Whether or not this was an autopay payment.
#   passed_3ds_check: Whether or not this payment passed the 3DS 
#   security check.
#   passed_avs_check: Whether or not this payment passed the AVS 
#   security check.
#   passed_cvv_check: Whether or not this payment passed the CVV 
#   security check.
#   payment_datetime: The date and time the payment was made.
#   payment_tracker_id: The unique tracking ID for this payment.
#   payment_type: The type of payment (e.g. cash, credit card.)
#   processor_message: The message returned back from the company 
#   that processed the transaction.
#   processor_status: The status of the payment provided by the 
#   payment processor.
#   reference: A payment reference like a check number, or wire 
#   transfer confirmation number.
#   status: The status.
#   successful: Whether or not this was successful.
#   transaction_id: The transaction ID from the credit card 
#   provider.
#   user_id: The ID of a User.
#   paginator: Provides the ability to paginate through results.
#   sorter: Provides the ability to sort results.
#   search: Complex search parameters.
#   general_search: Search across all string fields with partial 
#   matching.
#   aggregation: Provides the ability to return aggregated 
#   mathematical data about your results.
#   reverse_relation_filters: Reverse relation filters allow you to 
#   filter the result of a relation, and use that filter to affect the returned root 
#   elements.
payments(
id: Int64Bit,
sonar_unique_id: ID,
created_at: Datetime,
updated_at: Datetime,
_version: String,
account_id: Int64Bit,
amount: Int,
amount_remaining: Int,
bank_account_id: Int64Bit,
company_id: Int64Bit,
creation_token: String,
credit_card_id: Int64Bit,
deposit_slip_id: Int64Bit,
description: String,
fee: Int,
fractional_fee: Int,
full_processor_response: String,
is_autopay: Boolean,
passed_3ds_check: Boolean,
passed_avs_check: Boolean,
passed_cvv_check: Boolean,
payment_datetime: Datetime,
payment_tracker_id: String,
payment_type: PaymentType,
processor_message: String,
processor_status: String,
reference: String,
status: PaymentStatus,
successful: Boolean,
transaction_id: String,
user_id: Int64Bit,
paginator: Paginator,
sorter: [Sorter],
search: [Search],
general_search: String,
aggregation: [Aggregator],
reverse_relation_filters: [ReverseRelationFilter]
): PaymentConnection! 
}
BankAccount

link GraphQL Schema definition

link Require by

GraphQL Schema definition

Require by
