Ir para o conteúdo

Atualizar Benefício

Este serviço permite que um

Identificação no Pedido de Dados

idSistema: PGMEI
idServico: ATUBENEFICIO23

Dados de Entrada

Objeto Dados:

Campo Descrição Tipo Obrigatório
anoCalendario Ano calendário no formato AAAA Número SIM
infoBeneficio Informação sobre o benefício Lista de Objeto Beneficio SIM

Objeto: Beneficio

Campo Descrição Tipo Obrigatório
periodoApuracao Período de apuração no formato AAAAMM Texto SIM
indicadorBeneficio Indica se houve benefício Booleano SIM

Exemplo: conteúdo body json de entrada

    {
        "contratante": {
            "numero": "00000000000101",
            "tipo": 2
        },
        "autorPedidoDados": {
            "numero": "00000000000101",
            "tipo": 2
        },
        "contribuinte": {
            "numero": "00000000000101",
            "tipo": 2
        },
        "pedidoDados": {
            "idSistema": "PGMEI",
            "idServico": "ATUBENEFICIO23",
            "versaoSistema": "1.0",
            "dados": "{\"anoCalendario\":2021,\"infoBeneficio\":[{\"periodoApuracao\":\"202101\",\"indicadorBeneficio\":true},{\"periodoApuracao\":\"202102\",\"indicadorBeneficio\":true}]}"
        }
    }

Dados de Saída

O retorno é a confirmação que os benefícios foram inseridos com sucesso.

Campo Descrição Tipo
status Status HTTP retornado no acionamento do serviço. Número(3)
mensagens Mensagem explicativa retornada no acionamento do serviço. É um array composto de Código e texto da mensagem. O campo Código é um Texto que representa um código interno do negócio. Lista de Texto
dados Estrutura de dados de retorno. Texto (SCAPED Texto JSON: Lista de Objeto AtualizarBeneficioIntegraMei

Objeto: AtualizarBeneficioIntegraMei

Campo Descrição Tipo
paOriginal Período de apuração original Texto
indicadorBeneficio Indica se há benefício no período Booleano
paAgrupado PA que possui os períodos agrupados para emissão de DAS. Formato AAAAMM Texto

Exemplo: conteúdo payload json de saída

Json de exemplo: retorno Atualizar Benefício