{ "openapi": "3.0.1", "info": { "title": "Intet til utlegg/utleggstrekk (ITU/UTT) API", "description": "Restendepunkter for å hente opplysninger om intet til utlegg og utleggestrekk på et fødselesnummer/d-nummer/organisasjonsnummer. \nEndepunktene forventer et gyldig maskinporttoken med scope = brreg:losore/utlegg.", "contact": { "name": "Løsøreregisteret", "url": "https://brreg.github.io/docs/apidokumentasjon/losoreregisteret/", "email": "oa-fagstillinger@brreg.no" } }, "servers": [ { "url": "https://utlegg-api-ekstern.app-ppe.brreg.no", "description": "Generated server url" } ], "paths": { "/utlegg/totalbestand/{datoSistEndret}": { "get": { "tags": [ "totalbestand-controller" ], "description": "Hent totalbestand om intet til utlegg og utleggstrekk på fødselsnummer, d-nummer og organisasjonsnummer basert på sist endret dato (for kredittopplysningsforetak).", "operationId": "getTotalbestandMedDatoSistEndret", "parameters": [ { "name": "Authorization", "in": "header", "description": "Bearer ", "required": true, "schema": { "type": "string" }, "example": "Bearer access_token" }, { "name": "datoSistEndret", "in": "path", "description": "Sist endret dato", "required": true, "schema": { "type": "string" }, "example": "2020-01-01T00:00" } ], "responses": { "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResponseWrapper" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResponseWrapper" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TotalbestandWrapper" } } } } } } }, "/utlegg/totalbestand/enheter": { "get": { "tags": [ "totalbestand-controller" ], "description": "Hent totalbestand om intet til utlegg på organisasjonsnummer (for kredittopplysningsforetak).", "operationId": "getTotalbestandForEnhet", "parameters": [ { "name": "Authorization", "in": "header", "description": "Bearer ", "required": true, "schema": { "type": "string" }, "example": "Bearer access_token" } ], "responses": { "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResponseWrapper" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResponseWrapper" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TotalbestandWrapper" } } } } } } }, "/utlegg/totalbestand/enheter/{datoSistEndret}": { "get": { "tags": [ "totalbestand-controller" ], "description": "Hent totalbestand om intet til utlegg på organisasjonsnummer basert på sist endret dato (for kredittopplysningsforetak).", "operationId": "getTotalbestandForEnhetMedDatoSistEndret", "parameters": [ { "name": "Authorization", "in": "header", "description": "Bearer ", "required": true, "schema": { "type": "string" }, "example": "Bearer access_token" }, { "name": "datoSistEndret", "in": "path", "description": "Sist endret dato", "required": true, "schema": { "type": "string" }, "example": "2020-01-01T00:00" } ], "responses": { "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResponseWrapper" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResponseWrapper" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TotalbestandWrapper" } } } } } } }, "/utlegg/totalbestand/": { "get": { "tags": [ "totalbestand-controller" ], "description": "Hent totalbestand om intet til utlegg og utleggstrekk på fødselsnummer, d-nummer og organisasjonsnummer (for kredittopplysningsforetak).", "operationId": "getTotalbestand", "parameters": [ { "name": "Authorization", "in": "header", "description": "Bearer ", "required": true, "schema": { "type": "string" }, "example": "Bearer access_token" } ], "responses": { "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResponseWrapper" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResponseWrapper" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TotalbestandWrapper" } } } } } } }, "/utlegg/totalbestand": { "get": { "tags": [ "totalbestand-controller" ], "description": "Hent totalbestand om intet til utlegg og utleggstrekk på fødselsnummer, d-nummer og organisasjonsnummer (for kredittopplysningsforetak).", "operationId": "getTotalbestand_1", "parameters": [ { "name": "Authorization", "in": "header", "description": "Bearer ", "required": true, "schema": { "type": "string" }, "example": "Bearer access_token" } ], "responses": { "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResponseWrapper" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResponseWrapper" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TotalbestandWrapper" } } } } } } }, "/utlegg/personer/{fodselsnummer}": { "get": { "tags": [ "utlegg-controller" ], "summary": "Henter opplysninger om intet til utlegg/utleggstrekk på et fødselsnummer/d-nummer.\nEndepunktet forventer en gyldig maskinporten token som bearer token.\n", "description": "Hent opplysninger om intet til utlegg og utleggstrekk på et fødselsnummer eller d-nummer (for distributører).", "operationId": "findByFodselsnr", "parameters": [ { "name": "Authorization", "in": "header", "description": "Bearer ", "required": true, "schema": { "type": "string" }, "example": "Bearer access_token" }, { "name": "fodselsnummer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "sokers_orgnummer", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResponseWrapper" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResponseWrapper" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UtleggDistributorWrapper" } } } } } } }, "/utlegg/personer/": { "get": { "tags": [ "utlegg-controller" ], "summary": "Henter opplysninger om intet til utlegg/utleggstrekk på et fødselsnummer/d-nummer.\nEndepunktet forventer en gyldig maskinporten token som bearer token.\n", "description": "Hent opplysninger om intet til utlegg og utleggstrekk på et fødselsnummer eller d-nummer (for distributører).", "operationId": "findByFodselsnr_1", "parameters": [ { "name": "Authorization", "in": "header", "description": "Bearer ", "required": true, "schema": { "type": "string" }, "example": "Bearer access_token" }, { "name": "sokers_orgnummer", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResponseWrapper" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResponseWrapper" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UtleggDistributorWrapper" } } } } } } }, "/utlegg/personer-utvidet/": { "get": { "tags": [ "utlegg-controller" ], "summary": "Henter opplysninger om intet til utlegg/utleggstrekk på et fødselsnummer/d-nummer.\nEndepunktet forventer en gyldig maskinporten token som bearer token.\n", "description": "Hent opplysninger om intet til utlegg og utleggstrekk på et fødselsnummer eller d-nummer (for kredittopplysningsforetak).", "operationId": "findByFodselsnrKredittforetak", "parameters": [ { "name": "Authorization", "in": "header", "description": "Bearer ", "required": true, "schema": { "type": "string" }, "example": "Bearer access_token" } ], "responses": { "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResponseWrapper" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResponseWrapper" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UtleggKredittforetakWrapper" } } } } } } }, "/utlegg/personer-utvidet/{fodselsnummer}": { "get": { "tags": [ "utlegg-controller" ], "summary": "Henter opplysninger om intet til utlegg/utleggstrekk på et fødselsnummer/d-nummer.\nEndepunktet forventer en gyldig maskinporten token som bearer token.\n", "description": "Hent opplysninger om intet til utlegg og utleggstrekk på et fødselsnummer eller d-nummer (for kredittopplysningsforetak).", "operationId": "findByFodselsnrKredittforetak_1", "parameters": [ { "name": "Authorization", "in": "header", "description": "Bearer ", "required": true, "schema": { "type": "string" }, "example": "Bearer access_token" }, { "name": "fodselsnummer", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResponseWrapper" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResponseWrapper" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UtleggKredittforetakWrapper" } } } } } } }, "/utlegg/enheter/": { "get": { "tags": [ "utlegg-controller" ], "summary": "Henter opplysninger om intet til utlegg på et organisasjonsnummer.\nEndepunktet forventer en gyldig maskinporten token som bearer token.\n", "description": "Hent opplysninger om intet til utlegg på et organisasjonsnummer (for distributører).", "operationId": "findByOrganisasjonsnummer", "parameters": [ { "name": "Authorization", "in": "header", "description": "Bearer ", "required": true, "schema": { "type": "string" }, "example": "Bearer access_token" }, { "name": "sokers_orgnummer", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResponseWrapper" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResponseWrapper" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UtleggDistributorWrapper" } } } } } } }, "/utlegg/enheter/{organisasjonsnummer}": { "get": { "tags": [ "utlegg-controller" ], "summary": "Henter opplysninger om intet til utlegg på et organisasjonsnummer.\nEndepunktet forventer en gyldig maskinporten token som bearer token.\n", "description": "Hent opplysninger om intet til utlegg på et organisasjonsnummer (for distributører).", "operationId": "findByOrganisasjonsnummer_1", "parameters": [ { "name": "Authorization", "in": "header", "description": "Bearer ", "required": true, "schema": { "type": "string" }, "example": "Bearer access_token" }, { "name": "organisasjonsnummer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "sokers_orgnummer", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResponseWrapper" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResponseWrapper" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UtleggDistributorWrapper" } } } } } } }, "/utlegg/endringslogg/enheter/{datoOpprettet}": { "get": { "tags": [ "endringslogg-controller" ], "description": "Hent endringslogg om intet til utlegg på organisasjonsnummer basert på sist endret dato (for kredittopplysningsforetak).", "operationId": "finnNyeEndringsloggerForEnhetVedUid", "parameters": [ { "name": "Authorization", "in": "header", "description": "Bearer ", "required": true, "schema": { "type": "string" }, "example": "Bearer access_token" }, { "name": "datoOpprettet", "in": "path", "description": "Sist endret dato", "required": true, "schema": { "type": "string" }, "example": "2020-01-01T00:00" } ], "responses": { "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResponseWrapper" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResponseWrapper" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EndringsloggWrapper" } } } } } } }, "/utlegg/endringslogg/{datoOpprettet}": { "get": { "tags": [ "endringslogg-controller" ], "description": "Hent endringslogg om intet til utlegg og utleggstrekk på fødselsnummer, d-nummer og organisasjonsnummer basert på sist endret dato (for kredittopplysningsforetak).", "operationId": "finnNyeEndringsloggerVedUid", "parameters": [ { "name": "Authorization", "in": "header", "description": "Bearer ", "required": true, "schema": { "type": "string" }, "example": "Bearer access_token" }, { "name": "datoOpprettet", "in": "path", "description": "Sist endret dato", "required": true, "schema": { "type": "string" }, "example": "2020-01-01T00:00" } ], "responses": { "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResponseWrapper" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResponseWrapper" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EndringsloggWrapper" } } } } } } }, "/utlegg/endringslogg/": { "get": { "tags": [ "endringslogg-controller" ], "description": "Hent endringslogg om intet til utlegg og utleggstrekk på fødselsnummer, d-nummer og organisasjonsnummer basert på sist endret dato (for kredittopplysningsforetak).", "operationId": "finnNyeEndringsloggerVedUid_1", "parameters": [ { "name": "Authorization", "in": "header", "description": "Bearer ", "required": true, "schema": { "type": "string" }, "example": "Bearer access_token" } ], "responses": { "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResponseWrapper" } } } }, "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResponseWrapper" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EndringsloggWrapper" } } } } } } } }, "components": { "schemas": { "ResponseWrapper": { "type": "object" }, "Links": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Link" } }, "TotalbestandResponseKredittforetak": { "type": "object", "properties": { "antallITU": { "type": "integer", "format": "int32", "example": 0 }, "antallUTT": { "type": "integer", "format": "int32", "example": 1 }, "datoSistEndret": { "type": "string", "example": "2020-01-01T00:00:00" }, "meldinger": { "type": "array", "items": { "type": "string" } }, "links": { "$ref": "#/components/schemas/Links" }, "tilleggsinfo": { "type": "string" } } }, "TotalbestandWrapper": { "type": "object", "properties": { "totalbestandResponseKredittforetak": { "$ref": "#/components/schemas/TotalbestandResponseKredittforetak" } } }, "UtleggDistributorWrapper": { "type": "object", "properties": { "utleggResponseDistributor": { "$ref": "#/components/schemas/UtleggResponseDistributor" } } }, "UtleggResponseDistributor": { "type": "object", "properties": { "antallITU": { "type": "integer", "format": "int32", "example": 0 }, "antallUTT": { "type": "integer", "format": "int32", "example": 1 }, "meldinger": { "type": "array", "items": { "type": "string" } }, "info": { "type": "string", "writeOnly": true }, "links": { "$ref": "#/components/schemas/Links" }, "tilleggsinfo": { "type": "string" } } }, "UtleggKredittforetak": { "type": "object", "properties": { "ubnr": { "type": "integer", "format": "int64", "example": 20181230000026 }, "ubmeldnr": { "type": "integer", "format": "int32", "example": 1 }, "utleggstype": { "type": "string", "example": "UTT", "enum": [ "ITU", "UTT" ] }, "avholdtForretning": { "type": "string", "format": "date", "example": "2017-08-01" }, "innfortILosoreregisteret": { "type": "string", "format": "date", "example": "2017-08-02" }, "trekkprosent": { "type": "number", "format": "double", "example": 10.0 }, "trekkbelop": { "type": "number", "example": 25000.0 }, "trekkvaluta": { "type": "string", "example": "NOK" }, "periodeStart": { "type": "string", "format": "date", "example": "2017-07-13" }, "periodeSlutt": { "type": "string", "format": "date", "example": "2020-07-13" } } }, "UtleggKredittforetakWrapper": { "type": "object", "properties": { "utleggResponseKredittforetak": { "$ref": "#/components/schemas/UtleggResponseKredittforetak" } } }, "UtleggResponseKredittforetak": { "type": "object", "properties": { "antallITU": { "type": "integer", "format": "int32", "example": 0 }, "antallUTT": { "type": "integer", "format": "int32", "example": 1 }, "utlegg": { "type": "array", "items": { "$ref": "#/components/schemas/UtleggKredittforetak" } }, "meldinger": { "type": "array", "items": { "type": "string" } }, "links": { "$ref": "#/components/schemas/Links" }, "tilleggsinfo": { "type": "string" } } }, "EndringsloggResponseKredittforetak": { "type": "object", "properties": { "antallITU": { "type": "integer", "format": "int32", "example": 0 }, "antallUTT": { "type": "integer", "format": "int32", "example": 1 }, "datoSistEndret": { "type": "string", "example": "2020-01-01T00:00:00" }, "meldinger": { "type": "array", "items": { "type": "string" } }, "links": { "$ref": "#/components/schemas/Links" }, "tilleggsinfo": { "type": "string" } } }, "EndringsloggWrapper": { "type": "object", "properties": { "endringsloggResponseKredittforetak": { "$ref": "#/components/schemas/EndringsloggResponseKredittforetak" } } }, "Link": { "type": "object", "properties": { "href": { "type": "string" }, "hreflang": { "type": "string" }, "title": { "type": "string" }, "type": { "type": "string" }, "deprecation": { "type": "string" }, "profile": { "type": "string" }, "name": { "type": "string" }, "templated": { "type": "boolean" } } } } } }