Organization

An organization can be managed through company, region and entity objects. These are individual objects that support nesting for custom fields and user groups.

1. Company

This is an object representing your company. You can retrieve it to see properties about your company address and responsible manager. Custom fields and user groups associated with a company object can be retrieved as well.

curl --request GET \
     --url 'https://example.com/rest/api/bam/company' \
     --header 'accept: application/json'

{
  "id": "1e2e1b43-0fa0-43bc-8e15-0fca71da2edd",
  "phone": "string",
  "zipCode": "string",
  "city": "string",
  "address": "string",
  "name": "string",
  "language": "string",
  "country": "string",
  "responsibleManager": {
    "firstName": "string",
    "lastName": "string",
    "email": "[email protected]"
  }
}

2. Regions

A company may have different regions. This object represents all regions of a company. The object can be retrieved as an item and collection. Filters can be applied in the request, to query based on status, regionName, and companyName. Custom fields and user groups associated with a region object can also be retrieved.

curl --request GET \
     --url 'https://example.com/rest/api/bam/regions?page_number=1&page_size=50' \
     --header 'accept: application/json'

{
  "pageNumber": 1,
  "numberOfPages": 5,
  "pageSize": 50,
  "totalNumberOfElements": 240,
  "content": [
    {
      "id": "1e2e1b43-0fa0-43bc-8e15-0fca71da2edd",
      "name": "string",
      "language": "string",
      "regionalManager": {
        "firstName": "string",
        "lastName": "string",
        "email": "[email protected]"
      },
      "changeTime": "2019-08-24T14:15:22Z"
    }
  ]
}

3. Legal entities

A legal entity is associated with a region(s). The object can be retrieved as an item and collection. Filters can be applied in the request, to query based on businessId and name. Custom fields and user groups associated with a legal entity object can also be retrieved.

curl --request GET \
     --url 'https://example.com/rest/api/bam/legal-entities?page_number=1&page_size=50' \
     --header 'accept: application/json'

{
  "pageNumber": 1,
  "numberOfPages": 5,
  "pageSize": 50,
  "totalNumberOfElements": 240,
  "content": [
    {
      "id": "1e2e1b43-0fa0-43bc-8e15-0fca71da2edd",
      "businessId": "string",
      "name": "string",
      "address": "Lange Str. 12",
      "zipCode": "string",
      "city": "string",
      "country": "US",
      "state": "DE-HB",
      "changeTime": "2023-02-08T09:14:23.260Z",
      "region": {
        "id": "1e2e1b43-0fa0-43bc-8e15-0fca71da2edd",
        "name": "string",
        "language": "AR_LB",
        "changeTime": "2023-02-08T09:14:23.260Z",
        "regionalManager": {
          "firstName": "string",
          "lastName": "string",
          "email": "[email protected]"
        }
      }
    }
  ]
}

When a bank is linked to a legal entity, a bank property can be nested with a legal entity object. Custom fields and user groups associated with a legal-entity-bank-relations object can also be retrieved.

curl --request GET \
     --url 'https://example.com/rest/api/bam/legal-entity-bank-relations/legalEntityBankId' \
     --header 'accept: application/json'

{
  "pageNumber": 1,
  "numberOfPages": 5,
  "pageSize": 50,
  "totalNumberOfElements": 240,
  "content": [
    {
      "id": "1e2e1b43-0fa0-43bc-8e15-0fca71da2edd",
      "legalEntity": {
        "id": "1e2e1b43-0fa0-43bc-8e15-0fca71da2edd",
        "businessId": "string",
        "name": "string"
      },
      "bank": {
        "id": "1e2e1b43-0fa0-43bc-8e15-0fca71da2edd",
        "businessId": "string",
        "name": "string"
      },
      "changeTime": "2019-08-24T14:15:22Z"
    }
  ]
}

When a partner is linked to a legal entity, a partner property can be nested with a legal entity object. Custom fields and user groups associated with a legal-entity-partner-relations object can also be retrieved.

curl --request GET \
     --url 'https://examples.com/rest/api/bam/legal-entity-partner-relations/legalEntityPartnerId' \
     --header 'accept: application/json'

{
  "pageNumber": 1,
  "numberOfPages": 5,
  "pageSize": 50,
  "totalNumberOfElements": 240,
  "content": [
    {
      "id": "1e2e1b43-0fa0-43bc-8e15-0fca71da2edd",
      "legalEntity": {
        "id": "1e2e1b43-0fa0-43bc-8e15-0fca71da2edd",
        "businessId": "string",
        "name": "string"
      },
      "partner": {
        "id": "1e2e1b43-0fa0-43bc-8e15-0fca71da2edd",
        "businessId": "string",
        "name": "string"
      },
      "changeTime": "2019-08-24T14:15:22Z"
    }
  ]
}