Bidragskrav

API change history

Grensesnitt for overføring av krav/transaksjoner mellom bidragsområdet og Elin/Navi.

Sende krav

Operasjon for å levere en batch med krav fra NAV til regnskapet hos Skatteetaten. En krav-batch består av en liste med krav. Et krav består av en liste med konteringer. Det forventes at disse konteringen behandles samlet. Det vil si at hvis én av konteringene feiler, skal ingen av konteringene i kravet benyttes.

Dersom et krav feiler kan det forsøkes overført på nytt gjentatte ganger inntil kravet er overført. Krav som gjelder samme fagsak må leveres i korrekt rekkefølge. Feiler et krav i en sak, skal ikke senere krav i samme sak overføres. Senere krav i andre saker kan overføres, selv om noen av partene fra den feilende fagsaken er involvert.

Det forventes at et krav alltid inneholder de samme konteringene. Dersom et nytt vedtak fører til et nytt krav som venter på et tidligere feilende krav, skal ikke konteringene fra det seneste kravet slås sammen med det ventende kravet.

NAV har ansvar for å manuelt følge opp krav som ved flere forsøk ikke kan overføres, og vil løse opp i problemet i samarbeid med Skatteetaten.

Ved månedlig påløp skal ikke dette grensesnittet benyttes. Tilsvarende krav legges i stedet inn i en fil som overføres til Skatteetaten gjennom filslusa. Formatet på påløpsfilen skal leveres på gammelt XML-format, men uten persondata, kun br10.

Try it

Request

Request URL

Request headers

  • (optional)
    string
    Media type of the body sent to the API.
  • string
    Subscription key which provides access to this API. Found in your Profile.

Request body

