Organizations

Listing organizations

A GET request will list all of the organizations.

Curl request

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

Path parameters

Table 1. /api/referential/v3/{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/v3/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;charset=UTF-8
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: 1157

{
  "_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/v3/234567891/organizations/1234"
        },
        "entities" : {
          "href" : "https://apigw.financeactive.eu/api/referential/v3/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/v3/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

Number

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/v3/ACNT1/organizations/1234' -i -X GET

Path parameters

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

account_code

Account code or ID

organization_id

Organization ID

HTTP request

GET /api/referential/v3/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;charset=UTF-8
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: 769

{
  "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/v3/234567891/organizations/1234"
    },
    "entities" : {
      "href" : "https://apigw.financeactive.eu/api/referential/v3/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

Number

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

Adding a list of organizations

A POST request will add one or more organizations parameterized in the request body.

Curl request

$ curl 'https://apigw.financeactive.eu/api/referential/v3/ACNT1/organizations' -i -X POST \
    -H 'Content-Type: application/hal+json;charset=UTF-8' \
    -d '[
  {
    "name": "orga1"
  },
  {
    "name": "orga2"
  }
]
'

Path parameters

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

account_code

Account Code or ID

Request body

[
  {
    "name": "orga1"
  },
  {
    "name": "orga2"
  }
]

Request fields

Path Type Description

[].name

String

Organization name. Max size 100. Mandatory and unique.

HTTP request

POST /api/referential/v3/ACNT1/organizations HTTP/1.1
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 61
Host: apigw.financeactive.eu

[
  {
    "name": "orga1"
  },
  {
    "name": "orga2"
  }
]

HTTP response

HTTP/1.1 201 Created
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: 858

{
  "total" : 2,
  "success" : 2,
  "failed" : 0,
  "errors" : [ ],
  "organizations" : [ {
    "object_id" : "3160101125718377711",
    "name" : "orga1",
    "_links" : {
      "self" : {
        "href" : "https://apigw.financeactive.eu/api/referential/v3/234567891/organizations/3160101125718377711"
      },
      "entities" : {
        "href" : "https://apigw.financeactive.eu/api/referential/v3/234567891/organizations/3160101125718377711/entities"
      }
    }
  }, {
    "object_id" : "7274069725148240411",
    "name" : "orga2",
    "_links" : {
      "self" : {
        "href" : "https://apigw.financeactive.eu/api/referential/v3/234567891/organizations/7274069725148240411"
      },
      "entities" : {
        "href" : "https://apigw.financeactive.eu/api/referential/v3/234567891/organizations/7274069725148240411/entities"
      }
    }
  } ]
}

Response fields

Path Type Description

total

Number

Total batch actions

success

Number

Number of batch actions in success

failed

Number

Number of batch actions in error

errors[]

Array

Batch process errors

errors[].organization

Object

Organization in error

errors[].message

String

Error message

errors[].description

String

Error description

organizations

Array

created organizations

organizations[].object_id

String

Organization technical ID

organizations[].name

String

Organization name

organizations[]._links

Object

Links to other resources

organizations[]._links.self

Object

Link to this organization resource

organizations[]._links.entities

Object

Link to the entities attached to this organization

Updating a list of organizations

A PUT request will update one or more organizations parameterized in the request body.

Curl request

$ curl 'https://apigw.financeactive.eu/api/referential/v3/ACNT1/organizations' -i -X PUT \
    -H 'Content-Type: application/hal+json;charset=UTF-8' \
    -d '[
  {
    "object_id": "1",
    "name": "newOrg1"
  },
  {
    "object_id": "2",
    "name": "newOrg2"
  }
]
'

Path parameters

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

account_code

Account Code or ID

Request body

[
  {
    "object_id": "1",
    "name": "newOrg1"
  },
  {
    "object_id": "2",
    "name": "newOrg2"
  }
]

Request fields

Path Type Description

[].object_id

String

Organization ID.

[].name

String

Organization name. Max size 100. Mandatory and unique.

HTTP request

PUT /api/referential/v3/ACNT1/organizations HTTP/1.1
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 109
Host: apigw.financeactive.eu

[
  {
    "object_id": "1",
    "name": "newOrg1"
  },
  {
    "object_id": "2",
    "name": "newOrg2"
  }
]

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: 754

{
  "total" : 2,
  "success" : 2,
  "failed" : 0,
  "errors" : [ ],
  "organizations" : [ {
    "object_id" : "1",
    "name" : "newOrg1",
    "_links" : {
      "self" : {
        "href" : "https://apigw.financeactive.eu/api/referential/v3/234567891/organizations/1"
      },
      "entities" : {
        "href" : "https://apigw.financeactive.eu/api/referential/v3/234567891/organizations/1/entities"
      }
    }
  }, {
    "object_id" : "2",
    "name" : "newOrg2",
    "_links" : {
      "self" : {
        "href" : "https://apigw.financeactive.eu/api/referential/v3/234567891/organizations/2"
      },
      "entities" : {
        "href" : "https://apigw.financeactive.eu/api/referential/v3/234567891/organizations/2/entities"
      }
    }
  } ]
}

Response fields

Path Type Description

total

Number

Total batch actions

success

Number

Number of batch actions in success

failed

Number

Number of batch actions in error

errors[]

Array

Batch process errors

errors[].organization

Object

Organization in error

errors[].message

String

Error message

errors[].description

String

Error description

organizations

Array

updated organizations

organizations[].object_id

String

Organization technical ID

organizations[].name

String

Organization name

organizations[]._links

Object

Links to other resources

organizations[]._links.self

Object

Link to this organization resource

organizations[]._links.entities

Object

Link to the entities attached to this organization

Removing a list of organizations

A DELETE request will remove the organizations parameterized in the request parameters.

Curl request

$ curl 'https://apigw.financeactive.eu/api/referential/v3/ACNT1/organizations?organization_id=1&organization_id=2&organization_id=3' -i -X DELETE

Path parameters

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

account_code

Account Code or ID

Request parameters

Parameter Description

organization_id

Organization ID. Mandatory. Can be added several times.

HTTP request

DELETE /api/referential/v3/ACNT1/organizations?organization_id=1&organization_id=2&organization_id=3 HTTP/1.1
Host: apigw.financeactive.eu

HTTP response

HTTP/1.1 206 Partial Content
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: 133

{
  "total" : 3,
  "success" : 2,
  "failed" : 1,
  "errors" : [ {
    "object_id" : "3",
    "message" : "An error occurred"
  } ]
}

Response fields

Path Type Description

total

Number

Total batch actions

success

Number

Number of batch actions in success

failed

Number

Number of batch actions in error

errors[]

Array

Batch process errors

errors[].object_id

Long

Organization ID concerned by the error

errors[].message

String

Error message

errors[].description

String

Error description

Removing an organization

A DELETE request will remove the organization parameterized in the path parameters.

Curl request

$ curl 'https://apigw.financeactive.eu/api/referential/v3/ACNT1/organizations/1' -i -X DELETE

Path parameters

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

account_code

Account Code or ID

organization_id

Organization ID

HTTP request

DELETE /api/referential/v3/ACNT1/organizations/1 HTTP/1.1
Host: apigw.financeactive.eu

HTTP response

HTTP/1.1 204 No Content
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
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

Retrieving the entities of an organization

Curl request

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

Path parameters

Table 1. /api/referential/v3/{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/v3/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;charset=UTF-8
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: 1011

{
  "_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/v3/ACNT1/entities/123"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://apigw.financeactive.eu/api/referential/v3/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

Number

Entity technical ID

_embedded.entities[].enabled

Boolean

Status of the entity (activated or not)

_embedded.entities[].name

String

Entity name

_embedded.entities[].code

String

Entity code

_embedded.entities[].country

String

Entity country

_embedded.entities[].currency

String

Entity currency

_embedded.entities[].lei

String

legal entity identifier

_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

_embedded.entities[].privacy_policy.visible_outside_organization

Boolean

Entity visible outside the organization or not

_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[]._links

Object

Links to resources linked to this entity

_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 a member of an organization

Curl request

$ curl 'https://apigw.financeactive.eu/api/referential/v3/ACNT1/organizations/123/members/1' -i -X GET

Path parameters

Table 1. /api/referential/v3/{account_code}/organizations/{organization_id}/members/{entity_id}
Parameter Description

account_code

Account Code or ID

organization_id

Organization ID

entity_id

Entity ID

HTTP request

GET /api/referential/v3/ACNT1/organizations/123/members/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: 838

{
  "percentage" : "100.00",
  "entity" : {
    "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/v3/ACNT1/entities/1"
      }
    }
  },
  "_links" : {
    "self" : {
      "href" : "https://apigw.financeactive.eu/api/referential/v3/ACNT1/organizations/123/members/1"
    }
  }
}

Response fields

Path Type Description

percentage

String

Entity Consolidation Profile on organization. Optional. Default 100 %

_links

Object

Links to other resources

_links.self

Object

Link to this Entity resource

entity.object_id

String

Entity technical ID

entity.name

String

Entity name

entity.code

String

Entity code

entity.enabled

Boolean

Status of the entity (activated or not)

entity.country

String

Entity country

entity.currency

String

Entity currency

entity.language

String

Entity language

entity.privacy_policy

Object

Entity privacy policy

entity.privacy_policy.visible_inside_organization

Boolean

Entity visible inside the organization or not. Default false.

entity.privacy_policy.visible_outside_organization

Boolean

Entity visible outside the organization or not. Default false.

entity.address

Object

Entity address

entity.address.country

String

Entity country

entity.address.city

String

Entity city

entity.address.street_address1

String

Entity street address 1

entity.address.street_address2

String

Entity street address 2

entity.address.zip_code

String

Entity address zip code

entity.lei

String

Legal entity identifier

entity._links

Object

Links to other resources

entity._links.self

Object

Link to this Entity resource

Relation Description

self

Link to this Entity resource

Listing members

A GET request will list all members associated to a specific organization.

Curl request

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

Path parameters

Table 1. /api/referential/v3/{account_code}/organizations/{organization_id}/members
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/v3/ACNT1/organizations/123/members?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: 2244

{
  "_embedded" : {
    "members" : [ {
      "percentage" : "100.00",
      "entity" : {
        "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/v3/ACNT1/entities/1"
          }
        }
      },
      "_links" : {
        "self" : {
          "href" : "https://apigw.financeactive.eu/api/referential/v3/ACNT1/organizations/123/members/1"
        }
      }
    }, {
      "percentage" : "50.00",
      "entity" : {
        "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/v3/ACNT1/entities/2"
          }
        }
      },
      "_links" : {
        "self" : {
          "href" : "https://apigw.financeactive.eu/api/referential/v3/ACNT1/organizations/123/members/2"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://apigw.financeactive.eu/api/referential/v3/ACNT1/organizations/123/members?page=0&size=20"
    }
  },
  "page" : {
    "size" : 20,
    "total_elements" : 2,
    "total_pages" : 1,
    "number" : 0
  }
}

Response fields

Path Type Description

_embedded.members[].percentage

String

Entity Consolidation Profile on organization. Optional. Default 100 %

_embedded.members[]._links

Object

Links to other resources

_embedded.members[]._links.self

Object

Link to this Entity resource

