You can use the AuditLogItems API call to retrieve a filtered list of financial history entries, and to retrieve a particular financial history entry.
Wild Apricot's API is intended for use by developers with technical expertise. If you need assistance, we provide support via email or through our Developers forum. If you are not an experienced programmer, consider using Make (formerly Integromat) to build automated workflows with Wild Apricot.
AuditLogItems API functions
The AuditLogItems API call supports the following functions. To view the Swagger documentation, click the appropriate function below.
Filtering the results
When retrieving multiple financial history entries, you must include filter criteria. You can filter the results by specifying a filter object, by specifying a start and/or end date, and by specifying a set of financial history entry ids. You can combine multiple filter criteria to further narrow the results.
Specifying a filter object
Specifying a filter object allows you to filter the financial history entries by a particular customer, event, event registration, invoice, payment, refund, or donation.
Syntax
GET {baseAPIaddress}/v2.1/Accounts/{accountID}/AuditLogItems/?FilterObjectType={objectTy pe}&FilterObjectId={objectID} where objectType can be Customer, Event , EventRegistration, Invoice, Payment, Refund, or Donation, and objectID is the unique identifier of the customer, event, event registration, invoice, payment, refund, or donation.
Example:
GET https://api.wildapricot.org/v2.1/accounts/13703/AuditLogItems/?FilterObjectType=Even t&FilterObjectId=51377
Specifying a start or end document date
You can filter the financial history entries by specifying a start date and/or an end date (using the DocumentDate field).
Syntax:
GET {baseAPIaddress}/v2.1/Accounts/{accountID}/AuditLogItems/?StartDate={date}&EndDate={ date} where date is the start or end date of the range (using the yyyy-mm-dd date format).
Example:
GET https://api.wildapricot.org/v2.1/accounts/13703/AuditLogItems/?StartDate=2016-11-01&EndDate=2016-11-30
Specifying a set of audit log entries
You can filter the financial history entries by specifying a set of audit log entries.
Syntax:
GET {baseAPIaddress}/v2.1/Accounts/{accountID}/AuditLogItems/?ids={id1},{id2},{id3}... where id is the unique identifier of a financial history entry.
Example:
GET https://api.wildapricot.org/v2.1/accounts/13703/AuditLogItems/?ids=2525543,2525544
