curl --request GET \
--url https://api.exowpee.com/v1/accounting/organization/books/{book}/payment-sources \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.exowpee.com/v1/accounting/organization/books/{book}/payment-sources"
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/organization/books/{book}/payment-sources', 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/organization/books/{book}/payment-sources",
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/organization/books/{book}/payment-sources"
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/organization/books/{book}/payment-sources")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.exowpee.com/v1/accounting/organization/books/{book}/payment-sources")
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{
"data": [
{
"id": "<string>",
"company_id": "<string>",
"organization_id": "<string>",
"source_type": "<string>",
"source_id": "<string>",
"payment_method": "<string>",
"register_payment_method_id": "<string>",
"money_account_id": "<string>",
"functional_amount": 123,
"currency_code": "<string>",
"currency_exponent": 123,
"original_amount": 123,
"original_currency_code": "<string>",
"original_currency_exponent": 123,
"company_settlement_amount": 123,
"company_incoming_fee_snapshot": {},
"customer": {},
"customer_id": "<string>",
"order": {},
"reference": "<string>",
"received_at": "2023-11-07T05:31:56Z",
"accounting_status": "<string>",
"settlement_id": "<string>",
"settlement": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"meta": {
"per_page": 123,
"next_cursor": "<string>",
"prev_cursor": "<string>"
}
}{
"message": "<string>",
"errors": {}
}List payment sources (organization)
Organization space, on a chosen company book. Lists the payments recorded for accounting, except cheques, with amount filters.
curl --request GET \
--url https://api.exowpee.com/v1/accounting/organization/books/{book}/payment-sources \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.exowpee.com/v1/accounting/organization/books/{book}/payment-sources"
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/organization/books/{book}/payment-sources', 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/organization/books/{book}/payment-sources",
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/organization/books/{book}/payment-sources"
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/organization/books/{book}/payment-sources")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.exowpee.com/v1/accounting/organization/books/{book}/payment-sources")
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{
"data": [
{
"id": "<string>",
"company_id": "<string>",
"organization_id": "<string>",
"source_type": "<string>",
"source_id": "<string>",
"payment_method": "<string>",
"register_payment_method_id": "<string>",
"money_account_id": "<string>",
"functional_amount": 123,
"currency_code": "<string>",
"currency_exponent": 123,
"original_amount": 123,
"original_currency_code": "<string>",
"original_currency_exponent": 123,
"company_settlement_amount": 123,
"company_incoming_fee_snapshot": {},
"customer": {},
"customer_id": "<string>",
"order": {},
"reference": "<string>",
"received_at": "2023-11-07T05:31:56Z",
"accounting_status": "<string>",
"settlement_id": "<string>",
"settlement": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"meta": {
"per_page": 123,
"next_cursor": "<string>",
"prev_cursor": "<string>"
}
}{
"message": "<string>",
"errors": {}
}accounting_payment_sources.list
Conditions
- The accounting module must be active for the organization.
- The caller must have been granted access to the book in the URL.
- The book in the URL must be a company book; the organization’s own book or a client book is refused.
- Only payment sources of that company are listed.
- Cheque payments are never listed here; filtering on payment_method cheque is refused, because cheques have their own resource.
- to must not be before from, and max_amount must not be below min_amount.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Identifier of the company book whose payment sources are listed.
Query Parameters
Number of items per page.
1 <= x <= 100Position in the list. Pass the meta.next_cursor or meta.prev_cursor value of the previous page; leave it out to get the first page.
Field the list is sorted by.
received_at, functional_amount, created_at asc for ascending order, desc for descending order.
asc, desc Keeps only payments made with this method: cash, credit_card, bank_transfer, mobile_money or other. cheque is refused.
cash, credit_card, bank_transfer, mobile_money, cheque, other Keeps only payment sources in this accounting status (up to 40 characters): not_initiated, initiated, settled, cancelled or reversed.
40Keeps only payments recorded by this kind of business record, for example order_payment or customer_credit_payment.
100Keeps only the payment source created by this business record (27-character KSUID string).
27Keeps only payments of this customer (27-character KSUID string).
27Keeps payments received on or after this date (ISO 8601); the whole day is included.
Keeps payments received on or before this date (ISO 8601); the whole day is included. Must not be before from.
Keeps payments whose amount (functional_amount, in minor units of the company currency) is at least this integer.
x >= 0Keeps payments whose amount (functional_amount, in minor units of the company currency) is at most this integer. Must not be below min_amount.
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, organization_id, source_type, source_id, payment_method, register_payment_method_id, money_account_id, functional_amount, currency_code, currency_exponent, original_amount, original_currency_code, original_currency_exponent, company_settlement_amount, company_incoming_fee_snapshot, customer, customer_id, order, reference, received_at, accounting_status, settlement_id, 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: settlement.