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

OrganizationProperties

{
  "title": "OrganizationProperties",
  "required": ["_id", "name", "lastModified", "created", "deleted"],
  "properties": {
    "_id": {
      "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"
    },
    "subscription": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "subscriptionType": {
            "type": "string"
          },
          "startDate": {
            "type": "string",
            "format": "date-time"
          },
          "expires": {
            "type": "string",
            "format": "date-time"
          },
          "user": {
            "type": "object",
            "properties": {}
          }
        },
        "required": []
      }
    },
    "maxUsers": {
      "type": "number"
    },
    "status": {
      "type": "string"
    },
    "settings": {
      "type": "object",
      "properties": {
        "defaultLengthUnit": {
          "type": "string"
        },
        "defaultLengthUnitBillOfMaterials": {
          "type": "string"
        },
        "defaultPressureUnit": {
          "type": "string"
        },
        "defaultPaperSize": {
          "type": "string"
        },
        "addSalesTax": {
          "type": "boolean"
        },
        "storeHistory": {
          "type": "object",
          "properties": {
            "value": {
              "type": "boolean"
            },
            "historyCount": {
              "type": "number"
            },
            "historyDays": {
              "type": "number"
            }
          }
        },
        "salesEstimates": {
          "type": "object",
          "properties": {
            "standardFooter": {
              "type": "string"
            }
          }
        },
        "customers": {
          "type": "object",
          "properties": {
            "showCustomerLogoOnDrawings": {
              "type": "boolean"
            },
            "hideCutLengthOnDrawings": {
              "type": "boolean"
            },
            "boldOverAllLengthOnDrawings": {
              "type": "boolean"
            }
          }
        },
        "hoseAssemblies": {
          "type": "object",
          "properties": {
            "autoPartNumbers": {
              "type": "boolean"
            },
            "autoPartNumberFormat": {
              "type": "string"
            },
            "nextSequentialNumber": {
              "type": "number"
            }
          }
        },
        "hoseKits": {
          "type": "object",
          "properties": {
            "autoPartNumbers": {
              "type": "boolean"
            },
            "autoPartNumberFormat": {
              "type": "string"
            },
            "nextSequentialNumber": {
              "type": "number"
            }
          }
        },
        "salesTax": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "taxId": {
                "type": "string"
              },
              "taxCode": {
                "type": "string"
              },
              "percentage": {
                "type": "number"
              }
            },
            "required": []
          }
        },
        "defaultSalesTax": {
          "type": "string"
        },
        "defaultCurrency": {
          "type": "string"
        },
        "defaultLabelSize": {
          "type": "object",
          "properties": {
            "width": {
              "type": "number"
            },
            "height": {
              "type": "number"
            }
          }
        },
        "defaultWarehouse": {
          "type": "string"
        },
        "hideInventory": {
          "type": "boolean"
        },
        "shopLabourCost": {
          "type": "number"
        },
        "shopLabourCurrency": {
          "type": "string"
        },
        "defaultMarginPercentMaterials": {
          "type": "number"
        },
        "defaultMarginPercentLabour": {
          "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": []
          }
        },
        "defaultHoseBrand": {
          "type": "string"
        },
        "defaultAdaptorBrand": {
          "type": "string"
        },
        "defaultWrapBrand": {
          "type": "string"
        },
        "defaultOtherItemBrand": {
          "type": "string"
        },
        "defaultLocale": {
          "type": "string"
        },
        "revisionDelimiter": {
          "type": "string"
        },
        "useStandardPartNumbers": {
          "type": "boolean"
        },
        "listPricing": {
          "type": "boolean"
        },
        "labourRates": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "size": {
                "type": "string"
              },
              "cost": {
                "type": "number"
              },
              "currency": {
                "type": "string"
              },
              "unitOfMeasure": {
                "type": "string"
              },
              "available": {
                "type": "boolean"
              },
              "deleted": {
                "type": "boolean"
              }
            },
            "required": []
          }
        },
        "scrapRates": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "size": {
                "type": "string"
              },
              "percent": {
                "type": "number"
              },
              "available": {
                "type": "boolean"
              },
              "deleted": {
                "type": "boolean"
              }
            },
            "required": []
          }
        },
        "wrapLabourRates": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "size": {
                "type": "string"
              },
              "wrapType": {
                "type": "string"
              },
              "cost": {
                "type": "number"
              },
              "currency": {
                "type": "string"
              },
              "unitOfMeasure": {
                "type": "string"
              },
              "available": {
                "type": "boolean"
              },
              "deleted": {
                "type": "boolean"
              }
            },
            "required": []
          }
        },
        "testLabourRates": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "size": {
                "type": "string"
              },
              "testType": {
                "type": "string"
              },
              "cost": {
                "type": "number"
              },
              "currency": {
                "type": "string"
              },
              "unitOfMeasure": {
                "type": "string"
              },
              "available": {
                "type": "boolean"
              },
              "pressureMultiplier": {
                "type": "number"
              },
              "timeMinutes": {
                "type": "number"
              },
              "deleted": {
                "type": "boolean"
              }
            },
            "required": []
          }
        },
        "skiveLabourRates": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "size": {
                "type": "string"
              },
              "skiveType": {
                "type": "string"
              },
              "cost": {
                "type": "number"
              },
              "currency": {
                "type": "string"
              },
              "unitOfMeasure": {
                "type": "string"
              },
              "available": {
                "type": "boolean"
              },
              "deleted": {
                "type": "boolean"
              }
            },
            "required": []
          }
        },
        "workOrderSignOffs": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "title": {
                "type": "string"
              },
              "order": {
                "type": "number"
              },
              "deleted": {
                "type": "boolean"
              }
            },
            "required": []
          }
        }
      }
    },
    "users": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "user": {
            "type": "string"
          },
          "role": {
            "type": "string"
          },
          "deleted": {
            "type": "boolean"
          },
          "deletedBy": {
            "type": "string"
          },
          "deletedDate": {
            "type": "string",
            "format": "date-time"
          },
          "addedBy": {
            "type": "string"
          },
          "addedDate": {
            "type": "string",
            "format": "date-time"
          }
        },
        "required": []
      }
    },
    "imageName": {
      "type": "string"
    },
    "erpName": {
      "type": "string"
    },
    "useBetaFeatures": {
      "type": "boolean"
    },
    "erpId": {
      "type": "string"
    },
    "city": {
      "type": "string"
    },
    "region": {
      "type": "string"
    },
    "postalCode": {
      "type": "string"
    },
    "country": {
      "type": "string"
    },
    "phoneNumber": {
      "type": "string"
    },
    "email": {
      "type": "string"
    },
    "website": {
      "type": "string"
    },
    "address1": {
      "type": "string"
    },
    "address2": {
      "type": "string"
    },
    "branding": {
      "type": "object",
      "properties": {
        "primaryColour": {
          "type": "string"
        },
        "secondaryColour": {
          "type": "string"
        }
      }
    },
    "termsAndConditions": {
      "type": "object",
      "properties": {
        "version": {
          "type": "number"
        },
        "accepted": {
          "type": "boolean"
        },
        "acceptedBy": {
          "type": "string"
        },
        "acceptedDate": {
          "type": "string",
          "format": "date-time"
        }
      }
    },
    "syncSettings": {
      "type": "object",
      "properties": {
        "frequencyInMinutes": {
          "type": "number"
        },
        "encryptedConsumerKey": {
          "type": "string"
        },
        "erpType": {
          "type": "string"
        },
        "hostname": {
          "type": "string"
        },
        "portNumber": {
          "type": "string"
        },
        "syncOrganization": {
          "type": "boolean"
        },
        "syncCustomers": {
          "type": "boolean"
        },
        "syncItems": {
          "type": "boolean"
        },
        "syncSpecialPricing": {
          "type": "boolean"
        },
        "syncWarehouses": {
          "type": "boolean"
        },
        "syncInventory": {
          "type": "boolean"
        },
        "productGroups": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "itemType": {
                "type": "string"
              },
              "productGroupId": {
                "type": "string"
              }
            },
            "required": []
          }
        },
        "suppliers": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "itemType": {
                "type": "string"
              },
              "supplierId": {
                "type": "string"
              }
            },
            "required": []
          }
        },
        "locations": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "itemType": {
                "type": "string"
              },
              "locationId": {
                "type": "string"
              },
              "replenishmentLocation": {
                "type": "boolean"
              }
            },
            "required": []
          }
        }
      }
    }
  }
}

