Get Ledger Entries
GET api/V3/{language}/org/{orgIdentifier}/Ledgercodes
?showArchived={showArchived}
&page={page}
&perPage={perPage}
Returns a list of all Ledger Entries by id, with the option to show archived items.
Request Information
URI Parameters
| PARAMETERS | ||
|---|---|---|
| language (string) |
Language in which the localizable values should be returned. Part of base url. Value is either 'fr' or 'en' |
Required |
| orgIdentifier (string) |
Amilia-specific organization identifier. This identifier can be either the organization number, such as 8008, or the organization URL identifier. You can find that by looking at the URL of your Amilia store. It may look like lower-case words separated by a dash, such as forest-explorers. Note that in v2 and v1 we call that the 'rewrite URL'. |
Required |
| showArchived (boolean) |
Option to also show archived items. Default value is False |
Optional |
| page (integer) |
Result page number that appears first. Default value is 1 |
Optional |
| perPage (integer) |
Number of results per page. Default value is 200 |
Optional |
Body Parameters
None.
Response Information
Resource Description
| PARAMETERS | ||
|---|---|---|
| Description (string) |
Description of the activity that will be visible to your customers in your store |
|
| LedgerType (LedgerType) | ||
| IsArchived (boolean) |
True if resource is archived |
|
| IsSystemGenerated (boolean) | ||
| Id (integer) |
Resource id |
|
| Code (string) | ||
| Title (string) |
Title of the resource |
|