action wealthreader_post_entities {
  label: "Obtiene los activos financieros y el detalle de su composición"
  description: "Obtiene los activos financieros y el detalle de su composición de carteras de inversión compuestas por acciones o fondos, tarjetas de crédito, seguros y préstamos. Incluye información de titularidad de cada uno de los activos así como identificadores únicos que facilitan el tratamiento del dato. Es posible obtener datos Mock. Consulte con el equipo técnico cómo hacerlo.\n"
  provider: wealthreader
  method: POST
  path: "/entities"
  encoding: form
  output: {
    type: "array"
    items: {
      type: "object"
      required: ["success", "user_information", "statistics"]
      properties: {
        payload: {
          type: "object"
          properties: {
            accounts: {
              type: "array"
              description: "Cuentas bancarias. En cuentas europeas, solamente activado cuando el cliente de Wealth Reader cuenta con licencia PSD2"
              required: ["uuid", "code", "name", "currency", "owners", "balances", "transactions"]
              properties: {
                balances: {
                  type: "object"
                  properties: {
                    available: {
                      type: "number"
                    }
                    current: {
                      type: "number"
                    }
                  }
                }
                code: {
                  type: "string"
                  description: "Código IBAN sin espacios"
                }
                currency: {
                  type: "string"
                }
                name: {
                  type: "string"
                }
                owners: {
                  required: ["ID", "name", "role"]
                  properties: {
                    ID: {
                      type: "string"
                    }
                    name: {
                      type: "string"
                    }
                    role: {
                      type: "string"
                      enum: ["owner", "co-owner", "legal representative", "administrator", "attorney-in-fact", "authorised"]
                    }
                  }
                  items: {
                    type: "array"
                    items: {
                      type: "object"
                    }
                  }
                }
                transactions: {
                  type: "array"
                  items: {
                    type: "object"
                    properties: {
                      amount: {
                        type: "number"
                      }
                      balance: {
                        type: "number"
                      }
                      description: {
                        type: "string"
                      }
                      operation_date: {
                        type: "string"
                        format: "date"
                      }
                      uuid: {
                        type: "string"
                      }
                      value_date: {
                        type: "string"
                        format: "date"
                      }
                    }
                  }
                }
                uuid: {
                  type: "string"
                }
              }
              items: {
                type: "object"
              }
            }
            cards: {
              type: "array"
              description: "Tarjetas de crédito, débito y prepago"
              required: ["subtype", "uuid", "code", "name", "currency", "balances"]
              properties: {
                anual_interest: {
                  type: "number"
                }
                balances: {
                  type: "object"
                  properties: {
                    available: {
                      type: "number"
                    }
                    disposed: {
                      type: "number"
                    }
                    limit: {
                      type: "number"
                    }
                  }
                }
                code: {
                  type: "string"
                  description: "Numeración con ofuscación PCI compliance"
                }
                currency: {
                  type: "string"
                }
                linked_account: {
                  type: "string"
                }
                name: {
                  type: "string"
                }
                next_payment_date: {
                  type: "string"
                  format: "date"
                }
                owner: {
                  type: "object"
                  additionalProperties: true
                }
                status: {
                  type: "string"
                  enum: ["active", "inactive", "cancelled"]
                }
                subtype: {
                  type: "string"
                  enum: ["credit", "debit", "prepaid"]
                }
                tae: {
                  type: "number"
                }
                transactions: {
                  type: "array"
                  required: ["uuid", "value_date", "amount", "description"]
                  properties: {
                    amount: {
                      type: "number"
                    }
                    description: {
                      type: "string"
                    }
                    settled: {
                      type: "boolean"
                      description: "Indica si es un movimiento perteneciente a un extracto diferente del periodo de facturación actual"
                    }
                    uuid: {
                      type: "string"
                    }
                    value_date: {
                      type: "string"
                      format: "date"
                    }
                  }
                  items: {
                    type: "object"
                  }
                }
                uuid: {
                  type: "string"
                }
              }
              items: {
                type: "object"
              }
            }
            portfolios: {
              type: "array"
              description: "Carteras de acciones, fondos y planes de pensiones"
              required: ["subtype", "uuid", "code", "name", "currency", "total_value", "weighted_return", "annualized_volatility", "yield", "contributions", "withholdings", "contracting_date", "linked_account", "owners", "composition", "transactions"]
              properties: {
                annualized_volatility: {
                  type: "number"
                  description: "El valor será 0 cuando la entidad no lo proporcione"
                }
                code: {
                  type: "string"
                }
                composition: {
                  type: "array"
                  description: "Composición de la cartera"
                  properties: {
                    DGS: {
                      type: "string"
                      description: "Valor indicado siempre que la cartera sea subtype: pension-plans"
                    }
                    DGS_description: {
                      type: "string"
                      description: "Valor indicado siempre que la cartera sea subtype: pension-plans"
                    }
                    ISIN: {
                      type: "string"
                      description: "Valor indicado siempre que la cartera sea subtype: funds o stocks"
                    }
                    ISIN_description: {
                      type: "string"
                      description: "Valor indicado siempre que la cartera sea subtype: funds o stocks"
                    }
                    currency: {
                      type: "string"
                      description: "Divisa en codificación ISO 4217"
                    }
                    price: {
                      type: "number"
                      description: "Precio actual"
                    }
                    shares: {
                      type: "number"
                      description: "Participaciones"
                    }
                    total_amount: {
                      type: "number"
                      description: "Importe total"
                    }
                    weighting: {
                      type: "number"
                      description: "Peso con respecto al resto de la composición de la cartera"
                    }
                  }
                  items: {
                    type: "object"
                  }
                }
                contracting_date: {
                  type: "string"
                  format: "date"
                }
                contributions: {
                  type: "number"
                }
                currency: {
                  type: "string"
                }
                linked_account: {
                  type: "string"
                  description: "Código IBAN sin espacios. El valor será not-provided cuando la entidad no lo proporcione"
                }
                name: {
                  type: "string"
                }
                owners: {
                  type: "object"
                  additionalProperties: true
                }
                subtype: {
                  type: "string"
                  enum: ["funds", "stocks", "pension-plans"]
                }
                total_value: {
                  type: "number"
                }
                transactions: {
                  type: "array"
                  required: ["uuid", "value_date", "operation_type", "shares", "price", "total_amount", "reference_currency", "currency", "exchange_rate"]
                  properties: {
                    DGS: {
                      type: "string"
                      description: "Valor indicado siempre que la cartera sea subtype: pension-plans"
                    }
                    ISIN: {
                      type: "string"
                      description: "Valor indicado siempre que la cartera sea subtype: funds o stocks"
                    }
                    currency: {
                      type: "string"
                    }
                    exchange_rate: {
                      type: "number"
                    }
                    operation_date: {
                      type: "string"
                      format: "date"
                    }
                    operation_pending: {
                      type: "boolean"
                      description: "Indicado cuando subtype=stocks. Indica si la operación está pendiente o no de ejecutarse."
                    }
                    operation_type: {
                      type: "string"
                      enum: ["purchase", "sale", "subscription by transfer", "redemption by transfer"]
                    }
                    price: {
                      type: "number"
                    }
                    reference_currency: {
                      type: "string"
                    }
                    shares: {
                      type: "number"
                    }
                    total_amount: {
                      type: "number"
                    }
                    uuid: {
                      type: "string"
                      description: "Identificador único asignado por Wealth Reader"
                    }
                    value_date: {
                      type: "string"
                      format: "date"
                    }
                    value_time: {
                      type: "string"
                      format: "time"
                      description: "Indicado cuando subtype=stocks. La hora de ejecución de la operación."
                    }
                  }
                  items: {
                    type: "object"
                  }
                }
                uuid: {
                  type: "string"
                  description: "Identificador único asignado por Wealth Reader"
                }
                weighted_return: {
                  type: "number"
                }
                withholdings: {
                  type: "number"
                }
                yield: {
                  type: "number"
                }
              }
              items: {
                type: "object"
              }
            }
            properties: {
              type: "object"
              description: "Activos inmobiliarios"
              required: ["uuid", "code", "currency", "trading_price", "trading_year", "historic_prices"]
              properties: {
                code: {
                  type: "string"
                  description: "Referencia catastral"
                }
                currency: {
                  type: "string"
                }
                description: {
                  type: "string"
                }
                historic_prices: {
                  type: "array"
                  items: {
                    type: "object"
                    properties: {
                      date: {
                        type: "string"
                        format: "date"
                      }
                      price: {
                        type: "number"
                      }
                    }
                  }
                }
                purpose: {
                  type: "string"
                }
                trading_price: {
                  type: "number"
                }
                trading_year: {
                  type: "number"
                }
                uuid: {
                  type: "string"
                }
              }
            }
            user_information: {
              type: "object"
              description: "Información relativa a la persona que hace login"
              required: ["ID", "name"]
              properties: {
                ID: {
                  type: "string"
                }
                address: {
                  type: "string"
                }
                birth_date: {
                  type: "string"
                  format: "date"
                }
                birth_place: {
                  type: "string"
                }
                cell_phone: {
                  type: "string"
                  description: "Número de teléfono con el prefijo internacional, sin espacios"
                }
                city: {
                  type: "string"
                }
                country: {
                  type: "string"
                }
                email: {
                  type: "string"
                }
                gender: {
                  type: "string"
                  enum: ["male", "female"]
                }
                job: {
                  type: "string"
                  description: "El valor aquí es muy variable de una entidad a otra: de indicar solamente si es cuenta propia o cuenta ajena a indicar el tipo de profesión"
                }
                marital_status: {
                  type: "string"
                  enum: ["single", "married"]
                }
                name: {
                  type: "string"
                }
                postal_code: {
                  type: "string"
                }
              }
            }
          }
        }
        statistics: {
          type: "object"
          required: ["SESSION", "execution_time"]
          properties: {
            SESSION: {
              type: "string"
              description: "Guarda siempre este valor, tanto si la conexión es correcta como si no. Es necesario para obtener soporte"
            }
            execution_time: {
              type: "number"
              description: "Duración de la ejecución"
            }
            operation_id: {
              type: "string"
              description: "El valor vendrá indicado cuando se haya invocado a la API a través del Widget que proporciona Wealth Reader. Para saber más sobre este tipo de integración, visita: https://docs-es.wealthreader.com/"
            }
            token: {
              type: "string"
              description: "El valor vendrá indicado cuando se ha pedido la custodia de credenciales con la opción tokenize=true"
            }
          }
        }
        success: {
          type: "boolean"
        }
      }
    }
  }
}