Modus Server¶
- Índice
- Modus Server
Documentação dos end-points disponíveis na API do sistema.
A documentação completa, com exemplos de chamada e retorno, é disponibilizada através do link gerado pela ferramenta Postman.
Services¶
End-point para atendimento de serviços dos sistemas Modus. Inclui o envio de e-mail e emissão de relatórios.
Os principais serviços são /modus/email e /modus/report.
Macros para tratamento de datas em relatórios¶
Para viabilizar e facilitar o agendamento de serviços, principalmente relatórios, foram disponibilizadas macros (ou tags) que facilitam o tratamento de datas dinâmicas como parâmetro de entrada em relatórios.
Estas macros são expressões simples, expandidas no momento da emissão do relatório.
As macros disponíveis são:
Parâmetro BaseDate¶
Parâmetro especial - não repassado ao Report - utilizado para especificar uma data base de retorno para outras datas. Se presente, será processado primeiro.
Pode ser utilizado qualquer outra macro de data presente, por exemplo $F(Date) ou $F(StartOfMonth). Neste caso, o retorno será com base na data atual.
Os demais parâmetros que utilizam data serão baseados no resultado armazenado em BaseDate.
POST /modus/report/pdf
{ "report_id": "VEN010",
"params": {
"codemp": "1",
"codfil": "1",
"BaseDate": "$F(StartOfMonth)-1", "OBSERVAÇÃO: Ultimo Dia do Mês anterior - Será usado como data base em todas as outras macros"
"datemi": "$F(Date)-30,$F(Date)" "OBSERVAÇÃO: Data de emissão - Ultimo dia do mês anterior - 30 até Ultimo dia do mês anterior"
"datprv": "$F(StartOfMonth),$F(EndOfMonth)", "OBSERVAÇÃO: Primeiro dia do mês anterior até Ultimo dia do mês anterior"
}
}
$F(Date)¶
Data atual ou BaseDate. Utilizado para parametrizar relatórios com datas relativas à data atual (ou a data informada em BaseDate). Aceita expressão matemática de adição e subtração.
POST /modus/report/pdf
{ "report_id": "VEN010",
"params": {
"codemp": "1",
"codfil": "1",
"datemi": "$F(Date)-30,$F(Date)" "OBSERVAÇÃO: Data de emissão"
}
}
O parâmetro DatEmi acima gerará uma entrada no relatório de intervalo de datas entre a data atual menos 30 dias e a data atual. O relatório deve prever o recebimento do parâmetro no formato passado.
$F(StartOfWeek) e $F(EndOfWeek)¶
Data de início e fim da semana, com base na data atual ou em BaseDate. Utilizado para parametrizar relatórios com datas e aceita expressão matemática de adição e subtração.
StartOfWeek refere-se à domingo, e EndOfWeek refere-se à sábado.
POST /modus/report/pdf
{ "report_id": "VEN010",
"params": {
"codemp": "1",
"codfil": "1",
"datemi": "$F(StartOfWeek),$F(EndOfWeek)" "OBSERVAÇÃO: Data de emissão"
}
}
O parâmetro DatEmi acima gerará uma entrada no relatório de intervalo de datas entre o início e fim da semana corrente. O relatório deve prever o recebimento do parâmetro no formato passado.
$F(StartOfMonth) e $F(EndOfMonth)¶
Data de início e fim do mês, com base na data atual ou em BaseDate. Utilizado para parametrizar relatórios com datas e aceita expressão matemática de adição e subtração.
POST /modus/report/pdf
{ "report_id": "VEN010",
"params": {
"codemp": "1",
"codfil": "1",
"datemi": "$F(StartOfMonth),$F(EndOfMonth)" "OBSERVAÇÃO: Data de emissão"
}
}
O parâmetro DatEmi acima gerará uma entrada no relatório de intervalo de datas entre o início e fim do mês corrente. O relatório deve prever o recebimento do parâmetro no formato passado.
$F(StartOfYear) e $F(EndOfYear)¶
Data de início e fim do ano, com base na data atual ou em BaseDate. Utilizado para parametrizar relatórios com datas e aceita expressão matemática de adição e subtração.
POST /modus/report/pdf
{ "report_id": "VEN010",
"params": {
"codemp": "1",
"codfil": "1",
"datemi": "$F(StartOfYear),$F(EndOfYear)" "OBSERVAÇÃO: Data de emissão"
}
}
O parâmetro DatEmi acima gerará uma entrada no relatório de intervalo de datas entre o início e fim do ano corrente. O relatório deve prever o recebimento do parâmetro no formato passado.
