Ir para o conteúdo

Integra Contador

Base URL

Os serviços dos sistemas de negócio podem ser acionados por três tipos de métodos utilizando como base URL o endereço do Integra Contador no contexto da loja de APIs do Serpro.

Base URL: https://gateway.apiserpro.serpro.gov.br/integra-contador/v1/

IMPORTANTE

Acesse a seção do swagger de Demonstração para experimentar a API em modo trial. API Trial acima é apenas para demonstração.

Caminhos

Os caminhos existentes do Integra Contador para acionar qualquer serviço de negócio estão definidos com os serviços do tipo Apoiar, Consultar, Declarar e Emitir.

Apoiar

As funcionalidades acionadas do tipo Apoiar são os serviços auxiliares e de suporte.

URL de Requisição: https://gateway.apiserpro.serpro.gov.br/integra-contador/v1/Apoiar.

Consultar

As funcionalidades acionadas do tipo Consultar estão relacionadas as consultas.

URL de Requisição: https://gateway.apiserpro.serpro.gov.br/integra-contador/v1/Consultar.

Declarar

As funcionalidades acionadas do tipo Declarar estão relacionadas a entrega ou transmissão de declaração:

URL de Requisição: https://gateway.apiserpro.serpro.gov.br/integra-contador/v1/Declarar.

Emitir

As funcionalidades acionadas do tipo Emitir estão relacionadas a emissão de comprovantes, emissão de guia de recolhimento ou documento de arrecadação: https://gateway.apiserpro.serpro.gov.br/integra-contador/v1/Emitir.

Informação

Acesse a seção do Catálogo de Serviços para descobrir todo o portifólio da solução e também qual o tipo de caminho deve ser utilizado por serviço de negócio.

Padrões

  • RESTFUL/JSON (JavaScript Object Notation);
  • Application/json;
  • URL HTTPS;
  • Método: POST;
  • camelCase;
  • Encode UTF-8;
  • SCAPED STRING para o json do campo dados, exemplo:
    {
        "dados": "{\"cnpjBasico\": \"23478643\", \"pa\": \"202001\", \"dataConsolidacao\": null}"
    }
    

Body

O corpo da mensagem de entrada é representado por um objeto json com a seguinte estrutura obrigatória:

{
  "contratante": {
    "numero": "string",
    "tipo": 1
  },
  "autorPedidoDados": {
    "numero": "string",
    "tipo": 1
  },
  "contribuinte": {
    "numero": "string",
    "tipo": 1
  },
  "pedidoDados": {
    "idSistema": "string",
    "idServico": "string",
    "versaoSistema": "string",
    "dados": "string"
  }
}

Objeto Contratante:

Campo Descrição Tipo Obrigatório
numero Número do CNPJ completo (incluindo o DV) do contratante do produto na Loja Serpro. Só são aceitos números e sem a máscara de formatação. String (14) SIM
tipo Tipo do NI. Só é aceito o valor 2 que significa que o tipo do NI (número indicador) é CNPJ. Number (1) SIM

Objeto AutorPedidoDados:

Campo Descrição Tipo Obrigatório
numero Autor da requisição com o pedido de dados. Pode ser o próprio Contratante, Procurador ou Contribuinte. Esse campo aceita um número de CPF ou CNPJ completo (incluindo o DV). Só são aceitos números e sem a máscara de formatação. String (11) - CPF / String (14) - CNPJ SIM
tipo Tipo do NI. Tipo 1 representa o CPF e tipo 2 é CNPJ. Number (1) SIM

Objeto Contribuinte:

Campo Descrição Tipo Obrigatório
numero Número do CNPJ completo (incluindo o DV) do Contribuinte que está sendo realizado alguma operação de obrigação fiscal ou consulta de dados. Esse campo aceita um número de CPF ou CNPJ completo (incluindo o DV). Só são aceitos números e sem a máscara de formatação. String (11) - CPF / String (14) - CNPJ SIM
tipo Tipo do NI. Tipo 1 representa o CPF e tipo 2 é CNPJ. Number (1) SIM

Objeto PedidoDados:

Campo Descrição Tipo Obrigatório
idSistema Identificador do sistema. String SIM
idServico Identificador do serviço que contém a funcionalidade do sistema. String SIM
versaoSistema Versão do sistema acionado String SIM
dados Contém os parâmetros de entrada no sistema acionado. String (SCAPED STRING JSON) SIM