| Índice |
|---|
| Dica |
|---|
Só são suportadas integrações no padrão REST. |
...
Endpoint | Método | Header Content-Type | Descrição | ||
|---|---|---|---|---|---|
/extratoCoparticipacao/extrato
| POST | application/json | Endpoint para listar os registros de coparticipação relacionadas ao localizador (chaveUnica) |
...
Está indicado abaixo a estrutura de retorno do método. Esse método deve obedecer as regras indicadas no objeto principal e em seus desdobramentos.
OBJETO PRINCIPAL
Objeto principal
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
observacao | OP | String | Informativo a ser exibido para o cliente sobre os dados apresentados a baixo. | Texto livre. |
dataInicioPeriodoApuracao | M | String | Data de inicio da apuração aplicada pelo webservice do cliente. | Formato: YYYY-MM-DD |
dataFimPeriodoApuracao | M | String | Data de fim da apuração aplicada pelo webservice do cliente. | Formato: YYYY-MM-DD |
extrato | M | Array de objetos do tipo “detalheExtrado" | Retornar um array de objetos “detalheExtrato“. |
|
OBJETO DETALHE EXTRATO
Objeto detalhe extrato
| Informações |
|---|
|
...
Está indicado abaixo a estrutura de retorno do método. Esse método deve obedecer as regras indicadas no objeto principal e em seus desdobramentos.
OBJETO PRINCIPAL
Objeto principal
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
mensagem | M | String | mensagem para ser exibida para o cliente | texto livre |
...