Páginas filhas
  • NGF - Customer Panel - Endpoint Invoices

01. OVERVIEW

Returns a customer's invoices.

02. ENDPOINT

Method used: POST
Invoices: /api/tfc/v1/CustomerFinancialTransactions/Invoices

03. REQUEST PARAMETERS

Body parameters:

Attribute

Type

Description

Default

customerId

Character

Customer code

-

storeId

Character

Customer store

-

filter

Array

filter array [field, operator, value] 

filter array [field, operator, value] 

branchId

Array

system branches to be considered in the query

-

Example: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. API RESPONSE

Json Object

Attribute

Type

Description

items

Array

list of invoices

hasNext

Logical

true if there is a next page

Field list:

Attribute

Description

invoiceNumber

Number of the document

invoiceSerie

Document Series

invoiceValue

valor

invoiceCurrency

moeda

invoiceBranch

source branch

issueDate

data

Example: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
}
  • Sem rótulos