unleashed-software

Fetch the Unleashed company these credentials belong to — name, base currency and default tax rate. A cheap way to confirm the API id, key and signature are right. Unleashed: GET /Companies.

{
  "type": "object",
  "properties": {},
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

List products, optionally searched by code/description or filtered by code prefix, group, brand, barcode or modification date. Unleashed: GET /Products/{page}.

{
  "type": "object",
  "properties": {
    "product": {
      "description": "Search text matched against product code or description.",
      "type": "string"
    },
    "productCode": {
      "description": "Only products whose code starts with this.",
      "type": "string"
    },
    "productDescription": {
      "description": "Only products whose description starts with this.",
      "type": "string"
    },
    "productGroup": {
      "description": "Only products in this product group (subgroups excluded).",
      "type": "string"
    },
    "productBrand": {
      "description": "Only products of this brand.",
      "type": "string"
    },
    "ProductBarcode": {
      "description": "Only the product with this barcode.",
      "type": "string"
    },
    "includeObsolete": {
      "description": "Include obsolete (discontinued) products.",
      "type": "boolean"
    },
    "excludeAssembled": {
      "description": "Omit assembled products.",
      "type": "boolean"
    },
    "excludeComponents": {
      "description": "Omit component products.",
      "type": "boolean"
    },
    "includeAttributes": {
      "description": "Include each product's attribute set.",
      "type": "boolean"
    },
    "brief": {
      "description": "Return a condensed summary per product.",
      "type": "boolean"
    },
    "modifiedSince": {
      "description": "Only records created or modified since this UTC date (YYYY-MM-DD).",
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}(T[\\d:.]+Z?)?$"
    },
    "orderBy": {
      "description": "Sort column.",
      "type": "string",
      "enum": [
        "LastModifiedOn",
        "CreatedOn",
        "ProductCode"
      ]
    },
    "sort": {
      "description": "Sort direction.",
      "type": "string",
      "enum": [
        "asc",
        "desc"
      ]
    },
    "page": {
      "description": "Page number (1-based). Default 1.",
      "type": "integer",
      "minimum": 1,
      "maximum": 100000
    },
    "pageSize": {
      "description": "Records per page, 1-1000. Unleashed default is 200.",
      "type": "integer",
      "minimum": 1,
      "maximum": 1000
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Fetch a single product by Guid — prices, units, stock alert levels, group, brand, supplier. Unleashed: GET /Products/{productGuid}.

{
  "type": "object",
  "properties": {
    "productGuid": {
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
      "description": "The product's Guid."
    }
  },
  "required": [
    "productGuid"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

List stock on hand per product — QtyOnHand, AllocatedQty, AvailableQty, OnPurchase, AvgCost — optionally for one warehouse or as at a past date. Unleashed: GET /StockOnHand/{page}.

{
  "type": "object",
  "properties": {
    "warehouseCode": {
      "description": "Only stock in this warehouse code.",
      "type": "string"
    },
    "warehouseName": {
      "description": "Only stock in this warehouse name.",
      "type": "string"
    },
    "productId": {
      "description": "Only these product Guids (comma-separated).",
      "type": "string"
    },
    "asAtDate": {
      "description": "Stock on hand as at this date (YYYY-MM-DD).",
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}(T[\\d:.]+Z?)?$"
    },
    "isAssembled": {
      "description": "Include quantity that can be assembled via auto-assembly BOMs in AvailableQty.",
      "type": "boolean"
    },
    "modifiedSince": {
      "description": "Only records created or modified since this UTC date (YYYY-MM-DD).",
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}(T[\\d:.]+Z?)?$"
    },
    "orderBy": {
      "description": "Sort column (default productCode).",
      "type": "string"
    },
    "page": {
      "description": "Page number (1-based). Default 1.",
      "type": "integer",
      "minimum": 1,
      "maximum": 100000
    },
    "pageSize": {
      "description": "Records per page, 1-1000. Unleashed default is 200.",
      "type": "integer",
      "minimum": 1,
      "maximum": 1000
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Stock on hand for one product — totals, or broken down per warehouse with allWarehouses=true. The direct answer to 'how many do we have and where?'. Unleashed: GET /StockOnHand/{productGuid}[/AllWarehouses].

{
  "type": "object",
  "properties": {
    "productGuid": {
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
      "description": "The product's Guid."
    },
    "allWarehouses": {
      "description": "Break the stock down per warehouse.",
      "type": "boolean"
    },
    "warehouseCode": {
      "description": "Only this warehouse (ignored with allWarehouses).",
      "type": "string"
    },
    "asAtDate": {
      "description": "Stock on hand as at this date (YYYY-MM-DD).",
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}(T[\\d:.]+Z?)?$"
    }
  },
  "required": [
    "productGuid"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

List customers, optionally filtered by code or name prefix, currency or modification date. Unleashed: GET /Customers/{page}.

{
  "type": "object",
  "properties": {
    "customerCode": {
      "description": "Only customers whose code starts with this.",
      "type": "string"
    },
    "customerName": {
      "description": "Only customers whose name starts with this.",
      "type": "string"
    },
    "currency": {
      "description": "Only customers with exactly this currency code, e.g. NZD.",
      "type": "string"
    },
    "includeObsolete": {
      "description": "Include obsolete customers.",
      "type": "boolean"
    },
    "modifiedSince": {
      "description": "Only records created or modified since this UTC date (YYYY-MM-DD).",
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}(T[\\d:.]+Z?)?$"
    },
    "orderBy": {
      "description": "Sort column.",
      "type": "string",
      "enum": [
        "LastModifiedOn",
        "CreatedOn",
        "CustomerCode"
      ]
    },
    "page": {
      "description": "Page number (1-based). Default 1.",
      "type": "integer",
      "minimum": 1,
      "maximum": 100000
    },
    "pageSize": {
      "description": "Records per page, 1-1000. Unleashed default is 200.",
      "type": "integer",
      "minimum": 1,
      "maximum": 1000
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Fetch a single customer by Guid — contact details, addresses, currency, payment terms, credit limit. Unleashed: GET /Customers/{customerGuid}.

{
  "type": "object",
  "properties": {
    "customerGuid": {
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
      "description": "The customer's Guid."
    }
  },
  "required": [
    "customerGuid"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

List suppliers, optionally filtered by code prefix, contact email prefix or modification date. Unleashed: GET /Suppliers/{page}.

{
  "type": "object",
  "properties": {
    "supplierCode": {
      "description": "Only suppliers whose code starts with this.",
      "type": "string"
    },
    "contactEmail": {
      "description": "Only suppliers whose contact email starts with this.",
      "type": "string"
    },
    "modifiedSince": {
      "description": "Only records created or modified since this UTC date (YYYY-MM-DD).",
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}(T[\\d:.]+Z?)?$"
    },
    "page": {
      "description": "Page number (1-based). Default 1.",
      "type": "integer",
      "minimum": 1,
      "maximum": 100000
    },
    "pageSize": {
      "description": "Records per page, 1-1000. Unleashed default is 200.",
      "type": "integer",
      "minimum": 1,
      "maximum": 1000
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

List warehouses (code, name, default flag, address). Warehouse codes are what other tools filter by. Unleashed: GET /Warehouses/{page}.

{
  "type": "object",
  "properties": {
    "warehouseCode": {
      "description": "Only warehouses whose code starts with this.",
      "type": "string"
    },
    "warehouseName": {
      "description": "Only warehouses whose name starts with this.",
      "type": "string"
    },
    "includeObsolete": {
      "description": "Include obsolete warehouses.",
      "type": "boolean"
    },
    "modifiedSince": {
      "description": "Only records created or modified since this UTC date (YYYY-MM-DD).",
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}(T[\\d:.]+Z?)?$"
    },
    "page": {
      "description": "Page number (1-based). Default 1.",
      "type": "integer",
      "minimum": 1,
      "maximum": 100000
    },
    "pageSize": {
      "description": "Records per page, 1-1000. Unleashed default is 200.",
      "type": "integer",
      "minimum": 1,
      "maximum": 1000
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

List product groups (name, Guid, parent group) — the category tree products are filed under. Unleashed: GET /ProductGroups/{page}.

{
  "type": "object",
  "properties": {
    "page": {
      "description": "Page number (1-based). Default 1.",
      "type": "integer",
      "minimum": 1,
      "maximum": 100000
    },
    "pageSize": {
      "description": "Records per page, 1-1000. Unleashed default is 200.",
      "type": "integer",
      "minimum": 1,
      "maximum": 1000
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

List sales orders, filtered by status, customer, order number, warehouse or date range. Deleted orders are excluded unless asked for. Unleashed: GET /SalesOrders/{page}.

{
  "type": "object",
  "properties": {
    "orderStatus": {
      "description": "Comma-separated statuses, e.g. Parked,Placed,Backordered,Completed.",
      "type": "string"
    },
    "customerCode": {
      "description": "Only orders whose customer code starts with this.",
      "type": "string"
    },
    "customerId": {
      "description": "Only orders for these customer Guids (comma-separated).",
      "type": "string"
    },
    "orderNumber": {
      "description": "Only the order with this number (overrides other filters).",
      "type": "string"
    },
    "warehouseCode": {
      "description": "Only orders from this warehouse.",
      "type": "string"
    },
    "startDate": {
      "description": "Orders dated on/after this date (YYYY-MM-DD).",
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}(T[\\d:.]+Z?)?$"
    },
    "endDate": {
      "description": "Orders dated on/before this date (YYYY-MM-DD).",
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}(T[\\d:.]+Z?)?$"
    },
    "completedAfter": {
      "description": "Orders completed after this date (YYYY-MM-DD).",
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}(T[\\d:.]+Z?)?$"
    },
    "completedBefore": {
      "description": "Orders completed before this date (YYYY-MM-DD).",
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}(T[\\d:.]+Z?)?$"
    },
    "modifiedSince": {
      "description": "Only records created or modified since this UTC date (YYYY-MM-DD).",
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}(T[\\d:.]+Z?)?$"
    },
    "customOrderStatus": {
      "description": "A custom order status (overrides orderStatus).",
      "type": "string"
    },
    "serialBatch": {
      "description": "Include serial and batch numbers on lines.",
      "type": "boolean"
    },
    "page": {
      "description": "Page number (1-based). Default 1.",
      "type": "integer",
      "minimum": 1,
      "maximum": 100000
    },
    "pageSize": {
      "description": "Records per page, 1-1000. Unleashed default is 200.",
      "type": "integer",
      "minimum": 1,
      "maximum": 1000
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Fetch a single sales order by Guid, with its lines, totals, customer and warehouse. Unleashed: GET /SalesOrders/{orderGuid}.

{
  "type": "object",
  "properties": {
    "orderGuid": {
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
      "description": "The sales order's Guid."
    },
    "serialBatch": {
      "description": "Include serial and batch numbers on lines.",
      "type": "boolean"
    }
  },
  "required": [
    "orderGuid"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

List purchase orders, filtered by status, supplier, order number, warehouse or date range. Unleashed: GET /PurchaseOrders/{page}.

{
  "type": "object",
  "properties": {
    "orderStatus": {
      "description": "Comma-separated: Parked, Placed, Unapproved, Costed, Receipted, Complete, Deleted.",
      "type": "string"
    },
    "orderNumber": {
      "description": "Only the purchase order with this number.",
      "type": "string"
    },
    "supplierCode": {
      "description": "Only orders whose supplier code starts with this.",
      "type": "string"
    },
    "warehouseCode": {
      "description": "Only orders into this warehouse.",
      "type": "string"
    },
    "startDate": {
      "description": "Orders dated on/after this date (YYYY-MM-DD).",
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}(T[\\d:.]+Z?)?$"
    },
    "endDate": {
      "description": "Orders dated on/before this date (YYYY-MM-DD).",
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}(T[\\d:.]+Z?)?$"
    },
    "completedAfter": {
      "description": "Orders completed after this date (YYYY-MM-DD).",
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}(T[\\d:.]+Z?)?$"
    },
    "completedBefore": {
      "description": "Orders completed before this date (YYYY-MM-DD).",
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}(T[\\d:.]+Z?)?$"
    },
    "modifiedSince": {
      "description": "Only records created or modified since this UTC date (YYYY-MM-DD).",
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}(T[\\d:.]+Z?)?$"
    },
    "customOrderStatus": {
      "description": "A custom order status.",
      "type": "string"
    },
    "page": {
      "description": "Page number (1-based). Default 1.",
      "type": "integer",
      "minimum": 1,
      "maximum": 100000
    },
    "pageSize": {
      "description": "Records per page, 1-1000. Unleashed default is 200.",
      "type": "integer",
      "minimum": 1,
      "maximum": 1000
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Fetch a single purchase order by Guid, with its lines, supplier and totals. Unleashed: GET /PurchaseOrders/{orderGuid}.

{
  "type": "object",
  "properties": {
    "orderGuid": {
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
      "description": "The purchase order's Guid."
    }
  },
  "required": [
    "orderGuid"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

List sales invoices, filtered by status, customer, invoice number, sales order number or date range. Unleashed: GET /Invoices/{page}.

{
  "type": "object",
  "properties": {
    "invoiceStatus": {
      "description": "Comma-separated statuses, e.g. Completed,Parked.",
      "type": "string"
    },
    "invoiceNumber": {
      "description": "Only the invoice with this number (overrides other filters).",
      "type": "string"
    },
    "orderNumber": {
      "description": "Only invoices for this sales order number.",
      "type": "string"
    },
    "customerCode": {
      "description": "Only invoices for this customer code.",
      "type": "string"
    },
    "startDate": {
      "description": "Invoices created after this date (YYYY-MM-DD).",
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}(T[\\d:.]+Z?)?$"
    },
    "endDate": {
      "description": "Invoices created before this date (YYYY-MM-DD).",
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}(T[\\d:.]+Z?)?$"
    },
    "modifiedSince": {
      "description": "Only records created or modified since this UTC date (YYYY-MM-DD).",
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}(T[\\d:.]+Z?)?$"
    },
    "page": {
      "description": "Page number (1-based). Default 1.",
      "type": "integer",
      "minimum": 1,
      "maximum": 100000
    },
    "pageSize": {
      "description": "Records per page, 1-1000. Unleashed default is 200.",
      "type": "integer",
      "minimum": 1,
      "maximum": 1000
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

List sales quotes, filtered by status, customer, quote number or date range. Unleashed: GET /SalesQuotes/{page}.

{
  "type": "object",
  "properties": {
    "quoteStatus": {
      "description": "Comma-separated statuses, e.g. Draft,Parked,Completed.",
      "type": "string"
    },
    "quoteNumber": {
      "description": "Only the quote with this number (overrides other filters).",
      "type": "string"
    },
    "customerCode": {
      "description": "Only quotes whose customer code starts with this.",
      "type": "string"
    },
    "startDate": {
      "description": "Quotes created after this date (YYYY-MM-DD).",
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}(T[\\d:.]+Z?)?$"
    },
    "endDate": {
      "description": "Quotes created before this date (YYYY-MM-DD).",
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}(T[\\d:.]+Z?)?$"
    },
    "modifiedSince": {
      "description": "Only records created or modified since this UTC date (YYYY-MM-DD).",
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}(T[\\d:.]+Z?)?$"
    },
    "page": {
      "description": "Page number (1-based). Default 1.",
      "type": "integer",
      "minimum": 1,
      "maximum": 100000
    },
    "pageSize": {
      "description": "Records per page, 1-1000. Unleashed default is 200.",
      "type": "integer",
      "minimum": 1,
      "maximum": 1000
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

List stock adjustments (write-offs, recounts, corrections) with reason, status and lines, filtered by warehouse, product or date. Unleashed: GET /StockAdjustments/{page}.

{
  "type": "object",
  "properties": {
    "warehouseCode": {
      "description": "Only adjustments in this warehouse.",
      "type": "string",
      "maxLength": 15
    },
    "productCode": {
      "description": "Only adjustments touching this product code.",
      "type": "string",
      "maxLength": 100
    },
    "adjustmentDate": {
      "description": "Adjustments since this date (YYYY-MM-DD).",
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}(T[\\d:.]+Z?)?$"
    },
    "modifiedSince": {
      "description": "Only records created or modified since this UTC date (YYYY-MM-DD).",
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}(T[\\d:.]+Z?)?$"
    },
    "page": {
      "description": "Page number (1-based). Default 1.",
      "type": "integer",
      "minimum": 1,
      "maximum": 100000
    },
    "pageSize": {
      "description": "Records per page, 1-1000. Unleashed default is 200.",
      "type": "integer",
      "minimum": 1,
      "maximum": 1000
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Create a new customer. CustomerCode must be unique and cannot be changed later. Unleashed: POST /Customers.

{
  "type": "object",
  "properties": {
    "customerCode": {
      "type": "string",
      "minLength": 1,
      "description": "Unique customer code (cannot be changed after creation)."
    },
    "customerName": {
      "type": "string",
      "minLength": 1,
      "description": "Customer name."
    },
    "email": {
      "description": "Contact email.",
      "type": "string"
    },
    "phoneNumber": {
      "description": "Phone number.",
      "type": "string"
    },
    "mobileNumber": {
      "description": "Mobile number.",
      "type": "string"
    },
    "contactFirstName": {
      "description": "Contact first name.",
      "type": "string"
    },
    "contactLastName": {
      "description": "Contact last name.",
      "type": "string"
    },
    "website": {
      "description": "Website.",
      "type": "string"
    },
    "currencyCode": {
      "description": "Currency code, e.g. NZD. Defaults to the base currency.",
      "type": "string",
      "minLength": 3,
      "maxLength": 3
    },
    "paymentTerm": {
      "description": "Payment term name as configured in Unleashed.",
      "type": "string"
    },
    "taxable": {
      "description": "Whether sales to this customer are taxable.",
      "type": "boolean"
    },
    "gstVatNumber": {
      "description": "GST/VAT number.",
      "type": "string"
    }
  },
  "required": [
    "customerCode",
    "customerName"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Create a new product. ProductCode must be unique. Unleashed: POST /Products.

{
  "type": "object",
  "properties": {
    "productCode": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100,
      "description": "Unique product code (SKU)."
    },
    "productDescription": {
      "type": "string",
      "minLength": 1,
      "maxLength": 500,
      "description": "Product description."
    },
    "barcode": {
      "description": "Barcode.",
      "type": "string",
      "maxLength": 200
    },
    "defaultSellPrice": {
      "description": "Default sell price.",
      "type": "number",
      "minimum": 0
    },
    "defaultPurchasePrice": {
      "description": "Default purchase price.",
      "type": "number",
      "minimum": 0
    },
    "isSellable": {
      "description": "Can be sold.",
      "type": "boolean"
    },
    "isPurchasable": {
      "description": "Can be purchased.",
      "type": "boolean"
    },
    "minStockAlertLevel": {
      "description": "Low-stock alert level.",
      "type": "number",
      "minimum": 0
    },
    "maxStockAlertLevel": {
      "description": "Overstock alert level.",
      "type": "number",
      "minimum": 0
    },
    "weight": {
      "description": "Weight.",
      "type": "number",
      "minimum": 0
    },
    "packSize": {
      "description": "Pack size.",
      "type": "number",
      "minimum": 0
    }
  },
  "required": [
    "productCode",
    "productDescription"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Create a DRAFT sales order with status Parked (reserves no stock, posts nothing to accounting — a person places or completes it in Unleashed). Line totals, line tax, SubTotal, TaxTotal and Total are computed for you to satisfy Unleashed's validation (SubTotal = sum of line totals, TaxTotal = sum of line taxes, Total = SubTotal + TaxTotal). Unleashed: POST /SalesOrders.

{
  "type": "object",
  "properties": {
    "customerCode": {
      "type": "string",
      "minLength": 1,
      "description": "The customer's code."
    },
    "warehouseCode": {
      "type": "string",
      "minLength": 1,
      "description": "The warehouse code to sell from."
    },
    "currencyCode": {
      "type": "string",
      "minLength": 3,
      "maxLength": 3,
      "description": "Order currency code, e.g. NZD."
    },
    "exchangeRate": {
      "description": "Exchange rate to the base currency. Default 1.",
      "type": "number",
      "exclusiveMinimum": 0
    },
    "taxRate": {
      "type": "number",
      "minimum": 0,
      "maximum": 1,
      "description": "Tax rate as a fraction, e.g. 0.15 for 15%."
    },
    "taxCode": {
      "description": "Tax code as configured in Unleashed, e.g. GST.",
      "type": "string"
    },
    "orderNumber": {
      "description": "Order number; generated by Unleashed if omitted.",
      "type": "string"
    },
    "orderDate": {
      "description": "Order date (YYYY-MM-DD). Default today.",
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}(T[\\d:.]+Z?)?$"
    },
    "requiredDate": {
      "description": "Required date (YYYY-MM-DD).",
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}(T[\\d:.]+Z?)?$"
    },
    "comments": {
      "description": "Order comments.",
      "type": "string",
      "maxLength": 2048
    },
    "lines": {
      "minItems": 1,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "productCode": {
            "type": "string",
            "minLength": 1,
            "description": "The product's code."
          },
          "quantity": {
            "type": "number",
            "exclusiveMinimum": 0,
            "description": "Order quantity."
          },
          "unitPrice": {
            "type": "number",
            "minimum": 0,
            "description": "Unit price, exclusive of tax."
          }
        },
        "required": [
          "productCode",
          "quantity",
          "unitPrice"
        ]
      },
      "description": "At least one order line."
    }
  },
  "required": [
    "customerCode",
    "warehouseCode",
    "currencyCode",
    "taxRate",
    "lines"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}