API-referanse

Alle operasjonene i vbeslag API v1, laget fra det samme dokumentet som API-et sjekker med.

Nøkkelen

Hvem er jeg? Sjekk at nøkkelen virker

Virker

GET /api/v1/me

Det første kallet: viser verkstedet, nøkkelen (aldri hemmeligheten), delene som er slått på, og grensene. Avdelingene (locations) kommer: til verkstedet kan ha avdelinger, er feltet utelatt.

Rettigheter	`Bare en nøkkel`
Kundenøkkel	Ja, for sine egne
Grense	lesing, 120 i minuttet

Svaret (200)

Felt	Type	Må med	Beskrivelse
`organization`	`object`	Ja
`organization.name`	`string`	Ja
`organization.shopSlug`	`string \| null`	Ja
`key`	`object`	Ja
`key.name`	`string`	Ja
`key.prefix`	`string`	Ja	Begynnelsen av nøkkelen, som vist i appen. Aldri hemmeligheten.
`key.environment`	`"live" \| "test"`	Ja
`key.purpose`	`"nettside" \| "eget_system" \| "kunde" \| "egendefinert" \| "maskin" \| "regneark" \| "leverandor"`	Ja
`key.scopes`	`"catalog:read" \| "prices:read" \| "orders:read" \| "orders:write" \| "orders:status" \| "agreements:read" \| "customers:read" \| "customers:write" \| "invoices:read" \| "production:read" \| "production:status" \| "reports:read"[]`	Ja
`key.customer`	`object \| null`	Ja	Satt når nøkkelen er en kundenøkkel.
`key.createdAt`	`string`	Ja	Tidspunkt, ISO 8601 i UTC
`key.expiresAt`	`string \| null`	Ja	Tidspunkt, ISO 8601 i UTC
`features`	`object`	Ja
`features.api`	`boolean`	Ja
`features.webhooks`	`boolean`	Ja
`features.shop`	`boolean`	Ja
`features.avtaler`	`boolean`	Ja
`features.lapper`	`boolean`	Ja
`features.kontor`	`boolean`	Ja
`limits`	`object`	Ja
`limits.perMinute`	`object`	Ja
`limits.perDay`	`object`	Ja
`limits.perWorkshopPerDay`	`integer`	Ja
`limits.failedLogins`	`object`	Ja
`modules`	`object[]`	Nei	Modulene verkstedet har slått på.
`locations`	`object[]`	Nei	Kommer: avdelingene, når verkstedet har to eller flere. Til avdelinger finnes, er feltet utelatt.
`apiVersion`	`"v1"`	Ja

Feilkoder

unauthorized · Nø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.
account_closed · Verkstedet er stengt.
dpa_required · Verkstedet må godta databehandleravtalen før koblinger kan brukes.
feature_not_in_plan · Verkstedet har ikke slått på delen dette trenger. feature sier hvilken.
rate_limited · For mange kall. Vent retryAfterSeconds sekunder.
internal · Noe gikk galt hos oss. Feilen er meldt. Oppgi requestId hvis du spør.

Ordre

Send inn en ordre eller en forespørsel

Virker

POST /api/v1/orders

Blir en ordre i verkstedets liste med neste nummer, akkurat som en lapp, en ordre fra disken eller fra nettbutikken. En forespørsel (intent: request) venter på at verkstedet bekrefter. Et avrop på en godtatt avtale (agreementNumber og position-linjer, modulen Avtaler) blir Mottatt med avtalens priser; en kundenøkkel når bare sin egen kundes avtaler. Idempotency-Key gjør det trygt å prøve igjen.

Rettigheter	`orders:write`
Kundenøkkel	Ja, for sine egne
Grense	skriving, 30 i minuttet
Overskrifter	`Idempotency-Key`

Parametre

Felt	Type	Må med	Beskrivelse
`Idempotency-Key (header)`	`string`	Ja	8–255 tegn. Bruk en UUID per forsøk på en handling; samme nøkkel og samme innhold gir samme svar igjen.

Det du sender

Felt	Type	Må med	Beskrivelse
`intent`	`"order" \| "request"`	Ja	`request`: en Forespørsel verkstedet bekrefter («Ingenting er avtalt før du har bekreftet»). `order`: rett inn som Mottatt (bare verkstedets egne nøkler, med kunde).
`customer`	`object \| object \| object \| null`	Nei	Kunden: `{ "id" }`, `{ "number" }` (kundenummeret i registeret) eller `{ "orgNr" }`.
`contact`	`ContactInput \| null`	Nei
`createCustomer`	`boolean`	Nei	Lag kunden i registeret fra `contact` (bare med en ekte nøkkel som er verkstedets egen).
`agreementNumber`	`integer \| null`	Nei	Et avrop på en godtatt avtale (`intent: "order"`, bare `position`-linjer). Kunden, prosjektet og prisene er avtalens; en kundenøkkel når bare sin egen kundes avtaler. Ordren får `source: "avrop"`.
`projectNo`	`string \| null`	Nei
`orderer`	`string \| null`	Nei
`customerPo`	`string \| null`	Nei
`title`	`string \| null`	Nei
`note`	`string \| null`	Nei
`delivery`	`object \| null`	Nei
`delivery.mode`	`"henting" \| "levering" \| null`	Nei
`delivery.requestedDate`	`string \| null`	Nei	Dato på Oslo-kalenderen, ÅÅÅÅ-MM-DD
`delivery.address`	`object \| null`	Nei
`lines`	`TextLineInput \| PositionLineInput[]`	Nei
`externalRef`	`string \| null`	Nei	Din egen id (for eksempel `woo-18822`). Unik per nøkkel: samme id igjen gir 409 med ordrenummeret.

Svaret (201)

Felt	Type	Må med	Beskrivelse
`id`	`string`	Ja	UUID
`number`	`integer`	Ja	Ordrenummeret i verkstedets serie (testordre har sin egen serie).
`numberDisplay`	`string`	Ja	«004711», eller «T-000012» for en testordre.
`isTest`	`boolean`	Ja
`source`	`"lapp" \| "manuell" \| "tilbud" \| "avrop" \| "nettbutikk" \| "api" \| "import" \| "portal" \| "nettverk"`	Ja	Hvor ordren kom fra (`lapp`, `manuell`, `tilbud`, `avrop`, `nettbutikk`, `api`, `import`). Kan få nye verdier: les en ukjent verdi som «annet».
`channel`	`string \| null`	Ja	Navnet på nøkkelen eller butikkens «kilde»: der ordren kom fra.
`status`	`"forespurt" \| "mottatt" \| "i_arbeid" \| "klar" \| "levert" \| "fakturert" \| "betalt" \| "avbrutt"`	Ja	Lagret status: `forespurt`, `mottatt`, `i_arbeid`, `klar`, `levert`, `fakturert`, `betalt`, `avbrutt`. Stigen får aldri et nytt trinn uten v2.
`statusLabel`	`string`	Ja	Statusen med appens ord: Forespørsel, Mottatt, I arbeid, Klar, Levert/Hentet, Fakturert, Betalt, Avbrutt/Avvist.
`statusChangedAt`	`string`	Ja	Tidspunkt, ISO 8601 i UTC
`customer`	`object \| null`	Ja
`customer.id`	`string`	Ja	UUID
`customer.number`	`integer \| null`	Ja
`customer.name`	`string`	Ja
`contact`	`object \| null`	Ja	Bare så lenge ordren ikke har en kunde (en forespørsel).
`contact.name`	`string`	Ja
`contact.company`	`string \| null`	Ja
`contact.orgNr`	`string \| null`	Ja
`contact.email`	`string \| null`	Ja
`contact.mobile`	`string \| null`	Ja
`projectNo`	`string \| null`	Ja
`orderer`	`string \| null`	Ja
`customerPo`	`string \| null`	Ja
`title`	`string \| null`	Ja
`note`	`string \| null`	Ja
`agreement`	`object \| null`	Ja
`agreement.id`	`string`	Ja	UUID
`delivery`	`object`	Ja
`delivery.mode`	`"henting" \| "levering" \| null`	Ja
`delivery.requestedDate`	`string \| null`	Ja	Dato på Oslo-kalenderen, ÅÅÅÅ-MM-DD
`delivery.deliveryDate`	`string \| null`	Ja	Dato på Oslo-kalenderen, ÅÅÅÅ-MM-DD
`delivery.address`	`object \| null`	Ja
`lines`	`OrderLine[]`	Ja
`totals`	`object`	Ja
`totals.netOre`	`integer \| null`	Ja	Hele øre (1 kr = 100 øre)
`totals.vatOre`	`integer \| null`	Ja	Hele øre (1 kr = 100 øre)
`totals.grossOre`	`integer \| null`	Ja	Hele øre (1 kr = 100 øre)
`totals.currency`	`"NOK"`	Ja
`totals.priceStatus`	`"priced" \| "partial" \| "in_kalkyle" \| "hidden"`	Ja	`priced`: alle linjer har pris; `partial`: noen linjer venter på pris; `in_kalkyle`: prisen står i kalkylen; `hidden`: skjult for en kundenøkkel. Beløpene er `null` når de ikke er kjent.
`hasKalkyle`	`boolean \| null`	Ja	Om ordren er priset i en kalkyle; null for en kundenøkkel.
`stickerNumbers`	`integer[]`	Ja	Lappnumrene som er knyttet til ordren.
`readyWithoutReceipt`	`boolean`	Ja	«Klar uten mottak».
`readySms`	`object \| null`	Ja	Klar-SMS-en: status og tider, aldri nummer eller tekst. Null for en kundenøkkel.
`readySms.status`	`"queued" \| "cancelled" \| "sending" \| "sent" \| "delivered" \| "failed"`	Ja
`readySms.sendAfter`	`string \| null`	Ja	Tidspunkt, ISO 8601 i UTC
`readySms.sentAt`	`string \| null`	Ja	Tidspunkt, ISO 8601 i UTC
`invoice`	`object \| null`	Ja
`invoice.id`	`string`	Ja	UUID
`invoice.kind`	`"invoice" \| "credit_note" \| "erp_mark"`	Ja
`invoice.number`	`string \| null`	Ja
`invoice.issuedAt`	`string \| null`	Ja	Tidspunkt, ISO 8601 i UTC
`invoice.erpNo`	`string \| null`	Ja
`attachments`	`Attachment[]`	Ja
`externalRef`	`string \| null`	Ja	Din egen id for ordren, unik per nøkkel.
`createdAt`	`string`	Ja	Tidspunkt, ISO 8601 i UTC
`receivedAt`	`string \| null`	Ja	Tidspunkt, ISO 8601 i UTC
`inWorkAt`	`string \| null`	Ja	Tidspunkt, ISO 8601 i UTC
`readyAt`	`string \| null`	Ja	Tidspunkt, ISO 8601 i UTC
`deliveredAt`	`string \| null`	Ja	Tidspunkt, ISO 8601 i UTC
`invoicedAt`	`string \| null`	Ja	Tidspunkt, ISO 8601 i UTC
`paidAt`	`string \| null`	Ja	Tidspunkt, ISO 8601 i UTC
`cancelledAt`	`string \| null`	Ja	Tidspunkt, ISO 8601 i UTC
`cancelReason`	`string \| null`	Ja
`updatedAt`	`string`	Ja	Tidspunkt, ISO 8601 i UTC
`version`	`integer`	Ja	Øker ved hver endring. Send den tilbake i `If-Match: "v<version>"`.
`production`	`OrderProduction \| null`	Nei	Bøyearkene på ordren, når verkstedet har Produksjon; `null` uten Produksjon og for en kundenøkkel. Med i svarene fra ordreoperasjonene, ikke i webhooks og `GET /events`. Et bøyd ark endrer ikke `version`, så når `production` ikke er `null`, svarer `If-None-Match` aldri 304.

Feilkoder

invalid_json · Innholdet er ikke gyldig JSON.
invalid_request · Noe i forespørselen er feil eller ukjent. fields sier hva.
unauthorized · Nø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.
account_closed · Verkstedet er stengt.
customer_key_not_allowed · En kundenøkkel kan ikke gjøre dette.
dpa_required · Verkstedet må godta databehandleravtalen før koblinger kan brukes.
feature_not_in_plan · Verkstedet har ikke slått på delen dette trenger. feature sier hvilken.
insufficient_scope · Nøkkelen har ikke lov til dette. requiredScope sier hvilken rett som mangler.
test_key_not_allowed · En testnøkkel kan ikke dette: den endrer aldri kunderegisteret, og et avrop er alltid en ekte ordre.
duplicate_external_ref · Du har allerede sendt en ordre med denne externalRef. existingNumber er ordrenummeret.
idempotency_in_progress · En forespørsel med samme Idempotency-Key holder på. Prøv igjen om litt.
key_owner_missing · Brukeren som laget nøkkelen finnes ikke lenger. Lag en ny nøkkel.
agreement_not_active · Avtalen tar ikke imot avrop: den er ikke godtatt, er utløpt eller erstattet, eller finnes ikke for denne nøkkelen. reason sier hvorfor.
contact_invalid · Kontakten trenger et navn og en e-post eller et norsk mobilnummer.
content_required · Ordren må ha minst en linje eller en merknad (note) på minst 3 tegn.
customer_fixed_by_key · Denne nøkkelen hører til en kunde, og ordren må være for den kunden.
customer_invalid · Noe i kundefeltene er feil. fields sier hva.
customer_required · Ordren må ha en kunde. Send customer, eller contact med createCustomer: true.
date_invalid · Datoen er ikke en gyldig dag (ÅÅÅÅ-MM-DD).
delivery_date_not_allowed · Avtalen leverer ikke den dagen. nextPossibleDate er den første dagen som går.
idempotency_key_reused · Denne Idempotency-Key ble brukt på en annen forespørsel. Bruk en ny nøkkel for ny handling.
intent_not_allowed · En kundenøkkel sender forespørsler ("intent": "request"), eller avrop på en godtatt avtale (agreementNumber).
length_over_max · Lengden er over det avtalen tillater (maxLengthMm). fields sier hvilken linje.
orderer_required · Denne kunden krever bestiller (orderer).
position_not_in_agreement · Posisjonen hører ikke til denne avtalen. Hent posisjonene med GET /agreements/{number}. fields sier hvilken linje.
project_no_required · Denne kunden krever prosjektnummer (projectNo).
quantity_invalid · Antallet må være mellom 1 og 500.
too_many_lines · Ordren kan ha høyst 100 linjer.
idempotency_key_required · Send Idempotency-Key med denne forespørselen.
rate_limited · For mange kall. Vent retryAfterSeconds sekunder.
internal · Noe gikk galt hos oss. Feilen er meldt. Oppgi requestId hvis du spør.

Eksempel

Eksempel: POST /orders

{
  "intent": "request",
  "contact": {
    "name": "Kari Nordmann",
    "email": "kari@example.no",
    "mobile": "+4791234567"
  },
  "title": "Pipebeslag",
  "note": "Se bilde av skissen",
  "lines": [
    {
      "kind": "text",
      "description": "Pipebeslag 600×600, stål sort",
      "quantity": 1,
      "unit": "stk"
    }
  ],
  "externalRef": "woo-18822"
}

List ordre

Virker

GET /api/v1/orders

Nyeste først, eller etter endring for å synkronisere (sort=updatedAt med updatedSince og cursor). En testnøkkel ser testordrene. Avropene på en avtale: agreementNumber=12.

Rettigheter	`orders:read`
Kundenøkkel	Ja, for sine egne
Grense	lesing, 120 i minuttet

Parametre

