Get Savings Events

get

https://api.zylo.com/v2/savingsEvents

Required Permissions

applications:read

Rate Limit

basic

Query Params

application_id

string

Unique identifier for the application related to the savings event.

description

string

Description of the savings event.

event_type

string

Type of the savings event.

exclude_from_event_total

boolean

If checked, event will be excluded from aggregated event statistics and total event count.

string

Unique identifier for a savings event.

is_custom

boolean

Yes/No field to indicate if the event is custom or created by Zylo.

monetary_value

string

Monetary value of the savings event.

name

string

Name of the savings event.

notes

string

Notes of the savings event.

numerical_value

string

The numerical value of the savings event. This must be not null if the unit of measure is not null.

transaction_date

string

Date of the transaction for the savings event.

unit_of_measure

string

enum

The unit of measure for the numerical value of the savings event. This must be not null if the numerical value is not null.

Allowed:

value_type

string

enum

The value type category for the savings event.

Allowed:

zylo_created_at

string

Date and time the record was created in Zylo.

zylo_modified_at

string

Date and time the record was last modified in Zylo. Uses the created date by default.

sort

string

Defaults to +zylo_created_at

Sort by any non-object or array value. Use +/- to indicate direction.

limit

double

≤ 1000

Defaults to 50

Number of results to bring back.

skip

double

Defaults to 0

Offset the results by this number.

cursor

string

id value to use cursor based pagination. Can be used in place of skip.

string

Search the results by this string.

Response

Language

Credentials

Bearer

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Ok