Create a Sale

1 min

POST

https://developer.digitail.io/api/v1/sales

Permissions needed: any of (CREATE_CHECKUPS, EDIT_CHECKUPS, CREATE_EDIT_COUNTER_SALE, SELL_SERVICES)

Query Parameters

new_response

Body Parameters

bodyobjectrequired
- discountnumber<float>
  Format
  float
- discount_percentagenumber<float>
  Format
  float
- discount_typestring<fixed | percentage>
  Allowed
  fixedpercentage
- discount_reasonobject
  - reasonstring
  - is_privatestring<public | private>
    Allowed
    publicprivate
- predefined_discountsinteger[]
- sold_productsobject[]
  - idinteger
  - product_idinteger
  - vet_idnumber<float>
    Format
    float
  - unit_idstring<unit | subunit>
    Allowed
    unitsubunit
  - unitstring
  - quantitynumber<float>
    Format
    float
  - sale_pricenumber<float>
    Format
    float
  - sale_price_with_vatnumber<float>
    Format
    float
  - vatnumber<float>
    Description
    Warning: Deprecated
    Deprecated for lines referencing a catalog item — use tax_rate_ids. Still required on write-in lines (no product_id / service_package_id).
    Format
    float
  - tax_rate_idsinteger[]
    Example
    [ 57 ]
    Description
    Tax rate ids to apply. Takes precedence over vat when present. Send at most the clinic's max_tax_rates (1 today).
  - pricenumber<float>
    Format
    float
  - sub_pricenumber<float>
    Format
    float
  - product_namestring
  - labelstring
  - recommendationsstring
  - is_checkout_boughtboolean
  - fixed_feenumber<float>
    Format
    float
  - include_fixed_feeboolean
  - discount_reasonobject
    - reasonstring
    - is_privatestring<public | private>
      Allowed
      publicprivate
  - discountnumber<float>
    Format
    float
  - discount_percentagenumber<float>
    Format
    float
  - discount_typestring<fixed | percentage>
    Allowed
    fixedpercentage
  - price_threshold_typestring<minimum | maximum>
    Allowed
    minimummaximum
  - purchase_order_itemsobject[]
    - idinteger
    - quantitynumber<float>
      Format
      float
- sold_servicesobject[]
  - idinteger
  - service_package_idinteger
  - quantitynumber<float>
    Format
    float
  - pricenumber<float>
    Format
    float
  - unit_pricenumber<float>
    Format
    float
  - vatnumber<float>
    Description
    Warning: Deprecated
    Deprecated for lines referencing a catalog item — use tax_rate_ids. Still required on write-in lines (no product_id / service_package_id).
    Format
    float
  - tax_rate_idsinteger[]
    Example
    [ 57 ]
    Description
    Tax rate ids to apply. Takes precedence over vat when present. Send at most the clinic's max_tax_rates (1 today).
  - vet_idnumber<float>
    Format
    float
  - namestring
  - original_pricenumber<float>
    Format
    float
  - is_checkout_boughtboolean
  - discountnumber<float>
    Format
    float
  - discount_percentagenumber<float>
    Format
    float
  - discount_typestring<fixed | percentage>
    Allowed
    fixedpercentage
  - discount_reasonobject
    - reasonstring
    - is_privatestring<public | private>
      Allowed
      publicprivate
  - aaha_codestring
  - productsobject[]
    - idinteger
    - product_idinteger
    - unitsobject[]
    - formulanumber<float>
      Format
      float
    - unit_price_with_vatnumber<float>
      Format
      float
    - subunit_price_with_vatnumber<float>
      Format
      float
    - unit_idstring<unit | subunit>
      Allowed
      unitsubunit
    - quantitynumber<float>
      Format
      float
    - labelstring
    - recommendationsstring
    - namestring
    - displayedboolean
    - purchase_order_itemsobject[]
      - idinteger
      - quantitynumber<float>
        Format
        float

Responses

200

object
- dataobject
  - idinteger
    Example
    1
  - clinic_idstring
    Example
    1
  - customer_idstring
    Example
    1
  - typeinteger
    Example
    1
  - customerdata
  - filedata
  - counter_saleinteger
    Description
    Id of the realted counter sale
  - amount_paidstring
    Example
    0.000
  - amount_duestring
    Example
    250.000
  - edit_state_detailsedit_state_details
  - statusinteger
    Description
    0 - No sale (zero total and no line items) 1 - Pending 2 - Paid 3 - Partially Paid 4 - Paid (Overdraft)
    Allowed
    01234
  - totalstring
    Example
    250.000
  - global_discount_netstring
    Example
    0.000
  - global_discount_taxstring
    Example
    0.000
  - global_discount_grossstring
    Example
    0.000
  - consolidatedboolean
    Description
    A consolidated sale is a group of sale. A consolidated sale can't have direct products or services associated with it.
  - created_atstring<date-time>
    Example
    2022-07-18T08:58:36.000000Z
    Format
    date-time
  - updated_atstring<date-time>
    Example
    2022-07-18T08:58:36.000000Z
    Format
    date-time

curl

curl --request POST \
     --url https://developer.digitail.io/api/v1/sales \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://developer.digitail.io/api/v1/sales", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://developer.digitail.io/api/v1/sales")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://developer.digitail.io/api/v1/sales"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

200

{
  "data": {
    "id": 1,
    "clinic_id": "1",
    "customer_id": "1",
    "type": 1,
    "customer": {},
    "file": {},
    "counter_sale": 0,
    "amount_paid": "0.000",
    "amount_due": "250.000",
    "edit_state_details": {},
    "status": 0,
    "total": "250.000",
    "global_discount_net": "0.000",
    "global_discount_tax": "0.000",
    "global_discount_gross": "0.000",
    "consolidated": false,
    "created_at": "2022-07-18T08:58:36.000000Z",
    "updated_at": "2022-07-18T08:58:36.000000Z"
  }
}