Update ConsolidatedInvoice

1 min

PUT

https://developer.digitail.io/api/v1/sale/consolidate/{consolidatingSale}/update

Permissions needed: NONE This end point is used to update a consolidated invoice.

Path Parameters

consolidatingSaleintegerrequired
Description
The consolidating sale id

Body Parameters

bodyobjectrequired
- customer_idintegerrequired
  Example
  1
- invoice_datestring<date-time>required
  Example
  2020-01-01T00:00:00.000Z
  Format
  date-time
- sales_idsinteger[]
  Example
```
[
  1,
  2,
  3
]
```

Responses

200successful operation

object
- consolidatingSaleIdinteger
  Description
  Consolidating sale id
- invoiceobject
  Description
  Invoice object details
- invoicePreviewstring
  Description
  HTML string of consolidated invoice
- selectedSalesDetailsobject[]
  Description
  Contains details of selected sales that has been consolidated.
  - 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 PUT \
     --url https://developer.digitail.io/api/v1/sale/consolidate/{consolidatingSale}/update \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "customer_id": 1,
     "invoice_date": "2020-01-01T00:00:00.000Z"
     }'

javascript

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

var raw = JSON.stringify({
   "customer_id": 1,
   "invoice_date": "2020-01-01T00:00:00.000Z"
});

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

fetch("https://developer.digitail.io/api/v1/sale/consolidate/{consolidatingSale}/update", 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/sale/consolidate/{consolidatingSale}/update")

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

request = Net::HTTP::Put.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
   "customer_id": 1,
   "invoice_date": "2020-01-01T00:00:00.000Z"
})

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

python

import requests
import json

url = "https://developer.digitail.io/api/v1/sale/consolidate/{consolidatingSale}/update"

payload = json.dumps({
   "customer_id": 1,
   "invoice_date": "2020-01-01T00:00:00.000Z"
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

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

print(response.text)

200

// successful operation
{
  "consolidatingSaleId": 0,
  "invoice": {},
  "invoicePreview": "",
  "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\":[]}"