Customer Offer Sending API

Managing outgoing customer price offers — retrieval, creation, modification, closing and document download

Base URL

https://{tenant}.logzi.com/api/offer_send/

Every request returns a JSON response. On success result.code == 1, on error result.code == 0.

GET /api/offer_send/get

Retrieves a single customer price offer by identifier, with full details.

Query parameters

ParameterTypeRequiredDescription
idintUnique identifier of the offer

Example request

GET /api/offer_send/get?id=15
X-API-KEY: {your_api_key}

Example response

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "id": 15,
    "identify": "AJ-2024-0015",
    "date_create": "2024-05-01 09:00:00",
    "date_perform": "2024-05-15",
    "status_id": 1,
    "partner_company_name": "Minta Kft.",
    "price_netto": 80000,
    "price_brutto": 101600,
    "currency_name": "HUF",
    "item": [
      { "product_id": 3, "quantity": 2, "price": 40000, "tax_id": 2 }
    ]
  }
}
GET /api/offer_send/list

Retrieves a paginated list of customer price offers with filtering options.

Query parameters

ParameterTypeRequiredDescription
list_offsetintPagination offset (default: 0)
list_countintNumber of records shown per page
list_sort[field]stringName of the sort field
list_sort[sort]stringSort direction: ASC or DESC
list_condition[identify]stringFilter by identifier (LIKE)
list_condition[company_name]stringFilter by partner name (LIKE)
list_condition[status_id]intFilter by status
list_condition[date_create_from]dateCreation date — from (YYYY-MM-DD)
list_condition[date_create_to]dateCreation date — to (YYYY-MM-DD)

Example request

GET /api/offer_send/list?list_offset=0&list_condition[status_id]=1
X-API-KEY: {your_api_key}

Example response

{
  "result": { "code": 1, "message": "success" },
  "data": [
    { "id": 15, "identify": "AJ-2024-0015", "partner_company_name": "Minta Kft.", "status_id": 1, "price_brutto": 101600 }
  ],
  "params": { "list_count": 20, "list_offset": 0, "list_all": 42 }
}
POST /api/offer_send/save

Creates or updates a customer price offer. For a new offer use data[id] = 0; for an update, provide the existing ID.

POST fields — data object

FieldTypeRequiredDescription
idint0 = new offer, >0 = update
company_idintCompany identifier
company_user_idintResponsible user ID
company_address_idintCompany site ID
currency_idintCurrency identifier
partner_idintPartner/customer identifier
date_performdateValidity date (YYYY-MM-DD)
comment_topstringComment visible to the customer
comment_bottomstringInternal comment
jobnumber_idintJob number identifier
project_idintProject identifier
itemarrayArray of items (see below)

Item fields — data[item][]

FieldTypeRequiredDescription
product_idintProduct identifier
quantityfloatQuantity
pricefloatNet unit price
tax_idintVAT rate identifier
price_discountfloatDiscount percentage
removeint1 = remove the item on update

POST fields — params object (optional)

FieldTypeRequiredDescription
closeint1 = automatically close after saving
downloadint1 = generate PDF after saving

Example request

POST /api/offer_send/save
X-API-KEY: {your_api_key}
Content-Type: application/json

{
  "data": {
    "id": 0,
    "company_id": 1,
    "company_user_id": 3,
    "company_address_id": 1,
    "currency_id": 1,
    "partner_id": 12,
    "date_perform": "2024-06-30",
    "comment_top": "Az ajánlat 30 napig érvényes.",
    "item": [
      { "product_id": 5, "quantity": 10, "price": 8000, "tax_id": 2 }
    ]
  },
  "params": { "close": 0, "download": 0 }
}

Example response

{
  "result": { "code": 1, "message": "success" },
  "data": { "id": 16, "identify": "AJ-2024-0016" }
}
POST /api/offer_send/delete

Deletes a customer price offer. Only an open offer (status_id=1) can be deleted.

POST fields — data object

FieldTypeRequiredDescription
receipt_idintIdentifier of the offer to delete

Example request

POST /api/offer_send/delete
X-API-KEY: {your_api_key}
Content-Type: application/json

{ "data": { "receipt_id": 15 } }

Example response

{ "result": { "code": 1, "message": "success" }, "data": {} }
POST /api/offer_send/close

Closes an open customer price offer. Only an offer with status_id = 1 (open) can be closed.

POST fields — data object

FieldTypeRequiredDescription
receipt_idintIdentifier of the offer to close

Example request

POST /api/offer_send/close
X-API-KEY: {your_api_key}
Content-Type: application/json

{ "data": { "receipt_id": 15 } }

Example response

{ "result": { "code": 1, "message": "success" }, "data": {} }
GET /api/offer_send/download

Downloads the customer price offer document in various formats.

Query parameters

ParameterTypeRequiredDescription
receipt_idintOffer identifier
file_typestringpdf, pdf-string, pdf-string-sample, stream
languagestringName of the template language folder (e.g. hungarian)
template_idintCustom print template ID

Example request

GET /api/offer_send/download?receipt_id=15&file_type=pdf
X-API-KEY: {your_api_key}

Get in touch with us

Interested in our software? Feel free to write to us!

Need help?

If you can't find the answer and need assistance

Create your account now,
pay later!

Try it free for 3 days, no risk, no obligation!