Schema Reference API v1.0.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Base URLs:

https://goldleaf.app/api/v1

Schemas

InventoryItem

{
  "title": "InventoryItem",
  "required": ["_id", "item", "itemType", "created", "lastModified", "deleted"],
  "properties": {
    "_id": {
      "type": "string"
    },
    "warehouse": {
      "type": "string"
    },
    "warehouseName": {
      "type": "string"
    },
    "brandName": {
      "type": "string"
    },
    "partNumber": {
      "type": "string"
    },
    "orgPartNumber": {
      "type": "string"
    },
    "item": {
      "type": "string"
    },
    "itemType": {
      "type": "string"
    },
    "onHand": {
      "type": "number"
    },
    "onOrder": {
      "type": "number"
    },
    "committed": {
      "type": "number"
    },
    "unitOfMeasure": {
      "type": "string"
    },
    "bin": {
      "type": "string"
    },
    "recordSource": {
      "type": "string"
    },
    "created": {
      "type": "string",
      "format": "date-time"
    },
    "createdBy": {
      "type": "string"
    },
    "lastModified": {
      "type": "string",
      "format": "date-time"
    },
    "lastModifiedBy": {
      "type": "string"
    },
    "deleted": {
      "type": "boolean"
    },
    "deletedDate": {
      "type": "string",
      "format": "date-time"
    },
    "deletedBy": {
      "type": "string"
    }
  }
}

InventoryItem

Properties

Name	Type	Required	Restrictions	Description
_id	string	true	none	none
warehouse	string	false	none	none
warehouseName	string	false	none	none
brandName	string	false	none	none
partNumber	string	false	none	none
orgPartNumber	string	false	none	none
item	string	true	none	none
itemType	string	true	none	none
onHand	number	false	none	none
onOrder	number	false	none	none
committed	number	false	none	none
unitOfMeasure	string	false	none	none
bin	string	false	none	none
recordSource	string	false	none	none
created	string(date-time)	true	none	none
createdBy	string	false	none	none
lastModified	string(date-time)	true	none	none
lastModifiedBy	string	false	none	none
deleted	boolean	true	none	none
deletedDate	string(date-time)	false	none	none
deletedBy	string	false	none	none