Hoppa till innehållet

API och integrationer Referens Referensdata

English

Referensdata

Read-only reference data: the valid codes for warehouses, currencies, payment/delivery terms, order types and shipping methods used in other requests.

10 anrop GET Bas-URL https://api.fluit.cloud/preview

Autentisering, felkoder, rate limits, idempotens och paginering gäller alla anrop och står samlade under Kom igång.

GET /reference/currencies

List currencies

Returns all configured currencies. Use the code field as currencyCode in order creation. Reference lists are bounded configuration data and are returned unpaginated. Responses carry a weak ETag; pass it back in If-None-Match to get 304 Not Modified while the list is unchanged.

reference:read Stödjer ETag

Svar

200 PublicCurrencyResponse[]
  • ETag — Weak validator for this representation. Pass it back in If-None-Match to get 304 Not Modified while the record is unchanged.
Fält Typ Beskrivning
code string · nullable ISO 4217 currency code, e.g. `SEK`, `EUR`.
decimalPlaces integer Number of decimal places used when displaying amounts in this currency.
exchangeRate decimal Exchange rate relative to the tenant base currency. Serialised as a decimal string.
isBase boolean Whether this is the tenant's base / accounting currency.
name string · nullable Display name of the currency, e.g. `Swedish Krona`.
symbol string · nullable Currency symbol, e.g. `kr`, `€`. Null if not configured.
304 Tom body.
  • ETag — Weak validator for this representation. Pass it back in If-None-Match to get 304 Not Modified while the record is unchanged.

Standardfel: 401 403 Felhantering

Exempel

curl 
curl "https://api.fluit.cloud/preview/reference/currencies"
Svar 200 
[
  {
    "code": "string",
    "decimalPlaces": 2,
    "exchangeRate": "299.00",
    "isBase": true,
    "name": "Acme AB",
    "symbol": "string"
  }
]

Bas-URL https://api.fluit.cloud/preview. Svarsexemplet är genererat ur schemat: formen stämmer, värdena är påhittade.

GET /reference/delivery-terms

List delivery terms

Returns all delivery terms available for use as deliveryTermCode in order creation. Reference lists are bounded configuration data and are returned unpaginated. Responses carry a weak ETag; pass it back in If-None-Match to get 304 Not Modified while the list is unchanged.

reference:read Stödjer ETag

Svar

200 PublicDeliveryTermResponse[]
  • ETag — Weak validator for this representation. Pass it back in If-None-Match to get 304 Not Modified while the record is unchanged.
Fält Typ Beskrivning
code string · nullable Unique code used as `deliveryTermCode` in order creation, e.g. `DAP`.
isDefaultSales boolean Whether this is the default delivery term for new sales orders.
name string · nullable Display name of the delivery term.
304 Tom body.
  • ETag — Weak validator for this representation. Pass it back in If-None-Match to get 304 Not Modified while the record is unchanged.

Standardfel: 401 403 Felhantering

Exempel

curl 
curl "https://api.fluit.cloud/preview/reference/delivery-terms"
Svar 200 
[
  {
    "code": "string",
    "isDefaultSales": true,
    "name": "DAP Stockholm"
  }
]

Bas-URL https://api.fluit.cloud/preview. Svarsexemplet är genererat ur schemat: formen stämmer, värdena är påhittade.

GET /reference/order-types

List order types

Returns all order types available for use as orderTypeCode in order creation. Reference lists are bounded configuration data and are returned unpaginated. Responses carry a weak ETag; pass it back in If-None-Match to get 304 Not Modified while the list is unchanged.

reference:read Stödjer ETag

Svar

200 PublicOrderTypeResponse[]
  • ETag — Weak validator for this representation. Pass it back in If-None-Match to get 304 Not Modified while the record is unchanged.
Fält Typ Beskrivning
code string · nullable Unique code used as `orderTypeCode` in order creation.
isDefault boolean Whether this is the tenant's default order type.
name string · nullable Display name of the order type.
304 Tom body.
  • ETag — Weak validator for this representation. Pass it back in If-None-Match to get 304 Not Modified while the record is unchanged.

