OBJECT
Payment
A payment.
link GraphQL Schema definition
- type Payment implements CreditableInterface, DisbursableInterface, LoggableInterface, AccessloggableInterface {
- # The ID of the entity.
- Int64Bit! :
- # An ID that uniquely identifies this entity across the whole Sonar system.
- ID! :
- # The date and time this entity was created.
- Datetime! :
- # The last date and time this entity was modified.
- Datetime! :
- # A string that shows the version of this entity. It will be incremented whenever
- # the entity is modified.
- String! :
- # The ID of an Account.
- Int64Bit! :
- # The amount of the payment, in the smallest currency value.
- Int! :
- # The amount remaining that can be used.
- Int! :
- # The ID of a BankAccount.
- Int64Bit :
- # The ID of the company that this entity operates under.
- Int64Bit! :
- # A token sent to the payment provider during payment creation.
- String :
- # The ID of a CreditCard.
- Int64Bit :
- # The deposit slip ID.
- Int64Bit :
- # A description of the payment, used for internal reference.
- String :
- # The fee for this transaction.
- Int :
- # The fee for this transaction in fractional cents
- Int :
- # The entire response back from the company that processed the transaction. Not
- # typically human readable.
- String :
- # Whether or not this payment passed the 3DS security check.
- Boolean :
- # Whether or not this payment passed the AVS security check.
- Boolean :
- # Whether or not this payment passed the CVV security check.
- Boolean :
- # The date and time the payment was made.
- Datetime! :
- # The unique tracking ID for this payment.
- String :
- # The type of payment (e.g. cash, credit card.)
- PaymentType! :
- # The message returned back from the company that processed the transaction.
- String :
- # The status of the payment provided by the payment processor.
- String :
- # A payment reference like a check number, or wire transfer confirmation number.
- String :
- # The status.
- PaymentStatus :
- # Whether or not this was successful.
- Boolean! :
- # The transaction ID from the credit card provider.
- String :
- # The ID of a User.
- Int64Bit :
- # A credit card.
- #
- # 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.
- # auto: Whether or not this payment method is enabled for
- # automatic payments.
- # credit_card_processor_id: The ID of a CreditCardProcessor.
- # credit_card_type: The type of a credit card (e.g. Visa,
- # Mastercard.)
- # customer_profile_id: The profile ID provided by a credit card
- # processing service.
- # expiration_month: The month the credit card expires.
- # expiration_year: The year the credit card expires.
- # masked_number: A partial credit card number that can be used
- # for identification.
- # name_on_card: The name on the credit card.
- # token: The tokenized value that represents a credit card,
- # provided by a credit card processing service.
- # 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.
- (
- Int64Bit, :
- ID, :
- Datetime, :
- Datetime, :
- String, :
- Int64Bit, :
- Boolean, :
- Int64Bit, :
- CreditCardType, :
- String, :
- Int, :
- Int, :
- String, :
- String, :
- String, :
- Paginator, :
- Sorter], : [
- Search], : [
- String, :
- Aggregator], : [
- ReverseRelationFilter] : [
- ): CreditCard
- # A bank 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_id: The ID of an Account.
- # auto: Whether or not this payment method is enabled for
- # automatic payments.
- # bank_account_processor_id: The ID of a BankProcessor.
- # bank_account_type: The type of bank account this is.
- # customer_profile_id: The profile ID provided by a credit card
- # processing service.
- # masked_account_number: A partial account number that can be
- # used for identification.
- # name_on_account: The name on the account.
- # routing_number: The bank routing number.
- # token: The tokenized value that represents a credit card,
- # provided by a credit card processing service.
- # 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.
- (
- Int64Bit, :
- ID, :
- Datetime, :
- Datetime, :
- String, :
- Int64Bit, :
- Boolean, :
- Int64Bit, :
- BankAccountType, :
- String, :
- String, :
- String, :
- String, :
- String, :
- Paginator, :
- Sorter], : [
- Search], : [
- String, :
- Aggregator], : [
- ReverseRelationFilter] : [
- ): BankAccount
- # 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.
- # 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.
- # geopoint: A geo-point.
- # is_delinquent: Whether or not this account is delinquent.
- # 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.
- # 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.
- (
- Int64Bit, :
- ID, :
- Datetime, :
- Datetime, :
- String, :
- Int64Bit, :
- Int64Bit, :
- Date, :
- Time, :
- Int64Bit, :
- Int, :
- Geopoint, :
- Boolean, :
- String, :
- Date, :
- Int, :
- Int64Bit, :
- Paginator, :
- Sorter], : [
- Search], : [
- String, :
- Aggregator], : [
- ReverseRelationFilter] : [
- ): Account
- # A company you do business as.
- #
- # 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.
- # billing_communication_delay_end_local_time: The daily end time
- # of the period during which billing communication e.g. new invoices, delinquency,
- # etc. will not be sent.
- # billing_communication_delay_start_local_time: The daily start
- # time of the period during which billing communication e.g. new invoices,
- # delinquency, etc. will not be sent.
- # checks_payable_to: On an enabled remittance slip, who should
- # checks be made payable to?
- # country: A two character country code.
- # customer_portal_url: The URL to your customer portal.
- # default: Whether or not this entity is a default entry.
- # enabled: Whether or not this is enabled.
- # isp_type: The ISP type of this `Company`.
- # name: A descriptive name.
- # phone_number: A telephone number.
- # primary_color: The primary color to use in Sonar.
- # secondary_color: The secondary color to use in Sonar.
- # show_remittance_slip: Whether or not to include a detachable
- # remittance slip on the invoice.
- # tax_identification: A tax identification number. Should only be
- # entered if you are required to share some type of tax identification information
- # with your customers.
- # website_address: The address of the company website.
- # 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.
- (
- Int64Bit, :
- ID, :
- Datetime, :
- Datetime, :
- String, :
- Time, :
- Time, :
- String, :
- Country, :
- URL, :
- Boolean, :
- Boolean, :
- IspType, :
- String, :
- Numeric, :
- HtmlHexColor, :
- HtmlHexColor, :
- Boolean, :
- String, :
- URL, :
- Paginator, :
- Sorter], : [
- Search], : [
- String, :
- Aggregator], : [
- ReverseRelationFilter] : [
- ): Company
- # A deposit slip.
- #
- # 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.
- # bank_account_line: The bank account name/number
- # date: A date
- # memo: The memo.
- # 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.
- (
- Int64Bit, :
- ID, :
- Datetime, :
- Datetime, :
- String, :
- String, :
- Date, :
- String, :
- Paginator, :
- Sorter], : [
- Search], : [
- String, :
- Aggregator], : [
- ReverseRelationFilter] : [
- ): DepositSlip
- # The application of a `Discount` or `Payment` against an `Invoice`.
- #
- # 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, in the smallest currency value (e.g. cents,
- # pence, pesos.)
- # creditable_id: The ID the transaction that created this credit.
- # creditable_type: The type of transaction that created this
- # credit.
- # invoice_id: The ID of an `Invoice`.
- # void: Whether or not this entity has been voided.
- # voided_at: When this was voided.
- # 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.
- (
- Int64Bit, :
- ID, :
- Datetime, :
- Datetime, :
- String, :
- Int64Bit, :
- Int, :
- Int64Bit, :
- CreditableType, :
- Int64Bit, :
- Boolean, :
- Datetime, :
- Paginator, :
- Sorter], : [
- Search], : [
- String, :
- Aggregator], : [
- ReverseRelationFilter] : [
- ): CreditConnection!
- # 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.
- (
- Int64Bit, :
- ID, :
- Datetime, :
- Datetime, :
- String, :
- Int, :
- Int, :
- Int64Bit, :
- DisbursableType, :
- Int64Bit, :
- DisbursementDetailEvent, :
- String, :
- Int, :
- Int, :
- Boolean, :
- String, :
- Paginator, :
- Sorter], : [
- Search], : [
- String, :
- Aggregator], : [
- ReverseRelationFilter] : [
- ): DisbursementDetailConnection!
- # 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.
- (
- Int64Bit, :
- ID, :
- Datetime, :
- Datetime, :
- String, :
- Text, :
- Boolean, :
- String, :
- LogLevel, :
- Int64Bit, :
- String, :
- Int64Bit, :
- String, :
- Text, :
- Text, :
- Text, :
- LogType, :
- Int64Bit, :
- Paginator, :
- Sorter], : [
- Search], : [
- String, :
- Aggregator], : [
- 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.
- (
- Int64Bit, :
- ID, :
- Datetime, :
- Datetime, :
- String, :
- Datetime, :
- Int64Bit, :
- String, :
- Int64Bit, :
- String, :
- Int64Bit, :
- Paginator, :
- Sorter], : [
- Search], : [
- String, :
- Aggregator], : [
- ReverseRelationFilter] : [
- ): AccessLogConnection!
- # A record a `Payment` reversal.
- #
- # 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.)
- # description: A human readable description.
- # payment_id: The ID of a `Payment`.
- # 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.
- (
- Int64Bit, :
- ID, :
- Datetime, :
- Datetime, :
- String, :
- Int, :
- String, :
- Int64Bit, :
- Int64Bit, :
- Paginator, :
- Sorter], : [
- Search], : [
- String, :
- Aggregator], : [
- ReverseRelationFilter] : [
- ): ReversedPaymentConnection!
- # A record of a refund applied to 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.
- # amount: The amount, in the smallest currency value (e.g. cents,
- # pence, pesos.)
- # description: A human readable description.
- # payment_id: The ID of a `Payment`.
- # payment_tracker_id: The unique tracking ID for this payment.
- # processor_response_message: The response from the payment
- # processor when this payment was submitted.
- # 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.
- (
- Int64Bit, :
- ID, :
- Datetime, :
- Datetime, :
- String, :
- Int, :
- String, :
- Int64Bit, :
- String, :
- String, :
- String, :
- Int64Bit, :
- Paginator, :
- Sorter], : [
- Search], : [
- String, :
- Aggregator], : [
- ReverseRelationFilter] : [
- ): RefundedPaymentConnection!
- # A record of a `Payment` that was voided.
- #
- # 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.)
- # description: A human readable description.
- # payment_id: The ID of a `Payment`.
- # payment_tracker_id: The unique tracking ID for this payment.
- # processor_response_message: The response from the payment
- # processor when this payment was submitted.
- # 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.
- (
- Int64Bit, :
- ID, :
- Datetime, :
- Datetime, :
- String, :
- Int, :
- String, :
- Int64Bit, :
- String, :
- String, :
- String, :
- Int64Bit, :
- Paginator, :
- Sorter], : [
- Search], : [
- String, :
- Aggregator], : [
- ReverseRelationFilter] : [
- ): VoidedPaymentConnection!
- # A dispute.
- #
- # 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.)
- # case_id: The dispute's case ID.
- # cycle: The current dispute cycle.
- # dispute_date: The date the dispute was issued.
- # external_id: The payment processor's external ID.
- # payment_id: The ID of a `Payment`.
- # reason: The reason.
- # reply_by_date: The date the dispute must be replied to by.
- # status: The status.
- # 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.
- (
- Int64Bit, :
- ID, :
- Datetime, :
- Datetime, :
- String, :
- Int, :
- String, :
- String, :
- Date, :
- String, :
- Int64Bit, :
- Text, :
- Date, :
- DisputeStatus, :
- Paginator, :
- Sorter], : [
- Search], : [
- String, :
- Aggregator], : [
- ReverseRelationFilter] : [
- ): DisputeConnection!
- }