IN Integrador Padrão
Índice
- 1 Compras
- 1.1 EfetivacaoRequisicaoMaterial.integrador
- 1.2 CadastroGradeRequisicaoMaterial.integrador
- 1.3 CadastroGradeSolicitacaoMaterial.integrador
- 1.4 CadastroItemRequisicaoMaterial.integrador
- 1.5 CadastroItemSolicitacaoMaterial.integrador
- 1.6 CadastroPreNota.integrador
- 1.7 CadastroRequisicaoMaterial.integrador
- 1.8 CadastroSolicitacaoMaterial.integrador
- 2 Configurador
- 3 Estoque
- 3.1 CadastroBalanco.integrador
- 3.2 CadastroCaracteristicasMateriaisTg.integrador
- 3.3 CadastroCaracValidasParametros.integrador
- 3.4 CadastroCentroArmazenagem.integrador
- 3.5 CadastroClassificacaoFiscal.integrador
- 3.6 CadastroComplementoMaterial.integrador
- 3.7 CadastroEspecif1.integrador
- 3.8 CadastroEspecif2.integrador
- 3.9 CadastroEspecif3.integrador
- 3.10 CadastroEspecif4.integrador
- 3.11 CadastroEspecif5.integrador
- 3.12 CadastroEspecif6.integrador
- 3.13 CadastroGradeMovimento.integrador
- 3.14 CadastroGradePadrao.integrador
- 3.15 CadastroGrupos.integrador
- 3.16 CadastroInventarioEstoque.integrador
- 3.17 CadastroInventarioItens.integrador
- 3.18 CadastroListaMateriais.integrador
- 3.19 CadastroMateriais.integrador
- 3.20 CadastroMateriaisTg.integrador
- 3.21 CadastroMovimento.integrador
- 3.22 CadastroMovimentoEstoque.integrador
- 3.23 CadastroNumeracaoGrade.integrador
- 3.24 CadastroParametrosPlanejamento.integrador
- 3.25 CadastroRegraFiscal.integrador
- 3.26 CadastroRegraParametrosPlanejamento.integrador
- 3.27 CadastroSubGrupos.integrador
- 3.28 CadastroUnidadeMedida.integrador
- 4 Faturamento
- 4.1 CancelamentoNotaFiscal.integrador
- 4.2 CadastroCondicaoPagamento.integrador
- 4.3 CadastroControlePedido.integrador
- 4.4 CadastroGradePedido.integrador
- 4.5 CadastroItensPedido.integrador
- 4.6 CadastroMapaResumo.integrador
- 4.7 CadastroNotaFiscal.integrador
- 4.7.1 Cadastrar
- 4.7.2 ListarId
- 4.7.3 ListarPendentes
- 4.7.4 LiberarPendentes
- 4.7.5 ListarNotasFiscais
- 4.7.6 ListarNotasFiscaisInutilizadas
- 4.7.7 ListarNotasFiscaisPaf
- 4.7.8 ListasNFsMultiplasFormasPagamento
- 4.7.9 ListarComissoesPorRepresentante
- 4.7.10 CadastrarNotasFiscais
- 4.7.11 RegistrarNotaFiscalInutilizada
- 4.8 CadastroPedidos.integrador
- 4.9 CadastroPrazoPagamento.integrador
- 5 Financeiro
- 5.1 CadastroContaGerencial.integrador
- 5.2 CadastroContasFinanceiras.integrador
- 5.3 CadastroContratos.integrador
- 5.4 CadastroHistoricos.integrador
- 5.5 CadastroLancamentos.integrador
- 5.6 CadastroObjetoContrato.integrador
- 5.7 CadastroParcelaPadraoContrato.integrador
- 5.8 CadastrosParcelaContrato.integrador
- 5.9 CadastroPortadores.integrador
- 5.10 CadastroTipoPagamento.integrador
- 6 Fiscal
- 7 Generico
- 7.1 Notificacao.integrador
- 7.2 Arquivos.integrador
- 7.3 CadastroCategoriasTg.integrador
- 7.4 CadastroColaboradores.integrador
- 7.5 CadastroContatosEmpresas.integrador
- 7.6 CadastroControleTg.integrador
- 7.7 CadastroElementosTg.integrador
- 7.8 Email.integrador
- 7.9 CadastroEmpresas.integrador
- 7.10 CadastroEmpresaComissao.integrador
- 7.11 CadastroEnderecosCobrancaEmpresas.integrador
- 7.12 CadastroEnderecosEntregaEmpresas.integrador
- 7.13 CadastroEstados.integrador
- 7.14 CadastroMunicipios.integrador
- 7.15 CadastroObservacaoEmpresa.integrador
- 7.16 CadastroPaises.integrador
- 7.17 CadastroRegiaoMercado.integrador
- 7.18 CadastroRegraDesconto.integrador
- 7.19 CadastroTabelaPreco.integrador
- 7.20 CadastroTipoOperacao.integrador
- 7.21 CadastroTiposEmpresa.integrador
- 7.22 Log.integrador
- 8 Materiais
Compras
EfetivacaoRequisicaoMaterial.integrador
ListarPendentes
LiberarPendentes
EfetivarRequisicaoMaterial
CadastroGradeRequisicaoMaterial.integrador
ListarId
ListarIndividual
ListarModificacoes
ListarPendentes
LiberarPendentes
Cadastrar
CadastroGradeSolicitacaoMaterial.integrador
ListarId
ListarIndividual
ListarModificacoes
ListarPendentes
LiberarPendentes
Cadastrar
CadastroItemRequisicaoMaterial.integrador
Cadastrar
Excluir
ListarPendentes
ListarId
ListarModificacoes
ListarModificacoes
LiberarPendentes
ListarRequisicoesSeparacao
ApontamentoSeparacaoItemRequisicao
ApontamentoSeparacaoItemRequisicaoLote
CadastroItemSolicitacaoMaterial.integrador
ListarModificacoes
ListarPendentes
ListarId
ListarIndividual
LiberarPendentes
Cadastrar
Excluir
CadastroPreNota.integrador
ListarId
ListarIndividual
ListarPreNota
ListarModificacoes
Efetivar
CadastroRequisicaoMaterial.integrador
ListarId
ListarIndividual
ListarModificacoes
ListarPendentes
LiberarPendentes
Cadastrar
Excluir
CadastroSolicitacaoMaterial.integrador
ListarId
ListarIndividual
ListarModificacoes
ListarPendentes
LiberarPendentes
Cadastrar
Excluir
Configurador
CadastroCaracteristica.integrador
ListarId
ListarIndividual
ListarModificacoes
CadastroCaracteristicaConfigurador.integrador
ListarId
ListarIndividual
ListarModificacoes
CadastroConfigurador.integrador
ListarId
ListarIndividual
ListarModificacoes
CadastroConfiguradorProduto.integrador
ListarIdentificador
ListarConfigurador
ListarCaracteristicaConfigurador
ListarValorCaracteristica
CadastroConteudoCaracteristica.integrador
ListarId
ListarIndividual
ListarModificacoes
Estoque
CadastroBalanco.integrador
ListarId
ListarIndividual
ListarModificacoes
ListarPendentes
LiberarPendentes
Cadastrar
CadastroCaracteristicasMateriaisTg.integrador
ListarId
ListarIndividual
ListarModificacoes
ListarCategoriaUnica
CadastroCaracValidasParametros.integrador
ListarId
ListarIndividual
ListarModificacoes
CadastroCentroArmazenagem.integrador
ListarId
ListarIndividual
ListarModificacoes
CadastroClassificacaoFiscal.integrador
ListarId
ListarIndividual
ListarModificacoes
ListarClassificacaoFiscal
Cadastrar
CadastroComplementoMaterial.integrador
ListarId
ListarIndividual
ListarModificacoes
ListarImagem
ListarEspecifs
CadastroEspecif1.integrador
ListarId
ListarIndividual
ListarModificacoes
Cadastrar
CadastroEspecif2.integrador
ListarId
ListarIndividual
ListarModificacoes
Cadastrar
CadastroEspecif3.integrador
ListarId
ListarIndividual
ListarModificacoes
Cadastrar
CadastroEspecif4.integrador
ListarId
ListarIndividual
ListarModificacoes
Cadastrar
CadastroEspecif5.integrador
ListarId
ListarIndividual
ListarModificacoes
Cadastrar
CadastroEspecif6.integrador
ListarId
ListarIndividual
ListarModificacoes
Cadastrar
CadastroGradeMovimento.integrador
CadastroGradePadrao.integrador
CadastroGrupos.integrador
CadastroInventarioEstoque.integrador
CadastroInventarioItens.integrador
CadastroListaMateriais.integrador
CadastroMateriais.integrador
CadastroMateriaisTg.integrador
CadastroMovimento.integrador
CadastroMovimentoEstoque.integrador
CadastroNumeracaoGrade.integrador
CadastroParametrosPlanejamento.integrador
CadastroRegraFiscal.integrador
CadastroRegraParametrosPlanejamento.integrador
CadastroSubGrupos.integrador
CadastroUnidadeMedida.integrador
Faturamento
CancelamentoNotaFiscal.integrador
CadastroCondicaoPagamento.integrador
CadastroControlePedido.integrador
CadastroGradePedido.integrador
CadastroItensPedido.integrador
CadastroMapaResumo.integrador
CadastroNotaFiscal.integrador
Cadastrar
ListarId
ListarPendentes
LiberarPendentes
ListarNotasFiscais
ListarNotasFiscaisInutilizadas
Esse método tem por finalidade filtrar as numerações de NFe inutilizadas no ERP CIGAM, conforme indicado nos filtros exemplo a seguir:
ReceitaWS
Mantenha seu sistema sempre atualizado com dados fiéis das empresas que se relacionam com você.
Conheça nossa API.
API: Documentação
O ReceitaWS provê uma API para recuperação de dados de empresas brasileiras através de seu CNPJ. Existem dois modos de utilização desta API:
- Modo Público
- Modo Comercial
Para entender com mais detalhes as diferenças entre estes modos de uso, é recomendada a leitura do FAQ e da página de preços. Abaixo segue a documentação específica para utilização e integração de ambos os modos.
Documentação da API Pública
Recuperar dados de uma empresa
Método para recuperar as informações de uma empresa brasileira através do seu CNPJ. As informações são exatamente as mesmas informações retornadas pelo site da Receita Federal Brasileira.
URL para requisição
https://www.receitaws.com.br/v1/cnpj/[cnpj]
Parâmetros
- cnpj: obrigatório, numérico, o CNPJ a ser pesquisado
Exemplo de requisição
$ curl -X GET https://www.receitaws.com.br/v1/cnpj/27865757000102
Exemplo de resposta
Clique aqui para ver em seu browser.
Uma resposta típica é composta por uma matriz em JSON composta pelos seguintes campos:
| Campo | Tipo | Descrição |
|---|---|---|
| status | string | Indica a situação da requisição. Valores possíveis: OK, ERROR. |
| message | string | Mensagem explicativa indicando erro. Válido apenas quando o campo status é ERROR. |
| billing | objeto | Indica para a requisição como foi registrado a cobrança da consulta. |
| billing.free | boolean | Indica se a requisição foi gratuita. |
| billing.database | boolean | Indica como a requisição foi resolvida: true (resolvida pelo banco de dados), false (resolvida em tempo real). |
| cnpj | string | CNPJ no formato 00.000.000/0000-00. |
| tipo | string | Valores possíveis: MATRIZ, FILIAL. |
| abertura | string | Data de abertura no formato dd/mm/aaaa. |
| nome | string | Razão social. |
| fantasia | string | Nome fantasia. |
| atividade_principal | Array<objeto> | Atividade principal. Um array com um elemento. |
| atividade_principal.code | string | Código CNAE da atividade no formato 00.00-0-00. |
| atividade_principal.text | string | Descrição da atividade. |
| atividades_secundarias | Array<objeto> | Atividades secundárias. |
| atividades_secundarias.code | string | Código CNAE da atividade no formato 00.00-0-00. |
| atividades_secundarias.text | string | Descrição da atividade. |
| natureza_juridica | string | Natureza jurídica. |
| logradouro | string | Logradouro. |
| numero | string | Número. |
| complemento | string | Complemento. |
| cep | string | CEP no formato 00.000-000. |
| bairro | string | Bairro. |
| municipio | string | Município. |
| uf | string | Sigla da Unidade da Federação. |
| string | Email. | |
| telefone | string | Telefone. |
| efr | string | Ente Federativo Responsável, disponibilizado apenas para CNPJs da administração pública. |
| situacao | string | Situação. |
| data_situacao | string | Data da situação no formato dd/mm/aaaa. |
| motivo_situacao | string | Motivo da situação. |
| situacao_especial | string | Situação especial. |
| data_situacao_especial | string | Data da situação especial no formato dd/mm/aaaa. |
| capital_social | string | Valor do capital social no formato 0.00. |
| qsa | Array<objeto> | Quadro de Sócios e Administradores. |
| qsa.nome | string | Nome do sócio. |
| qsa.qual | string | Qualificação do sócio. |
| qsa.pais_origem | string | País de origem do sócio. Disponível apenas para sócios estrangeiros. |
| qsa.nome_rep_legal | string | Nome do representante legal. Disponível apenas para sócios com representantes. |
| qsa.qual_rep_legal | string | Qualificação do representante legal. Disponível apenas para sócios com representantes. |
| extra | objeto | Campo reservado para uso futuro. |
Erros
O campo status indica se houve ou não erro no processamento. No caso de um erro interno no servidor ou timeouts, o header de status da resposta será diferente de 200, portanto também esteja preparado para estes erros. Timeouts podem ocorrer devido à natureza do sistema. Para mais detalhes verifique o FAQ. Esteja preparado para tratar os seguintes erros que podem ocorrer na execução da API:
CNPJ rejeitado
CNPJ rejeitado pela Receita Federal
Exemplo de resposta
{
"status": "ERROR",
"message": "CNPJ rejeitado pela Receita Federal"
}
CNPJ inválido
CNPJ inválido
Exemplo de resposta
{
"status": "ERROR",
"message": "CNPJ inválido"
}
Documentação da API Comercial
Recuperar dados de uma empresa especificando a defasagem dos dados
Para controlar a quantidade de dias entre a sua requisição e a consulta dos dados do CNPJ na Receita Federal, é possível especificar a quantidade de dias máximo entre os dois eventos, ou seja, a defasagem máxima dos dados.
Por exemplo, um CNPJ foi consultado há 32 dias e estes são os dados retornados pela API Pública. Caso necessite de uma informação mais atualizada, basta informar a quantidade máxima de dias em que a consulta à Receita é aceitável para o seu caso de uso. Informando qualquer valor menor que 32, neste caso, geraria uma nova atualização dos dados.
No caso da requisição gerar uma consulta à Receita Federal haverá uma cobrança em sua conta. Apenas requisições respondidas em no máximo 60 segundos serão cobradas. Veja os valores vigentes na página de valores.
Para forçar uma nova atualização, independente da última atualização dos dados, basta enviar 0 (zero) no valor do parâmetro days.
URL para requisição
https://www.receitaws.com.br/v1/cnpj/[cnpj]/days/[days]
Parâmetros
- cnpj: obrigatório, numérico, o CNPJ a ser pesquisado
- days: obrigatório, numérico, quantidade máxima de dias com relação à última consulta na Receita Federal deste CNPJ
Headers
- Authorization: obrigatório, token para autenticação. Seu valor deve ser "Bearer <token>", onde <token> é o token gerado na sua conta.
Exemplo de requisição
$ TOKEN="meu-token" $ curl -X GET -H "Authorization: Bearer $TOKEN" https://www.receitaws.com.br/v1/cnpj/27865757000102/days/10