PUBLIC API v1

companies_recurring_invoices_pause_create

POST /api/v1/companies/{company_pk}/recurring-invoices/{public_id}/pause/

Return detail-serialized created instance

Permission: write_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
`public_id`Required	path · `string (uuid)`	Not specified

Responses

200 Response fields

application/json

Field Type / accepted values Description

publicIdRequiredRead only string (uuid) Not specified

status "active" | "paused" | "ended" * `active` - Active * `paused` - Paused * `ended` - Ended

lastError string Not specified

nextRunOn string (date) | null Not specified

periodStartRequiredRead only string (date) | null Not specified

runsMade integer Not specified

fullCost integer (int64) | null Not specified

fullCostOrigin string (decimal) | null Not specified

isReverseCharged boolean Not specified

createdRequiredRead only string (date-time) Not specified

interval "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

paymentDueDays integer Not specified

billingInAdvance boolean Not specified

mode "draft" | "issue" | "send" * `draft` - Create a draft * `issue` - Issue * `send` - Issue and send

client string (uuid) | null Not specified

invoiceType "GOODS" | "SERVICES" * `GOODS` - Goods * `SERVICES` - Services

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

currencyRequired string Not specified

currencyExchangedRequired string Not specified

language "de" | "en" | "pl" | "it" | "es" * `de` - German * `en` - English * `pl` - Polish * `it` - Italian * `es` - Spanish

isVatIncluded boolean Not specified

discountPercents integer Not specified

paymentTerms string Not specified

notes string Not specified

instructions string Not specified

message string Not specified

taxExemptReason string | null Not specified

companyEmail string (email) | null Not specified

createQr boolean Not specified

settingsOnOverdue object | null Not specified

mailingData object | null Not specified

onlinePaymentEnabled boolean Not specified

documentDesign

object

Not specified

Nested fields

Field	Type / accepted values	Description
`template`Required	`"heritage" \| "regent" \| "meridian" \| "horizon" \| "atelier" \| "epoque" \| "sovereign"`	* `heritage` - heritage * `regent` - regent * `meridian` - meridian * `horizon` - horizon * `atelier` - atelier * `epoque` - epoque * `sovereign` - sovereign
`version`	`1`	* `1` - 1
`logoSize`	`integer`	Not specified
`textSize`	`"small" \| "medium" \| "large"`	* `small` - small * `medium` - medium * `large` - large
`spacing`	`"compact" \| "standard" \| "spacious"`	* `compact` - compact * `standard` - standard * `spacious` - spacious
`tableBorders`	`"none" \| "dividers" \| "grid"`	* `none` - none * `dividers` - dividers * `grid` - grid

font string Not specified

colorSchema string Not specified

sourceContract string (uuid) | null Not specified

clientName string Not specified

upcomingRequiredRead only object[] Not specified

invoicesRequiredRead only object[] Not specified

400 Response fields

application/json

Field	Type / accepted values	Description
`field`Required	`string`	Not specified
`code`	`integer`	Not specified
`message`Required	`string`	Not specified
`type_`	`string`	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

404 Response fields

application/json

Field	Type / accepted values	Description
`detail`Required	`string`	Not specified
`code`Required	`integer`	Not specified
`type_`Required	`string`	Not specified
`field`Required	`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.