{
  "krav": [
    {
      "konteringer": [
        {
          "transaksjonskode": "B1",
          "type": "NY",
          "soknadType": "EN",
          "gjelderIdent": "15878598161",
          "kravhaverIdent": "14871298182",
          "mottakerIdent": "15878598161",
          "skyldnerIdent": "28848596401",
          "belop": 2000,
          "valuta": "NOK",
          "periode": "2022-02-01",
          "vedtaksdato": "2022-03-18",
          "saksbehandlerId": "a123456",
          "attestantId": "a123456",
          "tekst": "VII W → 550 → 50 /11",
          "fagsystemId": "2201234",
          "delytelsesId": "123456789"
        },
        {
          "transaksjonskode": "B1",
          "type": "NY",
          "soknadType": "EN",
          "gjelderIdent": "15878598161",
          "kravhaverIdent": "14871298182",
          "mottakerIdent": "15878598161",
          "skyldnerIdent": "28848596401",
          "belop": 2000,
          "valuta": "NOK",
          "periode": "2022-03-01",
          "vedtaksdato": "2022-03-18",
          "saksbehandlerId": "a123456",
          "attestantId": "a123456",
          "tekst": "VII W → 550 → 50 /11",
          "fagsystemId": "2201234",
          "delytelsesId": "123456789"
        },
        {
          "transaksjonskode": "B1",
          "type": "NY",
          "soknadType": "EN",
          "gjelderIdent": "15878598161",
          "kravhaverIdent": "14871298182",
          "mottakerIdent": "15878598161",
          "skyldnerIdent": "28848596401",
          "belop": 2000,
          "valuta": "NOK",
          "periode": "2022-04-01",
          "vedtaksdato": "2022-03-18",
          "saksbehandlerId": "a123456",
          "attestantId": "a123456",
          "tekst": "VII W → 550 → 50 /11",
          "fagsystemId": "2201234",
          "delytelsesId": "123456789"
        },
        {
          "transaksjonskode": "G1",
          "type": "NY",
          "soknadType": "FABM",
          "gjelderIdent": "15878598161",
          "kravhaverIdent": "80000345435",
          "mottakerIdent": "80000345435",
          "skyldnerIdent": "15878598161",
          "belop": 1223,
          "valuta": "NOK",
          "periode": "2022-03-01",
          "vedtaksdato": "2022-03-18",
          "saksbehandlerId": "a123456",
          "attestantId": "a123456",
          "fagsystemId": "2201234",
          "delytelsesId": "123456790"
        },
        {
          "transaksjonskode": "G1",
          "type": "NY",
          "soknadType": "FABP",
          "gjelderIdent": "15878598161",
          "kravhaverIdent": "80000345435",
          "mottakerIdent": "80000345435",
          "skyldnerIdent": "28848596401",
          "belop": 1223,
          "valuta": "NOK",
          "periode": "2022-03-01",
          "vedtaksdato": "2022-03-18",
          "saksbehandlerId": "a123456",
          "attestantId": "a123456",
          "fagsystemId": "2201234",
          "delytelsesId": "123456791"
        }
      ]
    }
  ]
}
{
  "required": [
    "krav"
  ],
  "type": "object",
  "properties": {
    "krav": {
      "type": "array",
      "items": {
        "required": [
          "konteringer"
        ],
        "type": "object",
        "properties": {
          "konteringer": {
            "type": "array",
            "items": {
              "required": [
                "attestantId",
                "belop",
                "delytelsesId",
                "fagsystemId",
                "gjelderIdent",
                "kjoredato",
                "mottakerIdent",
                "periode",
                "saksbehandlerId",
                "skyldnerIdent",
                "soknadType",
                "transaksjonskode",
                "type",
                "valuta",
                "vedtaksdato"
              ],
              "type": "object",
              "properties": {
                "transaksjonskode": {
                  "type": "string",
                  "description": "Type transaksjon.\n\nGyldige transaksjonskoder er:\n| Kode  | Korreksjonskode | Beskrivelse                                |\n|-------|-----------------|--------------------------------------------|\n| A1    | A3              | Bidragsforskudd                            |\n| B1    | B3              | Underholdsbidrag (m/u tilleggsbidrag)      |\n| D1    | D3              | 18årsbidrag                                |\n| E1    | E3              | Bidrag til særlige utgifter (særtilskudd)  |\n| F1    | F3              | Ekrefellebidrag                            |\n| G1    | G3              | Gebyr                                      |\n| H1    | H3              | Tilbakekreving                             |\n| I1    |                 | Motregning                                 |\n| K1    |                 | Ettergivelse                               |\n| K2    |                 | Direkte oppgjør (innbetalt beløp)          |\n| K3    |                 | Tilbakekreving ettergivelse                |",
                  "example": "B1"
                },
                "type": {
                  "enum": [
                    "NY",
                    "ENDRING"
                  ],
                  "type": "string",
                  "description": "Konteringstypen er NY for nye konteringer for en stønad i en periode. Deretter skal alle konteringer for samme stønad i samme periode markere ENDRING, altså B3-konteringen og for alle påfølgende B1-konteringer.",
                  "example": "NY"
                },
                "soknadType": {
                  "type": "string",
                  "description": "Angirtypen behandling som har ført til konteringen.\n| Kode | Beskrivelse |\n|------|----------------------------------------------------------------------------|\n| IN   | Sendes første måned i et indeksreguleringsvedtak. Etter dette benyttes EN. |\n| FABM | Benyttes for gebyr som gjelder BM.                                         |\n| FABP | Benyttes for gebyr som gjelder BP.                                         |\n| EN   | Alle andre typer endringer. Også førstegangsvedtak.                        |\nLegg merke til at dette er et svært begrenset utvalgt sammenliknet med hva som tidligere ble sendt fra Oppdrag.",
                  "example": "EN"
                },
                "gjelderIdent": {
                  "type": "string",
                  "description": "Personident (FNR/DNR) til bidragsmottaker i bidragssaken. I saker der bidragsmottaker ikke er satt benyttes et dummynr 22222222226",
                  "example": "15878598161"
                },
                "kravhaverIdent": {
                  "type": "string",
                  "description": "Personident (FNR/DNR) eller aktoernummer (TSS-ident/samhandler) til kravhaver.\n\nKravhaver angis ikke for gebyr.",
                  "example": "14871298182"
                },
                "mottakerIdent": {
                  "type": "string",
                  "description": "Personident (FNR/DNR) eller aktoernummer (TSS-ident/samhandler) til mottaker av kravet.\n\nFor gebyr settes mottakerIdent til NAVs aktoernummer 80000345435.",
                  "example": "15878598161"
                },
                "skyldnerIdent": {
                  "type": "string",
                  "description": "Personident (FNR/DNR) eller aktoernummer (TSS-ident/samhandler) til skyldner. For Bidrag er dette BP i saken.\n\nFor forskudd settes skyldnerIdent til NAVs aktoernummer 80000345435.",
                  "example": "28848596401"
                },
                "belop": {
                  "type": "number",
                  "description": "Konteringens beløp. Positive beløp og 0 regnes som tillegg, negative beløp som fradrag.",
                  "example": 2000.0
                },
                "valuta": {
                  "type": "string",
                  "description": "Valutakoden for beløpet.",
                  "example": "NOK"
                },
                "periode": {
                  "type": "string",
                  "description": "Angir hvilken periode (måned og år) konteringen gjelder.",
                  "format": "yyyy-mm",
                  "example": "2022-04"
                },
                "vedtaksdato": {
                  "type": "string",
                  "description": "Datoen vedtaket er fattet",
                  "format": "date",
                  "example": "2022-03-18"
                },
                "kjoredato": {
                  "type": "string",
                  "description": "Datoen kravet/konteringen gjøres klart for overføring. For direkteoverførte online-vedtak blir datoen sannsynligvis det samme som vedtaksdato. For påløp blir datoen satt til dagen påløpet genereres.",
                  "format": "date",
                  "example": "2022-03-18"
                },
                "saksbehandlerId": {
                  "type": "string",
                  "description": "NAVs brukerid for saksbehandler som har fattet vedtaket",
                  "example": "a123456"
                },
                "attestantId": {
                  "type": "string",
                  "description": "NAVs brukerid for saksbehandler som har attestert vedtaket (sannsynligvis samme som saksbehandlerId over).",
                  "example": "a123456"
                },
                "tekst": {
                  "type": "string",
                  "description": "Felt hvor utlandsavdelingen legger inn referansenummer (ffu-ref). Dette er et fritekstfelt som kan inneholde spesialtegn.\n\nTODO: Bedre navn på feltet? Hva blir riktig regnskapsmessig?",
                  "example": "VII W → 450 → 40 /11"
                },
                "fagsystemId": {
                  "type": "string",
                  "description": "Bidragssakens saksnummer angitt som String.",
                  "example": "2201234"
                },
                "delytelsesId": {
                  "type": "string",
                  "description": "Unik referanse til perioden i vedtaket angitt som String. I bidragssaken kan en periode strekke over flere måneder, og samme referanse blir da benyttet for alle månedene. Samme referanse kan ikke benyttes to ganger for samme transaksjonskode i samme måned.",
                  "example": "123456789"
                }
              },
              "description": "En kontering angir hvor mye som skal betales av skyldner til mottaker på vegne av kravhaver.\n\nKonteringen kan unikt identifiseres med kombinasjonen transaksjonskode, delytelsesId og periode. Det forutsettes at delytelsesid'n er unik også på tvers av fagsystemid'er.\n\nPersonidenter for gjelderIdent, kravhaverIdent, mottakerIdent og skyldnerIdent angis med enten FNR eller DNR. (Håndtering av BNR og NPID er uavklart.) Aktoernummer kan benyttes i kravhaverIdent, mottakerIdent og skyldnerIdent. Aktoernummere er elleve siffer og starter med enten 8 eller 9. \n\nI testmiljøene må Tenor-identer støttes i stedet for FNR/DNR. Disse identene har 8 eller 9 i tredje siffer."
            },
            "description": "En liste med konteringene i kravet."
          }
        },
        "description": "Et krav består av en liste med konteringer. "
      },
      "description": "Listen med krav."
    }
  },
  "description": "En sett med krav."
}

