Explore our new Open API v3 documentation!

Explore our new documentation, migration guide, and v3 endpoint reference. You can also learn how to share your feedback directly with our team. Check it out!

API Documentation

Ledger

Overview

Represents a shop's ledger.

Fields

Field Visibility Level Permission Scope Type Description
ledger_id private transactions_r int The ledger's numeric ID.
shop_id private transactions_r string The shop's numeric ID.
currency private transactions_r string The currency code of the shop.
create_date private transactions_r int The date and time the ledger was created in Epoch seconds.
update_date private transactions_r int The date and time the ledger was last updated in Epoch seconds.

Associations

This resource has no associations.

Methods

findLedger

Method Name findLedger
Synopsis Get a Shop Payment Account Ledger
HTTP Method GET
URI /shops/:shop_id/ledger/
Parameters
Name Required Default Type
shop_id Y   shop_id_or_name
Requires OAuth Y
Permission Scope transactions_r

Open API v3New

Your developer account