Payments & Vouchers

Voucher Ledger

A report detailing voucher revenue balances.

get/shop/reports/voucher-ledger/list

List LedgerLines

listVoucherLedger

Use this endpoint to retrieve a list of VoucherLedgerVoucher resources.

Query parameters

site_iduuidoptional
Retrieve the ledger voucher details for this site.
pageintegeroptional
The page to retrieve results from
datedateoptional
Retrieve the ledger voucher details as at this date.

Responses

200
The list of VoucherLedgerVoucher resources was successfully retrieved
401
The user is unauthenticated

curl "https://api.playground.try.be/shop/reports/voucher-ledger/list" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/reports/voucher-ledger/list', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.get(
    "https://api.playground.try.be/shop/reports/voucher-ledger/list",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.playground.try.be/shop/reports/voucher-ledger/list', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.playground.try.be/shop/reports/voucher-ledger/list", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The list of `VoucherLedgerVoucher` resources was successfully retrieved

{
  "data": [
    {
      "id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "code": "ABC123XYZ",
      "valid_from_date": "2023-04-02T00:00:00+01:00",
      "valid_to_date": "2023-04-02T00:00:00+01:00",
      "amount_type": "cash",
      "amount": 10000,
      "balance": 5000,
      "revenue_amount": 8000,
      "difference_amount": 2000,
      "ledger_balance": 5000,
      "ledger_balances": {
        "voucher": 5000,
        "voucher_difference": 2000,
        "voucher_discount": 0,
        "voucher_redemption": 0,
        "voided_voucher": 0
      },
      "currency": "gbp",
      "partially_redeemable": false,
      "voucher_name": "£100 treatment voucher"
    }
  ],
  "meta": {
    "from": 1,
    "to": 2,
    "total": 2,
    "current_page": 1,
    "last_page": 2,
    "per_page": 15,
    "path": "http://example.com/api"
  },
  "links": {
    "first": "http://example.com?page=1",
    "next": "https://example.com?page=3",
    "prev": "https://example.com?page=1",
    "last": "https://example.com?page=4"
  }
}

{
  "message": "Unauthenticated"
}

get/shop/reports/voucher-ledger/summary

Get voucher ledger balances as of the given date

getVoucherLedgerSummary

Get voucher ledger balances as of the given date.

Query parameters

site_iduuidoptional
Retrieve the ledger voucher details for this site.
datedateoptional
Retrieve the ledger voucher details as at this date.

Responses

200
A summary of the voucher ledger balances on the given date.
401
The user is unauthenticated

curl "https://api.playground.try.be/shop/reports/voucher-ledger/summary" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/reports/voucher-ledger/summary', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.get(
    "https://api.playground.try.be/shop/reports/voucher-ledger/summary",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.playground.try.be/shop/reports/voucher-ledger/summary', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.playground.try.be/shop/reports/voucher-ledger/summary", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

A summary of the voucher ledger balances on the given date.

{
  "data": {
    "balances": {
      "voucher": 5000,
      "voucher_difference": 2000,
      "voucher_discount": 0,
      "voucher_redemption": 0,
      "voided_voucher": 0
    },
    "balance": 5000
  }
}

{
  "message": "Unauthenticated"
}

get/shop/reports/voucher-ledger/queue

Queue an export of the voucher ledger.

actionQueueVoucherLedgerReport

Queue an export of the voucher ledger.

Query parameters

site_iduuidoptional
Retrieve the ledger voucher details for this site.
datedateoptional
Retrieve the ledger voucher details as at this date.

Responses

200
The job was successfully queued
401
The user is unauthenticated

curl "https://api.playground.try.be/shop/reports/voucher-ledger/queue" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/reports/voucher-ledger/queue', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.get(
    "https://api.playground.try.be/shop/reports/voucher-ledger/queue",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.playground.try.be/shop/reports/voucher-ledger/queue', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.playground.try.be/shop/reports/voucher-ledger/queue", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The job was successfully queued

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "status": "pending",
    "output": {},
    "created_at": "2023-11-07T00:00:00+00:00",
    "updated_at": "2023-11-07T01:00:00+00:00"
  }
}

{
  "message": "Unauthenticated"
}

