sync_payment_payee_aggregate Property

Wrapper for the payee details this payment was sent to.

Syntax

def get_sync_payment_payee_aggregate(sync_payment_index: int) -> str: ...

Default Value

""

Remarks

Wrapper for the payee details this payment was sent to.

This string consists of these payee's data: name, address, city, state, country, postal code, country and phone.

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

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_payment_index parameter specifies the index of the item in the array. The size of the array is controlled by the sync_payment_count property.

This property is read-only.