Felt	Type	Må med	Beskrivelse
`status (query)`	`string`	Nei	En eller flere statuser, med komma: `mottatt,i_arbeid`.
`view (query)`	`"apne" \| "klar_ikke_fakturert"`	Nei	`apne`: alt som ikke er lukket; `klar_ikke_fakturert`: Klar eller Levert uten faktura.
`source (query)`	`"lapp" \| "manuell" \| "tilbud" \| "avrop" \| "nettbutikk" \| "api" \| "import" \| "portal" \| "nettverk"`	Nei	Hvor ordren kom fra (`lapp`, `manuell`, `tilbud`, `avrop`, `nettbutikk`, `api`, `import`). Kan få nye verdier: les en ukjent verdi som «annet».
`customerId (query)`	`string`	Nei	UUID
`agreementNumber (query)`	`string`	Nei	Avropene på en avtale: avtalenummeret, som «12» (SR-AVT-4).
`projectNo (query)`	`string`	Nei
`externalRef (query)`	`string`	Nei
`createdSince (query)`	`string`	Nei	Tidspunkt, ISO 8601 i UTC
`updatedSince (query)`	`string`	Nei	Tidspunkt, ISO 8601 i UTC
`sort (query)`	`"-createdAt" \| "createdAt" \| "updatedAt"`	Nei	Nyeste først (`-createdAt`, standard), eldste først (`createdAt`), eller etter endring (`updatedAt`, for synkronisering).
`limit (query)`	`integer`	Nei	Antall per side, 1–100 (25 når den mangler).
`cursor (query)`	`string`	Nei	`nextCursor` fra forrige side.

Svaret (200)

Felt	Type	Må med	Beskrivelse
`data`	`Order[]`	Ja
`nextCursor`	`string \| null`	Ja	Gi denne som `cursor` for neste side; `null` når det ikke er flere.

Feilkoder

invalid_cursor · Markøren (cursor) er ikke en vi har gitt ut.
invalid_request · Noe i forespørselen er feil eller ukjent. fields sier hva.
unauthorized · Nø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.
account_closed · Verkstedet er stengt.
dpa_required · Verkstedet må godta databehandleravtalen før koblinger kan brukes.
feature_not_in_plan · Verkstedet har ikke slått på delen dette trenger. feature sier hvilken.
insufficient_scope · Nøkkelen har ikke lov til dette. requiredScope sier hvilken rett som mangler.
rate_limited · For mange kall. Vent retryAfterSeconds sekunder.
internal · Noe gikk galt hos oss. Feilen er meldt. Oppgi requestId hvis du spør.

Hent en ordre

Virker

GET /api/v1/orders/{number}

Med linjer, filer, faktura og Klar-SMS-ens status. ETag er versjonen; send If-None-Match for å få 304 når ingenting er endret.

Rettigheter	`orders:read`
Kundenøkkel	Ja, for sine egne
Grense	lesing, 120 i minuttet

Parametre

Felt	Type	Må med	Beskrivelse
`number (path)`	`string`	Ja	«4711», «004711», «T-000012» (testnøkler), eller et lappnummer som er blitt ordrens.

Svaret (200)

Felt	Type	Må med	Beskrivelse
`id`	`string`	Ja	UUID
`number`	`integer`	Ja	Ordrenummeret i verkstedets serie (testordre har sin egen serie).
`numberDisplay`	`string`	Ja	«004711», eller «T-000012» for en testordre.
`isTest`	`boolean`	Ja
`source`	`"lapp" \| "manuell" \| "tilbud" \| "avrop" \| "nettbutikk" \| "api" \| "import" \| "portal" \| "nettverk"`	Ja	Hvor ordren kom fra (`lapp`, `manuell`, `tilbud`, `avrop`, `nettbutikk`, `api`, `import`). Kan få nye verdier: les en ukjent verdi som «annet».
`channel`	`string \| null`	Ja	Navnet på nøkkelen eller butikkens «kilde»: der ordren kom fra.
`status`	`"forespurt" \| "mottatt" \| "i_arbeid" \| "klar" \| "levert" \| "fakturert" \| "betalt" \| "avbrutt"`	Ja	Lagret status: `forespurt`, `mottatt`, `i_arbeid`, `klar`, `levert`, `fakturert`, `betalt`, `avbrutt`. Stigen får aldri et nytt trinn uten v2.
`statusLabel`	`string`	Ja	Statusen med appens ord: Forespørsel, Mottatt, I arbeid, Klar, Levert/Hentet, Fakturert, Betalt, Avbrutt/Avvist.
`statusChangedAt`	`string`	Ja	Tidspunkt, ISO 8601 i UTC
`customer`	`object \| null`	Ja
`customer.id`	`string`	Ja	UUID
`customer.number`	`integer \| null`	Ja
`customer.name`	`string`	Ja
`contact`	`object \| null`	Ja	Bare så lenge ordren ikke har en kunde (en forespørsel).
`contact.name`	`string`	Ja
`contact.company`	`string \| null`	Ja
`contact.orgNr`	`string \| null`	Ja
`contact.email`	`string \| null`	Ja
`contact.mobile`	`string \| null`	Ja
`projectNo`	`string \| null`	Ja
`orderer`	`string \| null`	Ja
`customerPo`	`string \| null`	Ja
`title`	`string \| null`	Ja
`note`	`string \| null`	Ja
`agreement`	`object \| null`	Ja
`agreement.id`	`string`	Ja	UUID
`delivery`	`object`	Ja
`delivery.mode`	`"henting" \| "levering" \| null`	Ja
`delivery.requestedDate`	`string \| null`	Ja	Dato på Oslo-kalenderen, ÅÅÅÅ-MM-DD
`delivery.deliveryDate`	`string \| null`	Ja	Dato på Oslo-kalenderen, ÅÅÅÅ-MM-DD
`delivery.address`	`object \| null`	Ja
`lines`	`OrderLine[]`	Ja
`totals`	`object`	Ja
`totals.netOre`	`integer \| null`	Ja	Hele øre (1 kr = 100 øre)
`totals.vatOre`	`integer \| null`	Ja	Hele øre (1 kr = 100 øre)
`totals.grossOre`	`integer \| null`	Ja	Hele øre (1 kr = 100 øre)
`totals.currency`	`"NOK"`	Ja
`totals.priceStatus`	`"priced" \| "partial" \| "in_kalkyle" \| "hidden"`	Ja	`priced`: alle linjer har pris; `partial`: noen linjer venter på pris; `in_kalkyle`: prisen står i kalkylen; `hidden`: skjult for en kundenøkkel. Beløpene er `null` når de ikke er kjent.
`hasKalkyle`	`boolean \| null`	Ja	Om ordren er priset i en kalkyle; null for en kundenøkkel.
`stickerNumbers`	`integer[]`	Ja	Lappnumrene som er knyttet til ordren.
`readyWithoutReceipt`	`boolean`	Ja	«Klar uten mottak».
`readySms`	`object \| null`	Ja	Klar-SMS-en: status og tider, aldri nummer eller tekst. Null for en kundenøkkel.
`readySms.status`	`"queued" \| "cancelled" \| "sending" \| "sent" \| "delivered" \| "failed"`	Ja
`readySms.sendAfter`	`string \| null`	Ja	Tidspunkt, ISO 8601 i UTC
`readySms.sentAt`	`string \| null`	Ja	Tidspunkt, ISO 8601 i UTC
`invoice`	`object \| null`	Ja
`invoice.id`	`string`	Ja	UUID
`invoice.kind`	`"invoice" \| "credit_note" \| "erp_mark"`	Ja
`invoice.number`	`string \| null`	Ja
`invoice.issuedAt`	`string \| null`	Ja	Tidspunkt, ISO 8601 i UTC
`invoice.erpNo`	`string \| null`	Ja
`attachments`	`Attachment[]`	Ja
`externalRef`	`string \| null`	Ja	Din egen id for ordren, unik per nøkkel.
`createdAt`	`string`	Ja	Tidspunkt, ISO 8601 i UTC
`receivedAt`	`string \| null`	Ja	Tidspunkt, ISO 8601 i UTC
`inWorkAt`	`string \| null`	Ja	Tidspunkt, ISO 8601 i UTC
`readyAt`	`string \| null`	Ja	Tidspunkt, ISO 8601 i UTC
`deliveredAt`	`string \| null`	Ja	Tidspunkt, ISO 8601 i UTC
`invoicedAt`	`string \| null`	Ja	Tidspunkt, ISO 8601 i UTC
`paidAt`	`string \| null`	Ja	Tidspunkt, ISO 8601 i UTC
`cancelledAt`	`string \| null`	Ja	Tidspunkt, ISO 8601 i UTC
`cancelReason`	`string \| null`	Ja
`updatedAt`	`string`	Ja	Tidspunkt, ISO 8601 i UTC
`version`	`integer`	Ja	Øker ved hver endring. Send den tilbake i `If-Match: "v<version>"`.
`production`	`OrderProduction \| null`	Nei	Bøyearkene på ordren, når verkstedet har Produksjon; `null` uten Produksjon og for en kundenøkkel. Med i svarene fra ordreoperasjonene, ikke i webhooks og `GET /events`. Et bøyd ark endrer ikke `version`, så når `production` ikke er `null`, svarer `If-None-Match` aldri 304.

Feilkoder

invalid_request · Noe i forespørselen er feil eller ukjent. fields sier hva.
unauthorized · Nø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.
account_closed · Verkstedet er stengt.
dpa_required · Verkstedet må godta databehandleravtalen før koblinger kan brukes.
feature_not_in_plan · Verkstedet har ikke slått på delen dette trenger. feature sier hvilken.
insufficient_scope · Nøkkelen har ikke lov til dette. requiredScope sier hvilken rett som mangler.
not_found · Fant ikke dette.
rate_limited · For mange kall. Vent retryAfterSeconds sekunder.
internal · Noe gikk galt hos oss. Feilen er meldt. Oppgi requestId hvis du spør.

Endre prosjektnr, bestiller, merknad eller levering

Virker

PATCH /api/v1/orders/{number}

Krever If-Match med versjonen du så. Avvist når ordren er fakturert. En kundenøkkel kan bare endre sine egne ordre før de er klare.

Rettigheter	`orders:write`
Kundenøkkel	Ja, for sine egne
Grense	skriving, 30 i minuttet
Overskrifter	`Idempotency-Key (valgfri), If-Match`

Parametre

Felt	Type	Må med	Beskrivelse
`number (path)`	`string`	Ja	«4711», «004711», «T-000012» (testnøkler), eller et lappnummer som er blitt ordrens.
`Idempotency-Key (header)`	`string`	Nei	8–255 tegn. Bruk en UUID per forsøk på en handling; samme nøkkel og samme innhold gir samme svar igjen.
`If-Match (header)`	`string`	Ja	Versjonen du så, som `"v3"` (fra `version` eller `ETag`).

Det du sender

Felt	Type	Må med	Beskrivelse
`projectNo`	`string \| null`	Nei
`orderer`	`string \| null`	Nei
`customerPo`	`string \| null`	Nei
`title`	`string \| null`	Nei
`note`	`string \| null`	Nei
`delivery`	`object`	Nei
`delivery.requestedDate`	`string \| null`	Nei	Dato på Oslo-kalenderen, ÅÅÅÅ-MM-DD
`delivery.address`	`object \| null`	Nei

Svaret (200)

Felt	Type	Må med	Beskrivelse
`id`	`string`	Ja	UUID
`number`	`integer`	Ja	Ordrenummeret i verkstedets serie (testordre har sin egen serie).
`numberDisplay`	`string`	Ja	«004711», eller «T-000012» for en testordre.
`isTest`	`boolean`	Ja
`source`	`"lapp" \| "manuell" \| "tilbud" \| "avrop" \| "nettbutikk" \| "api" \| "import" \| "portal" \| "nettverk"`	Ja	Hvor ordren kom fra (`lapp`, `manuell`, `tilbud`, `avrop`, `nettbutikk`, `api`, `import`). Kan få nye verdier: les en ukjent verdi som «annet».
`channel`	`string \| null`	Ja	Navnet på nøkkelen eller butikkens «kilde»: der ordren kom fra.
`status`	`"forespurt" \| "mottatt" \| "i_arbeid" \| "klar" \| "levert" \| "fakturert" \| "betalt" \| "avbrutt"`	Ja	Lagret status: `forespurt`, `mottatt`, `i_arbeid`, `klar`, `levert`, `fakturert`, `betalt`, `avbrutt`. Stigen får aldri et nytt trinn uten v2.
`statusLabel`	`string`	Ja	Statusen med appens ord: Forespørsel, Mottatt, I arbeid, Klar, Levert/Hentet, Fakturert, Betalt, Avbrutt/Avvist.
`statusChangedAt`	`string`	Ja	Tidspunkt, ISO 8601 i UTC
`customer`	`object \| null`	Ja
`customer.id`	`string`	Ja	UUID
`customer.number`	`integer \| null`	Ja
`customer.name`	`string`	Ja
`contact`	`object \| null`	Ja	Bare så lenge ordren ikke har en kunde (en forespørsel).
`contact.name`	`string`	Ja
`contact.company`	`string \| null`	Ja
`contact.orgNr`	`string \| null`	Ja
`contact.email`	`string \| null`	Ja
`contact.mobile`	`string \| null`	Ja
`projectNo`	`string \| null`	Ja
`orderer`	`string \| null`	Ja
`customerPo`	`string \| null`	Ja
`title`	`string \| null`	Ja
`note`	`string \| null`	Ja
`agreement`	`object \| null`	Ja
`agreement.id`	`string`	Ja	UUID
`delivery`	`object`	Ja
`delivery.mode`	`"henting" \| "levering" \| null`	Ja
`delivery.requestedDate`	`string \| null`	Ja	Dato på Oslo-kalenderen, ÅÅÅÅ-MM-DD
`delivery.deliveryDate`	`string \| null`	Ja	Dato på Oslo-kalenderen, ÅÅÅÅ-MM-DD
`delivery.address`	`object \| null`	Ja
`lines`	`OrderLine[]`	Ja
`totals`	`object`	Ja
`totals.netOre`	`integer \| null`	Ja	Hele øre (1 kr = 100 øre)
`totals.vatOre`	`integer \| null`	Ja	Hele øre (1 kr = 100 øre)
`totals.grossOre`	`integer \| null`	Ja	Hele øre (1 kr = 100 øre)
`totals.currency`	`"NOK"`	Ja
`totals.priceStatus`	`"priced" \| "partial" \| "in_kalkyle" \| "hidden"`	Ja	`priced`: alle linjer har pris; `partial`: noen linjer venter på pris; `in_kalkyle`: prisen står i kalkylen; `hidden`: skjult for en kundenøkkel. Beløpene er `null` når de ikke er kjent.
`hasKalkyle`	`boolean \| null`	Ja	Om ordren er priset i en kalkyle; null for en kundenøkkel.
`stickerNumbers`	`integer[]`	Ja	Lappnumrene som er knyttet til ordren.
`readyWithoutReceipt`	`boolean`	Ja	«Klar uten mottak».
`readySms`	`object \| null`	Ja	Klar-SMS-en: status og tider, aldri nummer eller tekst. Null for en kundenøkkel.
`readySms.status`	`"queued" \| "cancelled" \| "sending" \| "sent" \| "delivered" \| "failed"`	Ja
`readySms.sendAfter`	`string \| null`	Ja	Tidspunkt, ISO 8601 i UTC
`readySms.sentAt`	`string \| null`	Ja	Tidspunkt, ISO 8601 i UTC
`invoice`	`object \| null`	Ja
`invoice.id`	`string`	Ja	UUID
`invoice.kind`	`"invoice" \| "credit_note" \| "erp_mark"`	Ja
`invoice.number`	`string \| null`	Ja
`invoice.issuedAt`	`string \| null`	Ja	Tidspunkt, ISO 8601 i UTC
`invoice.erpNo`	`string \| null`	Ja
`attachments`	`Attachment[]`	Ja
`externalRef`	`string \| null`	Ja	Din egen id for ordren, unik per nøkkel.
`createdAt`	`string`	Ja	Tidspunkt, ISO 8601 i UTC
`receivedAt`	`string \| null`	Ja	Tidspunkt, ISO 8601 i UTC
`inWorkAt`	`string \| null`	Ja	Tidspunkt, ISO 8601 i UTC
`readyAt`	`string \| null`	Ja	Tidspunkt, ISO 8601 i UTC
`deliveredAt`	`string \| null`	Ja	Tidspunkt, ISO 8601 i UTC
`invoicedAt`	`string \| null`	Ja	Tidspunkt, ISO 8601 i UTC
`paidAt`	`string \| null`	Ja	Tidspunkt, ISO 8601 i UTC
`cancelledAt`	`string \| null`	Ja	Tidspunkt, ISO 8601 i UTC
`cancelReason`	`string \| null`	Ja
`updatedAt`	`string`	Ja	Tidspunkt, ISO 8601 i UTC
`version`	`integer`	Ja	Øker ved hver endring. Send den tilbake i `If-Match: "v<version>"`.
`production`	`OrderProduction \| null`	Nei	Bøyearkene på ordren, når verkstedet har Produksjon; `null` uten Produksjon og for en kundenøkkel. Med i svarene fra ordreoperasjonene, ikke i webhooks og `GET /events`. Et bøyd ark endrer ikke `version`, så når `production` ikke er `null`, svarer `If-None-Match` aldri 304.

