Articles in this section

See more

Inventory Variance

Avatar
Chinh Nguyen
  • Updated
Follow

Please refer to the API documentation section for the most up-to-date information
https://developer.finaleinventory.com/reference/start

--

IMPORTANT NOTE: physicalInventoryTypeId - REQUIRED field for calls.


Create stock change

Example url: POST http://localsandbox.finaleinventory.com/demo/api/inventoryvariance/

Example request:

{"physicalInventoryUrl":null,"statusId":"PHSCL_INV_COMMITTED","physicalInventoryDate":"2023-05-22T15:00:00.000","physicalInventoryTypeId":"SINGLE","facilityUrl":"/demo/api/facility/100001","generalComments":"test note","inventoryItemVarianceList":[{"productUrl":"/demo/api/product/Ocean%201","facilityUrl":"/demo/api/facility/100001","lotId":null,"varianceReasonId":"VAR_RTN_SUPPLIER","normalizedPackingString":null,"quantityOnHandVar":2}]}

Create stock take

Example url: POST http://localsandbox.finaleinventory.com/demo/api/inventoryvariance/

Example request:

{"facilityUrl":"/demo/api/facility/100001","physicalInventoryUrl":null,"physicalInventoryDate":"2023-05-22T15:00:00.000","physicalInventoryTypeId":"FACILITY_COUNT","inventoryItemVarianceList":[{"productUrl":"/demo/api/product/Lion","facilityUrl":"/demo/api/facility/100001","quantityOnHandCount":12,"varianceReasonId":"VAR_RTN_SUPPLIER"},{"productUrl":"/demo/api/product/Lion","facilityUrl":"/demo/api/facility/100001","normalizedPackingString":"1 cs 1/1","quantityOnHandCount":1,"varianceReasonId":"VAR_RTN_SUPPLIER"}]}

 

Update inventory variance

Example url: POST http://localsandbox.finaleinventory.com/demo/api/inventoryvariance/100000

Example request:

{"actionUrlCommit":"/demo/api/inventoryvariance/100000/commit","actionUrlCancel":"/demo/api/inventoryvariance/100000/cancel","facilityUrl":"/demo/api/facility/100001","physicalInventoryUrl":"/demo/api/inventoryvariance/100000","externalUrl":null,"physicalInventoryDate":"2023-05-22T15:00:00","physicalInventoryTypeId":"FACILITY_COUNT","inventoryItemVarianceList":[{"facilityUrl":"/demo/api/facility/100001","productId":"Cat","productUrl":"/demo/api/product/Cat","quantityOnHandCount":12,"quantityOnHandVar":12},{"facilityUrl":"/demo/api/facility/100001","productId":"Lion","productUrl":"/demo/api/product/Lion","quantityOnHandCount":10,"quantityOnHandVar":10}],"statusId":"PHSCL_INV_INPUT","statusIdHistoryList":[{"statusId":null,"txStamp":1684766129,"userLoginUrl":"/demo/api/userlogin/testSuper"}],"generalComments":"Test stock take"}

Commit inventory variance

Example url: POST http://localsandbox.finaleinventory.com/demo/api/inventoryvariance/100000/commit

 

Cancel inventory variance

Example url: POST http://localsandbox.finaleinventory.com/demo/api/inventoryvariance/100000/cancel

Note: once an inventory variance has been committed or canceled it cannot be updated again. Attempting to do so will result in an error like below:

{"msg":"can not modify since statusId != PHSCL_INV_INPUT"}

 

Example inventory variance response:

{"physicalInventoryId":"100000","physicalInventoryUrl":"/demo/api/inventoryvariance/100000","physicalInventoryTypeId":"FACILITY_COUNT","physicalInventoryDate":"2023-05-22T15:00:00","statusId":"PHSCL_INV_COMMITTED","facilityUrl":"/demo/api/facility/100001","generalComments":"Test stock take","lastUpdatedDate":"2023-05-22T14:35:38","createdDate":"2023-05-22T14:35:29","actionUrlCancel":"/demo/api/inventoryvariance/100000/cancel","contentList":[],"inventoryItemVarianceList":[{"facilityUrl":"/demo/api/facility/100001","productId":"Cat","productUrl":"/demo/api/product/Cat","quantityOnHandVar":12,"quantityOnHandCount":12},{"facilityUrl":"/demo/api/facility/100001","productId":"Lion","productUrl":"/demo/api/product/Lion","quantityOnHandVar":10,"quantityOnHandCount":10}],"connectionRelationUrlList":[],"consolidatedItemList":[],"statusIdHistoryList":[{"statusId":null,"txStamp":1684766129,"userLoginUrl":"/demo/api/userlogin/testSuper"},{"statusId":"PHSCL_INV_COMMITTED","txStamp":1684766138,"userLoginUrl":"/demo/api/userlogin/testSuper"}],"invalidations":["/demo/api/inventoryitem/","/demo/api/inventoryvariancesummary/"]}

 

