PUBLIC API v1
Retrieve direct recurring
GET /api/v1/companies/{company_pk}/recurring-invoices/{public_id}/
Retrieve direct recurring data for recurring invoices of the company
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 |
public_idRequired | path · string (uuid) | Not specified |
Responses
200 Response fields
application/json
| Field | Type / accepted values | Description | ||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
publicIdRequiredRead only | string (uuid) | Not specified | ||||||||||||||||||||||||||||||||||||||||||||||||
vatNumber | string | Not specified | ||||||||||||||||||||||||||||||||||||||||||||||||
company | string (uuid) | null | Not specified | ||||||||||||||||||||||||||||||||||||||||||||||||
client | string (uuid) | null | Not specified | ||||||||||||||||||||||||||||||||||||||||||||||||
recurringNumberRequired | string | Not specified | ||||||||||||||||||||||||||||||||||||||||||||||||
discountPercents | integer | Not specified | ||||||||||||||||||||||||||||||||||||||||||||||||
currencyRequired | string | Not specified | ||||||||||||||||||||||||||||||||||||||||||||||||
currencyExchangedRequired | string | Not specified | ||||||||||||||||||||||||||||||||||||||||||||||||
invoicedItemsRequired | object[] | Not specifiedNested fields
| ||||||||||||||||||||||||||||||||||||||||||||||||
taxExemptReason | string | Not specified | ||||||||||||||||||||||||||||||||||||||||||||||||
paymentTerms | string | Not specified | ||||||||||||||||||||||||||||||||||||||||||||||||
notes | string | Not specified | ||||||||||||||||||||||||||||||||||||||||||||||||
instructions | string | Not specified | ||||||||||||||||||||||||||||||||||||||||||||||||
message | string | Not specified | ||||||||||||||||||||||||||||||||||||||||||||||||
language | "de" | "en" | "pl" | "it" | "es" | * `de` - German * `en` - English * `pl` - Polish * `it` - Italian * `es` - Spanish | ||||||||||||||||||||||||||||||||||||||||||||||||
fullCost | integer (int64) | null | Not specified | ||||||||||||||||||||||||||||||||||||||||||||||||
isVatIncluded | boolean | Not specified | ||||||||||||||||||||||||||||||||||||||||||||||||
invoiceType | "GOODS" | "SERVICES" | * `GOODS` - Goods * `SERVICES` - Services | ||||||||||||||||||||||||||||||||||||||||||||||||
companyEmail | string (email) | null | Not specified | ||||||||||||||||||||||||||||||||||||||||||||||||
fullCostOrigin | string (decimal) | null | Not specified | ||||||||||||||||||||||||||||||||||||||||||||||||
fullCostOriginExchanged | string (decimal) | null | Not specified | ||||||||||||||||||||||||||||||||||||||||||||||||
createQr | boolean | Not specified | ||||||||||||||||||||||||||||||||||||||||||||||||
historySnapshot | object | null | Not specified | ||||||||||||||||||||||||||||||||||||||||||||||||
invoicesRequired | object[] | Not specifiedNested fields
| ||||||||||||||||||||||||||||||||||||||||||||||||
baseInvoicesRequiredRead only | object[] | Not specified | ||||||||||||||||||||||||||||||||||||||||||||||||
repeatsOn | integer | Not specified | ||||||||||||||||||||||||||||||||||||||||||||||||
frequencyType | "weekly" | "monthly" | * `weekly` - Weekly * `monthly` - Monthly | ||||||||||||||||||||||||||||||||||||||||||||||||
frequencyUnit | integer | Not specified | ||||||||||||||||||||||||||||||||||||||||||||||||
startsFromDate | string (date) | null | Not specified | ||||||||||||||||||||||||||||||||||||||||||||||||
endsOnDate | string (date) | null | Not specified | ||||||||||||||||||||||||||||||||||||||||||||||||
endsOnInvoiceCount | integer | null | Not specified | ||||||||||||||||||||||||||||||||||||||||||||||||
isOngoing | boolean | Not specified | ||||||||||||||||||||||||||||||||||||||||||||||||
sourceContract | string (uuid) | null | Not specified | ||||||||||||||||||||||||||||||||||||||||||||||||
paymentDueDays | integer | null | Not specified | ||||||||||||||||||||||||||||||||||||||||||||||||
billingInAdvance | boolean | Not specified | ||||||||||||||||||||||||||||||||||||||||||||||||
lifeCycleStatus | "in_progress" | "finished" | "cancelled" | "removed" | * `in_progress` - In progress * `finished` - Finished * `cancelled` - Cancelled * `removed` - Removed | ||||||||||||||||||||||||||||||||||||||||||||||||
context | object | null | Not specified | ||||||||||||||||||||||||||||||||||||||||||||||||
settingsOnOverdue | object | null | Not specified | ||||||||||||||||||||||||||||||||||||||||||||||||
isToSend | boolean | Not specified | ||||||||||||||||||||||||||||||||||||||||||||||||
onlinePaymentEnabled | boolean | 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.