Restolution JSON API "getTransfers"

[limealot]

getTransfers

Gets all storage transfers from Restolution. The transfers are returned as an array of Transfers. The endpoint mimics the parameters and data in Transfer Summary Report in Restolution.

Transfer

The transfers returned by the "getTransfers" method are objects of "Transfer" which contains the rows of the transfer as an array of TransferRows.

• clientUUID - globally unique identifier of the Restolution client that this transfer belongs to (a type 4 UUID as specified by RFC 4122)
• transferDate - timestamp when this transfer took place and affected the storage values
• verifiedDate - timestamp when this transfer was verified
• fromBusinessUnitUUID - globally unique identifier of the Restolution business unit that this transfer reduced (a type 4 UUID as specified by RFC 4122)
• toBusinessUnitUUID - globally unique identifier of the Restolution business unit that this transfer added to (a type 4 UUID as specified by RFC 4122)
• fromStorageName - name of the storage that this transfer reduced
• toStorageName - name of the storage that this transfer added to
• userName - name of user who created this transfer
• verifier - name of user who verified this transfer
• status - the status of this transfer, can be one of IN_PROGRESS, DONE, VERIFIED.
• comment - a comment about this transfer
• transferRows - array of transfer rows

TransferRow

The transfer rows contain on article level the quantities and purchase prices of the transfer.

• articleUUID - globally unique identifier for this transfer row's article (a type 4 UUID as specified by RFC 4122)
• articleName - article name of this transfer row's article
• storageArticleID - storage article ID of this transfer row's storage article
• quantity - the SI unit quantity of the article of this transfer row in 1/1000 parts
• quantityInBaseUnits - the baseunit quantity of the article of this transfer row in 1/1000 parts
• baseUnit - the base unit of this transfer row's article, e.g. a bottle, BTL.
• baseUnitInSIUnits - base unit in SI units, e.g. how many grams in a kilogram. Note that this defaults to 1 for all units that can have different sizes, in 1/1000 parts.
• purchasePriceWithTax - The purchase price of a base unit of this transfer row's article including tax
• purchaseTax - The purchase tax percentage applied to the purchase of this transfer row's article. Given as a whole number, e.g 24% is given as 24.

parameters:

• dateFrom - get transfers that have transfer date equal to or later than this date. This parameter is required.
• dateUntil - get transfers that have transfer date equal to or earlier than this date.
• businessUnitUUIDs - optional list of business unit UUID's whose transfers (from or to) should be included. If this parameter is not given, the transfers of all business units will be included.

response:

• transfers - array of Transfer objects

sample request:

{
  "apiKey":"user_321683", 
  "timestamp": "2022-01-20T15:13:40.988Z",
  "requestID": "test_request_id",
  "method": "getTransfers",
  "params": {
      "dateFrom":"2022-01-01T05:00:00.00Z",
      "dateUntil":"2022-01-07T04:59:59.99Z",
      "businessUnitUUIDs": ["e2223c3b-5f6d-4873-b21b-2c06a2d6fe1b","4a67c7a2-bbf6-4130-be16-f4f7b2571d92"]
  }   
}

sample response:

{
  "success": true,
  "timestamp": "2022-04-04T08:46:58.426Z",
  "requestID": "test_request_id",
  "response": {
    "transfers": [
      {
        "clientUUID": "fba3d9ac-1bb6-49ea-a1cd-d147d6a7e238",
        "transferDate": "2021-08-18T04:59:59.99",
        "verifiedDate": "2021-08-17T12:41:10.869",
        "fromBusinessUnitUUID": "e2223c3b-5f6d-4873-b21b-2c06a2d6fe1b",
        "toBusinessUnitUUID": "4a67c7a2-bbf6-4130-be16-f4f7b2571d92",
        "fromStorageName": "Testivarasto 1",
        "toStorageName": "Testivarasto 2",
        "userName": "Milla Mallikas",
        "verifier": "Milla Mallikas",
        "status": "VERIFIED",
        "comment": "comment",
        "transferRows": [
          {
            "articleUUID": "a23ccb6d-f819-40b7-82ba-549d20dc499c",
            "storageArticleID": "816",
            "articleName": "Craft IPA",
            "quantity": 40500,
            "quantityInBaseUnits": 54000,
            "baseUnit": "PLO",
            "baseUnitInSIUnits": 750,
            "purchasePriceWithTax": 1620,
            "purchaseTax": 24
          },
          {
            "articleUUID": "334fca7c-e419-4b7d-846b-8d5422091ceb",
            "storageArticleID": "104",
            "articleName": "Fine Sherry",
            "quantity": 18750,
            "quantityInBaseUnits": 25000,
            "baseUnit": "PLO",
            "baseUnitInSIUnits": 750,
            "purchasePriceWithTax": 500,
            "purchaseTax": 24
          }
        ]
      }
    ]
  }
}

[limealot]

Merged to main specification document.