Pay sale with client credit

1 min

POST

/api/v1/sales/{id}/pay-with-credit

If amount sent is greater than sale amount due, after the sale is paid, difference between amount sent and sale amount due is used to pay outstanding balance sales. undefined

Body Parameters

bodyobjectrequired
- amountnumber<double>
  Example
  100,00
- typeinteger
  Description
  Payment from client credit has type 8
  Default
  8
- datestring<date-time>
  Description
  Payment date.
- notesstring
  Example
  Paid with credit
  Description
  Payment notes - if not sent then the notes from the charge will be used

Responses

200Successful operation - return sale's payments

object
- dataobject
  - idinteger
    Example
    6
  - amountnumber<double>
    Example
    100.00
  - amount_refundednumber<double>
    Example
    0.00
  - amount_leftnumber<double>
    Example
    0.00
  - datestring<date-time>
    Example
    2022-05-13T00:00:00Z
  - notesstring
  - sale_idinteger
    Example
    5
  - saleobject
  - charge_idinteger
    Example
    4
  - chargeobject

curl

curl --request POST \
     --url /api/v1/sales/{id}/pay-with-credit \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "type": 8
     }'

javascript

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

var raw = JSON.stringify({
   "type": 8
});

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

fetch("/api/v1/sales/{id}/pay-with-credit", 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/{id}/pay-with-credit")

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({
   "type": 8
})

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

python

import requests
import json

url = "/api/v1/sales/{id}/pay-with-credit"

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

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

print(response.text)

200

// Successful operation - return sale's payments
{
  "data": {
    "id": 6,
    "amount": "100.00",
    "amount_refunded": "0.00",
    "amount_left": "0.00",
    "date": "2022-05-13T00:00:00Z",
    "notes": "",
    "sale_id": 5,
    "sale": {},
    "charge_id": 4,
    "charge": {}
  }
}