Asset accrued
This event occurs when an asset accrues. The accrual process increments the unit_value
.
Type: object
Domain: assets
Event: asset_accrual
Version: 2
asset required
Title: Object representing the asset that accrued.
Type: objectid required
Title: Asset ID
Description: Unique asset identifier defined by client. This is part of the asset identifier on the Pismo platform. It can be used to make redemptions and cancellations.
Type: string
Example:
d0855c6b-b037-4dce-94c5-7a6ffc1800a3
issuer_id required
Title: Issuer ID
Description: Cetip code of registrator of asset. This is part of the asset identifier on the Pismo platform. It needs to be in every API call. An organization can have multiple issuer IDs.
Type: string
Example:
12345678
issued_units required
Title: Issued units
Description: Number of units asset can support. Whenregistration_mode
issingle
, this number should reflect the entire quota. Whenregistration_mode
ismany
, it should reflect the number of units available for purchase in the asset.
Type: number
Format: double
Example:
100.0
accrual_date required
Title: Accrual date
Description: Date asset accrues
Type: string
Format: date
Example:
2020-12-28
index_type required
Title: Index type
Description: Daily accrual calculations are based of on the index type. For example, "di" for DI rate or "pre" for prefixed rate.
Type: string
Must be one of the following:
di
pre
vpc
ipca
monthdi
index_rate
Title: Index rate
Description: How much asset accrues per day
Type: number
Format: double
Example:
1.0
daily_rate
Title: Daily rate
Description: The daily rate should reflect the price value of the index type.
Type: number
Format: double
Example:
1.0000754
accum_daily_rate
Title: Accumulated daily rate
Description: Accumulated daily rate since asset was created
Type: number
Format: double
Example:
1.0
unit_value required
Title: Unit value
Description: Current unit value of asset
Type: number
Format: double
Example:
3.12e-05
interest_rate
Title: Interest rate
Description: Interest rate used to calculate accruals
Type: number
Format: double
Example:
1.0
working_days
Title: Working days
Description: Number of days between issue of asset and accrual date. Used to obtain the calculation factor.
Type: integer
Example:
1
factor
Title: Factor
Description: Result of the accrual calculation based on asset's interest rate. Used to obtain unit value of asset.
Type: number
Format: double
Example:
1.0
updated_at required
Title: Updated date
Description: Date asset was last updated
Type: string
Format: date-time
Example:
2020-12-29T19:48:25
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"title": "Asset accrued",
"description": "This event occurs when an asset accrues. The accrual process increments the `unit_value`.",
"required": [
"asset",
"accrual_date",
"index_type",
"unit_value",
"updated_at"
],
"properties": {
"asset": {
"type": "object",
"title": "Object representing the asset that accrued.",
"required": [
"id",
"issuer_id",
"issued_units"
],
"properties": {
"id": {
"type": "string",
"title": "Asset ID",
"description": "Unique asset identifier defined by client. This is part of the asset identifier on the Pismo platform. It can be used to make redemptions and cancellations.",
"examples": [
"d0855c6b-b037-4dce-94c5-7a6ffc1800a3"
]
},
"issuer_id": {
"type": "string",
"title": "Issuer ID",
"description": "Cetip code of registrator of asset. This is part of the asset identifier on the Pismo platform. It needs to be in every API call. An organization can have multiple issuer IDs.",
"examples": [
"12345678"
]
},
"issued_units": {
"type": "number",
"title": "Issued units",
"description": "Number of units asset can support. When `registration_mode` is `single`, this number should reflect the entire quota. When `registration_mode` is `many`, it should reflect the number of units available for purchase in the asset.",
"format": "double",
"examples": [
100.0
]
}
}
},
"accrual_date": {
"type": "string",
"title": "Accrual date",
"format": "date",
"description": "Date asset accrues",
"examples": [
"2020-12-28"
]
},
"index_type": {
"type": "string",
"title": "Index type",
"description": "Daily accrual calculations are based of on the index type. For example, \"di\" for DI rate or \"pre\" for prefixed rate.",
"enum": [
"di",
"pre",
"vpc",
"ipca",
"monthdi"
]
},
"index_rate": {
"type": "number",
"title": "Index rate",
"description": "How much asset accrues per day",
"format": "double",
"examples": [
1.0
]
},
"daily_rate": {
"type": "number",
"title": "Daily rate",
"description": "The daily rate should reflect the price value of the index type.",
"format": "double",
"examples": [
1.0000754
]
},
"accum_daily_rate": {
"type": "number",
"title": "Accumulated daily rate",
"description": "Accumulated daily rate since asset was created",
"format": "double",
"examples": [
1.0
]
},
"unit_value": {
"type": "number",
"title": "Unit value",
"description": "Current unit value of asset",
"format": "double",
"examples": [
3.12e-05
]
},
"interest_rate": {
"type": "number",
"title": "Interest rate",
"description": "Interest rate used to calculate accruals",
"format": "double",
"examples": [
1.0
]
},
"working_days": {
"type": "integer",
"title": "Working days",
"description": "Number of days between issue of asset and accrual date. Used to obtain the calculation factor.",
"examples": [
1
]
},
"factor": {
"type": "number",
"title": "Factor",
"description": "Result of the accrual calculation based on asset's interest rate. Used to obtain unit value of asset.",
"format": "double",
"examples": [
1.0
]
},
"updated_at": {
"type": "string",
"title": "Updated date",
"description": "Date asset was last updated",
"format": "date-time",
"examples": [
"2020-12-29T19:48:25"
]
}
}
}
{
"asset": {
"id": "d0855c6b-b037-4dce-94c5-7a6ffc1800a3",
"issuer_id": "12345678",
"issued_units": 100.0
},
"accrual_date": "2020-12-28",
"index_type": "di",
"index_rate": 1.0,
"daily_rate": 1.0000754,
"accum_daily_rate": 1.0,
"unit_value": 3.12e-05,
"interest_rate": 1.0,
"working_days": 1,
"factor": 1.0,
"updated_at": "2020-12-29T19:48:25"
}
Updated 7 days ago