---
updatedAt: 2026-05-06T13:41:04.000Z
agentTools:
  projectIndex: https://rivhit-api.readme.io/llms.txt
---

# Payment.Report

### Get Payment Report

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Get payment report",
    "version": "1.0.0"
  },
  "paths": {
    "/online/RivhitOnlineAPI.svc/Payment.Report": {
      "post": {
        "summary": "Payment.Report",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "api_token": {
                    "type": "string",
                    "format": "uuid",
                    "example": "DECD03E5-E35C-41E8-84F7-FBA2FB483928",
                    "description": "Rivhit Merchant API Identifier.\n\n**Default:** No\n",
                    "nullable": false,
                    "deprecated": false
                  },
                  "pay_code": {
                    "type": "integer",
                    "example": 4,
                    "description": "The Payment Type.\n\n**Range:** 1 to 99\n**Default:** No\n",
                    "nullable": true
                  },
                  "from_production_date": {
                    "type": "string",
                    "format": "date",
                    "example": "01-05-2026",
                    "description": "The issue Date to Start Filter.\n\n~ combine with to_production_date\n**Format:** dd-MM-yyyy\n**Default:** No\n",
                    "nullable": false
                  },
                  "to_production_date": {
                    "type": "string",
                    "format": "date",
                    "example": "05-05-2026",
                    "description": "The issue Date to End Filter.\n\n~ combine with from_production_date\n**Format:** dd-MM-yyyy\n**Default:** No\n",
                    "nullable": false
                  },
                  "from_value_date": {
                    "type": "string",
                    "format": "date",
                    "example": "01-01-2026",
                    "description": "The Due Date to Start Filter.\n\n~ combine with to_value_date\n**Format:** dd-MM-yyyy\n**Default:** No\n",
                    "nullable": true
                  },
                  "to_value_date": {
                    "type": "string",
                    "format": "date",
                    "example": "31-12-2026",
                    "description": "The Due Date to End Filter.\n\n~ combine with from_value_date\n**Format:** dd-MM-yyyy\n**Default:** No\n",
                    "nullable": true
                  },
                  "crmUserId": {
                    "type": "integer",
                    "example": null,
                    "description": "CRM User Id.\n\n**Range:** 0 to 99999\n**Default:** Rivhit user settings\n",
                    "nullable": true
                  },
                  "projectId": {
                    "type": "integer",
                    "example": null,
                    "description": "Project Id Serial Number (Rivhit system).\n\n**Range:** 0 to 999999999\n**Default:** No\n",
                    "nullable": true
                  }
                },
                "required": [
                  "api_token"
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Success - Receipt List Returned",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error_code": {
                      "type": "integer",
                      "description": "The Response Error/Status Number (0 = Success)."
                    },
                    "client_message": {
                      "type": "string",
                      "description": "The Client Error Message."
                    },
                    "debug_message": {
                      "type": "string",
                      "description": "The Response Error Message."
                    },
                    "data": {
                      "type": "object",
                      "properties": {
                        "payments": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "amount": {
                                "type": "number",
                                "format": "float",
                                "description": "The Payment Amount."
                              },
                              "bank_account_number": {
                                "type": "string",
                                "description": "The Bank Account Number."
                              },
                              "bank_code": {
                                "type": "string",
                                "description": "Check Bank Code."
                              },
                              "branch_number": {
                                "type": "string",
                                "description": "Check Bank Branch Number."
                              },
                              "check_number": {
                                "type": "string",
                                "description": "Check/Transaction Voucher Number."
                              },
                              "customer_first_name": {
                                "type": "string",
                                "description": "The Customer's First Name."
                              },
                              "customer_id": {
                                "type": "integer",
                                "description": "Rivhit Customer Id."
                              },
                              "customer_last_name": {
                                "type": "string",
                                "description": "The Customer's Last Name."
                              },
                              "due_date": {
                                "type": "string",
                                "description": "Due Date for the Receipt."
                              },
                              "payment_type": {
                                "type": "integer",
                                "description": "The Payment Type."
                              },
                              "project_id": {
                                "type": "integer",
                                "description": "The Project Id."
                              },
                              "receipt_date": {
                                "type": "string",
                                "description": "The Receipt Production Date."
                              },
                              "receipt_link": {
                                "type": "string",
                                "description": "The Receipt Link."
                              },
                              "receipt_number": {
                                "type": "integer",
                                "description": "The Receipt Number."
                              },
                              "receipt_type": {
                                "type": "integer",
                                "description": "The Receipt Type."
                              },
                              "reference": {
                                "type": "string",
                                "description": "The Receipt Reference."
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error_code": "0,",
                  "client_message": "",
                  "debug_message": "",
                  "data": {
                    "payments": [
                      {
                        "amount": 500,
                        "bank_account_number": 0,
                        "bank_code": null,
                        "branch_number": null,
                        "check_number": null,
                        "customer_first_name": "",
                        "customer_id": 534202302,
                        "customer_last_name": "Dan Group",
                        "due_date": "01/05/2026",
                        "payment_type": 2,
                        "project_id": null,
                        "receipt_date": "31/03/2026",
                        "receipt_link": null,
                        "receipt_number": 1786,
                        "receipt_type": 1,
                        "reference": null
                      },
                      {
                        "amount": 1687,
                        "bank_account_number": 0,
                        "bank_code": null,
                        "branch_number": null,
                        "check_number": null,
                        "customer_first_name": "",
                        "customer_id": 534202724,
                        "customer_last_name": "פלסאל פלסטיק בע\"מ",
                        "due_date": "03/05/2026",
                        "payment_type": 2,
                        "project_id": null,
                        "receipt_date": "03/05/2026",
                        "receipt_link": "https://api.rivhit.co.il/pdf/FileService.svc/GetDocument/000000123/f9e1cf78-991a-46e2-b9e6-d5d85b0f4425/true/1_1920",
                        "receipt_number": 1920,
                        "receipt_type": 1,
                        "reference": null
                      }
                    ]
                  }
                }
              }
            }
          },
          "400": {
            "description": "Request Error",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string",
                      "example": "Request Error"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error_code": {
                      "type": "integer",
                      "example": 0,
                      "description": "Error code of the response."
                    },
                    "client_message": {
                      "type": "string",
                      "example": "",
                      "description": "The Client Error Message."
                    },
                    "debug_message": {
                      "type": "string",
                      "example": "",
                      "description": "The Response Error Message."
                    },
                    "data": {
                      "type": "array",
                      "example": null,
                      "description": "Error Data."
                    }
                  }
                }
              }
            }
          }
        },
        "description": "### Get Payment Report"
      }
    }
  },
  "servers": [
    {
      "url": "https://api.rivhit.co.il/"
    }
  ]
}
```