Allocation

Type:  
Abstract:  no
Status:  Active
Java Class:  Allocation
Represents allocations of funds across transactions (for example between payments and invoices).
Available Fields:
id
References: Balancing Summary.Id
XML Representation: attribute
Attributes: ReadOnly
Default Value
Identifier of the object used for references; auto-incremented integer value.

**create
Unique Allocation ID generated by the system.

  • exists
    • Unique Allocation ID generated by the system.

  • echo
    • Unique Allocation ID used as a search criteria to limit results.
    sourceId
    References: Balancing Summary.Source FK
    XML Representation: attribute
    Attributes: ReadOnly
    Default Value
  • create
    • Reference to a Transaction that the Allocation is associated with.
    Note: The balance of this source transaction was used to offset the balance of a target transaction. <br> <br> Typical example: source transaction is a payment, target transaction is an invoice.


  • exists
    • Reference to a Transaction that the Allocation is associated with.
    Note: The balance of this source transaction was used to offset the balance of a target transaction. <br> <br> Typical example: source transaction is a payment, target transaction is an invoice.


  • echo
    • Identifier of a transaction used as a search criteria to limit results.
    targetId
    References: Balancing Summary.Target FK
    XML Representation: attribute
    Attributes: ReadOnly
    Default Value
    Reference to the entity that represents balancing summary.

    **create Reference to a Transaction that the Allocation is associated with.
    Note: The balance of this target transaction was offset by the source transaction. <br> <br> Typical example: source transaction is a payment, target transaction is an invoice.


  • exists
    • Reference to a Transaction that the Allocation is associated with.
    Note: The balance of this target transaction was offset by the source transaction. <br> <br> Typical example: source transaction is a payment, target transaction is an invoice.


  • echo
    • Identifier of a transaction used as a search criteria to limit results.
    targetTransactionType
    References: Balancing Summary.Target FK
    XML Representation: attribute
    Attributes: ReadOnly
    Default Value
    Reference to the entity that represents balancing summary.

    **create Type of a target transaction that the Allocation is associated with.
    Note: See targetId for detail.


  • exists
    • Type of a target transaction that the Allocation is associated with.
    Note: See targetId for detail.


  • echo
    • Type of a target transaction used as a search criteria to limit results.
    causeTransactionId
    Type: Long
    XML Representation: attribute
    Attributes: ReadOnly
    Default Value
  • create
    • Reference to a Transaction that the Allocation is affected by.
    Note: Sometimes, the allocation may change due to business circumstances. This field indicates which transaction caused the changes.


  • exists
    • Reference to a Transaction that the Allocation is affected by.
    Note: Sometimes, the allocation may change due to business circumstances. This field indicates which transaction caused the changes.


  • echo
    • Identifier of a transaction used as a search criteria to limit results.
    causeTransactionType
    Type: String
    XML Representation: attribute
    Attributes: ReadOnly
    Default Value
  • create
    • Type of a transaction that the Allocation is affected by.
    Note: See causeTransactionId for detail.


  • exists
    • Type of a transaction that the Allocation is affected by.
    Note: See causeTransactionId for detail.


  • echo
    • Type of a transaction used as a search criteria to limit results.
    createDate
    References: Balancing Summary.Create Date
    XML Representation: attribute
    Attributes: ReadOnly
    Default Value
    Date when the record was created

    **create Date when the Allocation was created.
    Note: Date format: yyyy-MM-dd.


  • exists
    • Date when the Allocation was created.
    Note: Date format: yyyy-MM-dd.


  • echo
    • Date used for filtering Allocation records.
    isActive
    References: Balancing Summary.Is Active
    XML Representation: attribute
    Attributes: ReadOnly
    Default Value
    Indicates whether the record is active in the system.

    **create
    Status of the Allocation.
    Note: Values: true (active) or false (inactive).


  • exists
    • Status of the Allocation.
    Note: Values: true (active) or false (inactive).


  • echo
    • Status of the Allocation used for filtering Allocation records.
    amount
    References: Balancing Summary.Amount
    XML Representation: attribute
    Attributes: ReadOnly
    Default Value
    The amount element defines the amount of the transaction. Supply the value in cents without a decimal point.

    **create
    Amount (in cents) that will be charged upon the transaction processing.

  • exists
    • Amount (in cents) charged during the transaction processing.

  • echo
    • Amount (in cents) used as a search criteria to limit results.

    XML Sample:

    <allocations/>
    "<allocations/>"

    JSON Sample:

    {
 
}

    XURL Sample:

    ?
    Copyright © TidyPay. All Rights Reserved.
    All Logos and Trademarks used or mentioned on this page are copyrighted property of their respective owners and are used for display purposes only.