Reporting Structure

Data Model

Reporting Entity

• name (string): Display name of the reporting entity.

Relationships

• client: Client that owns the reporting entity.
• portfolios: Portfolios associated with a reporting entity.

Portfolio

• name (string, required): Display name of the portfolio.

Relationships

• accounts: Accounts in the portfolio.
• depositories: Depositories in the portfolio.
• reportingEntity: Reporting entity that the portfolio is associated with.

Endpoints

GET /clients/:id/reporting-entities

Find all reporting entities owned by the client given by id.

Parameters

• id (path, required): Client identifier, see GET /clients.

Examples

200 OK

# Request
GET /api/v2/clients/6698d912deb64c8b2fec2c08/reporting-entities HTTP/1.1
Accept: application/vnd.json+api
Authorization: Bearer <access token>
Host: platform.aleta.io


# Response
HTTP/1.1 200 OK
Content-Type: application/vnd.json+api

{
  "data": [
    {
      "id": "cb4b00eef0af406faddc82ae",
      "type": "reporting-entity",
      "attributes": {
        "name": "Reporting Entity 1"
      },
      "relationships": {
        "client": {
          "data": {
            "type": "client",
            "id": "6698d912deb64c8b2fec2c08"
          }
        }
      }
    },
    {
      "id": "51c10fb37fcada1fbda0eccf",
      "type": "reporting-entity",
      "attributes": {
        "name": "Reporting Entity 2"
      },
      "relationships": {
        "client": {
          "data": {
            "type": "client",
            "id": "6698d912deb64c8b2fec2c08"
          }
        }
      }
    },
    {
      "id": "eda70f1de75270ec9009dfde",
      "type": "reporting-entity",
      "attributes": {
        "name": "Reporting Entity 3"
      },
      "relationships": {
        "client": {
          "data": {
            "type": "client",
            "id": "6698d912deb64c8b2fec2c08"
          }
        }
      }
    }
  ]
}

POST /clients/:id/reporting-entities

Create a reporting entity owned by the client given by id.

Parameters

• id (path, required): Client identifier, see GET /clients.

Examples

201 Created

# Request
POST /api/v2/clients/6698d912deb64c8b2fec2c08/reporting-entities HTTP/1.1
Accept: application/vnd.json+api
Authorization: Bearer <access token>
Content-Type: application/vnd.json+api
Host: platform.aleta.io

{
  "data": {
    "type": "reporting-entity",
    "attributes": {
      "name": "New reporting entity"
    }
  }
}


# Response
HTTP/1.1 201 Created
Content-Type: application/vnd.json+api

{
  "data": {
    "id": "66991be2f9bcbf6057b65qa8",
    "type": "reporting-entity",
    "attributes": {
      "name": "New reporting entity"
    },
    "relationships": {
      "client": {
        "data": {
          "type": "client",
          "id": "6698d912deb64c8b2fec2c08"
        }
      }
    }
  }
}

GET /reporting-entities/:id

Find the reporting entity given by id.

Parameters

• id (path, required): Reporting entity identifier, see GET /clients/:id/reporting-entities.

Examples

200 OK

# Request
GET /api/v2/reporting-entities/666bec24167e19c23eb786d6 HTTP/1.1
Accept: application/vnd.json+api
Authorization: Bearer <access token>
Host: platform.aleta.io


# Response
HTTP/1.1 200 OK
Content-Type: application/vnd.json+api

{
  "data": {
    "id": "666bec24167e19c23eb786d6",
    "type": "reporting-entity",
    "attributes": {
      "name": "Reporting entity 1"
    },
    "relationships": {
      "client": {
        "data": {
          "type": "client",
          "id": "9d328abedbe8c8afabeffc69"
        }
      },
      "portfolios": {
        "data": [
          {
            "type": "portfolio",
            "id": "6699ee6d6bce2a04b34a8868"
          },
          {
            "type": "portfolio",
            "id": "6699ee7a8840a05de41743de"
          }
        ]
      }
    }
  }
}

DELETE /reporting-entities/:id

Delete the reporting entity given by id.

