Recurring Invoices
Create a recurring invoice from scratch
Creates a new recurring invoice template with all template data (lines, recipient, series, payment) and recurrence configuration, without needing an existing invoice.
AuthorizationBearer <token>
API Key authentication.
Format: Authorization: Bearer beel_sk_<key>
Scopes: API Keys use the same scopes as OAuth2 tokens. Each key is created with
specific scopes that limit which endpoints it can access. The required scope for each
endpoint is documented in the operation's security section under OAuth2.
Obtaining Keys: API Keys are managed from the BeeL dashboard
Security: API Keys are secret credentials. Do not share them or store them in source code
In: header
namestring
Length
length <= 255day_of_monthinteger
Range
1 <= value <= 31start_datestring
Format
datepreview_days?integer
Days before emission date to create a draft for review. 0 means immediate emission.
Default
0Range
0 <= value <= 30end_date?string|null
Format
dateseries_idstring
Format
uuidinvoice_typestring
Value in
"STANDARD" | "SIMPLIFIED"customer_id?string|null
Format
uuidlines
Items
1 <= itemspayment_method?string
Value in
"NONE" | "BANK_TRANSFER" | "CARD" | "CASH" | "CHECK" | "DIRECT_DEBIT" | "OTHER"payment_iban?string|null
payment_swift?string|null
payment_term_days?integer|null
notes?string|null
verifactu_enabled?boolean
Default
falsesend_automatically?boolean
Default
falseemail_configuration?|null
Response Body
application/json
application/json
curl -X POST "https://app.beel.es/api/v1/recurring-invoices" \ -H "Content-Type: application/json" \ -d '{ "name": "string", "day_of_month": 1, "start_date": "2019-08-24", "series_id": "0f6582ac-1e7e-41dc-a63a-24fccd074d0c", "invoice_type": "STANDARD", "lines": [ { "description": "string", "quantity": 0.01, "unit_price": 0, "vat_rate": 0 } ] }'{
"success": true,
"data": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"frequency": "MONTHLY",
"day_of_month": 0,
"start_date": "2019-08-24",
"end_date": "2019-08-24",
"next_generation": "2019-08-24",
"preview_days": 3,
"status": "ACTIVE",
"series_id": "0f6582ac-1e7e-41dc-a63a-24fccd074d0c",
"series_code": "string",
"invoice_type": "STANDARD",
"customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
"recipient_fiscal_name": "string",
"recipient_nif": "string",
"lines": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"order": 0,
"description": "string",
"quantity": 0,
"unit": "string",
"unit_price": 0,
"discount_percentage": 0,
"tax_type": "string",
"vat_rate": 0,
"regime_key": "string",
"equivalence_surcharge_rate": 0,
"irpf_rate": 0
}
],
"payment_method": "string",
"notes": "string",
"verifactu_enabled": true,
"send_automatically": true,
"email_configuration": {
"recipients": [
"string"
],
"cc": [
"string"
],
"subject": "string",
"message": "string"
},
"generated_invoices": 0,
"last_generation": "2019-08-24T14:15:22Z",
"source_invoice_id": "0c7d5f47-8759-4ef4-82d5-705413539f77",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"meta": {
"timestamp": "2025-01-15T10:30:00Z",
"request_id": "4bf92f3577b34da6a3ce929d0e0e4736"
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Validation error",
"details": {
"field_name": "Field is required"
}
},
"meta": {
"timestamp": "2025-01-15T10:30:00Z",
"request_id": "4bf92f3577b34da6a3ce929d0e0e4736"
}
}