Data model for contracts

count

Integer

Required parameter. Number of contracts per page, with the maximum being 10.

page

Integer

Required parameter. The page number, starting with 1.

suppliers

Comma-separated integers

One or more supplier participant numbers. The API will return the contracts for the user having these suppliers. No more than 10 participant numbers can be part of a single request.

from

Date

Filter contracts being approved or modified after this date. Format: yyyy-MM-dd

to

Date

Filter contracts being approved or modified before this date. Format: yyyy-MM-dd

onlyActiveConditions

Boolean

If set to true, the response will exclude conditions that are not active. Defaults to false.

approved

DateTime

UTC timestamp for when the contract was approved. Format according to ISO-8601. Example value: 2021-01-14T16:35:44.94Z

conditions

Array of Condition objects

Array of conditions on all levels of the contract. Also known as “Betingelser” in Norwegian.

contractId

Integer

Unique ID for the contract. Also known as “Avtalenummer” in Norwegian.

created

DateTime

UTC timestamp for when the contract was created. Format according to ISO-8601. Example value: 2021-01-14T16:35:44.94Z

from

Date

Date for when the contract is valid from. Format: yyyy-MM-dd

lastModified

DateTime

UTC timestamp for when the contract was last modified. Format according to ISO-8601. Example value: 2021-01-14T16:35:44.94Z

ownerParticipantNumber

Integer

Participant number for the contract owner.

receiverParticipantNumber

Integer

Participant number for the participant that received the contract.

senderParticipantNumber

Integer

Participant number for the participant that sent the contract.

sent

DateTime

UTC timestamp for when the contract was sent. Format according to ISO-8601. Example value: 2021-01-14T16:35:44.94Z

text

String

An optional text for describing the contract. Also known as “Avtaletekst” in Norwegian.

to

Date

An optional date for when the contract is valid to. Format: yyyy-MM-dd

active

Boolean

Shows if the current condition is active. Also known as “Aktiv” in Norwegian.

calculationrules

Array of Calculation Rule objects

Array of calculation rules. Also known as “Rabattelementer” in Norwegian.

delivery

Delivery object

For conditions that depend on a type of delivery.

description

String

An optional text for describing the condition. Shown as “Beskrivelse” in the desktop application.

level

String

Describes the level in the NOBB hierarchy where the condition applies. From bottom to top, these are the possible values:

• Item (“vare”)

• Module (“modul”)

• ProductGroup (“varegruppe”)

• MainGroup (“hovedgruppe”)

• SuperGroup (“overgruppe”)

• Supplier (“leverandør”)

number

Integer

Refers to the NOBB number, the module number, or the group number. It depends on the level attribute like this:

• NOBB number when level is Item

• Module number when level is Module

• Product group number when level is ProductGroup

• Main group number when level is MainGroup

• Super group number when level is SuperGroup

• null (no value) when level is Supplier

ownerParticipantNumber

Integer

Participant number of the condition owner.

packaging

Packaging object

For conditions that depend on a type of packaging.

quantity

Quantity object

For conditions that depend on quantities.

zones

Array of strings

For conditions that depend on zones. Zones are named ranges of postal code numbers.

active

Boolean

Shows if the current rule is active. Also known as “Aktiv” in Norwegian.

description

String

An optional text for describing the rule. Shown as “Navn” in the desktop application.

formula

String

String value of calculation formula. The allowed values are the same as in the desktop application: %, (%), KR, NT, DG, DBK, BF, IP, KP, VP, UTN.

from

Date

The first date for when the rule is active. Format: yyyy-MM-dd

ownerParticipantNumber

Integer

Participant number for the calculation rule owner.

to

Date

The last date for when the rule is active. Format: yyyy-MM-dd

type

String

Calculation rule type, possible values are:

• Purchase (“Innkjøp”)

• FullCost (“Selvkost”)

• Retail (“Utsalg”)

value

Decimal

Decimal value of the calculation rule.

directToCustomer

Boolean

Shown as “Byggeplass” in the desktop application.

stock

Boolean

Shown as “Lager” in the desktop application.

supplyStock

Boolean

Shown as “Forsyningslager” in the desktop application.

f

Boolean

Shown as “F-PAK” in the desktop application.

d

Boolean

Shown as “D-PAK” in the desktop application.

t

Boolean

Shown as “T-PAK” in the desktop application.

perProduct

Boolean

True if the quantity rules apply per item in an order. False if the quantity rules apply to the whole order.

rules

Array of Quantity Rule objects

One or more quantity rules.

isAnd

Boolean

Describes how multiple rules are evaluated. When true, then all rules must be satisfied. When false, then only one of the rules must be satisfied.

operator

String

Math condition operator, possible values: =, >, >=, <, <=

type

String

The type of the rule. Possible values: Count, OrderValue, Volume, Weight

unit

String

The unit for the rule. Depends on the type like this:

• When type is Count, the unit will be one of the NOBB units, like PAK, PAL, RUL, STK, etc.

• When type is OrderValue, the unit will be a currency code, like NOK, SEK, DKK, EUR.

• When type is Volume, the unit will always be M3 (for square meters).

• When type is Weight, the unit will always be KG (for kilograms).

value

Decimal

Decimal value for the quantity rule.