---
title: "Get a list of all required fields per country. Used for documentation purposes."
method: GET
path: "/v1/transactions/documentation/masterdata"
tags: ["Transactions"]
---

# Get a list of all required fields per country. Used for documentation purposes.

`GET /v1/transactions/documentation/masterdata`

## Request

- The document declares no server URL.
- Auth: API key in header `Ocp-Apim-Subscription-Key`

Returns a list of all required fields per country. Used for documentation purposes.

## Query parameters

- `country_codes` string[]
- `include_optional_properties` boolean
- `operations` string[]

## Response `200`

Ok - data was retrieved successfully.

- DocumentationMasterDataResponse
  - `master_data_per_operation` MasterDataPerOperation[]: List of master data of required properties per operation.
    - `master_data` DocumentationMasterData[]: List of master data of required properties per country and operation.
      - `description` string: Describes the given property. For example 'Unique and usually sequential identifier..' for transaction_number.
      - `example` string: Example value for the given property.
      - `parent_property_name` string: The name of the parent property. For example transport_data.shipping_to
      - `property_name` string: The name of the model property. For example transaction_number.
      - `required` boolean: Whether the given property is required for any of countries in field validations.
      - `validations` MasterDataValidations[]
        - `country_code` string: Country code for which the given property applies. Empty if for all.
        - `example` string: Example value for the given property.
        - `required` boolean: Whether the given property is required for the given country.
        - `required_when` string: The condition under which this property is required.
        - `validated` boolean: Whether there are some validations for the given property.
    - `operation` string: The operation for which the master data is provided. e.g. SubmitTransaction, CreditTransaction, etc

## Other responses

- `401`: Authentication failed - missing or incorrect subscription key
- `429`: Too many requests were sent for a short period of time. Try again a bit later.
- `5XX`: Internal server error. Its not you, its us! We are experiencing a rare and unexpected system disruption. Retry again later. The message field of the response will contain more information for the cause. Feel free to contact us.

---

[API](https://skmtc.dev/fonoa/apis/fonoa-e-invoicing.md) - [All operations](https://skmtc.dev/fonoa/apis/fonoa-e-invoicing/llms.txt) - [OpenAPI document](https://skmtc.dev/fonoa/apis/fonoa-e-invoicing/revisions/d38890cb6fcd?raw)