Reeleezee GitHub page

Paging

To retrieve certain amount of data at a time OData supports the $top and $skip system query options which can be combined with other system query options. The $top system query option can be used to fetch specified top records.

 

Example:

Request the first page of a paged list of products top 65 products: /api/v1/products?$top=65

 

To skip certain number of records and retrieve the remaining one, $skip system query option can be used.

 

Example:

Request the first page of a paged list of products with the first 100 products skipped: /api/v1/products?$skip=100

 

Along with above options, Reeleezee API also supports server-driven paging by default. When a GET request will return more than 1000 items, it will chunk them into blocks of 1000 items and will provide a link to fetch the next chunk. The @odata.nextlink will give you information how to retrieve the next chunk of data.

 

Example: “@odata.nextLink”: “https://portal.reeleezee.nl:443/api/apiservicedev/salesinvoices?$skip=1000”

{
  "@odata.nextLink": "https://portal.reeleezee.nl:443/api/apiservicedev/salesinvoices?$skip=1000",
  "value": [
    {
      "id": "48b5a999-31b2-47a9-9f40-e332ba73b67b",
      "IsArchived": false,
      "IsPeriodicInvoice": false,
      "NumberOfTimesEmailed": 0,
      "NumberOfTimesPrinted": 1,
      "BaseInvoiceAmount": 442.56,
      "BasePaidAmount": 442.56,
      "BaseRemainingAmount": 0,
      "TotalNetAmount": 371.9,
      "TotalPaidAmount": 442.56,
      "TotalPayableAmount": 442.56,
      "TotalTaxAmount": 70.66,
      "BookDate": "2012-02-02T00:00:00",
      "Date": "2012-02-02T00:00:00",
      "PaymentReference": null,
      "Reference": "3",
      "Status": 3,
      "DocumentType": 10,
      "Origin": 2,
      "Type": 1,
      "DueDate": "2012-03-03T00:00:00",
      "InvoiceNumber": 3,
      "OverdueDays": null
    },
    {
      "id": "1b02aa4f-8daf-447d-9287-aeb09147324e",
      "IsArchived": false,
      "IsPeriodicInvoice": false,
      "NumberOfTimesEmailed": 0,
      "NumberOfTimesPrinted": 0,
      "BaseInvoiceAmount": 59.5,
      "BasePaidAmount": 0,
      "BaseRemainingAmount": 59.5,
      "TotalNetAmount": 50,
      "TotalPaidAmount": 0,
      "TotalPayableAmount": 59.5,
      "TotalTaxAmount": 9.5,
      "BookDate": "2012-02-10T00:00:00",
      "Date": "2012-02-10T00:00:00",
      "PaymentReference": null,
      "Reference": "6",
      "Status": 2,
      "DocumentType": 10,
      "Origin": 2,
      "Type": 1,
      "DueDate": "2012-03-11T00:00:00",
      "InvoiceNumber": 6,
      "OverdueDays": -1823
    }
  ]
}