Sign in
Organizations

Organization Details

Returns a single organization by its ID

get/organizations/{organizationId}

Path parameters

organizationIdstring uuid required

The unique identifier of the organization.

Response

Ok

organizationIdstring uuid

The unique identifier of the organization.

namestring

The legal name of the organization.

statusSchema — 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.

tradeNamestring 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.
legalFormstring

The legal form of the organization.

foundationDatestring date

The founding date of the organization in the format DD.MM.YYYY.

countrystring

The country of the organization in ISO 3166-1 alpha-2 notation.

accountType'CREDIT' | 'PREFUNDED'

Replaced by cardAccount.accountType, see API endpoint. 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.

partnersOrganizationIdstring nullable

Optional field, referencing the id used by the partner to identify this organization.

partnerOrganizationIdstring 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. This field now shows the payment frequency of the default card account of this organization.

nationalRegisterCourtstring

The national register court of the organization.

nationalRegisterIdstring nullable

The national register id of the organization.

nationalRegisterTypestring nullable

The national register type of the organization.

tradeRegisterNumberstring

The trade register number of the organization.

vatIdstring nullable

The VAT ID of the organization, if available.

billingEmailstring nullable

The billing email of the organization.

isCompanyNamePrintableboolean

Determines if the company name should be printed on the card.

eligibleForHybridAccountboolean

Determines if the organization is eligible for a hybrid account. A hybrid account is a credit account with additional prefund balance.

missingReceiptNotificationsboolean

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.

fxFeePercentagenumber 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.

paymentProgramIdstring uuid

The id of the payment program this organization belongs to.

Changes