Company
Spending summary by period
Returns the company's spending aggregated by time period for a given product. Granularity is day when start_month equals end_month, otherwise month. The product query param selects the source: cards, transfers or pay. An unrecognized product yields an empty array.
Amounts are integers in the record's currency (currency codes are returned upper-cased).
get/v1/companies/{id}/spending_summary
Path parameters
idstring required
The id of the resource. This is a UUID for most resources, but for user endpoints it is the user's Firebase UID (an opaque string), so no uuid format is asserted here.
Query parameters
product'cards' | 'transfers' | 'pay' required
Product whose spending is summarized.
start_monthstring required
Example:01-2024
Start month, formatted MM-YYYY.
end_monthstring required
Example:03-2024
End month, formatted MM-YYYY.
Parameters
#/paths/~1v1~1users/get/parameters/0 — unresolved $ref
Response
Spending grouped by period.
Example response
[
{
"currency": "CLP"
}
]Changes
No recorded changes to this endpoint across all 1 revision of this API.