Reporting API v1 - preview invoices in status 'New'

Appxite Updated by Appxite

Introduction

We are pleased to introduce new Reporting API feature, which will help for Distributors and Direct Resellers to Preview their Incoming and Outgoing invoices in Status "New" through API. 

In this article:

Preview endpoints

In Status "New"  Distributors  will be able to Preview their incoming invoices from Vendors and their outgoing invoices for 2tier Resellers and Direct End Customers, similar Direct Resellers will be able to Preview their incoming invoices from Vendors and their outgoing invoices for End Customers before doing approval ( Verification ) of Invoices.

In order to get Invoices in Status "New", user should run queries bellow:

invoice-headers/preview

https://api.telemetry.appxite.com:8449/api/v1/reporting/api/v1/reporting/invoices/invoice-headers/{requesterId}/preview

invoice-rows/preview

https://api.telemetry.appxite.com:8449/api/v1/reporting/api/v1/reporting/invoices/invoice-rows/{requesterId}/preview

Replace the requesterId with your Organization ID.

To view detailed documentation please visit the Postman collection here: Postman Collection

Direct vs Indirect chain

From API above user should receive an information about (considering 1 subscription in response):

1) Indirect chain

     As Distributor invoicing 2tier Reseller, user will receive 2 invoices in Status "New" :

  •  invoice  between Vendor and Distributor
  •  invoice between Distributor and 2tier Reseller

     As Distributor invoicing directly End Customer, user will get 2 invoices with Status "New":

  •  invoice  between Vendor and Distributor
  •  invoice between Distributor and End Customer

2) Direct chain

     As Direct Reseller invoicing End Customer, user will receive 2 invoices with Status "New":

  •  invoice  between Vendor and Direct Reseller
  •  invoice between Direct Reseller and End Customer
In case 2tier Reseller or End Customer will run these queries, they will get 0 invoices. As Distributor and Direct Reseller provides invoices for them.

Summary

Distributors and Direct Resellers can preview their incoming and outgoing Invoices in "New" status through new Reporting API preview endpoints before Invoice approval. Use the invoice-headers/preview and invoice-rows/preview endpoints with your Organization ID to retrieve these Invoices. In an indirect chain, Distributors receive two Invoices: one between vendor and Distributor, and one between Distributor and either 2-tier Reseller or End Customer. In a direct chain, Direct Resellers receive two Invoices: one between vendor and Direct Reseller, and one between Direct Reseller and End Customer. Note that 2-tier Resellers and End Customers will receive zero Invoices when running these queries, as their Invoices are provided by Distributors or Direct Resellers.

Reporting API Preview invoices API invoices rw_v1

Was this article helpful?

0 out of 0 found this helpful

Articles in this section

Add comment

Please sign in to leave a comment.