API

Finance APIs

POST base/companies/current/operating-countries/{countryId}/vat-specification?vatPeriod={vatPeriodId}/api-operations/100931/instances

Operation for validating schema, authenticating or sending schema to Altinn. Input decides which one happens. If authentication is not included, then it will validate. If only authentication is included, then it will authenticate to trigger sending of smscode. If authentication with sms code is included, then it will verify and send schema to Altinn.

This is an API operation. Read the documentation pages for more information about API operations.

HTTP method POST
URI https://api.rambase.net/base/companies/current/operating-countries/{countryId}/vat-specification?vatPeriod={vatPeriodId}/api-operations/100931/instances
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {countryId} Country identifier
Integer, minimum 10000
Successful HTTP status code 200
API resource identifier 4096, version 11

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
<Parameters
Parameters

This field is optional.

>
2
     <SubmissionType
SubmissionType

Type of message.
1 = new submission
2 = add to previous submission
3 = replace previous submission

Minimum value: 1

Maximum value: 3

This field is optional.

>{Integer}</SubmissionType>
3
     <AdditionalInformation
AdditionalInformation

Additional information to be included with message.

This field is optional.

>{String}</AdditionalInformation>
4
     <Authentication
Authentication

This field is optional.

>
5
          <AltinnApplicationId
AltinnApplicationId

Application id

This field is optional.

>{String}</AltinnApplicationId>
6
          <AltinnApplicationPassword
AltinnApplicationPassword

Application password

This field is optional.

>{String}</AltinnApplicationPassword>
7
          <AltinnSignSchema
AltinnSignSchema

marks if schema should be sent in signed or not

Default value: False

This field is optional.

>{Boolean}</AltinnSignSchema>
8
          <LoggedInAt
LoggedInAt

datetime for when user logged into rambase. needed for signing schema. example: 2021-02-25T07:36:57+01:00

This field is optional.

>{Datetime}</LoggedInAt>
9
          <Username
Username

Endusers Altinn username

This field is optional.

>{String}</Username>
10
          <Password
Password

Endusers Altinn password

This field is optional.

>{String}</Password>
11
          <Method
Method

Method of authentication used.

Applicable domain values can be found here

This field is optional.

>{String}</Method>
12
          <SMSCode
SMSCode

Sms code to be used when method is SMSPin

This field is optional.

>{String}</SMSCode>
13
     </Authentication>
14
     <BankAccount
BankAccount

This field is optional.

>
15
          <AccountNumber
AccountNumber

Account number used to identify the bank account

This field is optional.

>{String}</AccountNumber>
16
          <ChangedAccountNumber
ChangedAccountNumber

Account number used to identify the bank account that Altinn should use in the future.

This field is optional.

>{String}</ChangedAccountNumber>
17
     </BankAccount>
18
     <AltinnVATPeriod
AltinnVATPeriod

This field is optional.

>
19
          <Type
Type

Type of period. example 4 is two monthly, refer to Altinn schema for all possible types.

Minimum value: 0

This field is optional.

>{Integer}</Type>
20
          <Period
Period

Period in correct format for type. Period of year followed by period type. Example: 024 which means march-april period

This field is optional.

>{String}</Period>
21
          <Year
Year

Period year

Minimum value: 1990

Maximum value: 2999

This field is optional.

>{Integer}</Year>
22
     </AltinnVATPeriod>
23
     <Lines
Lines

This field is optional.

>
24
          <Line
Line

This field is optional.

>
25
               <LineId
LineId

Id of a line in Vat specification

This field is optional.

>{String}</LineId>
26
               <Title
Title

Title of Vat specification line

This field is optional.

>{String}</Title>
27
               <NetAmount
NetAmount

Total net amount for this VAT code in this VAT posting

This field is optional.

>{Decimal}</NetAmount>
28
               <VATAmount
VATAmount

Total VAT amount for this VAT code in this VAT posting

This field is optional.

>{Decimal}</VATAmount>
29
          </Line>
30
     </Lines>
