Sign in
LedgerLinePostings

List LedgerLinePostings

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

get/shop/ledger-line-postings

Query parameters

site_idstring uuid

Filter the list of LedgerLinePostings by site

status'success' | 'resolved' | 'error' | 'in_progress' | 'not_started'

Filter the list of LedgerLinePostings by status

sortstring
Example:created_at

Sort the list by the given column name

sort_direction'asc' | 'desc'

The direction to sort the results in.

pageinteger

The page to retrieve results from

created_at_fromstring date
Example:2023-05-05

Filter the list of LedgerLinePostings by created at from. This will include the given date.

created_at_tostring date
Example:2023-05-05

Filter the list of LedgerLinePostings by created at to. This will filter up to and including the given date.

succeeded_at_fromstring date
Example:2023-05-05

Filter the list of LedgerLinePostings by succeeded at from. This will include the given date.

succeeded_at_tostring date
Example:2023-05-05

Filter the list of LedgerLinePostings by succeeded at to. This will filter up to and including the given date.

Response

The list of LedgerLinePostings resources was successfully retrieved

Example response

{
  "data": [
    {
      "created_at": "2023-05-05T11:38:29+01:00",
      "integration": "guestline_rezlynx",
      "integration_name": "Guestline",
      "payable": {
        "reference": "TRY00",
        "description": "dan@example.com"
      },
      "causer": {
        "reference": "TRY00"
      },
      "last_error_at": "2023-05-05T11:39:21+01:00",
      "succeeded_at": "2023-05-05T11:39:21+01:00",
      "lines": [
        {
          "gross_amount": 10000,
          "net_amount": 8333,
          "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": {
            "reference": "TRY00",
            "description": "dan@example.com"
          },
          "causer": {
            "reference": "TRY00"
          },
          "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"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.