| Field | Type | Required | Description | Example |
|---|---|---|---|---|
consumerId |
Optional<String> | ➖ | ID of the consumer which you want to get or push data from | test-consumer |
appId |
Optional<String> | ➖ | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX |
serviceId |
Optional<String> | ➖ | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
passThrough |
Map<String, Object> | ➖ | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | { "search": "San Francisco" } |
filter |
Optional<BalanceSheetFilter> | ➖ | Apply filters | { "start_date": "2021-01-01", "end_date": "2021-12-31", "period_count": 3, "period_type": "month" } |
raw |
Optional<Boolean> | ➖ | Include raw response. Mostly used for debugging purposes |