Payments & Vouchers

Deposit Ledger

A report detailing deposit revenue balances.

get/shop/reports/deposit-ledger-v2/list

List LedgerLines

listDepositLedger

Use this endpoint to retrieve a list of DepositLedgerDailyChange resources.

Query parameters

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

Responses

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

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

const response = await fetch('https://api.playground.try.be/shop/reports/deposit-ledger-v2/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/deposit-ledger-v2/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/deposit-ledger-v2/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/deposit-ledger-v2/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 `DepositLedgerDailyChange` resources was successfully retrieved

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "type": "basket",
      "reference": "TRY00",
      "description": "dan@example.com",
      "ledger_balance": 5000,
      "ledger_balances": {
        "deposit": 5000,
        "deposit_redemption": 3500
      }
    }
  ],
  "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/deposit-ledger-v2/summary

Get deposit ledger balances as of the given date

getDepositLedgerSummary

Get deposit ledger balances as of the given date.

Query parameters

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

Responses

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

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

const response = await fetch('https://api.playground.try.be/shop/reports/deposit-ledger-v2/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/deposit-ledger-v2/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/deposit-ledger-v2/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/deposit-ledger-v2/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 deposit ledger balances on the given date.

{
  "data": {
    "balances": {
      "deposit": 5000,
      "deposit_redemption": 3500
    },
    "balance": 5095
  }
}

{
  "message": "Unauthenticated"
}

get/shop/reports/deposit-ledger-v2/queue

Queue an export of the deposit ledger.

actionQueueDepositLedgerReport

Queue an export of the deposit ledger.

Query parameters

site_iduuidoptional
Retrieve the deposit ledger details for this site.
datedateoptional
Retrieve the deposit ledger 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/deposit-ledger-v2/queue" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/reports/deposit-ledger-v2/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/deposit-ledger-v2/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/deposit-ledger-v2/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/deposit-ledger-v2/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"
}