PUBLIC API v1

Suggest transaction for the invoice

GET /api/v1/companies/{company_pk}/invoices/{public_id}/suggest-transactions/

Suggest transaction for the invoice of the company

Permission: read_invoices read_transactions · 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

externalId string Not specified

status "PENDING" | "BOOKED" | "UNDEFINED" * `PENDING` - Pending * `BOOKED` - Booked * `UNDEFINED` - Undefined

amountRequired string (decimal) Not specified

amountExchanged string (decimal) | null Not specified

currencyRequired

object

Not specified

Nested fields

Field	Type / accepted values	Description
`fullName`RequiredRead only	`string`	Not specified
`isoCode`Required	`string`	Not specified

currencyExchangedRequired

object

Not specified

Nested fields

Field	Type / accepted values	Description
`fullName`RequiredRead only	`string`	Not specified
`isoCode`Required	`string`	Not specified

description string Not specified

descriptionLong string | null Not specified

userStatus "UNVERIFIED" | "VERIFIED" * `UNVERIFIED` - Unverified * `VERIFIED` - Verified

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

vatAmount string (decimal) Not specified

valueDate string (date-time) | null Not specified

paymentDate string (date) | null Not specified

ledgerPaymentAccountCode string | null Not specified

categoryRequired

object

Not specified

Nested fields

Field	Type / accepted values	Description
`publicId`RequiredRead only	`string (uuid)`	Not specified
`name`RequiredRead only	`string`	Not specified
`parent`	`string (uuid) \| null`	Not specified
`cashflowType`Required	`string`	Not specified
`vatApplied`	`"YES" \| "NO"`	* `YES` - Yes * `NO` - No
`metadata`	`object`	Not specified
`description`RequiredRead only	`string`	Not specified
`examples`RequiredRead only	`string`	Not specified

companyCategoryRequiredRead only

object

Not specified

Nested fields

Field	Type / accepted values	Description
`publicId`RequiredRead only	`string (uuid)`	Not specified
`code`Required	`string`	Not specified
`name`Required	`string`	Not specified
`nameDe`	`string`	Not specified
`namePl`	`string`	Not specified
`description`	`string`	Not specified
`cashflowType`	`"ASSET" \| "LIABILITY" \| "EQUITY" \| "INCOME" \| "EXPENSE"`	* `ASSET` - Asset * `LIABILITY` - Liability * `EQUITY` - Equity * `INCOME` - Income * `EXPENSE` - Expense
`vatApplicability`	`boolean`	Not specified
`suggestedVatRate`	`integer`	Not specified
`isCustom`	`boolean`	Not specified
`isActive`	`boolean`	Not specified
`isBookable`	`boolean`	Not specified
`categoryGroup`	`string`	Not specified
`metadata`	`object`	Not specified

isRefund boolean Not specified

iban string Not specified

bankLogoRequiredRead only string | null Not specified

verifiedAt string (date-time) | null Not specified

vatAmountExchanged string (decimal) | null Not specified

cashflowTypeRequired string Not specified

sourceRequired string Not specified

attachment string (uuid) | null Not specified

additionalAttachmentsRequiredRead only

object[]

Not specified

Nested fields

Field	Type / accepted values	Description
`publicId`RequiredRead only	`string (uuid)`	Not specified
`file`	`string (uri) \| null`	Not specified

invoice string (uuid) | null Not specified

supplierCountryNameRequired string Not specified

client string (uuid) | null Not specified

vendor string (uuid) | null Not specified

vendorDetailsRequiredRead only

object

Not specified

Nested fields

Field	Type / accepted values	Description
`publicId`RequiredRead only	`string (uuid)`	Not specified
`name`Required	`string`	Not specified
`displayLogoUrl`RequiredRead only	`string`	Not specified
`catalogKey`	`string`	Not specified

reverseCharge boolean Not specified

saleType "GOODS" | "SERVICES" | "" Not specified

inputVatType "NO_VAT" | "GERMAN_VAT" | "FOREIGN_VAT" | "" | null Not specified

categoryMetadata object Not specified

logo string (uri) | null Not specified

appliedRuleRequiredRead only

object

Minimal serializer for embedding in transaction responses.

Nested fields

Field	Type / accepted values	Description
`publicId`RequiredRead only	`string (uuid)`	Not specified
`name`Required	`string`	Not specified
`conditionsSummary`RequiredRead only	`string`	Not specified

advisorNotes string Private memo, not visible to your tax advisor. Use the transaction discussion to contact your advisor.

categorizationStatus "PENDING" | "CATEGORIZED" | "UNCATEGORIZED" * `PENDING` - Pending * `CATEGORIZED` - Categorized * `UNCATEGORIZED` - Uncategorized

itemsRequiredRead only

object[]

Not specified

Nested fields

Field Type / accepted values Description

publicIdRequiredRead only string (uuid) Not specified

description string Not specified

amountRequired string (decimal) Not specified

amountExchanged string (decimal) | null 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

vatAmount string (decimal) Not specified

vatAmountExchanged string (decimal) | null Not specified

vatType "VAT_INCLUDED" | "VAT_EXCLUDED" * `VAT_INCLUDED` - VAT Included * `VAT_EXCLUDED` - VAT Excluded

categoryRequiredRead only

object

Not specified

Nested fields

Field	Type / accepted values	Description
`publicId`RequiredRead only	`string (uuid)`	Not specified
`name`RequiredRead only	`string`	Not specified
`parent`	`string (uuid) \| null`	Not specified
`cashflowType`Required	`string`	Not specified
`vatApplied`	`"YES" \| "NO"`	* `YES` - Yes * `NO` - No
`metadata`	`object`	Not specified
`description`RequiredRead only	`string`	Not specified
`examples`RequiredRead only	`string`	Not specified

companyCategoryRequiredRead only

object

Not specified

Nested fields

Field	Type / accepted values	Description
`publicId`RequiredRead only	`string (uuid)`	Not specified
`code`Required	`string`	Not specified
`name`Required	`string`	Not specified
`nameDe`	`string`	Not specified
`namePl`	`string`	Not specified
`description`	`string`	Not specified
`cashflowType`	`"ASSET" \| "LIABILITY" \| "EQUITY" \| "INCOME" \| "EXPENSE"`	* `ASSET` - Asset * `LIABILITY` - Liability * `EQUITY` - Equity * `INCOME` - Income * `EXPENSE` - Expense
`vatApplicability`	`boolean`	Not specified
`suggestedVatRate`	`integer`	Not specified
`isCustom`	`boolean`	Not specified
`isActive`	`boolean`	Not specified
`isBookable`	`boolean`	Not specified
`categoryGroup`	`string`	Not specified
`metadata`	`object`	Not specified

professionalUsePart string (decimal) Fraction of business use (0.000 to 1.000)

order integer Not specified

metadata object Not specified

isLocked boolean Not specified

usesPreviousSkrAccountRequiredRead only boolean Not specified

documentNotRequired boolean | null 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.