Preview consolidated invoice

1 min

POST

/api/v1/sale/consolidate/preview/{consolidatingSale}

This end point is used to preview the consolidated invoice for selected sales, if no sale is selected all customer sales eligible for consolidation are used - create flow.
If ID of a already consoliated sale is provided (in body an in path also!!!)then preview of existing consolidated invoice is returned - update flow.
property notConsolidatedSalesDetails from response Contains details for all customer sales eligibe for consolidation process.
property selectedSalesDetails from response Contains details of selected sales for consolidation process. null - if the request is made with empty sales_ids parameter

Path Parameters

consolidatingSaleinteger
Description
Consolidating sale for with the preview is requested -on preview update

Body Parameters

bodyobjectrequired
- customer_idintegerrequired
- consolidating_sale_idinteger
  Description
  Required for a existing consolidated invoice preview - on update flow
- invoice_datestringrequired
- sales_idsinteger[]

Responses

200successful operation

object
- consolidatingSaleIdinteger
  Description
  Consolidating sale id for existing consolidated invoice preview - on update flow
- invoicePreviewstring
  Description
  HTML string of invoice
- notConsolidatedSalesDetailsobject[]
  Description
  Contains details for all customer sales eligibe for consolidation process
  - datestring
    Description
    Sale date
  - idinteger
    Description
    Sale record or counter sale id
  - numberstring
    Description
    Sale record number, null for counter sale
  - petobject
    Description
    Pet details - if sale is from a pet record
  - saleobject
    Description
    Sale details
  - sale_idinteger
    Description
    Sale id
- selectedSalesDetailsobject[]
  Description
  Contains details of selected sales for consolidation process. null - if the request is made with empty sales_ids parameter
  - datestring
    Description
    Sale date
  - idinteger
    Description
    Sale record or counter sale id
  - numberstring
    Description
    Sale record number, null for counter sale
  - petobject
    Description
    Pet details - if sale is from a pet record
  - saleobject
    Description
    Sale details
  - sale_idinteger
    Description
    Sale id

422Bad request

undefined

Example

{
  "key": "labels.consolidate_invoice.errors.sales_have_payments",
  "message": "exceptions.labels.consolidate_invoice.errors.sales_have_payments",
  "meta": []
}

curl

curl --request POST \
     --url /api/v1/sale/consolidate/preview/{consolidatingSale} \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "customer_id": 0,
     "invoice_date": ""
     }'

javascript

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

var raw = JSON.stringify({
   "customer_id": 0,
   "invoice_date": ""
});

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

fetch("/api/v1/sale/consolidate/preview/{consolidatingSale}", 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/sale/consolidate/preview/{consolidatingSale}")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
   "customer_id": 0,
   "invoice_date": ""
})

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

python

import requests
import json

url = "/api/v1/sale/consolidate/preview/{consolidatingSale}"

payload = json.dumps({
   "customer_id": 0,
   "invoice_date": ""
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

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

print(response.text)

200

// successful operation
{
  "consolidatingSaleId": 0,
  "invoicePreview": "",
  "notConsolidatedSalesDetails": [
    {
      "date": "",
      "id": 0,
      "number": "",
      "pet": {},
      "sale": {},
      "sale_id": 0
    }
  ],
  "selectedSalesDetails": [
    {
      "date": "",
      "id": 0,
      "number": "",
      "pet": {},
      "sale": {},
      "sale_id": 0
    }
  ]
}

422

// Bad request
"{\"key\":\"labels.consolidate_invoice.errors.sales_have_payments\",\"message\":\"exceptions.labels.consolidate_invoice.errors.sales_have_payments\",\"meta\":[]}"