API

Finance APIs

POST finance/SAFT-standard-codes

Resource for creating new SAF-T standard code.

HTTP method POST
URI https://api.rambase.net/finance/SAFT-standard-codes
Supported formats Xml, Html, Json (ex. $format=json)
Successful HTTP status code 201
API resource identifier 4846, version 3

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
<SAFTStandardCode>
2
     <Code
Code

Required/mandatory field

SAF-T standard code

>{String}</Code>
3
     <Type
Type

Required/mandatory field

Type of SAF-T standard code

Applicable domain values can be found here

>{String}</Type>
4
     <Name
Name

Required/mandatory field

Name of SAF-T standard code

>{String}</Name>
5
     <Description
Description

Description of SAF-T standard code

This field is optional.

>{String}</Description>
6
     <Country>
7
          <CountryId
CountryId

Required/mandatory field

Country identifier

Minimum value: 10000

>{Integer}</CountryId>
8
     </Country>
9
</SAFTStandardCode>
1
{
2
     "sAFTStandardCode": {
3
          "code
Code

Required/mandatory field

SAF-T standard code

": "{String}",
4
          "type
Type

Required/mandatory field

Type of SAF-T standard code

Applicable domain values can be found here

": "{String}",
5
          "name
Name

Required/mandatory field

Name of SAF-T standard code

": "{String}",
6
          "description
Description

Description of SAF-T standard code

This field is optional.

": "{String}",
7
          "country": {
8
               "countryId
CountryId

Required/mandatory field

Country identifier

Minimum value: 10000

": "{Integer}"
9
          }
10
     }
11
}

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.

$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.
$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$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
<SAFTStandardCode>
2
     <SAFTStandardCodeId
SAFTStandardCodeId

SAF-T standard code identifier

>{Integer}</SAFTStandardCodeId>
3
     <CreatedAt
CreatedAt

Date and time of creation

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

Status of SAF-T standard code

Possible domain values can be found here

>{Integer}</Status>
5
     <Code
Code

SAF-T standard code

>{String}</Code>
6
     <Type
Type

Type of SAF-T standard code

Possible domain values can be found here

>{String}</Type>
7
     <Name
Name

Name of SAF-T standard code

>{String}</Name>
8
     <Description
Description

Description of SAF-T standard code

>{String}</Description>
9
     <Country>
10
          <CountryCode
CountryCode

Country code of SAF-T standard code

>{String}</CountryCode>
11
     </Country>
12
     <Repository>
13
          <Scope
Scope

Scope of the object. GLOBAL objects is available in all RamBase systems. LOCAL objects is only available in current RamBase system.

Possible domain values can be found here

>{String}</Scope>
14
          <IsChanged
IsChanged

Tells whether this object has been changed locally and are ready to be committed to the Repository

>{Boolean}</IsChanged>
15
          <ChangedBy
ChangedBy

EmployeeId of the employee making the change

>
16
               <UserId
UserId

User identifier

>{Integer}</UserId>
17
               <Name
Name

Name of the user

>{String}</Name>
18
               <FirstName
FirstName

First name of the user

>{String}</FirstName>
19
               <UserLink
UserLink

User reference

>{String}</UserLink>
20
          </ChangedBy>
21
          <IsPendingDeployment
IsPendingDeployment

Tells whether this object has been changed locally and is ready to be deployed from the Repository

>{Boolean}</IsPendingDeployment>
22
     </Repository>
23
</SAFTStandardCode>
1
{
2
     "sAFTStandardCode": {
3
          "sAFTStandardCodeId
SAFTStandardCodeId

SAF-T standard code identifier

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

Date and time of creation

": "{Datetime}",
5
          "status
Status

Status of SAF-T standard code

Possible domain values can be found here

": "{Integer}",
6
          "code
Code

SAF-T standard code

": "{String}",
7
          "type
Type

Type of SAF-T standard code

Possible domain values can be found here

": "{String}",
8
          "name
Name

Name of SAF-T standard code

": "{String}",
9
          "description
Description

Description of SAF-T standard code

": "{String}",
10
          "country": {
11
               "countryCode
CountryCode

Country code of SAF-T standard code

": "{String}"
12
          },
13
          "repository": {
14
               "scope
Scope

Scope of the object. GLOBAL objects is available in all RamBase systems. LOCAL objects is only available in current RamBase system.

Possible domain values can be found here

": "{String}",
15
               "isChanged
IsChanged

Tells whether this object has been changed locally and are ready to be committed to the Repository

": "{Boolean}",
16
               "changedBy
ChangedBy

EmployeeId of the employee making the change

": {
17
                    "userId
UserId

User identifier

": "{Integer}",
18
                    "name
Name

Name of the user

": "{String}",
19
                    "firstName
FirstName

First name of the user

": "{String}",
20
                    "userLink
UserLink

User reference

": "{String}"
21
               },
22
               "isPendingDeployment
IsPendingDeployment

Tells whether this object has been changed locally and is ready to be deployed from the Repository

": "{Boolean}"
23
          }
24
     }
25
}

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:

Error 101079 HTTP 400 Mismatch in size of revision parameters
Error 106442 HTTP 400 Country is required
Error 100946 HTTP 400 Country code is not valid
Error 106443 HTTP 400 Type is required
Error 106444 HTTP 400 SAF-T standard code with the same code, country and type already exists