Customers¶
A Customer is the account CDMS bills and authorizes — the shipping line's agent, a BCO (beneficial cargo owner), an NVO, a transporter, or an internal account. Nearly every operational action in the depot (gate-in, invoicing, work orders) ultimately resolves to a customer record, because charges, credit limits, and shipping-line authorization all live here.
Before you start¶
- No hard prerequisites to create a Customer record itself.
- To make a customer usable for gate operations or billing, you will also need at least one Shipping Line to authorize them for, and a published Tariff Profile if you want charges to resolve correctly.
Walkthrough¶
Customers list¶
- Open Customers from the Commerce section of the sidebar.
- Filter by Name / Code, Account Type (SL Agent, BCO, NVO, Transporter, Internal), or Status (Active/Inactive) using the filter bar; sort by Code, Name, Account Type, or Created date.
- Click Add Customer to open the creation drawer.
- The table shows Code, Name, Type, SLA tier (Standard/Priority/Premium), Credit Limit, and Status. Click a customer's Code to open their detail page.
Customer detail page¶
Every customer has eight tabs. Each is a distinct area of the account:
| Tab | Purpose |
|---|---|
| Profile | Core identity fields — Name, Account Type, SLA Tier, Credit Limit, Payment Terms (days), Active flag — plus an account-balance summary card and any custom meta fields. |
| Billing Details | Legal/tax identity (Legal Name, Tax ID, Tax Regime), billing address, billing contact, invoice CC emails, and invoice delivery preferences (method, format, PO reference, notes). |
| Billing Cycles | The recurring schedule(s) CDMS uses to auto-generate invoices for this customer — cycle type, cutoff day, invoice/due date offsets, proforma and auto-dispatch flags. |
| Shipping Lines | The canonical place to authorize this customer for a shipping line, with an optional per-line tariff override. See Customer ↔ Shipping-Line Authorization for the full walkthrough — this is the most important tab on this page. |
| Tariff | Assigns which Tariff Profile this customer's charges resolve against (or "use default profile"). |
| Statement | A running ledger (invoices/payments) with a date-range filter, balance summary, and a Download PDF button. |
| History | Placeholder — gate pass and order history for this customer are not yet wired into this tab. |
| Documents | Standard document upload/attachment area. |
Profile tab in detail:
- Basic Details card: Name *, Account Type * (select: Shipping Line Agent, BCO, NVO, Transporter, Internal), SLA Tier (select: Standard, Priority, Premium), and an Active checkbox.
- Billing card: Credit Limit and Payment Terms (days) numeric fields.
- A balance card at the top shows Outstanding, Overdue (if any — flagged in red with a warning), and Total Invoiced.
Billing Cycles tab: click Add Cycle to open a drawer selecting Cycle Type * (Daily, Weekly, Fortnightly, Monthly), a cutoff (Cutoff Day for monthly, Cutoff Weekday for weekly/fortnightly), Invoice Date Offset (days), Due Date Offset (days), and Proforma required / Auto-dispatch checkboxes.
Note
Billing cycles are what make automatic invoice generation possible for a customer — without at least one configured, invoices for this customer must be run manually. See Invoices.
Related pages¶
- Customer ↔ Shipping-Line Authorization — the deep dive on the Shipping Lines tab
- Shipping Lines
- Tariffs
- Invoices
- Payments
- Customer portal
Who can access this¶
- Admin: full read/write across every tab.
- Manager: read/write on customer records.
- Billing: read/write, plus access to the Billing Details tab specifically.
- Viewer: read-only.
- Gate Operator, Yard Operator: no access — Commerce is outside their role.