NGF - FINA710 - Endpoint ReceivableDocuments and PayableDocuments

page

numeric

page number

1

pagesize

numeric

page size

10

filter

character

(optional) filters in oData pattern

-

allfields

logical

(optional) return all fields from the tables

false

fields

character

add fields to the return

-

/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

items

Array

list of documents

hasnext

Logical

true if there is a next page

struct

Array

struct of the returned fields

{
    "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": "Prefix     "
        },
        {
            "field": "E1_NUM",
            "type": "C",
            "title": "Bill no. "
        },
        {
            "field": "E1_PARCELA",
            "type": "C",
            "title": "Installment "
        },
        {
            "field": "E1_TIPO",
            "type": "C",
            "title": "Type        "
        },
        {
            "field": "E1_CLIENTE",
            "type": "C",
            "title": "Customer    "
        },
        {
            "field": "E1_LOJA",
            "type": "C",
            "title": "Store       "
        },
        {
            "field": "E1_EMISSAO",
            "type": "D",
            "title": "Issue Dt  "
        },
        {
            "field": "E1_VENCREA",
            "type": "D",
            "title": "Actual due date "
        },
        {
            "field": "E1_NATUREZ",
            "type": "C",
            "title": "Nature    "
        },
        {
            "field": "E1_VALOR",
            "type": "N",
            "title": "Bill Vl.  "
        },
        {
            "field": "E1_SALDO",
            "type": "N",
            "title": "Balance     "
        },
        {
            "field": "E1_SDACRES",
            "type": "N",
            "title": "Increas.Bal. "
        },
        {
            "field": "E1_SDDECRE",
            "type": "N",
            "title": "Decreas.Bal."
        },
        {
            "field": "E1_MOEDA",
            "type": "N",
            "title": "Currency    "
        },
        {
            "field": "F75_TXMOED",
            "type": "N",
            "title": "Currency rate"
        },
        {
            "field": "F75_ABATIM",
            "type": "N",
            "title": "Discounts "
        },
        {
            "field": "F75_VLVA",
            "type": "N",
            "title": "Accessory vl"
        },
        {
            "field": "F75_MULTA",
            "type": "N",
            "title": "Fine       "
        },
        {
            "field": "F75_JUROS",
            "type": "N",
            "title": "Interest    "
        },
        {
            "field": "F75_SALDO",
            "type": "N",
            "title": "Balance     "
        },
        {
            "field": "F75_VLTIT",
            "type": "N",
            "title": "Balance     "
        },
        {
            "field": "F75_FLUXO",
            "type": "C",
            "title": "Cash flow "
        }
    ]
}