Display Spend Report Data by Customer

This endpoint generates a detailed spend report for customers based on the provided filters. It returns comprehensive financial data including spending activity, refunds, ATM transactions, ACH transfers, internal transfers, and account balances, along with customer profile details. The report is date-based, allowing partners to track financial activities for a specific period.

Endpoint

POST /Report/spendReport

Authentication

Bearer token required. Obtain via:

POST https://api.banking.netevia.dev/api/auth/v2

Include in header: Authorization: Bearer {token}
Token lifetime: 10 minutes. Refresh via POST /api/auth/refresh.

When to use

Use this endpoint when you need a consolidated view of customer spending activity for a given reporting period. It is suitable for financial analysis, compliance reporting, and account management — for example, to review all customers with outstanding balances, filter by agent or ISO, or identify customers by application status. Partners and agents can narrow results by supplying specific profile IDs, agent IDs, or ISO IDs to scope the report to their relevant portfolio.

Request Body

{
  "reportDate": "2024-10-01T00:00:00.000Z",
  "agentsId": [101, 102],
  "isoId": 55,
  "profileIds": [2001, 2002, 2003],
  "havePoints": false,
  "profileType": 2,
  "applicationStatus": "Approved"
}

Response

200 OK

Returns an array of spend report objects. Each object contains financial activity totals and customer profile information for the specified reporting period.

[
  {
    "id": 8842,
    "userProfileId": 1045,
    "profileId": 2001,
    "period": "2024-10-01T00:00:00.000Z",
    "dayGeneration": "2024-10-09T10:37:34.308Z",
    "spendBalance": 358400,
    "refunds": 5000,
    "atm": 20000,
    "agentId": 101,
    "dba": "Acme Supplies Co.",
    "legalName": "Acme Supplies LLC",
    "email": "[email protected]",
    "firstName": "Jane",
    "lastName": "Smith",
    "transferACHOut": 100000,
    "transferACHIn": 250000,
    "transferInternal": 50000,
    "merchantProfileId": 3301,
    "state": 12,
    "accountsBalance": 1520000,
    "status": "Approved"
  }
]

Error Codes

Common Mistakes

• Omitting the required reportDate field — this will result in a 400 error. Always provide a valid ISO 8601 date-time string.
• Passing an invalid applicationStatus value not in the allowed enum list (e.g., using "Active" instead of "Approved"), which will cause a validation error.
• Providing profileType as a string (e.g., "business") instead of its integer enum value (e.g., 2).
• Expecting monetary values in dollars — all financial amounts (spendBalance, refunds, atm, transferACHOut, transferACHIn, transferInternal, accountsBalance) are returned in cents.

Related Endpoints

• POST /api/auth/v2 — Obtain a Bearer token for authentication
• POST /api/auth/refresh — Refresh an expiring Bearer token
• GET /Profile/{profileId} — Retrieve details for a specific customer profile
• GET /Report/transactionReport — Retrieve transaction-level report data for customers

Example

curl -X POST https://api.banking.netevia.dev/Report/spendReport \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "reportDate": "2024-10-01T00:00:00.000Z",
    "agentsId": [101],
    "isoId": 55,
    "profileIds": [2001, 2002],
    "havePoints": false,
    "profileType": 2,
    "applicationStatus": "Approved"
  }'