Generates a summary of redemptions made by all users.
Changed onDate rules:
<ul> <li>If you do not specify a start or end date, it will generate a report of the first of the current month to present.</li> <li>If you specify a start date and an end date, they cannot span more than a year.</li> <li>If you specify a start date without an end date, it will fetch either a month from start date, or the current day. Whichever is less.</li> <li>If you specify an end date without a start date, it will error.</li> </ul> All requests will include the applied start and end date.Snappy rules:
<ul> <li>Only billable Snappy orders are counted. Pending, canceled, refunded, and failed orders are left out, matching invoicing.</li> <li>Snappy gift cards, digital rewards, and donations count in gift_card_redemptions.</li> <li>Snappy marketplace merchandise counts in merchandise_redemptions.</li> <li>Snappy swag counts in swag_redemptions, and Snappy shipping in shipping_cost.</li> </ul> meta.total is the sum of every counted redemption. It can be higher than the sum of the categories when a redemption fits none of them.get/v1/analytics/financial/redemptions
Request
- Base URLhttps://api.nectarhr.com
- URLhttps://api.nectarhr.com/v1/analytics/financial/redemptions
- AuthHTTP bearer
Query parameters
expandstring[]
Return each users' expanded data
sort'gift_card_redemptions' | 'swag_redemptions' | 'amazon_us' | 'amazon_uk' | 'amazon_ca'
Sorts output by specified value in descending order.
start-datestring date
Start Date of range to get data from as defined by RFC 3339, section 5.6, for example, 2017-07-21.
end-datestring date
End Date of range to get data from as defined by RFC 3339, section 5.6, for example, 2017-07-21. If defined, start-date is required.
Response
OK
Example response
{
"data": {
"financialRedemptionReport": [
{
"user": {
"phone_number": "123-456-7890"
}
}
]
}
}Changes
- info
added the optional property
///////to the response with the status - info
added the optional property
///////to the response with the status - info
added the optional property
/////////////to the response with the status
- info