PUBLIC API v1
Retrieve a report
GET /api/v1/taxes/reports/{public_id}/
Retrieve a report
Permission: read_tax · Direct link
Company-scoped. Account permissions, plan limits and document state still apply.
Path and query parameters
| Parameter | Location / type | Description |
|---|---|---|
public_idRequired | path · string (uuid) | A UUID string identifying this Report. |
Responses
200 Response fields
application/json
| Field | Type / accepted values | Description | |||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
pkRequiredRead only | string (uuid) | Not specified | |||||||||||||||||||||||||||
taxLinesRequiredRead only | object | Not specified | |||||||||||||||||||||||||||
type | "ADVANCED_SALEX_TAX" | "ANNUAL_SALEX_TAX" | "PNL" | "INCOME_TAX_PREPAYMENT" | "ANNUAL_INCOME_TAX" | "RECAPITULATIVE_STATEMENT" | "ANNUAL_TRADE_TAX" | "EUR" | "ANNUAL_CORPORATE_TAX" | "JPK_V7M" | "JPK_V7K" | "PIT_ADVANCE" | "ZUS_MONTHLY" | "ANNUAL_PIT" | "PIT_36" | "PIT_36L" | "PIT_28" | "CIT_8" | "ZUS_DRA" | * `ADVANCED_SALEX_TAX` - Advanced sales tax * `ANNUAL_SALEX_TAX` - Annual sales tax * `PNL` - EUR P&L * `INCOME_TAX_PREPAYMENT` - Income tax prepayment * `ANNUAL_INCOME_TAX` - Annual income tax * `RECAPITULATIVE_STATEMENT` - RECAPITULATIVE STATEMENT (ZM) * `ANNUAL_TRADE_TAX` - Trade tax (Gewerbesteuer) annual * `EUR` - EUR P&L * `ANNUAL_CORPORATE_TAX` - Corporate tax (Körperschaftsteuer) annual * `JPK_V7M` - JPK_V7M (monthly VAT) * `JPK_V7K` - JPK_V7K (quarterly VAT) * `PIT_ADVANCE` - PIT advance payment * `ZUS_MONTHLY` - ZUS monthly contributions * `ANNUAL_PIT` - Annual PIT return * `PIT_36` - PIT-36 (progressive annual) * `PIT_36L` - PIT-36L (flat rate annual) * `PIT_28` - PIT-28 (lump-sum annual) * `CIT_8` - CIT-8 (corporate annual) * `ZUS_DRA` - ZUS DRA (monthly contribution report) | |||||||||||||||||||||||||||
typeNameRequired | string | Not specified | |||||||||||||||||||||||||||
dateFromRequired | string (date) | Not specified | |||||||||||||||||||||||||||
dateToRequired | string (date) | Not specified | |||||||||||||||||||||||||||
dateDue | string (date) | null | Not specified | |||||||||||||||||||||||||||
submissionDate | string (date) | null | Not specified | |||||||||||||||||||||||||||
payloadRequired | object | Not specified | |||||||||||||||||||||||||||
status | "NOT_COMPLETED" | "SUBMIT" | "PAID" | "SUBMIT_AND_PAID" | "REQUIRE_CORRECTION" | * `NOT_COMPLETED` - Not completed * `SUBMIT` - Submitted * `PAID` - Paid * `SUBMIT_AND_PAID` - Submitted and paid * `REQUIRE_CORRECTION` - Require correction | |||||||||||||||||||||||||||
statusNameRequired | string | Not specified | |||||||||||||||||||||||||||
total | string (decimal) | null | Not specified | |||||||||||||||||||||||||||
referenceName | string | Not specified | |||||||||||||||||||||||||||
reportFile | string (uri) | null | Not specified | |||||||||||||||||||||||||||
companyRequired | string (uuid) | Not specified | |||||||||||||||||||||||||||
reportMetadata | object | Not specified | |||||||||||||||||||||||||||
isSubmissionPaidRequiredRead only | boolean | Use only for individuals and income tax | |||||||||||||||||||||||||||
currency | string | Not specified | |||||||||||||||||||||||||||
paymentRequiredRead only | object | SEPA payment status for a submitted report.Nested fields
|
401 Response fields
application/json
| Field | Type / accepted values | Description |
|---|---|---|
detailRequiredRead only | string | Not specified |
403 Response fields
application/json
| Field | Type / accepted values | Description |
|---|---|---|
detailRequiredRead only | string | Not specified |
404 No response body
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.