Selecting - Reckon One API v2

All Reckon One API V2 GET endpoints allow you to select which fields you want to see in the result, whether you are getting a list of something or just a single resource.

This is added to the URL as a query string parameter:

/r1/v2/{cashbookId}/ledgeraccounts?select=id,name,status

👆 The above example will return a list of ledger accounts that will include just the id, name and status fields.


This applies equally to getting a single ledger account, for example:

/r1/v2/{cashbookId}/ledgeraccounts/{accountId}?select=id,name,status

👆 The above will get the id, name and status fields for the single account (if it exists).


Some more examples, selecting nested fields:

/r1/v2/{cashbookId}/expenseclaims?select=id,claimnumber,lineitems,lineitems.ledgeraccount.name,lineitems.item.name

👆 The above will get the id, claimnumber and all lineitems , including nested fields, but for the nested ledgeraccount and item, it will just get the name.


/r1/v2/{cashbookOd}/expenseclaims?select=id,claimnumber,lineitems.ledgeraccount.name,lineitems.item.name

👆 The above will get the id, claimnumber top-level fields and then, for each object in the lineitems array, it will get just the ledgeraccount name and the item name. No other fields will be returned.


/r1/v2/{cashbookId}/taxgroups/2020-01-30?select=taxcodes

👆 The above will get all tax codes and their properties.


How did we do?

Sorting - Reckon One API v2

Related Articles

Sorting - Reckon One API v2
Paging - Reckon One API v2
Filtering - Reckon One API v2
Powered by HelpDocs (opens in a new tab)

Powered by HelpDocs (opens in a new tab)