post https://api.banking.netevia.dev/Report/spendReport
This API endpoint generates a detailed spend report for customers based on the provided filters. It returns various financial data related to spending, refunds, transfers, and balances, with additional details about the customer's profile.
Body Parameters:
- agentsId (array of int32s | null): Optional list of agent IDs to filter the report by specific agents.
- isoId (int32 | null): Optional ISO ID for filtering data by specific ISO.
- profileIds (array of int32s | null): Optional list of profile IDs to retrieve data for specific customer profiles.
- reportDate (date-time, required): The date for which the report should be generated.
- havePoints (boolean): Flag indicating whether to include customers with reward points.
- profileType (int32): Type of profile being queried (e.g., personal, business).
- applicationStatus (string): Optional filter to retrieve customers based on their application status.
Response Structure:
The response is an array of objects with detailed information about customer spending and related financial data.
[
{
"id": 0, // Unique report ID
"userProfileId": 0, // ID of the user profile
"profileId": 0, // ID of the profile
"period": "2024-10-09T10:37:34.308Z", // Report period
"dayGeneration": "2024-10-09T10:37:34.308Z", // Date of report generation
"spendBalance": 0, // Total spend balance for the customer
"refunds": 0, // Total refunds issued
"atm": 0, // ATM transactions
"agentId": 0, // ID of the agent associated with the customer
"dba": "string", // Doing Business As (DBA) name
"legalName": "string", // Legal name of the customer
"email": "string", // Email address
"firstName": "string", // First name of the customer
"lastName": "string", // Last name of the customer
"transferACHOut": 0, // ACH transfers out
"transferACHIn": 0, // ACH transfers in
"transferInternal": 0, // Internal transfers
"merchantProfileId": 0, // Merchant profile ID
"state": 1, // Status or state of the profile (e.g., active, suspended)
"accountsBalance": 0, // Total balance of associated accounts
"status": "New" // Application or account status
}
]
Key Features:
- Customizable Filtering: Use agent IDs, ISO IDs, and profile IDs to target specific customers or groups.
- Comprehensive Financial Data: Captures all relevant financial activities, including spending, transfers, and refunds.
- Date-Based Reports: Allows the generation of reports for specific periods to track financial activities over time.
Summary:
The POST /Report/spendReport API is a robust tool for generating detailed customer spend reports, making it ideal for financial analysis and customer account management within the NetEvia banking system.