apicreateproposal JSON request body proposal + entries contact/product objects supported

POST /api/createproposal creates a proposal, its proposal entries, optional contact, and optional embedded products.

Complete field reference — full maximal JSON schema with every accepted attribute, enum values, defaults, and explanations.

Top-level JSON fields

Proposal Fields

You can send any standard proposal field such as:

• name required
• nr is always generated server-side. Any submitted nr is ignored.
• type defaults to 0.
• url is accepted only when type = 1. For default type = 0 and every other proposal type, URL is always generated server-side.
• created, deadline, currency, language
• author and owner as user ids; can be sent directly at top level or inside proposal. If omitted, the API falls back to the default user logic.
• discount, status, comment, confirmable

Entry Fields

Each entry can contain direct entries table fields:

• product: line title/text. If a product object/id/SKU is supplied, this defaults to the product name.
• product_ref: product id, SKU, or product object.
• link: product id. Used like product_ref when numeric.
• sku, ammount, ammount2, unit, unit2
• price, prime, discount, pvm, supplier
• comment, notes, image, tags
• attribute: use text_sep, header, footer, or omit/"0" for normal product rows (empty is stored as "0").
• accepted: 1 marks a selectable row as selected/accepted.
• selectable: child rows only. 1 makes an included child individually toggleable on the public offer. Does not hide the parent SELECT! button. Use settings.selectoff: 1 to hide parent SELECT!.
• children: array of child entries. Child rows are linked to the parent row through the existing parent/orderp system.

Select controls (selectable, selectoff, tunc)

Product Reference Formats

Entries can link to existing products or create products inline.

Existing product by id

{
  "product_ref": 15,
  "ammount": 2
}

Existing product by SKU

{
  "product_ref": "SKU-001",
  "ammount": 2
}

Create product inline

The object uses the same product payload as /api/createproduct, without the API key.

{
  "product_ref": {
    "name": "Created inline product",
    "sku": "INLINE-001",
    "category": "API products",
    "price": {
      "Supplier A": {
        "1": [50, 75, 0]
      }
    }
  },
  "ammount": 1
}

Feature Values on Entries

You can save entry-level feature selections using feature ids:

{
  "product_ref": "SKU-001",
  "feature_values": {
    "12": [44, 45],
    "15": "custom text"
  },
  "feature_custom_text": {
    "15": "custom text"
  },
  "feature_custom_number": {
    "20": "5"
  }
}

Minimal Example

{
  "key": "YOUR_API_KEY",
  "name": "API proposal",
  "author": 3,
  "owner": 3,
  "contact": {
    "name": "Example Company UAB",
    "code": "123456789",
    "email": "info@example.com"
  },
  "entries": [
    {
      "product_ref": "SKU-001",
      "ammount": 2,
      "children": [
        {
          "product_ref": "INCLUDED-SKU-001",
          "ammount": 1,
          "selectable": 1,
          "accepted": 1
        }
      ]
    }
  ]
}

Grouped Full Example

{
  "key": "YOUR_API_KEY",
  "proposal": {
    "name": "Website project",
    "currency": "EUR",
    "discount": 5,
    "comment": "Created through API"
  },
  "contact": {
    "name": "Client Company",
    "code": "300000001",
    "phone": "+37060000000",
    "meta": {
      "city": "Vilnius",
      "website": "https://client.example"
    }
  },
  "settings": {
    "advanceper": 30,
    "showgroup": 1
  },
  "groups": [
    {
      "name": "Main work",
      "advance": 30,
      "entries": [
        {
          "product_ref": {
            "name": "Design work",
            "sku": "DESIGN-API-001",
            "category": "Services",
            "price": {
              "Supplier A": {
                "1": [0, 500, 0]
              }
            }
          },
          "ammount": 1,
          "comment": "Design stage"
        },
        {
          "product": "Project note",
          "attribute": "text_sep",
          "comment": "<p>This is an informational row.</p>"
        }
      ]
    },
    {
      "name": "Recurring",
      "entries": [
        {
          "product_ref": "HOSTING-001",
          "ammount": 12,
          "unit": "mėn",
          "periodical": 1
        }
      ]
    }
  ]
}

Success Response

{
  "status": "ok",
  "data": {
    "proposal": { "id": 123, "name": "Website project", "url": "abc123..." },
    "entries": [ /* created entries */ ],
    "url": "https://your-domain/offer/abc123..."
  }
}

Error Responses

• { "status": "error", "data": "api disabled" }
• { "status": "error", "data": "no key" }
• { "status": "error", "data": "wrong key" }
• { "status": "error", "data": "name required" }
• { "status": "error", "data": "entries required" }
• { "status": "error", "data": "contact not found" }