Reconciliation

Manage inventory reconciliation processes. Requires PERFORM_RECONCILIATION permission.

Base URL: /api/v1/partner/reconciliations

Endpoints Overview

Method	Endpoint	Description
GET	/	Get Reconciliation History
GET	/{reconciliationId}	Get Reconciliation History By ID
POST	/	Create Reconciliation Request

---

Get Reconciliation History

GET /api/v1/partner/reconciliations

Retrieve a paginated list of reconciliation history records. Optionally filter by requestNo. Requires the PERFORM_RECONCILIATION partner permission.

Required Permission

PERFORM_RECONCILIATION

Query Parameters

Parameter	Type	Required	Description
requestNo	long	No	request no
start	integer	No	Number of records to skip
limit	integer	No	Maximum records to return

Response

Returns a paginated SearchResult of ReconciliationHistory objects.

Fields

Field	Type	Required	Description
id	string	No	Unique identifier
companyId	string	No	Company identifier
shopId	string	No	Shop identifier
created	long	No	Created timestamp (epoch ms)
modified	long	No	Last modified timestamp (epoch ms)
deleted	boolean	No	Whether the record is deleted
updated	boolean	No	Whether the record has been updated
requestNo	long	No	Request No
employeeId	string	No	Employee identifier
transNo	string	No	Trans No
metrcAdjustmentOption	string	No	Metrc Adjustment Option. One of: ADJUST_BY_DIFFERENCE, ADJUST_BY_FINAL_AMOUNT, DO_NOT_ADJUST_METRC (default: ADJUST_BY_FINAL_AMOUNT)
complianceAdjustmentOption	string	No	Compliance Adjustment Option. One of: ADJUST_BY_DIFFERENCE, ADJUST_BY_FINAL_AMOUNT, DO_NOT_ADJUST
complianceFinishedPackageTags	string[]	No	Compliance Finished Package Tags
reconciliations	ReconciliationHistoryList[]	No	Reconciliations
batchQuantityInfoMap	object	No	Batch Quantity Info Map
batchReconcile	boolean	No	Batch Reconcile (default: false)
inventoryId	string	No	Inventory identifier
audit	boolean	No	Audit (default: false)
note	string	No	Note
blind	boolean	No	Blind
forceScan	boolean	No	Force Scan
fullInventory	boolean	No	Full Inventory
complianceReason	string	No	Compliance Reason
value	string	No	Value
value	string	No	Value

JSON

{
  "id": "abc123",
  "companyId": "abc123",
  "shopId": "abc123",
  "created": 1704067200000,
  "modified": 1704067200000,
  "deleted": false,
  "updated": false,
  "requestNo": 0,
  "employeeId": "abc123",
  "transNo": "TXN-001",
  "metrcAdjustmentOption": "ADJUST_BY_FINAL_AMOUNT",
  "complianceAdjustmentOption": "ADJUST_BY_DIFFERENCE",
  "complianceFinishedPackageTags": [],
  "reconciliations": [
    {
      "id": "abc123",
      "productId": "abc123",
      "productName": "string",
      "oldQuantity": 0,
      "newQuantity": 0,
      "prePackageItemId": "abc123",
      "terminalId": "abc123",
      "inventoryId": "abc123",
      "errorMsg": "string",
      "reportLoss": false,
      "note": {},
      "batchId": "abc123",
      "batchSku": "string",
      "brandName": "string",
      "metrcReason": "string",
      "complianceReason": "string",
      "operations": []
    }
  ],
  "batchQuantityInfoMap": {},
  "batchReconcile": false,
  "inventoryId": "abc123",
  "audit": false,
  "note": "string",
  "blind": false,
  "forceScan": false,
  "fullInventory": false,
  "complianceReason": "string",
  "value": "string"
}

---

Get Reconciliation History By ID

GET /api/v1/partner/reconciliations/{reconciliationId}

Retrieve a single reconciliation record by its ID. Requires the PERFORM_RECONCILIATION partner permission.

Required Permission

PERFORM_RECONCILIATION

Path Parameters

Parameter	Type	Description
reconciliationId	string	The reconciliation i d

Response

Returns a ReconciliationHistory object.

Fields

Field	Type	Required	Description
id	string	No	Unique identifier
companyId	string	No	Company identifier
shopId	string	No	Shop identifier
created	long	No	Created timestamp (epoch ms)
modified	long	No	Last modified timestamp (epoch ms)
deleted	boolean	No	Whether the record is deleted
updated	boolean	No	Whether the record has been updated
requestNo	long	No	Request No
employeeId	string	No	Employee identifier
transNo	string	No	Trans No
metrcAdjustmentOption	string	No	Metrc Adjustment Option. One of: ADJUST_BY_DIFFERENCE, ADJUST_BY_FINAL_AMOUNT, DO_NOT_ADJUST_METRC (default: ADJUST_BY_FINAL_AMOUNT)
complianceAdjustmentOption	string	No	Compliance Adjustment Option. One of: ADJUST_BY_DIFFERENCE, ADJUST_BY_FINAL_AMOUNT, DO_NOT_ADJUST
complianceFinishedPackageTags	string[]	No	Compliance Finished Package Tags
reconciliations	ReconciliationHistoryList[]	No	Reconciliations
batchQuantityInfoMap	object	No	Batch Quantity Info Map
batchReconcile	boolean	No	Batch Reconcile (default: false)
inventoryId	string	No	Inventory identifier
audit	boolean	No	Audit (default: false)
note	string	No	Note
blind	boolean	No	Blind
forceScan	boolean	No	Force Scan
fullInventory	boolean	No	Full Inventory
complianceReason	string	No	Compliance Reason
value	string	No	Value
value	string	No	Value

