# `Incoterm`

A rule of ICC's Incoterms 2020, written as its code, `FOB`. The rules earlier editions had, `DAT`, are only read.

[Commerce and logistics](types.md#commerce-and-logistics); not ordered; since Jadpo 0.1.0.

## Make one

Pick one of its variants, `Incoterm.cfr`.

`text.parse(raw, as: Incoterm)` reads one from its text; text that isn't one at all fails `malformed`, such as `F.O.B.`, `FOB 2020` or `FO`.

## Variants

| Variant | Written |
|---|---|
| `cfr` | `CFR` |
| `cif` | `CIF` |
| `cip` | `CIP` |
| `cpt` | `CPT` |
| `daf` | `DAF` |
| `dap` | `DAP` |
| `dat` | `DAT` |
| `ddp` | `DDP` |
| `ddu` | `DDU` |
| `deq` | `DEQ` |
| `des` | `DES` |
| `dpu` | `DPU` |
| `exw` | `EXW` |
| `fas` | `FAS` |
| `fca` | `FCA` |
| `fob` | `FOB` |

## Text, JSON and storage

`text.from` writes its canonical text, the one form `text.parse` reads back. JSON sends its canonical text as a string.

| Text | JSON |
|---|---|
| `DAT` | `"DAT"` |
| `EXW` | `"EXW"` |
| `FOB` | `"FOB"` |

It is stored in one column named for the field, of type `text`. `EXW` is stored as `'EXW'`.

## Shown to people

`text.format(value, locale:)` shows it to people in their locale.

With `locale: Locale.en_gb`:

| Value | Shown |
|---|---|
| `DAT` | `DAT` |
| `EXW` | `EXW` |
| `FOB` | `FOB` |

## Operations

It has the contract's own operations: `text.parse`, `text.from`, `text.format`, `json.read`, `json.write` and `==`. It isn't ordered, so `<` and sorting don't take it. [Every standard type meets one contract](../topics/every-standard-type-meets-one-contract.md) says how they work.