Skip to content
Topsort Documentation
API

Get Vendor Account Activity

GET
/v1/billing-service/vendors/{external-vendor-id}/account-activity

Endpoint to get the Account Activity for a vendor.

start_date and end_date timezone is optional, if no timezone is provided it will be converted to UTC timezone.

Authentication

Topsort’s APIs are authenticated via bearer tokens. Requests must include an authorization header containing your private API key.

Don't have an API key yet? Learn how to generate one.

Authorization
required
string

The header containing a private API key. Format this header as follows:

Authorization: Bearer <YOUR-API-KEY>

Path Parameters

object
external-vendor-id
required

The External ID of the Vendor to retrieve.

string
>= 1 characters

The External ID of the Vendor to retrieve.

Query Parameters

object
start_date
required

The start of the date range for which to retrieve. Must include the Timezone definition.

string format: date-time

The start of the date range for which to retrieve. Must include the Timezone definition.

end_date
required

The end of the date range for which to retrieve. Must include the Timezone definition.

string format: date-time

The end of the date range for which to retrieve. Must include the Timezone definition.

Responses

Successful Response

This is the Response body for the Vendor Account Activity fetch.

application/json
object
currencyCode
required
string
lines
required
Array<object>

Account Activity Lines have 3 reason types: 1.- Credit : single lines 2.- Topup : single lines 3.- Daily Ad Spend : aggregation by day

object
amount
required
number
createdAt
required
string format: date-time
description
required
string
reasonType
required
string