API för inlämning av digitala årsredovisningar

Inlamning

inlamning

Lämna in årsredovisning till eget utrymme för granskning och underskrift

Tjänsten kontrollerar att en digital årsredovisning är tekniskt korrekt och lägger den i eget utrymme. Om kontrollen går bra och mobiltbankid är false returnerar den här operationen http status 200 och inget mer behöver göras via API (årsredovisningen ska skrivas under senare via webben). Om kontrollen går bra och mobiltbankid är true initieras också direktunderskrift med mobilt bankid och årsredovisningen skickas in till Bolagsverket efter lyckad underskrift. Observera att den här operationen returnerar omedelbart med http status 202 (innan årsredovisningen är underskriven och mottagen) och att programvaran ska använda operationen /inlamning-status för att säkerställa att direktunderskrift och mottagning lyckas.


/inlamning/{inlamningtoken}

Usage and SDK Samples

curl -X post "https://api.bolagsverket.se/lamna-in-arsredovisning/v1.3/inlamning/{inlamningtoken}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InlamningApi;

import java.io.File;
import java.util.*;

public class InlamningApiExample {

    public static void main(String[] args) {
        
        InlamningApi apiInstance = new InlamningApi();
        UUID inlamningtoken = inlamningtoken_example; // UUID | Token för inlämning
        InlamningAnrop anropsobjekt = ; // InlamningAnrop | Andra uppgifter och själva årsredovisningen
        try {
            InlamningOK result = apiInstance.inlamning(inlamningtoken, anropsobjekt);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InlamningApi#inlamning");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InlamningApi;

public class InlamningApiExample {

    public static void main(String[] args) {
        InlamningApi apiInstance = new InlamningApi();
        UUID inlamningtoken = inlamningtoken_example; // UUID | Token för inlämning
        InlamningAnrop anropsobjekt = ; // InlamningAnrop | Andra uppgifter och själva årsredovisningen
        try {
            InlamningOK result = apiInstance.inlamning(inlamningtoken, anropsobjekt);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InlamningApi#inlamning");
            e.printStackTrace();
        }
    }
}
UUID *inlamningtoken = inlamningtoken_example; // Token för inlämning
InlamningAnrop *anropsobjekt = ; // Andra uppgifter och själva årsredovisningen

InlamningApi *apiInstance = [[InlamningApi alloc] init];

// Lämna in årsredovisning till eget utrymme för granskning och underskrift
[apiInstance inlamningWith:inlamningtoken
    anropsobjekt:anropsobjekt
              completionHandler: ^(InlamningOK output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiFrInlmningAvDigitalaRsredovisningar = require('api_fr_inlmning_av_digitala_rsredovisningar');

var api = new ApiFrInlmningAvDigitalaRsredovisningar.InlamningApi()

var inlamningtoken = inlamningtoken_example; // {UUID} Token för inlämning

var anropsobjekt = ; // {InlamningAnrop} Andra uppgifter och själva årsredovisningen


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.inlamning(inlamningtoken, anropsobjekt, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class inlamningExample
    {
        public void main()
        {
            
            var apiInstance = new InlamningApi();
            var inlamningtoken = inlamningtoken_example;  // UUID | Token för inlämning
            var anropsobjekt = new InlamningAnrop(); // InlamningAnrop | Andra uppgifter och själva årsredovisningen

            try
            {
                // Lämna in årsredovisning till eget utrymme för granskning och underskrift
                InlamningOK result = apiInstance.inlamning(inlamningtoken, anropsobjekt);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InlamningApi.inlamning: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\InlamningApi();
$inlamningtoken = inlamningtoken_example; // UUID | Token för inlämning
$anropsobjekt = ; // InlamningAnrop | Andra uppgifter och själva årsredovisningen

try {
    $result = $api_instance->inlamning($inlamningtoken, $anropsobjekt);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InlamningApi->inlamning: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InlamningApi;

my $api_instance = WWW::SwaggerClient::InlamningApi->new();
my $inlamningtoken = inlamningtoken_example; # UUID | Token för inlämning
my $anropsobjekt = WWW::SwaggerClient::Object::InlamningAnrop->new(); # InlamningAnrop | Andra uppgifter och själva årsredovisningen

eval { 
    my $result = $api_instance->inlamning(inlamningtoken => $inlamningtoken, anropsobjekt => $anropsobjekt);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InlamningApi->inlamning: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.InlamningApi()
inlamningtoken = inlamningtoken_example # UUID | Token för inlämning
anropsobjekt =  # InlamningAnrop | Andra uppgifter och själva årsredovisningen

try: 
    # Lämna in årsredovisning till eget utrymme för granskning och underskrift
    api_response = api_instance.inlamning(inlamningtoken, anropsobjekt)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InlamningApi->inlamning: %s\n" % e)

Parameters

Path parameters
Name Description
inlamningtoken*
Body parameters
Name Description
anropsobjekt *

Responses

Status: 200 - Årsredovisning är inlämnad till eget utrymme för senare underskrift via webben.

Status: 202 - Årsredovisning är inlämnad till eget utrymme och begäran om direktunderskrift är initierad. Programvaran ska anropa /inlamning-status för att säkerställa att underskrift lyckas och att Bolagsverket lämnat kvittens på att årsredovisningen är mottagen.

Status: 400 - Felaktig request

Status: 403 - Obehörig användare av tjänsten

Status: 404 - Organisationsnummer saknas

Status: 500 - Ospecificerat tekniskt fel

Status: 503 - Tjänsten temporärt otillgänglig

Status: 504 - Timeout


inlamningStatus

Hämta aktuell inlämningsstatus efter inlämning med direktunderskrift

Tjänsten kontrollerar aktuell status för en årsredovisning inlämnad för direktunderskrift. Upprepa periodiskt anrop till den här metoden så länge returnerad inlämningsstatus har typ underskrift_pagaende (lämna några sekunders mellanrum mellan försöken för att inte överbelasta tjänsten). När inlämningsstatus med typ arsredovisning_mottagen returneras finns också en kvittens (med kvittensnummer och tidpunkt) som betyder att den underskrivna årsredovisningen är mottagen av Bolagsverket.


/inlamning-status/{underskrifttoken}

Usage and SDK Samples

curl -X get "https://api.bolagsverket.se/lamna-in-arsredovisning/v1.3/inlamning-status/{underskrifttoken}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InlamningApi;

import java.io.File;
import java.util.*;

public class InlamningApiExample {

    public static void main(String[] args) {
        
        InlamningApi apiInstance = new InlamningApi();
        UUID underskrifttoken = underskrifttoken_example; // UUID | Underskrifttoken från inlämning till eget utrymme
        try {
            Inlamningstatus result = apiInstance.inlamningStatus(underskrifttoken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InlamningApi#inlamningStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InlamningApi;

public class InlamningApiExample {

    public static void main(String[] args) {
        InlamningApi apiInstance = new InlamningApi();
        UUID underskrifttoken = underskrifttoken_example; // UUID | Underskrifttoken från inlämning till eget utrymme
        try {
            Inlamningstatus result = apiInstance.inlamningStatus(underskrifttoken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InlamningApi#inlamningStatus");
            e.printStackTrace();
        }
    }
}
UUID *underskrifttoken = underskrifttoken_example; // Underskrifttoken från inlämning till eget utrymme

InlamningApi *apiInstance = [[InlamningApi alloc] init];

// Hämta aktuell inlämningsstatus efter inlämning med direktunderskrift
[apiInstance inlamningStatusWith:underskrifttoken
              completionHandler: ^(Inlamningstatus output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiFrInlmningAvDigitalaRsredovisningar = require('api_fr_inlmning_av_digitala_rsredovisningar');

var api = new ApiFrInlmningAvDigitalaRsredovisningar.InlamningApi()

var underskrifttoken = underskrifttoken_example; // {UUID} Underskrifttoken från inlämning till eget utrymme


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.inlamningStatus(underskrifttoken, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class inlamningStatusExample
    {
        public void main()
        {
            
            var apiInstance = new InlamningApi();
            var underskrifttoken = underskrifttoken_example;  // UUID | Underskrifttoken från inlämning till eget utrymme

            try
            {
                // Hämta aktuell inlämningsstatus efter inlämning med direktunderskrift
                Inlamningstatus result = apiInstance.inlamningStatus(underskrifttoken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InlamningApi.inlamningStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\InlamningApi();
$underskrifttoken = underskrifttoken_example; // UUID | Underskrifttoken från inlämning till eget utrymme

try {
    $result = $api_instance->inlamningStatus($underskrifttoken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InlamningApi->inlamningStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InlamningApi;

my $api_instance = WWW::SwaggerClient::InlamningApi->new();
my $underskrifttoken = underskrifttoken_example; # UUID | Underskrifttoken från inlämning till eget utrymme

eval { 
    my $result = $api_instance->inlamningStatus(underskrifttoken => $underskrifttoken);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InlamningApi->inlamningStatus: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.InlamningApi()
underskrifttoken = underskrifttoken_example # UUID | Underskrifttoken från inlämning till eget utrymme

try: 
    # Hämta aktuell inlämningsstatus efter inlämning med direktunderskrift
    api_response = api_instance.inlamningStatus(underskrifttoken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InlamningApi->inlamningStatus: %s\n" % e)

Parameters

Path parameters
Name Description
underskrifttoken*

Responses

Status: 200 - Aktuell inlämningsstatus

Status: 400 - Felaktig request

Status: 403 - Obehörig användare av tjänsten

Status: 404 - Underskrifttoken saknas

Status: 500 - Ospecificerat tekniskt fel

Status: 503 - Tjänsten temporärt otillgänglig

Status: 504 - Timeout


skapaInlamningtoken

Skapa token för kontroll och inlämning till eget utrymme

Tjänsten skapar token för användning vid kontroll och inlämning av digital årsredovisning. Samma token används både som kontrolltoken i operation /kontrollera/{kontrolltoken} och som inlamningtoken i operation /inlamning/{inlamningtoken}.


/skapa-inlamningtoken

Usage and SDK Samples

curl -X post "https://api.bolagsverket.se/lamna-in-arsredovisning/v1.3/skapa-inlamningtoken"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InlamningApi;

import java.io.File;
import java.util.*;

public class InlamningApiExample {

    public static void main(String[] args) {
        
        InlamningApi apiInstance = new InlamningApi();
        SkapaInlamningTokenAnrop anropsobjekt = ; // SkapaInlamningTokenAnrop | Personnummer och organisationsnummer
        try {
            SkapaTokenOK result = apiInstance.skapaInlamningtoken(anropsobjekt);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InlamningApi#skapaInlamningtoken");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InlamningApi;

public class InlamningApiExample {

    public static void main(String[] args) {
        InlamningApi apiInstance = new InlamningApi();
        SkapaInlamningTokenAnrop anropsobjekt = ; // SkapaInlamningTokenAnrop | Personnummer och organisationsnummer
        try {
            SkapaTokenOK result = apiInstance.skapaInlamningtoken(anropsobjekt);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InlamningApi#skapaInlamningtoken");
            e.printStackTrace();
        }
    }
}
SkapaInlamningTokenAnrop *anropsobjekt = ; // Personnummer och organisationsnummer

InlamningApi *apiInstance = [[InlamningApi alloc] init];

// Skapa token för kontroll och inlämning till eget utrymme
[apiInstance skapaInlamningtokenWith:anropsobjekt
              completionHandler: ^(SkapaTokenOK output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiFrInlmningAvDigitalaRsredovisningar = require('api_fr_inlmning_av_digitala_rsredovisningar');

var api = new ApiFrInlmningAvDigitalaRsredovisningar.InlamningApi()

var anropsobjekt = ; // {SkapaInlamningTokenAnrop} Personnummer och organisationsnummer


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.skapaInlamningtoken(anropsobjekt, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class skapaInlamningtokenExample
    {
        public void main()
        {
            
            var apiInstance = new InlamningApi();
            var anropsobjekt = new SkapaInlamningTokenAnrop(); // SkapaInlamningTokenAnrop | Personnummer och organisationsnummer

            try
            {
                // Skapa token för kontroll och inlämning till eget utrymme
                SkapaTokenOK result = apiInstance.skapaInlamningtoken(anropsobjekt);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InlamningApi.skapaInlamningtoken: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\InlamningApi();
$anropsobjekt = ; // SkapaInlamningTokenAnrop | Personnummer och organisationsnummer

try {
    $result = $api_instance->skapaInlamningtoken($anropsobjekt);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InlamningApi->skapaInlamningtoken: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InlamningApi;

my $api_instance = WWW::SwaggerClient::InlamningApi->new();
my $anropsobjekt = WWW::SwaggerClient::Object::SkapaInlamningTokenAnrop->new(); # SkapaInlamningTokenAnrop | Personnummer och organisationsnummer

eval { 
    my $result = $api_instance->skapaInlamningtoken(anropsobjekt => $anropsobjekt);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InlamningApi->skapaInlamningtoken: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.InlamningApi()
anropsobjekt =  # SkapaInlamningTokenAnrop | Personnummer och organisationsnummer

try: 
    # Skapa token för kontroll och inlämning till eget utrymme
    api_response = api_instance.skapaInlamningtoken(anropsobjekt)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InlamningApi->skapaInlamningtoken: %s\n" % e)

Parameters

Body parameters
Name Description
anropsobjekt *

Responses

Status: 200 - Uppgifter mottagna

Status: 400 - Felaktig request

Status: 403 - Obehörig användare av tjänsten

Status: 404 - Personnummer saknas

Status: 500 - Ospecificerat tekniskt fel

Status: 503 - Tjänsten temporärt otillgänglig

Status: 504 - Timeout


Kontroll

kontrollera

Kontrollera årsredovisning innan uppladdning till eget utrymme


/kontrollera/{kontrolltoken}

Usage and SDK Samples

curl -X post "https://api.bolagsverket.se/lamna-in-arsredovisning/v1.3/kontrollera/{kontrolltoken}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.KontrollApi;

import java.io.File;
import java.util.*;

public class KontrollApiExample {

    public static void main(String[] args) {
        
        KontrollApi apiInstance = new KontrollApi();
        UUID kontrolltoken = kontrolltoken_example; // UUID | Token för kontroll
        KontrolleraAnrop anropsobjekt = ; // KontrolleraAnrop | Själva årsredovisningen
        try {
            KontrolleraSvar result = apiInstance.kontrollera(kontrolltoken, anropsobjekt);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KontrollApi#kontrollera");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.KontrollApi;

public class KontrollApiExample {

    public static void main(String[] args) {
        KontrollApi apiInstance = new KontrollApi();
        UUID kontrolltoken = kontrolltoken_example; // UUID | Token för kontroll
        KontrolleraAnrop anropsobjekt = ; // KontrolleraAnrop | Själva årsredovisningen
        try {
            KontrolleraSvar result = apiInstance.kontrollera(kontrolltoken, anropsobjekt);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KontrollApi#kontrollera");
            e.printStackTrace();
        }
    }
}
UUID *kontrolltoken = kontrolltoken_example; // Token för kontroll
KontrolleraAnrop *anropsobjekt = ; // Själva årsredovisningen

KontrollApi *apiInstance = [[KontrollApi alloc] init];

// Kontrollera årsredovisning innan uppladdning till eget utrymme
[apiInstance kontrolleraWith:kontrolltoken
    anropsobjekt:anropsobjekt
              completionHandler: ^(KontrolleraSvar output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ApiFrInlmningAvDigitalaRsredovisningar = require('api_fr_inlmning_av_digitala_rsredovisningar');

var api = new ApiFrInlmningAvDigitalaRsredovisningar.KontrollApi()

var kontrolltoken = kontrolltoken_example; // {UUID} Token för kontroll

var anropsobjekt = ; // {KontrolleraAnrop} Själva årsredovisningen


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.kontrollera(kontrolltoken, anropsobjekt, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class kontrolleraExample
    {
        public void main()
        {
            
            var apiInstance = new KontrollApi();
            var kontrolltoken = kontrolltoken_example;  // UUID | Token för kontroll
            var anropsobjekt = new KontrolleraAnrop(); // KontrolleraAnrop | Själva årsredovisningen

            try
            {
                // Kontrollera årsredovisning innan uppladdning till eget utrymme
                KontrolleraSvar result = apiInstance.kontrollera(kontrolltoken, anropsobjekt);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling KontrollApi.kontrollera: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\KontrollApi();
$kontrolltoken = kontrolltoken_example; // UUID | Token för kontroll
$anropsobjekt = ; // KontrolleraAnrop | Själva årsredovisningen

try {
    $result = $api_instance->kontrollera($kontrolltoken, $anropsobjekt);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KontrollApi->kontrollera: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::KontrollApi;

my $api_instance = WWW::SwaggerClient::KontrollApi->new();
my $kontrolltoken = kontrolltoken_example; # UUID | Token för kontroll
my $anropsobjekt = WWW::SwaggerClient::Object::KontrolleraAnrop->new(); # KontrolleraAnrop | Själva årsredovisningen

eval { 
    my $result = $api_instance->kontrollera(kontrolltoken => $kontrolltoken, anropsobjekt => $anropsobjekt);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KontrollApi->kontrollera: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.KontrollApi()
kontrolltoken = kontrolltoken_example # UUID | Token för kontroll
anropsobjekt =  # KontrolleraAnrop | Själva årsredovisningen

try: 
    # Kontrollera årsredovisning innan uppladdning till eget utrymme
    api_response = api_instance.kontrollera(kontrolltoken, anropsobjekt)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KontrollApi->kontrollera: %s\n" % e)

Parameters

Path parameters
Name Description
kontrolltoken*
Body parameters
Name Description
anropsobjekt *

Responses

Status: 200 - Årsredovisning är kontrollerad, se utfall. Användaren av programvaran bör upplysas om dessa eventuella utfall. Årsredovisningen kan dock lämnas in till eget utrymme oavsett utfall eller inte.

Status: 400 - Felaktig request

Status: 403 - Obehörig användare av tjänsten

Status: 500 - Ospecificerat tekniskt fel

Status: 503 - Tjänsten temporärt otillgänglig

Status: 504 - Timeout


Generated 2019-06-11T08:29:53.611+02:00