Pular para o conteúdo principal

PL/Cota - v1.1.0

Cadastro de solicitação de Informes em Lote​

POST <hub-anbima>:/v1/informes-diarios/solicitacoes

Tipo de rota: Síncrona

Para acessar os tipos e formatos dos campos, consultar a lista de campos de PL/Cota.

Método utilizado para criar uma solicitação de registro de informes diários de PL/COTA. Por se tratar de uma solicitação, ela passará por uma série de validações assincronamente. Dessa forma você poderá acompanhar a sua solicitação nesse endpoint.

Authorization: Bearer {access_token}

Body​

[
  {
    "codigo_classe_subclasse": string, 
    "data_competencia": date(YYYY-MM-DD),
    "valor_cota": number,
    "patrimonio_liquido": number,
    "volume_total_aplicacoes": number,
    "volume_total_resgates": number,
    "volume_total_resgate_ir": number,
    "numero_cotistas": number    
  }
]

Response​

Status code Ok - 201

  {
    "data": {
        "numero_solicitacao": string,
    "solicitacao_status": string,
    "informes":[
      {
        "numero_registro":string,
        "informe_status": string        
      }
    ]           
    },
    "message": string,
    "type": string
}

Error​

Status code Error - 400

{
    "data": null,
    "message": string,
    "type": string
}

Acompanhamento de solicitação de Informes​

GET <hub-anbima>:/v1/informes-diarios/solicitacoes/{numero_solicitacao}

Tipo de rota: Síncrona

Para acessar os tipos e formatos dos campos, consultar a lista de campos de PL/Cota.

Endpoint utilizado para recuperar todos os informes e status da solicitação enviada como parâmetro.

Header​

Authorization: Bearer {access_token}

Parâmetros​

numero_solicitacao: string

Response​

Status Ok - 200

{
    data: {
        numero_solicitacao: string,
        solicitacao_status: string,
        data_criacao: date(YYYY-MM-DD),
        data_ultima_atualizacao: date(YYYY-MM-DD),
        lista_informes:[
      {
        codigo_classe_subclasse: string,   
        data_competencia: date(YYYY-MM-DD),            
        valor_cota: number,
        patrimonio_liquido: number,
        volume_total_aplicacoes: number,
        volume_total_resgates: number,
        volume_total_resgate_ir: number,
        numero_cotistas: number,
        numero_registro: string,
        informe_status: string,                
        data_criacao: date(YYYY-MM-DD),
        data_ultima_atualizacao: date(YYYY-MM-DD),
        justificativa: string,        
        inconsistencias: string[]?
      }
    ],
    },
    message: string,
    type: string
}

Error​

Status Error - 400 

{
    data: null,
    message: "string",
    type: "string"
}

Acompanhamento de um Informe​

GET <hub-anbima>:/v1/informes-diarios/solicitacoes/{numero_solicitacao}/informes/{numero_registro}

Tipo de rota: Síncrona

Para acessar os tipos e formatos dos campos, consultar a lista de campos de PL/Cota.

Header​

Authorization: Bearer {access_token}

Parâmetros​

numero_solicitacao: string
numero_registro: string

Response​

Status Code Ok - 200 

{
    data: {
    codigo_classe_subclasse: string,    
    data_competencia: date(YYYY-MM-DD),    
    valor_cota: number,
    patrimonio_liquido: number,
    volume_total_aplicacoes: number,
    volume_total_resgates: number,
    volume_total_resgate_ir: number,
    numero_cotistas: number,    
    numero_registro: string,
    informe_status: string,
    data_criacao: date(YYYY-MM-DD),
    data_ultima_atualizacao: date(YYYY-MM-DD),
    justificativa: string,
    inconsistencias: string[]?
  },
    message: string,
    type: string,
}

Error​

Status Code Error - 400

{
    data: null,
    message: string,
    type: string
}

Correção de um único Informe​

PATCH <hub-anbima>:/v1/informes-diarios/solicitacoes/{numero_solicitacao}/informes/{numero_registro}

Tipo de rota: Síncrona

Para acessar os tipos e formatos dos campos, consultar a lista de campos de PL/Cota.

Header​

Authorization: Bearer {access_token}

Parâmetros​

numero_solicitacao: string
numero_registro: string

Body​

{
  codigo_classe_subclasse: string,
  data_competencia: date(YYYY-MM-DD),  
  valor_cota: number,
  patrimonio_liquido: number,
  volume_total_aplicacoes: number,
  volume_total_resgates: number,
  volume_total_resgate_ir: number,
  numero_cotistas: number,
}

Response​

Status Code Ok - 200

{
    data: {
    codigo_classe_subclasse: string, 
    data_competencia: date(YYYY-MM-DD),       
    valor_cota: number,
    patrimonio_liquido: number,
    volume_total_aplicacoes: number,
    volume_total_resgates: number,
    volume_total_resgate_ir: number,
    numero_cotistas: number,
    numero_registro: string,
    informe_status: string,
    data_criacao: date(YYYY-MM-DD),
    data_ultima_atualizacao: date(YYYY-MM-DD),
    justificativa: string,
    inconsistencias: string[]?
  },
    message: string,
    type: string,
}

Error​

Status Code Error - 400

{
    data: null,
    message: string,
    type: string
}