# POST /api/v1/recurring

> Create recurring template

- **Tag:** recurring
- **Operation ID:** `create_recurring_template_api_v1_recurring_post`

## Description

Create a new recurring invoice or bill template.

## Authentication

Bearer token in `Authorization` header.
Required header: `x-business-id: <business uuid>`.

## Request body

Schema: `RecurringTemplateCreate`

- `name` (string · required) — Name/description of this recurring template
- `currency` (string) — Currency for generated documents (USD, CAD, AUD, EUR, or GBP)
- `frequency` (FrequencyEnum · required) → `FrequencyEnum` — How often to generate
- `days_until_due` (integer) — Days from generation until due date
- `day_of_month` (integer) — Day of month (1-31). Only applies to monthly/quarterly/annually frequencies; ignored for daily/weekly/biweekly. If the day doesn't exist in a month (e.g., 31 in February), generates on the last day instead. If omitted, uses the day from start_date.
- `day_of_week` (integer) — Day of week (0=Monday, 6=Sunday). Only applies to weekly/biweekly frequencies; ignored for other frequencies. If omitted, uses the weekday from start_date.
- `end_date` (string · date) — Stop generating after this date (null = indefinite). If both end_date and max_occurrences are set, whichever is reached first stops generation.
- `max_occurrences` (integer) — Stop after generating this many documents (null = unlimited). If both end_date and max_occurrences are set, whichever is reached first stops generation.
- `notes` (string) — Optional notes about this recurring template
- `recurrence_type` (app__api__v1__schemas__recurring__recurring__RecurrenceTypeEnum · required) → `app__api__v1__schemas__recurring__recurring__RecurrenceTypeEnum` — Type of document to generate
- `start_date` (string · date · required) — When to start generating
- `customer_id` (string) — Customer ID (required for invoice type)
- `auto_send` (boolean) — Automatically send invoices to customer on generation
- `vendor_id` (string) — Vendor ID (required for bill type)
- `template_data` (object · required) — Document template data (amount, description, line_items, etc.)

## Responses

### 201 — Successful Response

Schema: `RecurringTemplateResponse`

- `id` (string · required)
- `business_id` (string · required)
- `name` (string · required)
- `recurrence_type` (RecurrenceTypeEnum-Output · required) → `RecurrenceTypeEnum-Output`
- `status` (RecurringStatusEnum · required) → `RecurringStatusEnum`
- `frequency` (FrequencyEnum · required) → `FrequencyEnum`
- `start_date` (string · date · required)
- `end_date` (string · date)
- `next_occurrence` (string · date · required)
- `last_generated` (string · date-time)
- `day_of_month` (integer)
- `day_of_week` (integer)
- `max_occurrences` (integer)
- `occurrences_generated` (integer · required)
- `template_data` (object · required)
- `days_until_due` (integer · required)
- `auto_send` (boolean · required)
- `notes` (string)
- `customer` (CustomerSummary)
- `vendor` (VendorSummary)
- `created_at` (string · date-time · required)
- `updated_at` (string · date-time · required)
- `amount_in_dollars` (number)
- `frequency_display` (string · required)
- `days_until_next` (integer)
- `is_due` (boolean · required)
- `should_generate` (boolean · required)

### 400 — Bad Request - Invalid input

### 401 — Unauthorized - Authentication required

### 403 — Forbidden - Insufficient permissions

### 404 — Not Found - Resource does not exist

### 422 — Validation Error

Schema: `HTTPValidationError`

- `detail` (array · ValidationError) → `ValidationError`
  - `loc` (array · string | integer · required)
  - `msg` (string · required)
  - `type` (string · required)
  - `input` (object)
  - `ctx` (object)

## Code samples

### cURL

```bash
curl -X POST 'https://api.ondayzero.com/api/v1/recurring' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "frequency": "string",
  "recurrence_type": "string",
  "start_date": "2026-01-01",
  "template_data": {}
}'
```

### JavaScript

```javascript
const response = await fetch('https://api.ondayzero.com/api/v1/recurring', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer dz_your_token',
    'x-business-id': 'YOUR_BUSINESS_ID',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "name": "string",
  "frequency": "string",
  "recurrence_type": "string",
  "start_date": "2026-01-01",
  "template_data": {}
}),
});
const data = await response.json();
```

### Python

```python
import httpx

headers = {
    "Authorization": "Bearer dz_your_token",
    "x-business-id": "YOUR_BUSINESS_ID",
}

payload = {
  "name": "string",
  "frequency": "string",
  "recurrence_type": "string",
  "start_date": "2026-01-01",
  "template_data": {}
}

response = httpx.post("https://api.ondayzero.com/api/v1/recurring", headers=headers, json=payload)
data = response.json()
```

## See also

- HTML version: https://www.ondayzero.com/docs/reference/recurring/create-recurring-template
- OpenAPI slice: https://www.ondayzero.com/docs/reference/recurring/create-recurring-template/openapi.json
- Other endpoints in **recurring**: https://www.ondayzero.com/docs/reference/recurring