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

Versões comparadas

Chave

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

NGF - Customer Panel - Endpoint InvoiceProducts

  Draft

01. OVERVIEW

Returns the invoice products.

02. ENDPOINT

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

03. REQUEST PARAMETERS

Body parameters:

Attribute

Type

Description

Default

customerId

Character

Customer code

-

storeId

Character

Customer store

-

branchId

Array

Invoice branch

-

invoiceNumber

Character

invoice number

-

serie

Character

invoice series

-

Example:

body

body = {
    branchId
    

branchId: "D MG 01 ",
    invoiceNumber
  

invoiceNumber: "000000001",
    serie
   

serie: "004",
    customerId
    

customerId: "CLI003",
    storeId
   

storeId: "01"

}

04. API RESPONSE

Json Object

Attribute

Type

Description

Attribute

Type

Description

items

Array

list of invoices

hasNext

Logical

true if there is a next page

Field list:

Attribute

Description

productAmount

quantity of the product

productTotal

Total value

productItem

Invoice Item

productDescription

Product Description

productUnit

Unit Value

Example: response

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="14ac92db-3def-49ed-b157-b2fcdcae959b"><ac:plain-text-body><![CDATA[

{    items: [        {            productAmount: 10,            productTotal: 10,            productItem
{   
items: [       
  {            
productAmount: 10,            

productTotal: 10,            

productItem: "01",
            productDescription
            

productDescription: "RAW MATERIAL",
            productUnit: 1        }    ],    hasNext: false}]]></ac:plain-text-body></ac:structured-macro>
            

productUnit: 1        
}    
],    
hasNext: false
}