Get Rollup Status - for Template Cash Flows

GET /ws/rest/service/v1/cashflow/template/rollup/status/{template_number}

Purpose

Get Rollup Status of template cash flows.

Request Format

All parameters should be URL encoded.

Request Parameters

The following parameters can be specified in the request:

  • template_number: (Optional) Specify the template number to get the rollup status of template cash flows; otherwise, to get the rollup status of standard template cash flows
  • URL parameter: (Optional) Specify an optional filter parameter in the following format.

    filter= {"names":["Cash Flow 1" ,"Cash Flow 2"]}

    Filter can be used to filter on name to get the cash flow rollup status. If cash flow does not exist with the given name, that name will be ignored. Cash flows of other names will be returned.

Response Format

A JSON object is returned in the following format.

{

"data": [],

"message": [],

"status": <REST status code value>

}

A successful response displays a status code 200.

A failed response displays a message with a status code.

Sample Success Response

{

"data": [

{

"name": "Cash Flow 1",

"id": "21",

"status": "Active"

}

],

"message": [ "success" ],

"status": 200

}