# Read a cash flow

One expected movement of money: its schedule and deal, type, direction, method and currency, the expected amount and due date, its place in the run, what actually landed and when, its external transaction and batch ids, and its status with a failure's reason and code.

Access class: `workspace`.

## Endpoint

`GET /v1/cash-flows/{id}`

## Parameters

| Name | In | Type | Required |
| --- | --- | --- | --- |
| id | path | string | Yes |
| body | query | null | No |
| params | query | object | No |
| query | query | object | No |

## Responses

### 200

the action's answer

Content type: `application/json`.

```json
{
  "data": {
    "actualAmountMinor": 1,
    "batchId": "",
    "counterpartyId": 1,
    "createdAt": "string",
    "currency": "string",
    "dealRowId": "",
    "detail": {},
    "direction": "string",
    "dueDate": "string",
    "expectedAmountMinor": 1,
    "externalTransactionId": "",
    "facilityId": 1,
    "failureCode": "string",
    "failureReason": "string",
    "flowType": "string",
    "id": 1,
    "maxRetries": 1,
    "method": "string",
    "notes": "string",
    "processedDate": "string",
    "retryCount": 1,
    "scheduleId": 1,
    "sequenceNumber": 1,
    "settledDate": "string",
    "status": "string",
    "totalPayments": 1,
    "updatedAt": "string"
  }
}
```

### default

a refusal: `{"error": "<what a person needs to read>"}`. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.

Content type: `application/json`.

```json
{
  "error": "string"
}
```
