Skip to main content

Get Stock Transfer Listing (Specific)

Get stock transfer listing using specific listing filters.

Request​

POST:/{accountBookId}/stockTransfer/listing

Request Body​

object: Stock Transfer Listing Input Model

Example Request Body
Get stock transfer listing using a date filter

Available date filters for stock transfer records are date, createdDate and lastModifiedDate. Add date filters in stock transfer listing filter input model according to your needs.

Example: Get stock transfer records with document date falling between a specific date range.

Date formats for from and to fields can be found here.

{
  "page": 1,
  "filter": {
    "date": {
      "from": "2022-05-02",
      "to": "2023-05-02"
    }
  }
}
Get stock transfer listing using a string filter

Available string filters for stock transfer records are docNo, fromLocation and toLocation. Add string filters in stock transfer listing filter input model according to your needs.

Example: Get stock transfer records with specific document numbers.

For filtering specific string values, use the multiSelect field in the filter.

{
  "page": 1,
  "filter": {
    "docNo": {
      "multiSelect": ["XFER-000001", "XFER-000002"]
    }
  }
}

Example: Get stock transfer records with document number falling between a range of string values.

For filtering a range of string values, use the from and to fields in the filter.

{
  "page": 1,
  "filter": {
    "docNo": {
      "from": "XFER-000001",
      "to": "XFER-000005"
    }
  }
}

Composite example:

{
  "page": 1,
  "filter": {
    "date": {
      "from": "2023-01-06",
      "to": "2023-05-06"
    },
    "docNo": {
      "multiSelect": ["XFER-000001","XFER-000003","XFER-000005"]
    }
  }
}

Example Request URL:

Parameters:
accountBookId = 1

URL:
POST: https://accounting-api.autocountcloud.com/1/stocktransfer/listing

Response​

Success Response​

Status Code: 200

Response Body​

FieldDescriptionType
dataResponse data.array[Stock Transfer View Model]
totalCountNumber of records retrieved.number
Example Success Response Body
{
    "data": [
        {
            "master": {
                "docKey": 44,
                "docNo": "XFER-000001",
                "docDate": "2023-03-14T00:00:00",
                "fromLocation": null,
                "toLocation": null,
                "ref": "",
                "description": "Transfer Shirts from HQ to Warehouse",
                "note": "",
                "reason": "Insufficient storage space",
                "authorisedBy": "Mr Kam",
                "remark1": "",
                "remark2": "",
                "remark3": "",
                "remark4": "",
                "cancelled": false,
                "total": 100000.00,
                "createdTimeStamp": "2023-03-14T14:15:34.8529222",
                "createdUserID": "ADMIN",
                "lastModified": "2023-03-14T14:45:26.323535",
                "lastModifiedUserID": "ADMIN",
                "status": "Approved",
                "approverID": "ADMIN",
                "approvedTimeStamp": "2023-03-06T16:42:26.9875477",
                "rejectReason": null
            },
            "details": [
                {
                    "docKey": 44,
                    "dtlKey": 157,
                    "inDtlKey": 158,
                    "seq": 0,
                    "stockId": 0,
                    "stockCode": "P-00001",
                    "description": "Shirt",
                    "furtherDescription": "",
                    "qty": 500.00000000,
                    "unitCost": 200.00000000,
                    "subTotal": 100000.00,
                    "deptNo": null
                }
            ]
        }
    ],
    "totalCount": 1
}

Error Response​

Response Body​

object: Error Response Model

Example Error Response Body
{
  "statusCode": 401,
  "message": "401 Unauthorized."
}