Charges API
List Charges Table Rows
Returns a page of charges export rows using the requested columns, filters, sorting, and pagination. Downstream finance systems such as NetSuite, Sage, or ERP middleware typically call Get Charges Table Definition first, choose a subset of fields, and then request rows for export, reconciliation, or incremental sync jobs.
Key request fields:
| Input | How downstream systems commonly use it |
|---|---|
table_data_request.requested_columns | Select the Cedar fields to include in each exported row. |
table_data_request.additional_filters | Limit the export to a specific invoice, accounting period, billing type, service type, GL code, customer, or other supported charge dimension. |
table_data_request.sort_columns | Create a stable export order for repeatable batching and reconciliation. |
page_size, page_next_token, page_previous_token | Page through large exports without re-reading the full result set. |
Each row is returned as a column-keyed structure rather than a fixed finance schema, so consumers can request only the columns they actively map into their downstream system.
POST
/
t
/
v1
/
charges-table-rows
List Charges Table Rows
curl --request POST \
--url https://api-lg-k-h1.arms.cedarai.com/t/v1/charges-table-rows \
--header 'Carrier: <carrier>' \
--header 'Content-Type: application/json' \
--header 'x-arms-api-key: <api-key>' \
--header 'x-arms-assume-user: <api-key>' \
--data '
{
"pageNextToken": "<string>",
"pagePreviousToken": "<string>",
"pageSize": 123,
"tableDataRequest": {
"additionalFilters": [
{
"columnKey": "<string>",
"op": "RO_DEFAULT",
"searchTerm": "<string>"
}
],
"pageNextToken": "<string>",
"pagePreviousToken": "<string>",
"pageSize": 123,
"requestedColumns": [
{
"columnKey": "<string>",
"op": "RO_DEFAULT",
"searchTerm": "<string>"
}
],
"sortColumns": [
{
"column": "<string>",
"direction": "ASCENDING"
}
]
}
}
'import requests
url = "https://api-lg-k-h1.arms.cedarai.com/t/v1/charges-table-rows"
payload = {
"pageNextToken": "<string>",
"pagePreviousToken": "<string>",
"pageSize": 123,
"tableDataRequest": {
"additionalFilters": [
{
"columnKey": "<string>",
"op": "RO_DEFAULT",
"searchTerm": "<string>"
}
],
"pageNextToken": "<string>",
"pagePreviousToken": "<string>",
"pageSize": 123,
"requestedColumns": [
{
"columnKey": "<string>",
"op": "RO_DEFAULT",
"searchTerm": "<string>"
}
],
"sortColumns": [
{
"column": "<string>",
"direction": "ASCENDING"
}
]
}
}
headers = {
"Carrier": "<carrier>",
"x-arms-api-key": "<api-key>",
"x-arms-assume-user": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Carrier: '<carrier>',
'x-arms-api-key': '<api-key>',
'x-arms-assume-user': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
pageNextToken: '<string>',
pagePreviousToken: '<string>',
pageSize: 123,
tableDataRequest: {
additionalFilters: [{columnKey: '<string>', op: 'RO_DEFAULT', searchTerm: '<string>'}],
pageNextToken: '<string>',
pagePreviousToken: '<string>',
pageSize: 123,
requestedColumns: [{columnKey: '<string>', op: 'RO_DEFAULT', searchTerm: '<string>'}],
sortColumns: [{column: '<string>', direction: 'ASCENDING'}]
}
})
};
fetch('https://api-lg-k-h1.arms.cedarai.com/t/v1/charges-table-rows', 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-lg-k-h1.arms.cedarai.com/t/v1/charges-table-rows",
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([
'pageNextToken' => '<string>',
'pagePreviousToken' => '<string>',
'pageSize' => 123,
'tableDataRequest' => [
'additionalFilters' => [
[
'columnKey' => '<string>',
'op' => 'RO_DEFAULT',
'searchTerm' => '<string>'
]
],
'pageNextToken' => '<string>',
'pagePreviousToken' => '<string>',
'pageSize' => 123,
'requestedColumns' => [
[
'columnKey' => '<string>',
'op' => 'RO_DEFAULT',
'searchTerm' => '<string>'
]
],
'sortColumns' => [
[
'column' => '<string>',
'direction' => 'ASCENDING'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Carrier: <carrier>",
"Content-Type: application/json",
"x-arms-api-key: <api-key>",
"x-arms-assume-user: <api-key>"
],
]);
$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-lg-k-h1.arms.cedarai.com/t/v1/charges-table-rows"
payload := strings.NewReader("{\n \"pageNextToken\": \"<string>\",\n \"pagePreviousToken\": \"<string>\",\n \"pageSize\": 123,\n \"tableDataRequest\": {\n \"additionalFilters\": [\n {\n \"columnKey\": \"<string>\",\n \"op\": \"RO_DEFAULT\",\n \"searchTerm\": \"<string>\"\n }\n ],\n \"pageNextToken\": \"<string>\",\n \"pagePreviousToken\": \"<string>\",\n \"pageSize\": 123,\n \"requestedColumns\": [\n {\n \"columnKey\": \"<string>\",\n \"op\": \"RO_DEFAULT\",\n \"searchTerm\": \"<string>\"\n }\n ],\n \"sortColumns\": [\n {\n \"column\": \"<string>\",\n \"direction\": \"ASCENDING\"\n }\n ]\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Carrier", "<carrier>")
req.Header.Add("x-arms-api-key", "<api-key>")
req.Header.Add("x-arms-assume-user", "<api-key>")
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-lg-k-h1.arms.cedarai.com/t/v1/charges-table-rows")
.header("Carrier", "<carrier>")
.header("x-arms-api-key", "<api-key>")
.header("x-arms-assume-user", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"pageNextToken\": \"<string>\",\n \"pagePreviousToken\": \"<string>\",\n \"pageSize\": 123,\n \"tableDataRequest\": {\n \"additionalFilters\": [\n {\n \"columnKey\": \"<string>\",\n \"op\": \"RO_DEFAULT\",\n \"searchTerm\": \"<string>\"\n }\n ],\n \"pageNextToken\": \"<string>\",\n \"pagePreviousToken\": \"<string>\",\n \"pageSize\": 123,\n \"requestedColumns\": [\n {\n \"columnKey\": \"<string>\",\n \"op\": \"RO_DEFAULT\",\n \"searchTerm\": \"<string>\"\n }\n ],\n \"sortColumns\": [\n {\n \"column\": \"<string>\",\n \"direction\": \"ASCENDING\"\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-lg-k-h1.arms.cedarai.com/t/v1/charges-table-rows")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Carrier"] = '<carrier>'
request["x-arms-api-key"] = '<api-key>'
request["x-arms-assume-user"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"pageNextToken\": \"<string>\",\n \"pagePreviousToken\": \"<string>\",\n \"pageSize\": 123,\n \"tableDataRequest\": {\n \"additionalFilters\": [\n {\n \"columnKey\": \"<string>\",\n \"op\": \"RO_DEFAULT\",\n \"searchTerm\": \"<string>\"\n }\n ],\n \"pageNextToken\": \"<string>\",\n \"pagePreviousToken\": \"<string>\",\n \"pageSize\": 123,\n \"requestedColumns\": [\n {\n \"columnKey\": \"<string>\",\n \"op\": \"RO_DEFAULT\",\n \"searchTerm\": \"<string>\"\n }\n ],\n \"sortColumns\": [\n {\n \"column\": \"<string>\",\n \"direction\": \"ASCENDING\"\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"nextToken": "<string>",
"prevToken": "<string>",
"rows": [
{
"data": {},
"intKey": "<string>",
"stringKey": "<string>"
}
],
"tableDef": {
"columns": [
{
"aliases": [
"<string>"
],
"description": "<string>",
"enumValues": [
"<string>"
],
"key": "<string>",
"name": "<string>",
"searchable": true,
"type": "STRING"
}
],
"defaultColumns": [
"<string>"
]
}
}{
"code": 123,
"details": [
{
"@type": "<string>"
}
],
"message": "<string>"
}Headers
Carrier ID
Body
application/json
Related topics
Get Charges Table SummaryGet Charges Table DefinitionList railcar charge historyNotesAPI IntroductionWas this page helpful?
⌘I
List Charges Table Rows
curl --request POST \
--url https://api-lg-k-h1.arms.cedarai.com/t/v1/charges-table-rows \
--header 'Carrier: <carrier>' \
--header 'Content-Type: application/json' \
--header 'x-arms-api-key: <api-key>' \
--header 'x-arms-assume-user: <api-key>' \
--data '
{
"pageNextToken": "<string>",
"pagePreviousToken": "<string>",
"pageSize": 123,
"tableDataRequest": {
"additionalFilters": [
{
"columnKey": "<string>",
"op": "RO_DEFAULT",
"searchTerm": "<string>"
}
],
"pageNextToken": "<string>",
"pagePreviousToken": "<string>",
"pageSize": 123,
"requestedColumns": [
{
"columnKey": "<string>",
"op": "RO_DEFAULT",
"searchTerm": "<string>"
}
],
"sortColumns": [
{
"column": "<string>",
"direction": "ASCENDING"
}
]
}
}
'import requests
url = "https://api-lg-k-h1.arms.cedarai.com/t/v1/charges-table-rows"
payload = {
"pageNextToken": "<string>",
"pagePreviousToken": "<string>",
"pageSize": 123,
"tableDataRequest": {
"additionalFilters": [
{
"columnKey": "<string>",
"op": "RO_DEFAULT",
"searchTerm": "<string>"
}
],
"pageNextToken": "<string>",
"pagePreviousToken": "<string>",
"pageSize": 123,
"requestedColumns": [
{
"columnKey": "<string>",
"op": "RO_DEFAULT",
"searchTerm": "<string>"
}
],
"sortColumns": [
{
"column": "<string>",
"direction": "ASCENDING"
}
]
}
}
headers = {
"Carrier": "<carrier>",
"x-arms-api-key": "<api-key>",
"x-arms-assume-user": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Carrier: '<carrier>',
'x-arms-api-key': '<api-key>',
'x-arms-assume-user': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
pageNextToken: '<string>',
pagePreviousToken: '<string>',
pageSize: 123,
tableDataRequest: {
additionalFilters: [{columnKey: '<string>', op: 'RO_DEFAULT', searchTerm: '<string>'}],
pageNextToken: '<string>',
pagePreviousToken: '<string>',
pageSize: 123,
requestedColumns: [{columnKey: '<string>', op: 'RO_DEFAULT', searchTerm: '<string>'}],
sortColumns: [{column: '<string>', direction: 'ASCENDING'}]
}
})
};
fetch('https://api-lg-k-h1.arms.cedarai.com/t/v1/charges-table-rows', 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-lg-k-h1.arms.cedarai.com/t/v1/charges-table-rows",
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([
'pageNextToken' => '<string>',
'pagePreviousToken' => '<string>',
'pageSize' => 123,
'tableDataRequest' => [
'additionalFilters' => [
[
'columnKey' => '<string>',
'op' => 'RO_DEFAULT',
'searchTerm' => '<string>'
]
],
'pageNextToken' => '<string>',
'pagePreviousToken' => '<string>',
'pageSize' => 123,
'requestedColumns' => [
[
'columnKey' => '<string>',
'op' => 'RO_DEFAULT',
'searchTerm' => '<string>'
]
],
'sortColumns' => [
[
'column' => '<string>',
'direction' => 'ASCENDING'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Carrier: <carrier>",
"Content-Type: application/json",
"x-arms-api-key: <api-key>",
"x-arms-assume-user: <api-key>"
],
]);
$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-lg-k-h1.arms.cedarai.com/t/v1/charges-table-rows"
payload := strings.NewReader("{\n \"pageNextToken\": \"<string>\",\n \"pagePreviousToken\": \"<string>\",\n \"pageSize\": 123,\n \"tableDataRequest\": {\n \"additionalFilters\": [\n {\n \"columnKey\": \"<string>\",\n \"op\": \"RO_DEFAULT\",\n \"searchTerm\": \"<string>\"\n }\n ],\n \"pageNextToken\": \"<string>\",\n \"pagePreviousToken\": \"<string>\",\n \"pageSize\": 123,\n \"requestedColumns\": [\n {\n \"columnKey\": \"<string>\",\n \"op\": \"RO_DEFAULT\",\n \"searchTerm\": \"<string>\"\n }\n ],\n \"sortColumns\": [\n {\n \"column\": \"<string>\",\n \"direction\": \"ASCENDING\"\n }\n ]\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Carrier", "<carrier>")
req.Header.Add("x-arms-api-key", "<api-key>")
req.Header.Add("x-arms-assume-user", "<api-key>")
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-lg-k-h1.arms.cedarai.com/t/v1/charges-table-rows")
.header("Carrier", "<carrier>")
.header("x-arms-api-key", "<api-key>")
.header("x-arms-assume-user", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"pageNextToken\": \"<string>\",\n \"pagePreviousToken\": \"<string>\",\n \"pageSize\": 123,\n \"tableDataRequest\": {\n \"additionalFilters\": [\n {\n \"columnKey\": \"<string>\",\n \"op\": \"RO_DEFAULT\",\n \"searchTerm\": \"<string>\"\n }\n ],\n \"pageNextToken\": \"<string>\",\n \"pagePreviousToken\": \"<string>\",\n \"pageSize\": 123,\n \"requestedColumns\": [\n {\n \"columnKey\": \"<string>\",\n \"op\": \"RO_DEFAULT\",\n \"searchTerm\": \"<string>\"\n }\n ],\n \"sortColumns\": [\n {\n \"column\": \"<string>\",\n \"direction\": \"ASCENDING\"\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-lg-k-h1.arms.cedarai.com/t/v1/charges-table-rows")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Carrier"] = '<carrier>'
request["x-arms-api-key"] = '<api-key>'
request["x-arms-assume-user"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"pageNextToken\": \"<string>\",\n \"pagePreviousToken\": \"<string>\",\n \"pageSize\": 123,\n \"tableDataRequest\": {\n \"additionalFilters\": [\n {\n \"columnKey\": \"<string>\",\n \"op\": \"RO_DEFAULT\",\n \"searchTerm\": \"<string>\"\n }\n ],\n \"pageNextToken\": \"<string>\",\n \"pagePreviousToken\": \"<string>\",\n \"pageSize\": 123,\n \"requestedColumns\": [\n {\n \"columnKey\": \"<string>\",\n \"op\": \"RO_DEFAULT\",\n \"searchTerm\": \"<string>\"\n }\n ],\n \"sortColumns\": [\n {\n \"column\": \"<string>\",\n \"direction\": \"ASCENDING\"\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"nextToken": "<string>",
"prevToken": "<string>",
"rows": [
{
"data": {},
"intKey": "<string>",
"stringKey": "<string>"
}
],
"tableDef": {
"columns": [
{
"aliases": [
"<string>"
],
"description": "<string>",
"enumValues": [
"<string>"
],
"key": "<string>",
"name": "<string>",
"searchable": true,
"type": "STRING"
}
],
"defaultColumns": [
"<string>"
]
}
}{
"code": 123,
"details": [
{
"@type": "<string>"
}
],
"message": "<string>"
}