Fenerum API (v1)

Download OpenAPI specification:Download

Authentication

Token

Security Scheme Type API Key
Header parameter name: Authorization

ERPAccountBudget

api_v1_account-budgets_list

Authorizations:
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1_account-budgets_read

Authorizations:
path Parameters
id
required
integer

A unique integer value identifying this erp account budget.

Responses

Response samples

Content type
application/json
{
  • "erp_account": {
    },
  • "start_date": "2019-08-24",
  • "end_date": "string",
  • "start_amount": "string",
  • "calculated_amount": "string",
  • "model": "string",
  • "schema": "string"
}

Account

api_v1_accounts_list

An Account in Fenerum is a named entity who can have one or more subscriptions. Can be used for both companies and people.

Authorizations:
query Parameters
balance
string
subscriptions_status
string
legal_country
string
created_date__lte
string

Format: YYYY-MM-DDTHH:MM:SSZ

created_date__gte
string

Format: YYYY-MM-DDTHH:MM:SSZ

last_modified_date__lte
string

Format: YYYY-MM-DDTHH:MM:SSZ

last_modified_date__gte
string

Format: YYYY-MM-DDTHH:MM:SSZ

ordering
string

Which field to use when ordering the results.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

header Parameters
Fields
string

A comma-separated list of fields to be included in the Account representation.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1_accounts_create

Note that ean_invoicing and ean_number can only be set if you have an GLN/EAN invoicing feature enabled.

Authorizations:
Request Body schema: application/json
company_name
required
string (Company name) [ 1 .. 128 ] characters
code
required
string (Custom ID from external system) [ 1 .. 128 ] characters
erp_id
string or null (Erp id) [ 1 .. 128 ] characters
partner
integer or null (Partner)
ean_invoicing
boolean (Electronic invoicing)

Check this to use GLN/EAN/CVR invoice box instead of email for invoice delivery

einvoicing_identifier_schema
string (Einvoicing identifier schema)
Enum: "GLN" "ORGNR"

Choices depend on the Organization's and Account's countries.

ean_number
string or null (GLN/EAN number) <= 128 characters
invoice_note
string or null (Invoice note) <= 240 characters

Additional text that will be added to description on the invoice.

language
string (Language)
Enum: "en" "da" "nl" "fi" "de" "no" "pt" "es" "se"

Language of communication: if possible invoices, emails etc. will be translated to this language.

legal_address
required
string (Legal address) non-empty
legal_zipcode
required
string (Legal zipcode) [ 1 .. 128 ] characters
legal_city
required
string (Legal city) [ 1 .. 128 ] characters
legal_country
required
string (Legal country)
Enum: "AF" "AX" "AL" "DZ" "AS" "AD" "AO" "AI" "AQ" "AG" "AR" "AM" "AW" "AU" "AT" "AZ" "BS" "BH" "BD" "BB" "BY" "BE" "BZ" "BJ" "BM" "BT"