OBJECT
Disbursement
A disbursement.
link GraphQL Schema definition
- type Disbursement implements NoteableInterface, 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 amount, in the smallest currency value (e.g. cents, pence, pesos.)
- : Int!
- # The bank account.
- : String
- # The ID of a BankProcessor.
- : Int64Bit
- # The ID of a CreditCardProcessor.
- : Int64Bit
- # The payment processor's external ID.
- : String!
- # The sonarPay Merchant ID
- : String
- # The date and time this entity was processed.
- : Datetime
- # The disbursement payout schedule.
- : DisbursementSchedule
- # The amount scheduled for payout.
- : Int
- # The disbursement payout scheduling factor.
- : Int
- # The unit of measurement for this disbursement's payout amount.
- : SonarPayUnit
- # The status.
- : DisbursementStatus!
- # 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.
- # fee_amount: The amount for this fee.
- # fee_unit: The unit of measurement for this fee's amount.
- # fractional_amount: The fractional portion of the amount.
- # fractional_amount_used: The fractional portion of the amount
- # used.
- # interchange_flat_rate_fee: The portion of the interchange fee
- # that is a fixed amount. This is stored as the smallest currency value (e.g.
- # cents, pence, pesos.).
- # interchange_percent_fee: The portion of the interchange fee
- # that is based on a percentage of the transaction amount. This is stored as basis
- # points (e.g. 260 represents 2.6%).
- # interchange_type: The name of the interchange fee type.
- # 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,
- : SonarPayUnit,
- : Int,
- : Int,
- : Int,
- : Int,
- : String,
- : Boolean,
- : String,
- : Paginator,
- : [Sorter],
- : [Search],
- : String,
- : [Aggregator],
- : [ReverseRelationFilter]
- ): DisbursementDetailConnection!
- # 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.
- (
- : Int64Bit,
- : ID,
- : Datetime,
- : Datetime,
- : String,
- : Boolean,
- : Boolean,
- : BankAccountProvider,
- : Paginator,
- : [Sorter],
- : [Search],
- : String,
- : [Aggregator],
- : [ReverseRelationFilter]
- ): BankAccountProcessor
- # A company that processes `CreditCard` transactions.
- #
- # 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.
- # amex: American Express.
- # dankort: Dankort.
- # dinersclub: Diner's Club.
- # discover: Discover.
- # enabled: Whether or not this is enabled.
- # forbrugsforeningen: Forbrugsforeningen.
- # jcb: JCB
- # maestro: Maestro.
- # mastercard: MasterCard.
- # moto_enabled: Enables processor specific `Mail Or Telephone
- # Order` functionality. Currently only applicable for `Stripe`.
- # primary: Whether or not this is the primary type of entity.
- # provider: The company that provides credit card processing
- # services.
- # unionpay: Union Pay.
- # visa: Visa
- # visaelectron: VISA Electron.
- # 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,
- : Boolean,
- : Boolean,
- : Boolean,
- : Boolean,
- : Boolean,
- : Boolean,
- : Boolean,
- : Boolean,
- : Boolean,
- : Boolean,
- : Boolean,
- : CreditCardProvider,
- : Boolean,
- : Boolean,
- : Boolean,
- : Paginator,
- : [Sorter],
- : [Search],
- : String,
- : [Aggregator],
- : [ReverseRelationFilter]
- ): CreditCardProcessor
- # 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.
- (
- : Int64Bit,
- : ID,
- : Datetime,
- : Datetime,
- : String,
- : Text,
- : Int64Bit,
- : NoteableType,
- : NotePriority,
- : Int64Bit,
- : Paginator,
- : [Sorter],
- : [Search],
- : String,
- : [Aggregator],
- : [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.
- (
- : 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!
- }