Linha Microsiga Protheus - Espanhol

Atalhos

Árvore de páginas

Versões comparadas

Versão antiga 1

changes.mady.by.user Rafael Fernando Villanueva Alegre

Gravado em

comparado com

Nova versão 2

changes.mady.by.user Rafael Fernando Villanueva Alegre

Gravado em

Chave

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

Índice

01. VISÃO GERAL

Retornar uma lista de títulos com base nos filtros encaminhados.

02. ENDPOINT

Método utilizado: GET

Documentos a receber: /api/gfin/v1/ReceivableDocuments

Documentos a pagar: /api/gfin/v1/PayableDocuments

03. PARÂMETROS DA REQUISIÇÃO

Query parameters:

Atributo

Tipo

Descrição

Padrão

pagenumericnúmero da página1
pagesizenumerictamanho da página10
filtercharacter(opcional) filtros no padrão oData-
allfieldslogical(opcional) retornar todos os campos da tabelasfalse
fieldscharacteradiciona campos para o retornor-

Exemplo:
queryParam

/api/gfin/v1/ReceivableDocuments?pagesize=10&page=1&allfields=true
 
/api/gfin/v1/ReceivableDocuments?pagesize=10&page=1&fields=e1_hist,e1_numbor
 
/api/gfin/v1/ReceivableDocuments?filter=(E1_NUM eq '000000229' or E1_NUM eq '000000230') and F75_SALDO gt 4000

04. RESPOSTA DA API

Objeto Json

Atributo

Tipo

Descrição

itemsArraylista de documentos
hasnextLogicaltrue se existir próxima página
structArraystruct dos campos retornados


Exemplo:
response

{
    "items": [
        {
            "e1_parcela": "",
            "f75_multa": 0,
            "f75_juros": 0,
            "f75_txmoed": 0,
            "e1_filial": "D MG 01",
            "f75_abatim": 0,
            "e1_prefixo": "",
            "e1_tipo": "NF",
            "e1_vencrea": "2017-12-3",
            "f75_vlva": 0,
            "f75_saldo": 0,
            "f75_fluxo": "",
            "e1_loja": "01",
            "e1_valor": 100,
            "e1_sdacres": 0,
            "e1_moeda": 1,
            "e1_sddecre": 0,
            "f75_vltit": 0,
            "e1_naturez": "0000000001",
            "e1_emissao": "2017-12-3",
            "e1_saldo": 0,
            "e1_cliente": "000012",
            "e1_num": "000000001"
        }
    ],
    "hasNext": true,
    "struct": [
        {
            "field": "E1_FILIAL",
            "type": "C",
            "title": "Filial      "
        },
        {
            "field": "E1_PREFIXO",
            "type": "C",
            "title": "Prefixo     "
        },
        {
            "field": "E1_NUM",
            "type": "C",
            "title": "No. Titulo  "
        },
        {
            "field": "E1_PARCELA",
            "type": "C",
            "title": "Parcela     "
        },
        {
            "field": "E1_TIPO",
            "type": "C",
            "title": "Tipo        "
        },
        {
            "field": "E1_CLIENTE",
            "type": "C",
            "title": "Cliente     "
        },
        {
            "field": "E1_LOJA",
            "type": "C",
            "title": "Loja        "
        },
        {
            "field": "E1_EMISSAO",
            "type": "D",
            "title": "DT Emissao  "
        },
        {
            "field": "E1_VENCREA",
            "type": "D",
            "title": "Vencto real "
        },
        {
            "field": "E1_NATUREZ",
            "type": "C",
            "title": "Natureza    "
        },
        {
            "field": "E1_VALOR",
            "type": "N",
            "title": "Vlr.Titulo  "
        },
        {
            "field": "E1_SALDO",
            "type": "N",
            "title": "Saldo       "
        },
        {
            "field": "E1_SDACRES",
            "type": "N",
            "title": "Sld.Acresc. "
        },
        {
            "field": "E1_SDDECRE",
            "type": "N",
            "title": "Sld.Decresc."
        },
        {
            "field": "E1_MOEDA",
            "type": "N",
            "title": "Moeda       "
        },
        {
            "field": "F75_TXMOED",
            "type": "N",
            "title": "Taxa moeda  "
        },
        {
            "field": "F75_ABATIM",
            "type": "N",
            "title": "Abatimentos "
        },
        {
            "field": "F75_VLVA",
            "type": "N",
            "title": "VL acessorio"
        },
        {
            "field": "F75_MULTA",
            "type": "N",
            "title": "Multa       "
        },
        {
            "field": "F75_JUROS",
            "type": "N",
            "title": "Juros       "
        },
        {
            "field": "F75_SALDO",
            "type": "N",
            "title": "Saldo       "
        },
        {
            "field": "F75_VLTIT",
            "type": "N",
            "title": "Saldo       "
        },
        {
            "field": "F75_FLUXO",
            "type": "C",
            "title": "Fluxo caixa "
        }
    ]
}