---
title: "Generate group settlement report by transaction status"
method: POST
path: "/billing/settlements/groupedbytransactionstatus/file"
---

# Generate group settlement report by transaction status

`POST /billing/settlements/groupedbytransactionstatus/file`

## Request

- Base URL: `https://api-sandbox.ezypay.com/v2`
- URL: `https://api-sandbox.ezypay.com/v2/billing/settlements/groupedbytransactionstatus/file`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://identity-sandbox.ezypay.com/token`

Generate a group settlement report by transaction status.

## Headers

- `merchant` string, required

## Request body

- object
  - `dateFrom` string: Start date (inclusive) that the Group Settlement Report should cover, in format YYYY-MM-DD.
  - `dateTo` string: End date (inclusive) that the Group Settlement Report should cover, in format YYYY-MM-DD.
  - `documentType` string: The type of document generated from the settlement. Supported values are: `tax_invoice`: Generates a settlement tax invoice PDF. `credit_note`: Generates credit note PDF. `detail_report`: Generates a full report (in .csv format) on the settlement status of payment collections from customers.
  - `merchantIds` string[]: Restrict the Group Settlement Report to a specified set of Merchants.

## Response `200`

200

- object

## Other responses

- `400`: 400

## Changes

- **2026-11-03** `924be4030f56`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/ezypay/apis/vault/changes/billing/settlements/groupedbytransactionstatus/file/post.md)

---

[API](https://skmtc.dev/ezypay/apis/vault.md) - [All operations](https://skmtc.dev/ezypay/apis/vault/llms.txt) - [OpenAPI document](https://skmtc.dev/ezypay/apis/vault/revisions/924be4030f56?raw)