Skip to content

Reports Client billing

Overview

Retrieve client billing details within a date range for a product.

Path

/v1/realpay/{merchant_number}/reports/client_billing_report/{product}

Path Parameters

  • merchant_number (string, required)
  • product (string, required)

Common Query Parameters

  • Version (string, required, default: v1)

Filter Query Parameters

  • StartDate (string, required): Format YYYY-MM-DD HH24:MI
  • EndDate (string, required): Format YYYY-MM-DD HH24:MI
  • ClientNumber (string, optional)

GET Client Billing Report

Retrieve client billing data.

Success Response (200) Schema

ClientBillingReportGetResponse

Response Example (200)

{
  "ClientBillingReportGetResponse": [
    {
      "BillingDate": "2024-05-07 16:00",
      "ClientNumber": "L11306666",
      "ContractNumber": "C1603",
      "ContractSequence": 9011154048,
      "BillingDescription": "Monthly fee",
      "Amount": 50.00,
      "TaxAmount": 7.50
    }
  ],
  "APIResponse": {
    "CallSequence": 7271,
    "Status": "SUCCESS",
    "Version": "1.0.0",
    "Name": "INTERNAL NAME OF CALL"
  }
}

Error Responses

  • 400 BadRequest
  • 401 Unauthorized
  • 404 NotFound
  • 500 InternalError
  • 503 ServiceUnavailable