31
</Parameters>
1
{
2
     "parameters
Parameters

This field is optional.

": {
3
          "submissionType
SubmissionType

Type of message.
1 = new submission
2 = add to previous submission
3 = replace previous submission

Minimum value: 1

Maximum value: 3

This field is optional.

": "{Integer}",
4
          "additionalInformation
AdditionalInformation

Additional information to be included with message.

This field is optional.

": "{String}",
5
          "authentication
Authentication

This field is optional.

": {
6
               "altinnApplicationId
AltinnApplicationId

Application id

This field is optional.

": "{String}",
7
               "altinnApplicationPassword
AltinnApplicationPassword

Application password

This field is optional.

": "{String}",
8
               "altinnSignSchema
AltinnSignSchema

marks if schema should be sent in signed or not

Default value: False

This field is optional.

": "{Boolean}",
9
               "loggedInAt
LoggedInAt

datetime for when user logged into rambase. needed for signing schema. example: 2021-02-25T07:36:57+01:00

This field is optional.

": "{Datetime}",
10
               "username
Username

Endusers Altinn username

This field is optional.

": "{String}",
11
               "password
Password

Endusers Altinn password

This field is optional.

": "{String}",
12
               "method
Method

Method of authentication used.

Applicable domain values can be found here

This field is optional.

": "{String}",
13
               "sMSCode
SMSCode

Sms code to be used when method is SMSPin

This field is optional.

": "{String}"
14
          },
15
          "bankAccount
BankAccount

This field is optional.

": {
16
               "accountNumber
AccountNumber

Account number used to identify the bank account

This field is optional.

": "{String}",
17
               "changedAccountNumber
ChangedAccountNumber

Account number used to identify the bank account that Altinn should use in the future.

This field is optional.

": "{String}"
18
          },
19
          "altinnVATPeriod
AltinnVATPeriod

This field is optional.

": {
20
               "type
Type

Type of period. example 4 is two monthly, refer to Altinn schema for all possible types.

Minimum value: 0

This field is optional.

": "{Integer}",
21
               "period
Period

Period in correct format for type. Period of year followed by period type. Example: 024 which means march-april period

This field is optional.

": "{String}",
22
               "year
Year

Period year

Minimum value: 1990

Maximum value: 2999

This field is optional.

": "{Integer}"
23
          },
24
          "lines
Lines

This field is optional.

": [
25
               {
26
                    "lineId
LineId

Id of a line in Vat specification

This field is optional.

": "{String}",
27
                    "title
Title

Title of Vat specification line

This field is optional.

": "{String}",
28
                    "netAmount
NetAmount

Total net amount for this VAT code in this VAT posting

This field is optional.

": "{Decimal}",
29
                    "vATAmount
VATAmount

Total VAT amount for this VAT code in this VAT posting

This field is optional.

": "{Decimal}"
30
               }
31
          ]
32
     }
33
}

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

vatPeriod Integer, optional Accounting period this VAT posting belongs to

Minimum: 190000,
Maximum: 299999
$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<OperationInstance>
2
     <OperationInstanceId
OperationInstanceId

Operation instance identifier

>{Integer}</OperationInstanceId>
3
     <Status
Status

Status of the instance, 2 = started, 7 = error, 9 = finished

>{Integer}</Status>
4
     <CreatedAt
CreatedAt

Date and time the operation instance was created

>{Datetime}</CreatedAt>
5
     <CreatedBy
CreatedBy

Reference to the creator

>
6
          <UserId
UserId

User identifier

>{Integer}</UserId>
7
          <UserLink
UserLink

User reference

>{String}</UserLink>
8
     </CreatedBy>
9
     <CreatedFor>
10
          <ObjectId
ObjectId

Identifier of the object

>{String}</ObjectId>
11
          <ObjectType
ObjectType

Type of object

>{String}</ObjectType>
12
          <ObjectLink
ObjectLink

API reference to the object

>{String}</ObjectLink>
13
          <ItemId
ItemId

Item-number of the object

>{Integer}</ItemId>
14
          <ItemType
ItemType

Type of item

>{String}</ItemType>
15
          <ItemLink
ItemLink

API reference to the item

>{String}</ItemLink>
16
          <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

>{String}</RamBaseKey>
17
     </CreatedFor>
18
     <ApiOperation>
19
          <ApiOprationId
ApiOprationId

Api operation identifiers

