# Earnings Event(s)

This action retrieves information about [Earnings Event(s)](https://docs.whiteswan.io/partner-knowledge-base/platform-overview/earnings) associated with your White Swan account.

{% hint style="info" %}
Earnings events with the Earnings Event value **Paid Compensation** signifies payments made to you and should be treated differently than events with the Earnings Event value **Closed Case** or **Referred Partner Earning**. For a deeper understanding, refer to our [Example Use Case of Integrating With Accounting/Payroll Tools](https://docs.whiteswan.io/partner-knowledge-base/zapier-integration/example-use-cases/integrate-with-accounting-payroll-tools).
{% endhint %}

***

**Input (Search) Fields:**

<table data-full-width="true"><thead><tr><th>Field Name</th><th>Field Type</th><th>Example Value</th><th>Description</th></tr></thead><tbody><tr><td>User Email</td><td>Text</td><td>john@acme.com</td><td>This input can optionally be used to only show earnings events associated with a particular user on your account.</td></tr><tr><td>Client Email</td><td>Text</td><td>jane@gmail.com</td><td>This input can optionally be used to only show earnings events associated with a particular client referred from your account.</td></tr><tr><td>Look-back Period in Days</td><td>Number</td><td>90</td><td>This input can optionally be used to only show earnings events created after the current date minus X amount of days.</td></tr></tbody></table>

***

**Output Fields:**

<table data-full-width="true"><thead><tr><th>Field Name</th><th>Field Type</th><th>Example Value</th><th>Description</th></tr></thead><tbody><tr><td>Earnings Event Name</td><td>Text</td><td>Case Closed</td><td>The name of the earnings event.</td></tr><tr><td>Earnings Event Amount Credited</td><td>Number</td><td>500</td><td>The amount credited for the earnings event.</td></tr><tr><td>Earnings Event Associated Client Name</td><td>Text</td><td>John Doe</td><td>The name of the client associated with the earnings event (only for Closed Case Events).</td></tr><tr><td>Earnings Event Associated Client Email</td><td>Text</td><td>john@example.com</td><td>The email address of the client associated with the earnings event (only for Closed Case Events).</td></tr><tr><td>Earnings Event Associated Plan Request ID</td><td>Text</td><td>1670721321811x149164079586738180</td><td>The ID of the plan request associated with the earnings event.</td></tr><tr><td>Earnings Event Associated Referred Partner</td><td>Text</td><td>Acme Inc</td><td>The name of the partner associated with the earnings event (only for Referred Partner Earning Events).</td></tr><tr><td>Earnings Event Credit Invoice</td><td>Text</td><td>https://s3.amazonaws.com/appforest_uf/f167656056312330177020/Crediting%20Invoice%20.docx</td><td>A link to the credit invoice for the earnings event (only for Paid Compensation Events)</td></tr><tr><td>Earnings Event Associated Account User</td><td>Text</td><td>Axel Doe</td><td>The name of the account user associated with the earnings event.</td></tr></tbody></table>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.whiteswan.io/partner-knowledge-base/zapier-integration/search-actions/earnings-event-s.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.