# `Incoterm`

A rule saying who pays for what in international shipping: `FOB`, `DDP` and so on.

Use it on a trade deal or a shipping order. These are the Incoterms 2020 rules.

## Shape

One of these 16 values:

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

## Example

```jadpo
Incoterm.fob
```

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

## Good to know

- Earlier rules such as `DAT` are still read from old data, so don't write new ones.
- `==` tells you whether two are the same. `<` and `list.sort_by` don't take it.

## In JSON

A string, in a request, a response or `json.write`:

```json
"DAT"
"EXW"
"FOB"
```

## Details

<details>
<summary>Text form, storage, how it is shown, and operations</summary>

`Incoterm` is in the group Commerce and logistics, and has been in Jadpo since 0.1.0.

### Text form

`text.from` writes one standard text form, the same form `text.parse` reads back: `DAT`, `EXW` and `FOB`.

### How it is stored

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

### How it is 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 also takes `text.parse`, `text.from`, `text.format`, `json.read`, `json.write` and `==`. [How every standard type behaves](/docs/every-standard-type-meets-one-contract.md) says how they work.

</details>