• id
    Descrição: Campo autoincrementável, não deve ser enviado ao inserir um novo registro!
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Sim
    • Quant. máx. de caracteres: 5
    • Campo auto incrementável: Sim
  • codigo
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Sim
    • Quant. máx. de caracteres: 11
    • Máscara: Número inteiro
  • tipo_documento
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Sim
    • Quant. máx. de caracteres: 100
  • tipo
    Dados técnicos:
    • Tipo de campo: Botão de seleção
    • Campo obrigatório: Sim
    • Valores disponíveis:
      E = Entrada
      S = Saida
  • gera_finan
    Dados técnicos:
    • Tipo de campo: Botão de seleção
    • Campo obrigatório: Sim
    • Valores disponíveis:
      S = Sim
      N = Não
  • gera_contab
    Dados técnicos:
    • Tipo de campo: Botão de seleção
    • Campo obrigatório: Sim
    • Valores disponíveis:
      S = Sim
      N = Não
  • gera_fiscal
    Dados técnicos:
    • Tipo de campo: Botão de seleção
    • Campo obrigatório: Sim
    • Valores disponíveis:
      S = Sim
      N = Não
  • gera_estoque
    Dados técnicos:
    • Tipo de campo: Botão de seleção
    • Campo obrigatório: Sim
    • Valores disponíveis:
      S = Sim
      N = Não
  • modelo_impressao_nota
    Descrição: Relacionado com o campo id da tabela Modelo de impressão de RPS.
    Dados técnicos:
    • Tipo de campo: Campo de busca avançada
    • Campo obrigatório: Não
    • Valores disponíveis:
  • finalidade_nfe_tipo_doc
    Dados técnicos:
    • Tipo de campo: Campo de seleção
    • Campo obrigatório: Não
    • Valor Padrão: NF-e normal
    • Valores disponíveis:
      1 = NF-e normal
      2 = NF-e complementar
      3 = NF-e de ajuste
      4 = Devolução/Retorno
  • tipo_tributacao
    Dados técnicos:
    • Tipo de campo: Botão de seleção
    • Campo obrigatório: Não
    • Valores disponíveis:
      ICMS = ICMS
      ISSQN = ISSQN
  • modelo_nf
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Não
    • Quant. máx. de caracteres: 10
  • serie_nf
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Não
    • Quant. máx. de caracteres: 10
  • natureza_dentro_estado
    Descrição: Relacionado com o campo id da tabela CFOP - Natureza da operação.
    Dados técnicos:
    • Tipo de campo: Campo de busca avançada
    • Campo obrigatório: Não
    • Valores disponíveis:
  • natureza_fora_estado
    Descrição: Relacionado com o campo id da tabela CFOP - Natureza da operação.
    Dados técnicos:
    • Tipo de campo: Campo de busca avançada
    • Campo obrigatório: Não
    • Valores disponíveis:
  • descricao_produto_nf
    Dados técnicos:
    • Tipo de campo: Botão de seleção
    • Campo obrigatório: Não
    • Valor Padrão: Cadastro do produto
    • Valores disponíveis:
      C = Cadastro do produto
      M = Descrição do movimento de produto
  • regime_tributario
    Dados técnicos:
    • Tipo de campo: Botão de seleção
    • Campo obrigatório: Sim
    • Valor Padrão: Padrão filial
    • Valores disponíveis:
      0 = Padrão filial
      1 = Simples Nacional
      2 = Simples Nacional ? excesso de sublimite de receita bruta
      3 = Tributação normal
  • nf_importacao
    Dados técnicos:
    • Tipo de campo: Botão de seleção
    • Campo obrigatório: Sim
    • Valor Padrão: Não
    • Valores disponíveis:
      N = Não
      S = Sim
  • impostometro
    Dados técnicos:
    • Tipo de campo: Botão de seleção
    • Campo obrigatório: Não
    • Valor Padrão: Não
    • Valores disponíveis:
      S = Sim
      N = Não
  • gera_servicos_nf
    Dados técnicos:
    • Tipo de campo: Botão de seleção
    • Campo obrigatório: Não
    • Valor Padrão: Sim
    • Valores disponíveis:
      S = Sim
      N = Não
  • gera_internet
    Dados técnicos:
    • Tipo de campo: Botão de seleção
    • Campo obrigatório: Não
    • Valor Padrão: Sim
    • Valores disponíveis:
      S = Sim
      N = Não
  • gera_mercadoria
    Dados técnicos:
    • Tipo de campo: Botão de seleção
    • Campo obrigatório: Não
    • Valor Padrão: Sim
    • Valores disponíveis:
      S = Sim
      N = Não
  • gera_telefonia
    Dados técnicos:
    • Tipo de campo: Botão de seleção
    • Campo obrigatório: Não
    • Valor Padrão: Sim
    • Valores disponíveis:
      S = Sim
      N = Não
  • gera_sva
    Dados técnicos:
    • Tipo de campo: Botão de seleção
    • Campo obrigatório: Sim
    • Valor Padrão: Sim
    • Valores disponíveis:
      S = Sim
      N = Não
  • alterar_descricao_nf
    Dados técnicos:
    • Tipo de campo: Botão de seleção
    • Campo obrigatório: Não
    • Valor Padrão: Não
    • Valores disponíveis:
      S = Sim
      N = Não
  • natureza_operacao
    Dados técnicos:
    • Tipo de campo: Campo de área de texto
    • Campo obrigatório: Não
    • Quant. máx. de caracteres: 100
  • nf_complementar_tp_doc
    Dados técnicos:
    • Tipo de campo: Campo de área de texto
    • Campo obrigatório: Não
    • Quant. máx. de caracteres: 2147483647
  • atualiza_custo_medio
    Dados técnicos:
    • Tipo de campo: Botão de seleção
    • Campo obrigatório: Não
    • Valor Padrão: Não
    • Valores disponíveis:
      S = Sim
      N = Não
  • emite_nfe_entrada
    Dados técnicos:
    • Tipo de campo: Botão de seleção
    • Campo obrigatório: Não
    • Valor Padrão: Não
    • Valores disponíveis:
      S = Sim
      N = Não
  • mask_entrada_quantidade
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Sim
    • Quant. máx. de caracteres: 1
    • Valor Padrão: 3
  • mask_entrada_valor_unit
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Sim
    • Quant. máx. de caracteres: 1
    • Valor Padrão: 3
  • mask_saida_quantidade
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Sim
    • Quant. máx. de caracteres: 1
    • Valor Padrão: 3
  • mask_saida_valor_unit
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Sim
    • Quant. máx. de caracteres: 1
    • Valor Padrão: 3
  • gera_servicos
    Dados técnicos:
    • Tipo de campo: Botão de seleção
    • Campo obrigatório: Sim
    • Valor Padrão: Não
    • Valores disponíveis:
      N = Não
      S = Sim
  • financeiro_liberado
    Dados técnicos:
    • Tipo de campo: Botão de seleção
    • Campo obrigatório: Sim
    • Valor Padrão: Não
    • Valores disponíveis:
      S = Sim
      N = Não
  • id_almox_padrao
    Descrição: Relacionado com o campo id da tabela Almoxarifado.
    Dados técnicos:
    • Tipo de campo: Campo de busca avançada
    • Campo obrigatório: Não
    • Valores disponíveis:
  • controle_estoque
    Dados técnicos:
    • Tipo de campo: Botão de seleção
    • Campo obrigatório: Não
    • Valor Padrão: Padrão
    • Valores disponíveis:
      N = Não
      B = Bloqueia
      A = Alerta
      P = Padrão
  • ir_desconta_pis_retido_total
    Dados técnicos:
    • Tipo de campo: Caixa de seleção
    • Campo obrigatório: Não
    • Valor Padrão: S
  • ir_desconta_cofins_retido_total
    Dados técnicos:
    • Tipo de campo: Caixa de seleção
    • Campo obrigatório: Não
    • Valor Padrão: S
  • ir_desconta_csll_retido_total
    Dados técnicos:
    • Tipo de campo: Caixa de seleção
    • Campo obrigatório: Não
    • Valor Padrão: S
  • ir_desconta_irrf_retido_total
    Dados técnicos:
    • Tipo de campo: Caixa de seleção
    • Campo obrigatório: Não
    • Valor Padrão: S
  • id_cnf_grade_ctb
    Descrição: Definir a grade de contabilização padrão para este Tipo de Documento.
    Em desenvolvimento.
    Dados técnicos:
    • Tipo de campo: Campo de busca avançada
    • Campo obrigatório: Não
    • Valores disponíveis:
  • codigo_classificacao_sped
    Dados técnicos:
    • Tipo de campo: Campo de seleção
    • Campo obrigatório: Não
    • Valores disponíveis:
      0101 = 0101 - Assinatura de serviços de telefonia
      0102 = 0102 - Assinatura de serviços de comunicação de dados
      0103 = 0103 - Assinatura de serviços de TV por Assinatura
      0104 = 0104 - Assinatura de serviços de provimento à internet
      0105 = 0105 - Assinatura de outros serviços de multimídia
      0199 = 0199 - Assinatura de outros serviços
      0201 = 0201 - Habilitação de serviços de telefonia
      0202 = 0202 - Habilitação de serviços de comunicação de dados
      0203 = 0203 - Habilitação de TV por Assinatura
      0204 = 0204 - Habilitação de serviços de provimento à internet
      0205 = 0205 - Habilitação de outros serviços multimídia
      0299 = 0299 - Habilitação de outros serviços
      0301 = 0301 - Serviço Medido - chamadas locais
      0302 = 0302 - Serviço Medido - chamadas interurbanas no Estado
      0303 = 0303 - Serviço Medido - chamadas interurbanas para fora do Estado
      0304 = 0304 - Serviço Medido - chamadas internacionais
      0305 = 0305 - Serviço Medido - Números Especiais (0300/0500/0600/0800/etc.)
      0306 = 0306 - Serviço Medido - comunicação de dados
      0307 = 0307 - Serviço Medido - chamadas originadas em Roaming
      0308 = 0308 - Serviço Medido - chamadas recebidas em Roaming
      0309 = 0309 - Serviço Medido - adicional de chamada
      0310 = 0310 - Serviço Medido - provimento de acesso à Internet
      0311 = 0311 - Serviço Medido - pay-per-view (programação TV)
      0312 = 0312 - Serviço Medido - Mensagem SMS
      0313 = 0313 - Serviço Medido - Mensagem MMS
      0314 = 0314 - Serviço Medido - outros mensagens
      0315 = 0315 - Serviço Medido - serviço multimídia
      0399 = 0399 - Serviço Medido - outros serviços
      0401 = 0401 - Cartão Telefônico - Telefonia Fixa
      0402 = 0402 - Cartão Telefônico - Telefonia Móvel
      0403 = 0403 - Cartão de Provimento de acesso à internet
      0404 = 0404 - Ficha Telefônica
      0405 = 0405 - Recarga de Créditos - Telefonia Fixa
      0406 = 0406 - Recarga de Créditos - Telefonia Móvel
      0407 = 0407 - Recarga de Créditos - Provimento de acesso à Internet
      0499 = 0499 - Outras cobranças realizadas de assinantes de plano serviço pré-pago
      0501 = 0501 - Serviço Adicional (substituição de número, troca de aparelho, emissão de 2ª via de conta, conta detalhada, etc.)
      0502 = 0502 - Serviço Facilidades (identificador de chamadas, caixa postal, transferência temporária, não-perturbe, etc.)
      0599 = 0599 - Outros Serviços
      0601 = 0601 - Energia Elétrica - Consumo
      0602 = 0602 - Energia Elétrica - Demanda
      0603 = 0603 - Energia Elétrica - Serviços (Vistoria de unidade consumidora, Aferição de Medidor, Ligação, Religação, Troca de medidor, etc.)
      0604 = 0604 - Energia Elétrica - Encargos Emergenciais
      0605 = 0605 - Tarifa de Uso dos Sistemas de Distribuição de Energia Elétrica - TUSD - Consumidor Cativo
      0606 = 0606 - Tarifa de Uso dos Sistemas de Distribuição de Energia Elétrica - TUSD - Consumidor Livre
      0607 = 0607 - Encargos de Conexão
      0608 = 0608 - Tarifa de Uso dos Sistemas de Transmissão de Energia Elétrica - TUST - Consumidor Cativo
      0609 = 0609 - Tarifa de Uso dos Sistemas de Transmissão de Energia Elétrica - TUST - Consumidor Livre
      0610 = 0610 - Subvenção econômica para consumidores da subclasse "baixa renda"
      0699 = 0699 - Energia Elétrica - Outros
      0701 = 0701 - de Aparelho Telefônico
      0702 = 0702 - de Aparelho Identificador de chamadas
      0703 = 0703 - de Modem
      0704 = 0704 - de Rack
      0705 = 0705 - de Sala/Recinto
      0706 = 0706 - de Roteador
      0707 = 0707 - de Servidor
      0708 = 0708 - de Multiplexador
      0709 = 0709 - de Decodificador/Conversor
      0799 = 0799 - Outras disponibilizações
      0801 = 0801 - Cobrança de Serviços de Terceiros
      0802 = 0802 - Cobrança de Seguros
      0803 = 0803 - Cobrança de Financiamento de Aparelho/Serviços
      0804 = 0804 - Cobrança de Juros de Mora
      0805 = 0805 - Cobrança de Multa de Mora
      0806 = 0806 - Cobrança de Conta de meses anteriores
      0807 = 0807 - Cobrança de Taxa Iluminação Pública
      0808 = 0808 - Retenção de ICMS-ST
      0899 = 0899 - Outras Cobranças
      0901 = 0901 - Dedução relativa a impugnação de serviços
      0902 = 0902 - Dedução referente ajuste de conta
      0903 = 0903 - Redutor - Energia Elétrica - IN Nº 306/2003 (PIS/COFINS/IRPJ/CSLL)
      0904 = 0904 - Dedução relativa à multa pela interrupção de fornecimento
      0905 = 0905 - Dedução relativa à distribuição de dividendos Eletrobrás
      0906 = 0906 - Dedução relativa à subvenção econômica para consumidores da subclasse "baixa renda"
      0999 = 0999 - Outras deduções
      1001 = 1001 - Serviço não medido de serviços de telefonia
      1002 = 1002 - Serviço não medido de serviços de comunicação de dados
      1003 = 1003 - Serviço não medido de serviços de TV por Assinatura
      1004 = 1004 - Serviço não medido de serviços de provimento à internet
      1005 = 1005 - Serviço não medido de outros serviços de multimídia
      1009 = 1099 - Serviço não medido de outros serviços"
  • tipo_receita_sped
    Dados técnicos:
    • Tipo de campo: Campo de seleção
    • Campo obrigatório: Não
    • Valor Padrão: 1- Receita própria - cobrança de débitos
    • Valores disponíveis:
      0 = 0- Receita própria - serviços prestados
      1 = 1- Receita própria - cobrança de débitos
      2 = 2- Receita própria - venda de mercadorias
      3 = 3- Receita própria - venda de serviço pré-pago
      4 = 4- Outras receitas próprias
      5 = 5- Receitas de terceiros (co-faturamento)
      9 = 9- Outras receitas de terceiros
  • Inserir
    
    require(__DIR__ . DIRECTORY_SEPARATOR . 'WebserviceClient.php');
    $host = 'https://SEU_DOMINIO/webservice/v1';
    $token = '6:4dacdb8e47193e8cbbabe508c3c59b4547e463817b1d9b9a1d20ab4812fe1a62';//token gerado no cadastro do usuario (verificar permissões)
    $selfSigned = true; //true para certificado auto assinado
    $api = new IXCsoft\WebserviceClient($host, $token, $selfSigned);
    $dados = array(
        'codigo' => '',
        'tipo_documento' => '',
        'tipo' => '',
        'gera_finan' => '',
        'gera_contab' => '',
        'gera_fiscal' => '',
        'gera_estoque' => '',
        'modelo_impressao_nota' => '',
        'finalidade_nfe_tipo_doc' => '1',
        'tipo_tributacao' => '',
        'modelo_nf' => '',
        'serie_nf' => '',
        'natureza_dentro_estado' => '',
        'natureza_fora_estado' => '',
        'descricao_produto_nf' => 'C',
        'regime_tributario' => '0',
        'nf_importacao' => 'N',
        'impostometro' => 'N',
        'gera_servicos_nf' => 'S',
        'gera_internet' => 'S',
        'gera_mercadoria' => 'S',
        'gera_telefonia' => 'S',
        'gera_sva' => 'S',
        'alterar_descricao_nf' => 'N',
        'natureza_operacao' => '',
        'nf_complementar_tp_doc' => '',
        'atualiza_custo_medio' => 'N',
        'emite_nfe_entrada' => 'N',
        'mask_entrada_quantidade' => '3',
        'mask_entrada_valor_unit' => '3',
        'mask_saida_quantidade' => '3',
        'mask_saida_valor_unit' => '3',
        'gera_servicos' => 'N',
        'financeiro_liberado' => 'N',
        'id_almox_padrao' => '',
        'controle_estoque' => 'P',
        'ir_desconta_pis_retido_total' => 'S',
        'ir_desconta_cofins_retido_total' => 'S',
        'ir_desconta_csll_retido_total' => 'S',
        'ir_desconta_irrf_retido_total' => 'S',
        'id_cnf_grade_ctb' => '',
        'codigo_classificacao_sped' => '',
        'tipo_receita_sped' => '1'
    );
    $api->post('tipo_documento', $dados);
    $retorno = $api->getRespostaConteudo(false);// false para json | true para array
    
  • Editar
    
    require(__DIR__ . DIRECTORY_SEPARATOR . 'WebserviceClient.php');
    $host = 'https://SEU_DOMINIO/webservice/v1';
    $token = '6:4dacdb8e47193e8cbbabe508c3c59b4547e463817b1d9b9a1d20ab4812fe1a62';//token gerado no cadastro do usuario (verificar permissões)
    $selfSigned = true; //true para certificado auto assinado
    $api = new IXCsoft\WebserviceClient($host, $token, $selfSigned);
    
    $dados = array(
        'codigo' => '',
        'tipo_documento' => '',
        'tipo' => '',
        'gera_finan' => '',
        'gera_contab' => '',
        'gera_fiscal' => '',
        'gera_estoque' => '',
        'modelo_impressao_nota' => '',
        'finalidade_nfe_tipo_doc' => '1',
        'tipo_tributacao' => '',
        'modelo_nf' => '',
        'serie_nf' => '',
        'natureza_dentro_estado' => '',
        'natureza_fora_estado' => '',
        'descricao_produto_nf' => 'C',
        'regime_tributario' => '0',
        'nf_importacao' => 'N',
        'impostometro' => 'N',
        'gera_servicos_nf' => 'S',
        'gera_internet' => 'S',
        'gera_mercadoria' => 'S',
        'gera_telefonia' => 'S',
        'gera_sva' => 'S',
        'alterar_descricao_nf' => 'N',
        'natureza_operacao' => '',
        'nf_complementar_tp_doc' => '',
        'atualiza_custo_medio' => 'N',
        'emite_nfe_entrada' => 'N',
        'mask_entrada_quantidade' => '3',
        'mask_entrada_valor_unit' => '3',
        'mask_saida_quantidade' => '3',
        'mask_saida_valor_unit' => '3',
        'gera_servicos' => 'N',
        'financeiro_liberado' => 'N',
        'id_almox_padrao' => '',
        'controle_estoque' => 'P',
        'ir_desconta_pis_retido_total' => 'S',
        'ir_desconta_cofins_retido_total' => 'S',
        'ir_desconta_csll_retido_total' => 'S',
        'ir_desconta_irrf_retido_total' => 'S',
        'id_cnf_grade_ctb' => '',
        'codigo_classificacao_sped' => '',
        'tipo_receita_sped' => '1'
    );
    $registro = '1';//registro a ser editado
    $api->put('tipo_documento', $dados, $registro);
    $retorno = $api->getRespostaConteudo(false);// false para json | true para array
    
  • Deletar
    
    require(__DIR__ . DIRECTORY_SEPARATOR . 'WebserviceClient.php');
    $host = 'https://SEU_DOMINIO/webservice/v1';
    $token = '6:4dacdb8e47193e8cbbabe508c3c59b4547e463817b1d9b9a1d20ab4812fe1a62';//token gerado no cadastro do usuario (verificar permissões)
    $selfSigned = true; //true para certificado auto assinado
    $api = new IXCsoft\WebserviceClient($host, $token, $selfSigned);
    $registro = '1';//registro a ser deletado
    $api->delete('tipo_documento', $registro);
    $retorno = $api->getRespostaConteudo(false);// false para json | true para array
    
  • Listar
    
    require(__DIR__ . DIRECTORY_SEPARATOR . 'WebserviceClient.php');
    $host = 'https://SEU_DOMINIO/webservice/v1';
    $token = '6:4dacdb8e47193e8cbbabe508c3c59b4547e463817b1d9b9a1d20ab4812fe1a62';//token gerado no cadastro do usuario (verificar permissões)
    $selfSigned = true; //true para certificado auto assinado
    $api = new IXCsoft\WebserviceClient($host, $token, $selfSigned);
    $params = array(
        'qtype' => 'tipo_documento.id',//campo de filtro
        'query' => '1',//valor para consultar
        'oper' => '=',//operador da consulta
        'page' => '1',//página a ser mostrada
        'rp' => '20',//quantidade de registros por página
        'sortname' => 'tipo_documento.id',//campo para ordenar a consulta
        'sortorder' => 'desc'//ordenação (asc= crescente | desc=decrescente)
    );
    $api->get('tipo_documento', $params);
    $retorno = $api->getRespostaConteudo(false);// false para json | true para array