Get

[POST] .../v1/doccommercialoffer/get

Returns information about document commercial offer. Use this method to retrieve commercial offer documents for sales proposal screens, price negotiation workflows and integrations that need offer header data. The request requires the commercial offer select permission, the commercial offer tariff option must be enabled and the query supports filters such as id, partner_id, currency_id, attached_user_id, date/start_date/end_date, search, blocked, deleted_mark and vat_calculation_type, plus sort_orders and pagination. The response returns a paged list with commercial offer date, code, partner, currency, amount, exchange rate, VAT calculation type, responsible user, lock state, deletion mark, next_offset and total. Business errors such as missing body, denied access, disabled tariff option, invalid filters or sort_orders, database failures or persistent lookup errors are returned as HTTP 200 ErrorResult.

Request Parameters

Name Type Required Description
filters Array of Filter Optional Optional filters by fields available for this API method.
limit Int32 Optional Number of result items to return.
offset Int32 Optional Offset from the beginning of the result set.
search String Optional Search string for fields: code - document code, partner_name - partner full name, partner_inn - partner taxpayer identification number, attached_user_name - responsible user full name.
sort_orders Array of DocCommercialOfferColumn Optional Output parameter sorting.

Filterable Fields

Field Type Description
attached_user_id int Responsible user IDs.
blocked bool Document edit lock state: true - locked, false - unlocked.
currency_id int Currency ID array.
date int
deleted_mark bool Deletion mark state: true - marked for deletion, false - not marked for deletion.
end_date int Period end date as Unix time in seconds.
id int Commercial offer document ID array.
partner_id int Partner IDs.
start_date int Period start date as Unix time in seconds.
vat_calculation_type string VAT calculation mode: No - do not accrue, Exclude - included in the amount, Include - added on top.

Sortable Fields

Field
amount
attached_user.name
blocked
code
currency.name
date
deleted_mark
id
last_update
partner.name
vat_calculation_type

Request Example

{
  "filters": [
    {
      "Field": "attached_user_id",
      "Operator": "Equal",
      "Value": "string"
    }
  ],
  "limit": 1,
  "offset": 1,
  "search": "string",
  "sort_orders": [
    {
      "column": "code",
      "direction": "ASC"
    }
  ]
}

Response Parameters

Name Type Description
next_offset Int32 Offset for the next data page.
ok Boolean Indicates whether the request completed successfully.
result Array of DocCommercialOffer Result array.
total Int64 Total number of result items.

Response Example

{
  "next_offset": 1,
  "ok": true,
  "result": [
    {
      "amount": 1.0,
      "attached_user": {
        "active": true,
        "address": "string",
        "can_authorize": true,
        "date_of_birth": "string",
        "description": "string",
        "email": "string",
        "enable_hints": true,
        "fields": [
          {
            "data_type": "string",
            "is_custom": true,
            "key": "string",
            "metadata": "string",
            "name": "string",
            "required": true,
            "value": "string"
          }
        ],
        "first_name": "string",
        "full_name": "string",
        "id": 1,
        "internal_phone": "string",
        "language_code": "string",
        "last_name": "string",
        "last_update": 1,
        "login": "string",
        "main_phone": "string",
        "middle_name": "string",
        "phones": "string",
        "photo_url": "string",
        "seller_barcode": "string",
        "sex": "none",
        "sub": "string",
        "system": true,
        "user_group": {
          "child_count": 1,
          "id": 1,
          "last_update": 1,
          "name": "string",
          "parent_id": 1
        }
      },
      "blocked": true,
      "code": "string",
      "currency": {
        "code_chr": "string",
        "code_num": 1,
        "deleted": true,
        "exchange_rate": 1.0,
        "id": 1,
        "is_base": true,
        "last_update": 1,
        "name": "string"
      },
      "date": 1,
      "deleted_mark": true,
      "description": "string",
      "exchange_rate": 1.0,
      "id": 1,
      "last_update": 1,
      "partner": {
        "address": "string",
        "bank_name": "string",
        "boss_name": "string",
        "deleted_mark": true,
        "description": "string",
        "email": "string",
        "fields": [
          {
            "data_type": "string",
            "is_custom": true,
            "key": "string",
            "metadata": "string",
            "name": "string",
            "required": true,
            "value": "string"
          }
        ],
        "fullname": "string",
        "group": {
          "child_count": 1,
          "id": 1,
          "last_update": 1,
          "name": "string",
          "parent_id": 1
        },
        "id": 1,
        "inn": "string",
        "last_update": 1,
        "legal_status": "Legal",
        "mfo": "string",
        "name": "string",
        "oked": "string",
        "phones": "string",
        "rs": "string",
        "vat_index": "string"
      },
      "vat_calculation_type": "No"
    }
  ],
  "total": 1
}