NGngpvan

/financialBatches

Changed on

Search for Financial Batches, with optional filtering. All query-string filters are optional.

get/financialBatches

Request

  • Base URL
    https://api.securevan.com/v4
  • URL
    https://api.securevan.com/v4/financialBatches
  • Auth
    HTTP basic

Query parameters

searchKeywordstring

Filter to batches whose names contain this text.

includeUnassignedboolean

If true, include the special Unassigned batch in the response. Default is true.

includeAllAutoGeneratedboolean

If true, includes autogenerated batches. Default is true.

includeAllStatusesboolean

If true, includes closed batches. Default is true.

Response

200

Example response

{
  "items": [
    {
      "financialBatchId": 825,
      "financialBatchNumber": 8675308,
      "financialBatchName": "Example Batch",
      "designationId": 122,
      "expectedContributionCount": 10,
      "expectedContributionTotalAmount": 500,
      "isOpen": true,
      "dateOpened": "2019-08-01T10:00:00Z"
    }
  ]
}

Changes