Feilkoder

invalid_json · Innholdet er ikke gyldig JSON.
invalid_request · Noe i forespørselen er feil eller ukjent. fields sier hva.
unauthorized · Nø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.
account_closed · Verkstedet er stengt.
dpa_required · Verkstedet må godta databehandleravtalen før koblinger kan brukes.
feature_not_in_plan · Verkstedet har ikke slått på delen dette trenger. feature sier hvilken.
insufficient_scope · Nøkkelen har ikke lov til dette. requiredScope sier hvilken rett som mangler.
not_found · Fant ikke dette.
already_invoiced · Ordren er fakturert og kan ikke endres.
idempotency_in_progress · En forespørsel med samme Idempotency-Key holder på. Prøv igjen om litt.
stale_version · Ordren er endret siden du leste den. Hent den på nytt og send med ny versjon.
status_conflict · Ordren kan ikke flyttes dit fra statusen den har nå. reason sier hvorfor.
date_invalid · Datoen er ikke en gyldig dag (ÅÅÅÅ-MM-DD).
idempotency_key_reused · Denne Idempotency-Key ble brukt på en annen forespørsel. Bruk en ny nøkkel for ny handling.
precondition_required · Send If-Match med versjonen du så, for eksempel "v3".
rate_limited · For mange kall. Vent retryAfterSeconds sekunder.
internal · Noe gikk galt hos oss. Feilen er meldt. Oppgi requestId hvis du spør.

Bekreft en forespørsel

Virker

POST /api/v1/orders/{number}/confirm

Forespørsel → Mottatt, med en kunde fra registeret eller en ny kunde laget fra forespørselen. Den som spurte får bekreftelsen.

Rettigheter	`orders:write`
Kundenøkkel	Nei
Grense	skriving, 30 i minuttet
Overskrifter	`Idempotency-Key (valgfri), If-Match (valgfri)`

Parametre

Felt	Type	Må med	Beskrivelse
`number (path)`	`string`	Ja	«4711», «004711», «T-000012» (testnøkler), eller et lappnummer som er blitt ordrens.
`Idempotency-Key (header)`	`string`	Nei	8–255 tegn. Bruk en UUID per forsøk på en handling; samme nøkkel og samme innhold gir samme svar igjen.
`If-Match (header)`	`string`	Nei	Versjonen du så, som `"v3"` (fra `version` eller `ETag`).

Det du sender

Felt	Type	Må med	Beskrivelse
`customerId`	`string \| null`	Nei	UUID
`createCustomer`	`boolean`	Nei

Svaret (200)

Felt	Type	Må med	Beskrivelse
`id`	`string`	Ja	UUID
`number`	`integer`	Ja	Ordrenummeret i verkstedets serie (testordre har sin egen serie).
`numberDisplay`	`string`	Ja	«004711», eller «T-000012» for en testordre.
`isTest`	`boolean`	Ja
`source`	`"lapp" \| "manuell" \| "tilbud" \| "avrop" \| "nettbutikk" \| "api" \| "import" \| "portal" \| "nettverk"`	Ja	Hvor ordren kom fra (`lapp`, `manuell`, `tilbud`, `avrop`, `nettbutikk`, `api`, `import`). Kan få nye verdier: les en ukjent verdi som «annet».
`channel`	`string \| null`	Ja	Navnet på nøkkelen eller butikkens «kilde»: der ordren kom fra.
`status`	`"forespurt" \| "mottatt" \| "i_arbeid" \| "klar" \| "levert" \| "fakturert" \| "betalt" \| "avbrutt"`	Ja	Lagret status: `forespurt`, `mottatt`, `i_arbeid`, `klar`, `levert`, `fakturert`, `betalt`, `avbrutt`. Stigen får aldri et nytt trinn uten v2.
`statusLabel`	`string`	Ja	Statusen med appens ord: Forespørsel, Mottatt, I arbeid, Klar, Levert/Hentet, Fakturert, Betalt, Avbrutt/Avvist.
`statusChangedAt`	`string`	Ja	Tidspunkt, ISO 8601 i UTC
`customer`	`object \| null`	Ja
`customer.id`	`string`	Ja	UUID
`customer.number`	`integer \| null`	Ja
`customer.name`	`string`	Ja
`contact`	`object \| null`	Ja	Bare så lenge ordren ikke har en kunde (en forespørsel).
`contact.name`	`string`	Ja
`contact.company`	`string \| null`	Ja
`contact.orgNr`	`string \| null`	Ja
`contact.email`	`string \| null`	Ja
`contact.mobile`	`string \| null`	Ja
`projectNo`	`string \| null`	Ja
`orderer`	`string \| null`	Ja
`customerPo`	`string \| null`	Ja
`title`	`string \| null`	Ja
`note`	`string \| null`	Ja
`agreement`	`object \| null`	Ja
`agreement.id`	`string`	Ja	UUID
`delivery`	`object`	Ja
`delivery.mode`	`"henting" \| "levering" \| null`	Ja
`delivery.requestedDate`	`string \| null`	Ja	Dato på Oslo-kalenderen, ÅÅÅÅ-MM-DD
`delivery.deliveryDate`	`string \| null`	Ja	Dato på Oslo-kalenderen, ÅÅÅÅ-MM-DD
`delivery.address`	`object \| null`	Ja
`lines`	`OrderLine[]`	Ja
`totals`	`object`	Ja
`totals.netOre`	`integer \| null`	Ja	Hele øre (1 kr = 100 øre)
`totals.vatOre`	`integer \| null`	Ja	Hele øre (1 kr = 100 øre)
`totals.grossOre`	`integer \| null`	Ja	Hele øre (1 kr = 100 øre)
`totals.currency`	`"NOK"`	Ja
`totals.priceStatus`	`"priced" \| "partial" \| "in_kalkyle" \| "hidden"`	Ja	`priced`: alle linjer har pris; `partial`: noen linjer venter på pris; `in_kalkyle`: prisen står i kalkylen; `hidden`: skjult for en kundenøkkel. Beløpene er `null` når de ikke er kjent.
`hasKalkyle`	`boolean \| null`	Ja	Om ordren er priset i en kalkyle; null for en kundenøkkel.
`stickerNumbers`	`integer[]`	Ja	Lappnumrene som er knyttet til ordren.
`readyWithoutReceipt`	`boolean`	Ja	«Klar uten mottak».
`readySms`	`object \| null`	Ja	Klar-SMS-en: status og tider, aldri nummer eller tekst. Null for en kundenøkkel.
`readySms.status`	`"queued" \| "cancelled" \| "sending" \| "sent" \| "delivered" \| "failed"`	Ja
`readySms.sendAfter`	`string \| null`	Ja	Tidspunkt, ISO 8601 i UTC
`readySms.sentAt`	`string \| null`	Ja	Tidspunkt, ISO 8601 i UTC
`invoice`	`object \| null`	Ja
`invoice.id`	`string`	Ja	UUID
`invoice.kind`	`"invoice" \| "credit_note" \| "erp_mark"`	Ja
`invoice.number`	`string \| null`	Ja
`invoice.issuedAt`	`string \| null`	Ja	Tidspunkt, ISO 8601 i UTC
`invoice.erpNo`	`string \| null`	Ja
`attachments`	`Attachment[]`	Ja
`externalRef`	`string \| null`	Ja	Din egen id for ordren, unik per nøkkel.
`createdAt`	`string`	Ja	Tidspunkt, ISO 8601 i UTC
`receivedAt`	`string \| null`	Ja	Tidspunkt, ISO 8601 i UTC
`inWorkAt`	`string \| null`	Ja	Tidspunkt, ISO 8601 i UTC
`readyAt`	`string \| null`	Ja	Tidspunkt, ISO 8601 i UTC
`deliveredAt`	`string \| null`	Ja	Tidspunkt, ISO 8601 i UTC
`invoicedAt`	`string \| null`	Ja	Tidspunkt, ISO 8601 i UTC
`paidAt`	`string \| null`	Ja	Tidspunkt, ISO 8601 i UTC
`cancelledAt`	`string \| null`	Ja	Tidspunkt, ISO 8601 i UTC
`cancelReason`	`string \| null`	Ja
`updatedAt`	`string`	Ja	Tidspunkt, ISO 8601 i UTC
`version`	`integer`	Ja	Øker ved hver endring. Send den tilbake i `If-Match: "v<version>"`.
`production`	`OrderProduction \| null`	Nei	Bøyearkene på ordren, når verkstedet har Produksjon; `null` uten Produksjon og for en kundenøkkel. Med i svarene fra ordreoperasjonene, ikke i webhooks og `GET /events`. Et bøyd ark endrer ikke `version`, så når `production` ikke er `null`, svarer `If-None-Match` aldri 304.

Feilkoder

invalid_json · Innholdet er ikke gyldig JSON.
invalid_request · Noe i forespørselen er feil eller ukjent. fields sier hva.
unauthorized · Nø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.
account_closed · Verkstedet er stengt.
customer_key_not_allowed · En kundenøkkel kan ikke gjøre dette.
dpa_required · Verkstedet må godta databehandleravtalen før koblinger kan brukes.
feature_not_in_plan · Verkstedet har ikke slått på delen dette trenger. feature sier hvilken.
insufficient_scope · Nøkkelen har ikke lov til dette. requiredScope sier hvilken rett som mangler.
test_key_not_allowed · En testnøkkel kan ikke dette: den endrer aldri kunderegisteret, og et avrop er alltid en ekte ordre.
not_found · Fant ikke dette.
idempotency_in_progress · En forespørsel med samme Idempotency-Key holder på. Prøv igjen om litt.
key_owner_missing · Brukeren som laget nøkkelen finnes ikke lenger. Lag en ny nøkkel.
stale_version · Ordren er endret siden du leste den. Hent den på nytt og send med ny versjon.
status_conflict · Ordren kan ikke flyttes dit fra statusen den har nå. reason sier hvorfor.
customer_invalid · Noe i kundefeltene er feil. fields sier hva.
customer_required · Ordren må ha en kunde. Send customer, eller contact med createCustomer: true.
idempotency_key_reused · Denne Idempotency-Key ble brukt på en annen forespørsel. Bruk en ny nøkkel for ny handling.
rate_limited · For mange kall. Vent retryAfterSeconds sekunder.
internal · Noe gikk galt hos oss. Feilen er meldt. Oppgi requestId hvis du spør.

Avbryt en ordre

Virker

POST /api/v1/orders/{number}/cancel

Med en grunn. En kundenøkkel kan bare trekke tilbake sine egne forespørsler: alt annet kan være i arbeid, og da må kunden ringe.

Rettigheter	`orders:write`
Kundenøkkel	Ja, for sine egne
Grense	skriving, 30 i minuttet
Overskrifter	`Idempotency-Key (valgfri), If-Match (valgfri)`

Parametre

Felt	Type	Må med	Beskrivelse
`number (path)`	`string`	Ja	«4711», «004711», «T-000012» (testnøkler), eller et lappnummer som er blitt ordrens.
`Idempotency-Key (header)`	`string`	Nei	8–255 tegn. Bruk en UUID per forsøk på en handling; samme nøkkel og samme innhold gir samme svar igjen.
`If-Match (header)`	`string`	Nei	Versjonen du så, som `"v3"` (fra `version` eller `ETag`).

Det du sender

Felt	Type	Må med	Beskrivelse
`reason`	`string`	Ja

Svaret (200)

Felt	Type	Må med	Beskrivelse
`id`	`string`	Ja	UUID
`number`	`integer`	Ja	Ordrenummeret i verkstedets serie (testordre har sin egen serie).
`numberDisplay`	`string`	Ja	«004711», eller «T-000012» for en testordre.
`isTest`	`boolean`	Ja
`source`	`"lapp" \| "manuell" \| "tilbud" \| "avrop" \| "nettbutikk" \| "api" \| "import" \| "portal" \| "nettverk"`	Ja	Hvor ordren kom fra (`lapp`, `manuell`, `tilbud`, `avrop`, `nettbutikk`, `api`, `import`). Kan få nye verdier: les en ukjent verdi som «annet».
`channel`	`string \| null`	Ja	Navnet på nøkkelen eller butikkens «kilde»: der ordren kom fra.
`status`	`"forespurt" \| "mottatt" \| "i_arbeid" \| "klar" \| "levert" \| "fakturert" \| "betalt" \| "avbrutt"`	Ja	Lagret status: `forespurt`, `mottatt`, `i_arbeid`, `klar`, `levert`, `fakturert`, `betalt`, `avbrutt`. Stigen får aldri et nytt trinn uten v2.
`statusLabel`	`string`	Ja	Statusen med appens ord: Forespørsel, Mottatt, I arbeid, Klar, Levert/Hentet, Fakturert, Betalt, Avbrutt/Avvist.
`statusChangedAt`	`string`	Ja	Tidspunkt, ISO 8601 i UTC
`customer`	`object \| null`	Ja
`customer.id`	`string`	Ja	UUID
`customer.number`	`integer \| null`	Ja
`customer.name`	`string`	Ja
`contact`	`object \| null`	Ja	Bare så lenge ordren ikke har en kunde (en forespørsel).
`contact.name`	`string`	Ja
`contact.company`	`string \| null`	Ja
`contact.orgNr`	`string \| null`	Ja
`contact.email`	`string \| null`	Ja
`contact.mobile`	`string \| null`	Ja
`projectNo`	`string \| null`	Ja
`orderer`	`string \| null`	Ja
`customerPo`	`string \| null`	Ja
`title`	`string \| null`	Ja
`note`	`string \| null`	Ja
`agreement`	`object \| null`	Ja
`agreement.id`	`string`	Ja	UUID
`delivery`	`object`	Ja
`delivery.mode`	`"henting" \| "levering" \| null`	Ja
`delivery.requestedDate`	`string \| null`	Ja	Dato på Oslo-kalenderen, ÅÅÅÅ-MM-DD
`delivery.deliveryDate`	`string \| null`	Ja	Dato på Oslo-kalenderen, ÅÅÅÅ-MM-DD
`delivery.address`	`object \| null`	Ja
`lines`	`OrderLine[]`	Ja
`totals`	`object`	Ja
`totals.netOre`	`integer \| null`	Ja	Hele øre (1 kr = 100 øre)
`totals.vatOre`	`integer \| null`	Ja	Hele øre (1 kr = 100 øre)
`totals.grossOre`	`integer \| null`	Ja	Hele øre (1 kr = 100 øre)
`totals.currency`	`"NOK"`	Ja
`totals.priceStatus`	`"priced" \| "partial" \| "in_kalkyle" \| "hidden"`	Ja	`priced`: alle linjer har pris; `partial`: noen linjer venter på pris; `in_kalkyle`: prisen står i kalkylen; `hidden`: skjult for en kundenøkkel. Beløpene er `null` når de ikke er kjent.
`hasKalkyle`	`boolean \| null`	Ja	Om ordren er priset i en kalkyle; null for en kundenøkkel.
`stickerNumbers`	`integer[]`	Ja	Lappnumrene som er knyttet til ordren.
`readyWithoutReceipt`	`boolean`	Ja	«Klar uten mottak».
`readySms`	`object \| null`	Ja	Klar-SMS-en: status og tider, aldri nummer eller tekst. Null for en kundenøkkel.
`readySms.status`	`"queued" \| "cancelled" \| "sending" \| "sent" \| "delivered" \| "failed"`	Ja
`readySms.sendAfter`	`string \| null`	Ja	Tidspunkt, ISO 8601 i UTC
`readySms.sentAt`	`string \| null`	Ja	Tidspunkt, ISO 8601 i UTC
`invoice`	`object \| null`	Ja
`invoice.id`	`string`	Ja	UUID
`invoice.kind`	`"invoice" \| "credit_note" \| "erp_mark"`	Ja
`invoice.number`	`string \| null`	Ja
`invoice.issuedAt`	`string \| null`	Ja	Tidspunkt, ISO 8601 i UTC
`invoice.erpNo`	`string \| null`	Ja
`attachments`	`Attachment[]`	Ja
`externalRef`	`string \| null`	Ja	Din egen id for ordren, unik per nøkkel.
`createdAt`	`string`	Ja	Tidspunkt, ISO 8601 i UTC
`receivedAt`	`string \| null`	Ja	Tidspunkt, ISO 8601 i UTC
`inWorkAt`	`string \| null`	Ja	Tidspunkt, ISO 8601 i UTC
`readyAt`	`string \| null`	Ja	Tidspunkt, ISO 8601 i UTC
`deliveredAt`	`string \| null`	Ja	Tidspunkt, ISO 8601 i UTC
`invoicedAt`	`string \| null`	Ja	Tidspunkt, ISO 8601 i UTC
`paidAt`	`string \| null`	Ja	Tidspunkt, ISO 8601 i UTC
`cancelledAt`	`string \| null`	Ja	Tidspunkt, ISO 8601 i UTC
`cancelReason`	`string \| null`	Ja
`updatedAt`	`string`	Ja	Tidspunkt, ISO 8601 i UTC
`version`	`integer`	Ja	Øker ved hver endring. Send den tilbake i `If-Match: "v<version>"`.
`production`	`OrderProduction \| null`	Nei	Bøyearkene på ordren, når verkstedet har Produksjon; `null` uten Produksjon og for en kundenøkkel. Med i svarene fra ordreoperasjonene, ikke i webhooks og `GET /events`. Et bøyd ark endrer ikke `version`, så når `production` ikke er `null`, svarer `If-None-Match` aldri 304.

