Índice
| Índice | ||||
|---|---|---|---|---|
|
Telas:
...
Descrição:
Retorna o resumo do demonstrativo de pagamento.
Regas de negócio
| Informações |
|---|
Considera que os dados necessários para identificação do cooperado são: chaveUnica e integração. Envie no objeto integração os dados que você precisa para reconhecer o seu cooperado, esse conjunto de dados: chaveUnica + integração serão enviados em todas as requisições para seu sistema. |
| Dica |
|---|
Só são suportadas integrações no padrão REST. |
| Nota |
|---|
OrientaçõesParâmetros de entradaSerão enviados no HEADER os headers estáticos definidos ao configurar a integração, combinado com os tokens retornados pela configuração de autorização da integração (caso seja vinculada) e os headers de segurança retornado no login do beneficiário. |
| Dica |
|---|
Só são suportadas integrações no padrão REST. |
| Nota |
|---|
OrientaçõesParâmetros de entradaSerão enviados no HEADER os headers estáticos definidos ao configurar a integração, combinado com os tokens retornados pela configuração de autorização da integração (caso seja vinculada) e os headers de segurança retornado no login do beneficiário. |
Critérios de preenchimento
...
| Nota |
|---|
Os atributos devem seguir exatamente os mesmos nomes indicados nesta documentação, caso contrário, serão rejeitados pelo validador de integração. Exemplo do atributo “contratos”:
|
Método de detalheDebito
| Dica |
|---|
|
...
Endpoint | Método | Header Content-Type | Descrição |
|---|---|---|---|
http://exemplo.com/ demonstrativoPagamento/resumo | POST | application/json | Retorna os dados básicos do demonstrativo de pagamento referente ao período selecionado |
Parâmetros de entrada
Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
chavePagamento | M | String | Chave de identificação do período selecionado. Essa informação é retornada pelo método listaPeriodo. |
chaveUnica | M | String | Chave de identificação do usuário retornada no login |
integracao | OP | Objeto | Nó integração retornado no login do usuário |
...