Reporting API

The Reporting API is a set of API endpoints that are built with the primary purpose of supporting self-service reporting.

Please reach out to support@appxite.com if you would like to learn more or get access to it.

Reporting API scope

Currently, the reporting API covers the following areas:  invoicing, subscriptions, and orders, offers and products, organizations, and currency exchange rates.

Invoice details:

/invoices/invoice-headers

/invoices/invoice-rows

Subscriptions, orders, offers and products:

/subscriptions

/subscription-events

/offers

/offers/properties

/orders

/orders/items

Organizations, additional info, and organization relations:

/organizations

/organizations/contacts

/organizations/addresses

/organizations/details

/contracts

/tenants/details

Default currency exchange rates:

/currency-rates

For more information, please refer to the Postman collection.

Sample data model

This is a general overview of how the tables relate to one another. Depending on the report or integration needs, you may apply different relations, as the same dimensions can be joined to multiple tables.

mceclip0.png

Mapping to invoice recon file

Most of the key values from the invoice recon file can be mapped to the Reporting API. Please see the mapping below.

Recon file column

API endpoint

Column

Invoice number

/invoices/invoice-headers

invoiceNumber

Invoice Status

/invoices/invoice-headers

invoiceStatus

Invoice date

/invoices/invoice-headers

invoiceDate

Invoice provider

/invoices/invoice-headers

providerName

Invoice receiver

/invoices/invoice-headers

consumerName

Receiver status

/organizations or /organizations/details

status

Receiver ERP ID

/organizations/details

erpId

Receiver country

/organizations/addresses

country

Receiver VAT number

/organizations/details

vatNumber

Contract number

n/a

n/a

Contract reference number

n/a

n/a

Reference contact person

/organizations/contacts

firstName + lastName

Billing address

/organizations/addresses

 

Account manager

/organizations/contacts

firstName + lastName

Account manager email

/organizations/contacts

firstName + lastName

Comments

n/a

n/a

Reseller name

/organizations or /organizations/details

fullName / shortName

Customer name

/organizations or /organizations/details

fullName / shortName

Offer name

/invoices/invoice-rows

offerName

Subscription name

/invoices/invoice-rows

subscriptionName

Subscription start date

/subscriptions

startDate

Subscription end date

/subscriptions

endDate

Charge start date

/invoices/invoice-rows

chargeStartDate

Charge end date

/invoices/invoice-rows

chargeEndDate

Charge type

/invoices/invoice-rows

chargeType

Currency

/invoices/invoice-rows

currency

Customer Unit price

/invoices/invoice-rows (where invoice receiver = customer)

unitPrice

Customer quantity

/invoices/invoice-rows (where invoice receiver = customer)

quantity

Customer total price

/invoices/invoice-rows (where invoice receiver = customer)

totalPrice

Vendor

/subscriptions

vendorName

Reseller Unit Price

/invoices/invoice-rows (where invoice receiver = reseller)

unitPrice

Reseller Total Price

/invoices/invoice-rows (where invoice receiver = reseller)

quantity

Reseller Currency

/invoices/invoice-rows (where invoice receiver = reseller)

totalPrice

Support Currency

n/a

n/a

Support Total Price

n/a

n/a

Retail Price Source

n/a

n/a

Retail Price Markup

n/a

n/a

Customer Markup

n/a

n/a

Price Markup Start Date

n/a

n/a

Invoice Provider Id

/invoices/invoice-headers

providerOrganizationId

Invoice Receiver Id

/invoices/invoice-headers

consumerOrganizationId

Reseller Id

/subscriptions

resellerOrganizationId

Customer Id

/subscriptions

customerOrganizationId

Offer Id

/subscriptions

offerId

Vendor Offer Id

/offers

offerExternalId

Subscription Id

/invoices/invoice-rows

subscriptionId

Vendor Subscription Id

/subscriptions

subscriptionExternalId

Custom offer properties

/offers/properties

key + value

Buyer Purchase Order Number

n/a

n/a

Seller Purchase Order Number

n/a

n/a

Invoice Reference #

n/a

n/a

 

Was this article helpful?

0 out of 0 found this helpful

Articles in this section

Add comment

Please sign in to leave a comment.