Responses

400 Bad Request

Forespørsel er ugyldig.

Representations

{
  "feilkode": "UGYLDIG_JSON",
  "feilmelding": "Did not expect ' on line 35, column 3"
}
{
  "required": [
    "feilkode",
    "feilmelding"
  ],
  "type": "object",
  "properties": {
    "feilkode": {
      "type": "string",
      "description": "En kode som beskriver feilsituasjonen. Koden skal være lik for like situasjoner.",
      "example": "UGYLDIG_TOKEN"
    },
    "feilmelding": {
      "type": "string",
      "description": "En tekst som beskriver denne konkrete feilsituasjonen. Beskrivelsen bør inneholde nok informasjon til at problemet kan løses.",
      "example": "Token utløp 2022-11-01 10:00:00"
    }
  },
  "description": "Et kall har ført til feilmelding."
}

202 Accepted

Alle konteringene i kravet er oppdatert OK. Responsen har tom body.

Det forventes også responskode 200 dersom kravet (og dermed konteringene) er overført tidligere. Det forventes da at kravet ignoreres slik at ikke konteringene posteres dobbelt.

Representations

{
  "batchUid": "bd27abf5-0632-414d-af4e-47bdecff2c2a"
}
{
  "required": [
    "batchUid"
  ],
  "type": "object",
  "properties": {
    "batchUid": {
      "type": "string",
      "description": "Referanse til prosessering av konteringene.",
      "example": "bd27abf5-0632-414d-af4e-47bdecff2c2a"
    }
  },
  "description": "Svar med referane til videre behandling av konteringene."
}

401 Unauthorized

Dersom klienten ikke er autentisert.

Representations

