The Copaco Cloud Support Center Portal is capable of providing you with your purchase and sales invoices in XML and JSON format. This feature is called “Billing API”. The Billing API enables your enterprise resource planning (ERP) system to request invoice details on demand from the Copaco Cloud Platform. These invoices are sent as structured XML or JSON data, which can then be processed by your ERP system.

The Billing API is a custom set of API endpoints built on top of the CloudStore API, and is not intended as a full replacement. The billing API provides an easy-to-use way to get consolidated invoices data from the Cloud Platform.

 There are multiple different endpoints in the Billing API:

  • The invoices endpoint retrieves your purchase invoices for a specified period (reseller cost price).

  • The customerinvoices endpoint retrieves your sales invoices for a specified period (customer prices).

  • The consolidatedinvoices endpoint retrieves a merged set of reseller cost and customer prices for a specified period.

  • The subscriptiondetails endpoint allows you to get additional data about a specified subscription. It provides details about the underlying “service plan”, “plan period“ “resources”, “resource rate” and when available “resource rate period” information. This information can be used to understand how an invoice line item was generated and gives the ability to apply your own billing logic on top of what our cloud platform provides.

 

Table of Contents:

1. Access to the Billing API
2. Requesting specific data
3 XML elements
4 Calculations
subscriptiondetails (JSON)

Versioning

The documentation in this knowledge base is built for the latest API version V4.

If you use an older version of this API, some endpoints or fields might be missing. New API versions are released when new functionality demands breaking changes to an endpoint, or if breaking bugs are found. It is advised to update your integrations to the latest API release as soon as possible. We keep supporting older API releases with the N-1 principle. (we support the latest release and the one before it).

Download a copy of legacy V1/V2 Documentation (end of life)

2tCloud Billing APIv2.pdf