Linha Microsiga Protheus

Árvore de páginas

01. DADOS GERAIS

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 informados.

03. SOLUÇÃO

Foi criada a API no seguinte end point: /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
    • aprova = A-Aprovado, R=Reprovado, em branco todos.

Obrigatórios:

    • cnpj_empresa
    • emissaoi
    • emissaof
    • cliente
    • loja

                

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

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

                           exemplo de payload a ser informado:


Request:


Para execução da Query

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





Retorno esperado:
Response:

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

N/A

05. ASSUNTOS RELACIONADOS

Apps RENTAL




  • Sem rótulos