List avtaler

GET/api/v1/agreements

Virker

Godtatte og sendte avtaler med posisjoner og pristabell, nyeste nummer først. Aldri et utkast. En kundenøkkel ser bare sin egen kundes avtaler som er sendt, sett eller godtatt. Utløpte avtaler med includeExpired=true, erstattede med status=erstattet. Et avrop er en ordre: send det med POST /orders.

Rettigheter: agreements:read
Kundenøkkel: Ja, for sine egne
Grense: lesing, 120 i minuttet
Siden: 5. oktober 2026

Parametre

I spørringen

statusstring
Verdiersendtsettgodtattavvisterstattetutlopt
customerIdstring · uuid
UUID
includeExpiredstring
Verdiertruefalse
limitinteger1–100
Antall per side, 1–100 (25 når den mangler).
cursorstringhøyst 400 tegn
nextCursor fra forrige side.

Svaret

200OKAvtalene

application/jsonAgreementList

dataAgreement[]Må med
Vis 18 feltSkjul 18 felt
- numberintegerMå med
- versionintegerMå med
- statusstringMå med
  Verdiersendtsettgodtattavvisterstattetutlopt
- expiredbooleanMå med
- customerobjectMå med
  Vis 3 feltSkjul 3 felt
  - idstring · uuidMå med
    UUID
  - numberintegerMå medkan være null
  - namestringMå med
- projectobjectMå medkan være null
  Vis 2 feltSkjul 2 felt
  - projectNostringMå med
  - namestringMå medkan være null
- titlestringMå med
- validUntilstringMå medkan være null
- deliveryWeekdaysinteger[]Må med
- leadDaysintegerMå medkan være null
- freightFreeFromOreintegerMå medkan være null
  Hele øre (1 kr = 100 øre)
- maxLengthMmintegerMå medkan være null
- termsWestringMå medkan være null
- termsYoustringMå medkan være null
- positionsAgreementPosition[]Må med
  Vis 10 feltSkjul 10 felt
  - idstring · uuidMå med
    UUID
  - posNointegerMå med
  - namestringMå med
  - shortNamestringMå medkan være null
  - materialstringMå medkan være null
  - colourstringMå medkan være null
  - colourSidestringMå medkan være null
    Verdierutinn
  - profileobjectMå medkan være null
    Vis 2 feltSkjul 2 felt
    slugstringMå med
    paramsRecord<string, number>Må mednøklene er tekst
  - priceTableobject[]Må med
    Vis 2 feltSkjul 2 felt
    upToLengthMmintegerMå med
    unitPriceOreintegerMå med
    Hele øre (1 kr = 100 øre)
  - vatBpintegerMå med0–10000
    Moms i basispunkter: 2500 = 25 %
- sentAtstring · date-timeMå medkan være nulleks. 2026-12-14T09:03:00.000Z
  Tidspunkt, ISO 8601 i UTC
- decidedAtstring · date-timeMå medkan være nulleks. 2026-12-14T09:03:00.000Z
  Tidspunkt, ISO 8601 i UTC
- decidedByNamestringMå medkan være null
nextCursorstringMå medkan være null

Feilkoder

Alle feil har samme form. Velg handling etter code, aldri etter message. Les mer under Feil.

400Bad Request

invalid_cursorMarkøren (cursor) er ikke en vi har gitt ut.
invalid_requestNoe i forespørselen er feil eller ukjent. fields sier hva.

401Unauthorized

unauthorizedNøkkelen mangler, er feil, er slått av eller har gått ut. En nøkkel som slås av, slutter å virke innen 1 minutt.

403Forbidden

account_closedVerkstedet er stengt.
dpa_requiredVerkstedet må godta databehandleravtalen før koblinger kan brukes.
feature_not_in_planVerkstedet har ikke slått på delen dette trenger. feature sier hvilken.
insufficient_scopeNøkkelen har ikke lov til dette. requiredScope sier hvilken rett som mangler.

429Too Many Requests

rate_limitedFor mange kall. Vent retryAfterSeconds sekunder.

500Internal Server Error

internalNoe gikk galt hos oss. Feilen er meldt. Oppgi requestId hvis du spør.

GET/agreements

curl https://vbeslag.com/api/v1/agreements \
  -H "Authorization: Bearer vb_test_…"

const res = await fetch('https://vbeslag.com/api/v1/agreements', {
  headers: {
    Authorization: 'Bearer vb_test_…',
  },
})
const data = await res.json()

$ch = curl_init('https://vbeslag.com/api/v1/agreements');
curl_setopt_array($ch, [
    CURLOPT_HTTPHEADER     => [
        'Authorization: Bearer vb_test_…',
    ],
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);

Svaret

HTTP/1.1 200 OK
Content-Type: application/json

{
  "data": [
    {
      "number": 12,
      "version": 2,
      "status": "godtatt",
      "expired": false,
      "customer": {
        "id": "5d0a1c2e-7b3f-4c1a-9e2d-1f0a2b3c4d5e",
        "number": 312,
        "name": "Byggmester Hansen AS"
      },
      "project": {
        "projectNo": "P-2231",
        "name": "Storgata 5"
      },
      "title": "Beslag Storgata 5",
      "validUntil": "2027-06-30",
      "deliveryWeekdays": [
        1,
        3,
        5
      ],
      "leadDays": 2,
      "freightFreeFromOre": 500000,
      "maxLengthMm": 3000,
      "termsWe": "Vi leverer på byggeplass.",
      "termsYou": "Dere tar imot og kvitterer.",
      "positions": [
        {
          "id": "c9a1b2c3-d4e5-4f60-8a7b-9c0d1e2f3a4b",
          "posNo": 1,
          "name": "Vindskie 150×40",
          "shortName": "VS150",
          "material": "Stål 0,6 mm",
          "colour": "RAL 9005",
          "colourSide": "ut",
          "profile": {
            "slug": "vindskie",
            "params": {
              "a": 150,
              "b": 40
            }
          },
          "priceTable": [
            {
              "upToLengthMm": 600,
              "unitPriceOre": 21900
            },
            {
              "upToLengthMm": 1250,
              "unitPriceOre": 27400
            },
            {
              "upToLengthMm": 2000,
              "unitPriceOre": 33800
            },
            {
              "upToLengthMm": 2500,
              "unitPriceOre": 38900
            }
          ],
          "vatBp": 2500
        }
      ],
      "sentAt": "2026-10-01T08:00:00.000Z",
      "decidedAt": "2026-10-02T09:30:00.000Z",
      "decidedByName": "Ole Hansen"
    }
  ],
  "nextCursor": null
}