Skip to main content
GET
/
v2
/
adjustments
List Adjustments
curl --request GET \
  --url https://api.example.com/v2/adjustments \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "name": "<string>",
      "is_active": true,
      "is_system": true,
      "automated": true,
      "description": "<string>",
      "ledger_account_id": "<string>",
      "ledger_account": {
        "created_at": "2023-11-07T05:31:56Z",
        "modified_at": "2023-11-07T05:31:56Z",
        "id": "<string>",
        "name": "<string>",
        "number": "<string>",
        "classification": "asset",
        "object": "<string>"
      },
      "object": "<string>",
      "can_delete": true
    }
  ],
  "current_page": 0,
  "total_records": 1,
  "next_page": 123
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
page
integer
default:0

Page number, 0 indexed.

Required range: x >= 0
​
limit
integer
default:100

Number of records per page.

Required range: 1 <= x <= 500
​
sort_by
enum<string>
default:name
Available options:
name,
created_at
​
sort_order
enum<string>
default:asc
Available options:
asc,
desc
​
is_active
boolean | null

Filter by active status. If true, returns only active adjustments; if false, returns only inactive adjustments.

Response

Successful Response

​
data
Adjustment · object[]
required

The list of records.

​
current_page
integer
default:0
required

The current page.

​
total_records
integer | null
required

Total number of records.

Required range: x >= 0
​
next_page
integer | null
required

The next page number, if one exists.