Reporting API v1/v2- invoice custom charges

Introduction

This article provides an overview of Invoice Custom Charges in the Reporting API. It explains how to access key details about corrections made to invoices within the Platform.

In this article:

• Affected endpoints
• Custom Charges related fields

Affected endpoints

The following endpoints are used to retrieve information related to Invoice Custom Charges:

1. GET invoice-headers
GET api/v1/reporting/invoices/invoice-headers/requesterId?sasKey=sasKey

2. GET invoice-headers/preview

GET api/v1/reporting/invoices/invoice-headers/requesterId/preview?sasKey=sasKey

3. GET invoice-rows

GET api/v1/reporting/invoices/invoice-rows/requesterId?sasKey=sasKey

4. GET invoice-rows/preview

GET api/v1/reporting/invoices/invoice-headers/requesterId/preview?sasKey=sasKey

The Custom Charges related fields are available in both Reporting API collections:

1. Appxite Reporting API v1
2. Appxite Reporting API v2

Custom Charges related fields

The visibility of Custom Charges details depends on the status of the related invoice:

1. New Corrected Status
When an invoice is in the "New Corrected" status, the details will only be visible via the GET invoice-headers/preview endpoint.

If Custom Charges are applied, the response will display the following fields:

• StatusId = 6
• Status = New Corrected
• InvoiceSourceId = 4
• InvoiceSource = Custom

2. Verified Status
Once the invoice with Custom Charges is in the "Verified" status, the following fields will be visible in the GET invoice-headers endpoint:

• StatusId = 1
• Status = Verified
• InvoiceSourceId =4
• InvoiceSource = Custom

Each invoice header generates multiple invoice rows. The GET invoice-rows and GET invoice-rows/preview endpoints will display details of these rows, including the following fields related to Custom Charges:

• CustomChargeDetails
• ChargeType = UserCorrection

NOTE! Custom Charges may or may not be tied to a specific subscription. If Custom Charges are applied at the general customer level (rather than to a specific subscription), the information will appear with the hardcoded value subscriptionName = Default Subscription.


 

Related Content

• Reporting API - Overview
• Reporting API - Data Model
• Reporting API : Preview invoices in status 'New'
  
• Appxite Reporting API v1
  
• Appxite Reporting API v2
• Custom Invoice Feature Overview