PUBLIC API v1

List of invoices of the company

GET /api/v1/companies/{company_pk}/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
`date_from`	query · `string (date)`	Not specified
`date_to`	query · `string (date)`	Not specified
`name`	query · `string`	Not specified
`no_trans`	query · `boolean`	Not specified
`page`	query · `integer`	A page number within the paginated result set.
`page_size`	query · `integer`	Number of results to return per page.
`paid_status`	query · `"paid" \| "unpaid"`	* `paid` - Paid * `unpaid` - Unpaid
`search`	query · `string`	Not specified
`status`	query · `"approved" \| "draft" \| "overdue" \| "paid" \| "pending" \| "removed" \| "saved" \| "sent" \| "uncollectible"`	* `draft` - Draft * `pending` - Pending * `overdue` - Overdue * `paid` - Paid * `uncollectible` - Uncollectible * `removed` - Removed * `saved` - Saved * `sent` - Sent * `approved` - Approved
`type`	query · `"cancel" \| "delivery_note" \| "invoice" \| "quote"`	* `invoice` - Invoice * `quote` - Quote * `delivery_note` - Delivery note * `cancel` - Cancel Invoice

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

type "invoice" | "quote" | "delivery_note" | "cancel" * `invoice` - Invoice * `quote` - Quote * `delivery_note` - Delivery note * `cancel` - Cancel Invoice

vatNumber string Not specified

company string (uuid) | null Not specified

client string (uuid) | null Not specified

invoiceNumberRequired string Not specified

paymentStatusRequired string Not specified

statusRequired 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

paymentDate string (date) | null 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
`id`	`string \| null`	The line's id (UUID), assigned by the server when the line is first written. Echo it on an update so the line keeps its identity; leave it out for a new line.
`name`Required	`string`	Not specified
`quantity`Required	`number (double)`	Not specified
`rate`Required	`integer`	Not specified
`vatRate`Required	`integer`	Not specified
`itemPriceNet`	`integer`	Not specified
`itemPriceGross`	`integer`	Not specified
`itemVatAmount`	`integer`	Not specified
`discountPercent`	`number (double)`	Not specified
`itemDiscountAmount`	`integer`	Not specified
`description`	`string`	Not specified
`discountNote`	`string`	Deprecated, use description.
`unit`	`"items" \| "hours" \| "days" \| "kilograms" \| "liters" \| "meters" \| "square_meters" \| "" \| null`	Not specified
`productId`	`string \| null`	Not specified
`companyCategory`	`string \| null`	Not specified
`gtuCode`	`"GTU_01" \| "GTU_02" \| "GTU_03" \| "GTU_04" \| "GTU_05" \| "GTU_06" \| "GTU_07" \| "GTU_08" \| "GTU_09" \| "GTU_10" \| "GTU_11" \| "GTU_12" \| "GTU_13" \| ""`	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

reportUrl string (uri) | null Not specified

transactionsRequired string (uuid)[] 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

ibanRequiredRead only string Not specified

bicRequiredRead only string Not specified

bankNameRequiredRead only string Not specified

historySnapshot object | null Not specified

remindersRequiredRead only

object[]

Not specified

Nested fields

Field	Type / accepted values	Description
`level`Required	`integer`	Not specified
`fee`	`string (decimal)`	Not specified
`subject`	`string`	Not specified
`sentAt`RequiredRead only	`string (date-time)`	Not specified
`source`	`string`	Not specified

settingsOnOverdue object | null Not specified

colorSchema string Not specified

font string Not specified

logo string (uri) | null Not specified

recurringDataRequired

object

Not specified

Nested fields

Field Type / accepted values Description

publicIdRequiredRead only string (uuid) Not specified

invoicesRequired

object[]

Not specified

Nested fields

Field	Type / accepted values	Description
`publicId`RequiredRead only	`string (uuid)`	Not specified
`status`	`"draft" \| "pending" \| "overdue" \| "paid" \| "uncollectible" \| "removed" \| "saved" \| "sent" \| "approved"`	* `draft` - Draft * `pending` - Pending * `overdue` - Overdue * `paid` - Paid * `uncollectible` - Uncollectible * `removed` - Removed * `saved` - Saved * `sent` - Sent * `approved` - Approved

context object | null Not specified

baseInvoicesRequiredRead only object[] Not specified

frequencyType "weekly" | "monthly" * `weekly` - Weekly * `monthly` - Monthly

frequencyUnit integer Not specified

isOngoing boolean Not specified

isToSend boolean Not specified

ksefStatus "pending" | "submitted" | "accepted" | "rejected" | "" Not specified

ksefReferenceNumber string Not specified

ksefSubmittedAt string (date-time) | null Not specified

isKsefReadonlyRequiredRead only boolean Not specified

onlinePaymentEnabled boolean Not specified

sourceContract string (uuid) | null Not specified

onlinePaymentRequiredRead 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 Missing scope, company mismatch, unsupported operation, or a plan/account restriction.

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.