_embedded.members[].entity.object_id

String

Entity technical ID

_embedded.members[].entity.name

String

Entity name

_embedded.members[].entity.code

String

Entity code

_embedded.members[].entity.enabled

Boolean

Status of the entity (activated or not)

_embedded.members[].entity.country

String

Entity country

_embedded.members[].entity.currency

String

Entity currency

_embedded.members[].entity.language

String

Entity language

_embedded.members[].entity.privacy_policy

Object

Entity privacy policy

_embedded.members[].entity.privacy_policy.visible_inside_organization

Boolean

Entity visible inside the organization or not. Default false.

_embedded.members[].entity.privacy_policy.visible_outside_organization

Boolean

Entity visible outside the organization or not. Default false.

_embedded.members[].entity.address

Object

Entity address

_embedded.members[].entity.address.country

String

Entity country

_embedded.members[].entity.address.city

String

Entity city

_embedded.members[].entity.address.street_address1

String

Entity street address 1

_embedded.members[].entity.address.street_address2

String

Entity street address 2

_embedded.members[].entity.address.zip_code

String

Entity address zip code

_embedded.members[].entity.lei

String

Legal entity identifier

_embedded.members[].entity._links

Object

Links to other resources

_embedded.members[].entity._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 Members list

Associate members to an organization

A POST request will associate members to an organization parameterized in the request body.

Curl request

$ curl 'https://apigw.financeactive.eu/api/referential/v3/ACNT1/organizations/123/members' -i -X POST \
    -H 'Content-Type: application/hal+json;charset=UTF-8' \
    -d '[
  {
    "percentage": 100,
    "entity_id": "1"
  },
  {
    "percentage": 50,
    "entity_id": "2"
  }
]
'

Path parameters

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

account_code

Account Code or ID

organization_id

Organization ID

HTTP request

POST /api/referential/v3/ACNT1/organizations/123/members HTTP/1.1
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 108
Host: apigw.financeactive.eu

[
  {
    "percentage": 100,
    "entity_id": "1"
  },
  {
    "percentage": 50,
    "entity_id": "2"
  }
]

HTTP response

HTTP/1.1 201 Created
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: 1898

{
  "total" : 2,
  "success" : 2,
  "failed" : 0,
  "errors" : [ ],
  "members" : [ {
    "percentage" : "100.00",
    "entity" : {
      "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/v3/ACNT1/entities/1"
        }
      }
    },
    "_links" : {
      "self" : {
        "href" : "https://apigw.financeactive.eu/api/referential/v3/ACNT1/organizations/123/members/1"
      }
    }
  }, {
    "percentage" : "50.00",
    "entity" : {
      "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/v3/ACNT1/entities/2"
        }
      }
    },
    "_links" : {
      "self" : {
        "href" : "https://apigw.financeactive.eu/api/referential/v3/ACNT1/organizations/123/members/2"
      }
    }
  } ]
}

Response fields

Path Type Description

total

Number

Total batch actions

success

Number

Number of batch actions in success

failed

Number

Number of batch actions in error

errors[]

Array

Batch process errors

errors[].member

Object

Member in error

errors[].message

String

Error message

errors[].description

String

Error description

members

Array

created Members

members[].entity.object_id

String

Entity technical ID

members[].entity.name

String

Entity name

members[].entity.code

String

Entity code

members[].entity.enabled

Boolean

Status of the entity (activated or not)

members[].entity.country

String

Entity country

members[].entity.currency

String

Entity currency

members[].entity.language

String

Entity language

members[].entity.privacy_policy

Object

Entity privacy policy

members[].entity.privacy_policy.visible_inside_organization

Boolean

Entity visible inside the organization or not. Default false.

members[].entity.privacy_policy.visible_outside_organization

Boolean

Entity visible outside the organization or not. Default false.

members[].entity.address

Object

Entity address

members[].entity.address.country

String

Entity country

members[].entity.address.city

String

Entity city

members[].entity.address.street_address1

String

Entity street address 1

members[].entity.address.street_address2

String

Entity street address 2

members[].entity.address.zip_code

String

Entity address zip code

members[].entity.lei

String

Legal entity identifier

members[].entity._links

Object

Links to other resources

members[].entity._links.self

Object

Link to this Entity resource

members[].percentage

String

Entity Consolidation Profile on organization. Optional. Default 100 %

members[]._links

Object

Links to other resources

members[]._links.self

Object

Link to this Entity resource

Updating members associations in an organization

A PUT request will update one or more members associations parameterized in the request body.

Curl request

$ curl 'https://apigw.financeactive.eu/api/referential/v3/ACNT1/organizations/123/members' -i -X PUT \
    -H 'Content-Type: application/hal+json;charset=UTF-8' \
    -d '[
  {
    "percentage": 40,
    "entity_id": "1"
  },
  {
    "percentage": 70,
    "entity_id": "2"
  }
]
'

Path parameters

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

account_code

Account Code or ID

organization_id

Organization ID

HTTP request

PUT /api/referential/v3/ACNT1/organizations/123/members HTTP/1.1
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 107
Host: apigw.financeactive.eu

[
  {
    "percentage": 40,
    "entity_id": "1"
  },
  {
    "percentage": 70,
    "entity_id": "2"
  }
]

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: 1897

{
  "total" : 2,
  "success" : 2,
  "failed" : 0,
  "errors" : [ ],
  "members" : [ {
    "percentage" : "40.00",
    "entity" : {
      "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/v3/ACNT1/entities/1"
        }
      }
    },
    "_links" : {
      "self" : {
        "href" : "https://apigw.financeactive.eu/api/referential/v3/ACNT1/organizations/123/members/1"
      }
    }
  }, {
    "percentage" : "70.00",
    "entity" : {
      "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/v3/ACNT1/entities/2"
        }
      }
    },
    "_links" : {
      "self" : {
        "href" : "https://apigw.financeactive.eu/api/referential/v3/ACNT1/organizations/123/members/2"
      }
    }
  } ]
}

Response fields

Path Type Description

total

Number

Total batch actions

success

Number

Number of batch actions in success

failed

Number

Number of batch actions in error

errors[]

Array

Batch process errors

errors[].member

Object

Member in error

errors[].message

String

Error message

errors[].description

String

Error description

total

Number

Total batch actions

success

Number

Number of batch actions in success

failed

Number

Number of batch actions in error

errors[]

Array

Batch process errors

errors[].member

Object

Member in error

errors[].message

String

Error message

errors[].description

String

Error description

members[].entity.object_id

String

Entity technical ID

members[].entity.name

String

Entity name

members[].entity.code

String

Entity code

members[].entity.enabled

Boolean

Status of the entity (activated or not)

members[].entity.country

String

Entity country

members[].entity.currency

String

Entity currency

members[].entity.language

String

Entity language

members[].entity.privacy_policy

Object

Entity privacy policy

members[].entity.privacy_policy.visible_inside_organization

Boolean

Entity visible inside the organization or not. Default false.

members[].entity.privacy_policy.visible_outside_organization

Boolean

Entity visible outside the organization or not. Default false.

members[].entity.address

Object

Entity address

members[].entity.address.country

String

Entity country

members[].entity.address.city

String

Entity city

members[].entity.address.street_address1

String

Entity street address 1

members[].entity.address.street_address2

String

Entity street address 2

members[].entity.address.zip_code

String

Entity address zip code

members[].entity.lei

String

Legal entity identifier

members[].entity._links

Object

Links to other resources

members[].entity._links.self

Object

Link to this Entity resource

members[].percentage

String

Entity Consolidation Profile on organization. Optional. Default 100 %

members[]._links

Object

Links to other resources

members[]._links.self

Object

Link to this Entity resource

Disassociate member from an organization

A DELETE request will disassociate member from an organization parameterized in the path parameters.

Curl request

$ curl 'https://apigw.financeactive.eu/api/referential/v3/ACNT1/organizations/123/members/1' -i -X DELETE

Path parameters

Table 1. /api/referential/v3/{account_code}/organizations/{organization_id}/members/{entity_id}
Parameter Description

account_code

Account Code or ID

organization_id

Organization ID

entity_id

Entity ID

HTTP request

DELETE /api/referential/v3/ACNT1/organizations/123/members/1 HTTP/1.1
Host: apigw.financeactive.eu

HTTP response

HTTP/1.1 204 No Content
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
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

Disassociate a list of members

A DELETE request will disassociate the members from organization parameterized in the request parameters.

Curl request

$ curl 'https://apigw.financeactive.eu/api/referential/v3/ACNT1/organizations/123/members?entity_id=1&entity_id=2&entity_id=3' -i -X DELETE

Path parameters

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

account_code

Account Code or ID

organization_id

Organization ID

Request parameters

Parameter Description

entity_id

Entity ID. Mandatory. Can be added several times.

HTTP request

DELETE /api/referential/v3/ACNT1/organizations/123/members?entity_id=1&entity_id=2&entity_id=3 HTTP/1.1
Host: apigw.financeactive.eu

HTTP response

HTTP/1.1 206 Partial Content
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: 133

{
  "total" : 3,
  "success" : 2,
  "failed" : 1,
  "errors" : [ {
    "object_id" : "3",
    "message" : "An error occurred"
  } ]
}

Response fields

Path Type Description

total

Number

Total batch actions

success

Number

Number of batch actions in success

failed

Number

Number of batch actions in error

errors[]

Array

Batch process errors

errors[].object_id

Long

Entity ID concerned by the error

errors[].message

String

Error message

errors[].description

String

Error description

Retrieving the counterparties of an organization

A GET request will list all the counterparties of an organization.

Curl request

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

Path parameters

Table 1. /api/referential/v3/{account_code}/organizations/{organization_id}/counterparties
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

enabled

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

HTTP request

GET /api/referential/v3/ACNT1/organizations/987654321/counterparties?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: 1415

