# Send a scheduled report now

`POST /businesses/{bid}/report-schedules/{report}/send`

Requires the `businesses` scope.

Sends the report to its addresses now, for a period you name (default: the last closed one). Owner only.

## Path parameters

| Name | Type | | Description |
|---|---|---|---|
| `bid` | string | **required** | Business id, from `POST /businesses`. |
| `report` | string | **required** |  One of: `workbook`, `full`, `profit`, `incomes`, `expenses`, `receivables`, `months`, `parties`, `documents_zip`, `movein`, `documents_csv`, `pcn874`. |

## Body

| Field | Type | | Description |
|---|---|---|---|
| `period` | string |  | `YYYY-MM`, `YYYY-Bn` or `YYYY`. Default: the last closed period. |

## Response

`200`: `{ "ok": true, … }`

| Field | Type | | Description |
|---|---|---|---|
| `ok` | boolean | **required** |  |
| `sent` | boolean | **required** | Whether a letter went out. |
| `results` | array of object |  |  |
| `to` | array of string |  |  |

Errors: `400`, `401`, `403`, `404`, `429`. Every failure answers `{ "error", "reason", "hint", "param", "doc_url", "retryable", "request_id" }`: branch on `reason`, and read `hint` for what to change (https://docs.billos.co.il/errors.md).

## Examples

### cURL

```bash
curl -X POST "$BASE/businesses/$BID/report-schedules/{report}/send" \
  -H "X-Api-Key: $KEY"
```
### Node

```node
const res = await fetch(`${BASE}/businesses/${BID}/report-schedules/{report}/send`, {
  method: 'POST',
  headers: {
    'X-Api-Key': KEY,
  },
})
const data = await res.json()
if (!data.ok) throw new Error(data.reason)
```
### Python

```python
import requests
res = requests.post(
    f"{BASE}/businesses/{BID}/report-schedules/{report}/send",
    headers={"X-Api-Key": KEY},
)
data = res.json()
```