Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-2498321298.8 KB
Investments

Get portfolio

Get portfolio.

get/financial-data/v2beta/portfolios/{id}

Path parameters

idstring required

Atlar resource ID.

Response

An portfolio.

idstring required

Unique resource identifier.

organizationIdstring required

Unique resource identifier for an Organization.

entityIdstring required

Unique resource identifier.

affiliationIdstring required

Unique resource identifier.

thirdPartyIdstring required

Unique resource identifier.

aliasstring

Alias of the portfolio.

createdstring date-time required

Time at which the resource was created.

updatedstring date-time required

Time at which the resource was last updated.

versioninteger required

Resource version. Starts at value 1 when the resource is created and increases by one for each successive update.

metadataMetadata nullable

Metadata is a string-string key-value container that can be used to store information known at the time of resource creation. This can be retrieved later on, for instance when a payment or expected transaction is reconciled with the booked transaction on the bank statement.

Metadata can have at most 20 entries. Keys may have a maximum length of 64 chars and values a maximum length of 512 chars.

By default, this field is optional. It is possible to make it required in the Atlar Dashboard by visiting the Metadata keys page. Requirement rules can be specified per API resource. Both the Dashboard and the API will then enforce these rules and give validation errors when the required fields are not set.

etagstring required

ETag based on the resource version. This can be passed along in If-Match HTTP header when updating a resource to perform a conditional update.

Example response

{
  "id": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
  "organizationId": "0160f6ab-5741-49e1-af46-9138927e547e",
  "entityId": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
  "affiliationId": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
  "thirdPartyId": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
  "alias": "My Portfolio",
  "created": "2022-05-04T18:31:12.889104898Z",
  "updated": "2022-05-04T18:47:32.213842599Z",
  "version": 1,
  "metadata": {
    "my_metadata_key": "2a9a79b9-601c-449b-aa05-432f41dbbc4a"
  },
  "etag": "version:3"
}