Feilkoder

invalid_json · Innholdet er ikke gyldig JSON.
invalid_request · Noe i forespørselen er feil eller ukjent. fields sier hva.
unauthorized · Nø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.
account_closed · Verkstedet er stengt.
dpa_required · Verkstedet må godta databehandleravtalen før koblinger kan brukes.
feature_not_in_plan · Verkstedet har ikke slått på delen dette trenger. feature sier hvilken.
insufficient_scope · Nøkkelen har ikke lov til dette. requiredScope sier hvilken rett som mangler.
not_found · Fant ikke dette.
already_invoiced · Ordren er fakturert og kan ikke endres.
cancel_not_allowed · Ordren kan ikke avbrytes nå. Ring verkstedet: arbeidet kan være i gang.
idempotency_in_progress · En forespørsel med samme Idempotency-Key holder på. Prøv igjen om litt.
stale_version · Ordren er endret siden du leste den. Hent den på nytt og send med ny versjon.
status_conflict · Ordren kan ikke flyttes dit fra statusen den har nå. reason sier hvorfor.
idempotency_key_reused · Denne Idempotency-Key ble brukt på en annen forespørsel. Bruk en ny nøkkel for ny handling.
rate_limited · For mange kall. Vent retryAfterSeconds sekunder.
internal · Noe gikk galt hos oss. Feilen er meldt. Oppgi requestId hvis du spør.

I arbeid, Klar, Levert eller Angre

Virker

POST /api/v1/orders/{number}/status

Klar sender kunden SMS etter verkstedets angrefrist (eller ingen med "sms": "skip"); svaret har den nøyaktige teksten. En ny Klar på en klar ordre endrer ingenting og sender ingen ny SMS. mottatt fra Klar eller Levert er «Angre».

Rettigheter	`orders:status`
Kundenøkkel	Nei
Grense	skriving, 30 i minuttet
Overskrifter	`Idempotency-Key (valgfri), If-Match (valgfri)`

Parametre

Felt	Type	Må med	Beskrivelse
`number (path)`	`string`	Ja	«4711», «004711», «T-000012» (testnøkler), eller et lappnummer som er blitt ordrens.
`Idempotency-Key (header)`	`string`	Nei	8–255 tegn. Bruk en UUID per forsøk på en handling; samme nøkkel og samme innhold gir samme svar igjen.
`If-Match (header)`	`string`	Nei	Versjonen du så, som `"v3"` (fra `version` eller `ETag`).

Det du sender

Felt	Type	Må med	Beskrivelse
`to`	`"i_arbeid" \| "klar" \| "levert" \| "mottatt"`	Ja	`mottatt` fra `klar` eller `levert` er «Angre» (en SMS som ennå venter, stoppes).
`sms`	`"auto" \| "skip"`	Nei	Ved `klar`: `auto` (standard) sender SMS etter angrefristen; `skip` sender ingen.
`deliveryDate`	`string \| null`	Nei	Dato på Oslo-kalenderen, ÅÅÅÅ-MM-DD
`deliveryMode`	`"henting" \| "levering" \| null`	Nei

Svaret (200)

Felt	Type	Må med	Beskrivelse
`order`	`Order`	Ja
`sms`	`object \| null`	Ja
`sms.willSend`	`boolean`	Ja
`sms.reason`	`string \| null`	Ja	Hvorfor ingen SMS går, når ingen går.
`sms.text`	`string`	Ja	Den nøyaktige teksten, sendt eller ikke.
`sms.sendAfter`	`string \| null`	Ja	Tidspunkt, ISO 8601 i UTC

Feilkoder

invalid_json · Innholdet er ikke gyldig JSON.
invalid_request · Noe i forespørselen er feil eller ukjent. fields sier hva.
unauthorized · Nø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.
account_closed · Verkstedet er stengt.
customer_key_not_allowed · En kundenøkkel kan ikke gjøre dette.
dpa_required · Verkstedet må godta databehandleravtalen før koblinger kan brukes.
feature_not_in_plan · Verkstedet har ikke slått på delen dette trenger. feature sier hvilken.
insufficient_scope · Nøkkelen har ikke lov til dette. requiredScope sier hvilken rett som mangler.
not_found · Fant ikke dette.
already_invoiced · Ordren er fakturert og kan ikke endres.
idempotency_in_progress · En forespørsel med samme Idempotency-Key holder på. Prøv igjen om litt.
not_ready · Ordren er ikke klar.
stale_version · Ordren er endret siden du leste den. Hent den på nytt og send med ny versjon.
status_conflict · Ordren kan ikke flyttes dit fra statusen den har nå. reason sier hvorfor.
date_invalid · Datoen er ikke en gyldig dag (ÅÅÅÅ-MM-DD).
idempotency_key_reused · Denne Idempotency-Key ble brukt på en annen forespørsel. Bruk en ny nøkkel for ny handling.
rate_limited · For mange kall. Vent retryAfterSeconds sekunder.
internal · Noe gikk galt hos oss. Feilen er meldt. Oppgi requestId hvis du spør.

Legg ved et bilde, en tegning eller en PDF

Virker

POST /api/v1/orders/{number}/attachments

multipart/form-data med fil og type. Typen leses fra filens første byte, ikke fra navnet.

Rettigheter	`orders:write`
Kundenøkkel	Ja, for sine egne
Grense	filer, 10 i minuttet
Overskrifter	`Idempotency-Key (valgfri)`

Parametre

Felt	Type	Må med	Beskrivelse
`number (path)`	`string`	Ja	«4711», «004711», «T-000012» (testnøkler), eller et lappnummer som er blitt ordrens.
`Idempotency-Key (header)`	`string`	Nei	8–255 tegn. Bruk en UUID per forsøk på en handling; samme nøkkel og samme innhold gir samme svar igjen.

Det du sender

Felt	Type	Må med	Beskrivelse
`fil`	`string`	Ja	Filen: JPEG, PNG, WebP, HEIC eller PDF, høyst 15 MB. Typen leses fra filens første byte.
`type`	`"foto" \| "tegning" \| "pdf"`	Ja	foto, tegning eller pdf

Svaret (201)

Felt	Type	Må med	Beskrivelse
`id`	`string`	Ja	UUID
`kind`	`"foto" \| "tegning" \| "pdf"`	Ja
`contentType`	`string`	Ja
`bytes`	`integer`	Ja
`createdAt`	`string`	Ja	Tidspunkt, ISO 8601 i UTC

Feilkoder

invalid_request · Noe i forespørselen er feil eller ukjent. fields sier hva.
unauthorized · Nø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.
account_closed · Verkstedet er stengt.
dpa_required · Verkstedet må godta databehandleravtalen før koblinger kan brukes.
feature_not_in_plan · Verkstedet har ikke slått på delen dette trenger. feature sier hvilken.
insufficient_scope · Nøkkelen har ikke lov til dette. requiredScope sier hvilken rett som mangler.
not_found · Fant ikke dette.
idempotency_in_progress · En forespørsel med samme Idempotency-Key holder på. Prøv igjen om litt.
status_conflict · Ordren kan ikke flyttes dit fra statusen den har nå. reason sier hvorfor.
payload_too_large · Filen er for stor.
unsupported_media_type · Filtypen tas ikke imot. Send JPEG, PNG, WebP, HEIC eller PDF.
idempotency_key_reused · Denne Idempotency-Key ble brukt på en annen forespørsel. Bruk en ny nøkkel for ny handling.
too_many_attachments · Ordren har allerede så mange filer som den kan ha.
rate_limited · For mange kall. Vent retryAfterSeconds sekunder.
internal · Noe gikk galt hos oss. Feilen er meldt. Oppgi requestId hvis du spør.

Hent en fil

Virker

GET /api/v1/orders/{number}/attachments/{id}

Svarer 302 til en lenke som lever i fem minutter.

Rettigheter	`orders:read`
Kundenøkkel	Ja, for sine egne
Grense	lesing, 120 i minuttet

Parametre

Felt	Type	Må med	Beskrivelse
`number (path)`	`string`	Ja	«4711», «004711», «T-000012» (testnøkler), eller et lappnummer som er blitt ordrens.
`id (path)`	`string`	Ja	UUID

Svaret: 302 · Videre til filen (lenken lever i fem minutter)

Feilkoder

invalid_request · Noe i forespørselen er feil eller ukjent. fields sier hva.
unauthorized · Nø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.
account_closed · Verkstedet er stengt.
dpa_required · Verkstedet må godta databehandleravtalen før koblinger kan brukes.
feature_not_in_plan · Verkstedet har ikke slått på delen dette trenger. feature sier hvilken.
insufficient_scope · Nøkkelen har ikke lov til dette. requiredScope sier hvilken rett som mangler.
not_found · Fant ikke dette.
rate_limited · For mange kall. Vent retryAfterSeconds sekunder.
internal · Noe gikk galt hos oss. Feilen er meldt. Oppgi requestId hvis du spør.

Ordrens tidslinje

Virker

GET /api/v1/orders/{number}/events

Hvert steg med fra- og til-status, hvem (som type, aldri navn) og når.

Rettigheter	`orders:read`
Kundenøkkel	Ja, for sine egne
Grense	lesing, 120 i minuttet

Parametre

Felt	Type	Må med	Beskrivelse
`number (path)`	`string`	Ja	«4711», «004711», «T-000012» (testnøkler), eller et lappnummer som er blitt ordrens.

Svaret (200)

Felt	Type	Må med	Beskrivelse
`data`	`OrderEvent[]`	Ja

Feilkoder

invalid_request · Noe i forespørselen er feil eller ukjent. fields sier hva.
unauthorized · Nø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.
account_closed · Verkstedet er stengt.
dpa_required · Verkstedet må godta databehandleravtalen før koblinger kan brukes.
feature_not_in_plan · Verkstedet har ikke slått på delen dette trenger. feature sier hvilken.
insufficient_scope · Nøkkelen har ikke lov til dette. requiredScope sier hvilken rett som mangler.
not_found · Fant ikke dette.
rate_limited · For mange kall. Vent retryAfterSeconds sekunder.
internal · Noe gikk galt hos oss. Feilen er meldt. Oppgi requestId hvis du spør.

Kunder

List kunder

Virker

GET /api/v1/customers

Etter kundenummer, eller etter endring for å synkronisere. Søk med q.

Rettigheter	`customers:read`
Kundenøkkel	Nei
Grense	lesing, 120 i minuttet

Parametre

Felt	Type	Må med	Beskrivelse
`q (query)`	`string`	Nei	Søk i navn, org.nr. eller telefon.
`updatedSince (query)`	`string`	Nei	Tidspunkt, ISO 8601 i UTC
`includeArchived (query)`	`boolean`	Nei
`sort (query)`	`"number" \| "updatedAt"`	Nei	Etter kundenummer (`number`, standard) eller etter endring (`updatedAt`).
`limit (query)`	`integer`	Nei	Antall per side, 1–100 (25 når den mangler).
`cursor (query)`	`string`	Nei	`nextCursor` fra forrige side.

Svaret (200)

Felt	Type	Må med	Beskrivelse
`data`	`Customer[]`	Ja
`nextCursor`	`string \| null`	Ja	Gi denne som `cursor` for neste side; `null` når det ikke er flere.

Feilkoder

invalid_cursor · Markøren (cursor) er ikke en vi har gitt ut.
invalid_request · Noe i forespørselen er feil eller ukjent. fields sier hva.
unauthorized · Nø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.
account_closed · Verkstedet er stengt.
customer_key_not_allowed · En kundenøkkel kan ikke gjøre dette.
dpa_required · Verkstedet må godta databehandleravtalen før koblinger kan brukes.
feature_not_in_plan · Verkstedet har ikke slått på delen dette trenger. feature sier hvilken.
insufficient_scope · Nøkkelen har ikke lov til dette. requiredScope sier hvilken rett som mangler.
rate_limited · For mange kall. Vent retryAfterSeconds sekunder.
internal · Noe gikk galt hos oss. Feilen er meldt. Oppgi requestId hvis du spør.

Hent en kunde

Virker

GET /api/v1/customers/{id}

Med kontakt, adresser og innstillingene ordrene leser (SMS, prosjektnr, faste dager).

Rettigheter	`customers:read`
Kundenøkkel	Nei
Grense	lesing, 120 i minuttet

Parametre

Felt	Type	Må med	Beskrivelse
`id (path)`	`string`	Ja	UUID

Svaret (200)

Felt	Type	Må med	Beskrivelse
`id`	`string`	Ja	UUID
`number`	`integer \| null`	Ja	Kundenummeret i registeret (1, 2, 3 …).
`kind`	`"firma" \| "privat"`	Ja
`name`	`string`	Ja
`orgNr`	`string \| null`	Ja
`contactPerson`	`string \| null`	Ja
`email`	`string \| null`	Ja
`mobile`	`string \| null`	Ja	Nummeret Klar-SMS går til, +47…
`phone`	`string \| null`	Ja
`invoiceAddress`	`object \| null`	Ja
`invoiceAddress.line`	`string \| null`	Ja
`invoiceAddress.postalCode`	`string \| null`	Ja
`invoiceAddress.city`	`string \| null`	Ja
`invoiceAddress.country`	`string \| null`	Ja
`deliveryAddress`	`object \| null`	Ja
`deliveryAddress.line`	`string \| null`	Ja
`deliveryAddress.postalCode`	`string \| null`	Ja
`deliveryAddress.city`	`string \| null`	Ja
`deliveryAddress.country`	`string \| null`	Ja
`invoicingMode`	`"per_ordre" \| "per_prosjekt" \| "prosjekt_mnd"`	Ja
`requiresProjectNo`	`boolean`	Ja	«Krever prosjektnr»: en ordre uten prosjektnummer blir avvist.
`requiresOrderer`	`boolean`	Ja	«Krever bestiller».
`smsOnReady`	`boolean`	Ja
`deliveryWeekdays`	`integer[] \| null`	Ja	Faste leveringsdager, 1 = mandag … 7 = søndag.
`erpRefs`	`object[]`	Ja	Kunden i regnskapet. Da eier regnskapet navn og org.nr.
`archived`	`boolean`	Ja
`createdAt`	`string`	Ja	Tidspunkt, ISO 8601 i UTC
`updatedAt`	`string`	Ja	Tidspunkt, ISO 8601 i UTC

