Allocation
Represents allocations of funds across transactions (for example between payments and invoices).
id
sourceId
create
Identifier of the transaction that initiated the allocation.\n\r\n> **Note:** Refers to the originating transaction in the allocation process.\n\r\n> **Tip:** Use this field to trace originating transactions and related flows.**echo
Identifier of the transaction that initiated the allocation.\n\r\n> **Note:** Refers to the originating transaction in the allocation process.\n\r\n> **Tip:** Use this field to trace originating transactions and related flows.
targetId
targetTransactionType
causeTransactionId
create
Identifier of the transaction that caused this allocation.\n\r\n> **Note:** Refers to the transaction that triggered the allocation creation.\n\r\n> **Tip:** Use this field to track the transaction that triggered this allocation.**echo
Identifier of the transaction that caused this allocation.\n\r\n> **Note:** Refers to the transaction that triggered the allocation creation.\n\r\n> **Tip:** Use this field to track the transaction that triggered this allocation.
causeTransactionType
create
Type of the causal transaction.\n\r\n> **Note:** Indicates the category of the transaction that triggered this allocation.\n\r\n> **Tip:** Use this field to identify and categorize allocation triggers.**echo
Type of the causal transaction.\n\r\n> **Note:** Indicates the category of the transaction that triggered this allocation.\n\r\n> **Tip:** Use this field to identify and categorize allocation triggers.
createDate
isActive
amount
taxAmount
create
Tax amount associated with the transaction in cents.\n\r\n> **Note:** Represents the tax component of the total amount.\n\r\n> **Tip:** Use for calculating and reporting tax obligations.**echo
Tax amount associated with the transaction in cents.\n\r\n> **Note:** Represents the tax component of the total amount.\n\r\n> **Tip:** Use for calculating and reporting tax obligations.
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
Identifier of the object used for references.\n\r\n> **Note:** Auto-incremented integer value uniquely identifying each allocation record.\n\r\n> **Tip:** Use this ID to reference allocations in subsequent API calls. See Identifiers section for best practices.
**create
Unique Allocation ID generated by the system.
References: Balancing Summary.Source FK
XML Representation: attribute
Attributes:
ReadOnly
Default Value
References: Balancing Summary.Target FK
XML Representation: attribute
Attributes:
ReadOnly
Default Value
Reference to the entity that represents balancing summary.
**create ID of the object storing the allocation data.\n\r\n> **Note:** Identifies the destination of the allocation.\n\r\n> **Tip:** Use this field to track where allocated funds are directed.**echo ID of the object storing the allocation data.\n\r\n> **Note:** Identifies the destination of the allocation.\n\r\n> **Tip:** Use this field to track where allocated funds are directed.
**create ID of the object storing the allocation data.\n\r\n> **Note:** Identifies the destination of the allocation.\n\r\n> **Tip:** Use this field to track where allocated funds are directed.**echo ID of the object storing the allocation data.\n\r\n> **Note:** Identifies the destination of the allocation.\n\r\n> **Tip:** Use this field to track where allocated funds are directed.
References: Balancing Summary.Target FK
XML Representation: attribute
Attributes:
ReadOnly
Default Value
Reference to the entity that represents balancing summary.
**create Type of transaction.\n\r\n> **Note:** Indicates the category of the target transaction.\n\r\n> **Tip:** Use this field for transaction categorization and reporting.**echo Type of transaction.\n\r\n> **Note:** Indicates the category of the target transaction.\n\r\n> **Tip:** Use this field for transaction categorization and reporting.
**create Type of transaction.\n\r\n> **Note:** Indicates the category of the target transaction.\n\r\n> **Tip:** Use this field for transaction categorization and reporting.**echo Type of transaction.\n\r\n> **Note:** Indicates the category of the target transaction.\n\r\n> **Tip:** Use this field for transaction categorization and reporting.
Type: Long
XML Representation: attribute
Attributes:
ReadOnly
Default Value
Type: String
XML Representation: attribute
Attributes:
ReadOnly
Default Value
References: Balancing Summary.Create Date
XML Representation: attribute
Attributes:
ReadOnly
Default Value
Date when the record was created
**create Date when the record was created.\n\r\n> **Note:** Returned in format yyyy-MM-dd HH:mm:ss.\n\r\n> **Tip:** Useful for audit trails and time-based reporting.**echo Date when the record was created.\n\r\n> **Note:** Returned in format yyyy-MM-dd HH:mm:ss.\n\r\n> **Tip:** Useful for audit trails and time-based reporting.
**create Date when the record was created.\n\r\n> **Note:** Returned in format yyyy-MM-dd HH:mm:ss.\n\r\n> **Tip:** Useful for audit trails and time-based reporting.**echo Date when the record was created.\n\r\n> **Note:** Returned in format yyyy-MM-dd HH:mm:ss.\n\r\n> **Tip:** Useful for audit trails and time-based reporting.
References: Balancing Summary.Is Active
XML Representation: attribute
Attributes:
ReadOnly
Default Value
Indicates whether the record is active in the system.
**create Indicates whether a record is active within the system.\n\r\n> **Note:** Values: true (`1`, default) or false (`0`).\n\r\n> **Tip:** Filter active vs. inactive records during processing.**echo Indicates whether a record is active within the system.\n\r\n> **Note:** Values: true (`1`, default) or false (`0`).\n\r\n> **Tip:** Filter active vs. inactive records during processing.
**create Indicates whether a record is active within the system.\n\r\n> **Note:** Values: true (`1`, default) or false (`0`).\n\r\n> **Tip:** Filter active vs. inactive records during processing.**echo Indicates whether a record is active within the system.\n\r\n> **Note:** Values: true (`1`, default) or false (`0`).\n\r\n> **Tip:** Filter active vs. inactive records during processing.
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 Total transaction amount in cents (not dollars).\n\r\n> **Note:** Example: $5.00 = 500 cents.\n\r\n> **Tip:** Store values in cents to avoid floating-point rounding errors.**echo Total transaction amount in cents (not dollars).\n\r\n> **Note:** Example: $5.00 = 500 cents.\n\r\n> **Tip:** Store values in cents to avoid floating-point rounding errors.
**create Total transaction amount in cents (not dollars).\n\r\n> **Note:** Example: $5.00 = 500 cents.\n\r\n> **Tip:** Store values in cents to avoid floating-point rounding errors.**echo Total transaction amount in cents (not dollars).\n\r\n> **Note:** Example: $5.00 = 500 cents.\n\r\n> **Tip:** Store values in cents to avoid floating-point rounding errors.
References: Balancing Summary.Tax Amount
XML Representation: attribute
Attributes:
Default Value
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.