Docs home

Payment Report

Returns the payments received by your organization in a date range, either as totals per day, week, month, quarter or year, or as a detailed list of payments. Use it to reconcile collections with your bank or payment gateway.

GET/reports/payment
Payment Report
curl --request GET \
  --url 'https://<your-api-host>/nuSource/api/v1/reports/payment?startDate=09-08-2023&endDate=07-09-2023&timeStep=1&reportDetailsType=2&page=1&per_page=25' \
  --header 'APIKEY: <your-api-key>' \
  --header 'ORGID: <your-org-id>'
{
  "code": 200,
  "message": "Payment Report Details",
  "result": {
    "reportDetails": [
      {
        "payment_day": "22-12-2024",
        "transactions": 0,
        "total_amount": 0
      },
      {
        "payment_day": "23-12-2024",
        "transactions": 0,
        "total_amount": 0
      },
      {
        "payment_day": "24-12-2024",
        "transactions": 0,
        "total_amount": 0
      },
      {
        "payment_day": "25-12-2024",
        "transactions": 0,
        "total_amount": 0
      },
      {
        "payment_day": "26-12-2024",
        "transactions": 0,
        "total_amount": 0
      },
      {
        "payment_day": "27-12-2024",
        "transactions": 0,
        "total_amount": 0
      },
      {
        "payment_day": "28-12-2024",
        "transactions": 0,
        "total_amount": 0
      },
      {
        "payment_day": "29-12-2024",
        "transactions": 0,
        "total_amount": 0
      },
      {
        "payment_day": "30-12-2024",
        "transactions": 0,
        "total_amount": 0
      },
      {
        "payment_day": "31-12-2024",
        "transactions": 0,
        "total_amount": 0
      },
      {
        "payment_day": "01-01-2025",
        "transactions": 0,
        "total_amount": 0
      },
      {
        "payment_day": "02-01-2025",
        "transactions": 1,
        "total_amount": "1000.00"
      },
      {
        "payment_day": "03-01-2025",
        "transactions": 0,
        "total_amount": 0
      },
      {
        "payment_day": "04-01-2025",
        "transactions": 0,
        "total_amount": 0
      },
      {
        "payment_day": "05-01-2025",
        "transactions": 0,
        "total_amount": 0
      },
      {
        "payment_day": "06-01-2025",
        "transactions": 0,
        "total_amount": 0
      },
      {
        "payment_day": "07-01-2025",
        "transactions": 0,
        "total_amount": 0
      },
      {
        "payment_day": "08-01-2025",
        "transactions": 0,
        "total_amount": 0
      },
      {
        "payment_day": "09-01-2025",
        "transactions": 1,
        "total_amount": "10.00"
      },
      {
        "payment_day": "10-01-2025",
        "transactions": 0,
        "total_amount": 0
      },
      {
        "payment_day": "11-01-2025",
        "transactions": 0,
        "total_amount": 0
      },
      {
        "payment_day": "12-01-2025",
        "transactions": 0,
        "total_amount": 0
      },
      {
        "payment_day": "13-01-2025",
        "transactions": 0,
        "total_amount": 0
      },
      {
        "payment_day": "14-01-2025",
        "transactions": 0,
        "total_amount": 0
      },
      {
        "payment_day": "15-01-2025",
        "transactions": 0,
        "total_amount": 0
      },
      {
        "payment_day": "16-01-2025",
        "transactions": 0,
        "total_amount": 0
      },
      {
        "payment_day": "17-01-2025",
        "transactions": 0,
        "total_amount": 0
      },
      {
        "payment_day": "18-01-2025",
        "transactions": 0,
        "total_amount": 0
      },
      {
        "payment_day": "19-01-2025",
        "transactions": 0,
        "total_amount": 0
      },
      {
        "payment_day": "20-01-2025",
        "transactions": 0,
        "total_amount": 0
      }
    ],
    "organizationcurrency": {
      "currency_id": 49,
      "currency_symbol": "₹",
      "position": 1,
      "num_of_decimals": 2
    }
  },
  "page_context": {
    "page": 1,
    "per_page": 200,
    "has_more_page": false,
    "total_rows": 30
  }
}

Access: Institute admins, plus custom roles with payments report access.

Query parameters
report_details_typeintegerrequired
1 totals per period (chart), 2 totals per period (table), 3 payment list.
First day, as DD-MM-YYYY. Default today.
end_datestring
Last day (whole day included), as DD-MM-YYYY. Default today.
time_stepinteger
Period for types 1 and 2: 1 day (default), 2 week, 3 month, 4 quarter, 5 year.
courseinteger
Only payments for this course.
pageinteger
Page number. Default 1.
per_pageinteger
Rows per page, up to 200. Default 200.
full_pageinteger
1 returns all rows without paging.
A oldest first or D newest first (default).
Only payments in this currency.
filtersJSON string
Optional filters (fields below).
is_exportinteger
With type 3, 1 downloads the list as a CSV file instead of JSON.
With is_export, 1 exports only the columns of your saved view.

Fields in the filters object:

Name Required Type Description
invoice_type No integer Only this invoice type.
payment_mode No integer Only this payment mode.
payment_gateway No integer Only payments through this gateway.
currency_id No integer Only this currency.
paid_amount_range No object {"start_amt": ..., "end_amt": ...} amount range.
invoice_date_range No object {"start_date": ..., "end_date": ...} invoice date range (date string or Unix timestamp).
type_of_transaction No string Domestic (your base currency) or anything else for international.
earnings_range No object {"start_amt": ..., "end_amt": ...} collected amount range.
product_type No array or comma-separated string Only these product types.
Response200application/json
codeinteger
Example: 200
messagestring
Example: Payment Report Details
resultobject
Show child attributesHide child attributes
Show child attributesHide child attributes
The period label, for example 22-12-2024
Example: 22-12-2024
Show child attributesHide child attributes
Example: 1
Example: 200
Example: false
Example: 30

Notes: Dates must be DD-MM-YYYY, otherwise "Invalid Date Input You have Passed". More than 200 per page fails with "You Only Get 200 Records Per Page". Rate limit: 100 requests per minute; going over locks you out for 30 minutes.

Updated yesterday

Ask AI