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

Methods

Method

Return type

Description

count

integer

The amount of person drops in the people drop

first

person drop

Returns the person drop of the first person in the people drop.

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.

Special drops

Drop

Description

Directors

A people drop with only the directors

Shareholders

A people drop with only the shareholders

count:                    {{ period.people.count }}
first:                    {{ period.people.first }}
directors:                {{ period.directors.count }}
shareholders:             {{ period.shareholders.count }}
Output

Directors filters

Filter

Description

active_directors

Filter the directors which are active during the current bookyear.

active_as_director_on:

Filter the directors which are active in a specific date.

{% assign active_directors_bookyear = period.directors.active_as_director %}
{% for person in active_directors_bookyear %}
  {{ person.name }}
{% endfor %}


{% assign active_directors_today = period.directors | active_as_director_on:'today' %}
{% for person in active_directors_today %}
  {{ person.name }}
{% endfor %}

Updated 2 months ago

People


Suggested Edits are limited on API Reference Pages

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