--- title: "Organization Details" method: GET path: "/organizations/{organizationId}" tags: ["Organizations"] --- # Organization Details `GET /organizations/{organizationId}` Returns a single organization by its ID ## Path parameters - `organizationId` string, uuid, required ## Response `200` Ok - object - `organizationId` string, uuid — The unique identifier of the organization. - `name` string — The legal name of the organization. - `status` Schema — unresolved $ref - `syncType` 'FULL' | 'PARTIAL', nullable — The sync type of the organization, will always be `FULL` for now. - `integrationType` 'PARTNER', nullable — 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 regarding limits and balances. - `value` number — 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` string — The currency of the monetary amount in ISO 4217 format, for example `EUR` for Euro or `USD` for US Dollar. - `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. - `value` number — 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` string — The currency of the monetary amount in ISO 4217 format, for example `EUR` for Euro or `USD` for US Dollar. - `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 limits and balances. - `value` number — 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` string — The currency of the monetary amount in ISO 4217 format, for example `EUR` for Euro or `USD` for US Dollar. - `cardsAccounts` object[] — 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. **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. - `number` number, nullable - `type` 'CREDITOR_ACCOUNT' | 'PAYMENT_ACCOUNT' - `tradeName` string, nullable — 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. This field is only optional, as long as the legal `name` of the organization is not longer than 20 characters. **If the legal `name` is longer than 20 characters, the trade name is required:** - The trade name maximum length is 20 characters, since it is printed on the physical cards. - Trade name cannot be `null` or empty. - `legalForm` string — The legal form of the organization. - `foundationDate` string, date — 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` 'CREDIT' | 'PREFUNDED' — 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`. - `partnersOrganizationId` string, nullable — Optional field, referencing the id used by the partner to identify this organization. - `partnerOrganizationId` string, nullable — Optional field, referencing the id used by the partner to identify this organization. - `paymentFrequency` 'DAILY' | 'WEEKLY' | 'BI_WEEKLY' | 'MONTHLY' | 'PREFUNDED' — 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` string, nullable — The national register id of the organization. - `nationalRegisterType` string, nullable — The national register type of the organization. - `tradeRegisterNumber` string — The trade register number of the organization. - `vatId` string, nullable — The VAT ID of the organization, if available. - `billingEmail` string, nullable — The billing email of the organization. - `billingAddress` object — The billing address of the organization. - `id` string — The unique identifier of the address. - `type` 'BILLING' | 'DELIVERY' — The type of the address, here always `BILLING`. - `country` string, nullable — 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. - `city` string, nullable — The city of the address. Might be `null` for non-active organizations, but is set for active organizations. - `postalCode` string, nullable — The postal code of the address. Might be `null` for non-active organizations, but is set for active organizations. - `streetFull` string, nullable — The full street name of the address. Might be `null` for non-active organizations, but is set for active organizations. - `streetName` string, nullable — The street name of the address. Might be `null` for non-active organizations, but is set for active organizations. - `streetNumber` string, nullable — The street number of the address. Might be `null` for non-active organizations, but is set for active organizations. - `streetAdditional` string, nullable — Optional additional street information. - `deliveryAddress` object, nullable — The delivery address of the organization. - `id` string — The unique identifier of the address. - `type` 'BILLING' | 'DELIVERY' — The type of the address, here always `DELIVERY`. - `country` string, nullable — 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. - `city` string, nullable — The city of the address. Might be `null` for non-active organizations, but is set for active organizations. - `postalCode` string, nullable — The postal code of the address. Might be `null` for non-active organizations, but is set for active organizations. - `streetFull` string, nullable — The full street name of the address. Might be `null` for non-active organizations, but is set for active organizations. - `streetName` string, nullable — The street name of the address. Might be `null` for non-active organizations, but is set for active organizations. - `streetNumber` string, nullable — The street number of the address. Might be `null` for non-active organizations, but is set for active organizations. - `streetAdditional` string, nullable — Optional additional street information. - `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. - `beneficiary` string — The beneficiary of the processing account. - `bankName` string, nullable — The name of the bank of the processing account. - `iban` string, nullable — The IBAN of the processing account. - `bic` string, nullable — The BIC of the processing account. - `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[] — The [card accounts](/docs/card-account) of the organization. At least one card account is required. - `id` string, uuid — The id of the card account. - `name` string — The name of the card account. - `status` 'ACTIVE' | 'PENDING' | 'DEACTIVATED' | 'CANCELLED' — The status of the card account. - `defaultAccount` boolean — Indicates whether this is the default card account. There is always one active default card account. - `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` number, float, nullable — 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, uuid — The id of the payment program this organization belongs to. ## Other responses - `400` — unresolved $ref - `401` — unresolved $ref - `403` — unresolved $ref - `404` — unresolved $ref - `500` — unresolved $ref --- [API](https://skmtc.dev/getpliant/apis/pliant-customer-api.md) · [All operations](https://skmtc.dev/getpliant/apis/pliant-customer-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/getpliant/pliant-customer-api/revisions/f3f589cfa718/schema)