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

PriceList

{
  "title": "PriceList",
  "required": ["_id", "priceListId", "name", "lastModified", "created", "deleted"],
  "properties": {
    "_id": {
      "type": "string"
    },
    "priceListId": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "lastModified": {
      "type": "string",
      "format": "date-time"
    },
    "created": {
      "type": "string",
      "format": "date-time"
    },
    "deleted": {
      "type": "boolean"
    },
    "lastModifiedBy": {
      "type": "string"
    },
    "createdBy": {
      "type": "string"
    },
    "deletedBy": {
      "type": "string"
    },
    "defaultCurrency": {
      "type": "string"
    },
    "defaultMarginPercentMaterials": {
      "type": "number"
    },
    "defaultMarginPercentLabour": {
      "type": "number"
    },
    "listPricing": {
      "type": "boolean"
    },
    "defaultDiscountPercentMaterials": {
      "type": "number"
    },
    "defaultItemPricing": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "itemType": {
            "type": "string"
          },
          "defaultMarginPercent": {
            "type": "number"
          },
          "defaultDiscountPercent": {
            "type": "number"
          },
          "listPricing": {
            "type": "boolean"
          },
          "enabled": {
            "type": "boolean"
          }
        },
        "required": []
      }
    }
  }
}

PriceList

Properties

Name	Type	Required	Restrictions	Description
_id	string	true	none	none
priceListId	string	true	none	none
name	string	true	none	none
lastModified	string(date-time)	true	none	none
created	string(date-time)	true	none	none
deleted	boolean	true	none	none
lastModifiedBy	string	false	none	none
createdBy	string	false	none	none
deletedBy	string	false	none	none
defaultCurrency	string	false	none	none
defaultMarginPercentMaterials	number	false	none	none
defaultMarginPercentLabour	number	false	none	none
listPricing	boolean	false	none	none
defaultDiscountPercentMaterials	number	false	none	none
defaultItemPricing	[object]	false	none	none
» itemType	string	false	none	none
» defaultMarginPercent	number	false	none	none
» defaultDiscountPercent	number	false	none	none
» listPricing	boolean	false	none	none
» enabled	boolean	false	none	none