Feilkoder

invalid_request · Noe i forespørselen er feil eller ukjent. fields sier hva.
unauthorized · Nø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.
account_closed · Verkstedet er stengt.
customer_key_not_allowed · En kundenøkkel kan ikke gjøre dette.
dpa_required · Verkstedet må godta databehandleravtalen før koblinger kan brukes.
feature_not_in_plan · Verkstedet har ikke slått på delen dette trenger. feature sier hvilken.
insufficient_scope · Nøkkelen har ikke lov til dette. requiredScope sier hvilken rett som mangler.
not_found · Fant ikke dette.
rate_limited · For mange kall. Vent retryAfterSeconds sekunder.
internal · Noe gikk galt hos oss. Feilen er meldt. Oppgi requestId hvis du spør.

Legg til en kunde

Virker

POST /api/v1/customers

Org.nr. sjekkes; samme org.nr. to ganger gir 409 med den første kundens id. Ikke med en testnøkkel.

Rettigheter	`customers:write`
Kundenøkkel	Nei
Grense	skriving, 30 i minuttet
Overskrifter	`Idempotency-Key`

Parametre

Felt	Type	Må med	Beskrivelse
`Idempotency-Key (header)`	`string`	Ja	8–255 tegn. Bruk en UUID per forsøk på en handling; samme nøkkel og samme innhold gir samme svar igjen.

Det du sender

Felt	Type	Må med
`name`	`string`	Ja
`kind`	`"firma" \| "privat"`	Nei
`orgNr`	`string \| null`	Nei
`contactPerson`	`string \| null`	Nei
`email`	`string \| null`	Nei
`mobile`	`string \| null`	Nei
`phone`	`string \| null`	Nei
`invoiceAddress`	`object \| null`	Nei
`invoiceAddress.line`	`string \| null`	Nei
`invoiceAddress.postalCode`	`string \| null`	Nei
`invoiceAddress.city`	`string \| null`	Nei
`invoiceAddress.country`	`string \| null`	Nei
`deliveryAddress`	`object \| null`	Nei
`deliveryAddress.line`	`string \| null`	Nei
`deliveryAddress.postalCode`	`string \| null`	Nei
`deliveryAddress.city`	`string \| null`	Nei
`deliveryAddress.country`	`string \| null`	Nei
`smsOnReady`	`boolean`	Nei
`invoicingMode`	`"per_ordre" \| "per_prosjekt" \| "prosjekt_mnd"`	Nei
`requiresProjectNo`	`boolean`	Nei
`requiresOrderer`	`boolean`	Nei
`deliveryWeekdays`	`integer[] \| null`	Nei

Svaret (201)

Felt	Type	Må med	Beskrivelse
`id`	`string`	Ja	UUID
`number`	`integer \| null`	Ja	Kundenummeret i registeret (1, 2, 3 …).
`kind`	`"firma" \| "privat"`	Ja
`name`	`string`	Ja
`orgNr`	`string \| null`	Ja
`contactPerson`	`string \| null`	Ja
`email`	`string \| null`	Ja
`mobile`	`string \| null`	Ja	Nummeret Klar-SMS går til, +47…
`phone`	`string \| null`	Ja
`invoiceAddress`	`object \| null`	Ja
`invoiceAddress.line`	`string \| null`	Ja
`invoiceAddress.postalCode`	`string \| null`	Ja
`invoiceAddress.city`	`string \| null`	Ja
`invoiceAddress.country`	`string \| null`	Ja
`deliveryAddress`	`object \| null`	Ja
`deliveryAddress.line`	`string \| null`	Ja
`deliveryAddress.postalCode`	`string \| null`	Ja
`deliveryAddress.city`	`string \| null`	Ja
`deliveryAddress.country`	`string \| null`	Ja
`invoicingMode`	`"per_ordre" \| "per_prosjekt" \| "prosjekt_mnd"`	Ja
`requiresProjectNo`	`boolean`	Ja	«Krever prosjektnr»: en ordre uten prosjektnummer blir avvist.
`requiresOrderer`	`boolean`	Ja	«Krever bestiller».
`smsOnReady`	`boolean`	Ja
`deliveryWeekdays`	`integer[] \| null`	Ja	Faste leveringsdager, 1 = mandag … 7 = søndag.
`erpRefs`	`object[]`	Ja	Kunden i regnskapet. Da eier regnskapet navn og org.nr.
`archived`	`boolean`	Ja
`createdAt`	`string`	Ja	Tidspunkt, ISO 8601 i UTC
`updatedAt`	`string`	Ja	Tidspunkt, ISO 8601 i UTC

Feilkoder

invalid_json · Innholdet er ikke gyldig JSON.
invalid_request · Noe i forespørselen er feil eller ukjent. fields sier hva.
unauthorized · Nø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.
account_closed · Verkstedet er stengt.
customer_key_not_allowed · En kundenøkkel kan ikke gjøre dette.
dpa_required · Verkstedet må godta databehandleravtalen før koblinger kan brukes.
feature_not_in_plan · Verkstedet har ikke slått på delen dette trenger. feature sier hvilken.
insufficient_scope · Nøkkelen har ikke lov til dette. requiredScope sier hvilken rett som mangler.
test_key_not_allowed · En testnøkkel kan ikke dette: den endrer aldri kunderegisteret, og et avrop er alltid en ekte ordre.
customer_exists · En kunde med dette org.nr. finnes allerede. id er kunden.
idempotency_in_progress · En forespørsel med samme Idempotency-Key holder på. Prøv igjen om litt.
key_owner_missing · Brukeren som laget nøkkelen finnes ikke lenger. Lag en ny nøkkel.
customer_invalid · Noe i kundefeltene er feil. fields sier hva.
idempotency_key_reused · Denne Idempotency-Key ble brukt på en annen forespørsel. Bruk en ny nøkkel for ny handling.
idempotency_key_required · Send Idempotency-Key med denne forespørselen.
rate_limited · For mange kall. Vent retryAfterSeconds sekunder.
internal · Noe gikk galt hos oss. Feilen er meldt. Oppgi requestId hvis du spør.

Endre en kunde

Virker

PATCH /api/v1/customers/{id}

Navn og org.nr. eies av regnskapet når kunden finnes der.

Rettigheter	`customers:write`
Kundenøkkel	Nei
Grense	skriving, 30 i minuttet
Overskrifter	`Idempotency-Key (valgfri)`

Parametre

Felt	Type	Må med	Beskrivelse
`id (path)`	`string`	Ja	UUID
`Idempotency-Key (header)`	`string`	Nei	8–255 tegn. Bruk en UUID per forsøk på en handling; samme nøkkel og samme innhold gir samme svar igjen.

Det du sender

Felt	Type	Må med
`name`	`string`	Nei
`kind`	`"firma" \| "privat"`	Nei
`orgNr`	`string \| null`	Nei
`contactPerson`	`string \| null`	Nei
`email`	`string \| null`	Nei
`mobile`	`string \| null`	Nei
`phone`	`string \| null`	Nei
`invoiceAddress`	`object \| null`	Nei
`invoiceAddress.line`	`string \| null`	Nei
`invoiceAddress.postalCode`	`string \| null`	Nei
`invoiceAddress.city`	`string \| null`	Nei
`invoiceAddress.country`	`string \| null`	Nei
`deliveryAddress`	`object \| null`	Nei
`deliveryAddress.line`	`string \| null`	Nei
`deliveryAddress.postalCode`	`string \| null`	Nei
`deliveryAddress.city`	`string \| null`	Nei
`deliveryAddress.country`	`string \| null`	Nei
`smsOnReady`	`boolean`	Nei
`invoicingMode`	`"per_ordre" \| "per_prosjekt" \| "prosjekt_mnd"`	Nei
`requiresProjectNo`	`boolean`	Nei
`requiresOrderer`	`boolean`	Nei
`deliveryWeekdays`	`integer[] \| null`	Nei

Svaret (200)

Felt	Type	Må med	Beskrivelse
`id`	`string`	Ja	UUID
`number`	`integer \| null`	Ja	Kundenummeret i registeret (1, 2, 3 …).
`kind`	`"firma" \| "privat"`	Ja
`name`	`string`	Ja
`orgNr`	`string \| null`	Ja
`contactPerson`	`string \| null`	Ja
`email`	`string \| null`	Ja
`mobile`	`string \| null`	Ja	Nummeret Klar-SMS går til, +47…
`phone`	`string \| null`	Ja
`invoiceAddress`	`object \| null`	Ja
`invoiceAddress.line`	`string \| null`	Ja
`invoiceAddress.postalCode`	`string \| null`	Ja
`invoiceAddress.city`	`string \| null`	Ja
`invoiceAddress.country`	`string \| null`	Ja
`deliveryAddress`	`object \| null`	Ja
`deliveryAddress.line`	`string \| null`	Ja
`deliveryAddress.postalCode`	`string \| null`	Ja
`deliveryAddress.city`	`string \| null`	Ja
`deliveryAddress.country`	`string \| null`	Ja
`invoicingMode`	`"per_ordre" \| "per_prosjekt" \| "prosjekt_mnd"`	Ja
`requiresProjectNo`	`boolean`	Ja	«Krever prosjektnr»: en ordre uten prosjektnummer blir avvist.
`requiresOrderer`	`boolean`	Ja	«Krever bestiller».
`smsOnReady`	`boolean`	Ja
`deliveryWeekdays`	`integer[] \| null`	Ja	Faste leveringsdager, 1 = mandag … 7 = søndag.
`erpRefs`	`object[]`	Ja	Kunden i regnskapet. Da eier regnskapet navn og org.nr.
`archived`	`boolean`	Ja
`createdAt`	`string`	Ja	Tidspunkt, ISO 8601 i UTC
`updatedAt`	`string`	Ja	Tidspunkt, ISO 8601 i UTC

Feilkoder

invalid_json · Innholdet er ikke gyldig JSON.
invalid_request · Noe i forespørselen er feil eller ukjent. fields sier hva.
unauthorized · Nø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.
account_closed · Verkstedet er stengt.
customer_key_not_allowed · En kundenøkkel kan ikke gjøre dette.
dpa_required · Verkstedet må godta databehandleravtalen før koblinger kan brukes.
feature_not_in_plan · Verkstedet har ikke slått på delen dette trenger. feature sier hvilken.
insufficient_scope · Nøkkelen har ikke lov til dette. requiredScope sier hvilken rett som mangler.
test_key_not_allowed · En testnøkkel kan ikke dette: den endrer aldri kunderegisteret, og et avrop er alltid en ekte ordre.
not_found · Fant ikke dette.
customer_exists · En kunde med dette org.nr. finnes allerede. id er kunden.
erp_owned_field · Navn og org.nr. eies av regnskapet for denne kunden. Endre dem der.
idempotency_in_progress · En forespørsel med samme Idempotency-Key holder på. Prøv igjen om litt.
customer_invalid · Noe i kundefeltene er feil. fields sier hva.
idempotency_key_reused · Denne Idempotency-Key ble brukt på en annen forespørsel. Bruk en ny nøkkel for ny handling.
rate_limited · For mange kall. Vent retryAfterSeconds sekunder.
internal · Noe gikk galt hos oss. Feilen er meldt. Oppgi requestId hvis du spør.

Kundens prosjekter

Virker

GET /api/v1/customers/{id}/projects

Prosjektnummer, navn, byggeplass og fast bestiller.

Rettigheter	`customers:read`
Kundenøkkel	Nei
Grense	lesing, 120 i minuttet

Parametre

Felt	Type	Må med	Beskrivelse
`id (path)`	`string`	Ja	UUID

Svaret (200)

Felt	Type	Må med	Beskrivelse
`data`	`Project[]`	Ja

Feilkoder

invalid_request · Noe i forespørselen er feil eller ukjent. fields sier hva.
unauthorized · Nø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.
account_closed · Verkstedet er stengt.
customer_key_not_allowed · En kundenøkkel kan ikke gjøre dette.
dpa_required · Verkstedet må godta databehandleravtalen før koblinger kan brukes.
feature_not_in_plan · Verkstedet har ikke slått på delen dette trenger. feature sier hvilken.
insufficient_scope · Nøkkelen har ikke lov til dette. requiredScope sier hvilken rett som mangler.
not_found · Fant ikke dette.
rate_limited · For mange kall. Vent retryAfterSeconds sekunder.
internal · Noe gikk galt hos oss. Feilen er meldt. Oppgi requestId hvis du spør.

Hendelser

Hendelser du kan ha gått glipp av

Virker

GET /api/v1/events

De samme konvoluttene som webhooks sender, 30 dager tilbake, eldste først etter after. For en mottaker som var nede, eller for den som heller spør.

Rettigheter	`orders:read`
Kundenøkkel	Ja, for sine egne
Grense	lesing, 120 i minuttet

Parametre

Felt	Type	Må med	Beskrivelse
`after (query)`	`string`	Nei	Id-en til den siste hendelsen du har.
`types (query)`	`string`	Nei	Typer med komma: `order.ready,order.delivered`.
`limit (query)`	`integer`	Nei

Svaret (200)

Felt	Type	Må med	Beskrivelse
`data`	`object[]`	Ja
`nextCursor`	`string \| null`	Ja	Gi denne som `after` for neste side.

Feilkoder

invalid_request · Noe i forespørselen er feil eller ukjent. fields sier hva.
unauthorized · Nø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.
account_closed · Verkstedet er stengt.
dpa_required · Verkstedet må godta databehandleravtalen før koblinger kan brukes.
feature_not_in_plan · Verkstedet har ikke slått på delen dette trenger. feature sier hvilken.
insufficient_scope · Nøkkelen har ikke lov til dette. requiredScope sier hvilken rett som mangler.
rate_limited · For mange kall. Vent retryAfterSeconds sekunder.
internal · Noe gikk galt hos oss. Feilen er meldt. Oppgi requestId hvis du spør.

Katalog og priser

Beslagsbiblioteket verkstedet kan selge

Virker

GET /api/v1/catalog/library

Familiene i vbeslag-biblioteket som verkstedet kan selge nå.

Rettigheter	`catalog:read`
Kundenøkkel	Nei
Grense	lesing, 120 i minuttet

Svaret (200)

Felt	Type	Må med	Beskrivelse
`data`	`LibraryEntry[]`	Ja

Feilkoder

unauthorized · Nø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.
account_closed · Verkstedet er stengt.
customer_key_not_allowed · En kundenøkkel kan ikke gjøre dette.
dpa_required · Verkstedet må godta databehandleravtalen før koblinger kan brukes.
feature_not_in_plan · Verkstedet har ikke slått på delen dette trenger. feature sier hvilken.
insufficient_scope · Nøkkelen har ikke lov til dette. requiredScope sier hvilken rett som mangler.
rate_limited · For mange kall. Vent retryAfterSeconds sekunder.
internal · Noe gikk galt hos oss. Feilen er meldt. Oppgi requestId hvis du spør.

Beslagene i nettbutikken

Virker

GET /api/v1/catalog/products

Butikkens publiserte beslag, i samme form som butikken viser dem.

Rettigheter	`catalog:read`
Kundenøkkel	Ja, for sine egne
Grense	lesing, 120 i minuttet

Parametre

Felt	Type	Må med	Beskrivelse
`limit (query)`	`integer`	Nei	Antall per side, 1–100 (25 når den mangler).
`cursor (query)`	`string`	Nei	`nextCursor` fra forrige side.

Svaret (200)