Standardfel: 401 403 Felhantering

Exempel

curl 
curl "https://api.fluit.cloud/preview/reference/order-types"
Svar 200 
[
  {
    "code": "string",
    "isDefault": true,
    "name": "Acme AB"
  }
]

Bas-URL https://api.fluit.cloud/preview. Svarsexemplet är genererat ur schemat: formen stämmer, värdena är påhittade.

GET /reference/payment-terms

List payment terms

Returns all payment terms available for use as paymentTermCode in order creation. Reference lists are bounded configuration data and are returned unpaginated. Responses carry a weak ETag; pass it back in If-None-Match to get 304 Not Modified while the list is unchanged.

reference:read Stödjer ETag

Svar

200 PublicPaymentTermResponse[]
  • ETag — Weak validator for this representation. Pass it back in If-None-Match to get 304 Not Modified while the record is unchanged.
Fält Typ Beskrivning
code string · nullable Unique code used as `paymentTermCode` in order creation.
days integer · nullable Number of net payment days. Null if not applicable.
isDefaultSales boolean Whether this is the default payment term for new sales orders.
name string · nullable Display name of the payment term.
304 Tom body.
  • ETag — Weak validator for this representation. Pass it back in If-None-Match to get 304 Not Modified while the record is unchanged.

Standardfel: 401 403 Felhantering

Exempel

curl 
curl "https://api.fluit.cloud/preview/reference/payment-terms"
Svar 200 
[
  {
    "code": "string",
    "days": 42,
    "isDefaultSales": true,
    "name": "30 days net"
  }
]

Bas-URL https://api.fluit.cloud/preview. Svarsexemplet är genererat ur schemat: formen stämmer, värdena är påhittade.

GET /reference/shipping-methods

List shipping methods

Returns shipping methods that have a code and can be referenced via shippingMethodCode in order creation. Reference lists are bounded configuration data and are returned unpaginated. Responses carry a weak ETag; pass it back in If-None-Match to get 304 Not Modified while the list is unchanged.

reference:read Stödjer ETag

Svar

200 PublicShippingMethodResponse[]
  • ETag — Weak validator for this representation. Pass it back in If-None-Match to get 304 Not Modified while the record is unchanged.
Fält Typ Beskrivning
code string · nullable Unique code used as `shippingMethodCode` in order creation.
name string · nullable Display name of the shipping method.
304 Tom body.
  • ETag — Weak validator for this representation. Pass it back in If-None-Match to get 304 Not Modified while the record is unchanged.

Standardfel: 401 403 Felhantering

Exempel

curl 
curl "https://api.fluit.cloud/preview/reference/shipping-methods"
Svar 200 
[
  {
    "code": "string",
    "name": "Parcel, next day"
  }
]

Bas-URL https://api.fluit.cloud/preview. Svarsexemplet är genererat ur schemat: formen stämmer, värdena är påhittade.

GET /reference/tax-classes

List VAT classes

Returns the tenant's VAT classes together with the rate in effect today. An item carries only taxClassCode — join it against this list to get the rate. The rate depends on tax class, country and date, so it is not a property of the item. rate is null for a class with no rate configured in that country.

Visa hela beskrivningen

Reference lists are bounded configuration data and are returned unpaginated. Responses carry a weak ETag; pass it back in If-None-Match to get 304 Not Modified while the list is unchanged.

reference:read Stödjer ETag

Frågeparametrar

Fält Typ Beskrivning
countryCode string Returns the rates in effect in this country (ISO 3166-1 alpha-2), for example when invoicing cross-border. Defaults to the tenant's own country.

Svar

200 PublicTaxClassResponse[]
  • ETag — Weak validator for this representation. Pass it back in If-None-Match to get 304 Not Modified while the record is unchanged.