get/shop/reports/voucher-ledger-detailed

Returns a chronological line-by-line ledger of voucher sales, redemptions, and refunds in the requested period at a site. Each entry is annotated with the order, basket item, payment, voucher code, and (where relevant) refund it relates to so it can be linked back to the underlying records.

For a single-line aggregate of the same period, see /shop/reports/voucher-ledger-summary.

Query parameters

site_iduuidrequired
The site to compute the voucher ledger for.
date_fromdaterequired
Start of the date range covered by the ledger.
date_todaterequired
End of the date range covered by the ledger.

Responses

200
The ledger was successfully generated.
400
The request failed.
401
The user is unauthenticated

curl "https://api.playground.try.be/shop/reports/voucher-ledger-detailed?site_id=00000000-0000-0000-0000-000000000000&date_from=2026-06-01&date_to=2026-06-30" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/reports/voucher-ledger-detailed?site_id=00000000-0000-0000-0000-000000000000&date_from=2026-06-01&date_to=2026-06-30', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.get(
    "https://api.playground.try.be/shop/reports/voucher-ledger-detailed?site_id=00000000-0000-0000-0000-000000000000&date_from=2026-06-01&date_to=2026-06-30",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.playground.try.be/shop/reports/voucher-ledger-detailed?site_id=00000000-0000-0000-0000-000000000000&date_from=2026-06-01&date_to=2026-06-30', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.playground.try.be/shop/reports/voucher-ledger-detailed?site_id=00000000-0000-0000-0000-000000000000&date_from=2026-06-01&date_to=2026-06-30", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The ledger was successfully generated.

[
  {
    "date": "2026-01-15T09:30:00+00:00",
    "type": "revenue",
    "revenue_centre": "voucher",
    "description": "Trybe Voucher Sales",
    "gross_amount": 1,
    "net_amount": 1,
    "tax_amount": 1,
    "meta": {}
  }
]

{
  "message": "string"
}

{
  "message": "Unauthenticated"
}

get/shop/reports/voucher-ledger-summary

Voucher ledger summary

getVoucherLedgerSummaryReport

Returns a single-line summary of voucher sales, redemptions, and the resulting opening and closing voucher liability balances for the given period at a site. Use this to reconcile the deferred-revenue balance held against Trybe-issued vouchers. For a line-by-line breakdown, see /shop/reports/voucher-ledger-detailed.

Query parameters

site_iduuidrequired
The site to compute the voucher ledger for.
date_fromdaterequired
Start of the date range covered by the ledger.
date_todaterequired
End of the date range covered by the ledger.

Responses

200
The summary was successfully generated.
400
The request failed.
401
The user is unauthenticated

curl "https://api.playground.try.be/shop/reports/voucher-ledger-summary?site_id=00000000-0000-0000-0000-000000000000&date_from=2026-06-01&date_to=2026-06-30" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/reports/voucher-ledger-summary?site_id=00000000-0000-0000-0000-000000000000&date_from=2026-06-01&date_to=2026-06-30', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.get(
    "https://api.playground.try.be/shop/reports/voucher-ledger-summary?site_id=00000000-0000-0000-0000-000000000000&date_from=2026-06-01&date_to=2026-06-30",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.playground.try.be/shop/reports/voucher-ledger-summary?site_id=00000000-0000-0000-0000-000000000000&date_from=2026-06-01&date_to=2026-06-30', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.playground.try.be/shop/reports/voucher-ledger-summary?site_id=00000000-0000-0000-0000-000000000000&date_from=2026-06-01&date_to=2026-06-30", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The summary was successfully generated.

{
  "revenues": {
    "revenue_centre": "voucher",
    "description": "Trybe Voucher Sales",
    "gross_amount": 1,
    "net_amount": 1,
    "tax_amount": 1,
    "count": 1
  },
  "payments": {
    "revenue_centre": "voucher_redemption",
    "description": "Trybe Voucher Redemptions",
    "amount": 1,
    "count": 1
  },
  "meta": {
    "currency": "gbp",
    "opening_balance": 1,
    "closing_balance": 1
  }
}

{
  "message": "string"
}

{
  "message": "Unauthenticated"
}