Linha Microsiga Protheus - Inglês

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

Versões comparadas

Versão antiga 1

changes.mady.by.user Thayna de Souza Moreira

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Thayna de Souza Moreira

Gravado em

Chave

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

NGF - Customer Panel - Endpoint Invoices

  Draft

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

-

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="325f10b3-e340-4980-b691-8fa5921194ab"><ac:plain-text-body><![CDATA[

filter

Array

filter array [field, operator, value] 

-

]]></ac:plain-text-body></ac:structured-macro>

filter array [field, operator, value] 

branchId

Array

system branches to be considered in the query

-

Example:body

body = {    

    customerId

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="a277b2a4-6550-4fb2-9074-3766fd4e16ef"><ac:plain-text-body><![CDATA[

body = {    customerId
: "FAT001",
    storeId
    

    storeId: "01",
    branchId: 
    

    branchId: ["D MG 01 ", "D MG 02"],
    filter: [                
   

    filter: [                

                ["issueDate", "ge", "2016-06-01"],                

                ["issueDate", "le", "2016-06-30"]
            ]    }

]]></ac:plain-text-body></ac:structured-macro>

           

            ]    

        }

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

...

Attribute

Description

invoiceNumber

Number of the document

invoiceSerie

Document Series

invoiceValue

valor

invoiceCurrency

moeda

invoiceBranch

source branch

issueDate

data

Example:response

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="9ea0eca5-2a70-4049-81b3-cadb58f61b27"><ac:plain-text-body><![CDATA[

{    items: [        {
{
    items: [
        {
            invoiceNumber: "000758   ",
            invoiceSerie: "1  ",
            invoiceValue: 100,
            issueDate: "2016/04/25",
            invoiceBranch: "D MG 01 ",
            invoiceCurrency:
1        
 1
        },
        {
            invoiceNumber: "000759   ",
            invoiceSerie: "1  ",
            invoiceValue: 101,
            issueDate: "2016/04/25",
            invoiceBranch: "D MG 01 ",
            invoiceCurrency:
1        
 1
        }
    ],
    hasNext: false
}]]></ac:plain-text-body></ac:structured-macro>

}