hi.health · Schema

OrganizationDetail

CompanyInsurancePaymentsCardsFintechHealthCards-as-a-ServiceEmbedded FinanceReimbursementClaims

Properties

Name	Type	Description
organizationId	string	The unique identifier of the organization.
name	string	The legal name of the organization.
status	object
syncType	stringnull	The sync type of the organization, will always be `FULL` for now.
integrationType	stringnull	The integration type of the organization, will always be `PARTNER`.
creditLimit	object	The credit limit for the organization, if applicable. For prefund organizations this value is always 0 EUR. See our [guides](/docs/organization-entity#account-limits-and-balance) for more details rega
availableLimit	object	The available spending capacity for the organization. See our [guides](/docs/organization-entity#account-limits-and-balance) for more details regarding limits and balances.
balance	object	The balance of the organization, which represents movements (positive and negative) on the account. See our [guides](/docs/organization-entity#account-limits-and-balance) for more details regarding li
cardsAccounts	array	Organizations are able to define account numbers that are used when exporting data from Pliant to an accounting system (e.g. DATEV). This is optional and only used for accounting purposes. Typically t
tradeName	stringnull	An organization may use a different name, e.g. for marketing purposes. In case a trade name is provided, this will be the one printed on the employees' physical cards, instead of the organization's le
legalForm	string	The legal form of the organization. Use a value for the organization's `country` from [Legal forms by country](/docs/legal-forms-by-country). Preserve the exact spelling, capitalization, spaces, and p
foundationDate	string	The founding date of the organization in the format `DD.MM.YYYY`.
country	string	The country of the organization in ISO 3166-1 alpha-2 notation.
accountType	string	Replaced by `cardAccount.accountType`, see [API endpoint](./get-card-accounts). This field now shows the account type of the default card account of this organization. Note: a `CREDIT` card account ca
partnersOrganizationId	stringnull	Optional field, referencing the id used by the partner to identify this organization.
partnerOrganizationId	stringnull	Optional field, referencing the id used by the partner to identify this organization.
paymentFrequency	string	Replaced by `cardAccount.paymentFrequency`, see [API endpoint](./get-card-accounts). This field now shows the payment frequency of the default card account of this organization.
nationalRegisterCourt	string	The national register court of the organization.
nationalRegisterId	stringnull	The national register id of the organization.
nationalRegisterType	stringnull	The national register type of the organization.
tradeRegisterNumber	string	The trade register number of the organization.
vatId	stringnull	The VAT ID of the organization, if available.
billingEmail	stringnull	The billing email of the organization.
billingAddress	object	The billing address of the organization.
deliveryAddress	objectnull	The delivery address of the organization.
processingAccount	object	Replaced by `cardAccount.bankAccountInformation`, see [API endpoint](./get-card-accounts). This field now shows the Pliant-internal IBAN of the default card account of this organization.
isCompanyNamePrintable	boolean	Determines if the company name should be printed on the card.
eligibleForHybridAccount	boolean	Determines if the organization is eligible for a hybrid account. A hybrid account is a credit account with additional prefund balance.
cardAccounts	object
missingReceiptNotifications	boolean	If set to `true`, the organization will receive notifications about missing receipts. If set to `false`, the organization will not receive notifications about missing receipts.
fxFeePercentage	numbernull	The per-organization fee (as a percentage of the transaction amount) that is charged for foreign exchange transactions. This value is specific to this organization. Example: `2.1`.
paymentProgramId	string	The id of the payment program this organization belongs to.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/hihealth/main/json-schema/hihealth-organization-detail-schema.json",
  "title": "OrganizationDetail",
  "x-generated": "2026-10-14",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/hihealth-pliant-partner-api-openapi.yml#/components/schemas/OrganizationDetail",
  "type": "object",
  "properties": {
    "organizationId": {
      "type": "string",
      "format": "uuid",
      "description": "The unique identifier of the organization."
    },
    "name": {
      "type": "string",
      "description": "The legal name of the organization."
    },
    "status": {
      "$ref": "#/$defs/status"
    },
    "syncType": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "FULL",
        "PARTIAL"
      ],
      "description": "The sync type of the organization, will always be `FULL` for now."
    },
    "integrationType": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "PARTNER"
      ],
      "description": "The integration type of the organization, will always be `PARTNER`."
    },
    "creditLimit": {
      "type": "object",
      "description": "The credit limit for the organization, if applicable. For prefund organizations this value is always 0 EUR. See our [guides](/docs/organization-entity#account-limits-and-balance) for more details regarding limits and balances.",
      "properties": {
        "value": {
          "type": "number",
          "description": "The value of the monetary amount, converted to minor units of the currency. For instance 1.00 EUR is 100 cents, thus the value here is `100`. See our [guides](/docs/monetary-values) for more details about how to handle monetary amounts."
        },
        "currency": {
          "type": "string",
          "description": "The currency of the monetary amount in ISO 4217 format, for example `EUR` for Euro or `USD` for US Dollar."
        }
      }
    },
    "availableLimit": {
      "type": "object",
      "description": "The available spending capacity for the organization. See our [guides](/docs/organization-entity#account-limits-and-balance) for more details regarding limits and balances.",
      "properties": {
        "value": {
          "type": "number",
          "description": "The value of the monetary amount, converted to minor units of the currency. For instance 1.00 EUR is 100 cents, thus the value here is `100`. See our [guides](/docs/monetary-values) for more details about how to handle monetary amounts."
        },
        "currency": {
          "type": "string",
          "description": "The currency of the monetary amount in ISO 4217 format, for example `EUR` for Euro or `USD` for US Dollar."
        }
      }
    },
    "balance": {
      "type": "object",
      "description": "The balance of the organization, which represents movements (positive and negative) on the account. See our [guides](/docs/organization-entity#account-limits-and-balance) for more details regarding limits and balances.",
      "properties": {
        "value": {
          "type": "number",
          "description": "The value of the monetary amount, converted to minor units of the currency. For instance 1.00 EUR is 100 cents, thus the value here is `100`. See our [guides](/docs/monetary-values) for more details about how to handle monetary amounts."
        },
        "currency": {
          "type": "string",
          "description": "The currency of the monetary amount in ISO 4217 format, for example `EUR` for Euro or `USD` for US Dollar."
        }
      }
    },
    "cardsAccounts": {
      "type": "array",
      "description": "Organizations are able to define account numbers that are used when exporting data from Pliant to an accounting system (e.g. DATEV). This is optional and only used for accounting purposes. Typically this is set on card account level but we do have fallbacks on organization level.\n**Important**: The properties and values are not identifiers for the companies card accounts within Pliant. Please use the respective endpoints to gather information about the card accounts.\n",
      "items": {
        "type": "object",
        "properties": {
          "number": {
            "type": [
              "number",
              "null"
            ]
          },
          "type": {
            "type": "string",
            "enum": [
              "CREDITOR_ACCOUNT",
              "PAYMENT_ACCOUNT"
            ]
          }
        }
      }
    },
    "tradeName": {
      "type": [
        "string",
        "null"
      ],
      "description": "An organization may use a different name, e.g. for marketing purposes. In case a trade name is provided, this will be the one printed on the employees' physical cards, instead of the organization's legal name.\nThis field is only optional, as long as the legal `name` of the organization is not longer than 20 characters.\n \n**If the legal `name` is longer than 20 characters, the trade name is required:**\n  - The trade name maximum length is 20 characters, since it is printed on the physical cards.\n  - Trade name cannot be `null` or empty.\n"
    },
    "legalForm": {
      "type": "string",
      "description": "The legal form of the organization. Use a value for the organization's `country` from\n[Legal forms by country](/docs/legal-forms-by-country).\nPreserve the exact spelling, capitalization, spaces, and punctuation.\n"
    },
    "foundationDate": {
      "type": "string",
      "format": "date",
      "description": "The founding date of the organization in the format `DD.MM.YYYY`."
    },
    "country": {
      "type": "string",
      "description": "The country of the organization in ISO 3166-1 alpha-2 notation.",
      "minLength": 2,
      "maxLength": 2
    },
    "accountType": {
      "type": "string",
      "deprecated": true,
      "description": "Replaced by `cardAccount.accountType`, see [API endpoint](./get-card-accounts). This field now shows the account type of the default card account of this organization. Note: a `CREDIT` card account can also top up their balance with a one-time prefund payment. This does not change the `accountType`, but just shows up as a bigger `availableLimit`.",
      "enum": [
        "CREDIT",
        "PREFUNDED"
      ]
    },
    "partnersOrganizationId": {
      "type": [
        "string",
        "null"
      ],
      "description": "Optional field, referencing the id used by the partner to identify this organization.",
      "deprecated": true
    },
    "partnerOrganizationId": {
      "type": [
        "string",
        "null"
      ],
      "description": "Optional field, referencing the id used by the partner to identify this organization."
    },
    "paymentFrequency": {
      "type": "string",
      "deprecated": true,
      "description": "Replaced by `cardAccount.paymentFrequency`, see [API endpoint](./get-card-accounts). This field now shows the payment frequency of the default card account of this organization.",
      "enum": [
        "DAILY",
        "WEEKLY",
        "BI_WEEKLY",
        "MONTHLY",
        "PREFUNDED"
      ]
    },
    "nationalRegisterCourt": {
      "type": "string",
      "description": "The national register court of the organization."
    },
    "nationalRegisterId": {
      "type": [
        "string",
        "null"
      ],
      "description": "The national register id of the organization."
    },
    "nationalRegisterType": {
      "type": [
        "string",
        "null"
      ],
      "description": "The national register type of the organization."
    },
    "tradeRegisterNumber": {
      "type": "string",
      "description": "The trade register number of the organization."
    },
    "vatId": {
      "type": [
        "string",
        "null"
      ],
      "description": "The VAT ID of the organization, if available."
    },
    "billingEmail": {
      "type": [
        "string",
        "null"
      ],
      "description": "The billing email of the organization."
    },
    "billingAddress": {
      "type": "object",
      "description": "The billing address of the organization.",
      "properties": {
        "id": {
          "type": "string",
          "description": "The unique identifier of the address."
        },
        "type": {
          "type": "string",
          "description": "The type of the address, here always `BILLING`.",
          "enum": [
            "BILLING",
            "DELIVERY"
          ]
        },
        "country": {
          "type": [
            "string",
            "null"
          ],
          "description": "The country of the address in ISO 3166-1 alpha-2 notation. Might be `null` for non-active organizations, but is set for active organizations.",
          "minLength": 2,
          "maxLength": 2
        },
        "city": {
          "type": [
            "string",
            "null"
          ],
          "description": "The city of the address. Might be `null` for non-active organizations, but is set for active organizations."
        },
        "postalCode": {
          "type": [
            "string",
            "null"
          ],
          "description": "The postal code of the address. Might be `null` for non-active organizations, but is set for active organizations."
        },
        "streetFull": {
          "type": [
            "string",
            "null"
          ],
          "description": "The full street name of the address. Might be `null` for non-active organizations, but is set for active organizations."
        },
        "streetName": {
          "type": [
            "string",
            "null"
          ],
          "description": "The street name of the address. Might be `null` for non-active organizations, but is set for active organizations."
        },
        "streetNumber": {
          "type": [
            "string",
            "null"
          ],
          "description": "The street number of the address. Might be `null` for non-active organizations, but is set for active organizations."
        },
        "streetAdditional": {
          "type": [
            "string",
            "null"
          ],
          "description": "Optional additional street information."
        }
      }
    },
    "deliveryAddress": {
      "type": [
        "object",
        "null"
      ],
      "description": "The delivery address of the organization.",
      "properties": {
        "id": {
          "type": "string",
          "description": "The unique identifier of the address."
        },
        "type": {
          "type": "string",
          "description": "The type of the address, here always `DELIVERY`.",
          "enum": [
            "BILLING",
            "DELIVERY"
          ]
        },
        "country": {
          "type": [
            "string",
            "null"
          ],
          "description": "The country of the address in ISO 3166-1 alpha-2 notation. Might be `null` for non-active organizations, but is set for active organizations.",
          "minLength": 2,
          "maxLength": 2
        },
        "city": {
          "type": [
            "string",
            "null"
          ],
          "description": "The city of the address. Might be `null` for non-active organizations, but is set for active organizations."
        },
        "postalCode": {
          "type": [
            "string",
            "null"
          ],
          "description": "The postal code of the address. Might be `null` for non-active organizations, but is set for active organizations."
        },
        "streetFull": {
          "type": [
            "string",
            "null"
          ],
          "description": "The full street name of the address. Might be `null` for non-active organizations, but is set for active organizations."
        },
        "streetName": {
          "type": [
            "string",
            "null"
          ],
          "description": "The street name of the address. Might be `null` for non-active organizations, but is set for active organizations."
        },
        "streetNumber": {
          "type": [
            "string",
            "null"
          ],
          "description": "The street number of the address. Might be `null` for non-active organizations, but is set for active organizations."
        },
        "streetAdditional": {
          "type": [
            "string",
            "null"
          ],
          "description": "Optional additional street information."
        }
      }
    },
    "processingAccount": {
      "type": "object",
      "deprecated": true,
      "description": "Replaced by `cardAccount.bankAccountInformation`, see [API endpoint](./get-card-accounts). This field now shows the Pliant-internal IBAN of the default card account of this organization.",
      "properties": {
        "beneficiary": {
          "type": "string",
          "description": "The beneficiary of the processing account."
        },
        "bankName": {
          "type": [
            "string",
            "null"
          ],
          "description": "The name of the bank of the processing account."
        },
        "iban": {
          "type": [
            "string",
            "null"
          ],
          "description": "The IBAN of the processing account."
        },
        "bic": {
          "type": [
            "string",
            "null"
          ],
          "description": "The BIC of the processing account."
        }
      }
    },
    "isCompanyNamePrintable": {
      "type": "boolean",
      "description": "Determines if the company name should be printed on the card."
    },
    "eligibleForHybridAccount": {
      "type": "boolean",
      "description": "Determines if the organization is eligible for a hybrid account. A hybrid account is a credit account with additional prefund balance."
    },
    "cardAccounts": {
      "$ref": "#/$defs/cardAccounts"
    },
    "missingReceiptNotifications": {
      "type": "boolean",
      "description": "If set to `true`, the organization will receive notifications about missing receipts. If set to `false`, the organization will not receive notifications about missing receipts."
    },
    "fxFeePercentage": {
      "type": [
        "number",
        "null"
      ],
      "description": "The per-organization fee (as a percentage of the transaction amount) that is charged for foreign exchange transactions. This value is specific to this organization. Example: `2.1`.",
      "format": "float",
      "minimum": 0,
      "maximum": 100
    },
    "paymentProgramId": {
      "type": "string",
      "format": "uuid",
      "description": "The id of the payment program this organization belongs to."
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this

find_json_schemasBrowse and filter every JSON Schema in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This JSON Schema

curl "https://apis.io/api/v1/json-schemas/hihealth-organization-detail"

All schemas

curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.