Fält Typ Beskrivning
code string · nullable Stable tax class code, e.g. `STANDARD`. This is the value on an item's `taxClassCode`.
countryCode string · nullable ISO 3166-1 alpha-2 country the rate below applies to.
isDefault boolean Whether this is the tenant default for new items.
name string · nullable Display name, e.g. `Standard 25%`.
rate decimal · nullable VAT rate in percent, e.g. `25.00`. Serialised as a decimal string. Null if no rate is configured for this class in the requested country.
taxCode string · nullable Accounting tax code for the rate, e.g. `MP1`. Null if no rate applies.
validFrom string(date) · nullable Date the rate took effect (inclusive). Null if no rate applies.
validTo string(date) · nullable Date the rate stops applying (exclusive). Null if open-ended or if no rate applies.
304 Tom body.
  • ETag — Weak validator for this representation. Pass it back in If-None-Match to get 304 Not Modified while the record is unchanged.
400 ProblemDetails countryCode is not a valid ISO 3166-1 alpha-2 country code.
Fält Typ
detail string · nullable
instance string · nullable
status integer · nullable
title string · nullable
type string · nullable

Standardfel: 401 403 Felhantering

Exempel

curl 
curl "https://api.fluit.cloud/preview/reference/tax-classes"
Svar 200 
[
  {
    "code": "string",
    "countryCode": "SE",
    "isDefault": true,
    "name": "Acme AB",
    "rate": "299.00",
    "taxCode": "STD",
    "validFrom": "2026-06-11",
    "validTo": "2026-06-11"
  }
]

Bas-URL https://api.fluit.cloud/preview. Svarsexemplet är genererat ur schemat: formen stämmer, värdena är påhittade.

GET /reference/tenant-info

Get tenant info

Returns company details and base configuration (currency, language, timezone) for the authenticated tenant. Address fields use the same names as elsewhere in the API (street1, countryCode) and codes are ISO: countryCode is ISO 3166-1 alpha-2, baseCurrencyCode is ISO 4217 and defaultLanguageCode is ISO 639-1.

Visa hela beskrivningen

Responses carry a weak ETag; pass it back in If-None-Match to get 304 Not Modified while the record is unchanged.

reference:read Stödjer ETag

Svar

200 PublicTenantInfoResponse
  • ETag — Weak validator for this representation. Pass it back in If-None-Match to get 304 Not Modified while the record is unchanged.
Fält Typ Beskrivning
baseCurrencyCode string · nullable ISO 4217 base currency code, e.g. `SEK`.
city string · nullable City, or `null` if not configured.
companyName string · nullable Registered company name.
countryCode string · nullable ISO 3166-1 alpha-2 country code, e.g. `SE`. Null if not configured.
defaultLanguageCode string · nullable ISO 639-1 default language code, e.g. `sv`.
email string · nullable Company contact e-mail, or `null` if not configured.
organizationNumber string · nullable Organisation / company registration number, or `null` if not configured.
phone string · nullable Company phone number, or `null` if not configured.
postalCode string · nullable Postal / ZIP code, or `null` if not configured.
street1 string · nullable Street address line 1, or `null` if not configured.
timezone string · nullable IANA timezone identifier, e.g. `Europe/Stockholm`.
vatNumber string · nullable VAT registration number, or `null` if not configured.
website string · nullable Company website URL, or `null` if not configured.
304 Tom body.
  • ETag — Weak validator for this representation. Pass it back in If-None-Match to get 304 Not Modified while the record is unchanged.

Standardfel: 401 403 Felhantering

Exempel

curl 
curl "https://api.fluit.cloud/preview/reference/tenant-info"
Svar 200 
{
  "baseCurrencyCode": "SEK",
  "city": "Stockholm",
  "companyName": "Acme AB",
  "countryCode": "SE",
  "defaultLanguageCode": "STD",
  "email": "order@acme.se",
  "organizationNumber": "ABC-001",
  "phone": "+46 8 123 45 67",
  "postalCode": "11122",
  "street1": "Storgatan 1",
  "timezone": "string",
  "vatNumber": "ABC-001",
  "website": "string"
}

Bas-URL https://api.fluit.cloud/preview. Svarsexemplet är genererat ur schemat: formen stämmer, värdena är påhittade.

GET /reference/ticket-queues

List ticket queues

