Linha Microsiga Protheus

Árvore de páginas

Versões comparadas

Versão antiga 1

changes.mady.by.user Leonardo Pacheco Fuga

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Leonardo Pacheco Fuga

Gravado em

Chave

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

...

Linha de Produto:TOTVS RENTAL
Segmento:Serviços
Módulo:SIGALOC
Função:

LOCW042NF

Ticket:Não há.
Story:

DSERLOCA-9274

02. SITUAÇÃO/REQUISITO

Criar API do Tipo Post (Regra tipo API Sync) para listar as notas fiscais de acordo com os parâmetros informadosAPI síncrona do tipo POST para listagem de Notas Fiscais de Saída no TOTVS Protheus (Linha Microsiga), permitindo filtros por empresa, período de emissão e cliente.

03. SOLUÇÃO

Foi A API foi criada a API no seguinte end pointendpoint:

/locw042NF


Parâmetros de entrada:

                 Parâmetros de entrada para Retornar

    • cnpj_empresa- Empresa logada no aplicativo - SIGAMAT
    • emissaoi - emissão inicial da nota fiscal de saída (F2_EMISSAO) a ser filtrado na query
    • emissaof - emissão final da nota fiscal de saída (F2_EMISSAO) a ser filtrado na query
    • cliente - Código do cliente a ser filtrado na query
    • loja - Loja do cliente a ser filtrado na query


Obrigatórios:

    • cnpj_empresa
    • emissaoi
    • emissaof
    • cliente
    • loja

                

                  Parâmetros de entrada para retornar as notas fiscais de saída              


Campo

Obrigatório

Descrição




cnpj_empresa

...

Sim

CNPJ da empresa conectada ao aplicativo (SIGAMAT).

emissaoi

Sim

Data inicial de emissão da nota fiscal

...

(F2_EMISSAO)

...

, no formato

...

yyyymmdd

emissaof

...

Sim

Data final de emissão

...

da nota fiscal

...

(F2_EMISSAO)

...

, no formato

...

yyyymmdd

cliente

...

Sim

Código do cliente

...

para filtro.

loja

...

Sim

Loja

...

do cliente para filtro.

aprova

Não

Status de aprovação: A = aprovado, R = reprovado. Em branco retorna todos.


Exemplo

...

                           exemplo de payload a ser informado:


Request:


Para execução da Query

{"cnpj_empresa":"99999999999999",
    "emissaoi":"20251201",
    "emissaof":"20251231",
    "cliente":"999999",
    "loja":"99"
}




...

retorno

{
    "retorno": "ok",
    "conteudo": {
        "SF2": [
            {
                "F2_DOC": "000393   ",
                "F2_SERIE": "1  ",
                "F2_CLIENTE": "000094",
                "F2_LOJA": "01",
                "F2_COND": "000",
                "F2_EMISSAO": "20231019",
                "F2_VALBRUT": 1000,
                "F2_STATUS": "total",
                "FPY": [
                    {
                        "FPY_FILIAL": "D MG 01 ",
                        "FPY_CLIENT": "      ",
                        "FPY_LOJA": "  ",
                        "FPY_DATA": "        ",
                        "FPY_PROJET": "202300107             ",
                        "FPY_PEDVEN": "pcpBB9",
                        "FPY_TIPFAT": "R",
                        "FPY_OBRA": "   "
                    },
                    {
                        "FPY_FILIAL": "D MG 01 ",
                        "FPY_CLIENT": "      ",
                        "FPY_LOJA": "  ",
                        "FPY_DATA": "        ",
                        "FPY_PROJET": "202300109             ",
                        "FPY_PEDVEN": "pcpBBF",
                        "FPY_TIPFAT": "R",
                        "FPY_OBRA": "   "
                    }
                ],
                "SE1": []
            },
            {
                "F2_DOC": "000394   ",
                "F2_SERIE": "1  ",
                "F2_CLIENTE": "000094",
                "F2_LOJA": "01",
                "F2_COND": "000",
                "F2_EMISSAO": "20231019",
                "F2_VALBRUT": 1000,
                "F2_STATUS": "atrasado",
                "FPY": [
                    {
                        "FPY_FILIAL": "D MG 01 ",
                        "FPY_CLIENT": "      ",
                        "FPY_LOJA": "  ",
                        "FPY_DATA": "        ",
                        "FPY_PROJET": "202300107             ",
                        "FPY_PEDVEN": "pcpBB9",
                        "FPY_TIPFAT": "R",
                        "FPY_OBRA": "   "
                    },
                    {
                        "FPY_FILIAL": "D MG 01 ",
                        "FPY_CLIENT": "      ",
                        "FPY_LOJA": "  ",
                        "FPY_DATA": "        ",
                        "FPY_PROJET": "202300109             ",
                        "FPY_PEDVEN": "pcpBBF",
                        "FPY_TIPFAT": "R",
                        "FPY_OBRA": "   "
                    }
                ],
                "SE1": []
            }
        ]
    }
}


04. DEMAIS INFORMAÇÕES

...

  • A API é síncrona.

  • Datas devem sempre ser informadas no padrão yyyymmdd.

  • Retornos vazios indicam que não há notas no período ou filtro informado.

05. ASSUNTOS RELACIONADOS

Apps RENTAL

...