Fields

actionUrlCancel

Read only. POST to this URL with an empty body to change status to PHSCL_INV_CANCELLED which corresponds to the status of “canceled” in the user interface.

actionUrlCommit

Read only. POST to this URL with an empty body to change status to PHSCL_INV_COMMITED which corresponds to the status of “commited” in the user interface.

createdDate

Read only. Represents the date this inventory variance was created in the UTC timezone. Example: 2023-05-22T15:00:00.000

lastUpdatedDate

Read only. Represents the date this inventory variance was last updated in the UTC timezone. Example: 2023-05-22T15:00:00.000

generalComments

String. Up to 255 characters corresponding to the note field in the user interface.

physicalInventoryTypeId - REQUIRED

One of SINGLE, FACILITY_COUNT, FACILITY.

SINGLE: used for quick stock changes that affect a single item.

FACILITY: used for stock changes that affect multiple items.

FACILITY_COUNT: used for stock takes.

physicalInventoryDate

Date. Represents the date this inventory variance took place. Only the date component is relevant. Example: 2023-05-21.

physicalInventoryId

Read only.

physicalInventoryUrl

Read only. Use this value to create requests to update an inventory variance.

facilityUrl

String. This is a reference to the facility that will be affected by the inventory variance.

statusIdHistoryList.

Read only. Array representing the history of status changes for an inventory variance.

statusID.

Read only. This field can only be modified by doing a commit or cancel request. Valid values are PHSCL_INV_CANCELLED, which corresponds to “canceled”, PHSCL_INV_COMMITED, which corresponds to “committed” or PHSCL_INV_INPUT, which is the default state for new inventory variances.

 

inventoryItemVarianceList

This is an array of zero or more items that are part of the inventory variance.

There are two types of items in this array representing individual and case stock changes.

An inventory item variance for individual items has the below format:

{
    "productUrl": "/demo/api/product/Lion",
    "facilityUrl": "/demo/api/facility/100001",
    "quantityOnHandCount": 12, (or quantityonHandVar for stock changes)
    "varianceReasonId": "VAR_RTN_SUPPLIER"
}

An inventory item variance for case stock has the below format:

{
    "productUrl": "/demo/api/product/Lion",
    "facilityUrl": "/demo/api/facility/100001",
    "normalizedPackingString": "1 cs 1/1",
    "quantityOnHandCount": 1, (or quantityonHandVar for stock changes)
    "varianceReasonId": "VAR_RTN_SUPPLIER"
}

 

inventoryItemVarianceList fields:

    • productUrl: the url of the product that this inventory item refers to.
    • comments: String of up to 255 characters.
    • facilityUrl: Reference to the affected location.
    • quantityOnHandVar: Number. Represents the amount that a quantity will be changed when committing this variance. Used for stock changes.
    • quantityOnHandCount: Number. Represents the new quantity on hand that will be set when committing this variance. Used for stock takes.
    • varianceReasonId: Optional. The reason for this inventory variance. Valid values are: VAR_DAMAGED (Damaged), VAR_EXPIRED (Expired), VAR_FOUND (Found), VAR_LOST (Lost), VAR_RTN_CUSTOMER (Return from customer), VAR_RTN_SUPPLIER (Return to supplier), VAR_SAMPLE (Sample), VAR_STOLEN (Stolen)
    • normalizedPackingString: Packing for the item (see patterns for description of this data type). (EDITOR NOTE: MUST LINK TO https://support.finaleinventory.com/hc/en-us/articles/115007671627-Resource-Patterns)

consolidatedItemList

Internal.

connectionRelationUrlList

Internal.

contentList

 Internal.

 

 

Related articles

Comments

0 comments

Article is closed for comments.