Revenue Report

This endpoint returns a csv with the revenue report of the selected period. If we are not passing period parameter it will return current month revenue report.

Request

Curl

curl -X GET https://api.reveniq.com/v1/revenue/reports.csv -H 'Authorization: YOUR_API_TOKEN_HERE' -H 'Content-Type: application/json'

Ruby

api.rb

require 'uri'
require 'net/http'
url = URI("https://api.reveniq.com/v1/revenue/reports.csv")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'YOUR_API_TOKEN_HERE'

response = http.request(request)
puts response.read_body

Java

api.java

HttpResponse<String> response = Unirest.get("https://api.reveniq.com/v1/revenue/reports.csv")
  .header("Authorization", "YOUR_API_TOKEN_HERE")
  .asString();

Python

api.py

import requests

url = "https://api.reveniq.com/v1/revenue/reports.csv"

payload = ""
headers = {
    'Content-Type': "application/json",
    'Authorization': "YOUR_API_TOKEN_HERE",
    }

response = requests.request("GET", url, data=payload, headers=headers)

print(response.text)

Javascript

api.js

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();


xhr.addEventListener("readystatechange", function () {
  if (this.readyState === 4) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.reveniq.com/v1/revenue/reports.csv");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.setRequestHeader("Authorization", "YOUR_API_TOKEN_HERE");

xhr.send(data);

Parmeters

Parameters	Description	Required
period	Month and Year of the report which need to be generated eg: "03-2023"	YES

Response

The above commands returns CSV structured like this:

Invoice ID	Customer ID	Account Name	Stripe Invoice ID	Salesforce ID	Unit Price	Quantity	Stripe Description	Product ID	Created Date	Status	Currency	Monthly Revenue Variance	No Of Months	MRR	ARR	MRR Variance	ARR Variance	Start Date	End Date
2367	26	abc	in_wewewdadasdsads	01t7V000006aR48QAE	0.5	449	Formula meter	113	023-03-01T18:41:44.981Z	approved	EUR - Euro	1.5	1	224.5	2694.0	1.5	18.0	2023-03-01 18:41:44 UTC	2023-03-31 18:41:44 UTC