PUBLIC API v1

List of attachments

GET /api/v1/companies/{company_pk}/attachments/

Get a list of attachments for the company (by company pk). Results are ordered by value_date desc by default, use `ordering` to override.

Permission: read_documents · Direct link

Company-scoped. Account permissions, plan limits and document state still apply.

Parameter	Location / type	Description
`brand_name`	query · `string`	Not specified
`company_pk`Required	path · `string (uuid)`	Not specified
`created_from`	query · `string (date)`	Not specified
`created_to`	query · `string (date)`	Not specified
`date_from`	query · `string (date)`	Filter by value_date (or created, when the document has no value_date) >= date_from (inclusive).
`date_to`	query · `string (date)`	Filter by value_date (or created, when the document has no value_date) <= date_to (inclusive).
`description`	query · `string`	Not specified
`file_name`	query · `string`	Not specified
`has_type`	query · `"contract" \| "invoice" \| "other" \| "receipt"`	* `invoice` - Invoice * `receipt` - Receipt * `contract` - Contract * `other` - Other
`linked`	query · `boolean`	Not specified
`ordering`	query · `string`	Sort field: value_date, created, amount. Prefix with `-` for desc.
`page`	query · `integer`	A page number within the paginated result set.
`page_size`	query · `integer`	Number of results to return per page.
`search`	query · `string`	Case-insensitive search across brand_name, description, file_name and attachment_number.

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
`publicId`RequiredRead only	`string (uuid)`	Not specified
`created`RequiredRead only	`string (date-time)`	Not specified
`file`	`string (uri) \| null`	Not specified
`transactions`Required	`string (uuid)[]`	Not specified
`company`Required	`string (uuid)`	Not specified
`attachmentType`	`"invoice" \| "receipt" \| "contract" \| "other"`	* `invoice` - Invoice * `receipt` - Receipt * `contract` - Contract * `other` - Other
`amount`	`string (decimal) \| null`	Not specified
`amountExchanged`	`string (decimal) \| null`	Not specified
`attachmentNumber`	`string`	Not specified
`brandName`	`string`	Not specified
`currency`	`string`	Not specified
`currencyExchanged`	`string \| null`	Not specified
`description`	`string`	Not specified
`supplierCountry`	`"DE" \| "PL" \| "DOMESTIC" \| "INSIDE_EU" \| "OUTSIDE_EU" \| ""`	Not specified
`valueDate`	`string (date-time) \| null`	Not specified
`vatSumAmount`	`string (decimal) \| null`	Not specified
`vatSumAmountExchanged`	`string (decimal) \| null`	Not specified
`fileName`	`string`	Not specified
`saleType`	`"GOODS" \| "SERVICES" \| ""`	Not specified
`vatRate`	`23 \| 19 \| 8 \| 7 \| 5 \| 0 \| -1 \| -2`	* `23` - 23% * `19` - 19% * `8` - 8% * `7` - 7% * `5` - 5% * `0` - 0% * `-1` - CUSTOM % * `-2` - Reverse charge
`extractedItems`	`object \| null`	Per-item OCR extraction results: [{description, amount, vat_rate, ...}]
`fileHash`	`string`	Not specified
`retentionUntil`	`string (date) \| null`	Not specified
`externalSource`	`string`	Not specified
`externalId`	`string`	Not specified

400 Response fields

application/json

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.