Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Índice

1. Informações Gerais (recurso ainda não disponível)


Especificação

Produto

 Totvs Automoção Fiscal

Módulo

 SIGATAF

Segmento Executor

 Serviços

Projeto

TAF - THF

IRM


Requisito


Subtarefa


...

Deve suportar filtrar os resultados de acordo com alguns parâmetros:

    • searchKey: Filtro chave, capaz de filtrar em diversos campos diferentes do contrato, como cliente ou fornecedor, número, descrição, etc (máximo de lugares possíveis).
    • _type: Tipo de contrato, indica se é um contrato de compra (_type="1") ou de venda (_type="2"). Caso não seja informado, retornar todos os tipos.
    • customer: Cliente relacionado ao contrato. Deve ser considerado apenas se o parâmetro _type for enviado com o valor "2" (venda).
    • supplier: Fornecedor relacionado ao contrato. Deve ser considerado apenas se o parâmetro _type for enviado com o valor "1" (compra).
    • unit: Loja do cliente ou do fornecedor relacionado ao contrato. Deve ser considerado apenas se o parâmetro customer ou supplier for enviado em conjunto.
    • expiring: Indicador de contratos à vencer. Se for true: retornar apenas os contratos próximos do vencimento. Se for false ou não for enviado, retornar todos.
    • status: indica a situação atual do contrato. O parâmetro aceita os seguintes valores:
      • 0 - Todos os contratos, com exceção dos revisados e em revisão;
      • 1 - Contratos vigentes (Valor Default);
      • 2 - Contratos em elaboração;
      • 3 - Contratos aguardando aprovação;
      • 4 - Contratos paralisados;
      • 5 - Contratos em reajuste;
      • 6 - Contratos vencidos;
      • 7 - Contratos a vencer em 30 dias;
      • 8 - Todos os contratos com exceção dos revisados;

...

    • sourceBranch: Código Identificador da filial do ERP emissor. Deve existe em C1E_CODFIL
    • period: Período desejado para a consulta.
    • status: Array do tipo numérico que contem o status desejado para a consulta. 1 - Todos, 2 - Pendente apuração, 3 - Apurados, 4 - Pendentes transmissão, 5 - Retorno com erros, 6 - Transmitidos, 7 - Aguardando retorno, 8 - Retorno com erros, 9 - Sem pendências .
    • events: Array do tipo string contendo os eventos a serem consultados. Ex: {"R-2010", "R-2020"}  para consultar apenas R-2010 e R-2020, Ex: {totds} para retornar todos os eventos.
    • eventType: Array do tipo numérico contendo  os tipos dos eventos que devem ser retornados. Ex: {1,2, 3, 4}. 1 - Todos, 2 - Tabelas, 3 - Periódicos, 4 - Não Periódicos, 5 - Totalizadores.
    • page: Indica o numero da pagina desejada, este parâmetro trabalha em conjunto com pageSize.
    • pageSize: Quantidade de registros que a pagina deve conter, este parâmetro trabalha cem conjunto com page.