NGngpvan

/financialBatches/{financialBatchId}

Changed on

Retrieve a Financial Batch by financialBatchId.

get/financialBatches/{financialBatchId}

Request

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

Path parameters

financialBatchIdinteger required

Required; Unique identifier of the Financial Batch

Response

200

financialBatchIdinteger
financialBatchNumberinteger
financialBatchNamestring
designationIdinteger
expectedContributionCountinteger
expectedContributionTotalAmountinteger
bankAccountIdunknown
dateDepositedunknown
depositNumberunknown
checkDateunknown
checkNumberunknown
isOpenboolean
dateOpenedstring
dateClosedunknown
isAutoGeneratedboolean

Example response

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

Changes