Parameters

• id (path, required): Reporting entity identifier, see GET /clients/:id/reporting-entities.

Examples

204 No Content

# Request
DELETE /api/v2/reporting-entities/dcdcbb6e5cfdca7dd597ac3a HTTP/1.1
Accept: application/vnd.json+api
Authorization: Bearer <access token>
Host: platform.aleta.io


# Response
HTTP/1.1 204 No Content
Content-Type: application/vnd.api+json

PATCH /reporting-entities/:id

Update the reporting entity given by id.

Parameters

• id (path, required): Reporting entity identifier, see GET /clients/:id/reporting-entities.

Examples

204 No Content

# Request
PATCH /api/v2/reporting-entities/666bec24167e19c23eb786d6 HTTP/1.1
Accept: application/vnd.json+api
Authorization: Bearer <access token>
Host: platform.aleta.io

{
  "data": {
    "id": "666bec24167e19c23eb786d6",
    "type": "reporting-entity",
    "attributes": {
      "name": "Reporting entity 1"
    }
  }
}


# Response
HTTP/1.1 204 No Content
Content-Type: application/vnd.json+api

GET /reporting-entities/:id/portfolios

Get portfolio information for all portfolios associated with the reporting entity given by id.

Parameters

• id (path, required): Reporting entity identifier, see GET /clients/:id/reporting-entities.

Examples

200 OK

# Request
GET /api/v2/reporting-entities/666bec24167e19c23eb786d6 HTTP/1.1
Accept: application/vnd.json+api
Authorization: Bearer <access token>
Host: platform.aleta.io


# Response
HTTP/1.1 200 OK
Content-Type: application/vnd.json+api

{
  "data": [
    {
      "id": "6699ee6d6bce2a04b34a8868",
      "type": "portfolio",
      "attributes": {
        "name": "Portfolio 1"
      },
      "relationships": {
        "accounts": {
          "data": [
            {
              "type": "account",
              "id": "6699ec9eed2e23e9f214ba6f"
            },
            {
              "type": "account",
              "id": "6698de390fb223343ef3b648"
            },
            {
              "type": "account",
              "id": "6698de390fb223343ef3b649"
            }
          ]
        },
        "depositories": {
          "data": [
            {
              "type": "depository",
              "id": "6698debff36caf2dcef8d217"
            }
          ]
        },
        "reportingEntity": {
          "data": {
            "type": "reporting-entity",
            "id": "666bec24167e19c23eb786d6"
          }
        }
      }
    },
    {
      "id": "6699ee7a8840a05de41743de",
      "type": "portfolio",
      "attributes": {
        "name": "Portfolio 2"
      },
      "relationships": {
        "accounts": {
          "data": [
            {
              "type": "account",
              "id": "6699ec9eed2e23e9f214bp1o"
            },
            {
              "type": "account",
              "id": "6698de390fb223343ef3b917"
            }
          ]
        },
        "depositories": {
          "data": [
            {
              "type": "depository",
              "id": "6698debff36caf2dcef9g192"
            }
          ]
        },
        "reportingEntity": {
          "data": {
            "type": "reporting-entity",
            "id": "666bec24167e19c23eb786d6"
          }
        }
      }
    }
  ]
}

POST /reporting-entities/:id/portfolios

Create a portfolio associated with the reporting entity given by id.

Parameters

• id (path, required): Reporting entity identifier, see GET /clients/:id/reporting-entities.

Examples

201 Created

# Request
POST /api/v2/reporting-entities/666be3f97fc417debcea6a5e/portfolios HTTP/1.1
Accept: application/vnd.json+api
Authorization: Bearer <access token>
Host: platform.aleta.io


{
  "data": {
    "type": "portfolio",
    "attributes": {
      "name": "Portfolio 1"
    },
    "relationships": {
      "accounts": {
        "data": [
          {
            "type": "account",
            "id": "6699ec9eed2e23e9f214ba6f"
          }
        ]
      },
      "depositories": {
        "data": [
          {
            "type": "depository",
            "id": "6698debff36caf2dcef8d217"
          }
        ]
      }
    }
  }
}


