Earnings
Last updated May 7th, 2024
This resource represents the earnings of your connected customers in their investment accounts. Information such as the amount earned, the narration, the date this earning was made, asset name, the sale price, quantity sold, etc are all returned.
Response Object
Request
1234567891011121314151617181920212223242526272829303132
{
"status": "successful",
"message": "Request was succesfully completed",
"timestamp": "2024-03-15T15:09:13.581Z",
"data": [
{
"id": "65d766c4977d0",
"amount": 1071,
"narration": "Transfer to Wallet from Mrchemicalmusic plan",
"date": "2024-02-13T17:24:30.000Z",
"asset": {
"symbol": null,
"name": "Mrchemicalmusic",
"sale_price": null,
"quantity_sold": null
}
},
{
"id": "65d76676c4977d1",
"amount": 300,
"narration": "Transfer to Wallet from Tiv music plan plan",
"date": "2024-02-10T01:53:58.000Z",
"asset": {
"symbol": null,
"name": "Tiv music plan",
"sale_price": null,
"quantity_sold": null
}
},
]
}
Field Definitions
| Field | Description | Type |
| _id | The ID of the earning. | string |
| amount | The total amount of earning value. | integer |
| narration | The narration based on this earning. | string |
| date | The date this earning was received. | string |
| asset.symbol | The asset symbol for this earning. | string |
| assets.name | The asset name for this earning. | string |
| asset.sale_price | The sale price for this earning. | integer |
| asset.quantity_sold | The quantity sold for this earning. | integer |