JSON

{
  "id": "abc123",
  "companyId": "abc123",
  "shopId": "abc123",
  "created": 1704067200000,
  "modified": 1704067200000,
  "deleted": false,
  "updated": false,
  "requestNo": 0,
  "employeeId": "abc123",
  "transNo": "TXN-001",
  "metrcAdjustmentOption": "ADJUST_BY_FINAL_AMOUNT",
  "complianceAdjustmentOption": "ADJUST_BY_DIFFERENCE",
  "complianceFinishedPackageTags": [],
  "reconciliations": [
    {
      "id": "abc123",
      "productId": "abc123",
      "productName": "string",
      "oldQuantity": 0,
      "newQuantity": 0,
      "prePackageItemId": "abc123",
      "terminalId": "abc123",
      "inventoryId": "abc123",
      "errorMsg": "string",
      "reportLoss": false,
      "note": {},
      "batchId": "abc123",
      "batchSku": "string",
      "brandName": "string",
      "metrcReason": "string",
      "complianceReason": "string",
      "operations": []
    }
  ],
  "batchQuantityInfoMap": {},
  "batchReconcile": false,
  "inventoryId": "abc123",
  "audit": false,
  "note": "string",
  "blind": false,
  "forceScan": false,
  "fullInventory": false,
  "complianceReason": "string",
  "value": "string"
}

---

Create Reconciliation Request

POST /api/v1/partner/reconciliations

Create a new inventory reconciliation request. Requires the PERFORM_RECONCILIATION partner permission.

Required Permission

PERFORM_RECONCILIATION

Request Body

Fields

Field	Type	Required	Description
terminalId	string	No	Terminal identifier
inventoryId	string	No	Inventory identifier
reportLoss	boolean	No	Report Loss (default: false)
note	string	No	Note
productLossRequests	ProductLossRequest[]	No	Product Loss Requests
batchReconcile	boolean	No	Batch Reconcile (default: false)
audit	boolean	No	Audit
blind	boolean	No	Blind
forceScan	boolean	No	Force Scan
fullInventory	boolean	No	Full Inventory
complianceReason	string	No	Compliance Reason
employeeId	string	No	Employee identifier

JSON

{
  "terminalId": "abc123",
  "inventoryId": "abc123",
  "reportLoss": false,
  "note": "string",
  "productLossRequests": [
    {
      "productId": "abc123",
      "quantity": 0,
      "batchId": "abc123",
      "prepackageItemId": "abc123",
      "note": "string",
      "batchSku": "string",
      "metrcReason": "string",
      "complianceReason": "string"
    }
  ],
  "batchReconcile": false,
  "audit": false,
  "blind": false,
  "forceScan": false,
  "fullInventory": false,
  "complianceReason": "string",
  "employeeId": "abc123"
}

Response

Returns a ReconciliationHistory object.

Fields

Field	Type	Required	Description
id	string	No	Unique identifier
companyId	string	No	Company identifier
shopId	string	No	Shop identifier
created	long	No	Created timestamp (epoch ms)
modified	long	No	Last modified timestamp (epoch ms)
deleted	boolean	No	Whether the record is deleted
updated	boolean	No	Whether the record has been updated
requestNo	long	No	Request No
employeeId	string	No	Employee identifier
transNo	string	No	Trans No
metrcAdjustmentOption	string	No	Metrc Adjustment Option. One of: ADJUST_BY_DIFFERENCE, ADJUST_BY_FINAL_AMOUNT, DO_NOT_ADJUST_METRC (default: ADJUST_BY_FINAL_AMOUNT)
complianceAdjustmentOption	string	No	Compliance Adjustment Option. One of: ADJUST_BY_DIFFERENCE, ADJUST_BY_FINAL_AMOUNT, DO_NOT_ADJUST
complianceFinishedPackageTags	string[]	No	Compliance Finished Package Tags
reconciliations	ReconciliationHistoryList[]	No	Reconciliations
batchQuantityInfoMap	object	No	Batch Quantity Info Map
batchReconcile	boolean	No	Batch Reconcile (default: false)
inventoryId	string	No	Inventory identifier
audit	boolean	No	Audit (default: false)
note	string	No	Note
blind	boolean	No	Blind
forceScan	boolean	No	Force Scan
fullInventory	boolean	No	Full Inventory
complianceReason	string	No	Compliance Reason
value	string	No	Value
value	string	No	Value

JSON

{
  "id": "abc123",
  "companyId": "abc123",
  "shopId": "abc123",
  "created": 1704067200000,
  "modified": 1704067200000,
  "deleted": false,
  "updated": false,
  "requestNo": 0,
  "employeeId": "abc123",
  "transNo": "TXN-001",
  "metrcAdjustmentOption": "ADJUST_BY_FINAL_AMOUNT",
  "complianceAdjustmentOption": "ADJUST_BY_DIFFERENCE",
  "complianceFinishedPackageTags": [],
  "reconciliations": [
    {
      "id": "abc123",
      "productId": "abc123",
      "productName": "string",
      "oldQuantity": 0,
      "newQuantity": 0,
      "prePackageItemId": "abc123",
      "terminalId": "abc123",
      "inventoryId": "abc123",
      "errorMsg": "string",
      "reportLoss": false,
      "note": {},
      "batchId": "abc123",
      "batchSku": "string",
      "brandName": "string",
      "metrcReason": "string",
      "complianceReason": "string",
      "operations": []
    }
  ],
  "batchQuantityInfoMap": {},
  "batchReconcile": false,
  "inventoryId": "abc123",
  "audit": false,
  "note": "string",
  "blind": false,
  "forceScan": false,
  "fullInventory": false,
  "complianceReason": "string",
  "value": "string"
}