GET Api/Beneficiario/DemonstrativoCoparticipacao?PeriodoId={PeriodoId}

Este endpoint retorna o extrato de coparticipação do beneficiário de acordo com o periodo selecionado.

Request Information

URI Parameters

Name	Description	Type	Additional information
PeriodoId		string	None.

Body Parameters

None.

Response Information

Resource Description

DemonstrativoCoparticipacaoRetorno

Name	Type	Additional information
Data	Collection of DataDemonstrativoCoparticipacao	None.
Result	integer	None.
Message	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Data": [
    {
      "categoria": "sample string 1",
      "valor": 2.0,
      "valorFormatado": "sample string 3",
      "itens": [
        {
          "valor": 1.0,
          "valorFormatado": "sample string 2",
          "detalhes": [
            {
              "Titulo": "sample string 1",
              "Campo": "sample string 2"
            },
            {
              "Titulo": "sample string 1",
              "Campo": "sample string 2"
            }
          ]
        },
        {
          "valor": 1.0,
          "valorFormatado": "sample string 2",
          "detalhes": [
            {
              "Titulo": "sample string 1",
              "Campo": "sample string 2"
            },
            {
              "Titulo": "sample string 1",
              "Campo": "sample string 2"
            }
          ]
        }
      ]
    },
    {
      "categoria": "sample string 1",
      "valor": 2.0,
      "valorFormatado": "sample string 3",
      "itens": [
        {
          "valor": 1.0,
          "valorFormatado": "sample string 2",
          "detalhes": [
            {
              "Titulo": "sample string 1",
              "Campo": "sample string 2"
            },
            {
              "Titulo": "sample string 1",
              "Campo": "sample string 2"
            }
          ]
        },
        {
          "valor": 1.0,
          "valorFormatado": "sample string 2",
          "detalhes": [
            {
              "Titulo": "sample string 1",
              "Campo": "sample string 2"
            },
            {
              "Titulo": "sample string 1",
              "Campo": "sample string 2"
            }
          ]
        }
      ]
    }
  ],
  "Result": 1,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:

<DemonstrativoCoparticipacaoRetorno xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UniCuiaba.UniBrasil.Modelo.ModeloRetorno.Beneficiario">
  <Message>sample string 2</Message>
  <Result>1</Result>
  <Data>
    <DataDemonstrativoCoparticipacao>
      <categoria>sample string 1</categoria>
      <itens>
        <ItensDemonstrativoCoparticipacao>
          <detalhes>
            <DetalhesDemonstrativoCoparticipacao>
              <Campo>sample string 2</Campo>
              <Titulo>sample string 1</Titulo>
            </DetalhesDemonstrativoCoparticipacao>
            <DetalhesDemonstrativoCoparticipacao>
              <Campo>sample string 2</Campo>
              <Titulo>sample string 1</Titulo>
            </DetalhesDemonstrativoCoparticipacao>
          </detalhes>
          <valor>1</valor>
          <valorFormatado>sample string 2</valorFormatado>
        </ItensDemonstrativoCoparticipacao>
        <ItensDemonstrativoCoparticipacao>
          <detalhes>
            <DetalhesDemonstrativoCoparticipacao>
              <Campo>sample string 2</Campo>
              <Titulo>sample string 1</Titulo>
            </DetalhesDemonstrativoCoparticipacao>
            <DetalhesDemonstrativoCoparticipacao>
              <Campo>sample string 2</Campo>
              <Titulo>sample string 1</Titulo>
            </DetalhesDemonstrativoCoparticipacao>
          </detalhes>
          <valor>1</valor>
          <valorFormatado>sample string 2</valorFormatado>
        </ItensDemonstrativoCoparticipacao>
      </itens>
      <valor>2</valor>
      <valorFormatado>sample string 3</valorFormatado>
    </DataDemonstrativoCoparticipacao>
    <DataDemonstrativoCoparticipacao>
      <categoria>sample string 1</categoria>
      <itens>
        <ItensDemonstrativoCoparticipacao>
          <detalhes>
            <DetalhesDemonstrativoCoparticipacao>
              <Campo>sample string 2</Campo>
              <Titulo>sample string 1</Titulo>
            </DetalhesDemonstrativoCoparticipacao>
            <DetalhesDemonstrativoCoparticipacao>
              <Campo>sample string 2</Campo>
              <Titulo>sample string 1</Titulo>
            </DetalhesDemonstrativoCoparticipacao>
          </detalhes>
          <valor>1</valor>
          <valorFormatado>sample string 2</valorFormatado>
        </ItensDemonstrativoCoparticipacao>
        <ItensDemonstrativoCoparticipacao>
          <detalhes>
            <DetalhesDemonstrativoCoparticipacao>
              <Campo>sample string 2</Campo>
              <Titulo>sample string 1</Titulo>
            </DetalhesDemonstrativoCoparticipacao>
            <DetalhesDemonstrativoCoparticipacao>
              <Campo>sample string 2</Campo>
              <Titulo>sample string 1</Titulo>
            </DetalhesDemonstrativoCoparticipacao>
          </detalhes>
          <valor>1</valor>
          <valorFormatado>sample string 2</valorFormatado>
        </ItensDemonstrativoCoparticipacao>
      </itens>
      <valor>2</valor>
      <valorFormatado>sample string 3</valorFormatado>
    </DataDemonstrativoCoparticipacao>
  </Data>
</DemonstrativoCoparticipacaoRetorno>