Open API v2 will be deprecated on April 3, 2023. Please begin transitioning to Open API v3 as soon as possible. As of September 29, 2022 all new apps will only be permitted to use Open API v3.
- ApiMethod
- BillCharge
- BillingOverview
- BillPayment
- Cart
- CartListing
- Country
- Coupon
- DataType
- FavoriteListing
- FavoriteUser
- Feedback
- FeedbackInfo
- ForumPost
- Guest
- GuestCart
- ImageType
- Ledger
- LedgerEntry
- Listing
- ListingFile
- ListingImage
- ListingInventory
- ListingOffering
- ListingProduct
- ListingTranslation
- ListingVariationImage
- Money
- ParamList
- Payment
- PaymentAccountLedgerEntry
- PaymentAdjustment
- PaymentAdjustmentItem
- PaymentTemplate
LedgerEntry
Overview
Represents an entry in a shop's ledger.
Fields
Field | Visibility Level | Permission Scope | Type | Description |
---|---|---|---|---|
ledger_entry_id |
private |
|
int |
The ledger entry's numeric ID. |
ledger_id |
private |
|
int |
The ledger's numeric ID. |
sequence |
private |
|
int |
The sequence allows ledger entries to be sorted chronologically. The higher the sequence, the more recent the entry. |
credit_amount |
private |
|
int |
The amount of money credited to the ledger. |
debit_amount |
private |
|
int |
The amount of money debited from the ledger. |
entry_type |
private |
|
string |
Details what kind of ledger entry this is: a payment, refund, reversal of a failed refund, disbursement, returned disbursement, recoupment, miscellaneous credit, miscellaneous debit, or bill payment |
reference_id |
private |
|
int |
Depending on the entry_type, this is the id of the corresponding payment, payment adjustment, or disbursement. |
running_balance |
private |
|
int |
The amount of money in the shop's ledger the moment after this entry was applied. |
create_date |
private |
|
int |
The date and time the ledger entry was created in Epoch seconds. |
Associations
This resource has no associations.
Methods
findLedgerEntries
Method Name | findLedgerEntries |
||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Synopsis | Get a Shop Payment Account Ledger's Entries | ||||||||||||||||||||||||||||
HTTP Method | GET |
||||||||||||||||||||||||||||
URI | /shops/:shop_id/ledger/entries |
||||||||||||||||||||||||||||
Parameters |
|
||||||||||||||||||||||||||||
Requires OAuth | Y |
||||||||||||||||||||||||||||
Permission Scope |
|