OBJECT

ContractAllocation

Contract Allocation

link GraphQL Schema definition

  • type ContractAllocation {
  • agent: Agent!
  • # Transactions
  • #
  • # Arguments
  • # after: Returns the elements in the list that come after the
  • # specified cursor.
  • # before: Returns the elements in the list that come before the
  • # specified cursor.
  • # first: Returns the first _n_ elements from the list.
  • # last: Returns the last _n_ elements from the list.
  • # offset: [Not documented]
  • # limit: [Not documented]
  • # orderBy: [Not documented]
  • # updatedBefore: [Not documented]
  • # updatedAfter: [Not documented]
  • agentLedgerTransactions(
  • after: String,
  • before: String,
  • first: Int,
  • last: Int,
  • offset: Int,
  • limit: Int,
  • orderBy: AgentLedgerTransactionOrderEnum,
  • updatedBefore: ISO8601DateTime,
  • updatedAfter: ISO8601DateTime
  • ): AgentLedgerTransactionConnection!
  • # Contract Allocation's split as a number
  • agentSplitAmount: Float
  • # Contract Allocation's split in percentage
  • agentSplitPercent: Float
  • # Contract Allocation's amount to agent as a number
  • amountToAgent: Float
  • # name of the category at the time of allocation creation
  • categoryName: String
  • # Commission Category
  • commissionCategory: CommissionCategory
  • # Contract
  • contract: Contract!
  • # contract deductions of the allocation
  • #
  • # Arguments
  • # after: Returns the elements in the list that come after the
  • # specified cursor.
  • # before: Returns the elements in the list that come before the
  • # specified cursor.
  • # first: Returns the first _n_ elements from the list.
  • # last: Returns the last _n_ elements from the list.
  • contractDeductions(
  • after: String,
  • before: String,
  • first: Int,
  • last: Int
  • ): ContractDeductionConnection
  • # When the contract allocation was created
  • createdAt: ISO8601DateTime!
  • # Contract Allocation Custom Payout Date
  • customPayoutDate: ISO8601DateTime
  • # Contract Allocation commission type
  • fromCommissionType: FromCommissionTypeEnum
  • # Amount to Agent calculated from which type of commission distribution
  • fromDistributableType: FromDistributableTypeEnum
  • # Contract Allocation's gst rate
  • gstRate: Float
  • # Gst view deductions of the Contract Allocation
  • gstViewDeductions: GstViewEnum
  • # ID of the Contract Allocation
  • id: ID!
  • # Contract Allocation's net agent split. (split_amount - deductions)
  • netAgentCommission: Float
  • # Contract Allocation net payable amount
  • netPayable: Float
  • # Contract Allocation's agent commission fully paid off
  • paid: PaidEnum
  • # Contract Allocation's remaining payable balance to agent. (Net commission -
  • # ledger transactions)
  • payableBalance: Float
  • # Contract Allocation's payout event type
  • payoutDateEvent: PayoutDateEventEnum
  • # Contract Allocation's percent to agent in percentage
  • percentToAgent: Float
  • # Agent was registered for gst when Agent Allocation was created
  • registeredForGst: Boolean
  • # Contract Allocation's superannuation rate
  • superannuationRate: Float
  • # Agent split commission type
  • toAgentType: ToAgentTypeEnum
  • # When the contract allocation was last updated
  • updatedAt: ISO8601DateTime!
  • }