Felt	Type	Må med	Beskrivelse
`data`	`Product[]`	Ja
`nextCursor`	`string \| null`	Ja

Feilkoder

invalid_cursor · Markøren (cursor) er ikke en vi har gitt ut.
invalid_request · Noe i forespørselen er feil eller ukjent. fields sier hva.
unauthorized · Nø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.
account_closed · Verkstedet er stengt.
dpa_required · Verkstedet må godta databehandleravtalen før koblinger kan brukes.
feature_not_in_plan · Verkstedet har ikke slått på delen dette trenger. feature sier hvilken.
insufficient_scope · Nøkkelen har ikke lov til dette. requiredScope sier hvilken rett som mangler.
rate_limited · For mange kall. Vent retryAfterSeconds sekunder.
internal · Noe gikk galt hos oss. Feilen er meldt. Oppgi requestId hvis du spør.

Ett beslag

Virker

GET /api/v1/catalog/products/{id}

Ett publisert beslag med mål, materialer og bilder. Tegningen og 3D-modellen kommer: til nettbutikken har en offentlig adresse for dem, er drawingUrl alltid null og media bare bilder.

Rettigheter	`catalog:read`
Kundenøkkel	Ja, for sine egne
Grense	lesing, 120 i minuttet

Parametre

Felt	Type	Må med	Beskrivelse
`id (path)`	`string`	Ja	UUID

Svaret (200)

Felt	Type	Må med	Beskrivelse
`id`	`string`	Ja	UUID
`slug`	`string`	Ja
`title`	`string`	Ja
`description`	`string \| null`	Ja
`category`	`string \| null`	Ja
`kind`	`"profil" \| "sektor" \| "kuttliste"`	Ja
`fields`	`object[]`	Ja
`fixed`	`object`	Ja
`materials`	`object[]`	Ja
`media`	`object[]`	Ja	Bildene av beslaget. 3D-modellen (`model`) kommer: til nettbutikken har en offentlig adresse for den, er listen bare bilder.
`drawingUrl`	`string \| null`	Ja	Kommer: alltid `null` til nettbutikken har en offentlig adresse for tegningen.
`priceFromOre`	`integer \| null`	Ja	null når butikken skjuler prisene og nøkkelen er en kundenøkkel
`priceShown`	`boolean`	Ja
`updatedAt`	`string`	Ja	Tidspunkt, ISO 8601 i UTC

Feilkoder

invalid_request · Noe i forespørselen er feil eller ukjent. fields sier hva.
unauthorized · Nø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.
account_closed · Verkstedet er stengt.
dpa_required · Verkstedet må godta databehandleravtalen før koblinger kan brukes.
feature_not_in_plan · Verkstedet har ikke slått på delen dette trenger. feature sier hvilken.
insufficient_scope · Nøkkelen har ikke lov til dette. requiredScope sier hvilken rett som mangler.
not_found · Fant ikke dette.
rate_limited · For mange kall. Vent retryAfterSeconds sekunder.
internal · Noe gikk galt hos oss. Feilen er meldt. Oppgi requestId hvis du spør.

Regn ut en pris

Virker

POST /api/v1/prices

Pris fra den samme prismotoren som butikken og kalkylen. Med discountCode og deliveryOptionId regnes rabatten og frakten som i kassen, så summen blir den samme som på en bestilling i butikken. Ingenting lagres.

Rettigheter	`prices:read`
Kundenøkkel	Ja, for sine egne
Grense	priser, 60 i minuttet

Det du sender

Felt	Type	Må med	Beskrivelse
`lines`	`ProductPriceLine \| PositionPriceLine[]`	Ja
`discountCode`	`string`	Nei	En rabattkode fra nettbutikken. Den gjelder beslagene fra butikken, ikke avtalelinjene.
`deliveryOptionId`	`string`	Nei	Et leveringsvalg fra `GET /shop`, priset som i kassen (`shippingOre`).

Svaret (200)

Felt	Type	Må med	Beskrivelse
`lines`	`PricedLine[]`	Ja
`totals`	`object`	Ja
`totals.netOre`	`integer`	Ja	Hele øre (1 kr = 100 øre)
`totals.smallOrderFeeOre`	`integer`	Ja	Hele øre (1 kr = 100 øre)
`totals.packagingOre`	`integer`	Ja	Hele øre (1 kr = 100 øre)
`totals.shippingOre`	`integer`	Ja	Hele øre (1 kr = 100 øre)
`totals.discountOre`	`integer`	Ja	Rabatten fra `discountCode`, eks. mva., trukket fra i `grossOre`
`totals.vatOre`	`integer`	Ja	Hele øre (1 kr = 100 øre)
`totals.grossOre`	`integer`	Ja	Hele øre (1 kr = 100 øre)
`totals.currency`	`"NOK"`	Ja
`engine`	`string`	Ja	Prismotorens versjon, som `UB_HARD_V0`
`pricedAt`	`string`	Ja	Tidspunkt, ISO 8601 i UTC

Feilkoder

invalid_json · Innholdet er ikke gyldig JSON.
invalid_request · Noe i forespørselen er feil eller ukjent. fields sier hva.
unauthorized · Nø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.
account_closed · Verkstedet er stengt.
dpa_required · Verkstedet må godta databehandleravtalen før koblinger kan brukes.
feature_not_in_plan · Verkstedet har ikke slått på delen dette trenger. feature sier hvilken.
insufficient_scope · Nøkkelen har ikke lov til dette. requiredScope sier hvilken rett som mangler.
prices_hidden · Butikken viser ikke prisene sine, så en kundenøkkel får ingen pris på beslagene. En verkstedsnøkkel får alltid prisen.
not_found · Fant ikke dette.
material_not_offered · Beslaget selges ikke i dette materialet. Materialene står på beslaget (GET /catalog/products/{id}).
params_impossible · Beslaget kan ikke lages med disse målene. fields sier hvilken linje.
params_invalid · Et mål mangler eller er utenfor det beslaget tillater. fields sier hvilken linje.
price_unavailable · Linjen har ingen pris nå, for eksempel fordi avtalen ikke er godtatt eller har gått ut. fields sier hvilken linje.
too_many_lines · Ordren kan ha høyst 100 linjer.
rate_limited · For mange kall. Vent retryAfterSeconds sekunder.
internal · Noe gikk galt hos oss. Feilen er meldt. Oppgi requestId hvis du spør.

Nettbutikk

Nettbutikken: adresse, kassen og levering

Virker

GET /api/v1/shop

Navnet, adressen, om prisene vises, hvem butikken spør først, måtene denne nøkkelen kan bestille på, leveringsvalgene (navn, type, dager; aldri sonene) og adressene til vilkårene.

Rettigheter	`catalog:read`
Kundenøkkel	Ja, for sine egne
Grense	lesing, 120 i minuttet

Svaret (200)

Felt	Type	Må med	Beskrivelse
`name`	`string`	Ja
`host`	`string`	Ja	Adressen butikken svarer på, uten https://
`priceShown`	`boolean`	Ja	`false`: butikken viser ikke priser til kundene.
`buyerDefault`	`"privat" \| "bedrift"`	Ja	Hvem butikken spør først: `privat` eller `bedrift`.
`checkoutModes`	`"foresporsel" \| "betal_etter_bekreft" \| "betal_naa"[]`	Ja	Måtene denne nøkkelen kan bestille på: `foresporsel` alltid; `betal_etter_bekreft` og `betal_naa` når verkstedet kan ta betalt.
`deliveryOptions`	`ShopDeliveryOption[]`	Ja
`legal`	`object`	Ja	Adressene til butikkens godkjente vilkår. `null` til verkstedet har godkjent dem.
`legal.kjopsvilkar`	`string \| null`	Ja
`legal.angrerett`	`string \| null`	Ja
`legal.personvern`	`string \| null`	Ja

Feilkoder

unauthorized · Nø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.
account_closed · Verkstedet er stengt.
dpa_required · Verkstedet må godta databehandleravtalen før koblinger kan brukes.
feature_not_in_plan · Verkstedet har ikke slått på delen dette trenger. feature sier hvilken.
insufficient_scope · Nøkkelen har ikke lov til dette. requiredScope sier hvilken rett som mangler.
rate_limited · For mange kall. Vent retryAfterSeconds sekunder.
internal · Noe gikk galt hos oss. Feilen er meldt. Oppgi requestId hvis du spør.

Regn ut leveringen

Virker

POST /api/v1/delivery-quotes

Hvert leveringsvalg med pris for disse lengdene og dette postnummeret, regnet av den samme regelen som kassen. Ingenting lagres.

Rettigheter	`prices:read`
Kundenøkkel	Ja, for sine egne
Grense	priser, 60 i minuttet

Det du sender

Felt	Type	Må med	Beskrivelse
`lines`	`object[]`	Ja	Lengden på hvert beslag i handlekurven, i millimeter.
`postcode`	`string`	Ja	Norsk postnummer, fire siffer
`optionId`	`string`	Nei	Bare dette valget.
`subtotalOre`	`integer`	Nei	Summen av varene i handlekurven, i øre med mva., slik kassen regner den. Et valg som er gratis fra en sum, blir gratis over den. Uten: 0.

Svaret (200)

Felt	Type	Må med	Beskrivelse
`options`	`object[]`	Ja

Feilkoder

invalid_json · Innholdet er ikke gyldig JSON.
invalid_request · Noe i forespørselen er feil eller ukjent. fields sier hva.
unauthorized · Nø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.
account_closed · Verkstedet er stengt.
dpa_required · Verkstedet må godta databehandleravtalen før koblinger kan brukes.
feature_not_in_plan · Verkstedet har ikke slått på delen dette trenger. feature sier hvilken.
insufficient_scope · Nøkkelen har ikke lov til dette. requiredScope sier hvilken rett som mangler.
too_many_lines · Ordren kan ha høyst 100 linjer.
rate_limited · For mange kall. Vent retryAfterSeconds sekunder.
internal · Noe gikk galt hos oss. Feilen er meldt. Oppgi requestId hvis du spør.

Eksempel

Eksempel: POST /delivery-quotes

{
  "lines": [
    {
      "lengthMm": 2000
    },
    {
      "lengthMm": 1000
    }
  ],
  "postcode": "7010"
}

Lag en betalingslenke

Virker

POST /api/v1/orders/{number}/payment-link

For en mottatt ordre i en butikk som tar betalt: lenken til ordrens statusside, der kunden sjekker målene og betaler. Finnes det en betaling som venter, brukes den. Bare verkstedets nøkler. Krever Nettbutikk med kortbetaling.

Rettigheter	`orders:write`
Kundenøkkel	Nei
Grense	skriving, 30 i minuttet
Overskrifter	`Idempotency-Key (valgfri)`

Parametre

Felt	Type	Må med	Beskrivelse
`number (path)`	`string`	Ja	«4711», «004711», «T-000012» (testnøkler), eller et lappnummer som er blitt ordrens.
`Idempotency-Key (header)`	`string`	Nei	8–255 tegn. Bruk en UUID per forsøk på en handling; samme nøkkel og samme innhold gir samme svar igjen.

Svaret (201)

Felt	Type	Må med	Beskrivelse
`url`	`string`	Ja	Ordrens statusside. Kunden sjekker målene og betaler der.
`amountOre`	`integer`	Ja	Beløp i øre, med mva.
`expiresAt`	`string`	Ja	Tidspunkt, ISO 8601 i UTC

Feilkoder

invalid_request · Noe i forespørselen er feil eller ukjent. fields sier hva.
unauthorized · Nø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.
account_closed · Verkstedet er stengt.
customer_key_not_allowed · En kundenøkkel kan ikke gjøre dette.
dpa_required · Verkstedet må godta databehandleravtalen før koblinger kan brukes.
feature_not_in_plan · Verkstedet har ikke slått på delen dette trenger. feature sier hvilken.
insufficient_scope · Nøkkelen har ikke lov til dette. requiredScope sier hvilken rett som mangler.
not_found · Fant ikke dette.
idempotency_in_progress · En forespørsel med samme Idempotency-Key holder på. Prøv igjen om litt.
status_conflict · Ordren kan ikke flyttes dit fra statusen den har nå. reason sier hvorfor.
idempotency_key_reused · Denne Idempotency-Key ble brukt på en annen forespørsel. Bruk en ny nøkkel for ny handling.
rate_limited · For mange kall. Vent retryAfterSeconds sekunder.
internal · Noe gikk galt hos oss. Feilen er meldt. Oppgi requestId hvis du spør.

Ordrens betalinger

Virker

GET /api/v1/orders/{number}/payments

Status, beløp, metode og hva som er betalt tilbake. Aldri en id hos Stripe, bare de fire siste tegnene. En kundenøkkel ser sine egne ordre.

Rettigheter	`orders:read`
Kundenøkkel	Ja, for sine egne
Grense	lesing, 120 i minuttet

Parametre

Felt	Type	Må med	Beskrivelse
`number (path)`	`string`	Ja	«4711», «004711», «T-000012» (testnøkler), eller et lappnummer som er blitt ordrens.

Svaret (200)

Felt	Type	Må med	Beskrivelse
`data`	`OrderPayment[]`	Ja

Feilkoder

invalid_request · Noe i forespørselen er feil eller ukjent. fields sier hva.
unauthorized · Nø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.
account_closed · Verkstedet er stengt.
dpa_required · Verkstedet må godta databehandleravtalen før koblinger kan brukes.
feature_not_in_plan · Verkstedet har ikke slått på delen dette trenger. feature sier hvilken.
insufficient_scope · Nøkkelen har ikke lov til dette. requiredScope sier hvilken rett som mangler.
not_found · Fant ikke dette.
rate_limited · For mange kall. Vent retryAfterSeconds sekunder.
internal · Noe gikk galt hos oss. Feilen er meldt. Oppgi requestId hvis du spør.

Avtaler

List avtaler

Virker

GET /api/v1/agreements

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

Parametre

Felt	Type	Må med	Beskrivelse
`status (query)`	`"sendt" \| "sett" \| "godtatt" \| "avvist" \| "erstattet" \| "utlopt"`	Nei
`customerId (query)`	`string`	Nei	UUID
`includeExpired (query)`	`"true" \| "false"`	Nei
`limit (query)`	`integer`	Nei	Antall per side, 1–100 (25 når den mangler).
`cursor (query)`	`string`	Nei	`nextCursor` fra forrige side.

Svaret (200)

Felt	Type	Må med	Beskrivelse
`data`	`Agreement[]`	Ja
`nextCursor`	`string \| null`	Ja

Feilkoder

invalid_cursor · Markøren (cursor) er ikke en vi har gitt ut.
invalid_request · Noe i forespørselen er feil eller ukjent. fields sier hva.
unauthorized · Nø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.
account_closed · Verkstedet er stengt.
dpa_required · Verkstedet må godta databehandleravtalen før koblinger kan brukes.
feature_not_in_plan · Verkstedet har ikke slått på delen dette trenger. feature sier hvilken.
insufficient_scope · Nøkkelen har ikke lov til dette. requiredScope sier hvilken rett som mangler.
rate_limited · For mange kall. Vent retryAfterSeconds sekunder.
internal · Noe gikk galt hos oss. Feilen er meldt. Oppgi requestId hvis du spør.

Hent en avtale

Virker

GET /api/v1/agreements/{number}

En avtale med posisjoner, leveringsdager og pristabell: den gjeldende versjonen, eller den version peker på (slik når du en avtale som er erstattet). Prisen per stykk er eks. mva.; vatBp står ved siden av.

Rettigheter	`agreements:read`
Kundenøkkel	Ja, for sine egne
Grense	lesing, 120 i minuttet

Parametre

Felt	Type	Må med	Beskrivelse
`number (path)`	`string`	Ja	Avtalenummeret, som «12»
`version (query)`	`string`	Nei

Svaret (200)

