GET v1/Adjustments?fields={fields}&where={where}&order={order}&page={page}&rows={rows}

Get a list of Adjustments.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
fields

A comma-separated list of field names

string

None.

where

A where clause

string

None.

order

An order by clause

string

None.

page

The page number (default: 1)

integer

Default value is 1

rows

Rows per page (default: 50, maximum: 250)

integer

Default value is 50

Body Parameters

None.

Response Information

Resource Description

Collection of Adjustment
NameDescriptionTypeAdditional information
Id

The unique Cin7 Id.

integer

None.

CreatedDate

Order created date

date

None.

ModifiedDate

Order last modified date

date

None.

CreatedBy

The ID for the User who created the Transaction.

integer

None.

ProcessedBy

The ID for the User who processed the Transaction.

integer

None.

IsApproved

Is Approved (default: true)

boolean

None.

Reference

A unique order reference (leave blank to auto-generate in an insert).

string

Max length: 20

BranchId

Branch ID.

integer

None.

CompletedDate

Completed Date.

date

None.

AdjustInAccountingSystem

Date to adjust in Accounting system.

date

None.

AdjustmentReason

The reason for adjusting Stock.

string

None.

AlternativeAccountCode

Alternative GL Account.

string

None.

ProductTotal

Product Total.

decimal number

None.

Source

The source of the Transaction.

string

None.

LineItems

Line Items.

Collection of AdjustmentItem

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "id": 1,
    "createdDate": "2020-10-20T02:20:46.5939481Z",
    "modifiedDate": "2020-10-20T02:20:46.5939481Z",
    "createdBy": 0,
    "processedBy": 0,
    "isApproved": false,
    "reference": "ADJ-1",
    "branchId": 3,
    "completedDate": "2020-10-20T00:00:00+13:00",
    "adjustInAccountingSystem": null,
    "adjustmentReason": null,
    "alternativeAccountCode": null,
    "productTotal": 0.0,
    "source": "API",
    "lineItems": [
      {
        "id": 1,
        "createdDate": "2020-10-20T02:20:46.5939481Z",
        "transactionId": 128,
        "parentId": 0,
        "productId": 1,
        "productOptionId": 1,
        "integrationRef": null,
        "sort": 1,
        "code": "",
        "name": "V-NECK TSHIRT",
        "option1": "Red",
        "option2": "XXL",
        "option3": "Yes",
        "qty": 2.0,
        "qtyAdjusted": 0.0,
        "holdingQty": 0.0,
        "account": null,
        "unitCost": 0.0
      }
    ]
  }
]