PUBLIC API v1

List of recurring data of the company

GET /api/v1/companies/{company_pk}/recurring-invoices/

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_pk`Required	path · `string (uuid)`	Not specified
`page`	query · `integer`	A page number within the paginated result set.
`page_size`	query · `integer`	Number of results to return per page.

Responses

200 Response fields

application/json

Field Type / accepted values Description

countRequired integer Not specified

next string (uri) | null Not specified

previous string (uri) | null Not specified

resultsRequired

object[]

Not specified

Nested fields

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 specified

Nested fields

Field	Type / accepted values	Description
`name`Required	`string`	Not specified
`quantity`Required	`number (double)`	Not specified
`rate`Required	`number (double)`	Not specified
`vatRate`Required	`integer`	Not specified
`itemPriceNet`Required	`integer`	Not specified
`itemPriceGross`Required	`integer`	Not specified
`itemVatAmount`Required	`integer`	Not specified
`discountPercent`	`number (double)`	Not specified
`itemDiscountAmount`	`integer`	Not specified
`description`	`string`	Not specified
`unit`	`"items" \| "hours" \| "days" \| "kilograms" \| "liters" \| "meters" \| "square_meters" \| "" \| null`	Not specified
`productId`	`string \| null`	Not specified
`companyCategory`	`string \| null`	Not specified
`gtuCode`	`string`	Not specified
`isSplitPayment`	`boolean`	Not specified

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 specified

Nested fields

Field	Type / accepted values	Description
`publicId`RequiredRead only	`string (uuid)`	Not specified
`vatNumber`	`string`	Not specified
`invoiceNumber`Required	`string`	Not specified
`status`Required	`string`	Not specified
`issued`	`string (date) \| null`	Not specified
`deliveryDate`	`string (date) \| null`	Not specified
`dueTo`	`string (date) \| null`	Not specified
`serviceStartDate`	`string (date) \| null`	Not specified
`serviceEndDate`	`string (date) \| null`	Not specified
`reportUrl`	`string (uri) \| null`	Not specified
`fullCostOriginExchanged`	`string (decimal) \| null`	Not specified
`settingsOnOverdue`	`object \| null`	Not specified

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
`detail`RequiredRead only	`string`	Not specified

403 Response fields

application/json

Field	Type / accepted values	Description
`detail`RequiredRead only	`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.