> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cedarai.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Charges Table Definition

> Returns the available charges export columns and default columns. Downstream finance systems such as NetSuite, Sage, or ERP middleware can use this metadata to map Cedar fields before requesting charge rows.

This response is metadata only: it tells consumers which columns are available, how Cedar labels them, which columns are searchable, and which columns Cedar returns by default.

Common export-oriented columns:

| Column | Meaning for downstream systems |
| --- | --- |
| `chargeId` | Stable Cedar charge identifier for reconciliation, upserts, or idempotent imports. |
| `customerLocationAccountNumber` | Customer location account number often used to map a charge into an external account or business unit. |
| `invoice` | Invoice number or sequence used to group already-invoiced charges. |
| `accountingPeriod` | Cedar accounting period label that can be used for period-close exports or batching. |
| `billingType` | High-level charge category such as storage, demurrage, switching, or ISS shipment. |
| `serviceType` | Service-specific classification that can help downstream mapping rules route charges to the right workflow. |
| `glCode` | General ledger code used for financial posting and account mapping. |
| `rateTableEntry` / `rateDescription` | Human-readable pricing fields that explain why the amount was calculated. |
| `adjustment_total` | Net difference between the original amount and the final adjusted amount. |

The response example below shows a representative subset of these columns.



## OpenAPI

````yaml /user-docs/api-reference/charge.swagger.json get /t/v1/charges-table-def
openapi: 3.0.1
info:
  title: protobuf/arms/charge.proto
  version: version not set
servers:
  - description: Production (US)
    url: https://api-lg-k-h1.arms.cedarai.com
  - description: Production (EU)
    url: https://api-lg-k-h1.arms.cedarai.se
security:
  - ApiKeyAuth: []
    AssumeUserAuth: []
tags:
  - name: ChargeService
paths:
  /t/v1/charges-table-def:
    get:
      tags:
        - ChargeService
      summary: Get Charges Table Definition
      description: >-
        Returns the available charges export columns and default columns.
        Downstream finance systems such as NetSuite, Sage, or ERP middleware can
        use this metadata to map Cedar fields before requesting charge rows.


        This response is metadata only: it tells consumers which columns are
        available, how Cedar labels them, which columns are searchable, and
        which columns Cedar returns by default.


        Common export-oriented columns:


        | Column | Meaning for downstream systems |

        | --- | --- |

        | `chargeId` | Stable Cedar charge identifier for reconciliation,
        upserts, or idempotent imports. |

        | `customerLocationAccountNumber` | Customer location account number
        often used to map a charge into an external account or business unit. |

        | `invoice` | Invoice number or sequence used to group already-invoiced
        charges. |

        | `accountingPeriod` | Cedar accounting period label that can be used
        for period-close exports or batching. |

        | `billingType` | High-level charge category such as storage, demurrage,
        switching, or ISS shipment. |

        | `serviceType` | Service-specific classification that can help
        downstream mapping rules route charges to the right workflow. |

        | `glCode` | General ledger code used for financial posting and account
        mapping. |

        | `rateTableEntry` / `rateDescription` | Human-readable pricing fields
        that explain why the amount was calculated. |

        | `adjustment_total` | Net difference between the original amount and
        the final adjusted amount. |


        The response example below shows a representative subset of these
        columns.
      operationId: ListChargesTableDef
      parameters:
        - description: Carrier ID
          in: header
          name: Carrier
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              example:
                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
              schema:
                $ref: '#/components/schemas/armsTableDef'
          description: A successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rpcStatus'
          description: An unexpected error response.
components:
  schemas:
    armsTableDef:
      properties:
        columns:
          items:
            $ref: '#/components/schemas/armsColumnDef'
          type: array
        defaultColumns:
          items:
            type: string
          type: array
      type: object
    rpcStatus:
      properties:
        code:
          format: int32
          type: integer
        details:
          items:
            $ref: '#/components/schemas/protobufAny'
          type: array
        message:
          type: string
      type: object
    armsColumnDef:
      properties:
        description:
          type: string
        enumValues:
          items:
            type: string
          type: array
        key:
          type: string
        name:
          type: string
        searchable:
          type: boolean
        type:
          $ref: '#/components/schemas/armsColumnDataType'
      type: object
    protobufAny:
      additionalProperties:
        type: object
      properties:
        '@type':
          type: string
      type: object
    armsColumnDataType:
      default: STRING
      enum:
        - STRING
        - INT
        - REAL
        - TIMESTAMP
        - DECIMAL
      type: string
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: x-arms-api-key
      type: apiKey
    AssumeUserAuth:
      in: header
      name: x-arms-assume-user
      type: apiKey

````