curl --request POST \
--url https://api.example.com/api/banking/categorize \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--header 'organization-id: <organization-id>' \
--data '
{
"date": "2023-01-01T00:00:00.000Z",
"creditAccountId": 1001,
"transactionType": "deposit",
"uncategorizedTransactionIds": [
1001,
1002,
1003
],
"referenceNo": "REF-001",
"transactionNumber": "TRX-001",
"exchangeRate": 1.15,
"currencyCode": "USD",
"description": "Monthly rent payment",
"branchId": 101
}
'import requests
url = "https://api.example.com/api/banking/categorize"
payload = {
"date": "2023-01-01T00:00:00.000Z",
"creditAccountId": 1001,
"transactionType": "deposit",
"uncategorizedTransactionIds": [1001, 1002, 1003],
"referenceNo": "REF-001",
"transactionNumber": "TRX-001",
"exchangeRate": 1.15,
"currencyCode": "USD",
"description": "Monthly rent payment",
"branchId": 101
}
headers = {
"Authorization": "<authorization>",
"organization-id": "<organization-id>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: '<authorization>',
'organization-id': '<organization-id>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
date: '2023-01-01T00:00:00.000Z',
creditAccountId: 1001,
transactionType: 'deposit',
uncategorizedTransactionIds: [1001, 1002, 1003],
referenceNo: 'REF-001',
transactionNumber: 'TRX-001',
exchangeRate: 1.15,
currencyCode: 'USD',
description: 'Monthly rent payment',
branchId: 101
})
};
fetch('https://api.example.com/api/banking/categorize', 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.example.com/api/banking/categorize",
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([
'date' => '2023-01-01T00:00:00.000Z',
'creditAccountId' => 1001,
'transactionType' => 'deposit',
'uncategorizedTransactionIds' => [
1001,
1002,
1003
],
'referenceNo' => 'REF-001',
'transactionNumber' => 'TRX-001',
'exchangeRate' => 1.15,
'currencyCode' => 'USD',
'description' => 'Monthly rent payment',
'branchId' => 101
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: application/json",
"organization-id: <organization-id>"
],
]);
$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.example.com/api/banking/categorize"
payload := strings.NewReader("{\n \"date\": \"2023-01-01T00:00:00.000Z\",\n \"creditAccountId\": 1001,\n \"transactionType\": \"deposit\",\n \"uncategorizedTransactionIds\": [\n 1001,\n 1002,\n 1003\n ],\n \"referenceNo\": \"REF-001\",\n \"transactionNumber\": \"TRX-001\",\n \"exchangeRate\": 1.15,\n \"currencyCode\": \"USD\",\n \"description\": \"Monthly rent payment\",\n \"branchId\": 101\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("organization-id", "<organization-id>")
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.example.com/api/banking/categorize")
.header("Authorization", "<authorization>")
.header("organization-id", "<organization-id>")
.header("Content-Type", "application/json")
.body("{\n \"date\": \"2023-01-01T00:00:00.000Z\",\n \"creditAccountId\": 1001,\n \"transactionType\": \"deposit\",\n \"uncategorizedTransactionIds\": [\n 1001,\n 1002,\n 1003\n ],\n \"referenceNo\": \"REF-001\",\n \"transactionNumber\": \"TRX-001\",\n \"exchangeRate\": 1.15,\n \"currencyCode\": \"USD\",\n \"description\": \"Monthly rent payment\",\n \"branchId\": 101\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/banking/categorize")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["organization-id"] = '<organization-id>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"date\": \"2023-01-01T00:00:00.000Z\",\n \"creditAccountId\": 1001,\n \"transactionType\": \"deposit\",\n \"uncategorizedTransactionIds\": [\n 1001,\n 1002,\n 1003\n ],\n \"referenceNo\": \"REF-001\",\n \"transactionNumber\": \"TRX-001\",\n \"exchangeRate\": 1.15,\n \"currencyCode\": \"USD\",\n \"description\": \"Monthly rent payment\",\n \"branchId\": 101\n}"
response = http.request(request)
puts response.read_bodyCategorize bank transactions.
curl --request POST \
--url https://api.example.com/api/banking/categorize \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--header 'organization-id: <organization-id>' \
--data '
{
"date": "2023-01-01T00:00:00.000Z",
"creditAccountId": 1001,
"transactionType": "deposit",
"uncategorizedTransactionIds": [
1001,
1002,
1003
],
"referenceNo": "REF-001",
"transactionNumber": "TRX-001",
"exchangeRate": 1.15,
"currencyCode": "USD",
"description": "Monthly rent payment",
"branchId": 101
}
'import requests
url = "https://api.example.com/api/banking/categorize"
payload = {
"date": "2023-01-01T00:00:00.000Z",
"creditAccountId": 1001,
"transactionType": "deposit",
"uncategorizedTransactionIds": [1001, 1002, 1003],
"referenceNo": "REF-001",
"transactionNumber": "TRX-001",
"exchangeRate": 1.15,
"currencyCode": "USD",
"description": "Monthly rent payment",
"branchId": 101
}
headers = {
"Authorization": "<authorization>",
"organization-id": "<organization-id>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: '<authorization>',
'organization-id': '<organization-id>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
date: '2023-01-01T00:00:00.000Z',
creditAccountId: 1001,
transactionType: 'deposit',
uncategorizedTransactionIds: [1001, 1002, 1003],
referenceNo: 'REF-001',
transactionNumber: 'TRX-001',
exchangeRate: 1.15,
currencyCode: 'USD',
description: 'Monthly rent payment',
branchId: 101
})
};
fetch('https://api.example.com/api/banking/categorize', 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.example.com/api/banking/categorize",
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([
'date' => '2023-01-01T00:00:00.000Z',
'creditAccountId' => 1001,
'transactionType' => 'deposit',
'uncategorizedTransactionIds' => [
1001,
1002,
1003
],
'referenceNo' => 'REF-001',
'transactionNumber' => 'TRX-001',
'exchangeRate' => 1.15,
'currencyCode' => 'USD',
'description' => 'Monthly rent payment',
'branchId' => 101
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: application/json",
"organization-id: <organization-id>"
],
]);
$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.example.com/api/banking/categorize"
payload := strings.NewReader("{\n \"date\": \"2023-01-01T00:00:00.000Z\",\n \"creditAccountId\": 1001,\n \"transactionType\": \"deposit\",\n \"uncategorizedTransactionIds\": [\n 1001,\n 1002,\n 1003\n ],\n \"referenceNo\": \"REF-001\",\n \"transactionNumber\": \"TRX-001\",\n \"exchangeRate\": 1.15,\n \"currencyCode\": \"USD\",\n \"description\": \"Monthly rent payment\",\n \"branchId\": 101\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("organization-id", "<organization-id>")
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.example.com/api/banking/categorize")
.header("Authorization", "<authorization>")
.header("organization-id", "<organization-id>")
.header("Content-Type", "application/json")
.body("{\n \"date\": \"2023-01-01T00:00:00.000Z\",\n \"creditAccountId\": 1001,\n \"transactionType\": \"deposit\",\n \"uncategorizedTransactionIds\": [\n 1001,\n 1002,\n 1003\n ],\n \"referenceNo\": \"REF-001\",\n \"transactionNumber\": \"TRX-001\",\n \"exchangeRate\": 1.15,\n \"currencyCode\": \"USD\",\n \"description\": \"Monthly rent payment\",\n \"branchId\": 101\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/banking/categorize")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["organization-id"] = '<organization-id>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"date\": \"2023-01-01T00:00:00.000Z\",\n \"creditAccountId\": 1001,\n \"transactionType\": \"deposit\",\n \"uncategorizedTransactionIds\": [\n 1001,\n 1002,\n 1003\n ],\n \"referenceNo\": \"REF-001\",\n \"transactionNumber\": \"TRX-001\",\n \"exchangeRate\": 1.15,\n \"currencyCode\": \"USD\",\n \"description\": \"Monthly rent payment\",\n \"branchId\": 101\n}"
response = http.request(request)
puts response.read_bodyHeaders
Value must be 'Bearer ' where is an API key prefixed with 'bc_' or a JWT token.
"Bearer bc_1234567890abcdef"
Required if Authorization is a JWT token. The organization ID to operate within.
Body
The date of the bank transaction
"2023-01-01T00:00:00.000Z"
ID of the credit account associated with this transaction
1001
Type of bank transaction (e.g., deposit, withdrawal)
"deposit"
Array of uncategorized transaction IDs to be categorized
[1001, 1002, 1003]
Optional external reference number
"REF-001"
Optional transaction number or reference
"TRX-001"
Exchange rate for currency conversion
1.15
Currency code for the transaction
"USD"
Description of the bank transaction
"Monthly rent payment"
ID of the branch where the transaction occurred
101
Response
The bank transactions have been categorized successfully.