Data Feed 68 Release
Payment Plans: Limited Attributes 1a and 1b (DEV-12278, EXTRACT-11388)(DEV-12326, EXTRACT-12023)
(Data Feed, Universal Connector)
Three new LOMs have been introduced to support the initial release of Payment Plan API’s created during the creation of Payment Plans in Data Feed. These LOMS are effective for both Data Feed and Universal Connector.
LOMs introduced:
- Payment_Plan
- Payment_Plan_Charge
- Payment_Plan_Schedule
All three objects are subscribed together when subscribing to Payment_Plan.
Payment Plan LOM Details:
### Payment_Plan
An [Entity](#Entities) with IDs: 'payment_plan_no', 'client_payment_plan_id'.
"payment_plan_no" and "client_payment_plan_id" each independently identify the same item object.
| Field name | Datatype
|:-----------------------|---------------------------------
| payment_plan_no | [BigInt](#Primitives)
| client_payment_plan_id | [Text](#Primitives)
| name | [Text](#Primitives)
| description | [Text](#Primitives)
| account | [Ref](#Ref)<[Account](#Account)>
| number_of_installments | [Int](#Primitives)
| created_tstamp | [DateTime](#Primitives)
| total_charge_amount | [Decimal](#Primitives)
| total_tax_amount | [Decimal](#Primitives)
Sample LOM:
{
"payment_plan_no": 5,
"client_payment_plan_id": "5",
"name": null,
"description": null,
"account": {
"ids": {
"account_no": 298901,
"userid": "rgxsmm3s",
"client_account_id": "wPZhmKToNK48k5zyMRpTNw4tfelh8kPSwKDHllVrb3FsGgl9SF"
},
"type": "Account"
},
"number_of_installments": 3,
"created_tstamp": "2025-08-10T00:41:38+02:00",
"total_charge_amount": 10.55,
"total_tax_amount": 0
}
Payment Plan Charge LOM Details:
### Payment_Plan_Charge
An [Entity](#Entities) with ids: 'payment_plan_no', 'charge_transaction_no'.
"payment_plan_no" and "charge_transaction_no" together identify a Payment_Plan_Charge object.
| Field name | Datatype | Description
|:-----------------------|--------------------------------------------|----------------------
| payment_plan_no | [BigInt](#Primitives) | part of this entity's compound id
| charge_transaction_no | [BigInt](#Primitives) | part of this entity's compound id
| payment_plan | [Ref](#Ref)<[Payment_Plan](#Payment_Plan)> | links this payment_plan_charge to its related payment plan
| charge | [Ref](#Ref)<[Transaction](#Transaction)> | links this payment_plan_charge to its related charge transaction
| charge_amount | [Decimal](#Primitives) | outstanding charge amount balance at the time the Payment_Plan_Charge was created (derived from the charge_transaction)
| tax_amount | [Decimal](#Primitives) | outstanding tax amount balance at the time the Payment_Plan_Charge was created (derived from the charge transaction)
Sample LOM:
{
"payment_plan_no": 141,
"charge_transaction_no": 5066561,
"payment_plan": {
"ids": {
"payment_plan_no": 141,
"client_payment_plan_id": "141"
},
"type": "Payment_Plan"
},
"charge": {
"ids": {
"transaction_no": 5066561
},
"type": "Transaction"
},
"charge_amount": 10,
"tax_amount": 0
}
Payment Plan Schedule LOM Details:
### Payment_Plan_Schedule
An [Entity](#Entities) with ids: 'payment_plan_no', 'schedule_no'.
"payment_plan_no" and "schedule_no" together identify a Payment_Plan_Schedule object.
| Field name | Datatype | Description
|:------------------------------|--------------------------------------------------------------------------|----------------------
| payment_plan_no | [BigInt](#Primitives) | part of this entity's compound id
| schedule_no | [BigInt](#Primitives) | part of this entity's compound id
| payment_plan | [Ref](#Ref)<[Payment_Plan](#Payment_Plan)> | links this payment_plan_schedule to its related payment plan
| billing_group | [Ref](#Ref)<[Billing_Group](#Billing_Group)> | links this payment_plan_schedule to its related billing group
| aligned_master_plan_instance | [Ref](#Ref)<[Plan_Instance](#Plan_Instance)> | links this payment_plan_schedule to its related master plan instance
| total_charge_amount | [Decimal](#Primitives) | total charge amount balance at the time the payment_plan_schedule was created (derived from all the related charge transactions with outstanding balances)
| total_tax_amount | [Decimal](#Primitives) | outstanding tax amount balance at the time the payment_plan_schedule was created (erived from all the related charge transactions with outstanding tax balances)
| number_of_installments | [Int](#Primitives) | the total number of scheduled billing installments that will be used to collect the outstanding assigned balance(s)
| is_aligned | [Boolean](#Primitives) | indicates if the scheduled installments are alligned with the bill dates and intervals of a master Plan_Instance or if it has independent bill dates
| balance_status | [Ref](#Ref)<[Payment_Plan_Balance_Status](#Payment_Plan_Balance_Status)> | balance status (1 = balance remaining, 2 = fully paid)
| status | [Ref](#Ref)<[Payment_Plan_Status](#Payment_Plan_Status)> | status associated with the schedule lom itself
| status_updated_tstamp | [DateTime](#Primitives) | timestamp when the schedule status was last updated
| created_tstamp | [DateTime](#Primitives) | timestamp when the schedule was created
Sample LOM:
{
"payment_plan_no": 61,
"schedule_no": 12207,
"payment_plan": {
"ids": {
"payment_plan_no": 61,
"client_payment_plan_id": "61"
},
"type": "Payment_Plan"
},
"aligned_master_plan_instance": null,
"billing_group": {
"ids": {
"billing_group_no": 312326,
"client_billing_group_id": "312326"
},
"type": "Billing_Group"
},
"total_charge_amount": 40,
"total_tax_amount": 0.5,
"number_of_installments": 3,
"is_aligned": false,
"balance_status": {
"ids": {
"status_no": 1
},
"type": "Payment_Plan_Balance_Status"
},
"status": {
"ids": {
"status_no": 0
},
"type": "Payment_Plan_Status"
},
"status_updated_tstamp": "2025-09-14T02:47:15+02:00",
"created_tstamp": "2025-09-14T02:47:15+02:00"
}
Queue_no Is 0 When Sync_rate Is Executed (EXTRACT-11860)
(Miscellaneous)
The Salesforce Loader Sync_Rate functionality had a bug where accounts being rate synced would not correctly have their Queued Plan Instance related data updated in the sync. This does not impact the update of their rates themselves. All other “upsert” event resolution of Queued Plan Instances is unaffected (including upserts triggered by Account Syncs).
Payment_source_description Added To External_payment From Transaction LOM (EXTRACT-11922)
(Data Feed, Universal Connector)
A new attribute has been introduced to the Transaction LOM object. This attribute, payment_source_description, is specific to external payment transactions (transaction type2).
| payment_source_description | [Text](#Primitives)<40> | only [Type](#Transaction_Type) 2<br/>Can be used to populate the actual payment methods (e.g., Visa, Cash) used outside of Aria. If populated, it will also impact what is displayed in the Aria UI Source column for external payments.
Sample LOM:
{
"transaction_no": 172869,
"transaction_type": {
"ids": {
"type_no": 2,
"enum": 2
},
"type": "Transaction_Type"
},
"created_tstamp": "2023-09-15T21:07:02+02:00",
"source_no": 8392,
"account": {
"ids": {
"account_no": 8820,
"userid": "uid_1582139221154",
"client_account_id": "caid_1582139221154"
},
"type": "Account"
},
"currency": {
"ids": {
"currency_cd": "usd",
"code": "usd"
},
"type": "Currency"
},
"amount": -20,
"applied_amount": -20,
"fully_applied_tstamp": "2023-09-15T21:07:02+02:00",
"statement": {
"ids": {
"statement_no": 562348
},
"type": "Statement"
},
"master_plan_instance": null,
"api_receipt_id": "recordpaymentreceipt1582139222698",
"transaction_supp_fields": [
{
"field_name": "ext_pay_qual_name1582139222698",
"field_value": "ext_pay_qual_value1582139222698"
}
],
"voided_transaction": null,
"voiding_transaction": null,
"payment_tstamp": "2023-09-15T21:07:02+02:00",
"reference_id": "ext_payment_1582139222698",
"payment_source_description": "test"
}