Organizations

Listing organizations

A GET request will list all of the organizations.

Curl request

$ curl 'https://apigw.financeactive.eu/api/referential/v4/ACNT1/organizations?page=0&size=20' -i -X GET

Path parameters

Table 1. /api/referential/v4/{account_code}/organizations
Parameter Description

account_code

Account code or ID

Request parameters

Parameter Description

page

Requested page number. Optional. Defaults to 0

size

Requested page size. Optional. Defaults to 20

HTTP request

GET /api/referential/v4/ACNT1/organizations?page=0&size=20 HTTP/1.1
Host: apigw.financeactive.eu

HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Cache-Control: no-store,no-cache,must-revalidate
Pragma: no-cache
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 1159

{
  "_embedded" : {
    "organizations" : [ {
      "object_id" : "1234",
      "name" : "ORGA123",
      "nb_entities" : 3,
      "nb_users" : 0,
      "nb_administrators" : 0,
      "portal_version_label" : "Full",
      "advanced_portal_version_label" : "Portal",
      "_links" : {
        "self" : {
          "href" : "https://apigw.financeactive.eu/api/referential/v4/234567891/organizations/1234"
        },
        "entities" : {
          "href" : "https://apigw.financeactive.eu/api/referential/v4/234567891/organizations/1234/entities"
        },
        "members" : {
          "href" : "https://apigw.financeactive.eu/api/referential/v3/234567891/organizations/1234/members"
        },
        "counterparties" : {
          "href" : "https://apigw.financeactive.eu/api/referential/v3/234567891/organizations/1234/counterparties{?enabled}",
          "templated" : true
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://apigw.financeactive.eu/api/referential/v4/ACNT1/organizations?page=0&size=20"
    }
  },
  "page" : {
    "size" : 20,
    "total_elements" : 1,
    "total_pages" : 1,
    "number" : 0
  }
}

Response fields

Path Type Description

_embedded.organizations[].object_id

String

Organization technical ID

_embedded.organizations[].name

String

Organization name

_embedded.organizations[].nb_entities

Number

Number of entities in this organization

_embedded.organizations[].nb_users

Number

Number of users in this organization

_embedded.organizations[].nb_administrators

Number

Number of administrators in this organization

_embedded.organizations[].portal_version_label

String

Organization portal version

_embedded.organizations[].advanced_portal_version_label

String

Organization advanced portal version

_embedded.organizations[]._links

Object

Links to resources linked to this organization

_links

Object

Links to other resources

page

Object

Pagination information

page.size

Number

Current page size. Integer

page.total_elements

Number

Total number of elements for this collection. Integer

page.total_pages

Number

Total number of pages. Integer

page.number

Number

Current page number. 0-based integer

Relation Description

self

Link to this organization list

Retrieving an organization

Curl request

$ curl 'https://apigw.financeactive.eu/api/referential/v4/ACNT1/organizations/1234' -i -X GET

Path parameters

Table 1. /api/referential/v4/{account_code}/organizations/{organization_id}
Parameter Description

account_code

Account code or ID

organization_id

Organization ID

HTTP request

GET /api/referential/v4/ACNT1/organizations/1234 HTTP/1.1
Host: apigw.financeactive.eu

HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Cache-Control: no-store,no-cache,must-revalidate
Pragma: no-cache
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 771

{
  "object_id" : "1234",
  "name" : "ORGA123",
  "nb_entities" : 3,
  "nb_users" : 0,
  "nb_administrators" : 0,
  "portal_version_label" : "Full",
  "advanced_portal_version_label" : "Portal",
  "_links" : {
    "self" : {
      "href" : "https://apigw.financeactive.eu/api/referential/v4/234567891/organizations/1234"
    },
    "entities" : {
      "href" : "https://apigw.financeactive.eu/api/referential/v4/234567891/organizations/1234/entities"
    },
    "members" : {
      "href" : "https://apigw.financeactive.eu/api/referential/v3/234567891/organizations/1234/members"
    },
    "counterparties" : {
      "href" : "https://apigw.financeactive.eu/api/referential/v3/234567891/organizations/1234/counterparties{?enabled}",
      "templated" : true
    }
  }
}

Response fields

Path Type Description

object_id

String

Organization technical ID

name

String

Organization name

nb_entities

Number

Number of entities in this organization

nb_users

Number

Number of users in this organization

nb_administrators

Number

Number of administrators in this organization

portal_version_label

String

Organization portal version

advanced_portal_version_label

String

Organization advanced portal version

_links

Object

Links to other resources

Relation Description

self

Link to this organization resource

entities

link to the entities attached to this organization

members

link to associated members to this organization

counterparties

link to the counterparties of this organization

Retrieving the entities of an organization

Curl request

$ curl 'https://apigw.financeactive.eu/api/referential/v4/ACNT1/organizations/1234/entities?page=0&size=20' -i -X GET

Path parameters

Table 1. /api/referential/v4/{account_code}/organizations/{organization_id}/entities
Parameter Description

account_code

Account code or ID

organization_id

Organization ID

Request parameters

Parameter Description

page

Requested page number. Optional. Defaults to 0

size

Requested page size. Optional. Defaults to 20

HTTP request

GET /api/referential/v4/ACNT1/organizations/1234/entities?page=0&size=20 HTTP/1.1
Host: apigw.financeactive.eu

HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Cache-Control: no-store,no-cache,must-revalidate
Pragma: no-cache
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 1013

{
  "_embedded" : {
    "entities" : [ {
      "object_id" : "123",
      "enabled" : true,
      "name" : "ENTITY12",
      "code" : "E12CODE",
      "country" : "FR",
      "currency" : "EUR",
      "language" : "fr_FR",
      "privacy_policy" : {
        "visible_inside_organization" : true,
        "visible_outside_organization" : false
      },
      "address" : {
        "street_address1" : "street address 1",
        "street_address2" : "street address 2",
        "zip_code" : "75000",
        "city" : "Paris",
        "country" : "FR"
      },
      "lei" : "AZERTYUIOP1234567890",
      "_links" : {
        "self" : {
          "href" : "https://apigw.financeactive.eu/api/referential/v4/ACNT1/entities/123"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://apigw.financeactive.eu/api/referential/v4/ACNT1/organizations/1234/entities?page=0&size=20"
    }
  },
  "page" : {
    "size" : 20,
    "total_elements" : 1,
    "total_pages" : 1,
    "number" : 0
  }
}

Response fields

Path Type Description

_embedded.entities[].object_id

String

Entity technical ID

_embedded.entities[].name

String

Entity name

_embedded.entities[].code

String

Entity code

_embedded.entities[].enabled

Boolean

Status of the entity (activated or not)

_embedded.entities[].country

String

Entity country

_embedded.entities[].currency

String

Entity currency

_embedded.entities[].language

String

Entity language

_embedded.entities[].privacy_policy

Object

Entity privacy policy

_embedded.entities[].privacy_policy.visible_inside_organization

Boolean

Entity visible inside the organization or not. Default false.

_embedded.entities[].privacy_policy.visible_outside_organization

Boolean

Entity visible outside the organization or not. Default false.

_embedded.entities[].address

Object

Entity address

_embedded.entities[].address.country

String

Entity country

_embedded.entities[].address.city

String

Entity city

_embedded.entities[].address.street_address1

String

Entity street address 1

_embedded.entities[].address.street_address2

String

Entity street address 2

_embedded.entities[].address.zip_code

String

Entity address zip code

_embedded.entities[].lei

String

Legal entity identifier

_embedded.entities[]._links

Object

Links to other resources

_embedded.entities[]._links.self

Object

Link to this Entity resource

_links

Object

Links to other resources

page

Object

Pagination information

page.size

Number

Current page size. Integer

page.total_elements

Number

Total number of elements for this collection. Integer

page.total_pages

Number

Total number of pages. Integer

page.number

Number

Current page number. 0-based integer

Relation Description

self

Link to this Entity list

Entities

Listing entities

A GET request will list all of the entities.

Curl request

$ curl 'https://apigw.financeactive.eu/api/referential/v4/ACNT1/entities?enabled=true&page=0&size=20' -i -X GET

Path parameters

Table 1. /api/referential/v4/{account_code}/entities
Parameter Description

account_code

Account Code or ID

Request parameters

Parameter Description

enabled

Requested entities enabled or not. Optional. See all by default

page

Requested page number. Optional. Defaults to 0

size

Requested page size. Optional. Defaults to 20

HTTP request

GET /api/referential/v4/ACNT1/entities?enabled=true&page=0&size=20 HTTP/1.1
Host: apigw.financeactive.eu

HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Cache-Control: no-store,no-cache,must-revalidate
Pragma: no-cache
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 1693

{
  "_embedded" : {
    "entities" : [ {
      "object_id" : "1",
      "enabled" : true,
      "name" : "ENTITY1",
      "code" : "E1CODE",
      "country" : "FR",
      "currency" : "EUR",
      "language" : "fr_FR",
      "privacy_policy" : {
        "visible_inside_organization" : true,
        "visible_outside_organization" : false
      },
      "address" : {
        "street_address1" : "street address 1",
        "street_address2" : "street address 2",
        "zip_code" : "75000",
        "city" : "Paris",
        "country" : "FR"
      },
      "lei" : "AZERTYUIOP1234567890",
      "_links" : {
        "self" : {
          "href" : "https://apigw.financeactive.eu/api/referential/v4/ACNT1/entities/1"
        }
      }
    }, {
      "object_id" : "2",
      "enabled" : true,
      "name" : "ENTITY2",
      "code" : "E2CODE",
      "country" : "FR",
      "currency" : "EUR",
      "language" : "fr_FR",
      "privacy_policy" : {
        "visible_inside_organization" : true,
        "visible_outside_organization" : false
      },
      "address" : {
        "street_address1" : "street address 1",
        "street_address2" : "street address 2",
        "zip_code" : "44200",
        "city" : "Nantes",
        "country" : "FR"
      },
      "lei" : "AZERTY12345678905678",
      "_links" : {
        "self" : {
          "href" : "https://apigw.financeactive.eu/api/referential/v4/ACNT1/entities/2"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://apigw.financeactive.eu/api/referential/v4/ACNT1/entities?page=0&size=20"
    }
  },
  "page" : {
    "size" : 20,
    "total_elements" : 2,
    "total_pages" : 1,
    "number" : 0
  }
}

Response fields

Path Type Description

_embedded.entities[].object_id

String

Entity technical ID

_embedded.entities[].name

String

Entity name

_embedded.entities[].code

String

Entity code

_embedded.entities[].enabled

Boolean

Status of the entity (activated or not)

_embedded.entities[].country

String

Entity country

_embedded.entities[].currency

String

Entity currency

_embedded.entities[].language

String

Entity language

_embedded.entities[].privacy_policy

Object

Entity privacy policy

_embedded.entities[].privacy_policy.visible_inside_organization

Boolean

Entity visible inside the organization or not. Default false.

_embedded.entities[].privacy_policy.visible_outside_organization

Boolean

Entity visible outside the organization or not. Default false.

_embedded.entities[].address

Object

Entity address

_embedded.entities[].address.country

String

Entity country

_embedded.entities[].address.city

String

Entity city

_embedded.entities[].address.street_address1

String

Entity street address 1

_embedded.entities[].address.street_address2

String

Entity street address 2

_embedded.entities[].address.zip_code

String

Entity address zip code

_embedded.entities[].lei

String

Legal entity identifier

_embedded.entities[]._links

Object

Links to other resources

_embedded.entities[]._links.self

Object

Link to this Entity resource

_links

Object

Links to other resources

page

Object

Pagination information

page.size

Number

Current page size. Integer

page.total_elements

Number

Total number of elements for this collection. Integer

page.total_pages

Number

Total number of pages. Integer

page.number

Number

Current page number. 0-based integer

Relation Description

self

Link to this Entity list

Retrieving an entity

Curl request

$ curl 'https://apigw.financeactive.eu/api/referential/v4/ACNT1/entities/1' -i -X GET

Path parameters

Table 1. /api/referential/v4/{account_code}/entities/{entity_id}
Parameter Description

account_code

Account code or ID

entity_id

Entity ID

HTTP request

GET /api/referential/v4/ACNT1/entities/1 HTTP/1.1
Host: apigw.financeactive.eu

HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Cache-Control: no-store,no-cache,must-revalidate
Pragma: no-cache
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 746

{
  "object_id" : "1",
  "enabled" : true,
  "name" : "ENTITY1",
  "code" : "E1CODE",
  "country" : "FR",
  "currency" : "EUR",
  "language" : "fr_FR",
  "privacy_policy" : {
    "visible_inside_organization" : true,
    "visible_outside_organization" : false
  },
  "address" : {
    "street_address1" : "street address 1",
    "street_address2" : "street address 2",
    "zip_code" : "75000",
    "city" : "Paris",
    "country" : "FR"
  },
  "lei" : "AZERTYUIOP1234567890",
  "_links" : {
    "self" : {
      "href" : "https://apigw.financeactive.eu/api/referential/v4/ACNT1/entities/1"
    },
    "entities" : {
      "href" : "https://apigw.financeactive.eu/api/referential/v4/ACNT1/entities{?enabled}",
      "templated" : true
    }
  }
}

Response fields

Path Type Description

object_id

String

Entity technical ID

name

String

Entity name

code

String

Entity code

enabled

Boolean

Status of the entity (activated or not)

country

String

Entity country

currency

String

Entity currency

language

String

Entity language

privacy_policy

Object

Entity privacy policy

privacy_policy.visible_inside_organization

Boolean

Entity visible inside the organization or not. Default false.

privacy_policy.visible_outside_organization

Boolean

Entity visible outside the organization or not. Default false.

address

Object

Entity address

address.country

String

Entity country

address.city

String

Entity city

address.street_address1

String

Entity street address 1

address.street_address2

String

Entity street address 2

address.zip_code

String

Entity address zip code

lei

String

Legal entity identifier

_links

Object

Links to other resources

_links.self

Object

Link to this Entity resource

Relation Description

self

Link to this Entity resource

entities

Link to the Entity list

Users

Listing the accounts of a user

Curl request

$ curl 'https://apigw.financeactive.eu/api/referential/v4/ACNT1/users/5678/accounts?enabled=true&page=0&size=20' -i -X GET

Path parameters

Table 1. /api/referential/v4/{account_code}/users/{user_id}/accounts
Parameter Description

account_code

Account code or ID

user_id

User id

Request parameters

Parameter Description

enabled

Requested accounts enabled or not. Optional. See all by default

page

Requested page number. Optional. Defaults to 0

size

Requested page size. Optional. Defaults to 20

HTTP request

GET /api/referential/v4/ACNT1/users/5678/accounts?enabled=true&page=0&size=20 HTTP/1.1
Host: apigw.financeactive.eu

HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Cache-Control: no-store,no-cache,must-revalidate
Pragma: no-cache
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 678

{
  "_embedded" : {
    "accounts" : [ {
      "object_id" : "1234",
      "name" : "ACCOUNT1",
      "unique_code" : "ACNT1",
      "country" : "FR",
      "default_currency" : "EUR",
      "enabled" : true,
      "default_language" : "fr_FR",
      "restricted" : false,
      "_links" : {
        "self" : {
          "href" : "https://apigw.financeactive.eu/api/referential/v3/accounts/ACNT1"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://apigw.financeactive.eu/api/referential/v4/ACNT1/users/5678/accounts?page=0&size=20"
    }
  },
  "page" : {
    "size" : 20,
    "total_elements" : 1,
    "total_pages" : 1,
    "number" : 0
  }
}

Response fields

Path Type Description

_embedded.accounts[].object_id

String

Account technical ID

_embedded.accounts[].name

String

Account name

_embedded.accounts[].unique_code

String

Account code

_embedded.accounts[].country

String

Account country

_embedded.accounts[].default_currency

String

Account currency

_embedded.accounts[].default_language

String

Account language

_embedded.accounts[].enabled

Boolean

Status of the account (activated or not)

_embedded.accounts[].restricted

Boolean

Indicates if the Account’s access is restricted

_embedded.accounts[]._links

Object

Links to resources linked to this account

_links

Object

Links to other resources

page

Object

Pagination information

page.size

Number

Current page size. Integer

page.total_elements

Number

Total number of elements for this collection. Integer

page.total_pages

Number

Total number of pages. Integer

page.number

Number

Current page number. 0-based integer

Relation Description

self

Link to this Account list