Scheduled Load Orders List

Filterable Attributes

Attribute Name	Meaning
customer_id	Id of customer associated with the scheduled load orders
state	Current state of the scheduled load order: `paused`, or `active`
voucher_category	Category of vouchers handled by the scheduled load order

Accessible By

multiplier, customer

Parameters:

name	type	default	info
sort	string	NONE	OPTIONAL, defaults to created_at
skip_meta_totals	boolean	false	OPTIONAL, defaults to false
page[number] integer/string	1		OPTIONAL, defaults to 1
page[size]	integer/string	25	OPTIONAL, default page size is 25, max page size is 250

Return

{
  "meta": {
    "total_pages": 0,
    "current_page": 0,
    "page_size": 0,
    "total_entries": 0
  },
  "data": [
    {
      "id": "string",
      "created_at": "2020-04-29T07:56:58.936+02:00",
      "updated_at": "2023-02-07T16:59:07.667+01:00",
      "customer": {
        "id": "string",
        "type": "customer"
      },
      "is_top_up": false,
      "description": null,
      "day_of_month": 15,
      "month_of_year": null,
      "schedule": "monthly",
      "entries_count": 0,
      "net_total": {
        "cents": 0,
        "currency": "EUR"
      },
      "active_entries_count": 0,
      "active_net_total": {
        "cents": 0,
        "currency": "EUR"
      },
      "next_invoicing_date": "2020-05-05",
      "next_due_date": "2020-05-15",
      "state": "active",
      "vouchers_count": 0,
      "voucher_category": "mixed"
    }
  ],
  "links": {
    "self": "http://example.com",
    "first": "http://example.com",
    "prev": "http://example.com",
    "next": "http://example.com",
    "last": "http://example.com"
  }
}

curl --location -g --request GET 'https://www-staging.givve.com/api/scheduled_load_orders?sort=created_at&skip_meta_totals=&page[number]=1&page[size]=25' \ --header 'Authorization: Bearer ' \ --header 'Accept-Version: v2'

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

sort

string

required

Example:

created_at

skip_meta_totals

string

required

page[number]

string

required

Example:

page[size]

string

required

Example:

Header Params

Authorization

string

required

Example:

Bearer {{token}}

Accept-Version

string

required

Example:

List

Scheduled Load Orders List#

Filterable Attributes#

Accessible By#

Parameters:#

Return#

Request

Responses

Scheduled Load Orders List

Filterable Attributes

Accessible By

Parameters:

Return