{
  "feilkode": "TOKEN_MANGLER",
  "feilmelding": "Fant ingen token i requesten."
}
{
  "required": [
    "feilkode",
    "feilmelding"
  ],
  "type": "object",
  "properties": {
    "feilkode": {
      "type": "string",
      "description": "En kode som beskriver feilsituasjonen. Koden skal være lik for like situasjoner.",
      "example": "UGYLDIG_TOKEN"
    },
    "feilmelding": {
      "type": "string",
      "description": "En tekst som beskriver denne konkrete feilsituasjonen. Beskrivelsen bør inneholde nok informasjon til at problemet kan løses.",
      "example": "Token utløp 2022-11-01 10:00:00"
    }
  },
  "description": "Et kall har ført til feilmelding."
}

403 Forbidden

Dersom klienten ikke har tilgang.

Representations

{
  "feilkode": "INGEN_TILGANG",
  "feilmelding": "Ingen tilgang med vedlagte token"
}
{
  "required": [
    "feilkode",
    "feilmelding"
  ],
  "type": "object",
  "properties": {
    "feilkode": {
      "type": "string",
      "description": "En kode som beskriver feilsituasjonen. Koden skal være lik for like situasjoner.",
      "example": "UGYLDIG_TOKEN"
    },
    "feilmelding": {
      "type": "string",
      "description": "En tekst som beskriver denne konkrete feilsituasjonen. Beskrivelsen bør inneholde nok informasjon til at problemet kan løses.",
      "example": "Token utløp 2022-11-01 10:00:00"
    }
  },
  "description": "Et kall har ført til feilmelding."
}

500 Internal Server Error

Ukjent feil.

Representations

{
  "feilkode": "UKJENT_FEIL",
  "feilmelding": "Intern feil"
}
{
  "required": [
    "feilkode",
    "feilmelding"
  ],
  "type": "object",
  "properties": {
    "feilkode": {
      "type": "string",
      "description": "En kode som beskriver feilsituasjonen. Koden skal være lik for like situasjoner.",
      "example": "UGYLDIG_TOKEN"
    },
    "feilmelding": {
      "type": "string",
      "description": "En tekst som beskriver denne konkrete feilsituasjonen. Beskrivelsen bør inneholde nok informasjon til at problemet kan løses.",
      "example": "Token utløp 2022-11-01 10:00:00"
    }
  },
  "description": "Et kall har ført til feilmelding."
}

503 Service Unavailable

Service unavailable - Påløpsmodus er på.

Representations

{
  "feilkode": "VEDLIKEHOLD_MODUS",
  "feilmelding": "Tjenesten er utilgjengelig under vedlikehold"
}
{
  "required": [
    "feilkode",
    "feilmelding"
  ],
  "type": "object",
  "properties": {
    "feilkode": {
      "type": "string",
      "description": "En kode som beskriver feilsituasjonen. Koden skal være lik for like situasjoner.",
      "example": "UGYLDIG_TOKEN"
    },
    "feilmelding": {
      "type": "string",
      "description": "En tekst som beskriver denne konkrete feilsituasjonen. Beskrivelsen bør inneholde nok informasjon til at problemet kan løses.",
      "example": "Token utløp 2022-11-01 10:00:00"
    }
  },
  "description": "Et kall har ført til feilmelding."
}

Code samples

@ECHO OFF

curl -v -X POST "https://api-preprod.nav.no/bidrag/v1/bidragskrav/api/krav"
-H "Content-Type: application/json"
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}" 

using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            var uri = "https://api-preprod.nav.no/bidrag/v1/bidragskrav/api/krav?" + queryString;

            HttpResponseMessage response;

            // Request body
            byte[] byteData = Encoding.UTF8.GetBytes("{body}");

            using (var content = new ByteArrayContent(byteData))
            {
               content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
               response = await client.PostAsync(uri, content);
            }

        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://api-preprod.nav.no/bidrag/v1/bidragskrav/api/krav");


            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            request.setHeader("Content-Type", "application/json");
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}


<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
        };
      
        $.ajax({
            url: "https://api-preprod.nav.no/bidrag/v1/bidragskrav/api/krav?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Content-Type","application/json");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "POST",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>

#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://api-preprod.nav.no/bidrag/v1/bidragskrav/api/krav";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"POST"];
    // Request headers
    [_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}

<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://api-preprod.nav.no/bidrag/v1/bidragskrav/api/krav');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Content-Type' => 'application/json',
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_POST);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('api-preprod.nav.no')
    conn.request("POST", "/bidrag/v1/bidragskrav/api/krav?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('api-preprod.nav.no')
    conn.request("POST", "/bidrag/v1/bidragskrav/api/krav?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://api-preprod.nav.no/bidrag/v1/bidragskrav/api/krav')


request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json'
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body