NewSalesOrderNote

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/blackbaud/main/json-schema/blackbaud-new-sales-order-note-schema.json",
  "title": "NewSalesOrderNote",
  "description": "CreateSalesOrderNote",
  "x-generated": "2026-10-14",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/blackbaud-altru-sales-api-openapi.yml#/components/schemas/NewSalesOrderNote",
  "required": [
    "sales_order_id",
    "date_entered",
    "notetype"
  ],
  "type": "object",
  "properties": {
    "sales_order_id": {
      "type": "string",
      "description": "The sales order ID."
    },
    "context_type": {
      "type": "integer",
      "description": "The context type. Read-only in the SOAP API.",
      "format": "int32"
    },
    "title": {
      "maxLength": 50,
      "minLength": 0,
      "type": "string",
      "description": "The the title of this note."
    },
    "date_entered": {
      "type": "string",
      "description": "The the date this note was entered. Uses the format YYYY-MM-DDThh:mm:ss. An example date: <i>1955-11-05T22:04:00</i>.",
      "format": "date-time"
    },
    "author_id": {
      "type": "string",
      "description": "The the author of this note."
    },
    "notetype": {
      "type": "string",
      "description": "The the user-defined type of this note. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/salesordernotetypecode/entries"
    },
    "text_note": {
      "type": "string",
      "description": "The the text that comprises this note."
    },
    "html_note": {
      "type": "string",
      "description": "The the html that comprises this note."
    },
    "order_id": {
      "type": "string",
      "description": "The order ID. Read-only in the SOAP API."
    },
    "sales_order_item": {
      "type": "string",
      "description": "The sales order item with which the note refers. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/62358363-7019-41d0-92f5-8e28718e8eef?parameters=sales_order_id,{order_id}."
    }
  },
  "additionalProperties": false,
  "x-display-name": "Sales Order Note Add Form",
  "x-display-id": "Sales Order Note Add Form"
}