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

Retorna as notas fiscais de um cliente

02. ENDPOINT

O método utilizado: POST

Invoices: /api/tfc/v1/CustomerFinancialTransactions/Invoices

03. PARÂMETROS DA REQUISIÇÃO

Parâmetros do body:

Atributo

Tipo

Descrição

Padrão

customerIdCharactercódigo do cliente-
storeIdCharacter

loja do cliente

-
filterArrayarray de filter [campo, operado, valor] -
branchIdArrayfiliais do sistema para considerar na consulta-

Exemplo:
body

body = {
    customerId: "FAT001",
    storeId: "01",
    branchId: ["D MG 01 ", "D MG 02"],
    filter: [
                ["issueDate", "ge", "2016-06-01"],
                ["issueDate", "le", "2016-06-30"]
            ]
    }

04. RESPOSTA DA API

Objeto Json

Atributo

Tipo

Descrição

itemsArraylista de notas
hasNextLogicaltrue se existir próxima página

Lista de campos:

Atributo

Descrição

Atributo

Descrição

invoiceNumbernúmero do documento
invoiceSerieserie do documento
invoiceValuevalor
invoiceCurrencymoeda
invoiceBranchfilial de origem
issueDatedata

Exemplo:
response

{
    items: [
        {
            invoiceNumber: "000758   ",
            invoiceSerie: "1  ",
            invoiceValue: 100,
            issueDate: "2016/04/25",
            invoiceBranch: "D MG 01 ",
            invoiceCurrency: 1
        },
        {
            invoiceNumber: "000759   ",
            invoiceSerie: "1  ",
            invoiceValue: 101,
            issueDate: "2016/04/25",
            invoiceBranch: "D MG 01 ",
            invoiceCurrency: 1
        }
    ],
    hasNext: false
}