curl --request GET \
--url https://api.exowpee.com/v1/accounting/settlements/{settlement} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.exowpee.com/v1/accounting/settlements/{settlement}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.exowpee.com/v1/accounting/settlements/{settlement}', 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://api.exowpee.com/v1/accounting/settlements/{settlement}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.exowpee.com/v1/accounting/settlements/{settlement}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.exowpee.com/v1/accounting/settlements/{settlement}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.exowpee.com/v1/accounting/settlements/{settlement}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"company_id": "<string>",
"source_type": "<string>",
"source_id": "<string>",
"direction": "<string>",
"payment_method": "<string>",
"creation_mode": "<string>",
"status": "<string>",
"money_account_id": "<string>",
"payment_route_account_id": "<string>",
"register_payment_method_id": "<string>",
"original_amount": 123,
"original_currency_code": "<string>",
"original_currency_exponent": 123,
"company_functional_amount": 123,
"company_currency_code": "<string>",
"company_currency_exponent": 123,
"organization_functional_amount": 123,
"organization_currency_code": "<string>",
"organization_currency_exponent": 123,
"conversion_snapshot": {},
"external_reference": "<string>",
"initiated_at": "2023-11-07T05:31:56Z",
"settled_at": "2023-11-07T05:31:56Z",
"reversed_at": "2023-11-07T05:31:56Z",
"reversed_by": "<string>",
"reversed_by_type": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"message": "<string>",
"errors": {}
}View a settlement (company)
Shows one payment settlement of a company (company space).
curl --request GET \
--url https://api.exowpee.com/v1/accounting/settlements/{settlement} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.exowpee.com/v1/accounting/settlements/{settlement}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.exowpee.com/v1/accounting/settlements/{settlement}', 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://api.exowpee.com/v1/accounting/settlements/{settlement}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.exowpee.com/v1/accounting/settlements/{settlement}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.exowpee.com/v1/accounting/settlements/{settlement}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.exowpee.com/v1/accounting/settlements/{settlement}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"company_id": "<string>",
"source_type": "<string>",
"source_id": "<string>",
"direction": "<string>",
"payment_method": "<string>",
"creation_mode": "<string>",
"status": "<string>",
"money_account_id": "<string>",
"payment_route_account_id": "<string>",
"register_payment_method_id": "<string>",
"original_amount": 123,
"original_currency_code": "<string>",
"original_currency_exponent": 123,
"company_functional_amount": 123,
"company_currency_code": "<string>",
"company_currency_exponent": 123,
"organization_functional_amount": 123,
"organization_currency_code": "<string>",
"organization_currency_exponent": 123,
"conversion_snapshot": {},
"external_reference": "<string>",
"initiated_at": "2023-11-07T05:31:56Z",
"settled_at": "2023-11-07T05:31:56Z",
"reversed_at": "2023-11-07T05:31:56Z",
"reversed_by": "<string>",
"reversed_by_type": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"message": "<string>",
"errors": {}
}settlements.retrieve
Conditions
- The accounting module must be active for the organization.
- This action is available only in the company space.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Identifier of the settlement (27-character KSUID string).
Query Parameters
Response mode. Default resource; none answers 204 No Content.
resource Comma-separated JSON keys of the root resource (id is always rendered). Available: id, company_id, source_type, source_id, direction, payment_method, creation_mode, status, money_account_id, payment_route_account_id, register_payment_method_id, original_amount, original_currency_code, original_currency_exponent, company_functional_amount, company_currency_code, company_currency_exponent, organization_functional_amount, organization_currency_code, organization_currency_exponent, conversion_snapshot, external_reference, initiated_at, settled_at, reversed_at, reversed_by, reversed_by_type, created_at, updated_at.
Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: .
Response
Resource.
Identifier of the settlement (27-character KSUID string).
Identifier of the company the record belongs to.
Kind of business record whose payment is settled, for example order_payment or customer_credit_payment.
Identifier of that business record (27-character KSUID string). A payment can have only one settlement per company.
Direction of the money flow; incoming for payments received.
Payment method: credit_card (starts initiated, confirmed later by the organization), bank_transfer or mobile_money (created already settled).
manual or automatic: how the settlement was created. Settlements created for the supported methods are automatic.
initiated (waiting for the money), settled (money confirmed on the money account), cancelled (initiated one that was reversed) or reversed (settled one that was reversed).
Organization money account that receives the money (27-character KSUID string).
Accounting account of the payment route the payment went through (27-character KSUID string).
Identifier of the register payment method the payment went through (27-character KSUID string); null when the payment has none.
Amount in the currency the customer paid in, an integer in minor units (divide by 10 to the power original_currency_exponent).
Currency the customer paid in (ISO 4217 code).
Number of decimal places of the original currency.
Amount in the company currency, an integer in minor units, frozen from the payment conversion.
Company currency (ISO 4217 code).
Number of decimal places of the company currency.
Amount in the organization currency, an integer in minor units, frozen from the payment conversion.
Organization currency (ISO 4217 code).
Number of decimal places of the organization currency.
Frozen record of the conversions, the fees applied when settled, a hash of the confirmation payload, the accounting posting status and the journal entry identifiers, and the reversal details. Never recalculated with newer rates.
Reference supplied by the payment provider or the bank; null when none.
Date and time the settlement was initiated (ISO 8601).
Date and time the money was confirmed (ISO 8601); null until settled.
Date and time the settlement was reversed or cancelled (ISO 8601); null otherwise.
Identifier of the member profile or agent account who reversed it; null otherwise.
Type of the actor who reversed it; null otherwise.
Date and time the record was created (ISO 8601, UTC).
Date and time the record was last changed (ISO 8601, UTC).