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

SalesEstimate

{
  "title": "SalesEstimate",
  "required": ["customer", "number", "lastModified", "created", "deleted"],
  "properties": {
    "customer": {
      "type": "string"
    },
    "number": {
      "type": "string"
    },
    "revision": {
      "type": "string"
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "lineNumber": {
            "type": "number"
          },
          "quantity": {
            "type": "number"
          },
          "unitOfMeasure": {
            "type": "string"
          },
          "item": {
            "type": "string"
          },
          "itemType": {
            "type": "string"
          },
          "price": {
            "type": "number"
          },
          "currency": {
            "type": "string"
          },
          "deleted": {
            "type": "boolean"
          },
          "deletedDate": {
            "type": "string",
            "format": "date-time"
          },
          "deletedBy": {
            "type": "string"
          }
        },
        "required": []
      }
    },
    "subTotalPrice": {
      "type": "number"
    },
    "taxes": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "ratePercent": {
            "type": "number"
          },
          "amount": {
            "type": "number"
          }
        },
        "required": []
      }
    },
    "totalPrice": {
      "type": "number"
    },
    "currency": {
      "type": "string"
    },
    "comments": {
      "type": "string"
    },
    "customerName": {
      "type": "string"
    },
    "customerDeleted": {
      "type": "boolean"
    },
    "status": {
      "type": "string"
    },
    "documentDate": {
      "type": "string",
      "format": "date-time"
    },
    "validUntilDate": {
      "type": "string",
      "format": "date-time"
    },
    "lastModified": {
      "type": "string",
      "format": "date-time"
    },
    "created": {
      "type": "string",
      "format": "date-time"
    },
    "deleted": {
      "type": "boolean"
    },
    "deletedDate": {
      "type": "string",
      "format": "date-time"
    },
    "lastModifiedBy": {
      "type": "string"
    },
    "createdBy": {
      "type": "string"
    },
    "deletedBy": {
      "type": "string"
    },
    "_id": {
      "type": "string"
    }
  }
}

SalesEstimate

Properties

Name	Type	Required	Restrictions	Description
customer	string	true	none	none
number	string	true	none	none
revision	string	false	none	none
items	[object]	false	none	none
» lineNumber	number	false	none	none
» quantity	number	false	none	none
» unitOfMeasure	string	false	none	none
» item	string	false	none	none
» itemType	string	false	none	none
» price	number	false	none	none
» currency	string	false	none	none
» deleted	boolean	false	none	none
» deletedDate	string(date-time)	false	none	none
» deletedBy	string	false	none	none
subTotalPrice	number	false	none	none
taxes	[object]	false	none	none
» name	string	false	none	none
» ratePercent	number	false	none	none
» amount	number	false	none	none
totalPrice	number	false	none	none
currency	string	false	none	none
comments	string	false	none	none
customerName	string	false	none	none
customerDeleted	boolean	false	none	none
status	string	false	none	none
documentDate	string(date-time)	false	none	none
validUntilDate	string(date-time)	false	none	none
lastModified	string(date-time)	true	none	none
created	string(date-time)	true	none	none
deleted	boolean	true	none	none
deletedDate	string(date-time)	false	none	none
lastModifiedBy	string	false	none	none
createdBy	string	false	none	none
deletedBy	string	false	none	none
_id	string	false	none	none