Get monthly sales and payments

GET

reports

sales_and_payments

curl --request GET \
  --url https://api.staging.streamlinedpayments.com/api/v1/reports/sales_and_payments \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-App-Id: <api-key>'

const options = {method: 'GET', headers: {'X-App-Id': '<api-key>', 'X-Api-Key': '<api-key>'}};

fetch('https://api.staging.streamlinedpayments.com/api/v1/reports/sales_and_payments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.staging.streamlinedpayments.com/api/v1/reports/sales_and_payments"

headers = {
    "X-App-Id": "<api-key>",
    "X-Api-Key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

url = URI("https://api.staging.streamlinedpayments.com/api/v1/reports/sales_and_payments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-App-Id"] = '<api-key>'
request["X-Api-Key"] = '<api-key>'

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

{
  "currency": "USD",
  "data": [
    {
      "month": "2026-10",
      "sales_amount": 4210000,
      "payment_amount": 3880000
    }
  ]
}

Authorizations

X-App-Id

string

header

required

App ID for authentication

X-Api-Key

string

header

required

API Key for authentication

Query Parameters

start_date

string<date>

First month of the range, as any day in it (YYYY-MM-DD). The range can be at most 24 months.

end_date

string<date>

Last month of the range, as any day in it (YYYY-MM-DD).

Response

Successful operation

currency

enum<string>

ISO currency code. Most resources support these. Products are limited to USD, CAD, EUR, GBP, AUD.

Available options:

USD,

CAD,

GBP,

EUR,

AUD,

JPY,

INR

data

object[]

Every month in the range, oldest first, with zeros where nothing happened.

Show child attributes

Get monthly sales and payments

curl --request GET \
  --url https://api.staging.streamlinedpayments.com/api/v1/reports/sales_and_payments \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-App-Id: <api-key>'

const options = {method: 'GET', headers: {'X-App-Id': '<api-key>', 'X-Api-Key': '<api-key>'}};

fetch('https://api.staging.streamlinedpayments.com/api/v1/reports/sales_and_payments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.staging.streamlinedpayments.com/api/v1/reports/sales_and_payments"

headers = {
    "X-App-Id": "<api-key>",
    "X-Api-Key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

url = URI("https://api.staging.streamlinedpayments.com/api/v1/reports/sales_and_payments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-App-Id"] = '<api-key>'
request["X-Api-Key"] = '<api-key>'

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

{
  "currency": "USD",
  "data": [
    {
      "month": "2026-10",
      "sales_amount": 4210000,
      "payment_amount": 3880000
    }
  ]
}

Orders

Customers

Customer applications

Customer groups

Customer files

Customer addresses

Payouts

Invoices

Transactions

Products

Deposit links

Webhooks

Reports

Get monthly sales and payments

Authorizations

Query Parameters

Response