curl --request POST \
--url https://app.flextell.ai/api/v1/sales/{id}/payments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Tenant: <x-tenant>' \
--data '
{
"amount": 1.01,
"currency_id": 123,
"exchange_rate": 1,
"transaction_date": "2023-11-07T05:31:56Z",
"invoice_number": "<string>",
"description": "<string>",
"installment_number": 2,
"account_id": 123
}
'import requests
url = "https://app.flextell.ai/api/v1/sales/{id}/payments"
payload = {
"amount": 1.01,
"currency_id": 123,
"exchange_rate": 1,
"transaction_date": "2023-11-07T05:31:56Z",
"invoice_number": "<string>",
"description": "<string>",
"installment_number": 2,
"account_id": 123
}
headers = {
"X-Tenant": "<x-tenant>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Tenant': '<x-tenant>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
amount: 1.01,
currency_id: 123,
exchange_rate: 1,
transaction_date: '2023-11-07T05:31:56Z',
invoice_number: '<string>',
description: '<string>',
installment_number: 2,
account_id: 123
})
};
fetch('https://app.flextell.ai/api/v1/sales/{id}/payments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.flextell.ai/api/v1/sales/{id}/payments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'amount' => 1.01,
'currency_id' => 123,
'exchange_rate' => 1,
'transaction_date' => '2023-11-07T05:31:56Z',
'invoice_number' => '<string>',
'description' => '<string>',
'installment_number' => 2,
'account_id' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-Tenant: <x-tenant>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.flextell.ai/api/v1/sales/{id}/payments"
payload := strings.NewReader("{\n \"amount\": 1.01,\n \"currency_id\": 123,\n \"exchange_rate\": 1,\n \"transaction_date\": \"2023-11-07T05:31:56Z\",\n \"invoice_number\": \"<string>\",\n \"description\": \"<string>\",\n \"installment_number\": 2,\n \"account_id\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Tenant", "<x-tenant>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.flextell.ai/api/v1/sales/{id}/payments")
.header("X-Tenant", "<x-tenant>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 1.01,\n \"currency_id\": 123,\n \"exchange_rate\": 1,\n \"transaction_date\": \"2023-11-07T05:31:56Z\",\n \"invoice_number\": \"<string>\",\n \"description\": \"<string>\",\n \"installment_number\": 2,\n \"account_id\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.flextell.ai/api/v1/sales/{id}/payments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Tenant"] = '<x-tenant>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 1.01,\n \"currency_id\": 123,\n \"exchange_rate\": 1,\n \"transaction_date\": \"2023-11-07T05:31:56Z\",\n \"invoice_number\": \"<string>\",\n \"description\": \"<string>\",\n \"installment_number\": 2,\n \"account_id\": 123\n}"
response = http.request(request)
puts response.read_body{
"success": "<string>",
"data": {
"sale_id": "<string>",
"remaining_balance": "<string>",
"transaction": {
"id": "<string>",
"type": "<string>",
"credit": "<string>",
"debit": "<string>",
"currency_id": "<string>",
"exchange_rate": "<string>",
"invoice_number": "<string>",
"description": "<string>",
"is_installment": true,
"installment_number": "<string>",
"total_installments": "<string>",
"due_date": "<string>"
}
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"success": true,
"error_code": "RESOURCE_NOT_FOUND",
"message": "<string>",
"errors": null,
"data": null
}{
"success": false,
"error_code": "CUSTOMER_ERASED",
"message": "<string>"
}{
"message": "<string>",
"errors": {}
}{
"success": false,
"error_code": "SETUP_REQUIRED",
"message": "Complete the required setup steps to continue.",
"data": {
"next_step": "clinic_info"
}
}Add payment to a sale
Requires Pay:Sale. Without ViewAllSales:Sale only the caller’s own sales are accepted;
any other sale returns 404. On an installment sale, installment_number links the collection
to that installment; the collections linked to one installment cannot exceed its amount.
curl --request POST \
--url https://app.flextell.ai/api/v1/sales/{id}/payments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Tenant: <x-tenant>' \
--data '
{
"amount": 1.01,
"currency_id": 123,
"exchange_rate": 1,
"transaction_date": "2023-11-07T05:31:56Z",
"invoice_number": "<string>",
"description": "<string>",
"installment_number": 2,
"account_id": 123
}
'import requests
url = "https://app.flextell.ai/api/v1/sales/{id}/payments"
payload = {
"amount": 1.01,
"currency_id": 123,
"exchange_rate": 1,
"transaction_date": "2023-11-07T05:31:56Z",
"invoice_number": "<string>",
"description": "<string>",
"installment_number": 2,
"account_id": 123
}
headers = {
"X-Tenant": "<x-tenant>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Tenant': '<x-tenant>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
amount: 1.01,
currency_id: 123,
exchange_rate: 1,
transaction_date: '2023-11-07T05:31:56Z',
invoice_number: '<string>',
description: '<string>',
installment_number: 2,
account_id: 123
})
};
fetch('https://app.flextell.ai/api/v1/sales/{id}/payments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.flextell.ai/api/v1/sales/{id}/payments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'amount' => 1.01,
'currency_id' => 123,
'exchange_rate' => 1,
'transaction_date' => '2023-11-07T05:31:56Z',
'invoice_number' => '<string>',
'description' => '<string>',
'installment_number' => 2,
'account_id' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-Tenant: <x-tenant>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.flextell.ai/api/v1/sales/{id}/payments"
payload := strings.NewReader("{\n \"amount\": 1.01,\n \"currency_id\": 123,\n \"exchange_rate\": 1,\n \"transaction_date\": \"2023-11-07T05:31:56Z\",\n \"invoice_number\": \"<string>\",\n \"description\": \"<string>\",\n \"installment_number\": 2,\n \"account_id\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Tenant", "<x-tenant>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.flextell.ai/api/v1/sales/{id}/payments")
.header("X-Tenant", "<x-tenant>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 1.01,\n \"currency_id\": 123,\n \"exchange_rate\": 1,\n \"transaction_date\": \"2023-11-07T05:31:56Z\",\n \"invoice_number\": \"<string>\",\n \"description\": \"<string>\",\n \"installment_number\": 2,\n \"account_id\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.flextell.ai/api/v1/sales/{id}/payments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Tenant"] = '<x-tenant>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 1.01,\n \"currency_id\": 123,\n \"exchange_rate\": 1,\n \"transaction_date\": \"2023-11-07T05:31:56Z\",\n \"invoice_number\": \"<string>\",\n \"description\": \"<string>\",\n \"installment_number\": 2,\n \"account_id\": 123\n}"
response = http.request(request)
puts response.read_body{
"success": "<string>",
"data": {
"sale_id": "<string>",
"remaining_balance": "<string>",
"transaction": {
"id": "<string>",
"type": "<string>",
"credit": "<string>",
"debit": "<string>",
"currency_id": "<string>",
"exchange_rate": "<string>",
"invoice_number": "<string>",
"description": "<string>",
"is_installment": true,
"installment_number": "<string>",
"total_installments": "<string>",
"due_date": "<string>"
}
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"success": true,
"error_code": "RESOURCE_NOT_FOUND",
"message": "<string>",
"errors": null,
"data": null
}{
"success": false,
"error_code": "CUSTOMER_ERASED",
"message": "<string>"
}{
"message": "<string>",
"errors": {}
}{
"success": false,
"error_code": "SETUP_REQUIRED",
"message": "Complete the required setup steps to continue.",
"data": {
"next_step": "clinic_info"
}
}Yetkilendirmeler
The access token received from the authorization server in the OAuth 2.0 flow.
Başlıklar
Tenant identifier. Send the Tenant ID in the X-Tenant header to scope API requests to a specific tenant.
Yol Parametreleri
The sale identifier
Gövde
Monetary amount.
x >= 0.01The payment method used for this collection or payment.
bank_account, cash, transfer_cash, other, clinic_credit_card, credit_card, private_insurance, sgk Currency of the payment; defaults to the sale currency.
Currency exchange rate.
x >= 0Transaction date (YYYY-MM-DD).
The transaction type; defaults to a collection when omitted.
collection, payment, null The invoice number the payment belongs to.
255The description.
65535The installment (1-based) of an installment sale this collection settles. Must exist in the sale's installment plan, and the collections linked to one installment cannot exceed its amount. Not allowed for payments.
x >= 1Account ID.