> Portal Navigation:
> 
> - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version.
> - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages).
> - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`).
> - Top-level index of all portals: https://dev.wix.com/docs/llms.txt
> - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt

# GetMaterializedInvoicesAggregate

# Package: earnings

# Namespace: MaterializedInvoices

# Method link: https://dev.wix.com/docs/api-reference/account-level/studio-workspace/earnings/materialized-invoice-v1/get-materialized-invoices-aggregate.md

## Permission Scopes:
SCOPE.PARTNERS.REVSHARE: SCOPE.PARTNERS.REVSHARE

## Introduction

Retrieves the total amount (in USD) and count of the partner's materialized invoices matching the provided filter.


The totals cover exactly the invoices the filter matches, across every `status`. Pass an empty filter to total the partner's full invoice history. The Wix Studio dashboard's total is narrower: it sums only `PAID` and `UNPAID` invoices that match the filters selected in the UI, so it excludes `BELOW_THRESHOLD` invoices.

---

## REST API

### Schema

```
 Method: getMaterializedInvoicesAggregate
 Description: Retrieves the total amount (in USD) and count of the partner's materialized invoices matching the provided filter.   The totals cover exactly the invoices the filter matches, across every `status`. Pass an empty filter to total the partner's full invoice history. The Wix Studio dashboard's total is narrower: it sums only `PAID` and `UNPAID` invoices that match the filters selected in the UI, so it excludes `BELOW_THRESHOLD` invoices.
 URL: https://www.wixapis.com/partners/revshare/v1/materialized-invoices/aggregate
 Method: GET
 Method parameters:
   query param name: filter | type: filter | description: Filter selecting which materialized invoices to aggregate.  
 Return type: GetMaterializedInvoicesAggregateResponse
  - name: materializedInvoicesTotalAmount | type: number | description: Total amount across the matching materialized invoices, in USD.  
  - name: materializedInvoicesCount | type: number | description: Number of materialized invoices matching the filter.  


```

### Examples

### Get Materialized Invoices Aggregate
Returns the total amount and count of a partner's materialized invoices matching a filter

```curl
curl -X GET \
  'https://www.wixapis.com/v1/materialized-invoices/aggregate?filter=%7B%22earningsMonth%22%3A%7B%22%24gte%22%3A%222026-01-01T00%3A00%3A00.000Z%22%7D%7D' \
  -H 'Authorization: <AUTH>'
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.revshareMaterializedInvoices.revshareMaterializedInvoices.getMaterializedInvoicesAggregate(options)
 Description: Retrieves the total amount (in USD) and count of the partner's materialized invoices matching the provided filter.   The totals cover exactly the invoices the filter matches, across every `status`. Pass an empty filter to total the partner's full invoice history. The Wix Studio dashboard's total is narrower: it sums only `PAID` and `UNPAID` invoices that match the filters selected in the UI, so it excludes `BELOW_THRESHOLD` invoices.
 Method parameters:
   param name: options | type: GetMaterializedInvoicesAggregateOptions  none  
        - name: filter | type: object | description: Filter selecting which materialized invoices to aggregate.  
 Return type: PROMISE<GetMaterializedInvoicesAggregateResponse>
  - name: materializedInvoicesTotalAmount | type: number | description: Total amount across the matching materialized invoices, in USD.  
  - name: materializedInvoicesCount | type: number | description: Number of materialized invoices matching the filter.  


```

### Examples

### Get materialized invoices aggregate
Returns the total amount and count of a partner's materialized invoices matching a filter

```javascript
import { wixPartnersRevshareV1MaterializedInvoice } from "@wix/dev";

const filter = {
  earningsMonth: { $gte: "2026-01-01T00:00:00.000Z" },
};

async function getMaterializedInvoicesAggregate() {
  const response =
    await wixPartnersRevshareV1MaterializedInvoice.getMaterializedInvoicesAggregate(
      { filter },
    );
}

/* Promise resolves to:
 * {
 *   "materializedInvoicesTotalAmount": 9215.75,
 *   "materializedInvoicesCount": 5
 * }
 */

```

### getMaterializedInvoicesAggregate (self-hosted)
Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md).

```javascript
import { createClient } from '@wix/sdk';
import { revshareMaterializedInvoices } from '@wix/revshare-materialized-invoices';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { revshareMaterializedInvoices },
  // Include the auth strategy and host as relevant
});


async function getMaterializedInvoicesAggregate(options) {
  const response = await myWixClient.revshareMaterializedInvoices.getMaterializedInvoicesAggregate(options);
};
```

---