---
title: "Aggregate Bill Data"
method: POST
path: "/v1/web/bill/aggregate"
tags: ["Bill Analytics"]
---

# Aggregate Bill Data

`POST /v1/web/bill/aggregate`

## Request body

- object
  - `bucket` union, required
    - object
      - `field` union, required
        - 'status'
        - 'fundingSource'
        - 'syncStatus'
        - 'ingestionChannel'
        - 'vendor'
    - object
      - `field` union, required
        - 'createdAt'
        - 'invoiceDate'
        - 'paymentDueDate'
        - 'paymentScheduledDate'
        - 'completedAt'
      - `timeframe` union, required
        - 'day'
        - 'month'
  - `value` union, required
    - object
      - `field` 'amount', required
      - `aggregateMethod` union, required
        - 'avg'
        - 'sum'
    - object
      - `aggregateMethod` 'count', required
  - `filters` union[]
    - union
      - object
        - `field` union, required
          - 'createdAt'
          - 'completedAt'
        - `value` object, required
          - `before` string, date-time
          - `after` string, date-time
      - object
        - `field` union, required
          - 'invoiceDate'
          - 'paymentDueDate'
          - 'paymentScheduledDate'
        - `value` object, required
          - `before` string, date
          - `after` string, date
      - object
        - `field` union, required
          - 'status'
          - 'fundingSource'
          - 'syncStatus'
          - 'ingestionChannel'
        - `value` string[], required
      - object
        - `field` 'vendorIds', required
        - `value` string[], required

## Response `200`

Default Response

- object
  - `items` object[], required
    - `bucket` union, required
      - string
      - boolean
    - `value` string, required

## Other responses

- `400` — Default Response
- `401` — The access to this resource has been denied
- `403` — The access to this resource is forbidden
- `default` — Catch-all error response for any unexpected internal errors

---

[API](https://skmtc.net/funneldash/apis/surface-web-api.md) · [All operations](https://skmtc.net/funneldash/apis/surface-web-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/funneldash/surface-web-api/versions/ac700d65f443/schema)