OData

The Reckon One API utilises OData v4.0.

The Open Data Protocol (OData) enables the creation of REST-based data services, which allow resources, identified using Uniform Resource Identifiers (URLs) and defined in a data model, to be published and edited by Web clients using simple HTTP messages. This specification defines a set of recommended (but not required) rules for constructing URLs to identify the data and metadata exposed by an OData service as well as a set of reserved URL query string operators, which if accepted by an OData service, MUST be implemented as required by this document - OData.Org

Further reading can be found at OData.org including the Getting Started guides.  

Common OData System Query Options

Option

Description

$expand

Directs that related records should be retrieved in the record or collection being retrieved.

$filter

Specifies an expression or function that must evaluate to true for a record to be returned in the collection.

$orderby

Determines what values are used to order a collection of records.

$select

Specifies a subset of properties to return.

$skip

Sets the number of records to skip before it retrieves records in a collection.

$top

Determines the maximum number of records to return.

 

Example:

  1. https://api.reckon.com/r1/{CASHBOOKID}/accounts?subscription-key=<<KEY>>&$skip=50 
    This will skip the first 50 records of the response.
  2. https://api.reckon.com/R1/{CASHBOOKID}/invoices?&$filter=Status eq '3'
    This will return the list of invoices where the Status is equal to 3 (Overdue).
  3. https://api.reckon.com/R1/{CASHBOOKID}/invoices?$filter=Balance gt 0
    This will return the list of invoices where the Balance of the invoice is greater than 0 (zero).
  4. https://api.reckon.com/R1/{CASHBOOKID}/invoices?$filter=InvoiceDate ge 2020-08-01
    This will return the list of Invoices where the InvoiceDate is greater than or equal to 1st August 2020.

 

Further examples of how to use OData can also be found here at the Microsoft Developer site. Please note this refers to Dynamics CRM by Microsoft, however the queries such as $skip etc remain the same for Reckon One.

How did we do?

Reckon One Postman Collection

Pagination
Powered by HelpDocs (opens in a new tab)

Powered by HelpDocs (opens in a new tab)