>{Integer}</ApiOprationId>
20
          <ApiOperationLink
ApiOperationLink

Api operation reference

>{String}</ApiOperationLink>
21
     </ApiOperation>
22
     <ObjectReference>
23
          <ObjectId
ObjectId

Identifier of the object

>{String}</ObjectId>
24
          <ObjectType
ObjectType

Type of object

>{String}</ObjectType>
25
          <ObjectLink
ObjectLink

API reference to the object

>{String}</ObjectLink>
26
          <ItemId
ItemId

Item-number of the object

>{Integer}</ItemId>
27
          <ItemType
ItemType

Type of item

>{String}</ItemType>
28
          <ItemLink
ItemLink

API reference to the item

>{String}</ItemLink>
29
          <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

>{String}</RamBaseKey>
30
     </ObjectReference>
31
     <Error>
32
          <Message
Message

Full error message/description. The message is generated from the specified ErrorMessage object, expanded with the given parameter(s).

>{String}</Message>
33
          <TranslatedMessage
TranslatedMessage

Full translated error description. The language used is specified either in $lang or by user settings. If error message don't exist in desired language, english will be used.

>{String}</TranslatedMessage>
34
          <StackTrace
StackTrace

Stack trace for details about the error

>{String}</StackTrace>
35
          <ErrorMessage
ErrorMessage

Contains a reference to the error message, if an error occured

>
36
               <ErrorMessageId
ErrorMessageId

Error message identifier

>{Integer}</ErrorMessageId>
37
               <ErrorMessageLink
ErrorMessageLink

Error message reference

>{String}</ErrorMessageLink>
38
          </ErrorMessage>
39
          <Parameters>
40
               <Parameter>
41
                    <Index
Index

Error Key

>{Integer}</Index>
42
                    <Value
Value

Value of the error parameter

>{String}</Value>
43
               </Parameter>
44
          </Parameters>
45
          <InnerErrors>
46
               <Error>
47
                    <Message
Message

Full error message/description. The message is generated from the specified ErrorMessage object, expanded with the given parameter(s).

>{String}</Message>
48
                    <TranslatedMessage
TranslatedMessage

Full translated error description. The language used is specified either in $lang or by user settings. If error message don't exist in desired language, english will be used.

>{String}</TranslatedMessage>
49
                    <StackTrace
StackTrace

Stack trace for details about the error

>{String}</StackTrace>
50
                    <ErrorMessage
ErrorMessage

Contains a reference to the error message, if an error occured

>
51
                         <ErrorMessageId
ErrorMessageId

Error message identifier

>{Integer}</ErrorMessageId>
52
                         <ErrorMessageLink
ErrorMessageLink

Error message reference

>{String}</ErrorMessageLink>
53
                    </ErrorMessage>
54
                    <Parameters>
55
                         <Parameter>
56
                              <Index
Index

Error Key

>{Integer}</Index>
57
                              <Value
Value

Value of the error parameter

>{String}</Value>
58
                         </Parameter>
59
                    </Parameters>
60
               </Error>
61
          </InnerErrors>
62
     </Error>
63
     <ResultValues>
64
          <ResultValue>
65
               <Key
Key

Key of the result value

>{String}</Key>
66
               <Value
Value

Value of the result value

>{String}</Value>
67
          </ResultValue>
68
     </ResultValues>
69
     <SystemJob
SystemJob

Contains a reference to the system job, if a system job was started

>
70
          <ObjectId
ObjectId

{OIN.ObjectId}

>{Integer}</ObjectId>
71
          <ObjectType
ObjectType

Type of object

>{String}</ObjectType>
72
          <PercentComplete
PercentComplete

Percent complete

>{Integer}</PercentComplete>
73
          <ObjectLink
ObjectLink

API reference to the object

>{String}</ObjectLink>
74
     </SystemJob>
75
     <OperationInstanceLink
OperationInstanceLink

Operation instance reference

