PUBLIC API v1
First run dates of a rule that is not saved yet
POST /api/v1/companies/{company_pk}/recurring-invoices/schedule-preview/
Return detail-serialized created instance
Permission: read_invoices · Direct link
Company-scoped. Account permissions, plan limits and document state still apply.
Path and query parameters
| Parameter | Location / type | Description |
|---|---|---|
company_pkRequired | path · string (uuid) | Not specified |
Request body
application/json
| Field | Type / accepted values | Description |
|---|---|---|
intervalRequired | "week" | "month" | "year" | * `week` - Week * `month` - Month * `year` - Year |
intervalCount | integer | Not specified |
startsOnRequired | string (date) | Not specified |
endsOn | string (date) | null | Not specified |
endsAfter | integer | null | Not specified |
billingInAdvance | boolean | Not specified |
paymentDueDays | integer | Not specified |
count | integer | Not specified |
periodStart | string (date) | null | The period of the first run. Unset, periods follow the run dates. |
runsMade | integer | Invoices made already, for `ends_after`. |
multipart/form-data
| Field | Type / accepted values | Description |
|---|---|---|
intervalRequired | "week" | "month" | "year" | * `week` - Week * `month` - Month * `year` - Year |
intervalCount | integer | Not specified |
startsOnRequired | string (date) | Not specified |
endsOn | string (date) | null | Not specified |
endsAfter | integer | null | Not specified |
billingInAdvance | boolean | Not specified |
paymentDueDays | integer | Not specified |
count | integer | Not specified |
periodStart | string (date) | null | The period of the first run. Unset, periods follow the run dates. |
runsMade | integer | Invoices made already, for `ends_after`. |
application/x-www-form-urlencoded
| Field | Type / accepted values | Description |
|---|---|---|
intervalRequired | "week" | "month" | "year" | * `week` - Week * `month` - Month * `year` - Year |
intervalCount | integer | Not specified |
startsOnRequired | string (date) | Not specified |
endsOn | string (date) | null | Not specified |
endsAfter | integer | null | Not specified |
billingInAdvance | boolean | Not specified |
paymentDueDays | integer | Not specified |
count | integer | Not specified |
periodStart | string (date) | null | The period of the first run. Unset, periods follow the run dates. |
runsMade | integer | Invoices made already, for `ends_after`. |
Responses
200 Response fields
application/json
| Field | Type / accepted values | Description |
|---|---|---|
runOnRequired | string (date) | Not specified |
dueToRequired | string (date) | Not specified |
periodStartRequired | string (date) | Not specified |
periodEndRequired | string (date) | Not specified |
400 Response fields
application/json
| Field | Type / accepted values | Description |
|---|---|---|
fieldRequired | string | Not specified |
code | integer | Not specified |
messageRequired | string | Not specified |
type_ | string | Not specified |
401 Response fields
application/json
| Field | Type / accepted values | Description |
|---|---|---|
detailRequiredRead only | string | Not specified |
403 Response fields
application/json
| Field | Type / accepted values | Description |
|---|---|---|
detailRequiredRead only | string | Not specified |
404 Response fields
application/json
| Field | Type / accepted values | Description |
|---|---|---|
detailRequired | string | Not specified |
codeRequired | integer | Not specified |
type_Required | string | Not specified |
fieldRequired | string | Not specified |
429 Rate limit exceeded. Wait for the Retry-After header before retrying.
Use the base URL https://api.norman.finance/api/v1. Sign up or log in to Norman to create an API key, then send it as a Bearer token. For an OpenAPI JSON file, contact support.