OBJECT

VoidedPayment

A record of a Payment that was voided.

link GraphQL Schema definition

  • type VoidedPayment implements DisbursableInterface, 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 amount, in the smallest currency value (e.g. cents, pence, pesos.)
  • amount: Int!
  • # A human readable description.
  • description: String
  • # The ID of a `Payment`.
  • payment_id: Int64Bit!
  • # The unique tracking ID for this payment.
  • payment_tracker_id: String
  • # The response from the payment processor when this payment was submitted.
  • processor_response_message: String
  • # The transaction ID from the credit card provider.
  • transaction_id: String
  • # The ID of a User.
  • user_id: Int64Bit
  • # 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.
  • # 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.
  • # 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.
  • payment(
  • 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,
  • 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,
  • successful: Boolean,
  • transaction_id: String,
  • user_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): Payment
  • # A user that can login to Sonar.
  • #
  • # 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.
  • # completed_setup: Whether or not the user has completed the
  • # setup process.
  • # email_address: An email address.
  • # enabled: Whether or not this is enabled.
  • # is_sonar_staff: Whether or not this user is a Sonar employee.
  • # language: A supported language.
  • # mobile_number: A mobile phone number. This will be used to send
  • # SMS messages.
  • # name: A descriptive name.
  • # public_name: The publicly viewable name of this user.
  • # role_id: The ID of a Role.
  • # super_admin: Super admins receive all system permissions
  • # automatically, regardless of their role.
  • # username: A username, used for authentication.
  • # 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.
  • user(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • completed_setup: Boolean,
  • email_address: EmailAddress,
  • enabled: Boolean,
  • is_sonar_staff: Boolean,
  • language: Language,
  • mobile_number: Numeric,
  • name: String,
  • public_name: String,
  • role_id: Int64Bit,
  • super_admin: Boolean,
  • username: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): User
  • # A disbursement detail.
  • #
  • # 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.
  • # amount: The amount, in the smallest currency value (e.g. cents,
  • # pence, pesos.)
  • # amount_used: The amount used.
  • # disbursable_id: The id of the entity that the disbusement
  • # applies to.
  • # disbursable_type: The type of entity that the disbursement
  • # applies to.
  • # disbursement_id: The ID of a `Disbursement`.
  • # event: The event associated with the disbursement detail
  • # record.
  • # external_id: The payment processor's external ID.
  • # fractional_amount: The fractional portion of the amount.
  • # fractional_amount_used: The fractional portion of the amount
  • # used.
  • # is_fee: Whether or not this record is a fee.
  • # transaction_id: The transaction ID from the credit card
  • # provider.
  • # 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.
  • disbursement_details(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • amount: Int,
  • amount_used: Int,
  • disbursable_id: Int64Bit,
  • disbursable_type: DisbursableType,
  • disbursement_id: Int64Bit,
  • event: DisbursementDetailEvent,
  • external_id: String,
  • fractional_amount: Int,
  • fractional_amount_used: Int,
  • is_fee: Boolean,
  • transaction_id: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): DisbursementDetailConnection!
  • # 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!
  • }