Felt	Type	Må med	Beskrivelse
`number`	`integer`	Ja
`version`	`integer`	Ja
`status`	`"sendt" \| "sett" \| "godtatt" \| "avvist" \| "erstattet" \| "utlopt"`	Ja
`expired`	`boolean`	Ja
`customer`	`object`	Ja
`customer.id`	`string`	Ja	UUID
`customer.number`	`integer \| null`	Ja
`customer.name`	`string`	Ja
`project`	`object \| null`	Ja
`project.projectNo`	`string`	Ja
`project.name`	`string \| null`	Ja
`title`	`string`	Ja
`validUntil`	`string \| null`	Ja
`deliveryWeekdays`	`integer[]`	Ja
`leadDays`	`integer \| null`	Ja
`freightFreeFromOre`	`integer \| null`	Ja	Hele øre (1 kr = 100 øre)
`maxLengthMm`	`integer \| null`	Ja
`termsWe`	`string \| null`	Ja
`termsYou`	`string \| null`	Ja
`positions`	`AgreementPosition[]`	Ja
`sentAt`	`string \| null`	Ja	Tidspunkt, ISO 8601 i UTC
`decidedAt`	`string \| null`	Ja	Tidspunkt, ISO 8601 i UTC
`decidedByName`	`string \| null`	Ja

Feilkoder

invalid_request · Noe i forespørselen er feil eller ukjent. fields sier hva.
unauthorized · Nø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.
account_closed · Verkstedet er stengt.
dpa_required · Verkstedet må godta databehandleravtalen før koblinger kan brukes.
feature_not_in_plan · Verkstedet har ikke slått på delen dette trenger. feature sier hvilken.
insufficient_scope · Nøkkelen har ikke lov til dette. requiredScope sier hvilken rett som mangler.
not_found · Fant ikke dette.
rate_limited · For mange kall. Vent retryAfterSeconds sekunder.
internal · Noe gikk galt hos oss. Feilen er meldt. Oppgi requestId hvis du spør.

Fakturaer

List fakturaer

Virker

GET /api/v1/invoices

Sendte fakturaer, kreditnotaer og «Fakturert i regnskapet», nyeste først. Utkast kommer bare med includeDrafts=true. Filtrer på status, customerId, issuedSince (fakturadato, Oslo) og updatedSince. En kundenøkkel ser bare sin egen kundes sendte fakturaer, aldri et utkast.

Rettigheter	`invoices:read`
Kundenøkkel	Ja, for sine egne
Grense	lesing, 120 i minuttet

Parametre

Felt	Type	Må med	Beskrivelse
`status (query)`	`"utkast" \| "sendt" \| "forfalt" \| "betalt" \| "kansellert" \| "kreditert"`	Nei
`customerId (query)`	`string`	Nei	UUID
`issuedSince (query)`	`string`	Nei	Dato på Oslo-kalenderen, ÅÅÅÅ-MM-DD
`updatedSince (query)`	`string`	Nei	Tidspunkt, ISO 8601 i UTC
`includeDrafts (query)`	`"true" \| "false"`	Nei
`limit (query)`	`integer`	Nei	Antall per side, 1–100 (25 når den mangler).
`cursor (query)`	`string`	Nei	`nextCursor` fra forrige side.

Svaret (200)

Felt	Type	Må med	Beskrivelse
`data`	`Invoice[]`	Ja
`nextCursor`	`string \| null`	Ja

Feilkoder

invalid_cursor · Markøren (cursor) er ikke en vi har gitt ut.
invalid_request · Noe i forespørselen er feil eller ukjent. fields sier hva.
unauthorized · Nø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.
account_closed · Verkstedet er stengt.
dpa_required · Verkstedet må godta databehandleravtalen før koblinger kan brukes.
feature_not_in_plan · Verkstedet har ikke slått på delen dette trenger. feature sier hvilken.
insufficient_scope · Nøkkelen har ikke lov til dette. requiredScope sier hvilken rett som mangler.
rate_limited · For mange kall. Vent retryAfterSeconds sekunder.
internal · Noe gikk galt hos oss. Feilen er meldt. Oppgi requestId hvis du spør.

Hent en faktura

Virker

GET /api/v1/invoices/{id}

Med linjer, KID og ordrene den dekker. En kundenøkkel får bare sin egen kundes; en annen kundes faktura og et utkast svarer 404.

Rettigheter	`invoices:read`
Kundenøkkel	Ja, for sine egne
Grense	lesing, 120 i minuttet

Parametre

Felt	Type	Må med	Beskrivelse
`id (path)`	`string`	Ja	UUID

Svaret (200)

Felt	Type	Må med	Beskrivelse
`id`	`string`	Ja	UUID
`kind`	`"invoice" \| "credit_note" \| "erp_mark"`	Ja
`number`	`string \| null`	Ja
`status`	`"utkast" \| "sendt" \| "forfalt" \| "betalt" \| "kansellert" \| "kreditert"`	Ja
`issueDate`	`string \| null`	Ja	Dato på Oslo-kalenderen, ÅÅÅÅ-MM-DD
`dueDate`	`string \| null`	Ja	Dato på Oslo-kalenderen, ÅÅÅÅ-MM-DD
`kid`	`string \| null`	Ja
`customer`	`object \| null`	Ja
`customer.id`	`string`	Ja	UUID
`customer.number`	`integer \| null`	Ja
`customer.name`	`string`	Ja
`orderReference`	`string \| null`	Ja
`customerReference`	`string \| null`	Ja
`orderNumbers`	`integer[]`	Ja
`currency`	`"NOK"`	Ja
`netOre`	`integer \| null`	Ja	Hele øre (1 kr = 100 øre)
`vatOre`	`integer \| null`	Ja	Hele øre (1 kr = 100 øre)
`grossOre`	`integer \| null`	Ja	Hele øre (1 kr = 100 øre)
`lines`	`InvoiceLine[]`	Ja
`erp`	`object \| null`	Ja
`erp.vendor`	`"poweroffice" \| "tripletex" \| "fiken"`	Ja
`erp.invoiceNo`	`string \| null`	Ja
`paidAt`	`string \| null`	Ja	Tidspunkt, ISO 8601 i UTC
`createdAt`	`string`	Ja	Tidspunkt, ISO 8601 i UTC
`updatedAt`	`string`	Ja	Tidspunkt, ISO 8601 i UTC

Feilkoder

invalid_request · Noe i forespørselen er feil eller ukjent. fields sier hva.
unauthorized · Nø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.
account_closed · Verkstedet er stengt.
dpa_required · Verkstedet må godta databehandleravtalen før koblinger kan brukes.
feature_not_in_plan · Verkstedet har ikke slått på delen dette trenger. feature sier hvilken.
insufficient_scope · Nøkkelen har ikke lov til dette. requiredScope sier hvilken rett som mangler.
not_found · Fant ikke dette.
rate_limited · For mange kall. Vent retryAfterSeconds sekunder.
internal · Noe gikk galt hos oss. Feilen er meldt. Oppgi requestId hvis du spør.

Fakturaen som PDF

Virker

GET /api/v1/invoices/{id}/pdf

PDF-en slik kunden fikk den, laget på serveren av den utstedte fakturaen (nummer og KID). Et utkast og «Fakturert i regnskapet» har ingen PDF her: svaret er 404. En kundenøkkel får bare sin egen kundes.

Rettigheter	`invoices:read`
Kundenøkkel	Ja, for sine egne
Grense	lesing, 120 i minuttet

Parametre

Felt	Type	Må med	Beskrivelse
`id (path)`	`string`	Ja	UUID

Svaret: 200 · PDF-en

Feilkoder

invalid_request · Noe i forespørselen er feil eller ukjent. fields sier hva.
unauthorized · Nø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.
account_closed · Verkstedet er stengt.
dpa_required · Verkstedet må godta databehandleravtalen før koblinger kan brukes.
feature_not_in_plan · Verkstedet har ikke slått på delen dette trenger. feature sier hvilken.
insufficient_scope · Nøkkelen har ikke lov til dette. requiredScope sier hvilken rett som mangler.
not_found · Fant ikke dette.
rate_limited · For mange kall. Vent retryAfterSeconds sekunder.
internal · Noe gikk galt hos oss. Feilen er meldt. Oppgi requestId hvis du spør.

Produksjon

Bøyearkene på en ordre

Virker

GET /api/v1/orders/{number}/bending-sheets

Gjeldende versjon av hvert ark på ordren, etter arknummer. Krever Produksjon.

Rettigheter	`production:read`
Kundenøkkel	Nei
Grense	lesing, 120 i minuttet

Parametre

Felt	Type	Må med	Beskrivelse
`number (path)`	`string`	Ja	«4711», «004711», «T-000012» (testnøkler), eller et lappnummer som er blitt ordrens.

Svaret (200)

Felt	Type	Må med	Beskrivelse
`data`	`BendingSheet[]`	Ja

Feilkoder

invalid_request · Noe i forespørselen er feil eller ukjent. fields sier hva.
unauthorized · Nø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.
account_closed · Verkstedet er stengt.
customer_key_not_allowed · En kundenøkkel kan ikke gjøre dette.
dpa_required · Verkstedet må godta databehandleravtalen før koblinger kan brukes.
feature_not_in_plan · Verkstedet har ikke slått på delen dette trenger. feature sier hvilken.
insufficient_scope · Nøkkelen har ikke lov til dette. requiredScope sier hvilken rett som mangler.
not_found · Fant ikke dette.
rate_limited · For mange kall. Vent retryAfterSeconds sekunder.
internal · Noe gikk galt hos oss. Feilen er meldt. Oppgi requestId hvis du spør.

Hent ett bøyeark

Virker

GET /api/v1/bending-sheets/{id}

En versjon av ett ark: profilen (mål og vinkler i tegningens rekkefølge), materialet, utbrettet med fradragene, kantbenken, dagen det er planlagt og godkjenningen. superseded er true når en nyere versjon har erstattet det. Krever Produksjon.

Rettigheter	`production:read`
Kundenøkkel	Nei
Grense	lesing, 120 i minuttet

Parametre

Felt	Type	Må med	Beskrivelse
`id (path)`	`string`	Ja	UUID

Svaret (200)

Felt	Type	Må med	Beskrivelse
`id`	`string`	Ja	UUID
`orderNumber`	`string`	Ja	«004711», eller «T-000012» for en testordre.
`sheetNo`	`integer`	Ja	Arket på ordren: «004711-1» er ark 1.
`version`	`integer`	Ja	Versjonen av arket. En endring etter utkast lagrer en ny versjon.
`superseded`	`boolean`	Ja	`true` når en nyere versjon har erstattet denne.
`status`	`"utkast" \| "venter_kunde" \| "endring" \| "godkjent" \| "til_pressen" \| "boyd" \| "avbrutt"`	Ja	Lagret status: `utkast`, `venter_kunde`, `endring`, `godkjent`, `til_pressen`, `boyd`, `avbrutt`. Kan få nye verdier: les en ukjent verdi som «annet».
`statusLabel`	`string`	Ja	Ordet verkstedet ser («Til pressen», «Bøyd»).
`profile`	`object`	Ja
`profile.legs`	`object[]`	Ja
`profile.bends`	`object[]`	Ja
`profile.colourSide`	`"ut" \| "inn" \| null`	Ja
`profile.bendOrder`	`integer[] \| null`	Ja	Bukkene i den rekkefølgen de bøyes (1-basert); `null` = i tegningens rekkefølge.
`materialLabel`	`string`	Ja
`thicknessMm`	`number`	Ja
`colour`	`string \| null`	Ja
`lengthMm`	`number`	Ja
`quantity`	`integer`	Ja
`developedWidthMm`	`number \| null`	Ja	Utbrett: summen av målene minus fradragene; `null` før arket er regnet ut.
`deductions`	`object[]`	Ja
`press`	`object \| null`	Ja
`press.id`	`string`	Ja	UUID
`press.name`	`string`	Ja
`plannedDate`	`string \| null`	Ja	Dato på Oslo-kalenderen, ÅÅÅÅ-MM-DD
`approval`	`object \| null`	Ja
`approval.basis`	`string`	Ja	`lenke`, `portal`, `nettbutikk`, `api`, `avtale`, `tidligere`, `telefon` eller `overstyrt`. Kan få nye verdier.
`approval.decidedAt`	`string \| null`	Ja	Tidspunkt, ISO 8601 i UTC
`approval.decidedByName`	`string \| null`	Ja
`bentAt`	`string \| null`	Ja	Tidspunkt, ISO 8601 i UTC

Feilkoder

invalid_request · Noe i forespørselen er feil eller ukjent. fields sier hva.
unauthorized · Nø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.
account_closed · Verkstedet er stengt.
customer_key_not_allowed · En kundenøkkel kan ikke gjøre dette.
dpa_required · Verkstedet må godta databehandleravtalen før koblinger kan brukes.
feature_not_in_plan · Verkstedet har ikke slått på delen dette trenger. feature sier hvilken.
insufficient_scope · Nøkkelen har ikke lov til dette. requiredScope sier hvilken rett som mangler.
not_found · Fant ikke dette.
rate_limited · For mange kall. Vent retryAfterSeconds sekunder.
internal · Noe gikk galt hos oss. Feilen er meldt. Oppgi requestId hvis du spør.

Bøyearket som PDF

Virker

GET /api/v1/bending-sheets/{id}/pdf

Svarer 302 til PDF-en verkstedet skriver ut, med QR-koden pressen leser. Lenken lever i fem minutter. Et utkast har ingen PDF ennå: 409 med reason: pdf_not_made.

Rettigheter	`production:read`
Kundenøkkel	Nei
Grense	lesing, 120 i minuttet

Parametre

Felt	Type	Må med	Beskrivelse
`id (path)`	`string`	Ja	UUID

Svaret: 302 · Videre til PDF-en (lenken lever i fem minutter)

Feilkoder

invalid_request · Noe i forespørselen er feil eller ukjent. fields sier hva.
unauthorized · Nø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.
account_closed · Verkstedet er stengt.
customer_key_not_allowed · En kundenøkkel kan ikke gjøre dette.
dpa_required · Verkstedet må godta databehandleravtalen før koblinger kan brukes.
feature_not_in_plan · Verkstedet har ikke slått på delen dette trenger. feature sier hvilken.
insufficient_scope · Nøkkelen har ikke lov til dette. requiredScope sier hvilken rett som mangler.
not_found · Fant ikke dette.
status_conflict · Ordren kan ikke flyttes dit fra statusen den har nå. reason sier hvorfor.
rate_limited · For mange kall. Vent retryAfterSeconds sekunder.
internal · Noe gikk galt hos oss. Feilen er meldt. Oppgi requestId hvis du spør.

Platen som DXF

Virker

GET /api/v1/bending-sheets/{id}/dxf

Den flate platen (utbrett × lengde) med bukkelinjene, som DXF R12. For klippebord, kappemaskiner og programmer som leser en flat plate. Et ark som ikke er regnet ut ennå gir 409 med reason: not_developed.

Rettigheter	`production:read`
Kundenøkkel	Nei
Grense	lesing, 120 i minuttet

Parametre

Felt	Type	Må med	Beskrivelse
`id (path)`	`string`	Ja	UUID

Svaret: 200 · DXF-filen (`application/dxf`)

Feilkoder

invalid_request · Noe i forespørselen er feil eller ukjent. fields sier hva.
unauthorized · Nø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.
account_closed · Verkstedet er stengt.
customer_key_not_allowed · En kundenøkkel kan ikke gjøre dette.
dpa_required · Verkstedet må godta databehandleravtalen før koblinger kan brukes.
feature_not_in_plan · Verkstedet har ikke slått på delen dette trenger. feature sier hvilken.
insufficient_scope · Nøkkelen har ikke lov til dette. requiredScope sier hvilken rett som mangler.
not_found · Fant ikke dette.
status_conflict · Ordren kan ikke flyttes dit fra statusen den har nå. reason sier hvorfor.
rate_limited · For mange kall. Vent retryAfterSeconds sekunder.
internal · Noe gikk galt hos oss. Feilen er meldt. Oppgi requestId hvis du spør.
unavailable · Tjenesten er midlertidig nede. Prøv igjen senere.

Dagens bøyeliste

Virker

GET /api/v1/production/queue