Returns the active ticket queues (team workspaces) and their codes, for use as queueCode when routing a ticket with POST /preview/tickets/{ticketNumber}/queue or PATCH /preview/tickets/{ticketNumber}.

Visa hela beskrivningen

Inactive queues are left out because they do not accept new tickets. Reference lists are bounded configuration data and are returned unpaginated. Responses carry a weak ETag; pass it back in If-None-Match to get 304 Not Modified while the list is unchanged.

reference:read Stödjer ETag

Svar

200 PublicTicketQueueResponse[]
  • ETag — Weak validator for this representation. Pass it back in If-None-Match to get 304 Not Modified while the record is unchanged.
Fält Typ Beskrivning
code string · nullable Unique queue code used as `queueCode` on the ticket endpoints.
description string · nullable What the queue handles. Null if not set.
name string · nullable Display name of the queue.
304 Tom body.
  • ETag — Weak validator for this representation. Pass it back in If-None-Match to get 304 Not Modified while the record is unchanged.

Standardfel: 401 403 Felhantering

Exempel

curl 
curl "https://api.fluit.cloud/preview/reference/ticket-queues"
Svar 200 
[
  {
    "code": "string",
    "description": "string",
    "name": "Acme AB"
  }
]

Bas-URL https://api.fluit.cloud/preview. Svarsexemplet är genererat ur schemat: formen stämmer, värdena är påhittade.

GET /reference/units

List units of measure

Returns all active units of measure. These are the valid values for unit on order lines. An item's own orderable units — the base unit plus any case/pallet units with their conversion factors — are returned by GET /preview/items/{itemNumber} in units[].

Visa hela beskrivningen

Unit codes are stored uppercase and matched case-insensitively. Reference lists are bounded configuration data and are returned unpaginated. Responses carry a weak ETag; pass it back in If-None-Match to get 304 Not Modified while the list is unchanged.

reference:read Stödjer ETag

Svar

200 PublicUnitResponse[]
  • ETag — Weak validator for this representation. Pass it back in If-None-Match to get 304 Not Modified while the record is unchanged.
Fält Typ Beskrivning
code string · nullable Unique unit code used as `unit` on order lines, e.g. `ST`, `KG`.
decimalPlaces integer Number of decimals normally used for quantities in this unit.
name string · nullable Display name of the unit.
symbol string · nullable Short symbol for presentation, e.g. `kg`. Null if not set.
304 Tom body.
  • ETag — Weak validator for this representation. Pass it back in If-None-Match to get 304 Not Modified while the record is unchanged.

Standardfel: 401 403 Felhantering

Exempel

curl 
curl "https://api.fluit.cloud/preview/reference/units"
Svar 200 
[
  {
    "code": "string",
    "decimalPlaces": 2,
    "name": "Piece",
    "symbol": "string"
  }
]

Bas-URL https://api.fluit.cloud/preview. Svarsexemplet är genererat ur schemat: formen stämmer, värdena är påhittade.

GET /reference/warehouses

List warehouses

Returns all active warehouses available for use as warehouseCode in order creation. Reference lists are bounded configuration data and are returned unpaginated. Responses carry a weak ETag; pass it back in If-None-Match to get 304 Not Modified while the list is unchanged.

reference:read Stödjer ETag

Svar

200 PublicWarehouseResponse[]
  • ETag — Weak validator for this representation. Pass it back in If-None-Match to get 304 Not Modified while the record is unchanged.
Fält Typ Beskrivning
code string · nullable Unique warehouse code used as `warehouseCode` in order creation.
isDefault boolean Whether this is the tenant's default warehouse.
name string · nullable Display name of the warehouse.
304 Tom body.
  • ETag — Weak validator for this representation. Pass it back in If-None-Match to get 304 Not Modified while the record is unchanged.

Standardfel: 401 403 Felhantering

Exempel

curl 
curl "https://api.fluit.cloud/preview/reference/warehouses"
Svar 200 
[
  {
    "code": "string",
    "isDefault": true,
    "name": "Main warehouse"
  }
]

Bas-URL https://api.fluit.cloud/preview. Svarsexemplet är genererat ur schemat: formen stämmer, värdena är påhittade.