Finance APIs

GET finance/SAFT-standard-codes/{sAFTStandardCodeId}

SAF-T standard code for provided identifier

HTTP method	GET
URI	https://api.rambase.net/finance/SAFT-standard-codes/{sAFTStandardCodeId}
Supported formats	Xml, Html, Json (ex. $format=json)
- URI parameter {sAFTStandardCodeId}	SAF-T standard code identifier Integer, minimum 100000
Successful HTTP status code	200
API resource identifier	4812, version 2

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:

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.

$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]
$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
$format String, optional	Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$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.
$select String, optional	Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$expand String, optional	Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information.

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. Fields colored in grey is expandable fields.

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

Format:

                                        <SAFTStandardCode>
                                    

<SAFTStandardCodeId

SAFTStandardCodeId

SAF-T standard code identifier

>{Integer}</SAFTStandardCodeId>

<CreatedAt

CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>

<Status

Status

Status of SAF-T standard code

Possible domain values can be found here

>{Integer}</Status>

<Code

Code

SAF-T standard code

>{String}</Code>

<Type

Type

Type of SAF-T standard code

Possible domain values can be found here

>{String}</Type>

<Name

Name

Name of SAF-T standard code

>{String}</Name>

<TranslatedName

TranslatedName

Name of SAF-T standard code

This field is greyed out because it is an expandable field. You have to add $expand=TranslatedName in your request URI to get this field

>{String}</TranslatedName>

<Description

Description

Description of SAF-T standard code

>{String}</Description>

<TranslatedDescription

TranslatedDescription

Description of SAF-T standard code

This field is greyed out because it is an expandable field. You have to add $expand=TranslatedDescription in your request URI to get this field

>{String}</TranslatedDescription>

                                             <Country>
                                    

<CountryId

CountryId

Country identifier

This field is greyed out because it is an expandable field. You have to add $expand=Country.CountryId in your request URI to get this field

>{Integer}</CountryId>

<Name

Name

Name of country

This field is greyed out because it is an expandable field. You have to add $expand=Country.Name in your request URI to get this field

>{String}</Name>

<CountryCode

CountryCode

Country code of SAF-T standard code

>{String}</CountryCode>

<CountryLink

CountryLink

Country reference

This field is greyed out because it is an expandable field. You have to add $expand=Country.CountryLink in your request URI to get this field

>{String}</CountryLink>

                                             </Country>
                                    

                                             <Repository>
                                    

<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>

<IsChanged

IsChanged

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

>{Boolean}</IsChanged>

<ChangedBy

ChangedBy

EmployeeId of the employee making the change

<UserId

UserId

User identifier

>{Integer}</UserId>

<Name

Name

Name of the user

>{String}</Name>

<FirstName

FirstName

First name of the user

>{String}</FirstName>

<UserLink

UserLink

User reference

>{String}</UserLink>

                                                  </ChangedBy>
                                    

<IsPendingDeployment

IsPendingDeployment

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

>{Boolean}</IsPendingDeployment>

                                             </Repository>
                                    

                                        </SAFTStandardCode>
                                    

{

                                             "sAFTStandardCode": {
                                    

"sAFTStandardCodeId

SAFTStandardCodeId

SAF-T standard code identifier

": "{Integer}",

"createdAt

CreatedAt

Date and time of creation

": "{Datetime}",

"status

Status

Status of SAF-T standard code

Possible domain values can be found here

": "{Integer}",

"code

Code

SAF-T standard code

": "{String}",

"type

Type

Type of SAF-T standard code

Possible domain values can be found here

": "{String}",

"name

Name

Name of SAF-T standard code

": "{String}",

"translatedName

TranslatedName

Name of SAF-T standard code

This field is greyed out because it is an expandable field. You have to add $expand=TranslatedName in your request URI to get this field

": "{String}",

"description

Description

Description of SAF-T standard code

": "{String}",

"translatedDescription

TranslatedDescription

Description of SAF-T standard code

This field is greyed out because it is an expandable field. You have to add $expand=TranslatedDescription in your request URI to get this field

": "{String}",

                                                  "country": {
                                    

"countryId

CountryId

Country identifier

This field is greyed out because it is an expandable field. You have to add $expand=Country.CountryId in your request URI to get this field

": "{Integer}",

"name

Name

Name of country

This field is greyed out because it is an expandable field. You have to add $expand=Country.Name in your request URI to get this field

": "{String}",

"countryCode

CountryCode

Country code of SAF-T standard code

": "{String}",

"countryLink

CountryLink

Country reference

This field is greyed out because it is an expandable field. You have to add $expand=Country.CountryLink in your request URI to get this field

": "{String}"

},

                                                  "repository": {
                                    

"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}",

"isChanged

IsChanged

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

": "{Boolean}",

"changedBy

ChangedBy

EmployeeId of the employee making the change

": {

"userId

UserId

User identifier

": "{Integer}",

"name

Name

Name of the user

": "{String}",

"firstName

FirstName

First name of the user

": "{String}",

"userLink

UserLink

User reference

": "{String}"

},

"isPendingDeployment

IsPendingDeployment

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

": "{Boolean}"

}

}

}

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 101814 HTTP 404

Employee not found