>{String}</OperationInstanceLink>
76
</OperationInstance>
1
{
2
     "operationInstance": {
3
          "operationInstanceId
OperationInstanceId

Operation instance identifier

": "{Integer}",
4
          "status
Status

Status of the instance, 2 = started, 7 = error, 9 = finished

": "{Integer}",
5
          "createdAt
CreatedAt

Date and time the operation instance was created

": "{Datetime}",
6
          "createdBy
CreatedBy

Reference to the creator

": {
7
               "userId
UserId

User identifier

": "{Integer}",
8
               "userLink
UserLink

User reference

": "{String}"
9
          },
10
          "createdFor": {
11
               "objectId
ObjectId

Identifier of the object

": "{String}",
12
               "objectType
ObjectType

Type of object

": "{String}",
13
               "objectLink
ObjectLink

API reference to the object

": "{String}",
14
               "itemId
ItemId

Item-number of the object

": "{Integer}",
15
               "itemType
ItemType

Type of item

": "{String}",
16
               "itemLink
ItemLink

API reference to the item

": "{String}",
17
               "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

": "{String}"
18
          },
19
          "apiOperation": {
20
               "apiOprationId
ApiOprationId

Api operation identifiers

": "{Integer}",
21
               "apiOperationLink
ApiOperationLink

Api operation reference

": "{String}"
22
          },
23
          "objectReference": {
24
               "objectId
ObjectId

Identifier of the object

": "{String}",
25
               "objectType
ObjectType

Type of object

": "{String}",
26
               "objectLink
ObjectLink

API reference to the object

": "{String}",
27
               "itemId
ItemId

Item-number of the object

": "{Integer}",
28
               "itemType
ItemType

Type of item

": "{String}",
29
               "itemLink
ItemLink

API reference to the item

": "{String}",
30
               "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

": "{String}"
31
          },
32
          "error": {
33
               "message
Message

Full error message/description. The message is generated from the specified ErrorMessage object, expanded with the given parameter(s).

": "{String}",
34
               "translatedMessage
TranslatedMessage

Full translated error description. The language used is specified either in $lang or by user settings. If error message don't exist in desired language, english will be used.

": "{String}",
35
               "stackTrace
StackTrace

Stack trace for details about the error

": "{String}",
36
               "errorMessage
ErrorMessage

Contains a reference to the error message, if an error occured

": {
37
                    "errorMessageId
ErrorMessageId

Error message identifier

": "{Integer}",
38
                    "errorMessageLink
ErrorMessageLink

Error message reference

": "{String}"
39
               },
40
               "parameters": [
41
                    {
42
                         "index
Index

Error Key

": "{Integer}",
43
                         "value
Value

Value of the error parameter

": "{String}"
44
                    }
45
               ],
46
               "innerErrors": [
47
                    {
48
                         "message
Message

Full error message/description. The message is generated from the specified ErrorMessage object, expanded with the given parameter(s).

": "{String}",
49
                         "translatedMessage
TranslatedMessage

Full translated error description. The language used is specified either in $lang or by user settings. If error message don't exist in desired language, english will be used.

": "{String}",
50
                         "stackTrace
StackTrace

Stack trace for details about the error

": "{String}",
51
                         "errorMessage
ErrorMessage

Contains a reference to the error message, if an error occured

": {
52
                              "errorMessageId
ErrorMessageId

Error message identifier

": "{Integer}",
53
                              "errorMessageLink
ErrorMessageLink

Error message reference

": "{String}"
54
                         },
55
                         "parameters": [
56
                              {
57
                                   "index
Index

Error Key

": "{Integer}",
58
                                   "value
Value

Value of the error parameter

": "{String}"
59
                              }
60
                         ]
61
                    }
62
               ]
63
          },
64
          "resultValues": [
65
               {
66
                    "key
Key

Key of the result value

": "{String}",
67
                    "value
Value

Value of the result value

": "{String}"
68
               }
69
          ],
70
          "systemJob
SystemJob

Contains a reference to the system job, if a system job was started

": {
71
               "objectId
ObjectId

{OIN.ObjectId}

": "{Integer}",
72
               "objectType
ObjectType

Type of object

": "{String}",
73
               "percentComplete
PercentComplete

Percent complete

": "{Integer}",
74
               "objectLink
ObjectLink

API reference to the object

": "{String}"
75
          },
76
          "operationInstanceLink
OperationInstanceLink

Operation instance reference

": "{String}"
77
     }
78
}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return: