Payments & Vouchers

Ledger Line Postings

A LedgerLinePosting contains a group of balanced LedgerLine's that Trybe can send to other systems. The LedgerLinePosting ensures accurate recording of financial transactions and enables you to monitor the successful postings for data integrity.

The LedgerLinePosting object

Attributes

idobject-idrequired
The ID of this ledger line posting.
site_iduuidrequired
The ID of the site this ledger line posting belongs to.
created_atdate-timerequired
The date and time the ledger posting was created.
integrationstringrequired
An identifier for the integration the posting was for.
integration_namestringrequired
A user-friendly name for the integration.
integration_is_asyncbooleanoptional
Whether the integration works asynchronously.
statusstringrequired
The status of the posting.
Possible values:successresolvederrorin_progressnot_startednothing_to_post
payableobjectrequired
A summary of the model that the ledger line or posting relates to, usually a basket.
causerobjectrequired
A summary of the model that caused the posting or line to be generated.
last_errorstringoptional
The last error encountered when attempting to post this record.
last_error_atdate-timeoptional
The date and time of the last error.
succeeded_atdate-timeoptional
The date and time the posting succeeded.
linesobject[]required

{
  "id": "64a9f3b2c3d8e1f4a5b6c7d8",
  "site_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2023-05-05T11:38:29+01:00",
  "integration": "guestline_rezlynx",
  "integration_name": "Guestline",
  "integration_is_async": false,
  "status": "success",
  "payable": {
    "id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "type": "basket",
    "reference": "TRY00",
    "description": "dan@example.com"
  },
  "causer": {
    "id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "type": "basket",
    "reference": "TRY00"
  },
  "last_error": "string",
  "last_error_at": "2023-05-05T11:39:21+01:00",
  "succeeded_at": "2023-05-05T11:39:21+01:00",
  "lines": [
    "string"
  ]
}

get/shop/ledger-line-postings

List LedgerLinePostings

listLedgerLinePostings

Use this endpoint to retrieve a list of LedgerLinePosting resources associated with a Site.

Query parameters

site_iduuidoptional
Filter the list of LedgerLinePostings by site
statusstringoptional
Filter the list of LedgerLinePostings by status
Possible values:successresolvederrorin_progressnot_started
sortstringoptional
Sort the list by the given column name
sort_directionstringoptional
The direction to sort the results in.
Possible values:ascdesc
pageintegeroptional
The page to retrieve results from
created_at_fromdateoptional
Filter the list of LedgerLinePostings by created at from. This will include the given date.
created_at_todateoptional
Filter the list of LedgerLinePostings by created at to. This will filter up to and including the given date.
succeeded_at_fromdateoptional
Filter the list of LedgerLinePostings by succeeded at from. This will include the given date.
succeeded_at_todateoptional
Filter the list of LedgerLinePostings by succeeded at to. This will filter up to and including the given date.

Responses

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

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

const response = await fetch('https://api.playground.try.be/shop/ledger-line-postings', {
  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/ledger-line-postings",
    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/ledger-line-postings', [
    '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/ledger-line-postings", 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 `LedgerLinePostings` resources was successfully retrieved

{
  "data": [
    {
      "id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "site_id": "00000000-0000-0000-0000-000000000000",
      "created_at": "2023-05-05T11:38:29+01:00",
      "integration": "guestline_rezlynx",
      "integration_name": "Guestline",
      "integration_is_async": false,
      "status": "success",
      "payable": {
        "id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "type": "basket",
        "reference": "TRY00",
        "description": "dan@example.com"
      },
      "causer": {
        "id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "type": "basket",
        "reference": "TRY00"
      },
      "last_error": "string",
      "last_error_at": "2023-05-05T11:39:21+01:00",
      "succeeded_at": "2023-05-05T11:39:21+01:00",
      "lines": [
        {
          "id": "64a9f3b2c3d8e1f4a5b6c7d8",
          "gross_amount": 10000,
          "net_amount": 8333,
          "type": "charge",
          "description": "Trybe Cash payment [TRY3Z] Jane Jenkins",
          "revenue_centre": "spa",
          "revenue_centre_name": "Spa",
          "payment_processor": "manual",
          "payment_processor_friendly": "Manual (Cash)",
          "mapped_value": "trybe_spa_revenue",
          "ledger_date": "2023-04-02T00:00:00+01:00",
          "currency": "gbp",
          "payable": {
            "id": "64a9f3b2c3d8e1f4a5b6c7d8",
            "type": "basket",
            "reference": "TRY00",
            "description": "dan@example.com"
          },
          "causer": {
            "id": "64a9f3b2c3d8e1f4a5b6c7d8",
            "type": "basket",
            "reference": "TRY00"
          },
          "status": "pending",
          "created_at": "2023-05-05T11:38:29+01:00"
        }
      ]
    }
  ],
  "meta": {
    "from": 1,
    "to": 2,
    "total": 2,
    "current_page": 1,
    "last_page": 2,
    "per_page": 15,
    "path": "http://example.com/api",
    "aggregations": [
      {
        "id": "integrations",
        "name": "Integrations",
        "options": [
          {
            "id": "mews",
            "name": "Mews",
            "count": 100
          }
        ]
      }
    ],
    "last_succeeded_at": "2023-05-05T11:39:21+01:00",
    "last_error_at": "2023-05-05T11:39:21+01:00",
    "total_succeeded": 100,
    "total_errored": 20,
    "success_rate": 99.9
  },
  "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/ledger-line-postings/{ledgerLinePostingId}

Show a LedgerLinePosting

getLedgerLinePosting

Use this endpoint to retrieve a LedgerLinePosting.

Path parameters

ledgerLinePostingIdobject-idrequired
The ID of the LedgerLinePosting

Responses

200
The LedgerLinePosting was successfully retrieved
401
The user is unauthenticated
404
The resource couldn't be found

curl "https://api.playground.try.be/shop/ledger-line-postings/abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/ledger-line-postings/abc123', {
  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/ledger-line-postings/abc123",
    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/ledger-line-postings/abc123', [
    '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/ledger-line-postings/abc123", 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 `LedgerLinePosting` was successfully retrieved

{
  "data": {
    "id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "site_id": "00000000-0000-0000-0000-000000000000",
    "created_at": "2023-05-05T11:38:29+01:00",
    "integration": "guestline_rezlynx",
    "integration_name": "Guestline",
    "integration_is_async": false,
    "status": "success",
    "payable": {
      "id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "type": "basket",
      "reference": "TRY00",
      "description": "dan@example.com"
    },
    "causer": {
      "id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "type": "basket",
      "reference": "TRY00"
    },
    "last_error": "string",
    "last_error_at": "2023-05-05T11:39:21+01:00",
    "succeeded_at": "2023-05-05T11:39:21+01:00",
    "lines": [
      {
        "id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "gross_amount": 10000,
        "net_amount": 8333,
        "type": "charge",
        "description": "Trybe Cash payment [TRY3Z] Jane Jenkins",
        "revenue_centre": "spa",
        "revenue_centre_name": "Spa",
        "payment_processor": "manual",
        "payment_processor_friendly": "Manual (Cash)",
        "mapped_value": "trybe_spa_revenue",
        "ledger_date": "2023-04-02T00:00:00+01:00",
        "currency": "gbp",
        "payable": {
          "id": "64a9f3b2c3d8e1f4a5b6c7d8",
          "type": "basket",
          "reference": "TRY00",
          "description": "dan@example.com"
        },
        "causer": {
          "id": "64a9f3b2c3d8e1f4a5b6c7d8",
          "type": "basket",
          "reference": "TRY00"
        },
        "status": "pending",
        "created_at": "2023-05-05T11:38:29+01:00"
      }
    ]
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "The requested resource could not be found"
}

put/shop/ledger-line-postings/{ledgerLinePostingId}

Update a LedgerLinePosting

updateLedgerLinePosting

Use this endpoint to update the status of a LedgerLinePosting.

Path parameters

ledgerLinePostingIdobject-idrequired
The ID of the LedgerLinePosting

Request body

statusstringrequired
The status of the LedgerLinePosting
Possible values:successresolved

Responses

200
The LedgerLinePosting was successfully updated
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found
422
The request didn't pass validation

curl -X PUT "https://api.playground.try.be/shop/ledger-line-postings/abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "status": "success"
}'

const response = await fetch('https://api.playground.try.be/shop/ledger-line-postings/abc123', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "status": "success"
  }),
})

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

const data = await response.json()

import httpx

response = httpx.put(
    "https://api.playground.try.be/shop/ledger-line-postings/abc123",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "status": "success"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.playground.try.be/shop/ledger-line-postings/abc123', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'status' => 'success'
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"status": "success",
	})
	req, _ := http.NewRequest("PUT", "https://api.playground.try.be/shop/ledger-line-postings/abc123", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "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 `LedgerLinePosting` was successfully updated

{
  "data": {
    "id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "site_id": "00000000-0000-0000-0000-000000000000",
    "created_at": "2023-05-05T11:38:29+01:00",
    "integration": "guestline_rezlynx",
    "integration_name": "Guestline",
    "integration_is_async": false,
    "status": "success",
    "payable": {
      "id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "type": "basket",
      "reference": "TRY00",
      "description": "dan@example.com"
    },
    "causer": {
      "id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "type": "basket",
      "reference": "TRY00"
    },
    "last_error": "string",
    "last_error_at": "2023-05-05T11:39:21+01:00",
    "succeeded_at": "2023-05-05T11:39:21+01:00",
    "lines": [
      {
        "id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "gross_amount": 10000,
        "net_amount": 8333,
        "type": "charge",
        "description": "Trybe Cash payment [TRY3Z] Jane Jenkins",
        "revenue_centre": "spa",
        "revenue_centre_name": "Spa",
        "payment_processor": "manual",
        "payment_processor_friendly": "Manual (Cash)",
        "mapped_value": "trybe_spa_revenue",
        "ledger_date": "2023-04-02T00:00:00+01:00",
        "currency": "gbp",
        "payable": {
          "id": "64a9f3b2c3d8e1f4a5b6c7d8",
          "type": "basket",
          "reference": "TRY00",
          "description": "dan@example.com"
        },
        "causer": {
          "id": "64a9f3b2c3d8e1f4a5b6c7d8",
          "type": "basket",
          "reference": "TRY00"
        },
        "status": "pending",
        "created_at": "2023-05-05T11:38:29+01:00"
      }
    ]
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

{
  "errors": {},
  "message": "The request didn't pass validation"
}

post/shop/ledger-line-postings/{ledgerLinePostingId}/retry

Retry a LedgerLinePosting

actionRetryLedgerLinePosting

Use this endpoint to retry a LedgerLinePosting that has failed.

Path parameters

ledgerLinePostingIdobject-idrequired
The ID of the LedgerLinePosting

Responses

200
The request to retry a LedgerLinePosting was received
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found

curl -X POST "https://api.playground.try.be/shop/ledger-line-postings/abc123/retry" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/ledger-line-postings/abc123/retry', {
  method: 'POST',
  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.post(
    "https://api.playground.try.be/shop/ledger-line-postings/abc123/retry",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/shop/ledger-line-postings/abc123/retry', [
    '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("POST", "https://api.playground.try.be/shop/ledger-line-postings/abc123/retry", 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 request to retry a `LedgerLinePosting` was received

{
  "data": {
    "id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "site_id": "00000000-0000-0000-0000-000000000000",
    "created_at": "2023-05-05T11:38:29+01:00",
    "integration": "guestline_rezlynx",
    "integration_name": "Guestline",
    "integration_is_async": false,
    "status": "success",
    "payable": {
      "id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "type": "basket",
      "reference": "TRY00",
      "description": "dan@example.com"
    },
    "causer": {
      "id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "type": "basket",
      "reference": "TRY00"
    },
    "last_error": "string",
    "last_error_at": "2023-05-05T11:39:21+01:00",
    "succeeded_at": "2023-05-05T11:39:21+01:00",
    "lines": [
      {
        "id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "gross_amount": 10000,
        "net_amount": 8333,
        "type": "charge",
        "description": "Trybe Cash payment [TRY3Z] Jane Jenkins",
        "revenue_centre": "spa",
        "revenue_centre_name": "Spa",
        "payment_processor": "manual",
        "payment_processor_friendly": "Manual (Cash)",
        "mapped_value": "trybe_spa_revenue",
        "ledger_date": "2023-04-02T00:00:00+01:00",
        "currency": "gbp",
        "payable": {
          "id": "64a9f3b2c3d8e1f4a5b6c7d8",
          "type": "basket",
          "reference": "TRY00",
          "description": "dan@example.com"
        },
        "causer": {
          "id": "64a9f3b2c3d8e1f4a5b6c7d8",
          "type": "basket",
          "reference": "TRY00"
        },
        "status": "pending",
        "created_at": "2023-05-05T11:38:29+01:00"
      }
    ]
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

post/shop/ledger-line-postings/{ledgerLinePostingId}/reverse

Reverse a LedgerLinePosting

actionReverseLedgerLinePosting

Use this endpoint to reverse a LedgerLinePosting. This action does not automatically attempt to post the new LedgerLinePosting to any integrations.

Path parameters

ledgerLinePostingIdobject-idrequired
The ID of the LedgerLinePosting

Responses

200
The request to reverse a LedgerLinePosting was received
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found

curl -X POST "https://api.playground.try.be/shop/ledger-line-postings/abc123/reverse" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/ledger-line-postings/abc123/reverse', {
  method: 'POST',
  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.post(
    "https://api.playground.try.be/shop/ledger-line-postings/abc123/reverse",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/shop/ledger-line-postings/abc123/reverse', [
    '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("POST", "https://api.playground.try.be/shop/ledger-line-postings/abc123/reverse", 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 request to reverse a `LedgerLinePosting` was received

{
  "data": {
    "id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "site_id": "00000000-0000-0000-0000-000000000000",
    "created_at": "2023-05-05T11:38:29+01:00",
    "integration": "guestline_rezlynx",
    "integration_name": "Guestline",
    "integration_is_async": false,
    "status": "success",
    "payable": {
      "id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "type": "basket",
      "reference": "TRY00",
      "description": "dan@example.com"
    },
    "causer": {
      "id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "type": "basket",
      "reference": "TRY00"
    },
    "last_error": "string",
    "last_error_at": "2023-05-05T11:39:21+01:00",
    "succeeded_at": "2023-05-05T11:39:21+01:00",
    "lines": [
      {
        "id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "gross_amount": 10000,
        "net_amount": 8333,
        "type": "charge",
        "description": "Trybe Cash payment [TRY3Z] Jane Jenkins",
        "revenue_centre": "spa",
        "revenue_centre_name": "Spa",
        "payment_processor": "manual",
        "payment_processor_friendly": "Manual (Cash)",
        "mapped_value": "trybe_spa_revenue",
        "ledger_date": "2023-04-02T00:00:00+01:00",
        "currency": "gbp",
        "payable": {
          "id": "64a9f3b2c3d8e1f4a5b6c7d8",
          "type": "basket",
          "reference": "TRY00",
          "description": "dan@example.com"
        },
        "causer": {
          "id": "64a9f3b2c3d8e1f4a5b6c7d8",
          "type": "basket",
          "reference": "TRY00"
        },
        "status": "pending",
        "created_at": "2023-05-05T11:38:29+01:00"
      }
    ]
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}