---
title: "List of gross transactions."
method: POST
path: "/reports/v0-nsfw/reports/gross-transactions"
tags: ["Reports"]
---

# List of gross transactions.

`POST /reports/v0-nsfw/reports/gross-transactions`

Returns a list of gross transactions with metadata (folio and reservation details).<br>You must have this scope: 'reports.read'.

## Query parameters

- `propertyId` string, required
- `dateFilter` string[], required
- `reference` string

## Headers

- `Idempotency-Key` string

## Response `200`

OK

- TransactionsGrossExportListModel
  - `transactions` TransactionsGrossExportListItemModel[], required — The list of gross transactions with additional metadata
    - `reservation` TransactionsGrossExportReservationModel
      - `id` string, required — Reservation id
      - `status` 'Confirmed' | 'InHouse' | 'CheckedOut' | 'Canceled' | 'NoShow', required — Status of the reservation
      - `arrival` string, date-time, required — Date of arrival<br />A date and time (without fractional second part) in UTC or with UTC offset as defined in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>
      - `departure` string, date-time, required — Date of departure<br />A date and time (without fractional second part) in UTC or with UTC offset as defined in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>
    - `timestamp` string, date-time, required — Timestamp with time zone information, when the booking was done<br />A date and time (without fractional second part) in UTC or with UTC offset as defined in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>
    - `date` string, date, required — The business date when the booking was done
    - `debitedAccount` ExportAccountModel, required
      - `name` string, required — The account name
      - `number` string, required — The account number
      - `parentNumber` string, nullable — The number of the parent account
      - `type` 'Revenues' | 'Payments' | 'Liabilities' | 'Receivables' | 'Vat' | 'House' | 'AccountsReceivable' | 'CityTaxes' | 'TransitoryItems' | 'VatOnLiabilities' | 'LossOfAccountsReceivable' | 'SecondCityTax' | 'GuestLevies', required — The account type
    - `creditedAccount` ExportAccountModel, required
      - `name` string, required — The account name
      - `number` string, required — The account number
      - `parentNumber` string, nullable — The number of the parent account
      - `type` 'Revenues' | 'Payments' | 'Liabilities' | 'Receivables' | 'Vat' | 'House' | 'AccountsReceivable' | 'CityTaxes' | 'TransitoryItems' | 'VatOnLiabilities' | 'LossOfAccountsReceivable' | 'SecondCityTax' | 'GuestLevies', required — The account type
    - `command` 'PostCharge' | 'PostPayment' | 'MoveLineItem' | 'PostPrepayment' | 'PostToAccountsReceivables' | 'PostPrepaymentVat' | 'PostToLossOfAccountsReceivables' | 'System', required — The type of business transaction which triggered the booking
    - `currency` string, required — The currency of the transaction
    - `grossAmount` number, double, required — The gross amount being booked
    - `netAmount` number, double, required — The net amount being booked
    - `taxes` TaxAmountModel[], nullable — The taxes which make up the difference between net and gross amount
      - `type` 'Null' | 'VeryReduced' | 'Reduced' | 'Normal' | 'Without' | 'Special' | 'Special1' | 'Special2' | 'ReducedCovid19' | 'NormalCovid19' | 'Mixed', required — The VAT type
      - `percent` number, double, required — The currently valid percent to calculate the VAT
      - `amount` number, double, required — The tax amount
    - `receipt` ReceiptModel, required
      - `type` 'Custom' | 'Reservation' | 'Invoice' | 'PspReference' — The type of receipt.
      - `number` string, required — The receipt number.
    - `sourceEntryNumber` string, required — The original raw transaction entry number which got converted to these one or 2 lines.
    - `reference` string, required — The reference for the transactions, reservation id for guest folios, booking id for booking folio, folio id for external folios, property code for the house folio
    - `referenceType` 'House' | 'Guest' | 'External' | 'Booking', required — Does this transaction belong to a reservation, a house or an external folio
  - `count` integer, required — Total count of items

## Other responses

- `204` — No Content
- `400` — Bad request.
- `401` — You are unauthorized.
- `403` — Forbidden.
- `404` — The Request-URI could not be found.
- `422` — Validation errors in the request body or query params.
- `499` — Client closed request.
- `500` — An unexpected error occurred.
- `503` — The server is currently unavailable. Please try later.

---

[API](https://skmtc.dev/apaleo/apis/apaleo-reports-api-not-safe-for-work.md) · [All operations](https://skmtc.dev/apaleo/apis/apaleo-reports-api-not-safe-for-work/llms.txt) · [OpenAPI document](https://skmtc.dev/apaleo/apis/apaleo-reports-api-not-safe-for-work/revisions/d870ce9eee20?raw)