---
title: "Returns folio change log entries sorted by the timestamp."
method: GET
path: "/logs/v0-nsfw/finance/folio"
tags: ["FinanceLogs"]
---

# Returns folio change log entries sorted by the timestamp.

`GET /logs/v0-nsfw/finance/folio`

## Request

- Base URL: `https://api.apaleo.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.apaleo.com/logs/v0-nsfw/finance/folio`
- Auth: OAuth 2
  - Implicit: `https://identity.apaleo.com/connect/authorize`
  - Scopes: `logs.read`, `admin`

<br>You must have this scope: 'logs.read'.<br>For fine-grained clients, you must have this permission: 'core.folio_log.read'.

## Query parameters

- `folioIds` string[]
- `eventTypes` string[]
- `clientIds` string[]
- `propertyIds` string[]
- `subjectIds` string[]
- `dateFilter` string[]
- `pageNumber` integer
- `pageSize` integer

## Response `200`

Success.

- FolioChangeLogListModel
  - `logEntries` FolioChangeLogItemModel[], required: List of the log entries.
    - `folioId` string, required: The ID of the folio
    - `eventType` 'Created' | 'ChargePosted' | 'TransitoryChargePosted' | 'AllowancePosted' | 'PaymentPosted' | 'ChargeMovedFromFolio' | 'TransitoryChargeMovedFromFolio' | 'PaymentMovedFromFolio' | 'ChargeMovedToFolio' | 'TransitoryChargeMovedToFolio' | 'PaymentMovedToFolio' | 'Closed' | 'Reopened' | 'Deleted' | 'DebitorChanged' | 'AllowanceMovedFromFolio' | 'AllowanceMovedToFolio' | 'RefundPosted' | 'RefundMovedFromFolio' | 'RefundMovedToFolio' | 'InvoiceCreated' | 'InvoiceCanceled' | 'InvoicePaid' | 'ChargesChanged' | 'PaymentAdded' | 'PaymentFailed' | 'PaymentCanceled' | 'RefundAdded' | 'RefundFailed' | 'InvoiceWrittenOff' | 'DepositItemAdded' | 'DepositItemChanged' | 'DepositItemDeleted' | 'InvoiceFailed', required: The type of the operation
    - `relatedEntityId` string, nullable: The ID of related entity, if there is any (e.g. the ID of the charge posted)
    - `relatedEntityDescription` string, nullable: The description of related entity, if there is any (e.g. the name of the charge posted or the payment method)
    - `amount` MonetaryValueModel
      - `amount` number, double, required
      - `currency` string, required
    - `clientId` string, required: The ID of the client that triggered this event
    - `serviceDate` string, date, nullable: The date the service is expected to be provided
    - `propertyId` string, required: The ID of the property
    - `created` string, date-time, required: Date and time when the operation has been executed<br />A date and time in UTC or with UTC offset as defined in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>
    - `subjectId` string, nullable: The ID of the user that triggered this event
  - `count` integer, required: Total count of items

## Other responses

- `204`: No folio change logs found.
- `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-logs-api-not-safe-for-work.md) - [All operations](https://skmtc.dev/apaleo/apis/apaleo-logs-api-not-safe-for-work/llms.txt) - [OpenAPI document](https://skmtc.dev/apaleo/apis/apaleo-logs-api-not-safe-for-work/revisions/5a908bbb0d37?raw)