{
  "_embedded" : {
    "counterparties" : [ {
      "object_id" : "1",
      "enabled" : true,
      "name" : "ENTITY",
      "code" : "ECODE",
      "country" : "FR",
      "language" : "fr_FR",
      "currency" : "EUR",
      "lei" : "AZERTYUIOP1234567890",
      "address" : {
        "street_address1" : "street address 1",
        "street_address2" : "street address 2",
        "zip_code" : "75000",
        "city" : "Paris",
        "country" : "FR"
      },
      "_links" : {
        "self" : {
          "href" : "https://apigw.financeactive.eu/api/referential/v3/ACNT1/entities/1"
        }
      }
    }, {
      "object_id" : "2",
      "enabled" : true,
      "name" : "THIRD_PARTY",
      "code" : "TPCODE",
      "country" : "FR",
      "lei" : "AZERTY12345678905678",
      "roles" : [ "COUNTERPARTY" ],
      "group" : {
        "id" : "3",
        "name" : "THIRD_PARTY"
      },
      "origin" : "GLOBAL",
      "address" : {
        "street_address1" : "street address 1",
        "street_address2" : "street address 2",
        "zip_code" : "44200",
        "city" : "Nantes",
        "country" : "FR"
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://apigw.financeactive.eu/api/referential/v3/ACNT1/organizations/987654321/counterparties?page=0&size=20"
    }
  },
  "page" : {
    "size" : 20,
    "total_elements" : 2,
    "total_pages" : 1,
    "number" : 0
  }
}

Response fields

Path Type Description

_embedded.counterparties[].object_id

String

Counterparty technical ID

_embedded.counterparties[].name

String

Counterparty name

_embedded.counterparties[].code

String

Counterparty code

_embedded.counterparties[].enabled

Boolean

Status of the counterparty (activated or not)

_embedded.counterparties[].country

String

Counterparty country

_embedded.counterparties[].currency

String

Counterparty currency

_embedded.counterparties[].language

String

Counterparty language

_embedded.counterparties[].roles[]

Array

Counterparty roles

_embedded.counterparties[].group

Object

Counterparty group

_embedded.counterparties[].group.id

String

Counterparty group id

_embedded.counterparties[].group.name

String

Counterparty group name

_embedded.counterparties[].origin

String

Counterparty origin

_embedded.counterparties[].address

Object

Counterparty address

_embedded.counterparties[].address.country

String

Counterparty country

_embedded.counterparties[].address.city

String

Counterparty city

_embedded.counterparties[].address.street_address1

String

Counterparty street address 1

_embedded.counterparties[].address.street_address2

String

Counterparty street address 2

_embedded.counterparties[].address.zip_code

String

Counterparty address zip code

_embedded.counterparties[].lei

String

Legal entity identifier

_embedded.counterparties[]._links

Object

Links to other resources

_embedded.counterparties[]._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 Counterparty list

Associate entities as internal counterparties of an organization

A POST request will associate entities parameterized in the request body.

Curl request

$ curl 'https://apigw.financeactive.eu/api/referential/v3/ACNT1/organizations/123456789/internal-counterparties' -i -X POST \
    -H 'Content-Type: application/hal+json;charset=UTF-8' \
    -d '[
  {
    "entity_id": "123456789"
  },
  {
    "entity_id": "234567891"
  },
  {
    "entity_id": "345678912"
  }
]
'

Path parameters

Table 1. /api/referential/v3/{account_code}/organizations/{organization_id}/internal-counterparties
Parameter Description

account_code

Account Code or ID

organization_id

Organization ID

HTTP request

POST /api/referential/v3/ACNT1/organizations/123456789/internal-counterparties HTTP/1.1
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 117
Host: apigw.financeactive.eu

[
  {
    "entity_id": "123456789"
  },
  {
    "entity_id": "234567891"
  },
  {
    "entity_id": "345678912"
  }
]

HTTP response

HTTP/1.1 206 Partial Content
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: 969

{
  "total" : 3,
  "success" : 2,
  "failed" : 1,
  "errors" : [ {
    "message" : "An error occurred",
    "internal_counterparty" : {
      "entity_id" : "345678912"
    }
  } ],
  "counterparties" : [ {
    "object_id" : "123456789",
    "enabled" : true,
    "name" : "ENTITY1",
    "code" : "E1CODE",
    "country" : "FR",
    "language" : "fr_FR",
    "currency" : "EUR",
    "lei" : "AZERTYUIOP1234567890",
    "origin" : "LOCAL",
    "_links" : {
      "self" : {
        "href" : "https://apigw.financeactive.eu/api/referential/v3/ACNT1/entities/123456789"
      }
    }
  }, {
    "object_id" : "234567891",
    "enabled" : true,
    "name" : "ENTITY2",
    "code" : "E2CODE",
    "country" : "FR",
    "language" : "fr_FR",
    "currency" : "EUR",
    "lei" : "AZERTY12345678905678",
    "origin" : "GLOBAL",
    "_links" : {
      "self" : {
        "href" : "https://apigw.financeactive.eu/api/referential/v3/ACNT1/entities/234567891"
      }
    }
  } ]
}

Response fields

Path Type Description

total

Number

Total batch actions

success

Number

Number of batch actions in success

failed

Number

Number of batch actions in error

errors[]

Array

Batch process errors

errors[].internal_counterparty

Object

internal counterparty in error

errors[].message

String

Error message

errors[].description

String

Error description

errors[].internal_counterparty.entity_id

String

Entity ID that throw an error.

counterparties[].object_id

String

Counterparty technical ID

counterparties[].name

String

Counterparty name

counterparties[].code

String

Counterparty code

counterparties[].enabled

Boolean

Status of the counterparty (activated or not)

counterparties[].country

String

Counterparty country

counterparties[].currency

String

Counterparty currency

counterparties[].language

String

Counterparty language

counterparties[].origin

String

Counterparty origin

counterparties[].lei

String

Legal entity identifier

counterparties[]._links

Object

Links to other resources

counterparties[]._links.self

Object

Link to this Entity resource

Disassociate entities as internal counterparties of an organization

A DELETE request will disassociate entities parameterized in the path parameters.

Curl request

$ curl 'https://apigw.financeactive.eu/api/referential/v3/ACNT1/organizations/123456789/internal-counterparties?entity_id=1&entity_id=2&entity_id=3' -i -X DELETE

Path parameters

Table 1. /api/referential/v3/{account_code}/organizations/{organization_id}/internal-counterparties
Parameter Description

account_code

Account Code or ID

organization_id

Organization ID

Request parameters

Parameter Description

entity_id

Entity ID. Mandatory. Can be added several times.

HTTP request

DELETE /api/referential/v3/ACNT1/organizations/123456789/internal-counterparties?entity_id=1&entity_id=2&entity_id=3 HTTP/1.1
Host: apigw.financeactive.eu

HTTP response

HTTP/1.1 206 Partial Content
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: 133

{
  "total" : 3,
  "success" : 2,
  "failed" : 1,
  "errors" : [ {
    "object_id" : "3",
    "message" : "An error occurred"
  } ]
}

Response fields

Path Type Description

total

Number

Total batch actions

success

Number

Number of batch actions in success

failed

Number

Number of batch actions in error

errors[]

Array

Batch process errors

errors[].object_id

Long

Entity ID concerned by the error

errors[].message

String

Error message

errors[].description

String

Error description

Entities

Listing entities

A GET request will list all of the entities.

Curl request

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

Path parameters

Table 1. /api/referential/v3/{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/v3/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;charset=UTF-8
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: 1689

{
  "_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/v3/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/v3/ACNT1/entities/2"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://apigw.financeactive.eu/api/referential/v3/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

Number

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/v3/ACNT1/entities/1' -i -X GET

Path parameters

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

account_code

Account code or ID

entity_id

Entity ID

HTTP request

GET /api/referential/v3/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;charset=UTF-8
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: 744

{
  "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/v3/ACNT1/entities/1"
    },
    "entities" : {
      "href" : "https://apigw.financeactive.eu/api/referential/v3/ACNT1/entities{?enabled}",
      "templated" : true
    }
  }
}

Response fields

Path Type Description

object_id

Number

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

Adding a list of entities

A POST request will add one or more entities parameterized in the request body.

Curl request

$ curl 'https://apigw.financeactive.eu/api/referential/v3/ACNT1/entities' -i -X POST \
    -H 'Content-Type: application/hal+json;charset=UTF-8' \
    -d '[
  {
    "address": {
      "city": "Paris",
      "country": "FR",
      "street_address1": "street address 1",
      "street_address2": "street address 2",
      "zip_code": "75000"
    },
    "code": "E1CODE",
    "currency": "EUR",
    "lei": "AZERTYUIOP1234567890",
    "language": "FR",
    "name": "ENTITY1"
  }
]
'

Path parameters

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

account_code

Account code or ID

Request body

[
  {
    "address": {
      "city": "Paris",
      "country": "FR",
      "street_address1": "street address 1",
      "street_address2": "street address 2",
      "zip_code": "75000"
    },
    "code": "E1CODE",
    "currency": "EUR",
    "lei": "AZERTYUIOP1234567890",
    "language": "FR",
    "name": "ENTITY1"
  }
]

Request fields

Path Type Description

[].name

String

Entity name. Max size 100. Mandatory

[].code

String

Entity Code. Max size 20. Mandatory

[].language

String

Entity language. Supported languages (en, en_US, fr, fr_BE, sv, fi, no, es_ES, nl, nl_BE, de). Optional. Default: Account language.

[].address

Object

Entity address. Optional.

[].address.street_address1

String

Entity street address 1. Max size 255. Optional.

[].address.street_address2

String

Entity street address 2. Max size 255. Optional.

[].address.zip_code

String

Entity address zip code. Max size 10. Optional.

[].address.city

String

Entity city. Max size 100. Optional.

[].address.country

String

Entity country. Optional. Default: Account Country

[].currency

String

Entity currency. Optional

[].lei

String

Legal entity identifier. Exact size 20. Only alphanumeric characters. Optional.

HTTP request

POST /api/referential/v3/ACNT1/entities HTTP/1.1
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 322
Host: apigw.financeactive.eu

[
  {
    "address": {
      "city": "Paris",
      "country": "FR",
      "street_address1": "street address 1",
      "street_address2": "street address 2",
      "zip_code": "75000"
    },
    "code": "E1CODE",
    "currency": "EUR",
    "lei": "AZERTYUIOP1234567890",
    "language": "FR",
    "name": "ENTITY1"
  }
]

HTTP response

HTTP/1.1 201 Created
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: 778

{
  "total" : 1,
  "success" : 1,
  "failed" : 0,
  "errors" : [ ],
  "entities" : [ {
    "object_id" : "4144645326359212622",
    "enabled" : true,
    "name" : "ENTITY1",
    "code" : "E1CODE",
    "country" : "FR",
    "currency" : "EUR",
    "language" : "fr_FR",
    "privacy_policy" : {
      "visible_inside_organization" : false,
      "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/v3/ACNT1/entities/4144645326359212622"
      }
    }
  } ]
}

Response fields

Path Type Description

total

Number

Total batch actions

success

Number

Number of batch actions in success

failed

Number

Number of batch actions in error

errors[]

Array

Batch process errors

errors[].entity

Object

Entity in error

errors[].message

String

Error message

errors[].description

String

Error description

entities

Array

created Entities

entities[].object_id

String

Entity technical ID

entities[].name

String

Entity name

entities[].code

String

Entity code

entities[].enabled

Boolean

Status of the entity (activated or not)

entities[].country

String

Entity country

entities[].currency

String

Entity currency

entities[].language

String

Entity language

entities[].privacy_policy

Object

Entity privacy policy

entities[].privacy_policy.visible_inside_organization

Boolean

Entity visible inside the organization or not. Default false.

entities[].privacy_policy.visible_outside_organization

Boolean

Entity visible outside the organization or not. Default false.

entities[].address

Object

Entity address

entities[].address.country

String

Entity country

entities[].address.city

String

Entity city

entities[].address.street_address1

String

Entity street address 1

entities[].address.street_address2

String

Entity street address 2

entities[].address.zip_code

String

Entity address zip code

entities[].lei

String

Legal entity identifier

entities[]._links

Object

Links to other resources

entities[]._links.self

Object

Link to this Entity resource

Updating a list of entities

A PUT request will update one or more entities parameterized in the request body.

Curl request

