Get a list of Sales

1 min

GET

/api/v1/sales

Returns list of Sales

Query Parameters

filter[id]integer
Description
Sale ID
filter[customer_id]integer
Example
1
Description
Client/Owner Id
filter[pet_id]integer
Description
Pet ID
filter[status]string
Description
Status (comma separated statuses: 0 - No Sale; 1 - Pending, 2 - Paid, 3 - Partial, 4 - Overdraft)
filter[include_consolidated]boolean
Description
Include consolidated Sales - those with consolidated=1 (default false)
includestring
Description
Additional relations to include. Ex.: invoice,file
filter[has_monetization]boolean
Description
Belongs to a Record that has attached a service or treatment (total > 0);Used to include/ignore Draft Records; Default value: true
filter[created_at]string[]
Description
Dates between when sale was added in the platform
filter[updated_at]string[]
Description
Dates between when sale was last updated in the platform

Responses

200successful operation

object
- dataSale[]
  - idinteger
    Example
    1
  - clinic_idstring
    Example
    1
  - customer_idstring
    Example
    1
  - customerSaleCustomer
    - idinteger
      Example
      1
    - namestring
      Example
      John
    - last_namestring
      Example
      Doe
    - emailstring
      Example
      [email protected]
    - phonestring
      Example
      +16175551212.
      Description
      Phone number in E.164 format
    - addressstring
      Example
      Flowers St. 300, Palo Alto, 123456, USA
    - citystring
      Example
      Palo Alto
    - streetstring
      Example
      Flowers St.
    - street_numberstring
      Example
      300
    - countryCountry
      - idinteger
        Example
        6
      - namestring
        Example
        United States
      - iso_codestring
        Example
        us
      - codestring
        Example
        usa
    - zipstring
      Example
      123456
    - regionstring
      Example
      California
    - timezonestring
      Example
      America/Los_Angeles
    - has_appboolean
      Example
      true
    - chatUidstring
      Example
      e58ed763-928c-4155-bee9-fdbaaadc15f3
  - fileRecord
    - idinteger
      Example
      1
    - numberstring
      Example
      175
    - statusinteger
      Example
      1
      Description
      `0` - Draft `1` - Saved `2` - Closed `3` - Hospitalized
    - vet_idinteger
      Example
      1
    - clinic_idinteger
      Example
      1
    - pet_idinteger
      Example
      1
    - sale_idinteger
      Example
      1
    - datestring
      Example
      2021-11-19
    - reasonstring
      Example
      Routine checkup
    - template_idinteger
    - commentsstring
    - recommendationsstring
    - rabic_tag_numberstring
    - presumptive_diagnosisstring
    - diagnosisstring
    - treatmentstring
  - counter_saleinteger
    Description
    Id of the realted counter sale
  - amount_paidstring
    Example
    0.000
  - amount_duestring
    Example
    250.000
  - edit_state_detailsobject
    - stateinteger
      Description
      `1` - Open `2` - Ready For Checkout `3` - Closed
    - labelstring
      Description
      Label of the current state
    - can_transit_toobject[]
      - labelstring
        Example
        labels.sale_edit_state.states.open
      - actionstring
        Example
        labels.sale_edit_state.actions.open
      - stateinteger
        Example
        1
  - statusinteger
    Description
    `0` - Pending `1` - Pending `2` - Paid `3` - Partially Paid `4` - Paid (Overdraft)
  - totalstring
    Example
    250.000
  - global_discount_netstring
    Example
    0.000
  - global_discount_taxstring
    Example
    0.000
  - global_discount_grossstring
    Example
    0.000
  - consolidatedboolean
  - created_atstring<date-time>
    Example
    2022-07-18T08:58:36.000000Z
  - updated_atstring<date-time>
    Example
    2022-07-18T08:58:36.000000Z
- linkslinks
- metameta

curl

curl --request GET \
     --url /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: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("/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("/api/v1/sales")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

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

python

import requests
import json

url = "/api/v1/sales"

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

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

print(response.text)

200

// successful operation
{
  "data": [
    {
      "id": 1,
      "clinic_id": "1",
      "customer_id": "1",
      "customer": {
        "id": 1,
        "name": "John",
        "last_name": "Doe",
        "email": "[email protected]",
        "phone": "+16175551212.",
        "address": "Flowers St. 300, Palo Alto, 123456, USA",
        "city": "Palo Alto",
        "street": "Flowers St.",
        "street_number": "300",
        "country": {
          "id": 6,
          "name": "United States",
          "iso_code": "us",
          "code": "usa"
        },
        "zip": "123456",
        "region": "California",
        "timezone": "America/Los_Angeles",
        "has_app": true,
        "chatUid": "e58ed763-928c-4155-bee9-fdbaaadc15f3"
      },
      "file": {
        "id": 1,
        "number": "175",
        "status": 1,
        "vet_id": 1,
        "clinic_id": 1,
        "pet_id": 1,
        "sale_id": 1,
        "date": "2021-11-19",
        "reason": "Routine checkup",
        "template_id": 0,
        "comments": "",
        "recommendations": "",
        "rabic_tag_number": "",
        "presumptive_diagnosis": "",
        "diagnosis": "",
        "treatment": ""
      },
      "counter_sale": 0,
      "amount_paid": "0.000",
      "amount_due": "250.000",
      "edit_state_details": {
        "state": 0,
        "label": "",
        "can_transit_to": [
          {
            "label": "labels.sale_edit_state.states.open",
            "action": "labels.sale_edit_state.actions.open",
            "state": 1
          }
        ]
      },
      "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"
    }
  ],
  "links": {},
  "meta": {}
}