O Sistema IXCSoft é multi-filial, o objetivo do uso de multi-filial é poder gerenciar resultados, indicadores e informações por filial ou consolidado.
É obrigatório o cadastro de pelo menos uma filial, e não possui limite de cadastros de filiais.
Os dados que são impressos nos cabeçalho das notas fiscais, boletos e relatórios, buscam no cadastro da filial. 

  • 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: 11
    • Campo auto incrementável: Sim
  • id_empresa
    Descrição: Relacionado com o campo id da tabela Empresa.
    Dados técnicos:
    • Tipo de campo: Campo de busca avançada
    • Campo obrigatório: Sim
    • Valores disponíveis:
  • razao
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Sim
    • Quant. máx. de caracteres: 100
  • fantasia
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Sim
    • Quant. máx. de caracteres: 100
  • email
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Não
    • Quant. máx. de caracteres: 250
  • site
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Não
    • Quant. máx. de caracteres: 250
  • tipo_pessoa
    Dados técnicos:
    • Tipo de campo: Botão de seleção
    • Campo obrigatório: Sim
    • Valor Padrão: Jurídica
    • Valores disponíveis:
      J = Jurídica
      F = Física
  • cnpj
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Não
    • Quant. máx. de caracteres: 30
  • im_numero_creci
    Descrição: Conselho Regional de Corretores de Imóveis 
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Não
    • Quant. máx. de caracteres: 30
  • ie
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Não
    • Quant. máx. de caracteres: 20
  • iest
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Não
    • Quant. máx. de caracteres: 14
  • im
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Não
    • Quant. máx. de caracteres: 15
  • cnae
    Descrição: Classificação Nacional de Atividades Econômicas, utilizado para emissão da Nota fiscal Eletrônica
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Não
    • Quant. máx. de caracteres: 7
  • cnae_complementar
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Não
    • Quant. máx. de caracteres: 2
  • rt
    Descrição: Conjunto de leis que regem a tributação do estado.
    Dados técnicos:
    • Tipo de campo: Botão de seleção
    • Campo obrigatório: Sim
    • Valor Padrão: Simples Nacional
    • Valores disponíveis:
      1 = Simples Nacional
      2 = Simples Nacional, excesso sublimite de receita bruta
      3 = Regime Normal
  • ato_anatel
    Descrição: Alteração por Nova Outorga da ANATEL é usado para comprovar que é uma empresa legal
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Não
    • Quant. máx. de caracteres: 100
  • sici_numero_fistel
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Não
    • Quant. máx. de caracteres: 11
    • Máscara: Número 11 dígitos - 99999999999
  • contato
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Não
    • Quant. máx. de caracteres: 100
  • cidade
    Descrição: Relacionado com o campo id da tabela Cidade.
    Dados técnicos:
    • Tipo de campo: Campo de busca avançada
    • Campo obrigatório: Sim
    • Valores disponíveis:
  • bairro
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Sim
    • Quant. máx. de caracteres: 60
  • endereco
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Sim
    • Quant. máx. de caracteres: 200
  • numero
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Sim
    • Quant. máx. de caracteres: 20
  • cep
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Sim
    • Quant. máx. de caracteres: 20
    • Máscara: CEP - 99999-999
  • complemento
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Não
    • Quant. máx. de caracteres: 60
  • latitude
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Não
    • Quant. máx. de caracteres: 50
  • longitude
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Não
    • Quant. máx. de caracteres: 50
  • telefone
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Sim
    • Quant. máx. de caracteres: 20
    • Máscara: Fone - (99) 9999-9999
  • ramal
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Não
    • Quant. máx. de caracteres: 10
  • telefone1
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Não
    • Quant. máx. de caracteres: 20
    • Máscara: Fone - (99) 9999-9999
  • fax
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Não
    • Quant. máx. de caracteres: 20
    • Máscara: Fone - (99) 9999-9999
  • desc_auxiliar_fone_os
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Não
    • Quant. máx. de caracteres: 150
  • facebook
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Não
    • Quant. máx. de caracteres: 300
  • nfe_ambiente
    Dados técnicos:
    • Tipo de campo: Botão de seleção
    • Campo obrigatório: Não
    • Valor Padrão: Homologação
    • Valores disponíveis:
      1 = Produção
      2 = Homologação
  • nfe_formato_imp
    Dados técnicos:
    • Tipo de campo: Botão de seleção
    • Campo obrigatório: Não
    • Valores disponíveis:
      P = Retrato
      L = Paisagem
  • nfe_canhoto
    Dados técnicos:
    • Tipo de campo: Caixa de seleção
    • Campo obrigatório: Não
    • Valor Padrão: S
  • nfe_certificado
    Dados técnicos:
    • Tipo de campo: Arquivo
    • Campo obrigatório: Não
  • nfe_chave
    Dados técnicos:
    • Tipo de campo: Campo de senha
    • Campo obrigatório: Não
  • nfe_inf_complementar
    Dados técnicos:
    • Tipo de campo: Campo de área de texto
    • Campo obrigatório: Não
    • Quant. máx. de caracteres: 2147483647
  • nfce_imprime_produtos
    Dados técnicos:
    • Tipo de campo: Caixa de seleção
    • Campo obrigatório: Não
    • Valor Padrão: S
  • nfce_id_token
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Não
    • Quant. máx. de caracteres: 6
    • Valor Padrão: 000001
  • nfce_csc
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Não
    • Quant. máx. de caracteres: 100
  • nfe_id_email_envio_cliente
    Descrição: Relacionado com o campo id da tabela Mensagem de e-mail.
    Dados técnicos:
    • Tipo de campo: Campo de busca avançada
    • Campo obrigatório: Não
    • Valores disponíveis:
  • nfe_id_envio_email_fornecedor
    Descrição: Relacionado com o campo id da tabela Mensagem de e-mail.
    Dados técnicos:
    • Tipo de campo: Campo de busca avançada
    • Campo obrigatório: Não
    • Valores disponíveis:
  • nfe_envia_pdf_email
    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
  • nfe_envia_xml_email
    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
  • nfse_padrao
    Descrição: Padrão do modelo de integração via XML.
    Dados técnicos:
    • Tipo de campo: Campo de seleção
    • Campo obrigatório: Não
    • Valor Padrão: ABRASF
    • Valores disponíveis:
      ABRASF = ABRASF
      FiscalWeb = FiscalWeb
      Simpliss/GDN = Simpliss/GDN
      Betha = Betha (Fly e-Nota)
      Publica = Pública
      SmarAPD = SmarAPD
      Coplan = Coplan
      DEISS = DEISS
      Boa Nota = Boa Nota
      BHISS = BHISS
      Salvador = Salvador
      Taquara = Taquara
      Vitoria = Vitória
      CampoGrande = Campo Grande
      dourados = Dourados
  • nfse_url_servico
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Não
    • Quant. máx. de caracteres: 250
  • usuario_nfse
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Não
    • Quant. máx. de caracteres: 0
  • nfse_senha_acesso
    Dados técnicos:
    • Tipo de campo: Campo de senha
    • Campo obrigatório: Não
  • nfse_cod_cidade
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Não
    • Quant. máx. de caracteres: 10
  • id_rps_modelo_impressao
    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:
  • opcao_simples
    Dados técnicos:
    • Tipo de campo: Botão de seleção
    • Campo obrigatório: Não
    • Valor Padrão: Não-Optante pelo Simples Nacional
    • Valores disponíveis:
      0 = Não-Optante pelo Simples Nacional
      1 = Optante pelo Simples Nacional (Recolhimento pelo DAS)
  • rt_especial
    Dados técnicos:
    • Tipo de campo: Campo de seleção
    • Campo obrigatório: Não
    • Valor Padrão: Nenhum
    • Valores disponíveis:
      00 = Nenhum
      01 = Microempresa Municipal
      02 = Estimativa
      03 = Sociedade de Profissionais
      04 = Cooperativa
      05 = Microempreendedor Individual (MEI)
      06 = Microempresário e Empresa de Pequeno Porte (ME EPP - Art. 33, inc. II, item 8, Lei nº 691/84)
  • iss_exigibilidade
    Dados técnicos:
    • Tipo de campo: Campo de seleção
    • Campo obrigatório: Não
    • Valores disponíveis:
      1 = Exigivel
      2 = Não Incidência
      3 = Isenção
      4 = Exportação
      5 = Imunidade
      6 = Exigibilidade Suspensa por decisão judicial
      7 = Exigibilidade Suspensa por Processo Administrativo
  • id_filial_isss_exig
    Descrição: Relacionado com o campo id da tabela Cadastro de códigos de exigibilidade ISS.
    Dados técnicos:
    • Tipo de campo: Campo de busca avançada
    • Campo obrigatório: Não
    • Valores disponíveis:
  • insentivo_cultural
    Dados técnicos:
    • Tipo de campo: Botão de seleção
    • Campo obrigatório: Não
    • Valor Padrão: Não
    • Valores disponíveis:
      0 = Não
      1 = Sim
  • insentivo_fiscal
    Dados técnicos:
    • Tipo de campo: Botão de seleção
    • Campo obrigatório: Não
    • Valor Padrão: Não
    • Valores disponíveis:
      2 = Não
      1 = Sim
  • logo_docs
    Descrição: Por padrão o sistema usa o logo cadastrado na empresa, mas e for cadastrado um logo na filial, o sistema vai usar o logo cadastrado na filial para ser impresso nas notas fiscais, recibos, ordem de serviço e todos os relatórios.
    Dados técnicos:
    • Tipo de campo: Arquivo
    • Campo obrigatório: Não
  • img_assinatura
    Descrição: Imagem da assinatura do gerente para imprimir nos contratos
    Dados técnicos:
    • Tipo de campo: Arquivo
    • Campo obrigatório: Não
  • email_suporte
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Não
    • Quant. máx. de caracteres: 50
  • enviar_email_suporte
    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
  • id_filial_doc_opcional
    Descrição: Relacionado com o campo id da tabela Filial.
    Dados técnicos:
    • Tipo de campo: Campo de busca avançada
    • Campo obrigatório: Não
    • Valores disponíveis:
  • envia_email_assinatura_digital_contrato
    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
      P = Padrão
  • smtp_envio_email_assinatura_contrato_digital
    Descrição: Relacionado com o campo id da tabela E-mail SMTP.
    Dados técnicos:
    • Tipo de campo: Campo de busca avançada
    • Campo obrigatório: Não
    • Valores disponíveis:
  • email_envio_contrato_assinado_filial
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Não
    • Quant. máx. de caracteres: 100
  • contador_nome
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Não
    • Quant. máx. de caracteres: 100
  • contador_cnpj
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Não
    • Quant. máx. de caracteres: 30
  • contador_cpf
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Não
    • Quant. máx. de caracteres: 30
  • contador_crc
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Não
    • Quant. máx. de caracteres: 30
  • contador_uf
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Não
    • Quant. máx. de caracteres: 10
  • contador_cep
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Não
    • Quant. máx. de caracteres: 20
    • Máscara: CEP - 99999-999
  • contador_cidade
    Descrição: Relacionado com o campo id da tabela Cidade.
    Dados técnicos:
    • Tipo de campo: Campo de busca avançada
    • Campo obrigatório: Não
    • Valores disponíveis:
  • contador_endereco
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Não
    • Quant. máx. de caracteres: 200
  • contador_numero
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Não
    • Quant. máx. de caracteres: 20
  • contador_complemento
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Não
    • Quant. máx. de caracteres: 60
  • contador_bairro
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Não
    • Quant. máx. de caracteres: 60
  • contador_telefone
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Não
    • Quant. máx. de caracteres: 20
    • Máscara: Fone - (99) 9999-9999
  • contador_fax
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Não
    • Quant. máx. de caracteres: 20
    • Máscara: Fone - (99) 9999-9999
  • contador_email
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Não
    • Quant. máx. de caracteres: 250
  • 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(
        'id_empresa' => '',
        'razao' => '',
        'fantasia' => '',
        'email' => '',
        'site' => '',
        'tipo_pessoa' => 'J',
        'cnpj' => '',
        'im_numero_creci' => '',
        'ie' => '',
        'iest' => '',
        'im' => '',
        'cnae' => '',
        'cnae_complementar' => '',
        'rt' => '1',
        'ato_anatel' => '',
        'sici_numero_fistel' => '',
        'contato' => '',
        'cidade' => '',
        'bairro' => '',
        'endereco' => '',
        'numero' => '',
        'cep' => '',
        'complemento' => '',
        'latitude' => '',
        'longitude' => '',
        'telefone' => '',
        'ramal' => '',
        'telefone1' => '',
        'fax' => '',
        'desc_auxiliar_fone_os' => '',
        'facebook' => '',
        'nfe_ambiente' => '2',
        'nfe_formato_imp' => '',
        'nfe_canhoto' => 'S',
        'nfe_certificado' => '',
        'nfe_chave' => '',
        'nfe_inf_complementar' => '',
        'nfce_imprime_produtos' => 'S',
        'nfce_id_token' => '000001',
        'nfce_csc' => '',
        'nfe_id_email_envio_cliente' => '',
        'nfe_id_envio_email_fornecedor' => '',
        'nfe_envia_pdf_email' => 'S',
        'nfe_envia_xml_email' => 'S',
        'nfse_padrao' => 'ABRASF',
        'nfse_url_servico' => '',
        'usuario_nfse' => '',
        'nfse_senha_acesso' => '',
        'nfse_cod_cidade' => '',
        'id_rps_modelo_impressao' => '',
        'opcao_simples' => '0',
        'rt_especial' => '00',
        'iss_exigibilidade' => '',
        'id_filial_isss_exig' => '',
        'insentivo_cultural' => '0',
        'insentivo_fiscal' => '2',
        'logo_docs' => '',
        'img_assinatura' => '',
        'email_suporte' => '',
        'enviar_email_suporte' => 'N',
        'id_filial_doc_opcional' => '',
        'envia_email_assinatura_digital_contrato' => 'N',
        'smtp_envio_email_assinatura_contrato_digital' => '',
        'email_envio_contrato_assinado_filial' => '',
        'contador_nome' => '',
        'contador_cnpj' => '',
        'contador_cpf' => '',
        'contador_crc' => '',
        'contador_uf' => '',
        'contador_cep' => '',
        'contador_cidade' => '',
        'contador_endereco' => '',
        'contador_numero' => '',
        'contador_complemento' => '',
        'contador_bairro' => '',
        'contador_telefone' => '',
        'contador_fax' => '',
        'contador_email' => ''
    );
    $api->post('filial', $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(
        'id_empresa' => '',
        'razao' => '',
        'fantasia' => '',
        'email' => '',
        'site' => '',
        'tipo_pessoa' => 'J',
        'cnpj' => '',
        'im_numero_creci' => '',
        'ie' => '',
        'iest' => '',
        'im' => '',
        'cnae' => '',
        'cnae_complementar' => '',
        'rt' => '1',
        'ato_anatel' => '',
        'sici_numero_fistel' => '',
        'contato' => '',
        'cidade' => '',
        'bairro' => '',
        'endereco' => '',
        'numero' => '',
        'cep' => '',
        'complemento' => '',
        'latitude' => '',
        'longitude' => '',
        'telefone' => '',
        'ramal' => '',
        'telefone1' => '',
        'fax' => '',
        'desc_auxiliar_fone_os' => '',
        'facebook' => '',
        'nfe_ambiente' => '2',
        'nfe_formato_imp' => '',
        'nfe_canhoto' => 'S',
        'nfe_certificado' => '',
        'nfe_chave' => '',
        'nfe_inf_complementar' => '',
        'nfce_imprime_produtos' => 'S',
        'nfce_id_token' => '000001',
        'nfce_csc' => '',
        'nfe_id_email_envio_cliente' => '',
        'nfe_id_envio_email_fornecedor' => '',
        'nfe_envia_pdf_email' => 'S',
        'nfe_envia_xml_email' => 'S',
        'nfse_padrao' => 'ABRASF',
        'nfse_url_servico' => '',
        'usuario_nfse' => '',
        'nfse_senha_acesso' => '',
        'nfse_cod_cidade' => '',
        'id_rps_modelo_impressao' => '',
        'opcao_simples' => '0',
        'rt_especial' => '00',
        'iss_exigibilidade' => '',
        'id_filial_isss_exig' => '',
        'insentivo_cultural' => '0',
        'insentivo_fiscal' => '2',
        'logo_docs' => '',
        'img_assinatura' => '',
        'email_suporte' => '',
        'enviar_email_suporte' => 'N',
        'id_filial_doc_opcional' => '',
        'envia_email_assinatura_digital_contrato' => 'N',
        'smtp_envio_email_assinatura_contrato_digital' => '',
        'email_envio_contrato_assinado_filial' => '',
        'contador_nome' => '',
        'contador_cnpj' => '',
        'contador_cpf' => '',
        'contador_crc' => '',
        'contador_uf' => '',
        'contador_cep' => '',
        'contador_cidade' => '',
        'contador_endereco' => '',
        'contador_numero' => '',
        'contador_complemento' => '',
        'contador_bairro' => '',
        'contador_telefone' => '',
        'contador_fax' => '',
        'contador_email' => ''
    );
    $registro = '1';//registro a ser editado
    $api->put('filial', $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('filial', $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' => 'filial.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' => 'filial.id',//campo para ordenar a consulta
        'sortorder' => 'desc'//ordenação (asc= crescente | desc=decrescente)
    );
    $api->get('filial', $params);
    $retorno = $api->getRespostaConteudo(false);// false para json | true para array