$ curl 'https://apigw.financeactive.eu/api/referential/v3/ACNT1/entities' -i -X PUT \
    -H 'Content-Type: application/hal+json;charset=UTF-8' \
    -d '[
  {
    "object_id": "1",
    "enabled": true,
    "name": "NName1",
    "code": "NCode1",
    "language": "FR",
    "address": {
      "street_address1": "NSTA11",
      "street_address2": "NSTA21",
      "zip_code": "NZipCode1",
      "city": "NCity1",
      "country": "SE"
    },
    "currency": "IDR",
    "lei": "AZERTYUIOP1234567892"
  },
  {
    "object_id": "2",
    "enabled": false,
    "name": "NName2",
    "code": "NCode2",
    "language": "FR",
    "address": {
      "street_address1": "NSTA12",
      "street_address2": "NSTA22",
      "zip_code": "NZipCode2",
      "city": "NCity2",
      "country": "SE"
    },
    "currency": "SEK",
    "lei": "AZERTYUIOP1234567893"
  }
]'

Path parameters

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

account_code

Account Code or ID

Request body

[
  {
    "object_id": "1",
    "enabled": true,
    "name": "NName1",
    "code": "NCode1",
    "language": "FR",
    "address": {
      "street_address1": "NSTA11",
      "street_address2": "NSTA21",
      "zip_code": "NZipCode1",
      "city": "NCity1",
      "country": "SE"
    },
    "currency": "IDR",
    "lei": "AZERTYUIOP1234567892"
  },
  {
    "object_id": "2",
    "enabled": false,
    "name": "NName2",
    "code": "NCode2",
    "language": "FR",
    "address": {
      "street_address1": "NSTA12",
      "street_address2": "NSTA22",
      "zip_code": "NZipCode2",
      "city": "NCity2",
      "country": "SE"
    },
    "currency": "SEK",
    "lei": "AZERTYUIOP1234567893"
  }
]

Request fields

Path Type Description

[].object_id

String

Entity ID. Mandatory.

[].enabled

Boolean

Entity is enabled (true or false). Mandatory.

[].name

String

Entity name. Max size 100. Mandatory.

[].code

String

Entity code. Max size 20. Mandatory.

[].language

String

Entity language. One of (en, en_US, fr, fr_BE, sv, fi, no, es_ES, nl, nl_BE, de). Mandatory.

[].address

Object

Entity address. Mandatory.

[].address.street_address1

String

Street address 1. Max size 255. Optional.

[].address.street_address2

String

Street address 2. Max size 255. Optional.

[].address.zip_code

String

Zip code. Max size 10. Optional.

[].address.city

String

City. Max size 100. Optional.

[].address.country

String

Country. Mandatory.

[].currency

String

Entity currency. Mandatory.

[].lei

String

Legal entity identifier. Exact size 20. Only alphanumeric characters. Optional.

HTTP request

PUT /api/referential/v3/ACNT1/entities HTTP/1.1
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 695
Host: apigw.financeactive.eu

[
  {
    "object_id": "1",
    "enabled": true,
    "name": "NName1",
    "code": "NCode1",
    "language": "FR",
    "address": {
      "street_address1": "NSTA11",
      "street_address2": "NSTA21",
      "zip_code": "NZipCode1",
      "city": "NCity1",
      "country": "SE"
    },
    "currency": "IDR",
    "lei": "AZERTYUIOP1234567892"
  },
  {
    "object_id": "2",
    "enabled": false,
    "name": "NName2",
    "code": "NCode2",
    "language": "FR",
    "address": {
      "street_address1": "NSTA12",
      "street_address2": "NSTA22",
      "zip_code": "NZipCode2",
      "city": "NCity2",
      "country": "SE"
    },
    "currency": "SEK",
    "lei": "AZERTYUIOP1234567893"
  }
]

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: 1363

{
  "total" : 2,
  "success" : 2,
  "failed" : 0,
  "errors" : [ ],
  "entities" : [ {
    "object_id" : "1",
    "enabled" : true,
    "name" : "NName1",
    "code" : "NCode1",
    "country" : "SE",
    "currency" : "IDR",
    "language" : "fr_FR",
    "privacy_policy" : {
      "visible_inside_organization" : true,
      "visible_outside_organization" : false
    },
    "address" : {
      "street_address1" : "NSTA11",
      "street_address2" : "NSTA21",
      "zip_code" : "NZipCode1",
      "city" : "NCity1",
      "country" : "SE"
    },
    "lei" : "AZERTYUIOP1234567892",
    "_links" : {
      "self" : {
        "href" : "https://apigw.financeactive.eu/api/referential/v3/ACNT1/entities/1"
      }
    }
  }, {
    "object_id" : "2",
    "enabled" : true,
    "name" : "NName2",
    "code" : "NCode2",
    "country" : "SE",
    "currency" : "SEK",
    "language" : "fr_FR",
    "privacy_policy" : {
      "visible_inside_organization" : true,
      "visible_outside_organization" : false
    },
    "address" : {
      "street_address1" : "NSTA12",
      "street_address2" : "NSTA22",
      "zip_code" : "NZipCode2",
      "city" : "NCity2",
      "country" : "SE"
    },
    "lei" : "AZERTYUIOP1234567893",
    "_links" : {
      "self" : {
        "href" : "https://apigw.financeactive.eu/api/referential/v3/ACNT1/entities/2"
      }
    }
  } ]
}

Response fields

Path Type Description

total

Number

Total batch actions

success

Number

Number of batch actions in success

failed

Number

Number of batch actions in error

errors[]

Array

Batch process errors

errors[].entity

Object

Entity in error

errors[].message

String

Error message

errors[].description

String

Error description

entities

Array

updated Entities

entities[].object_id

String

Entity technical ID

entities[].name

String

Entity name

entities[].code

String

Entity code

entities[].enabled

Boolean

Status of the entity (activated or not)

entities[].country

String

Entity country

entities[].currency

String

Entity currency

entities[].language

String

Entity language

entities[].privacy_policy

Object

Entity privacy policy

entities[].privacy_policy.visible_inside_organization

Boolean

Entity visible inside the organization or not. Default false.

entities[].privacy_policy.visible_outside_organization

Boolean

Entity visible outside the organization or not. Default false.

entities[].address

Object

Entity address

entities[].address.country

String

Entity country

entities[].address.city

String

Entity city

entities[].address.street_address1

String

Entity street address 1

entities[].address.street_address2

String

Entity street address 2

entities[].address.zip_code

String

Entity address zip code

entities[].lei

String

Legal entity identifier

entities[]._links

Object

Links to other resources

entities[]._links.self

Object

Link to this Entity resource

Removing a list of entities

A DELETE request will remove the entities parameterized in the request parameters.

Curl request

$ curl 'https://apigw.financeactive.eu/api/referential/v3/ACNT1/entities?entity_id=1&entity_id=2&entity_id=3' -i -X DELETE

Path parameters

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

account_code

Account Code or ID

Request parameters

Parameter Description

entity_id

Entity ID. Mandatory. Can be added several times.

HTTP request

DELETE /api/referential/v3/ACNT1/entities?entity_id=1&entity_id=2&entity_id=3 HTTP/1.1
Host: apigw.financeactive.eu

HTTP response

HTTP/1.1 206 Partial Content
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: 133

{
  "total" : 3,
  "success" : 2,
  "failed" : 1,
  "errors" : [ {
    "object_id" : "3",
    "message" : "An error occurred"
  } ]
}

Response fields

Path Type Description

total

Number

Total batch actions

success

Number

Number of batch actions in success

failed

Number

Number of batch actions in error

errors[]

Array

Batch process errors

errors[].object_id

Long

Entity ID concerned by the error

errors[].message

String

Error message

errors[].description

String

Error description

Removing an entity

A DELETE request will remove the entity parameterized in the path parameters.

Curl request

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

Path parameters

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

account_code

Account Code or ID

entity_id

Entity ID

HTTP request

DELETE /api/referential/v3/ACNT1/entities/1 HTTP/1.1
Host: apigw.financeactive.eu

HTTP response

HTTP/1.1 204 No Content
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
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

Users

Listing users

A GET request will return a user in a given account with a link to his permissions on each entities of the account.

Curl request

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

Path parameters

Table 1. /api/referential/v3/{account_code}/users
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/v3/ACNT1/users?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;charset=UTF-8
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: 858

