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

CustomerItemProperties

{
  "title": "CustomerItemProperties",
  "required": ["_id", "item", "customer", "lastModified", "created", "deleted", "itemType"],
  "properties": {
    "_id": {
      "type": "string"
    },
    "item": {
      "type": "string"
    },
    "customer": {
      "type": "string"
    },
    "startDate": {
      "type": "string",
      "format": "date-time"
    },
    "endDate": {
      "type": "string",
      "format": "date-time"
    },
    "lastModified": {
      "type": "string",
      "format": "date-time"
    },
    "created": {
      "type": "string",
      "format": "date-time"
    },
    "lastModifiedBy": {
      "type": "string"
    },
    "createdBy": {
      "type": "string"
    },
    "deleted": {
      "type": "boolean"
    },
    "deletedDate": {
      "type": "string",
      "format": "date-time"
    },
    "deletedBy": {
      "type": "string"
    },
    "orgPartNumber": {
      "type": "string"
    },
    "available": {
      "type": "boolean"
    },
    "priority": {
      "type": "string"
    },
    "cost": {
      "type": "number"
    },
    "costCurrency": {
      "type": "string"
    },
    "unitOfMeasure": {
      "type": "string"
    },
    "netPrice": {
      "type": "number"
    },
    "netPriceCurrency": {
      "type": "string"
    },
    "netPriceUnitOfMeasure": {
      "type": "string"
    },
    "itemType": {
      "type": "string"
    },
    "recordSource": {
      "type": "string"
    },
    "erpHeaderId": {
      "type": "string"
    },
    "erpId": {
      "type": "string"
    }
  }
}

CustomerItemProperties

Properties

Name	Type	Required	Restrictions	Description
_id	string	true	none	none
item	string	true	none	none
customer	string	true	none	none
startDate	string(date-time)	false	none	none
endDate	string(date-time)	false	none	none
lastModified	string(date-time)	true	none	none
created	string(date-time)	true	none	none
lastModifiedBy	string	false	none	none
createdBy	string	false	none	none
deleted	boolean	true	none	none
deletedDate	string(date-time)	false	none	none
deletedBy	string	false	none	none
orgPartNumber	string	false	none	none
available	boolean	false	none	none
priority	string	false	none	none
cost	number	false	none	none
costCurrency	string	false	none	none
unitOfMeasure	string	false	none	none
netPrice	number	false	none	none
netPriceCurrency	string	false	none	none
netPriceUnitOfMeasure	string	false	none	none
itemType	string	true	none	none
recordSource	string	false	none	none
erpHeaderId	string	false	none	none
erpId	string	false	none	none