---
title: "Payment.Report"
method: POST
path: "/online/RivhitOnlineAPI.svc/Payment.Report"
---

# Payment.Report

`POST /online/RivhitOnlineAPI.svc/Payment.Report`

### Get Payment Report

## Request body

- object
  - `api_token` string, uuid, required — Rivhit Merchant API Identifier. **Default:** No
  - `pay_code` integer, nullable — The Payment Type. **Range:** 1 to 99 **Default:** No
  - `from_production_date` string, date — The issue Date to Start Filter. ~ combine with to_production_date **Format:** dd-MM-yyyy **Default:** No
  - `to_production_date` string, date — The issue Date to End Filter. ~ combine with from_production_date **Format:** dd-MM-yyyy **Default:** No
  - `from_value_date` string, date, nullable — The Due Date to Start Filter. ~ combine with to_value_date **Format:** dd-MM-yyyy **Default:** No
  - `to_value_date` string, date, nullable — The Due Date to End Filter. ~ combine with from_value_date **Format:** dd-MM-yyyy **Default:** No
  - `crmUserId` integer, nullable — CRM User Id. **Range:** 0 to 99999 **Default:** Rivhit user settings
  - `projectId` integer, nullable — Project Id Serial Number (Rivhit system). **Range:** 0 to 999999999 **Default:** No

## Response `200`

Success - Receipt List Returned

- 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
    - `payments` object[]
      - `amount` number, float — The Payment Amount.
      - `bank_account_number` string — The Bank Account Number.
      - `bank_code` string — Check Bank Code.
      - `branch_number` string — Check Bank Branch Number.
      - `check_number` string — Check/Transaction Voucher Number.
      - `customer_first_name` string — The Customer's First Name.
      - `customer_id` integer — Rivhit Customer Id.
      - `customer_last_name` string — The Customer's Last Name.
      - `due_date` string — Due Date for the Receipt.
      - `payment_type` integer — The Payment Type.
      - `project_id` integer — The Project Id.
      - `receipt_date` string — The Receipt Production Date.
      - `receipt_link` string — The Receipt Link.
      - `receipt_number` integer — The Receipt Number.
      - `receipt_type` integer — The Receipt Type.
      - `reference` string — The Receipt Reference.

## 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)