{
  "_embedded" : {
    "users" : [ {
      "object_id" : "234",
      "name" : "John Doe",
      "email" : "john.doe@example.org",
      "language" : "en",
      "enabled" : true,
      "is_account_admin" : false,
      "organization_id" : "12",
      "organization_name" : "Org name",
      "use_new_permission_system" : false,
      "_links" : {
        "self" : {
          "href" : "https://apigw.financeactive.eu/api/referential/v3/ACNT1/users/234"
        },
        "permissions" : {
          "href" : "https://apigw.financeactive.eu/api/referential/v3/ACNT1/users/234/permissions"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://apigw.financeactive.eu/api/referential/v3/ACNT1/users?page=0&size=20"
    }
  },
  "page" : {
    "size" : 20,
    "total_elements" : 1,
    "total_pages" : 1,
    "number" : 0
  }
}

Response fields

Path Type Description

_embedded.users[].object_id

String

User technical ID

_embedded.users[].name

String

User name

_embedded.users[].email

String

User email

_embedded.users[].language

String

User language

_embedded.users[].enabled

Boolean

Status of the user (activated or not)

_embedded.users[].is_account_admin

Boolean

is User account administrator

_embedded.users[].organization_id

String

Organization ID

_embedded.users[].organization_name

String

Organization name

_embedded.users[].use_new_permission_system

Boolean

is user on new permission system

_embedded.users[]._links

Object

Links to resources linked to this user

_embedded.users[]._links.permissions

Object

Link to the API permissions of a user

_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 the this users list

Retrieving a user

A GET request will return the list of the users in a given account with a link to their permissions on each entities of the account.

Curl request

$ curl 'https://apigw.financeactive.eu/api/referential/v3/ACNT1/users/234' -i -X GET

Path parameters

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

account_code

Account Code or ID

user_id

User ID

HTTP request

GET /api/referential/v3/ACNT1/users/234 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;charset=UTF-8
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: 506

{
  "object_id" : "234",
  "name" : "John Doe",
  "email" : "john.doe@example.org",
  "language" : "en",
  "enabled" : true,
  "is_account_admin" : false,
  "organization_id" : "12",
  "organization_name" : "Org name",
  "use_new_permission_system" : false,
  "_links" : {
    "self" : {
      "href" : "https://apigw.financeactive.eu/api/referential/v3/ACNT1/users/234"
    },
    "permissions" : {
      "href" : "https://apigw.financeactive.eu/api/referential/v3/ACNT1/users/234/permissions"
    }
  }
}

Response fields

Path Type Description

object_id

String

User technical ID

name

String

User name

email

String

User email

language

String

User language

enabled

Boolean

Status of the user (activated or not)

is_account_admin

Boolean

is User account administrator

organization_id

String

Organization ID

organization_name

String

Organization name

use_new_permission_system

Boolean

is user on new permission system

_links

Object

Links to resources linked to this user

_links.permissions

Object

Link to the API permissions of a user

Relation Description

self

Link to this user resource

permissions

Link to the API permissions of the user

Adding a list of users

A POST request will add one or more users parameterized in the request body.

Curl request

$ curl 'https://apigw.financeactive.eu/api/referential/v3/users' -i -X POST \
    -H 'Content-Type: application/hal+json;charset=UTF-8' \
    -d '[
  {
    "email": "user1@test.com",
    "full_name": "user1",
    "language": "FR",
    "accounts": [
      "ACNT1",
      "ACNT2"
    ]
  },
  {
    "email": "user2@test.com",
    "full_name": "user2",
    "language": "EN",
    "accounts": [
      "ACNT2",
      "ACNT3"
    ]
  }
]
'

Path parameters

Snippet path-parameters not found for operation::general-users-POST

Request body

[
  {
    "email": "user1@test.com",
    "full_name": "user1",
    "language": "FR",
    "accounts": [
      "ACNT1",
      "ACNT2"
    ]
  },
  {
    "email": "user2@test.com",
    "full_name": "user2",
    "language": "EN",
    "accounts": [
      "ACNT2",
      "ACNT3"
    ]
  }
]

Request fields

Path Type Description

[].email

String

User email address. Mandatory and unique.

[].full_name

String

User full name. Mandatory. Max size 200

[].language

String

User language. Mandatory in the followings: (en, en_US, fr, fr_BE, sv, fi, no, es_ES, nl, nl_BE, de)

[].accounts

Array

the accounts to which you want to associate the user

HTTP request

POST /api/referential/v3/users HTTP/1.1
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 285
Host: apigw.financeactive.eu

[
  {
    "email": "user1@test.com",
    "full_name": "user1",
    "language": "FR",
    "accounts": [
      "ACNT1",
      "ACNT2"
    ]
  },
  {
    "email": "user2@test.com",
    "full_name": "user2",
    "language": "EN",
    "accounts": [
      "ACNT2",
      "ACNT3"
    ]
  }
]

HTTP response

HTTP/1.1 201 Created
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: 979

{
  "total" : 2,
  "success" : 2,
  "failed" : 0,
  "errors" : [ ],
  "users" : [ {
    "object_id" : "4016545395965379394",
    "uuid" : "81b85066-e192-43d3-ba0e-0b56f325174c",
    "name" : "User1",
    "email" : "user1@test.com",
    "language" : "French",
    "enabled" : false,
    "privilege" : {
      "value" : "STANDARD",
      "label" : "Standard"
    },
    "_links" : {
      "self" : {
        "href" : "https://apigw.financeactive.eu/api/referential/v3/users/81b85066-e192-43d3-ba0e-0b56f325174c"
      }
    }
  }, {
    "object_id" : "6892607562899869109",
    "uuid" : "069618df-9383-4127-90d8-9ac320ad266d",
    "name" : "User2",
    "email" : "user2@test.com",
    "language" : "English",
    "enabled" : false,
    "privilege" : {
      "value" : "STANDARD",
      "label" : "Standard"
    },
    "_links" : {
      "self" : {
        "href" : "https://apigw.financeactive.eu/api/referential/v3/users/069618df-9383-4127-90d8-9ac320ad266d"
      }
    }
  } ]
}

Response fields

Path Type Description

total

Number

Total batch actions

success

Number

Number of batch actions in success

failed

Number

Number of batch actions in error

errors[]

Array

Batch process errors

errors[].user

Object

User that has error

errors[].message

String

Error message

errors[].description

String

Error description

users

Array

Users that was created

users[].object_id

String

User technical ID

users[].name

String

User full name

users[].email

String

User email address. Unique.

users[].language

String

user default language

users[].enabled

Boolean

Status of the user (activated or not). Default disable

users[].privilege

Object

User privilege. Default standard

users[].privilege.value

String

privilege value

users[].privilege.label

String

privilege label translated according to the user’s default language

users[].uuid

String

User universal unique identifier

users[]._links

Object

Links to other resources

users[]._links.self

Object

Link to this User resource

Updating a list of users

A PUT request will update one or more users parameterized in the request body.

Curl request

$ curl 'https://apigw.financeactive.eu/api/referential/v3/users' -i -X PUT \
    -H 'Content-Type: application/hal+json;charset=UTF-8' \
    -d '[
  {
    "uuid": "1",
    "enabled": false,
    "email": "newUser1@test.com",
    "full_name": "newUser1",
    "language": "EN"
  },
  {
    "uuid": "2",
    "enabled": false,
    "email": "newUser2@test.com",
    "full_name": "newUser2",
    "language": "FR"
  }
]
'

Path parameters

Snippet path-parameters not found for operation::general-users-response-PUT

Request body

[
  {
    "uuid": "1",
    "enabled": false,
    "email": "newUser1@test.com",
    "full_name": "newUser1",
    "language": "EN"
  },
  {
    "uuid": "2",
    "enabled": false,
    "email": "newUser2@test.com",
    "full_name": "newUser2",
    "language": "FR"
  }
]

Request fields

Path Type Description

[].uuid

String

User universal unique identifier. Mandatory and unique.

[].enabled

Boolean

Status of the user (activated or not). Mandatory.

[].email

String

User email address. Mandatory and unique.

[].full_name

String

User full name. Mandatory. Max size 200

[].language

String

User language. Mandatory in the followings: (en, en_US, fr, fr_BE, sv, fi, no, es_ES, nl, nl_BE, de)

HTTP request

PUT /api/referential/v3/users HTTP/1.1
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 267
Host: apigw.financeactive.eu

[
  {
    "uuid": "1",
    "enabled": false,
    "email": "newUser1@test.com",
    "full_name": "newUser1",
    "language": "EN"
  },
  {
    "uuid": "2",
    "enabled": false,
    "email": "newUser2@test.com",
    "full_name": "newUser2",
    "language": "FR"
  }
]

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: 815

{
  "total" : 2,
  "success" : 2,
  "failed" : 0,
  "errors" : [ ],
  "users" : [ {
    "object_id" : "1",
    "uuid" : "1",
    "name" : "newUser1",
    "email" : "newUser1@test.com",
    "language" : "English",
    "enabled" : false,
    "privilege" : {
      "value" : "STANDARD",
      "label" : "Standard"
    },
    "_links" : {
      "self" : {
        "href" : "https://apigw.financeactive.eu/api/referential/v3/users/1"
      }
    }
  }, {
    "object_id" : "2",
    "uuid" : "2",
    "name" : "newUser2",
    "email" : "newUser2@test.com",
    "language" : "French",
    "enabled" : false,
    "privilege" : {
      "value" : "STANDARD",
      "label" : "Standard"
    },
    "_links" : {
      "self" : {
        "href" : "https://apigw.financeactive.eu/api/referential/v3/users/2"
      }
    }
  } ]
}

Response fields

Path Type Description

total

Number

Total batch actions

success

Number

Number of batch actions in success

failed

Number

Number of batch actions in error

errors[]

Array

Batch process errors

errors[].user

Object

User that has error

errors[].message

String

Error message

errors[].description

String

Error description

users

Array

Users that was created

users[].object_id

String

User technical ID

users[].name

String

User full name

users[].email

String

User email address. Unique.

users[].language

String

user default language

users[].enabled

Boolean

Status of the user (activated or not). Default disable

users[].privilege

Object

User privilege. Default standard

users[].privilege.value

String

privilege value

users[].privilege.label

String

privilege label translated according to the user’s default language

users[].uuid

String

User universal unique identifier

users[]._links

Object

Links to other resources

users[]._links.self

Object

Link to this User resource

Permissions of a given user

A GET request will return all the permissions of a user on its entities.

Curl request

$ curl 'https://apigw.financeactive.eu/api/referential/v3/ACNT1/users/234/permissions' -i -X GET

Path parameters

Table 1. /api/referential/v3/{account_id}/users/{user_id}/permissions
Parameter Description

account_id

Account ID

user_id

User ID

HTTP request

GET /api/referential/v3/ACNT1/users/234/permissions 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;charset=UTF-8
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: 682

{
  "user_account_admin" : true,
  "organizations" : {
    "_embedded" : {
      "organizations" : [ {
        "object_id" : "12345",
        "name" : "ORG_12345",
        "organization_admin" : true,
        "entities" : [ {
          "id" : "1234",
          "code" : "E12CODE",
          "name" : "ENTITY12",
          "permissions" : [ "ENTITY_ACCESS", "ENTITY_MANAGE" ]
        } ]
      } ]
    },
    "_links" : {
      "self" : {
        "href" : "https://apigw.financeactive.eu/api/referential/v3/ACNT1/users/234/permissions?page=0&size=20"
      }
    },
    "page" : {
      "size" : 20,
      "total_elements" : 1,
      "total_pages" : 1,
      "number" : 0
    }
  }
}

Response fields

Path Type Description

user_account_admin

Boolean

If user is account admin

organizations

Object

Paged organizations

organizations._links

Object

All links to paged organizations

organizations.page

Object

Pagination information

organizations.page.size

Number

Current page size. Integer

organizations.page.total_elements

Number

Total number of elements for this collection. Integer

organizations.page.total_pages

Number

Total number of pages. Integer

organizations.page.number

Number

Current page number. 0-based integer

organizations._embedded.organizations[].object_id

String

Organization technical ID

organizations._embedded.organizations[].name

String

Organization name

organizations._embedded.organizations[].organization_admin

Boolean

If user is organization admin

organizations._embedded.organizations[].entities[]

Array

Entities of organization

organizations._embedded.organizations[].entities[].id

String

Entity technical ID

organizations._embedded.organizations[].entities[].code

String

Entity code

organizations._embedded.organizations[].entities[].name

String

Entity name

organizations._embedded.organizations[].entities[].permissions[]

Array

Entity access permissions

Listing the accounts of a user

Curl request

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

Path parameters

Table 1. /api/referential/v3/{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/v3/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;charset=UTF-8
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: 676

{
  "_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/v3/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

Number

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

Third Parties

Retrieving a third party

Curl request

$ curl 'https://apigw.financeactive.eu/api/referential/v3/ACNT1/third-parties/364469532718733' -i -X GET

Path parameters

Table 1. /api/referential/v3/{account_code}/third-parties/{third_party_id}
Parameter Description

account_code

Account Code or ID

third_party_id

Third Party ID

HTTP request

GET /api/referential/v3/ACNT1/third-parties/364469532718733 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: 570

{
  "object_id" : "364469532718733",
  "enabled" : false,
  "name" : "NTP94",
  "code" : "CTP94",
  "roles" : [ "COUNTERPARTY" ],
  "group" : "NTP",
  "address" : {
    "street_address1" : "ST12",
    "street_address2" : "ST22",
    "zip_code" : "ZipCode2",
    "city" : "City2",
    "country" : "SE"
  },
  "_links" : {
    "self" : {
      "href" : "https://apigw.financeactive.eu/api/referential/v3/234567891/third-parties/364469532718733"
    },
    "group" : {
      "href" : "https://apigw.financeactive.eu/api/referential/v3/234567891/third-parties/1"
    }
  }
}

Response fields

Path Type Description

object_id

String

Third Party technical ID

name

String

Third Party name

code

String

Third Party code

enabled

Boolean

Status of the third party (activated or not)

roles

Array

Third Party roles

address

class java.lang.Object

Third party address

address.country

class java.lang.String

Third party country

address.city

class java.lang.String

Third party city

address.street_address1

class java.lang.String

Third party street address 1

address.street_address2

class java.lang.String

Third party street address 2

address.zip_code

class java.lang.String

Third party address zip code

group

class java.lang.String

Third Party group

lei

class java.lang.String

Legal entity identifier

_links

Object

Links to other resources

_links.self

Object

Link to this Third Party resource

_links.group

class java.lang.String

Link to the group of this third party resource

Snippet links not found for operation::referential-third-parties-id-GET

Adding a list of third parties

A POST request will add one or more third parties parameterized in the request body.

Curl request

$ curl 'https://apigw.financeactive.eu/api/referential/v3/ACNT1/third-parties' -i -X POST \
    -H 'Content-Type: application/hal+json;charset=UTF-8' \
    -d '[
  {
    "name": "NTP94",
    "code": "CTP94",
    "roles": ["COUNTERPARTY"],
    "group_id": null
  }
]
'

Path parameters

Table 1. /api/referential/v3/{account_code}/third-parties
Parameter Description

account_code

Account Code or ID

Request body

[
  {
    "name": "NTP94",
    "code": "CTP94",
    "roles": ["COUNTERPARTY"],
    "group_id": null
  }
]

Request fields

Path Type Description

[].name

String

Third Party name. Max size 100. Mandatory.

[].code

String

Third Party code. Max size 20. Mandatory and unique.

[].roles

Array

Third Party roles. Optional or can be PARTY or/and COUNTERPARTY.

[].group_id

Null

Third Party group ID. Optional.

HTTP request

POST /api/referential/v3/ACNT1/third-parties HTTP/1.1
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 106
Host: apigw.financeactive.eu

[
  {
    "name": "NTP94",
    "code": "CTP94",
    "roles": ["COUNTERPARTY"],
    "group_id": null
  }
]

HTTP response

HTTP/1.1 201 Created
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: 394

{
  "total" : 1,
  "success" : 1,
  "failed" : 0,
  "errors" : [ ],
  "third_parties" : [ {
    "object_id" : "364469532718733",
    "enabled" : false,
    "name" : "NTP94",
    "code" : "CTP94",
    "roles" : [ "COUNTERPARTY" ],
    "_links" : {
      "self" : {
        "href" : "https://apigw.financeactive.eu/api/referential/v3/234567891/third-parties/364469532718733"
      }
    }
  } ]
}

Response fields

Path Type Description

total

Number

Total batch actions

success

Number

Number of batch actions in success

failed

Number

Number of batch actions in error

errors[]

Array

Batch process errors

errors[].third_party

Object

Third party in error

errors[].message

String

Error message

errors[].description

String

Error description

third_parties[].object_id

String

Third Party technical ID

third_parties[].name

String

Third Party name

third_parties[].code

String

Third Party code

third_parties[].enabled

Boolean

Status of the third party (activated or not)

third_parties[].roles

Array

Third Party roles

third_parties[].address

class java.lang.Object

Third party address

third_parties[].address.country

class java.lang.String

Third party country

third_parties[].address.city

class java.lang.String

Third party city

third_parties[].address.street_address1

class java.lang.String

Third party street address 1

third_parties[].address.street_address2

class java.lang.String

Third party street address 2

third_parties[].address.zip_code

class java.lang.String

Third party address zip code

third_parties[].group

class java.lang.String

Third Party group

third_parties[].lei

class java.lang.String

Legal entity identifier

third_parties[]._links

Object

Links to other resources

third_parties[]._links.self

Object

Link to this Third Party resource

third_parties[]._links.group

class java.lang.String

Link to the group of this third party resource

Updating a list of third parties

A PUT request will update one or more third parties parameterized in the request body.

Curl request

$ curl 'https://apigw.financeactive.eu/api/referential/v3/ACNT1/third-parties' -i -X PUT \
    -H 'Content-Type: application/hal+json;charset=UTF-8' \
    -d '[
  {
    "object_id": "1",
    "code": "NCode1",
    "name": "NName1",
    "roles": ["COUNTERPARTY"],
    "lei": "AZERTY12345678905687",
    "address": {
      "street_address1": "NSTA11",
      "street_address2": "NSTA12",
      "zip_code": "NZipCode1",
      "city": "NCity1",
      "country": "SE"
    },
    "enabled": true
  },
  {
    "object_id": "2",
    "code": "NCode2",
    "name": "NName2",
    "roles": ["PARTY"],
    "lei": "AZERTY21345678905687",
    "address": {
      "street_address1": "NSTA12",
      "street_address2": "NSTA22",
      "zip_code": "NZipCode1",
      "city": "NCity2",
      "country": "SE"
    },
    "group_id": "1",
    "enabled": false
  }
]
'

Path parameters

Table 1. /api/referential/v3/{account_code}/third-parties
Parameter Description

account_code

Account Code or ID

Request body

[
  {
    "object_id": "1",
    "code": "NCode1",
    "name": "NName1",
    "roles": ["COUNTERPARTY"],
    "lei": "AZERTY12345678905687",
    "address": {
      "street_address1": "NSTA11",
      "street_address2": "NSTA12",
      "zip_code": "NZipCode1",
      "city": "NCity1",
      "country": "SE"
    },
    "enabled": true
  },
  {
    "object_id": "2",
    "code": "NCode2",
    "name": "NName2",
    "roles": ["PARTY"],
    "lei": "AZERTY21345678905687",
    "address": {
      "street_address1": "NSTA12",
      "street_address2": "NSTA22",
      "zip_code": "NZipCode1",
      "city": "NCity2",
      "country": "SE"
    },
    "group_id": "1",
    "enabled": false
  }
]

Request fields

Path Type Description

[].object_id

String

Third party ID. Mandatory.

[].enabled

Boolean

Third party is enabled (true or false). Mandatory.

[].name

String

Third party name. Max size 100. Mandatory.

[].code

String

Third party code. Max size 20. Mandatory.

[].roles[]

Array

Third party roles. Accepted values : PARTY, COUNTERPARTY. Mandatory.

[].address

Object

Third party address. Mandatory.

[].address.street_address1

String

Street address 1. Max size 255. Optional.

[].address.street_address2

String

Street address 2. Max size 255. Optional.

[].address.zip_code

String

Zip code. Max size 10. Optional.

[].address.city

String

City. Max size 100. Optional.

[].address.country

String

Country. Mandatory.

[].lei

String

Legal entity identifier. Exact size 20. Only alphanumeric characters. Optional.

[].group_id

String

Third party group ID. Optional.

HTTP request

PUT /api/referential/v3/ACNT1/third-parties HTTP/1.1
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 682
Host: apigw.financeactive.eu

[
  {
    "object_id": "1",
    "code": "NCode1",
    "name": "NName1",
    "roles": ["COUNTERPARTY"],
    "lei": "AZERTY12345678905687",
    "address": {
      "street_address1": "NSTA11",
      "street_address2": "NSTA12",
      "zip_code": "NZipCode1",
      "city": "NCity1",
      "country": "SE"
    },
    "enabled": true
  },
  {
    "object_id": "2",
    "code": "NCode2",
    "name": "NName2",
    "roles": ["PARTY"],
    "lei": "AZERTY21345678905687",
    "address": {
      "street_address1": "NSTA12",
      "street_address2": "NSTA22",
      "zip_code": "NZipCode1",
      "city": "NCity2",
      "country": "SE"
    },
    "group_id": "1",
    "enabled": false
  }
]

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: 1207

{
  "total" : 2,
  "success" : 2,
  "failed" : 0,
  "errors" : [ ],
  "third_parties" : [ {
    "object_id" : "1",
    "enabled" : true,
    "name" : "NName1",
    "code" : "NCode1",
    "roles" : [ "COUNTERPARTY" ],
    "lei" : "AZERTYUIOP1234567892",
    "address" : {
      "street_address1" : "NSTA11",
      "street_address2" : "NSTA21",
      "zip_code" : "NZipCode1",
      "city" : "NCity1",
      "country" : "SE"
    },
    "_links" : {
      "self" : {
        "href" : "https://apigw.financeactive.eu/api/referential/v3/234567891/third-parties/1"
      }
    }
  }, {
    "object_id" : "2",
    "enabled" : true,
    "name" : "NName2",
    "code" : "NCode2",
    "roles" : [ "PARTY" ],
    "group" : "NName1",
    "lei" : "AZERTYUIOP1234567893",
    "address" : {
      "street_address1" : "NSTA12",
      "street_address2" : "NSTA22",
      "zip_code" : "NZipCode2",
      "city" : "NCity2",
      "country" : "SE"
    },
    "_links" : {
      "self" : {
        "href" : "https://apigw.financeactive.eu/api/referential/v3/234567891/third-parties/2"
      },
      "group" : {
        "href" : "https://apigw.financeactive.eu/api/referential/v3/234567891/third-parties/1"
      }
    }
  } ]
}

Response fields

Path Type Description

total

Number

Total batch actions

success

Number

Number of batch actions in success

failed

Number

Number of batch actions in error

errors[]

Array

Batch process errors

errors[].third_party

Object

Third party in error

errors[].message

String

Error message

errors[].description

String

Error description

third_parties

Array

updated Third parties

third_parties[].object_id

String

Third Party technical ID

third_parties[].name

String

Third Party name

third_parties[].code

String

Third Party code

third_parties[].enabled

Boolean

Status of the third party (activated or not)

third_parties[].roles

Array

Third Party roles

third_parties[].address

class java.lang.Object

Third party address

third_parties[].address.country

class java.lang.String

Third party country

third_parties[].address.city

class java.lang.String

Third party city

third_parties[].address.street_address1

class java.lang.String

Third party street address 1

third_parties[].address.street_address2

class java.lang.String

Third party street address 2

third_parties[].address.zip_code

class java.lang.String

Third party address zip code

third_parties[].group

class java.lang.String

Third Party group

third_parties[].lei

class java.lang.String

Legal entity identifier

third_parties[]._links

Object

Links to other resources

third_parties[]._links.self

Object

Link to this Third Party resource

third_parties[]._links.group

class java.lang.String

Link to the group of this third party resource

Removing a list of third parties

A DELETE request will remove the third parties parameterized in the request parameters.

Curl request

$ curl 'https://apigw.financeactive.eu/api/referential/v3/ACNT1/third-parties?third_party_id=1&third_party_id=2&third_party_id=3' -i -X DELETE

Path parameters

Table 1. /api/referential/v3/{account_code}/third-parties
Parameter Description

account_code

Account Code or ID

Request parameters

Parameter Description

third_party_id

Third Party ID. Mandatory. Can be added several times.

HTTP request

DELETE /api/referential/v3/ACNT1/third-parties?third_party_id=1&third_party_id=2&third_party_id=3 HTTP/1.1
Host: apigw.financeactive.eu

HTTP response

HTTP/1.1 206 Partial Content
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: 133

{
  "total" : 3,
  "success" : 2,
  "failed" : 1,
  "errors" : [ {
    "object_id" : "3",
    "message" : "An error occurred"
  } ]
}

Response fields

Path Type Description

total

Number

Total batch actions

success

Number

Number of batch actions in success

failed

Number

Number of batch actions in error

errors[]

Array

Batch process errors

errors[].object_id

Long

Third Party ID concerned by the error

errors[].message

String

Error message

errors[].description

String

Error description

Removing a third party

A DELETE request will remove the third party parameterized in the path parameters.

Curl request

$ curl 'https://apigw.financeactive.eu/api/referential/v3/ACNT1/third-parties/1' -i -X DELETE

Path parameters

Table 1. /api/referential/v3/{account_code}/third-parties/{third_party_id}
Parameter Description

account_code

Account Code or ID

third_party_id

Third Party ID

HTTP request

DELETE /api/referential/v3/ACNT1/third-parties/1 HTTP/1.1
Host: apigw.financeactive.eu

HTTP response

HTTP/1.1 204 No Content
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
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

Guarantors

Listing guarantors

A GET request will list all guarantors of an organization.

Curl request

$ curl 'https://apigw.financeactive.eu/api/referential/v3/ACNT1/organizations/1/guarantors' -i -X GET

Path parameters

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

account_code

Account Code or ID

organization_id

Organization ID

Request parameters

Snippet request-parameters not found for operation::referential-guarantors-GET

HTTP request

GET /api/referential/v3/ACNT1/organizations/1/guarantors 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: 1758

{
  "_embedded" : {
    "guarantors" : [ {
      "entity" : {
        "object_id" : "12",
        "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",
        "origin" : "Global",
        "_links" : {
          "self" : {
            "href" : "https://apigw.financeactive.eu/api/referential/v3/ACNT1/entities/12"
          }
        }
      }
    }, {
      "third_party" : {
        "object_id" : "2",
        "enabled" : true,
        "name" : "THIRD_PARTY",
        "code" : "TPCODE",
        "roles" : [ "COUNTERPARTY" ],
        "lei" : "AZERTY12345678905678",
        "address" : {
          "street_address1" : "street address 1",
          "street_address2" : "street address 2",
          "zip_code" : "44200",
          "city" : "Nantes",
          "country" : "FR"
        },
        "origin" : "GLOBAL",
        "_links" : {
          "self" : {
            "href" : "https://apigw.financeactive.eu/api/referential/v3/234567891/third-parties/2"
          }
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://apigw.financeactive.eu/api/referential/v3/ACNT1/organizations/1/guarantors?page=0&size=20"
    }
  },
  "page" : {
    "size" : 20,
    "total_elements" : 2,
    "total_pages" : 1,
    "number" : 0
  }
}

Response fields

Path Type Description

_embedded.guarantors[].entity

Object

Entity as guarantor

_embedded.guarantors[].entity.object_id

Varies

Entity technical ID

_embedded.guarantors[].entity.name

Varies

Entity name

_embedded.guarantors[].entity.code

Varies

Entity code

_embedded.guarantors[].entity.enabled

Varies

Status of the entity (activated or not)

_embedded.guarantors[].entity.country

Varies

Entity country

_embedded.guarantors[].entity.currency

Varies

Entity currency

_embedded.guarantors[].entity.language

Varies

Entity language

_embedded.guarantors[].entity.privacy_policy

Varies

Entity privacy policy

_embedded.guarantors[].entity.privacy_policy.visible_inside_organization

Varies

Entity visible inside the organization or not. Default false.

_embedded.guarantors[].entity.privacy_policy.visible_outside_organization

Varies

Entity visible outside the organization or not. Default false.

_embedded.guarantors[].entity.address

Varies

Entity address

_embedded.guarantors[].entity.address.country

Varies

Entity country

_embedded.guarantors[].entity.address.city

Varies

Entity city

_embedded.guarantors[].entity.address.street_address1

Varies

Entity street address 1

_embedded.guarantors[].entity.address.street_address2

Varies

Entity street address 2

_embedded.guarantors[].entity.address.zip_code

Varies

Entity address zip code

_embedded.guarantors[].entity.lei

Varies

Legal entity identifier

_embedded.guarantors[].entity.origin

Varies

Origin of the entity

_embedded.guarantors[].entity._links

Varies

Links to other resources

_embedded.guarantors[].entity._links.self

Varies

Link to this Entity resource

_embedded.guarantors[].third_party

Object

Third party as guarantor

_embedded.guarantors[].third_party.object_id

Varies

Third Party technical ID

_embedded.guarantors[].third_party.name

Varies

Third Party name

_embedded.guarantors[].third_party.code

Varies

Third Party code

_embedded.guarantors[].third_party.enabled

Varies

Status of the third party (activated or not)

_embedded.guarantors[].third_party.roles

Array

Third Party roles

_embedded.guarantors[].third_party.address

class java.lang.Object

Third party address

_embedded.guarantors[].third_party.address.country

class java.lang.String

Third party country

_embedded.guarantors[].third_party.address.city

class java.lang.String

Third party city

_embedded.guarantors[].third_party.address.street_address1

class java.lang.String

Third party street address 1

_embedded.guarantors[].third_party.address.street_address2

class java.lang.String

Third party street address 2

_embedded.guarantors[].third_party.address.zip_code

class java.lang.String

Third party address zip code

_embedded.guarantors[].third_party.group

class java.lang.String

Third Party group

_embedded.guarantors[].third_party.lei

class java.lang.String

Legal entity identifier

_embedded.guarantors[].third_party.origin

Varies

Third Party origin

_embedded.guarantors[].third_party._links

Varies

Links to other resources

_embedded.guarantors[].third_party._links.self

Varies

Link to this Third Party resource

_embedded.guarantors[].third_party._links.group

class java.lang.String

Link to the group of this third party resource

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

_links

Object

Links to other resources

Snippet links not found for operation::referential-guarantors-GET

Adding a list of guarantors

A POST request will associate guarantors to an organization.

Curl request

$ curl 'https://apigw.financeactive.eu/api/referential/v3/ACNT1/organizations/1/guarantors' -i -X POST \
    -H 'Content-Type: application/hal+json;charset=UTF-8' \
    -d '[
  {
    "entity_id": "12"
  },
  {
    "third_party_id": "2"
  }
]'

Path parameters

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

account_code

Account Code or ID

organization_id

Organization ID

Request body

[
  {
    "entity_id": "12"
  },
  {
    "third_party_id": "2"
  }
]

Request fields

Path Type Description

[].entity_id

String

Entity ID to link with organization as guarantor. Mandatory if third_party_id is empty. Forbidden if third_party_id not empty

[].third_party_id

String

Third Party ID to link with organization as guarantor. Mandatory if entity_id is empty. Forbidden if entity_id not empty

HTTP request

POST /api/referential/v3/ACNT1/organizations/1/guarantors HTTP/1.1
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 68
Host: apigw.financeactive.eu

[
  {
    "entity_id": "12"
  },
  {
    "third_party_id": "2"
  }
]

HTTP response

HTTP/1.1 201 Created
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: 1443

{
  "total" : 2,
  "success" : 2,
  "failed" : 0,
  "errors" : [ ],
  "guarantors" : [ {
    "entity" : {
      "object_id" : "12",
      "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",
      "origin" : "Global",
      "_links" : {
        "self" : {
          "href" : "https://apigw.financeactive.eu/api/referential/v3/ACNT1/entities/12"
        }
      }
    }
  }, {
    "third_party" : {
      "object_id" : "2",
      "enabled" : true,
      "name" : "THIRD_PARTY",
      "code" : "TPCODE",
      "roles" : [ "COUNTERPARTY" ],
      "lei" : "AZERTY12345678905678",
      "address" : {
        "street_address1" : "street address 1",
        "street_address2" : "street address 2",
        "zip_code" : "44200",
        "city" : "Nantes",
        "country" : "FR"
      },
      "origin" : "GLOBAL",
      "_links" : {
        "self" : {
          "href" : "https://apigw.financeactive.eu/api/referential/v3/234567891/third-parties/2"
        }
      }
    }
  } ]
}

Response fields

Path Type Description

total

Number

Total batch actions

success

Number

Number of batch actions in success

failed

Number

Number of batch actions in error

errors[]

Array

Batch process errors

errors[].guarantors

Object

Entity ID or Third Party ID in error

errors[].message

String

Error message

errors[].description

String

Error description

guarantors

Array

created Entities

guarantors[].entity

Object

Entity as guarantor

guarantors[].entity.object_id

Varies

Entity technical ID

guarantors[].entity.name

Varies

Entity name

guarantors[].entity.code

Varies

Entity code

guarantors[].entity.enabled

Varies

Status of the entity (activated or not)

guarantors[].entity.country

Varies

Entity country

guarantors[].entity.currency

Varies

Entity currency

guarantors[].entity.language

Varies

Entity language

guarantors[].entity.privacy_policy

Varies

Entity privacy policy

guarantors[].entity.privacy_policy.visible_inside_organization

Varies

Entity visible inside the organization or not. Default false.

guarantors[].entity.privacy_policy.visible_outside_organization

Varies

Entity visible outside the organization or not. Default false.

guarantors[].entity.address

Varies

Entity address

guarantors[].entity.address.country

Varies

Entity country

guarantors[].entity.address.city

Varies

Entity city

guarantors[].entity.address.street_address1

Varies

Entity street address 1

guarantors[].entity.address.street_address2

Varies

Entity street address 2

guarantors[].entity.address.zip_code

Varies

Entity address zip code

guarantors[].entity.lei

Varies

Legal entity identifier

guarantors[].entity.origin

Varies

Origin of the entity

guarantors[].entity._links

Varies

Links to other resources

guarantors[].entity._links.self

Varies

Link to this Entity resource

guarantors[].third_party

Object

Third party as guarantor

guarantors[].third_party.object_id

Varies

Third Party technical ID

guarantors[].third_party.name

Varies

Third Party name

guarantors[].third_party.code

Varies

Third Party code

guarantors[].third_party.enabled

Varies

Status of the third party (activated or not)

guarantors[].third_party.roles

Array

Third Party roles

guarantors[].third_party.address

class java.lang.Object

Third party address

guarantors[].third_party.address.country

class java.lang.String

Third party country

guarantors[].third_party.address.city

class java.lang.String

Third party city

guarantors[].third_party.address.street_address1

class java.lang.String

Third party street address 1

guarantors[].third_party.address.street_address2

class java.lang.String

Third party street address 2

guarantors[].third_party.address.zip_code

class java.lang.String

Third party address zip code

guarantors[].third_party.group

class java.lang.String

Third Party group

guarantors[].third_party.lei

class java.lang.String

Legal entity identifier

guarantors[].third_party.origin

Varies

Third Party origin

guarantors[].third_party._links

Varies

Links to other resources

guarantors[].third_party._links.self

Varies

Link to this Third Party resource

guarantors[].third_party._links.group

class java.lang.String

Link to the group of this third party resource

Removing a list of guarantors

A DELETE request will remove guarantors to an organization.

Curl request

$ curl 'https://apigw.financeactive.eu/api/referential/v3/ACNT1/organizations/1/guarantors?entity_id=12&entity_id=123&third_party_id=2' -i -X DELETE

Path parameters

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

account_code

Account Code or ID

organization_id

Organization ID

Request parameters

Parameter Description

entity_id

Entity ID. O. Can be added several times.

third_party_id

Third Party ID. Mandatory. Can be added several times.

HTTP request

DELETE /api/referential/v3/ACNT1/organizations/1/guarantors?entity_id=12&entity_id=123&third_party_id=2 HTTP/1.1
Host: apigw.financeactive.eu

HTTP response

HTTP/1.1 206 Partial Content
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: 134

{
  "total" : 3,
  "success" : 2,
  "failed" : 1,
  "errors" : [ {
    "object_id" : "12",
    "message" : "An error occurred"
  } ]
}

Response fields

Path Type Description

total

Number

Total batch actions

success

Number

Number of batch actions in success

failed

Number

Number of batch actions in error

errors[]

Array

Batch process errors

errors[].object_id

Long

Object ID concerned by the error

errors[].message

String

Error message

errors[].description

String

Error description

Contributions

Listing the contributions of a user

A GET request will list all the contributions for the user parameterized in the path parameters.

Curl request

$ curl 'https://apigw.financeactive.eu/api/referential/v3/users/a16d6437-7be1-45ae-b631-dd9b0471094d/contributions?page=0&size=20' -i -X GET

Path parameters

Table 1. /api/referential/v3/users/{user_uuid}/contributions
Parameter Description

user_uuid

User UUID

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/v3/users/a16d6437-7be1-45ae-b631-dd9b0471094d/contributions?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: 1434

{
  "_embedded" : {
    "contributions" : [ {
      "account_id" : "234567891",
      "organization_id" : "1234",
      "is_admin" : false,
      "_links" : {
        "self" : {
          "href" : "https://apigw.financeactive.eu/api/referential/v3/users/a16d6437-7be1-45ae-b631-dd9b0471094d/contributions/1234"
        },
        "account" : {
          "href" : "https://apigw.financeactive.eu/api/referential/v3/accounts/234567891"
        },
        "organization" : {
          "href" : "https://apigw.financeactive.eu/api/referential/v3/234567891/organizations/1234"
        }
      }
    }, {
      "account_id" : "234567891",
      "organization_id" : "123",
      "is_admin" : false,
      "_links" : {
        "self" : {
          "href" : "https://apigw.financeactive.eu/api/referential/v3/users/a16d6437-7be1-45ae-b631-dd9b0471094d/contributions/123"
        },
        "account" : {
          "href" : "https://apigw.financeactive.eu/api/referential/v3/accounts/234567891"
        },
        "organization" : {
          "href" : "https://apigw.financeactive.eu/api/referential/v3/234567891/organizations/123"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://apigw.financeactive.eu/api/referential/v3/users/a16d6437-7be1-45ae-b631-dd9b0471094d/contributions?page=0&size=20"
    }
  },
  "page" : {
    "size" : 20,
    "total_elements" : 2,
    "total_pages" : 1,
    "number" : 0
  }
}

Response fields

Path Type Description

_embedded.contributions[].account_id

String

Account ID

_embedded.contributions[].organization_id

String

Organization ID

_embedded.contributions[].is_admin

Boolean

Administrator Status

_embedded.contributions[]._links

Object

Links to other resources

_embedded.contributions[]._links.self

Object

Link to this contribution resource

_embedded.contributions[]._links.organization

Object

Link to the organization

_embedded.contributions[]._links.account

Object

Link to the 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 Contribution list

Retrieving a contribution

Curl request

$ curl 'https://apigw.financeactive.eu/api/referential/v3/users/a16d6437-7be1-45ae-b631-dd9b0471094d/contributions/123' -i -X GET

Path parameters

Table 1. /api/referential/v3/users/{user_uuid}/contributions/{contribution_id}
Parameter Description

user_uuid

User UUID

contribution_id

Organization ID

HTTP request

GET /api/referential/v3/users/a16d6437-7be1-45ae-b631-dd9b0471094d/contributions/123 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: 488

{
  "account_id" : "234567891",
  "organization_id" : "123",
  "is_admin" : false,
  "_links" : {
    "self" : {
      "href" : "https://apigw.financeactive.eu/api/referential/v3/users/a16d6437-7be1-45ae-b631-dd9b0471094d/contributions/123"
    },
    "account" : {
      "href" : "https://apigw.financeactive.eu/api/referential/v3/accounts/234567891"
    },
    "organization" : {
      "href" : "https://apigw.financeactive.eu/api/referential/v3/234567891/organizations/123"
    }
  }
}

Response fields

Path Type Description

account_id

String

Account ID

organization_id

String

Organization ID

is_admin

Boolean

Administrator Status

_links

Object

Links to other resources

_links.self

Object

Link to this contribution resource

_links.organization

Object

Link to the organization

_links.account

Object

Link to the account

Relation Description

self

Link to this Contribution resource

organization

Link to the organization

account

Link to the account

Adding a list of contributions

A POST request will add one or more contributions parameterized in the request body.

Curl request

$ curl 'https://apigw.financeactive.eu/api/referential/v3/users/a16d6437-7be1-45ae-b631-dd9b0471094d/contributions' -i -X POST \
    -H 'Content-Type: application/hal+json;charset=UTF-8' \
    -d '[
  {
    "organization_id":"123",
    "is_admin": false
  }
]
'

Path parameters

Table 1. /api/referential/v3/users/{user_uuid}/contributions
Parameter Description

user_uuid

User UUID

Request body

[
  {
    "organization_id":"123",
    "is_admin": false
  }
]

Request fields

Path Type Description

[].organization_id

String

Organization ID. Mandatory

[].is_admin

Boolean

is User is admin. Optional

HTTP request

POST /api/referential/v3/users/a16d6437-7be1-45ae-b631-dd9b0471094d/contributions HTTP/1.1
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 63
Host: apigw.financeactive.eu

[
  {
    "organization_id":"123",
    "is_admin": false
  }
]

HTTP response

HTTP/1.1 201 Created
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: 612

{
  "total" : 1,
  "success" : 1,
  "failed" : 0,
  "errors" : [ ],
  "contributions" : [ {
    "account_id" : "234567891",
    "organization_id" : "123",
    "is_admin" : false,
    "_links" : {
      "self" : {
        "href" : "https://apigw.financeactive.eu/api/referential/v3/users/a16d6437-7be1-45ae-b631-dd9b0471094d/contributions/123"
      },
      "account" : {
        "href" : "https://apigw.financeactive.eu/api/referential/v3/accounts/234567891"
      },
      "organization" : {
        "href" : "https://apigw.financeactive.eu/api/referential/v3/234567891/organizations/123"
      }
    }
  } ]
}

Response fields

Path Type Description

total

Number

Total batch actions

success

Number

Number of batch actions in success

failed

Number

Number of batch actions in error

errors[]

Array

Batch process errors

errors[].contribution

Object

Contribution in error

errors[].message

String

Error message

errors[].description

String

Error description

contributions

Array

created contributions

contributions[].account_id

String

Account ID

contributions[].organization_id

String

Organization ID

contributions[].is_admin

Boolean

Administrator Status

contributions[]._links

Object

Links to other resources

contributions[]._links.self

Object

Link to this contribution resource

contributions[]._links.organization

Object

Link to the organization

contributions[]._links.account

Object

Link to the account

Updating a list of contributions

A PUT request will update one or more contributions parameterized in the request body.

Curl request

$ curl 'https://apigw.financeactive.eu/api/referential/v3/users/a16d6437-7be1-45ae-b631-dd9b0471094d/contributions' -i -X PUT \
    -H 'Content-Type: application/hal+json;charset=UTF-8' \
    -d '[
  {
    "organization_id":"123",
    "is_admin": false
  }
]
'

Path parameters

Table 1. /api/referential/v3/users/{user_uuid}/contributions
Parameter Description

user_uuid

User UUID

Request body

[
  {
    "organization_id":"123",
    "is_admin": false
  }
]

Request fields

Path Type Description

[].organization_id

String

Organization ID. Mandatory

[].is_admin

Boolean

is User is admin. Optional

HTTP request

PUT /api/referential/v3/users/a16d6437-7be1-45ae-b631-dd9b0471094d/contributions HTTP/1.1
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 63
Host: apigw.financeactive.eu

[
  {
    "organization_id":"123",
    "is_admin": false
  }
]

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: 612

{
  "total" : 1,
  "success" : 1,
  "failed" : 0,
  "errors" : [ ],
  "contributions" : [ {
    "account_id" : "234567891",
    "organization_id" : "123",
    "is_admin" : false,
    "_links" : {
      "self" : {
        "href" : "https://apigw.financeactive.eu/api/referential/v3/users/a16d6437-7be1-45ae-b631-dd9b0471094d/contributions/123"
      },
      "account" : {
        "href" : "https://apigw.financeactive.eu/api/referential/v3/accounts/234567891"
      },
      "organization" : {
        "href" : "https://apigw.financeactive.eu/api/referential/v3/234567891/organizations/123"
      }
    }
  } ]
}

Response fields

Path Type Description

total

Number

Total batch actions

success

Number

Number of batch actions in success

failed

Number

Number of batch actions in error

errors[]

Array

Batch process errors

errors[].contribution

Object

Contribution in error

errors[].message

String

Error message

errors[].description

String

Error description

contributions

Array

created contributions

contributions[].account_id

String

Account ID

contributions[].organization_id

String

Organization ID

contributions[].is_admin

Boolean

Administrator Status

contributions[]._links

Object

Links to other resources

contributions[]._links.self

Object

Link to this contribution resource

contributions[]._links.organization

Object

Link to the organization

contributions[]._links.account

Object

Link to the account

Removing a contribution

A DELETE request will remove the contributions for the organization parameterized in the path parameters.

Curl request

$ curl 'https://apigw.financeactive.eu/api/referential/v3/users/a16d6437-7be1-45ae-b631-dd9b0471094d/contributions/123' -i -X DELETE

Path parameters

Table 1. /api/referential/v3/users/{user_uuid}/contributions/{contribution_id}
Parameter Description

user_uuid

User UUID

contribution_id

Organization ID

HTTP request

DELETE /api/referential/v3/users/a16d6437-7be1-45ae-b631-dd9b0471094d/contributions/123 HTTP/1.1
Host: apigw.financeactive.eu

HTTP response

HTTP/1.1 204 No Content
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
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

Response fields

Snippet response-fields not found for operation::referential-contributions-id-DELETE

Removing a list of contributions

A DELETE request will remove the contributions parameterized in the request parameters.

Curl request

$ curl 'https://apigw.financeactive.eu/api/referential/v3/users/a16d6437-7be1-45ae-b631-dd9b0471094d/contributions?contribution_id=1&contribution_id=2' -i -X DELETE

Path parameters

Table 1. /api/referential/v3/users/{user_uuid}/contributions
Parameter Description

user_uuid

User UUID

Request parameters

Parameter Description

contribution_id

Organization ID. Mandatory. Can be added several times.

HTTP request

DELETE /api/referential/v3/users/a16d6437-7be1-45ae-b631-dd9b0471094d/contributions?contribution_id=1&contribution_id=2 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: 68

{
  "total" : 2,
  "success" : 2,
  "failed" : 0,
  "errors" : [ ]
}

Response fields

Path Type Description

total

Number

Total batch actions

success

Number

Number of batch actions in success

failed

Number

Number of batch actions in error

errors[]

Array

Batch process errors

errors[].object_id

Long

errors[].message

String

Error message

errors[].description

String

Error description