sync_payee_aggregate Property

Wrapper for payee details.

Syntax

def get_sync_payee_aggregate(sync_payee_index: int) -> str: ...

Default Value

""

Remarks

Wrapper for payee details.

This string consists of all the payee's properties sync_payee_id, sync_payee_name, sync_payee_addr1, sync_payee_addr2, sync_payee_addr3, sync_payee_city, sync_payee_state, sync_payee_postal_code, sync_payee_country, sync_payee_phone, sync_payee_id_scope, sync_payee_days_to_pay, sync_payee_list_id, sync_payee_account of the payee.

When the on_synchronize_payees is called, the on_sync_payees event is fired for each payee in the payee list. Among other payee data returned through this event's parameters, there is also a PayeeAggregate parameter.

When sending a payment request (by calling on_pay_bill) to an existing payee in the list returned via the payee synchronization request, and when the sync_payee_id is unknown or not assigned, instead of setting all payee's properties, the user can set the sync_payee_aggregate to the value of PayeeAggregate returned for that payee from the on_sync_payees event. When the sync_payee_aggregate is set to this value, all payee's properties are populated with the corresponding values in the aggregate.

Aggregates are pieces of XML taken from the financial institution's original response. They contain elements that correspond to many of the class's properties. However, some of these elements, and/or their potential values, may not be supported by the class. Any user who wishes to use unsupported fields may use this aggregate property to parse out the desired data either via our OFXAggregate class or any other means.

Note: The original data from the server is returned as SGML or XML (depending on the value of ofx_version that FI supports. If the original data is returned in SGML format, the class internally manipulates these responses into the equivalent XML format by inserting close element tags (e.g., "</ACCTID>") into the data as it comes from the server.

The sync_payee_index parameter specifies the index of the item in the array. The size of the array is controlled by the sync_payee_count property.

This property is read-only.