Consultar Código Receita Sicalc
Baseado nos parâmetros de entrada fornecidos pelo chamador, o serviço:
• Monta uma chamada ao serviço que consulta a base do cadastro de receitas administradas pela Receita Federal do Brasil
• Devolve ao chamador um array de 3 ocorrências informando quais são os atributos obrigatórios, opcionais e informativos em relação ao serviço “Consolidar e emitir um DARF”
Identificação no Pedido de Dados
idSistema: SICALC
idServico: CONSULTAAPOIORECEITAS52
versão: 2.9
Dados de Entrada
Objeto dados:
Campo | Descrição | Tipo | Obrigatório |
---|---|---|---|
codigoReceita | Código da Receita | numérico | SIM |
Exemplo: conteúdo body json de entrada
{
"contratante":{
"numero":"00000000000000",
"tipo":2
},
"autorPedidoDados":{
"numero":"00000000000",
"tipo":1
},
"contribuinte":{
"numero":"00000000000",
"tipo":1
},
"pedidoDados":{
"idSistema":"SICALC",
"idServico":"CONSULTAAPOIORECEITAS52",
"versaoSistema":"2.9",
"dados":"{\"codigoReceita\": \"6106\"}"
}
}
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:
Objecto receita:
Campo | Descrição | Tipo |
---|---|---|
codigoReceita | Código de receita informado na chamada | numérico |
descricaoReceita | Nome descritivo do código de receita | texto |
extensoes | Dentro das 3 estruturas previstas, serão informados os atributos relativos ao código de receita, pertinentes ao nome de cada estrutura | array |
(1) Objeto obrigatorios:
Campo | Descrição | Tipo |
---|---|---|
codigoReceita | Indica se o envio do campo é obrigatório. | boolean |
codigoReceitaExtensao | Indica se o envio do campo é obrigatório. | boolean |
cota | Indica se o envio do campo é obrigatório. | boolean |
dataConsolidacao | Indica se o envio do campo é obrigatório. | boolean |
dataPA | Indica se o envio do campo é obrigatório. | boolean |
referencia | Indica se o envio do campo é obrigatório. | boolean |
tipoPA | Indica se o envio do campo é obrigatório. | boolean |
valorImposto | Indica se o envio do campo é obrigatório. | boolean |
vencimento | Indica se o envio do campo é obrigatório. | boolean |
(2) Objeto opcionais:
Campo | Descrição | Tipo |
---|---|---|
cno | Indica se o envio do campo é opcional | boolean |
cnpjPrestador | Indica se o envio do campo é opcional | boolean |
confissao | Informa que o atributo confissao do serviço 'Consolidar e Emitir um DARF' pode ser utilizado para esta receita | boolean |
dataAlienacao | Indica se o envio do campo é opcional | boolean |
ganhoCapital | Indica se o envio do campo é opcional | boolean |
municipio | Indica se o envio do campo é opcional | boolean |
observacao | Indica se o envio do campo é opcional | boolean |
referencia | Indica se o envio do campo é opcional | boolean |
uf | Indica se o envio do campo é opcional | boolean |
valorJuros | Indica se o envio do campo é opcional | boolean |
valorMulta | Indica se o envio do campo é opcional | boolean |
(3) Objeto informacoes:
Campo | Descrição | Tipo |
---|---|---|
calculado | Informa que o débito pode ter os acréscimos legais calculados pelo sistema de cálculo | boolean |
codigoBarras | Informa se a receita permite a emissão do DARF com código de barras | boolean |
codigoReceitaExtensao | Informa a extensão da receita | numérico |
criacao | Informa a data de criação da receita | texto |
descricaoReceitaExtensao | Informa a descrição do código de extensão da receita | texto |
descricaoReferencia | Informa que tipo de dado é aguardado pelo atributo referência | texto |
exigeMatriz | Informa que somente pode ser utilizado o CNPJ da Matriz para débito | boolean |
manual | Informa que o débito não pode ter os acréscimos legais calculados pelo sistema de cálculo e deve ter todos os seus atributos preenchidos pelo usuário (incluindo os de valores) | boolean |
pf | Informa que o código de receita pode ser utilizado num débito de pessoa física | boolean |
pj | Informa que o código de receita pode ser utilizado num débito de pessoa jurídica | boolean |
vedaValor | Informa se o valor total do DARF pode ser inferior a R$ 10,00 | boolean |
Exemplo: conteúdo payload json de saída
Json de exemplo 1: Apoio Consultar Código Receita Sicalc
Json de exemplo 2: Apoio Consultar Código Receita Sicalc