Ir para o conteúdo

Consolidar e Emitir um DARF

Baseado nos parâmetros de entrada fornecidos pelo chamador, o serviço:

• Monta uma chamada para a funcionalidade de consolidação (cálculo da multa e dos juros);

• É montada uma chamada ao sistema SENDA responsável pela geração dos DARF para gerar um documento baseado no resultado da consolidação;

• Devolve ao chamador:

a) O resultado do cálculo em uma propriedade de nome consolidado;

b) E devolve ao chamador a propriedade de nome darf, que deverá ter em seu conteúdo os dados do DARF gerado pelo sistema SENDA.

Identificação no Pedido de Dados

idSistema: SICALC
idServico: CONSOLIDARGERARDARF51
versaoSistema: "2.9"

Dados de Entrada

Objeto ct:

Campo Descrição Tipo Obrigatório
uf Unidade Federativa texto SIM
município Código do Município numérico SIM
codigoReceita Código da Receita numérico SIM
codigoReceitaExtensao Código da Extensão da Receita numérico SIM
numeroReferencia Número de referência utilizado no preenchimento do DARF numérico NÃO
tipoPA Tipo do período de apuração texto NÃO
dataPA Data do período de apuração texto SIM
vencimento Data de vencimento do tributo texto SIM
cota Número da cota (para os débitos que possuem cotas) numérico NÃO
valorImposto Valor do Imposto numérico SIM
valorMulta Valor da multa - Preenchido somente no caso de DARF manual numérico NÃO
valorJuros Valor dos juros - Preenchido somente no caso de DARF manual numérico NÃO
ganhoCapital Indicador de ganho de capital boolean NÃO
dataAlienacao Data da Alienação referente ao Ganho de Capital boolean NÃO
dataConsolidacao Data da Consolidação (Data do Pagamento) texto SIM
observacao Campo observação do DARF texto NÃO

Exemplo 1: DARF de Pessoa Física
conteúdo body json de entrada

{
    "contratante": {
        "numero": "99999999999999",
        "tipo": 2
    },
    "autorPedidoDados": {
        "numero": "99999999999",
        "tipo": 1
    },
    "contribuinte": {
        "numero": "99999999999",
        "tipo": 1
    },
    "pedidoDados": {
        "idSistema": "SICALC",
        "idServico": "CONSOLIDARGERARDARF51",
        "versaoSistema": "2.9",
        "dados": "{\"uf\": \"SP\", \"municipio\": \"7107\", \"codigoReceita\": \"0190\", \"codigoReceitaExtensao\": \"01\", \"tipoPA\": \"ME\", \"dataPA\": \"12/2017\", \"vencimento\": \"2018-01-31T00:00:00\", \"valorImposto\": \"1000.00\", \"dataConsolidacao\": \"2022-08-08T00:00:00\", \"observacao\": \"Darf calculado\"}"
    }
}

Exemplo 2: DARF de Pessoa Jurídica de um débito com cotas
conteúdo body json de entrada

 {
     "contratante":{
      "numero":"99999999999999",
      "tipo":2
     },
     "autorPedidoDados":{
      "numero":"99999999999999",
      "tipo":2
     },
     "contribuinte":{
      "numero":"99999999999999",
      "tipo":2
     },
     "pedidoDados":{
      "idSistema":"SICALC",
      "idServico":"CONSOLIDARGERARDARF51",
      "versaoSistema":"2.9",
      "dados":"{\"uf\": \"SP\", \"municipio\": \"7107\", \"codigoReceita\": \"0220\", \"codigoReceitaExtensao\": \"01\", \"tipoPA\": \"TR\", \"dataPA\": \"04/2021\", \"cota\": \"1\", \"valorImposto\": \"1000.00\", \"dataConsolidacao\": \"2022-08-08T00:00:00\", \"observacao\": \"Darf calculado\"}"
     }
 }

Exemplo 3: DARF de Pessoa Jurídica - com código de barras e com numeração - QRCODE
conteúdo body json de entrada

 {
    "contratante": {
        "numero": "99999999999999",
        "tipo": 2
    },
    "autorPedidoDados": {
        "numero": "99999999999999",
        "tipo": 2
    },
    "contribuinte": {
        "numero": "99999999999999",
        "tipo": 2
    },
    "pedidoDados": {
        "idSistema": "SICALC",
        "idServico": "CONSOLIDARGERARDARF51",
        "versaoSistema": "2.9",
        "dados": "{\"uf\": \"SP\", \"municipio\": \"7107\", \"codigoReceita\": \"1162\", \"codigoReceitaExtensao\": \"01\", \"tipoPA\": \"ME\", \"dataPA\": \"01/2022\", \"vencimento\": \"2022-02-18T00:00:00\", \"valorImposto\": \"1000.00\", \"dataConsolidacao\": \"2022-08-08T00:00:00\", \"observacao\": \"Darf calculado\"}"
    }
 }

Dados de Saída

A estrutura de dados retornada é a mesma nos casos de pesquisa por ano-calendário ou período de apuração. O que muda é a quantidade itens retornados.

Campo Descrição Tipo
status Status HTTP retornado no acionamento do serviço. Number(3)
mensagens Mensagem explicativa retornada no acionamento do serviço. É um array composto de Código e texto da mensagem. O campo Código é uma string de tamanho 5 que representa um código interno do negócio. Array of String
dados Estrutura de dados de retorno. String (SCAPED STRING JSON: XXXXXX)

No atributo dados, será retornado os seguintes objetos:

Objeto consolidado:

Campo Descrição Tipo
valorPrincipalMoedaCorrente Valor principal calculado texto
moeda Código da moeda de retorno numérico
dataValidadeCalculo Data em que o resultado de calculo é válido texto
dataArrecadacaoConsolidacao Data de Arrecadação/Consolidação considerada no resultado de cálculo texto
dataVencimentoDebito Data de Vencimento do Débito considerado no cálculo dos acréscimos legais texto
dataVencimentoCota Data de Vencimento da Cota considerado no cálculo dos acréscimos legais texto
valorMultaMora Valor de multa de mora calculada texto
percentualMultaMora Percentual de multa de mora calculada numérico
valorJuros Valor de juros calculada texto
termoInicialJuros Data no qual começa a incidência de juros no débito texto
percentualJuros Percentual de juros calculado numérico
valorTotalConsolidado Valor total do débito calculado texto

Objeto darf:

Campo Descrição Tipo
darf Conteúdo binário Base64 contendo o PDF a ser montado pelo sistema chamador. base64

conteúdo payload json de saída

Json de exemplo: DARF de Pessoa Física

Json de exemplo: DARF de Pessoa Jurídica de um débito com cotas

Json de exemplo: DARF de Pessoa Jurídica - com código de barras e com numeração - QRCODE