---
title: "Preview upcoming recurring invoice dates"
method: GET
path: "/companies/{company}/recurring-invoices/{recurring_invoice}/preview"
tags: ["Recurring Invoices"]
---

# Preview upcoming recurring invoice dates

`GET /companies/{company}/recurring-invoices/{recurring_invoice}/preview`

## Request

- Base URL: `https://api.factuarea.com/v1`
- URL: `https://api.factuarea.com/v1/companies/{company}/recurring-invoices/{recurring_invoice}/preview`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`

Return the next scheduled run dates with their due dates and estimated totals. Defaults to 5 occurrences.

## Path parameters

- `company` string, uuid, required
- `recurring_invoice` string, uuid, required

## Query parameters

- `count` string
- `expand` string

## Headers

- `Factuarea-Version` string, date

## Response `200`

Upcoming dates. When expand=document is supplied, next_invoice includes the computed lines and totals without persisting an invoice.

- object
  - `data` RecurringInvoicePreviewDate[], required
    - `date` string, date, required
    - `due_date` string, date, required
    - `occurrence_number` integer, required
    - `estimated_total` string, required: Estimated total of the occurrence (EUR), as a 2-decimal string.
    - `will_be_sent` boolean, required
  - `next_invoice` RecurringInvoicePreviewDocument
    - `lines` object[], required
      - `quantity` number, required
      - `unit_price` string, required: Unit price (EUR), as a decimal string with the four-decimal scale of the column.
      - `tax_rate` number, required
      - `retention_rate` number, required
      - `surcharge_rate` number, required
      - `commercial_quantity` number, required
      - `subtotal` string, required: Line subtotal (EUR), as a 2-decimal string.
      - `tax` string, required: Line VAT amount (EUR), as a 2-decimal string.
      - `line_total` string, required: Line total (EUR), as a 2-decimal string.
      - `description` string, nullable, required
      - `commercial_unit_code` string, nullable, required
      - `base_unit_code` string, nullable, required
      - `conversion_factor` string, nullable, required
      - `base_quantity` string, nullable, required
      - `price_list_uuid` string, nullable, required
      - `price_list_name` string, nullable, required
      - `price_source` string, nullable, required
      - `price_unit_code` string, nullable, required
      - `configuration_uuid` string, nullable, required
      - `configuration_name` string, nullable, required
      - `configuration_signature` string, nullable, required
      - `price_semantics` string, nullable, required
      - `price_adjustment_total` string, nullable, required
      - `option_labels` string[], required
      - `option_adjustments_absorbed` boolean, nullable, required
    - `totals` object, required
      - `subtotal` string, required: Taxable base of the next invoice (EUR), as a 2-decimal string.
      - `tax` string, required: VAT of the next invoice (EUR), as a 2-decimal string.
      - `total` string, required: Total of the next invoice (EUR), as a 2-decimal string.

## Other responses

- `400`: `parameter_unknown` with `subcode` `retired_active_profile_header`: the retired `X-Active-Profile` header was sent; the company goes in the path. `parameter_invalid_format` on `Factuarea-Version`: the header is not a `YYYY-MM-DD` date. `unsupported_api_version`: the `Factuarea-Version` date is not a supported version.
- `401`: Missing or invalid API key.
- `403`: The request is authenticated but not allowed: the API key lacks the required scope (`insufficient_scope`), the plan does not include the public API or this feature (`addon_not_active`, `feature_not_available_in_plan`), or the module is not available with a test key (`module_not_available_in_sandbox`).
- `404`: The requested resource does not exist or belongs to another company.
- `429`: Rate limit exceeded. Retry after the duration in `Retry-After`.
- `500`: Unexpected server error.

---

[API](https://skmtc.dev/factuarea/apis/factuarea-public-api.md) · [All operations](https://skmtc.dev/factuarea/apis/factuarea-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/factuarea/apis/factuarea-public-api/revisions/718e77934422?raw)