---
title: "Handle Preview Invoice Number"
method: POST
path: "/api/v1/pm_invoice/preview_invoice_number"
---

# Handle Preview Invoice Number

`POST /api/v1/pm_invoice/preview_invoice_number`

## Request

- Base URL: `https://api.caresquare.com.au` (the document declares no server; this is the origin it was published from)
- URL: `https://api.caresquare.com.au/api/v1/pm_invoice/preview_invoice_number`
- Auth: none declared

The invoice number Generate Fee would use for this payload. When the base
number is already in use, `exists` is true and `invoice_number` carries the
next free -A, -B suffix. Nothing is written, including the custom counter.

## Request body

- GeneratePmInvoicesPayload
  - `billing_period_from` string, required
  - `billing_period_to` string, required
  - `participant_id` string, required
  - `plan_manager_id` string, required
  - `setup` boolean
  - `unit_price` number, nullable
  - `monthly_in_arrears` boolean, nullable
  - `automatic_price_adjustment` boolean, nullable
  - `manual` boolean

## Response `200`

Successful Response

- PmInvoiceNumberPreview
  - `base_invoice_number` string, required
  - `invoice_number` string, required
  - `exists` boolean, required

## Other responses

- `422`: Validation Error

## Changes

- **2026-11-13** `343e7f4855e0`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/caresquare/apis/caresquare-api/changes/api/v1/pm_invoice/preview_invoice_number/post.md)

---

[API](https://skmtc.dev/caresquare/apis/caresquare-api.md) - [All operations](https://skmtc.dev/caresquare/apis/caresquare-api/llms.txt) - [OpenAPI document](https://skmtc.dev/caresquare/apis/caresquare-api/revisions/9d14b6cbc177?raw)