apicreateproposal — complete JSON reference all fields field-by-field

POST /api/createproposal — maximal request schema, accepted values, defaults, and server overrides. For shorter examples, see apicreateproposal.html.

Full maximal JSON

Every supported key in one payload. Placeholder values illustrate types and typical shapes.

{
  "key": "YOUR_API_KEY",

  "proposal": {
    "name": "Website project",
    "type": 0,
    "url": "custom-url-only-when-type-1",
    "created": "2026-07-08",
    "deadline": "2026-08-07",
    "currency": "EUR",
    "language": "lt",
    "author": 3,
    "owner": 3,
    "edited": 3,
    "status": 0,
    "discount": 5,
    "tax": 0,
    "comment": "Internal comment shown in editor",
    "usercomment": "Client-visible comment",
    "confirmable": 1,
    "accepted": 0,
    "hide": 0,
    "hidecus": 0,
    "hidepronr": 0,
    "deleted": 0,
    "locked": 0,
    "client": "Client Company",
    "code": "300000001",
    "person": "Jane Doe",
    "project": "Project code",
    "selling": "2026-07-15",
    "arriving": "2026-07-20",
    "done": "2026-09-01",
    "soldby": 3,
    "colors": "",
    "people": 10,
    "gramsperperson": 250,
    "proprice": 0,
    "margin": 0,
    "marginper": 0,
    "turnover": 0,
    "total": 0,
    "edit_amount": 0,
    "showpriceperperson": 0,
    "showgroup": 0,
    "template": 0,
    "listtype": 0,
    "header": "",
    "opacity": 0,
    "archive": 0,
    "shop": 0,
    "started": "",
    "form_id": 0,
    "video": "",
    "zoho": "",
    "zohod": 0,
    "scoro": 0,
    "bitrix": "",
    "bitrixlead": 0,
    "bitrixdeal": 0,
    "unicode": "auto-generated-if-omitted"
  },

  "name": "Alternative top-level name (ignored if proposal.name is set)",
  "author": 3,
  "owner": 3,

  "contact": 123,
  "contact_object_example": {
    "id": 123,
    "name": "Client Company",
    "code": "300000001",
    "phone": "+37060000000",
    "email": "info@client.example",
    "address": "Example street 1",
    "person": "Jane Doe",
    "manager": 3,
    "lead": "",
    "lead_data": "",
    "zoho_id": "",
    "vat": "LT123456789",
    "website": "https://client.example",
    "city": "Vilnius",
    "meta": {
      "payment_terms": "14 days",
      "custom_field": "any value"
    }
  },

  "settings": {
    "advanceper": 30,
    "showgroup": 1,
    "thediscount": "5%",
    "hidepronr": 0,
    "textcolor": "#111827",
    "offtags": 0,
    "selectoff": 0,
    "groupinstotal": 0,
    "dicper": 0,
    "perpos": 0,
    "decprice": 0,
    "fiveround": 0,
    "hidecusrr": 0,
    "proptitle": "",
    "expandheadfoot": 0,
    "movebuttons": 0,
    "thepayon": 0,
    "setcompany": 0,
    "shop_image": "",
    "shop_text": ""
  },

  "advanceper": 30,
  "showgroup": 1,
  "thediscount": "5%",

  "groups": [
    {
      "name": "Main work",
      "title": "Alternative group title key",
      "product": "Alternative group title key",
      "advance": 30,
      "price": 30,
      "entries": [
        {
          "product_ref": 15,
          "product": "Line title override",
          "link": 15,
          "sku": "SKU-001",
          "product_variation_id": 0,
          "variation": "",
          "ammount": 2,
          "ammount2": 1,
          "amount": 2,
          "amount2": 1,
          "unit": "vnt",
          "unit2": "vnt",
          "price": 100,
          "prime": 80,
          "discount": 0,
          "discount_type": 0,
          "pvm": 21,
          "withpvm": 0,
          "supplier": "Supplier A",
          "marper": 0,
          "deli": 0,
          "price_per_unit": 0,
          "comment": "Short description / HTML",
          "notes": "Internal notes",
          "image": "gallery-id-or-path",
          "tags": "1,2,3",
          "group": "Main work",
          "attribute": "",
          "grams": 0,
          "accepted": 0,
          "acceptable": 0,
          "selectable": 0,
          "required": 0,
          "periodical": 0,
          "pricetype": 0,
          "amounttype": 0,
          "edit_amount": 0,
          "hide_amount": 0,
          "addup": 0,
          "amname": "",
          "template": 0,
          "counterpri": 0,
          "preview": 0,
          "translations": {
            "en": { "product": "English line title", "comment": "English description" }
          },
          "feature_values": {
            "12": [44, 45],
            "15": "custom text"
          },
          "feature_custom_text": { "15": "custom text" },
          "feature_custom_number": { "20": "5" },
          "children": [
            {
              "product_ref": "INCLUDED-SKU-001",
              "ammount": 1,
              "selectable": 1,
              "accepted": 1
            }
          ]
        },
        {
          "product": "Informational row",
          "attribute": "text_sep",
          "comment": "<p>HTML content</p>"
        }
      ]
    }
  ],

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

Note: send either entries or groups, not both as required lists. The example above shows both only for documentation. contact_object_example is not a real key — use contact with one of the supported formats below.

Top-level fields

Proposal fields

All columns mass-assignable on the proposals table. Send inside proposal or at top level.

Contact object

When contact is an object, it is created or updated via the same logic as POST /api/createcontact. See apicreatecontact.html for full details.

Settings object

Stored per proposal in the settings table. Keys may be sent inside settings or at top level.

Any other proposal setting key accepted by the app's settings helper may also be stored if sent inside settings. Array values are JSON-encoded before storage. Do not send tunc. tunc is a company setting (“Separate prices for included products”), not a proposal setting. The public offer and /accepting read it from company settings. A proposal-level tunc value is ignored and does not update group subtotals or the sticky/footer total. Group subtotals use showgroup. When company tunc is on and the parent has addup: 1, a bundle sumbox is shown next to included children. There is no showvat or showtax createproposal setting. The public offer hides the VAT row when the proposal tax rate and every commercial line are 0%.

Groups

Each group creates one group_sep entry, then creates the group's entries with the group name assigned.

Entry fields

Each item in entries[] or groups[].entries[]. All entries table fillable columns are accepted.

Product linking

Line content and pricing

Display, structure, and flags

order, orderp, parent, and proposal are assigned automatically. Do not send them unless you have a specific reason.

Product references

product_ref (or numeric/object product, or link, or bare sku) resolves in this order:

1. Integer id — existing product by products.id
2. String SKU — existing product by products.sku
3. Object with id — lookup by id
4. Object with sku — lookup by SKU
5. Object without match — inline create via apicreateproduct logic

Inline product object

Full product schema: apicreateproduct.html. Common keys:

{
  "name": "Created inline product",
  "sku": "INLINE-001",
  "category": "Services",
  "price": {
    "Supplier A": {
      "1": [50, 75, 0, 5]
    }
  },
  "description": "Short description",
  "withpvm": 0,
  "attributes": [],
  "variations": []
}

Price tier array: [cost, sale_price, delivery, discount]. Tier keys are strings ("1", "10", etc.).

When a product resolves, these entry fields are auto-filled from the product if not explicitly sent: link, product (name), sku, unit, unit2, pvm, withpvm, grams, amounttype, hide_amount, comment, image, price, prime, supplier.

Feature values on entries

Save product feature selections on a line. Keys are product_features.id values.

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

Child entries

children[] creates nested lines linked to the parent through the parent / orderp system (included products, selectable add-ons, etc.).

• Child objects use the same fields as regular entries.
• Set selectable: 1 on children the client may toggle on/off. That child flag does not hide the parent's SELECT! button.
• Set accepted: 1 to pre-select a selectable child.
• Required / packing children use selectable: 0 (no child SELECT toggle).
• Children may themselves contain children[] (recursive).

Enums and constants

Proposal type

Proposal status

Entry attribute

Entry hide_amount

Aliases and server rules

• amount → ammount, amount2 → ammount2
• product_object → same as inline product_ref object
• Group title / product → group name
• Group price → group advance
• nr is always regenerated; submitted value ignored
• url is only honored for type = 1; otherwise regenerated
• Proposal totals (total, margins, etc.) are recalculated after all entries are created
• Transaction rolls back on validation errors (e.g. missing name, missing entries)

Responses

Success

{
  "status": "ok",
  "data": {
    "proposal": {
      "id": 123,
      "name": "Website project",
      "url": "abc123def456",
      "nr": 1042,
      "client": "Client Company",
      "code": "300000001",
      "total": 1500,
      "...": "all proposal columns"
    },
    "entries": [
      {
        "id": 501,
        "proposal": 123,
        "product": "Design work",
        "link": 15,
        "ammount": 1,
        "price": 500,
        "...": "all entry columns",
        "images": [],
        "feature_values": []
      }
    ],
    "url": "https://your-domain/offer/abc123def456"
  }
}

Errors