Get Position By Id

GET /customers/{id}/position

Path parameters

  • id string(uuid) Required

Query parameters

  • date string(date-time) Required

Responses

  • 200
    Hide response attribute Show response attribute object
    • position object Required
      Hide position attributes Show position attributes object
      • grossTotal number Required
      • netTotal number Required
      • grossTotalFunds number Required
      • grossTotalFixedIncome number Required
      • netTotalFunds number Required
      • netTotalFixedIncome number Required
      • funds object Required
        Hide funds attributes Show funds attributes object
        • label string Required
        • grossTotal number Required
        • netTotal string Required
        • percentage string Required
        • positions array[object] Required
          Hide positions attributes Show positions attributes array[object]
          • id number Required
          • type string Required
          • name string Required
          • value string Required
          • initialDate string Required
          • grossValue number Required
          • netValue number Required
          • positionDate string Required
          • irvalue number Required
          • iofvalue number Required
          • sharesNumber number Required
          • shareValue number Required
          • shareDate string Required
          • shareType string Required
          • productId number Required
          • certificatesIds string Required
          • contractId string Required
      • fixedIncome object Required
        Hide fixedIncome attributes Show fixedIncome attributes object
        • label string Required
        • grossTotal number Required
        • netTotal string Required
        • percentage string Required
        • positions array[object] Required
          Hide positions attributes Show positions attributes array[object]
          • id number Required
          • type string Required
          • name string Required
          • value string Required
          • initialDate string Required
          • grossValue number Required
          • netValue number Required
          • positionDate string Required
          • irvalue number Required
          • iofvalue number Required
          • sharesNumber number Required
          • shareValue number Required
          • shareDate string Required
          • shareType string Required
          • productId number Required
          • certificatesIds string Required
          • contractId string Required
      • td object Required
        Hide td attributes Show td attributes object
        • label string Required
        • grossTotal number Required
        • netTotal string Required
        • percentage string Required
  • 400
    Hide response attributes Show response attributes object
    • message object Required
    • data object Required
  • 401
    Hide response attributes Show response attributes object
    • message object Required
    • data object Required
GET /customers/{id}/position
curl \
 -X GET https://open-api.hml.soupi.com.br/customers/{id}/position?date=2023-05-04T09%3A42%3A00%2B00%3A00 \
 -H "Authorization: $API_KEY"
Response examples (200)
{
  "position": {
    "grossTotal": 42.0,
    "netTotal": 42.0,
    "grossTotalFunds": 42.0,
    "grossTotalFixedIncome": 42.0,
    "netTotalFunds": 42.0,
    "netTotalFixedIncome": 42.0,
    "funds": {
      "label": "string",
      "grossTotal": 42.0,
      "netTotal": "string",
      "percentage": "string",
      "positions": [
        {
          "id": 42.0,
          "type": "string",
          "name": "string",
          "value": "string",
          "initialDate": "string",
          "grossValue": 42.0,
          "netValue": 42.0,
          "positionDate": "string",
          "irvalue": 42.0,
          "iofvalue": 42.0,
          "sharesNumber": 42.0,
          "shareValue": 42.0,
          "shareDate": "string",
          "shareType": "string",
          "productId": 42.0,
          "certificatesIds": "string",
          "contractId": "string"
        }
      ]
    },
    "fixedIncome": {
      "label": "string",
      "grossTotal": 42.0,
      "netTotal": "string",
      "percentage": "string",
      "positions": [
        {
          "id": 42.0,
          "type": "string",
          "name": "string",
          "value": "string",
          "initialDate": "string",
          "grossValue": 42.0,
          "netValue": 42.0,
          "positionDate": "string",
          "irvalue": 42.0,
          "iofvalue": 42.0,
          "sharesNumber": 42.0,
          "shareValue": 42.0,
          "shareDate": "string",
          "shareType": "string",
          "productId": 42.0,
          "certificatesIds": "string",
          "contractId": "string"
        }
      ]
    },
    "td": {
      "label": "string",
      "grossTotal": 42.0,
      "netTotal": "string",
      "percentage": "string",
      "": [
        []
      ]
    }
  }
}
Response examples (200)
{
  "position": {
    "grossTotal": 42.0,
    "netTotal": 42.0,
    "grossTotalFunds": 42.0,
    "grossTotalFixedIncome": 42.0,
    "netTotalFunds": 42.0,
    "netTotalFixedIncome": 42.0,
    "funds": {
      "label": "string",
      "grossTotal": 42.0,
      "netTotal": "string",
      "percentage": "string",
      "positions": [
        {
          "id": 42.0,
          "type": "string",
          "name": "string",
          "value": "string",
          "initialDate": "string",
          "grossValue": 42.0,
          "netValue": 42.0,
          "positionDate": "string",
          "irvalue": 42.0,
          "iofvalue": 42.0,
          "sharesNumber": 42.0,
          "shareValue": 42.0,
          "shareDate": "string",
          "shareType": "string",
          "productId": 42.0,
          "certificatesIds": "string",
          "contractId": "string"
        }
      ]
    },
    "fixedIncome": {
      "label": "string",
      "grossTotal": 42.0,
      "netTotal": "string",
      "percentage": "string",
      "positions": [
        {
          "id": 42.0,
          "type": "string",
          "name": "string",
          "value": "string",
          "initialDate": "string",
          "grossValue": 42.0,
          "netValue": 42.0,
          "positionDate": "string",
          "irvalue": 42.0,
          "iofvalue": 42.0,
          "sharesNumber": 42.0,
          "shareValue": 42.0,
          "shareDate": "string",
          "shareType": "string",
          "productId": 42.0,
          "certificatesIds": "string",
          "contractId": "string"
        }
      ]
    },
    "td": {
      "label": "string",
      "grossTotal": 42.0,
      "netTotal": "string",
      "percentage": "string",
      "": [
        []
      ]
    }
  }
}
Response examples (400)
{
  "message": {},
  "data": {}
}
Response examples (400)
{
  "message": {},
  "data": {}
}
Response examples (401)
{
  "message": {},
  "data": {}
}
Response examples (401)
{
  "message": {},
  "data": {}
}