# Response
HTTP/1.1 201 Created
Content-Type: application/vnd.json+api

{
  "data": {
    "id": "6699ed355c077cba345a8a2c",
    "type": "portfolio",
    "attributes": {
      "name": "Portfolio 1"
    },
    "relationships": {
      "accounts": {
        "data": [
          {
            "type": "account",
            "id": "6699ec9eed2e23e9f214ba6f"
          },
          {
            "type": "account",
            "id": "6698de390fb223343ef3b648"
          },
          {
            "type": "account",
            "id": "6698de390fb223343ef3b649"
          }
        ]
      },
      "depositories": {
        "data": [
          {
            "type": "depository",
            "id": "6698debff36caf2dcef8d217"
          }
        ]
      },
      "reportingEntity": {
        "data": {
          "type": "reporting-entity",
          "id": "666be3f97fc417debcea6a5e"
        }
      }
    }
  }
}

GET /portfolios/:id

Get portfolio information for the portfolio given by id.

Parameters

• id (path, required): Portfolio identifier, see GET /reporting-entities/:id/portfolios.

Examples

200 OK

# Request
GET /api/v2/portfolios/6699ee6d6bce2a04b34a8868 HTTP/1.1
Accept: application/vnd.json+api
Authorization: Bearer <access token>
Host: platform.aleta.io


# Response
HTTP/1.1 200 OK
Content-Type: application/vnd.json+api

{
  "data": {
    "id": "6699ee6d6bce2a04b34a8868",
    "type": "portfolio",
    "attributes": {
      "name": "Portfolio 1"
    },
    "relationships": {
      "accounts": {
        "data": [
          {
            "type": "account",
            "id": "6699ec9eed2e23e9f214ba6f"
          },
          {
            "type": "account",
            "id": "6698de390fb223343ef3b648"
          },
          {
            "type": "account",
            "id": "6698de390fb223343ef3b649"
          }
        ]
      },
      "depositories": {
        "data": [
          {
            "type": "depository",
            "id": "6698debff36caf2dcef8d217"
          }
        ]
      },
      "reportingEntity": {
        "data": {
          "type": "reporting-entity",
          "id": "666be3f97fc417debcea6a5e"
        }
      }
    }
  }
}

DELETE /portfolios/:id

Delete the portfolio given by id.

Parameters

• id (path, required): Portfolio identifier, see GET /reporting-entities/:id/portfolios.

Examples

204 No Content

# Request
DELETE /api/v2/portfolios/54e45acada7e9feebae2c5fd HTTP/1.1
Accept: application/vnd.json+api
Authorization: Bearer <access token>
Host: platform.aleta.io


# Response
HTTP/1.1 204 No Content
Content-Type: application/vnd.api+json

PATCH /portfolios/:id

Update the portfolio given by id.

Parameters

• id (path, required): Portfolio identifier, see GET /reporting-entities/:id/portfolios.

Examples

204 No Content

# Request
PATCH /api/v2/portfolios/6699ee6d6bce2a04b34a8868 HTTP/1.1
Accept: application/vnd.json+api
Authorization: Bearer <access token>
Host: platform.aleta.io

{
  "data": {
    "id": "6699ee6d6bce2a04b34a8868",
    "type": "portfolio",
    "attributes": {
      "name": "Portfolio 1"
    },
    "relationships": {
      "accounts": {
        "data": [
          {
            "type": "account",
            "id": "6699ec9eed2e23e9f214ba6f"
          },
          {
            "type": "account",
            "id": "6698de390fb223343ef3b648"
          },
          {
            "type": "account",
            "id": "6698de390fb223343ef3b649"
          }
        ]
      },
      "depositories": {
        "data": [
          {
            "type": "depository",
            "id": "6698debff36caf2dcef8d217"
          }
        ]
      },
      "reportingEntity": {
        "data": {
          "type": "reporting-entity",
          "id": "666be3f97fc417debcea6a5e"
        }
      }
    }
  }
}


# Response
HTTP/1.1 204 No Content
Content-Type: application/vnd.json+api