RamBase REST APIs
Creating new department
| HTTP method | POST |
| URI | https://api.rambase.net/finance/departments |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Successful HTTP status code | 201 |
| API resource identifier | 3110, version 9 |
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.
DepartmentId
Required/mandatory field
Department identifier
Minimum value: 1
>{Integer}</DepartmentId>Name
Required/mandatory field
Name of department
>{String}</Name>Description
Description of department
This field is optional.
>{String}</Description>EffectivePeriod
Required/mandatory field
Effective period of the department
Minimum value: 199000
Maximum value: 299912
>{Integer}</EffectivePeriod>ExpirationPeriod
Expiration period of the department
Minimum value: 199000
Maximum value: 299912
This field is optional.
>{Integer}</ExpirationPeriod>Responsible
This field is optional.
>EmployeeId
Employee identifier
Minimum value: 100
This field is optional.
>{Integer}</EmployeeId>DepartmentId
Required/mandatory field
Department identifier
Minimum value: 1
": "{Integer}",Name
Required/mandatory field
Name of department
": "{String}",Description
Description of department
This field is optional.
": "{String}",EffectivePeriod
Required/mandatory field
Effective period of the department
Minimum value: 199000
Maximum value: 299912
": "{Integer}",ExpirationPeriod
Expiration period of the department
Minimum value: 199000
Maximum value: 299912
This field is optional.
": "{Integer}"Responsible
This field is optional.
": {EmployeeId
Employee identifier
Minimum value: 100
This field is optional.
": "{Integer}"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.
DepartmentId
Department identifier
>{Integer}</DepartmentId>Name
Name of department
>{String}</Name>Description
Description of department
>{String}</Description>LastGeneralLedgerPostingPeriod
Last general ledger posting period of department
>{Integer}</LastGeneralLedgerPostingPeriod>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>EmployeeId
Employee identifier
>{Integer}</EmployeeId>LastName
Last name of employee
>{String}</LastName>FirstName
First name of employee
>{String}</FirstName>EmployeeLink
Employee reference
>{String}</EmployeeLink>EffectivePeriod
Effective period of the department
>{Integer}</EffectivePeriod>ExpirationPeriod
Expiration period of the department
>{Integer}</ExpirationPeriod>EmployeeId
Employee identifier
>{Integer}</EmployeeId>LastName
Last name of employee
>{String}</LastName>FirstName
First name of employee
>{String}</FirstName>EmployeeLink
Employee reference
>{String}</EmployeeLink>DepartmentId
Department identifier
": "{Integer}",Status
Status of department
Possible domain values can be found here
": "{Integer}",Name
Name of department
": "{String}",Description
Description of department
": "{String}",LastGeneralLedgerPostingPeriod
Last general ledger posting period of department
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",EmployeeId
Employee identifier
": "{Integer}",LastName
Last name of employee
": "{String}",FirstName
First name of employee
": "{String}",EmployeeLink
Employee reference
": "{String}"EffectivePeriod
Effective period of the department
": "{Integer}",ExpirationPeriod
Expiration period of the department
": "{Integer}"EmployeeId
Employee identifier
": "{Integer}",LastName
Last name of employee
": "{String}",FirstName
First name of employee
": "{String}",EmployeeLink
Employee reference
": "{String}"
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 101015 HTTP 404 | Permission not found |
| Error 101420 HTTP 404 | Setting definition not found |
| Error 103703 HTTP 400 | To period is not valid. General ledger postings exists. |
| Error 101316 HTTP 400 | Department number {0} already exists |