---
title: "Customer.JournalReport"
method: POST
path: "/online/RivhitOnlineAPI.svc/Customer.JournalReport"
---

# Customer.JournalReport

`POST /online/RivhitOnlineAPI.svc/Customer.JournalReport`

## Request body

- object
  - `api_token` string, uuid, required — Rivhit Merchant API Identifier. **Default:** No
  - `customer_id` integer, required — Rivhit Customer Identifier. **Range:** 0 to 999999999 **Default:** No
  - `year` integer, nullable — Year of the Journal Report. **Format:** YYYY **Default:** Current year
  - `only_open` boolean, nullable — Return Only Open Journal Reports. **Default:** false
  - `all_years` boolean, nullable — Return All Years Journal Reports. **Default:** false

## Response `200`

Success - Customer Journal Report Retrived

- object
  - `error_code` integer — The Response Error/Status Number (0 = Success)
  - `client_message` string — The Client Error Message.
  - `debug_message` string — The Response Error Message.
  - `data` object
    - `customer_journal` object[]
      - `credit_amount` number, double — Credit Amount in the Journal Report.
      - `debit_amount` number, double — Debit Amount in the Journal Report.
      - `details` string — Details of the Journal Report.
      - `due_date` string, date — Due Date of the Journal Report (DD/MM/YYYY).
      - `journal_id` integer — Unique Identifier for the Journal Report.
      - `journal_month` integer — Month of the Journal Report (MM).
      - `journal_year` integer — Year of the Journal Report (YYYY).
      - `opposite_account` integer — Opposite Account Identifier (Debit or Credit Id).
      - `reference1` string — The First Reference Value.
      - `reference2` string — The Second Reference Value.
      - `reference_date` string, date — Reference Date for the Accounting Journal (DD/MM/YYYY).
      - `sort_code` integer — The Sort Code Type.
      - `sort_code_name` string — The Sort Code Name.

## Other responses

- `400` — Request Error
- `500` — Internal Server Error

---

[API](https://skmtc.net/rivhit/apis/get-payment-url-22-12.md) · [All operations](https://skmtc.net/rivhit/apis/get-payment-url-22-12/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rivhit/get-payment-url-22-12/versions/ed5261a52458/schema)