---
title: "List POS journals"
method: GET
path: "/api/v1/posJournals"
tags: ["Point Of Sale"]
---

# List POS journals

`GET /api/v1/posJournals`

Lists all active POS journals.

## Query parameters

- `filter` union
  - object
    - `id` string[]
  - object[]
    - `key` 'id' | 'date' | 'customerId' | 'projectId' | 'salesOrderId' | 'externalOrderNumber'
    - `op` 'equals' | 'notEquals' | 'in' | 'notIn' | 'allIn' | 'allNotIn' | 'contains' | 'notContains' | 'startsWith' | 'endsWith' | 'greaterThan' | 'lessThan'
    - `value` union
      - string
      - string[]
- `page` object
  - `number` string, required — Page number should be an integer greater than or equal to 1
  - `size` string, required — Page size should usually be an integer between 10 and 50.
- `order` object[]
  - `field` 'id' | 'date' | 'customerId' | 'projectId'
  - `dir` 'asc' | 'desc'

## Response `200`

Operation completed successfully.

- object
  - `data` object[]
    - `id` string — Resource identifier.
    - `date` string, date-time, nullable
    - `projectId` string — Resource identifier.
    - `type` string
    - `posFunction` string
    - `doctype` string
    - `paymentType` string
    - `doctypeId` number
    - `documentNumber` string
    - `journalText` string
    - `revenueAccount` string
    - `currency` string
    - `tax` number, float
    - `amountGross` number, float
    - `amountNet` number, float
    - `cashRegisterId` number
    - `customerId` string — Resource identifier.
    - `createdAt` string, date-time
    - `createdBy` string
    - `businessTransactionType` string, nullable
    - `qrString` string, nullable
    - `fiscalDocumentReference` object, nullable — This field represents an object with dynamic structure
    - `salesOrder` object, nullable
      - `id` string, required — Resource identifier.
      - `number` string, required
      - `externalOrderNumber` string
  - `extra` object
    - `totalCount` integer, required — the total count of all items
    - `page` object, required — The pagination object containing the current page number and size
      - `number` integer, required — The current page number
      - `size` integer, required — The size of the pages

## Other responses

- `401` — Unable to authenticate the client
- `403` — Unable to authorize the client
- `406` — Requested resource representation does not exist.
- `429` — Too many API calls made.

---

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