Skip to main content
GET
/
t
/
v1
/
charges-table-def
Get Charges Table Definition
curl --request GET \
  --url https://api-lg-k-h1.arms.cedarai.com/t/v1/charges-table-def \
  --header 'Carrier: <carrier>' \
  --header 'x-arms-api-key: <api-key>' \
  --header 'x-arms-assume-user: <api-key>'
{
  "columns": [
    {
      "key": "chargeId",
      "name": "Charge ID",
      "searchable": true,
      "type": "INT"
    },
    {
      "key": "customer",
      "name": "Customer",
      "searchable": true,
      "type": "STRING"
    },
    {
      "key": "customerLocation",
      "name": "Customer Location",
      "searchable": true,
      "type": "STRING"
    },
    {
      "key": "customerLocationAccountNumber",
      "name": "Customer Location Account #",
      "searchable": true,
      "type": "STRING"
    },
    {
      "key": "invoice",
      "name": "Invoice",
      "searchable": true,
      "type": "STRING"
    },
    {
      "key": "accountingPeriod",
      "name": "Accounting Period",
      "searchable": true,
      "type": "STRING"
    },
    {
      "enumValues": [
        "STORAGE",
        "DEMURRAGE",
        "SWITCHING",
        "JUNCTION SETTLEMENT",
        "NON-RAILROAD CHARGE",
        "TRACKAGE",
        "EXCESS",
        "MISC.",
        "ISS SHIPMENT"
      ],
      "key": "billingType",
      "name": "Billing Type",
      "searchable": true,
      "type": "STRING"
    },
    {
      "enumValues": [
        "IN_PROGRESS",
        "PENDING",
        "ASSIGNED",
        "INVOICED",
        "ARCHIVED",
        "DELETED",
        "RESET",
        "VOID"
      ],
      "key": "billingStatus",
      "name": "Billing Status",
      "searchable": true,
      "type": "STRING"
    },
    {
      "key": "amount",
      "name": "Amount",
      "searchable": true,
      "type": "REAL"
    },
    {
      "key": "appliedAt",
      "name": "Applied At",
      "searchable": true,
      "type": "TIMESTAMP"
    },
    {
      "key": "serviceType",
      "name": "Service Type",
      "searchable": true,
      "type": "STRING"
    },
    {
      "key": "glCode",
      "name": "GL Code",
      "searchable": true,
      "type": "STRING"
    },
    {
      "key": "rateTableEntry",
      "name": "Rate Table Entry",
      "searchable": true,
      "type": "STRING"
    },
    {
      "key": "rateDescription",
      "name": "Rate Description",
      "searchable": true,
      "type": "STRING"
    },
    {
      "key": "adjustment_total",
      "name": "Adjustment Total",
      "searchable": true,
      "type": "REAL"
    }
  ],
  "defaultColumns": [
    "chargeId",
    "customer",
    "customerLocation",
    "billingStatus",
    "amount",
    "appliedAt",
    "invoice",
    "billingType",
    "serviceType",
    "glCode",
    "rateTableEntry"
  ]
}

Authorizations

x-arms-api-key
string
header
required
x-arms-assume-user
string
header
required

Headers

Carrier
string
required

Carrier ID

Response

A successful response.

columns
object[]
defaultColumns
string[]