Stores financial transaction details.
You must have the financials ConventionPrivilege to access this,
or be the leader of the Group that controls the ledger.
Ledger Entrys are accessed via /api/ledgerentry.
See "Object Properties" in Introduction for basic shared properties.
Complete details in LedgerEntryProperties.
See "Related Objects" in Introduction for how to use them.
The Convention this ledger entry belongs to (if any).
The ConventionReceipt this ledger entry belongs to (if any).
The Group this ledger entry belongs to.
The SupplyOrder this ledger entry belongs to (if any).
See "Includes" in Introduction for how to use them.
Includes payment information associated with the Ledger Entry.
Requires the financials privilege.
Field is returned in format:
{
"id" : "xxx",
...
"receipt_payment" : {
"receipt_order_number" : [integer],
"payment_method" : [string],
"payment_transaction_id" : [string],
},
...
}
The services used to fetch and manipulate ledger entries.
This section describes basic searchability of Ledger Entries, which is now available across several endpoints.
To request badges, a user must make a request via an endpoint for a parent object.
Returns:
{
"paging" : {...},
"items" : [
{
"id" : "xxx",
"category" : "badge",
"amount" : 23.50,
...
},
...
]
}
Pass a string query to search for a partial match in specifically allowed text fields.
Only the memo field can be queried.
Use this field to do a partial search on badge name. (Like query but must be stated explicitly.)
Options include:
Options are badge, booth, boothaddon, soldproduct, sponsor, ticket. For older conventions, use the category parameter instead. Otherwise, using the orderitem_type parameter should return pretty much the same results as using the same values for category.
While you can use this field for searching, its real purpose is to allow you to easily get from a Ledger Entry to the order item it is for.
Limit ledger entries to a specific ConventionReceipt number.
Options are stripe, cash.
A flag option, set to 1 or any non-empty/non-zero value. Returns all Ledger Entries for refunds.
GET /api/ledgerentry/xxx
Returns:
{
"id" : "xxx",
"name" : "The Captain is Dead",
...
}