Earnings Event(s)

This action retrieves information about Earnings Event(s) associated with your White Swan account.

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.


Input (Search) Fields:

Field NameField TypeExample ValueDescription

User Email

Text

john@acme.com

This input can optionally be used to only show earnings events associated with a particular user on your account.

Client Email

Text

jane@gmail.com

This input can optionally be used to only show earnings events associated with a particular client referred from your account.

Look-back Period in Days

Number

90

This input can optionally be used to only show earnings events created after the current date minus X amount of days.


Output Fields:

Field NameField TypeExample ValueDescription

Earnings Event Name

Text

Case Closed

The name of the earnings event.

Earnings Event Amount Credited

Number

500

The amount credited for the earnings event.

Earnings Event Associated Client Name

Text

John Doe

The name of the client associated with the earnings event (only for Closed Case Events).

Earnings Event Associated Client Email

Text

john@example.com

The email address of the client associated with the earnings event (only for Closed Case Events).

Earnings Event Associated Plan Request ID

Text

1670721321811x149164079586738180

The ID of the plan request associated with the earnings event.

Earnings Event Associated Referred Partner

Text

Acme Inc

The name of the partner associated with the earnings event (only for Referred Partner Earning Events).

Earnings Event Credit Invoice

Text

https://s3.amazonaws.com/appforest_uf/f167656056312330177020/Crediting%20Invoice%20.docx

A link to the credit invoice for the earnings event (only for Paid Compensation Events)

Earnings Event Associated Account User

Text

Axel Doe

The name of the account user associated with the earnings event.

Last updated