---
title: "Fetch collections report"
method: POST
path: "/v1/reports/collections/flat_file"
---

# Fetch collections report

`POST /v1/reports/collections/flat_file`

This API gets the collections details in the organization during a selected date range.

## Query parameters

- `page` string
- `size` string

## Request body

- unknown

## Response `200`

200

- union
  - object
    - `collections` object[]
      - `payment_date` string
      - `invoice_no` string
      - `guest_name` string
      - `center_name` string
      - `center_code` string
      - `tax_collected` integer
      - `payment_type` string
      - `amount_paid` integer
      - `amount_paid_exc_tax` integer
      - `total_paid` integer
      - `amount_paid_inc_tax_tip_ssg` integer
      - `due` integer
      - `tip` integer
      - `ssg` integer
      - `esf` integer
      - `cash_back` integer
      - `card_type` string
      - `card_number` string
      - `card_invoice_no` string
      - `card_bank_name` string
      - `card_expiry` string
      - `check_number` string
      - `check_bank_name` string
      - `check_date` string
      - `additional_data` string
      - `collected_by` string
      - `collected_by_code` string
      - `invoice_status` string
      - `invoice_id` string
      - `guest_id` string
      - `center_id` string
      - `invoice_center` string
    - `total` object
      - `amount_paid` integer
      - `amount_paid_exc_tax` number
      - `amount_paid_inc_tax_tip_ssg` number
      - `tip` integer
      - `ssg` number
      - `tax_collected` number
    - `page_info` object
      - `total` integer
      - `page` integer
      - `size` integer
    - `error` unknown
  - object
    - `collections` object[]
      - `payment_date` string
      - `invoice_no` string
      - `guest_name` string
      - `guest_code` string
      - `guest_gender` integer
      - `guest_nationality` string
      - `center_name` string
      - `center_code` string
      - `tax_collected` integer
      - `payment_type` string
      - `amount_paid` integer
      - `amount_paid_exc_tax` integer
      - `total_paid` integer
      - `amount_paid_inc_tax_tip_ssg` integer
      - `due` integer
      - `tip` integer
      - `ssg` integer
      - `esf` integer
      - `donation` integer
      - `cash_back` integer
      - `card_type` string
      - `card_number` string
      - `card_invoice_no` string
      - `card_bank_name` string
      - `card_expiry` string
      - `check_number` string
      - `check_bank_name` string
      - `check_date` string
      - `collected_by` string
      - `collected_by_code` string
      - `cash_register` string
      - `invoice_status` string
      - `invoice_id` string
      - `guest_id` string
      - `center_id` string
      - `invoice_center` string
      - `invoice_closed_date` string
      - `card_surcharge_fee` integer
    - `total` object
      - `amount_paid` integer
      - `amount_paid_exc_tax` number
      - `amount_paid_inc_tax_tip_ssg` number
      - `tip` integer
      - `ssg` number
      - `tax_collected` number
      - `donation` integer
      - `card_surcharge_fee` integer
    - `page_info` object
      - `total` integer
      - `page` integer
      - `size` integer
    - `error` unknown

## Other responses

- `400` — 400

---

[API](https://skmtc.net/zenoti/apis/zenoti-authentication.md) · [All operations](https://skmtc.net/zenoti/apis/zenoti-authentication/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/zenoti/zenoti-authentication/revisions/e628f892391a/schema)