Silverfin

The Silverfin Developer Hub

Welcome to the Silverfin developer hub. You'll find comprehensive guides and documentation to help you start working with Silverfin as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started

A period drop contains information about the current period

Methods

Method

Return type

Description

accounts

accounts drop

A collection of all accounts with bookings on this period

adjustments

adjustments drop

All adjustments attached to this period

bookyear_index

integer

Returns the index number of the current book year as an integer. The first book year equals 1.

Calendar_years

array

An array of all calendar years in the fiscal year. The information for each year is: start_date, end_date, amount_of_days and amount_of_days_in_full_year

custom

custom drop

A way to attach custom information to a period. This is done automatically in reconciliations.

directors

people drop

All people attached to this period that are shareholders.

end_date

date

The date this period ends

exists

boolean

Returns true when the period exists in the Silverfin database

fiscal_year

string

The fiscal year of this period.

is_first_year

boolean

Returns true if the period is in the first book year of this client file.

month_end_dates

array

An array of all the end dates of the calendar months in this fiscal year

name

string

The name of the period.

people

people drop

All people attached to the period (typically copied from general company level)

reconciliations

reconciliations drop

A collection of all reconciliations for this period. You can ask for a specific reconciliation by adding the handle. I.e. period.reconciliations.the_handle

reports

reports drop

A collection of all reports for this period. You can ask for a specific report by adding the handle. I.e. period.reports.the_handle

shareholders

people drop

All people attached to this period that are shareholders

start_date

date

The date this period starts

year_end

period drop

The period at the end of the fiscal year this period is in.

year_end_date

date

The date of the end of the fiscal year of this period.

year_start_date

date

The date of the start of the fiscal year of this period.

minus_1p,
minus_2p,
minus_3p,
...

period drop

The period drop of the current period minus the amount of periods defined.

minus_1y,
minus_2y,
minus_3y,
...

period drop

The period drop of the current period minus the amount of years defined.

plus_1p
plus_2p
plus_3p
...

period drop

The period drop of the current period plus the amount of periods defined.

plus_1y
plus_2y
plus_3y
...

period drop

The period drop of the current period plus the amount of years defined.

accounts

{% for account in period.accounts %}
{{ account }}
{% endfor %}
Output
AccountDrop
AccountDrop
AccountDrop
AccountDrop
...

adjustments

{% for adjustment in period.adjustments %}
{{ adjustment }}
{% endfor %}
Output
AdjustmentDrop
AdjustmentDrop
AdjustmentDrop
AdjustmentDrop
...

bookyear_index

{{ period.bookyear_index }}
Output
6

calendar_years

{% for calendar in period.calendar_years %}
Start date :            {{ calendar.start_date }}
End date :          {{ calendar.end_date }}
Amount of days in bookyear :    {{ calendar.amount_of_days }}
Amount of days in full year :   {{ calendar.amount_of_days_in_full_year }}
{% endfor %}
Output
Start date :			2019-01-01
End date :			2019-31-12
Amount of days in bookyear :  	365
Amount of days in full year : 	365

custom

Input field : {% input period.custom.some.thing %}
Print :       {{ period.custom.some.thing }}
Output

directors

{{period.directors
Output
PersonsDrop

end_date

{{ period.end_date }}
{{ period.end_date |date:"%d %B %Y"}}
{{ period.end_date |date:"%Y"}}
Output
2019-12-31
31 december 2019
2019

exists

{{ period.exists }}
Output
true

fiscal_year

{{ period.fiscal_year }}
Output
2020

is_first_year

{{ period.is_first_year }}
Output
false

month_end_dates

{{ period.month_end_dates }}
Output
2019-01-312019-02-282019-03-312019-04-302019-05-312019-06-302019-07-312019-08-312019-09-302019-10-312019-11-302019-12-31

name

{{ period.name }}
Output
2019

people

{{ period.people }}
Output
PersonsDrop

reconciliations

{{ period.reconciliations }}
Output
ReconciliationTextsDrop

reports

{{ period.reports }}
Output
ReportsDrop

shareholders

{{ period.shareholders }}
Output
PersonsDrop

start_date

{{ period.start_date }}
Output
2019-01-01

year_end

{{ period.year_end }}
Output
PeriodDrop

year_end_date

{{ period.year_end_date }}
Output
2019-12-31

year_start_date

{{ period.year_start_date }}
Output
2019-01-01

minus_1p, minus_2p, minus_3p, ...

{{ period.minus_1p }}
{{ period.minus_2p }}
{{ period.minus_3p }}
Output
PeriodDrop
PeriodDrop
PeriodDrop

minus_1y, minus_2y, minus_3y, ...

{{ period.minus_1y }}
{{ period.minus_2y }}
{{ period.minus_3y }}
Output
PeriodDrop
PeriodDrop
PeriodDrop

plus_1p, plus_2p, plus_3p, ...

{{ period.plus_1p }}
{{ period.plus_2p }}
{{ period.plus_3p }}
Output
PeriodDrop
PeriodDrop
PeriodDrop

plus_1y, plus_2y, plus_3y, ...

{{ period.plus_1y }}
{{ period.plus_2y }}
{{ period.plus_3y }}
Output
PeriodDrop
PeriodDrop
PeriodDrop

Updated about a year ago

Period


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.