Finance APIs
Create accounting period
| HTTP method | POST |
| URI | https://api.rambase.net/finance/periods |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Successful HTTP status code | 201 |
| API resource identifier | 4166, 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.
Period
Required/mandatory field
Accounting period
Minimum value: 190000
Maximum value: 290000
>{Integer}</Period>Name
Name of accounting period
This field is optional.
>{String}</Name>Type
Type of accounting period
Applicable domain values can be found here
Default value: STANDARD
This field is optional.
>{String}</Type>Description
Description of accounting period
This field is optional.
>{String}</Description>StartDate
Required/mandatory field
Start date of accounting period
>{Date}</StartDate>EndDate
Required/mandatory field
End date of accounting period
>{Date}</EndDate>Period
Required/mandatory field
Accounting period
Minimum value: 190000
Maximum value: 290000
": "{Integer}",Name
Name of accounting period
This field is optional.
": "{String}",Type
Type of accounting period
Applicable domain values can be found here
Default value: STANDARD
This field is optional.
": "{String}",Description
Description of accounting period
This field is optional.
": "{String}",StartDate
Required/mandatory field
Start date of accounting period
": "{Date}",EndDate
Required/mandatory field
End date of accounting period
": "{Date}"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.
AccountingPeriodId
Accounting period identifier
>{Integer}</AccountingPeriodId>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>Period
Accounting period
>{Integer}</Period>Name
Name of accounting period
>{String}</Name>Description
Description of accounting period
>{String}</Description>AgioStatus
Agio status of accounting period
Possible domain values can be found here
>{Integer}</AgioStatus>IsReconciled
Indicates if all general ledger postings are registered and reconciled to transation documents.
>{Boolean}</IsReconciled>VATPeriod
Accounting period this VAT posting belongs to
>{Integer}</VATPeriod>StartDate
Start date of accounting period
>{Date}</StartDate>EndDate
End date of accounting period
>{Date}</EndDate>ClosedDate
Closed date of accounting period
>{Date}</ClosedDate>UserId
User identifier
>{Integer}</UserId>Name
Name of the user
>{String}</Name>FirstName
First name of the user
>{String}</FirstName>UserLink
User reference
>{String}</UserLink>EmployeeId
Employee identifier
>{Integer}</EmployeeId>LastName
Last name of employee
>{String}</LastName>FirstName
First name of employee
>{String}</FirstName>EmployeeLink
Employee reference
>{String}</EmployeeLink>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>CustomerAmount
Customer balance amount
>{Decimal}</CustomerAmount>SupplierAmount
Supplier balance amount
>{Decimal}</SupplierAmount>Amount
Inventory balance amount
>{Decimal}</Amount>ImportDate
Inventory balance imported date
>{Date}</ImportDate>Amount
Work in progress balance amount
>{Decimal}</Amount>ImportDate
Work in progress balance imported date
>{Date}</ImportDate>Amount
Product balance amount
>{Decimal}</Amount>ImportDate
Product balance imported date
>{Date}</ImportDate>Amount
Depreciation amount
>{Decimal}</Amount>AccountingPeriodId
Accounting period identifier
": "{Integer}",Status
Status of accounting period
Possible domain values can be found here
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",Period
Accounting period
": "{Integer}",Name
Name of accounting period
": "{String}",Type
Type of accounting period
Possible domain values can be found here
": "{String}",Description
Description of accounting period
": "{String}",AgioStatus
Agio status of accounting period
Possible domain values can be found here
": "{Integer}",IsReconciled
Indicates if all general ledger postings are registered and reconciled to transation documents.
": "{Boolean}",VATPeriod
Accounting period this VAT posting belongs to
": "{Integer}",StartDate
Start date of accounting period
": "{Date}",EndDate
End date of accounting period
": "{Date}",ClosedDate
Closed date of accounting period
": "{Date}",UserId
User identifier
": "{Integer}",Name
Name of the user
": "{String}",FirstName
First name of the user
": "{String}",UserLink
User reference
": "{String}"EmployeeId
Employee identifier
": "{Integer}",LastName
Last name of employee
": "{String}",FirstName
First name of employee
": "{String}",EmployeeLink
Employee reference
": "{String}",Currency
Three character code following the ISO 4217 standard
": "{String}",CustomerAmount
Customer balance amount
": "{Decimal}",SupplierAmount
Supplier balance amount
": "{Decimal}",Amount
Inventory balance amount
": "{Decimal}",ImportDate
Inventory balance imported date
": "{Date}"Amount
Work in progress balance amount
": "{Decimal}",ImportDate
Work in progress balance imported date
": "{Date}"Amount
Product balance amount
": "{Decimal}",ImportDate
Product balance imported date
": "{Date}"Status
Depreciation status
Possible domain values can be found here
": "{String}",Amount
Depreciation amount
": "{Decimal}"
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 100184 HTTP 404 | Accounting period not found |
| Error 101420 HTTP 404 | Setting definition not found |
| Error 100511 HTTP 400 | Invalid date |
| Error 105129 HTTP 400 | Start date cannot be greater than end date. |
| Error 105130 HTTP 400 | Both dates or no dates must be provided. |
| Error 105288 HTTP 400 | StartDate and EndDate must be provided when creating accounting periods manually. |