OrganizationProperties

Properties

Name	Type	Required	Restrictions	Description
_id	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
subscription	[object]	false	none	none
» subscriptionType	string	false	none	none
» startDate	string(date-time)	false	none	none
» expires	string(date-time)	false	none	none
» user	object	false	none	none
maxUsers	number	false	none	none
status	string	false	none	none
settings	object	false	none	none
» defaultLengthUnit	string	false	none	none
» defaultLengthUnitBillOfMaterials	string	false	none	none
» defaultPressureUnit	string	false	none	none
» defaultPaperSize	string	false	none	none
» addSalesTax	boolean	false	none	none
» storeHistory	object	false	none	none
»» value	boolean	false	none	none
»» historyCount	number	false	none	none
»» historyDays	number	false	none	none
» salesEstimates	object	false	none	none
»» standardFooter	string	false	none	none
» customers	object	false	none	none
»» showCustomerLogoOnDrawings	boolean	false	none	none
»» hideCutLengthOnDrawings	boolean	false	none	none
»» boldOverAllLengthOnDrawings	boolean	false	none	none
» hoseAssemblies	object	false	none	none
»» autoPartNumbers	boolean	false	none	none
»» autoPartNumberFormat	string	false	none	none
»» nextSequentialNumber	number	false	none	none
» hoseKits	object	false	none	none
»» autoPartNumbers	boolean	false	none	none
»» autoPartNumberFormat	string	false	none	none
»» nextSequentialNumber	number	false	none	none
» salesTax	[object]	false	none	none
»» taxId	string	false	none	none
»» taxCode	string	false	none	none
»» percentage	number	false	none	none
» defaultSalesTax	string	false	none	none
» defaultCurrency	string	false	none	none
» defaultLabelSize	object	false	none	none
»» width	number	false	none	none
»» height	number	false	none	none
» defaultWarehouse	string	false	none	none
» hideInventory	boolean	false	none	none
» shopLabourCost	number	false	none	none
» shopLabourCurrency	string	false	none	none
» defaultMarginPercentMaterials	number	false	none	none
» defaultMarginPercentLabour	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
» defaultHoseBrand	string	false	none	none
» defaultAdaptorBrand	string	false	none	none
» defaultWrapBrand	string	false	none	none
» defaultOtherItemBrand	string	false	none	none
» defaultLocale	string	false	none	none
» revisionDelimiter	string	false	none	none
» useStandardPartNumbers	boolean	false	none	none
» listPricing	boolean	false	none	none
» labourRates	[object]	false	none	none
»» size	string	false	none	none
»» cost	number	false	none	none
»» currency	string	false	none	none
»» unitOfMeasure	string	false	none	none
»» available	boolean	false	none	none
»» deleted	boolean	false	none	none
» scrapRates	[object]	false	none	none
»» size	string	false	none	none
»» percent	number	false	none	none
»» available	boolean	false	none	none
»» deleted	boolean	false	none	none
» wrapLabourRates	[object]	false	none	none
»» size	string	false	none	none
»» wrapType	string	false	none	none
»» cost	number	false	none	none
»» currency	string	false	none	none
»» unitOfMeasure	string	false	none	none
»» available	boolean	false	none	none
»» deleted	boolean	false	none	none
» testLabourRates	[object]	false	none	none
»» size	string	false	none	none
»» testType	string	false	none	none
»» cost	number	false	none	none
»» currency	string	false	none	none
»» unitOfMeasure	string	false	none	none
»» available	boolean	false	none	none
»» pressureMultiplier	number	false	none	none
»» timeMinutes	number	false	none	none
»» deleted	boolean	false	none	none
» skiveLabourRates	[object]	false	none	none
»» size	string	false	none	none
»» skiveType	string	false	none	none
»» cost	number	false	none	none
»» currency	string	false	none	none
»» unitOfMeasure	string	false	none	none
»» available	boolean	false	none	none
»» deleted	boolean	false	none	none
» workOrderSignOffs	[object]	false	none	none
»» title	string	false	none	none
»» order	number	false	none	none
»» deleted	boolean	false	none	none
users	[object]	false	none	none
» user	string	false	none	none
» role	string	false	none	none
» deleted	boolean	false	none	none
» deletedBy	string	false	none	none
» deletedDate	string(date-time)	false	none	none
» addedBy	string	false	none	none
» addedDate	string(date-time)	false	none	none
imageName	string	false	none	none
erpName	string	false	none	none
useBetaFeatures	boolean	false	none	none
erpId	string	false	none	none
city	string	false	none	none
region	string	false	none	none
postalCode	string	false	none	none
country	string	false	none	none
phoneNumber	string	false	none	none
email	string	false	none	none
website	string	false	none	none
address1	string	false	none	none
address2	string	false	none	none
branding	object	false	none	none
» primaryColour	string	false	none	none
» secondaryColour	string	false	none	none
termsAndConditions	object	false	none	none
» version	number	false	none	none
» accepted	boolean	false	none	none
» acceptedBy	string	false	none	none
» acceptedDate	string(date-time)	false	none	none
syncSettings	object	false	none	none
» frequencyInMinutes	number	false	none	none
» encryptedConsumerKey	string	false	none	none
» erpType	string	false	none	none
» hostname	string	false	none	none
» portNumber	string	false	none	none
» syncOrganization	boolean	false	none	none
» syncCustomers	boolean	false	none	none
» syncItems	boolean	false	none	none
» syncSpecialPricing	boolean	false	none	none
» syncWarehouses	boolean	false	none	none
» syncInventory	boolean	false	none	none
» productGroups	[object]	false	none	none
»» itemType	string	false	none	none
»» productGroupId	string	false	none	none
» suppliers	[object]	false	none	none
»» itemType	string	false	none	none
»» supplierId	string	false	none	none
» locations	[object]	false	none	none
»» itemType	string	false	none	none
»» locationId	string	false	none	none
»» replenishmentLocation	boolean	false	none	none