curl --request POST \
--url https://api.exowpee.com/v1/accounting/cheque-transfers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"source_type": "<string>",
"source_id": "<string>",
"transferred_at": "2023-11-07T05:31:56Z",
"external_reference": "<string>"
}
'import requests
url = "https://api.exowpee.com/v1/accounting/cheque-transfers"
payload = {
"source_type": "<string>",
"source_id": "<string>",
"transferred_at": "2023-11-07T05:31:56Z",
"external_reference": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
source_type: '<string>',
source_id: '<string>',
transferred_at: '2023-11-07T05:31:56Z',
external_reference: '<string>'
})
};
fetch('https://api.exowpee.com/v1/accounting/cheque-transfers', 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/cheque-transfers",
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([
'source_type' => '<string>',
'source_id' => '<string>',
'transferred_at' => '2023-11-07T05:31:56Z',
'external_reference' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://api.exowpee.com/v1/accounting/cheque-transfers"
payload := strings.NewReader("{\n \"source_type\": \"<string>\",\n \"source_id\": \"<string>\",\n \"transferred_at\": \"2023-11-07T05:31:56Z\",\n \"external_reference\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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://api.exowpee.com/v1/accounting/cheque-transfers")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"source_type\": \"<string>\",\n \"source_id\": \"<string>\",\n \"transferred_at\": \"2023-11-07T05:31:56Z\",\n \"external_reference\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.exowpee.com/v1/accounting/cheque-transfers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"source_type\": \"<string>\",\n \"source_id\": \"<string>\",\n \"transferred_at\": \"2023-11-07T05:31:56Z\",\n \"external_reference\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"organization_id": "<string>",
"company_id": "<string>",
"status": "<string>",
"source_type": "<string>",
"source_id": "<string>",
"original_amount": 123,
"currency_code": "<string>",
"currency_exponent": 123,
"company_amount": 123,
"company_currency_code": "<string>",
"company_currency_exponent": 123,
"organization_amount": 123,
"organization_currency_code": "<string>",
"organization_currency_exponent": 123,
"external_reference": "<string>",
"transferred_at": "2023-11-07T05:31:56Z",
"transferred_by": "<string>",
"transferred_by_type": "<string>",
"organization_settled_at": "2023-11-07T05:31:56Z",
"organization_settled_by": "<string>",
"organization_settled_by_type": "<string>",
"reversed_at": "2023-11-07T05:31:56Z",
"reversed_by": "<string>",
"reversed_by_type": "<string>",
"company_journal_entry_id": "<string>",
"organization_journal_entry_id": "<string>",
"company_reversal_journal_entry_id": "<string>",
"organization_reversal_journal_entry_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"message": "<string>",
"errors": {}
}Transfer a cheque
Hands a cheque payment over to the organization and records the movement in both books (company space).
curl --request POST \
--url https://api.exowpee.com/v1/accounting/cheque-transfers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"source_type": "<string>",
"source_id": "<string>",
"transferred_at": "2023-11-07T05:31:56Z",
"external_reference": "<string>"
}
'import requests
url = "https://api.exowpee.com/v1/accounting/cheque-transfers"
payload = {
"source_type": "<string>",
"source_id": "<string>",
"transferred_at": "2023-11-07T05:31:56Z",
"external_reference": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
source_type: '<string>',
source_id: '<string>',
transferred_at: '2023-11-07T05:31:56Z',
external_reference: '<string>'
})
};
fetch('https://api.exowpee.com/v1/accounting/cheque-transfers', 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/cheque-transfers",
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([
'source_type' => '<string>',
'source_id' => '<string>',
'transferred_at' => '2023-11-07T05:31:56Z',
'external_reference' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://api.exowpee.com/v1/accounting/cheque-transfers"
payload := strings.NewReader("{\n \"source_type\": \"<string>\",\n \"source_id\": \"<string>\",\n \"transferred_at\": \"2023-11-07T05:31:56Z\",\n \"external_reference\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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://api.exowpee.com/v1/accounting/cheque-transfers")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"source_type\": \"<string>\",\n \"source_id\": \"<string>\",\n \"transferred_at\": \"2023-11-07T05:31:56Z\",\n \"external_reference\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.exowpee.com/v1/accounting/cheque-transfers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"source_type\": \"<string>\",\n \"source_id\": \"<string>\",\n \"transferred_at\": \"2023-11-07T05:31:56Z\",\n \"external_reference\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"organization_id": "<string>",
"company_id": "<string>",
"status": "<string>",
"source_type": "<string>",
"source_id": "<string>",
"original_amount": 123,
"currency_code": "<string>",
"currency_exponent": 123,
"company_amount": 123,
"company_currency_code": "<string>",
"company_currency_exponent": 123,
"organization_amount": 123,
"organization_currency_code": "<string>",
"organization_currency_exponent": 123,
"external_reference": "<string>",
"transferred_at": "2023-11-07T05:31:56Z",
"transferred_by": "<string>",
"transferred_by_type": "<string>",
"organization_settled_at": "2023-11-07T05:31:56Z",
"organization_settled_by": "<string>",
"organization_settled_by_type": "<string>",
"reversed_at": "2023-11-07T05:31:56Z",
"reversed_by": "<string>",
"reversed_by_type": "<string>",
"company_journal_entry_id": "<string>",
"organization_journal_entry_id": "<string>",
"company_reversal_journal_entry_id": "<string>",
"organization_reversal_journal_entry_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"message": "<string>",
"errors": {}
}cheque_transfers.create
Conditions
- The organization’s plan must include the accounting module; otherwise the call is refused before anything else.
- This action is available only in the company space.
- source_type and source_id must identify a payment source of your company whose payment method is cheque; otherwise the call is refused.
- A transfer can be made only once per payment: any existing transfer for the same company and source, even a cancelled one, refuses the call.
- Refused when a settlement already exists on the same payment source, because the cheque would be posted twice.
- The payment source must hold valid conversion snapshots for the company and the organization.
- The transferred_at date must fall in an open fiscal period of both the company book and the organization book.
- The cheque’s own status is not checked by this older flow.
- Posts two entries dated on the transferred_at day in the bank journal: in the company book debit the intercompany account with the organization and credit the cheques-received account of the payment route; in the organization book debit the cheques-received-from-company account and credit the intercompany account with the company.
- Creates the cheque transfer in status transferred, with both journal entry identifiers and the actor who made it.
- Marks the payment source as transferred (cheque_transfer_id set).
- When the payment already has a cheque in the cheque workflow, moves its accounting owner and physical holder to the organization, increments its version and records a transferred step in its history.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Response mode. Default none; none answers 204 No Content.
none, resource Comma-separated JSON keys of the root resource (id is always rendered). Available: id, organization_id, company_id, status, source_type, source_id, original_amount, currency_code, currency_exponent, company_amount, company_currency_code, company_currency_exponent, organization_amount, organization_currency_code, organization_currency_exponent, external_reference, transferred_at, transferred_by, transferred_by_type, organization_settled_at, organization_settled_by, organization_settled_by_type, reversed_at, reversed_by, reversed_by_type, company_journal_entry_id, organization_journal_entry_id, company_reversal_journal_entry_id, organization_reversal_journal_entry_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: .
Body
Required. Type of the payment whose cheque is handed over (for example order_payment or customer_credit_payment), up to 100 characters. Together with source_id it must identify a cheque payment of the your company.
100Required. Identifier of the cheque payment (27-character KSUID). A payment can be transferred only once.
27Required. Date and time of the handover (ISO 8601). Its date is the accounting date of the entries and must fall in an open fiscal period of both books.
Optional free reference for the handover, up to 255 characters.
255Response
Resource (only with response=resource).
Identifier of the cheque transfer (27-character KSUID).
Identifier of the organization the record belongs to.
Identifier of the company the record belongs to.
transferred when the transfer is active, reversed after the organization cancelled it.
Type of the transferred payment, for example order_payment or customer_credit_payment.
Identifier of the transferred payment (27-character KSUID).
Amount of the cheque as tendered, in minor units of currency_code.
ISO 4217 code of the currency the cheque was paid in.
Number of decimal places of the currency (0 for XOF). An amount in minor units divided by 10 to this power gives the amount in the currency.
Amount in the company's currency, in minor units of company_currency_code.
ISO 4217 code of the company's currency.
Number of decimal places of the company's currency; divide company_amount by 10 to this power.
Amount in the organization's currency, in minor units of organization_currency_code.
ISO 4217 code of the organization's currency.
Number of decimal places of the organization's currency; divide organization_amount by 10 to this power.
Free reference given at transfer time, for example a handover slip number.
Date and time of the handover (ISO 8601), as sent by the company. Also the accounting date of the transfer entries.
Identifier of the member profile or agent account who made the transfer; null when no actor could be identified.
Kind of actor named in transferred_by (its type alias); null when unknown.
Not set by any current action; always null.
Not set by any current action; always null.
Not set by any current action; always null.
Date and time the organization cancelled the transfer (ISO 8601); null while it is active.
Identifier of the member profile or agent account who cancelled the transfer; null while active.
Kind of actor named in reversed_by; null while active.
Identifier of the entry posted in the company's book when the cheque was handed over.
Identifier of the entry posted in the organization's book when the cheque was handed over.
Identifier of the reversing entry in the company's book; null while the transfer is active.
Identifier of the reversing entry in the organization's book; null while the transfer is active.
Date and time the record was created (ISO 8601, UTC).
Date and time the record was last changed (ISO 8601, UTC).