Arkene som er planlagt en dag, i den rekkefølgen de skal bøyes, for alle kantbenker eller en (press). Med Accept: text/csv kommer lista som CSV med semikolon og UTF-8, slik at den åpnes i Excel. Ark som venter på kunden er med, men merket. Krever Produksjon.

Rettigheter	`production:read`
Kundenøkkel	Nei
Grense	lesing, 120 i minuttet

Parametre

Felt	Type	Må med	Beskrivelse
`date (query)`	`string`	Nei	Dagen, ÅÅÅÅ-MM-DD. I dag (Oslo) når den mangler.
`press (query)`	`string`	Nei	Bare denne kantbenken (id fra `GET /presses`).

Svaret (200)

Felt	Type	Må med	Beskrivelse
`date`	`string`	Ja	Dato på Oslo-kalenderen, ÅÅÅÅ-MM-DD
`press`	`object \| null`	Ja
`press.id`	`string`	Ja	UUID
`press.name`	`string`	Ja
`summary`	`object`	Ja	«I dag: 14 bøyeark · 52 bukk · 3 materialer»
`summary.bendingSheets`	`integer`	Ja
`summary.bends`	`integer`	Ja
`summary.materials`	`integer`	Ja
`data`	`ProductionQueueRow[]`	Ja

Feilkoder

invalid_request · Noe i forespørselen er feil eller ukjent. fields sier hva.
unauthorized · Nø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.
account_closed · Verkstedet er stengt.
customer_key_not_allowed · En kundenøkkel kan ikke gjøre dette.
dpa_required · Verkstedet må godta databehandleravtalen før koblinger kan brukes.
feature_not_in_plan · Verkstedet har ikke slått på delen dette trenger. feature sier hvilken.
insufficient_scope · Nøkkelen har ikke lov til dette. requiredScope sier hvilken rett som mangler.
not_found · Fant ikke dette.
date_invalid · Datoen er ikke en gyldig dag (ÅÅÅÅ-MM-DD).
rate_limited · For mange kall. Vent retryAfterSeconds sekunder.
internal · Noe gikk galt hos oss. Feilen er meldt. Oppgi requestId hvis du spør.

Kantbenkene

Virker

GET /api/v1/presses

Verkstedets kantbenker i den rekkefølgen verkstedet har satt. Bruk id som press i dagens bøyeliste. Krever Produksjon.

Rettigheter	`production:read`
Kundenøkkel	Nei
Grense	lesing, 120 i minuttet

Svaret (200)

Felt	Type	Må med	Beskrivelse
`data`	`Press[]`	Ja

Feilkoder

unauthorized · Nø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.
account_closed · Verkstedet er stengt.
customer_key_not_allowed · En kundenøkkel kan ikke gjøre dette.
dpa_required · Verkstedet må godta databehandleravtalen før koblinger kan brukes.
feature_not_in_plan · Verkstedet har ikke slått på delen dette trenger. feature sier hvilken.
insufficient_scope · Nøkkelen har ikke lov til dette. requiredScope sier hvilken rett som mangler.
rate_limited · For mange kall. Vent retryAfterSeconds sekunder.
internal · Noe gikk galt hos oss. Feilen er meldt. Oppgi requestId hvis du spør.

Merk et bøyeark som bøyd

Virker

POST /api/v1/bending-sheets/{id}/bent

Det samme som «Bøyd» på pressen: bare fra «Til pressen». Avvist med 409 når arket venter på kunden (reason: waits_for_customer), når en nyere versjon har erstattet det (superseded) og når ordren er lukket (order_closed). Et ark som allerede er bøyd svarer som det er, uten en ny hendelse. Krever Produksjon.

Rettigheter	`production:status`
Kundenøkkel	Nei
Grense	skriving, 30 i minuttet
Overskrifter	`Idempotency-Key (valgfri)`

Parametre

Felt	Type	Må med	Beskrivelse
`id (path)`	`string`	Ja	UUID
`Idempotency-Key (header)`	`string`	Nei	8–255 tegn. Bruk en UUID per forsøk på en handling; samme nøkkel og samme innhold gir samme svar igjen.

Svaret (200)

Felt	Type	Må med	Beskrivelse
`id`	`string`	Ja	UUID
`orderNumber`	`string`	Ja	«004711», eller «T-000012» for en testordre.
`sheetNo`	`integer`	Ja	Arket på ordren: «004711-1» er ark 1.
`version`	`integer`	Ja	Versjonen av arket. En endring etter utkast lagrer en ny versjon.
`superseded`	`boolean`	Ja	`true` når en nyere versjon har erstattet denne.
`status`	`"utkast" \| "venter_kunde" \| "endring" \| "godkjent" \| "til_pressen" \| "boyd" \| "avbrutt"`	Ja	Lagret status: `utkast`, `venter_kunde`, `endring`, `godkjent`, `til_pressen`, `boyd`, `avbrutt`. Kan få nye verdier: les en ukjent verdi som «annet».
`statusLabel`	`string`	Ja	Ordet verkstedet ser («Til pressen», «Bøyd»).
`profile`	`object`	Ja
`profile.legs`	`object[]`	Ja
`profile.bends`	`object[]`	Ja
`profile.colourSide`	`"ut" \| "inn" \| null`	Ja
`profile.bendOrder`	`integer[] \| null`	Ja	Bukkene i den rekkefølgen de bøyes (1-basert); `null` = i tegningens rekkefølge.
`materialLabel`	`string`	Ja
`thicknessMm`	`number`	Ja
`colour`	`string \| null`	Ja
`lengthMm`	`number`	Ja
`quantity`	`integer`	Ja
`developedWidthMm`	`number \| null`	Ja	Utbrett: summen av målene minus fradragene; `null` før arket er regnet ut.
`deductions`	`object[]`	Ja
`press`	`object \| null`	Ja
`press.id`	`string`	Ja	UUID
`press.name`	`string`	Ja
`plannedDate`	`string \| null`	Ja	Dato på Oslo-kalenderen, ÅÅÅÅ-MM-DD
`approval`	`object \| null`	Ja
`approval.basis`	`string`	Ja	`lenke`, `portal`, `nettbutikk`, `api`, `avtale`, `tidligere`, `telefon` eller `overstyrt`. Kan få nye verdier.
`approval.decidedAt`	`string \| null`	Ja	Tidspunkt, ISO 8601 i UTC
`approval.decidedByName`	`string \| null`	Ja
`bentAt`	`string \| null`	Ja	Tidspunkt, ISO 8601 i UTC

Feilkoder

invalid_request · Noe i forespørselen er feil eller ukjent. fields sier hva.
unauthorized · Nø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.
account_closed · Verkstedet er stengt.
customer_key_not_allowed · En kundenøkkel kan ikke gjøre dette.
dpa_required · Verkstedet må godta databehandleravtalen før koblinger kan brukes.
feature_not_in_plan · Verkstedet har ikke slått på delen dette trenger. feature sier hvilken.
insufficient_scope · Nøkkelen har ikke lov til dette. requiredScope sier hvilken rett som mangler.
not_found · Fant ikke dette.
idempotency_in_progress · En forespørsel med samme Idempotency-Key holder på. Prøv igjen om litt.
stale_version · Ordren er endret siden du leste den. Hent den på nytt og send med ny versjon.
status_conflict · Ordren kan ikke flyttes dit fra statusen den har nå. reason sier hvorfor.
idempotency_key_reused · Denne Idempotency-Key ble brukt på en annen forespørsel. Bruk en ny nøkkel for ny handling.
rate_limited · For mange kall. Vent retryAfterSeconds sekunder.
internal · Noe gikk galt hos oss. Feilen er meldt. Oppgi requestId hvis du spør.

Rapporter

Tallene for en måned

Virker

GET /api/v1/reports/months/{month}

Tallene fra Tall for en måned: bare summer, aldri kundenavn. Hvert tall teller det som skjedde i måneden (norsk tid). Inneværende måned gir tallene så langt; en måned fram i tid avvises. Bare verkstedets egne nøkler.

Rettigheter	`reports:read`
Kundenøkkel	Nei
Grense	lesing, 120 i minuttet

Parametre

Felt	Type	Må med	Beskrivelse
`month (path)`	`string`	Ja	Måneden, ÅÅÅÅ-MM

Svaret (200)

Felt	Type	Må med	Beskrivelse
`month`	`string`	Ja
`currency`	`"NOK"`	Ja
`orders`	`object`	Ja
`orders.received`	`integer`	Ja
`orders.ready`	`integer`	Ja
`orders.delivered`	`integer`	Ja
`orders.bySource`	`object`	Ja
`invoiced`	`object`	Ja
`invoiced.count`	`integer`	Ja
`invoiced.netOre`	`integer`	Ja	Hele øre (1 kr = 100 øre)
`invoiced.grossOre`	`integer`	Ja	Hele øre (1 kr = 100 øre)
`paid`	`object`	Ja
`paid.count`	`integer`	Ja
`paid.grossOre`	`integer`	Ja	Hele øre (1 kr = 100 øre)
`outstanding`	`object`	Ja
`outstanding.count`	`integer`	Ja
`outstanding.grossOre`	`integer`	Ja	Hele øre (1 kr = 100 øre)
`outstanding.overdueCount`	`integer`	Ja
`outstanding.overdueGrossOre`	`integer`	Ja	Hele øre (1 kr = 100 øre)
`generatedAt`	`string`	Ja	Tidspunkt, ISO 8601 i UTC

Feilkoder

invalid_request · Noe i forespørselen er feil eller ukjent. fields sier hva.
unauthorized · Nø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.
account_closed · Verkstedet er stengt.
customer_key_not_allowed · En kundenøkkel kan ikke gjøre dette.
dpa_required · Verkstedet må godta databehandleravtalen før koblinger kan brukes.
feature_not_in_plan · Verkstedet har ikke slått på delen dette trenger. feature sier hvilken.
insufficient_scope · Nøkkelen har ikke lov til dette. requiredScope sier hvilken rett som mangler.
not_found · Fant ikke dette.
date_invalid · Datoen er ikke en gyldig dag (ÅÅÅÅ-MM-DD).
rate_limited · For mange kall. Vent retryAfterSeconds sekunder.
internal · Noe gikk galt hos oss. Feilen er meldt. Oppgi requestId hvis du spør.

Dokumentet

OpenAPI-dokumentet

Virker

GET /api/v1/openapi.json

Hele API-et som OpenAPI 3.1. Uten nøkkel, og kan hentes fra en nettleser (Postman, Insomnia, Swagger UI).

Rettigheter	`Bare en nøkkel`
Kundenøkkel	Ja, for sine egne
Grense	ingen nøkkel

Svaret: 200 · Dokumentet

Feilkoder

internal · Noe gikk galt hos oss. Feilen er meldt. Oppgi requestId hvis du spør.

Feilkoder

400	`invalid_cursor`	Markøren (`cursor`) er ikke en vi har gitt ut.
400	`invalid_json`	Innholdet er ikke gyldig JSON.
400	`invalid_request`	Noe i forespørselen er feil eller ukjent. `fields` sier hva.
401	`unauthorized`	Nø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.
403	`account_closed`	Verkstedet er stengt.
403	`customer_key_not_allowed`	En kundenøkkel kan ikke gjøre dette.
403	`dpa_required`	Verkstedet må godta databehandleravtalen før koblinger kan brukes.
403	`feature_not_in_plan`	Verkstedet har ikke slått på delen dette trenger. `feature` sier hvilken.
403	`insufficient_scope`	Nøkkelen har ikke lov til dette. `requiredScope` sier hvilken rett som mangler.
403	`prices_hidden`	Butikken viser ikke prisene sine, så en kundenøkkel får ingen pris på beslagene. En verkstedsnøkkel får alltid prisen.
403	`test_key_not_allowed`	En testnøkkel kan ikke dette: den endrer aldri kunderegisteret, og et avrop er alltid en ekte ordre.
404	`not_found`	Fant ikke dette.
405	`method_not_allowed`	Denne adressen tar ikke imot denne metoden.
409	`already_invoiced`	Ordren er fakturert og kan ikke endres.
409	`cancel_not_allowed`	Ordren kan ikke avbrytes nå. Ring verkstedet: arbeidet kan være i gang.
409	`customer_exists`	En kunde med dette org.nr. finnes allerede. `id` er kunden.
409	`duplicate_external_ref`	Du har allerede sendt en ordre med denne `externalRef`. `existingNumber` er ordrenummeret.
409	`erp_owned_field`	Navn og org.nr. eies av regnskapet for denne kunden. Endre dem der.
409	`idempotency_in_progress`	En forespørsel med samme `Idempotency-Key` holder på. Prøv igjen om litt.
409	`key_owner_missing`	Brukeren som laget nøkkelen finnes ikke lenger. Lag en ny nøkkel.
409	`not_ready`	Ordren er ikke klar.
409	`stale_version`	Ordren er endret siden du leste den. Hent den på nytt og send med ny versjon.
409	`status_conflict`	Ordren kan ikke flyttes dit fra statusen den har nå. `reason` sier hvorfor.
413	`payload_too_large`	Filen er for stor.
415	`unsupported_media_type`	Filtypen tas ikke imot. Send JPEG, PNG, WebP, HEIC eller PDF.
422	`agreement_not_active`	Avtalen tar ikke imot avrop: den er ikke godtatt, er utløpt eller erstattet, eller finnes ikke for denne nøkkelen. `reason` sier hvorfor.
422	`contact_invalid`	Kontakten trenger et navn og en e-post eller et norsk mobilnummer.
422	`content_required`	Ordren må ha minst en linje eller en merknad (`note`) på minst 3 tegn.
422	`customer_fixed_by_key`	Denne nøkkelen hører til en kunde, og ordren må være for den kunden.
422	`customer_invalid`	Noe i kundefeltene er feil. `fields` sier hva.
422	`customer_required`	Ordren må ha en kunde. Send `customer`, eller `contact` med `createCustomer: true`.
422	`date_invalid`	Datoen er ikke en gyldig dag (ÅÅÅÅ-MM-DD).
422	`delivery_date_not_allowed`	Avtalen leverer ikke den dagen. `nextPossibleDate` er den første dagen som går.
422	`idempotency_key_reused`	Denne `Idempotency-Key` ble brukt på en annen forespørsel. Bruk en ny nøkkel for ny handling.
422	`intent_not_allowed`	En kundenøkkel sender forespørsler (`"intent": "request"`), eller avrop på en godtatt avtale (`agreementNumber`).
422	`length_over_max`	Lengden er over det avtalen tillater (`maxLengthMm`). `fields` sier hvilken linje.
422	`material_not_offered`	Beslaget selges ikke i dette materialet. Materialene står på beslaget (`GET /catalog/products/{id}`).
422	`orderer_required`	Denne kunden krever bestiller (`orderer`).
422	`params_impossible`	Beslaget kan ikke lages med disse målene. `fields` sier hvilken linje.
422	`params_invalid`	Et mål mangler eller er utenfor det beslaget tillater. `fields` sier hvilken linje.
422	`position_not_in_agreement`	Posisjonen hører ikke til denne avtalen. Hent posisjonene med `GET /agreements/{number}`. `fields` sier hvilken linje.
422	`price_unavailable`	Linjen har ingen pris nå, for eksempel fordi avtalen ikke er godtatt eller har gått ut. `fields` sier hvilken linje.
422	`project_no_required`	Denne kunden krever prosjektnummer (`projectNo`).
422	`quantity_invalid`	Antallet må være mellom 1 og 500.
422	`too_many_attachments`	Ordren har allerede så mange filer som den kan ha.
422	`too_many_lines`	Ordren kan ha høyst 100 linjer.
428	`idempotency_key_required`	Send `Idempotency-Key` med denne forespørselen.
428	`precondition_required`	Send `If-Match` med versjonen du så, for eksempel `"v3"`.
429	`rate_limited`	For mange kall. Vent `retryAfterSeconds` sekunder.
500	`internal`	Noe gikk galt hos oss. Feilen er meldt. Oppgi `requestId` hvis du spør.
503	`unavailable`	Tjenesten er midlertidig nede. Prøv igjen senere.