create_recurring_invoice
Automatically generate invoices at customizable intervals for recurring billing needs. Specify frequency, start/end dates, and invoice counts to streamline regular payments for services or contracts.
Instructions
Create a recurring invoice that will automatically generate new invoices based on specified frequency.
Useful for contracts or services that bill on a regular basis.
Always ask for reccurring configuration, for example:
- How often to generate invoices (weekly, monthly)
- Number of units for frequency (e.g. 1 for monthly = every month, 2 = every 2 months)
- Start date
- End date
- End invoice count (optional)
Ask for additional information if needed, for example:
- If the client is not found, ask for the client details and create a new client if necessary.
- If the invoice number is not provided, ask for it.
- If the due date is not provided, ask for it.
- If the payment terms are not provided, ask for it.
- If the bank details are not provided, ask for it.
Args:
client_id: ID of the client for the invoice
items: List of invoice items, each containing name, quantity, rate, vatRate and total
frequency_type: How often to generate invoices ("weekly", "monthly")
frequency_unit: Number of units for frequency (e.g. 1 for monthly = every month, 2 = every 2 months)
starts_from_date: Date to start generating invoices from (YYYY-MM-DD)
ends_on_date: Optional end date for recurring invoices (YYYY-MM-DD). Either ends_on_date or ends_on_invoice_count should be provided.
ends_on_invoice_count: Optional number of invoices to generate before stopping. Either ends_on_date or ends_on_invoice_count should be provided.
invoice_number: Base invoice number (will be auto-generated if not provided)
issued: Issue date in YYYY-MM-DD format
due_to: Due date in YYYY-MM-DD format
currency: Invoice currency (EUR, USD), by default it's EUR
payment_terms: Payment terms text
notes: Additional notes
language: Invoice language (en, de)
invoice_type: Type of invoice (SERVICES, GOODS)
is_vat_included: Whether prices include VAT
bank_name: Name of the bank
iban: IBAN for payments
bic: BIC/SWIFT code
create_qr: Whether to create payment QR code
color_schema: Invoice style color (hex code)
font: Invoice font (e.g. "Plus Jakarta Sans", "Inter")
is_to_send: Whether to send invoices automatically to client
settings_on_overdue: Configuration for overdue notifications
service_start_date: Service period start date (for SERVICES type)
service_end_date: Service period end date (for SERVICES type)
delivery_date: Delivery date (for GOODS type)
Returns:
Information about the created recurring invoice setup and always include the generated invoice pdf url from reportUrl field
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| bank_name | No | ||
| bic | No | ||
| client_id | Yes | ||
| color_schema | No | #FFFFFF | |
| create_qr | No | ||
| currency | No | EUR | |
| delivery_date | No | ||
| due_to | No | ||
| ends_on_date | No | ||
| ends_on_invoice_count | No | ||
| font | No | Plus Jakarta Sans | |
| frequency_type | Yes | ||
| frequency_unit | Yes | ||
| iban | No | ||
| invoice_number | No | ||
| invoice_type | No | SERVICES | |
| is_to_send | No | ||
| is_vat_included | No | ||
| issued | No | ||
| items | Yes | ||
| language | No | en | |
| notes | No | ||
| payment_terms | No | ||
| service_end_date | No | ||
| service_start_date | No | ||
| settings_on_overdue | No | ||
| starts_from_date | Yes |
Input Schema (JSON Schema)
{
"properties": {
"bank_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Bank Name"
},
"bic": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Bic"
},
"client_id": {
"title": "Client Id",
"type": "string"
},
"color_schema": {
"default": "#FFFFFF",
"title": "Color Schema",
"type": "string"
},
"create_qr": {
"default": false,
"title": "Create Qr",
"type": "boolean"
},
"currency": {
"default": "EUR",
"title": "Currency",
"type": "string"
},
"delivery_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Delivery Date"
},
"due_to": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Due To"
},
"ends_on_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Ends On Date"
},
"ends_on_invoice_count": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Ends On Invoice Count"
},
"font": {
"default": "Plus Jakarta Sans",
"title": "Font",
"type": "string"
},
"frequency_type": {
"title": "Frequency Type",
"type": "string"
},
"frequency_unit": {
"title": "Frequency Unit",
"type": "integer"
},
"iban": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Iban"
},
"invoice_number": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Invoice Number"
},
"invoice_type": {
"default": "SERVICES",
"title": "Invoice Type",
"type": "string"
},
"is_to_send": {
"default": false,
"title": "Is To Send",
"type": "boolean"
},
"is_vat_included": {
"default": false,
"title": "Is Vat Included",
"type": "boolean"
},
"issued": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Issued"
},
"items": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Items",
"type": "array"
},
"language": {
"default": "en",
"title": "Language",
"type": "string"
},
"notes": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Notes"
},
"payment_terms": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Payment Terms"
},
"service_end_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Service End Date"
},
"service_start_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Service Start Date"
},
"settings_on_overdue": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Settings On Overdue"
},
"starts_from_date": {
"title": "Starts From Date",
"type": "string"
}
},
"required": [
"client_id",
"items",
"frequency_type",
"frequency_unit",
"starts_from_date"
],
"title": "create_recurring_invoiceArguments",
"type": "object"
}