---
title: "Create new report"
method: POST
path: "/reports"
---
# Create new report
`POST /reports`
## Headers
- `Content-Type` string, required
- `Host` string, required
- `Date` string, required
- `Digest` string, required
- `Authorization` string, required
- `Idempotency-Key` string
## Request body
- object
- `type` string, required — The type of report that you want to extract.
`PAYMENT_FEE`
Generates a report that includes collected fees and group id for each transaction.
- `format` 'CSV' | 'XLS', required — The type report format required.
`CSV`
Generates an CSV file format.
`XLS`
Generates an XLS file format.
- `notification` object
- `email_cc_list` string[] — The array of emails that will be notified once the report is ready.
- `callback_url` string — The URL to be triggered via an HTTP GET request once the report is ready.
- `query_type` 'PAYMENT_DATE_INTERVAL', required — The query type that you wish to use in the `query_payload` parameter.
`PAYMENT_DATE_INTERVAL`
The only query type supported.
- `query_payload` object, required
- `payment_date_from` string, required — The starting date for payments in the report.
The format must be: `YYYY-MM-dd`.
- `payment_date_to` string, required — The ending date for payments in the report.
The format must be: `YYYY-MM-dd`.
- `time_zone` string — The timezone.
e.g. `Europe/Rome`, you could find a complete list [here](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List).
- `columns` object[] — This array represent the list of columns that will be in your export.
This field is optional.
If not provided, the report will default to the standard version.
- `identifier` 'transaction_id' | 'transaction_acceptance_date' | 'transaction_amount_unit' | 'transaction_signed_amount_unit' | 'transaction_type' | 'transaction_external_code' | 'transaction_counterpart_type' | 'transaction_counterpart_id' | 'transaction_currency' | 'transaction_group_id' | 'transaction_e_money_amount_unit' | 'transaction_meal_voucher_amount_unit' | 'fee_amount_unit' | 'fee_acceptance_date' | 'fee_signed_amount_unit' | 'fee_transaction_original_id' | 'fee_transaction_id' | 'fee_type' | 'fee_id' | 'shop_id' | 'shop_name' | 'shop_external_code', required — The identifier of the columns that you want to add.
Each identifier can be used only once per `columns` field.
`transaction_id`
The payment id.
`transaction_acceptance_date`
The payment acceptance date.
`transaction_amount_unit`
The payment total amount.
`transaction_signed_amount_unit`
The payment signed total amount (negative for refunds).
`transaction_type`
The payment type (`TO_BUSINESS` or `REFUND_TO_BUSINESS`).
`transaction_external_code`
The payment external code.
`transaction_counterpart_type`
The payment counterpart type (`CUSTOMER` or `SHOP`).
`transaction_counterpart_id`
The payment counterpart id (customer or shop).
`transaction_currency`
The payment currency used.
`transaction_group_id`
The payment group id (e.g. refunds).
`transaction_e_money_amount_unit`
The payment e-wallet amount unit.
`transaction_meal_voucher_amount_unit`
The payment meal vouchers amount.
`transaction_fringe_amount_unit`
The payment fringe amount.
`fee_amount_unit`
The payment total amount of fees.
`fee_acceptance_date`
The fee acceptance date.
`fee_signed_amount_unit`
The fees signed total signed amount.
`fee_transaction_original_id`
The original transaction fee id.
`fee_transaction_id`
The transaction fee id.
`fee_type`
The fee type (net).
`fee_id`
The fee id.
`shop_id`
The shop id.
`shop_name`
The shop name.
`shop_external_code`
The shop external code.
- `name` string — The column name that you will see on the header of your report.
This field can contain a custom string value up to 50 chars.
The only allowed characters are: letters, numbers, `-` `_` and spaces.
- `order` integer — The report column order.
The array order will be followed if left empty.
## Response `200`
200
- object
- `id` string — The unique report id.
This can be used to retrieve the generated report.
- `type` string — The report type generated.
`PAYMENT_FEE`
A report that includes collected fees and group id for each transaction.
- `status` string — The current report status.
`PENDING`
The report will be generated soon.
`SUCCESS`
The report has been successfully generated.
- `notification` object
- `email_cc_list` string[] — The array of emails that will be notified once the report is ready.
- `callback_url` string — The URL to be triggered via an HTTP GET request once the report is ready.
- `query_type` string — The query type that you used in the `query_payload` parameter.
`PAYMENT_DATE_INTERVAL`
The only query type supported.
- `query_payload` object
- `payment_date_from` string — The starting date for payments in the report.
The format must be: `YYYY-MM-dd`.
- `payment_date_to` string — The ending date for payments in the report.
The format must be: `YYYY-MM-dd`.
- `time_zone` string — The timezone.
e.g. `Europe/Rome`, you could find a complete list [here](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List).
- `columns` object[] — This array represent the list of columns that will be in your export.
This field is optional.
If not provided, the report will default to the standard version.
- `identifier` string — The identifier of the columns in the current export.
You can find the value listed in the request.
- `name` string — The report column order.
- `order` integer — The report column order.
The array order will be followed if left empty.
## Other responses
- `400` — 400
- `401` — 401
- `403` — 403
---
[API](https://skmtc.net/satispay/apis/satispay-gbusiness-api.md) · [All operations](https://skmtc.net/satispay/apis/satispay-gbusiness-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/satispay/satispay-gbusiness-api/versions/f91f20a37e6f/schema)