Sign in

v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

Fetch collections report

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

post/v1/reports/collections/flat_file

Query parameters

pagestring

Page number to search

sizestring

Size of the list to return

Request body

{"stackTrail":"paths:/v1/reports/collections/flat_file:post:requestBody:content:application/json:schema","oasType":"schema","type":"unknown"}

Response

200

OR

Example response

{
  "collections": [
    {
      "payment_date": "2021-12-22T00:00:00",
      "invoice_no": "RR10961",
      "guest_name": "Tarc Lopez",
      "center_name": "Khammam",
      "center_code": "KMM",
      "payment_type": "Cash",
      "total_paid": 4770,
      "amount_paid_inc_tax_tip_ssg": 1350,
      "ssg": 1350,
      "card_type": "Visa",
      "collected_by": "Tangerinespa_Own Owner",
      "collected_by_code": "IvyOwner",
      "invoice_status": "Open",
      "invoice_id": "a613ce4c-4e90-4600-be9e-9ee7479b0955",
      "guest_id": "e3259138-76e1-4451-be34-53482cd42a90",
      "center_id": "a11f578a-1b81-4de0-8834-915f79e5362b",
      "invoice_center": "Khammam"
    }
  ],
  "total": {
    "amount_paid": 16070,
    "amount_paid_exc_tax": 15160.38,
    "amount_paid_inc_tax_tip_ssg": 19118.11,
    "ssg": 3048.11,
    "tax_collected": 909.62
  },
  "page_info": {
    "total": 4,
    "page": 1,
    "size": 10
  }
}