API docs by Redocly

Fenerum API (v1)

Download OpenAPI specification:

E-mail: support@fenerum.com

SelfService

api_self_service_initiate_organization

This endpoint can be used to initiate self-service on behalf of a recipient/new user. It requires the self-service feature and the permission "initiate_self_service". The endpoint returns a direct link to self-service for the provided email.

Authorizations:
Token
Request Body schema: application/json
required
email
required
string <email> (Email) non-empty

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com"
}

Response samples

Content type
application/json
{}

ERPAccountBudget

api_v1_account-budgets_list

Authorizations:
Token
query Parameters
budget_id
string
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,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1_account-budgets_read

Authorizations:
Token
path Parameters
id
required
integer

A unique integer value identifying this erp account budget.

Responses

Response samples

Content type
application/json
{
  • "budget_id": "string",
  • "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:
Token
query Parameters
uuid
string
code
string
type
string
is_getting_reminders
string
is_archived
string
search
string

Filter by account name

balance
string
subscription_status
string
subscription_collection_method
string
subscription_set_to_expire
string
legal_country
string
active_payment_method
string
reseller_program
string
registered_for_direct_debit
string
register_status
string
ean_invoicing
string
has_recipient_receiving_invoices
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,
  • "next": "http://example.com",
  • "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:
Token
Request Body schema: application/json
required
company_name
string or null (Company name) [ 1 .. 256 ] characters
first_name
string or null (First name) [ 1 .. 128 ] characters
middle_name
string or null (Middle name) <= 128 characters
last_name
string or null (Last name) [ 1 .. 128 ] characters
title
string or null (Title)
Enum: "mr" "mrs" "ms"
gender
string or null (Gender)
Enum: "male" "female" "other"
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" "nb" "pl" "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 ZIP code) [ 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" "BO" "BQ" "BA" "BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "CV" "KH" "CM" "CA" "KY" "CF" "TD" "CL" "CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CW" "CY" "CZ" "DK" "DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "SZ" "ET" "FK" "FO" "FJ" "FI" "FR" "GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GG" "GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM" "IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU" "MO" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "NC" "NZ" "NI" "NE" "NG" "NU" "NF" "KP" "MK" "MP" "NO" "OM" "PK" "PW" "PS" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR" "QA" "RE" "RO" "RU" "RW" "BL" "SH" "KN" "LC" "MF" "PM" "VC" "WS" "SM" "ST" "SA" "SN" "RS" "SC" "SL" "SG" "SX" "SK" "SI" "SB" "SO" "ZA" "GS" "KR" "SS" "ES" "LK" "SD" "SR" "SJ" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "UM" "US" "UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW"
legal_vat_number
string (Legal VAT number) <= 128 characters
billing_same_as_legal
boolean (Billing address same as legal)
billing_address
string (Billing address)
billing_zipcode
string (Billing ZIP code) <= 128 characters
billing_city
string (Billing city) <= 128 characters
billing_country
string (Billing 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" "BO" "BQ" "BA" "BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "CV" "KH" "CM" "CA" "KY" "CF" "TD" "CL" "CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CW" "CY" "CZ" "DK" "DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "SZ" "ET" "FK" "FO" "FJ" "FI" "FR" "GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GG" "GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM" "IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU" "MO" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "NC" "NZ" "NI" "NE" "NG" "NU" "NF" "KP" "MK" "MP" "NO" "OM" "PK" "PW" "PS" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR" "QA" "RE" "RO" "RU" "RW" "BL" "SH" "KN" "LC" "MF" "PM" "VC" "WS" "SM" "ST" "SA" "SN" "RS" "SC" "SL" "SG" "SX" "SK" "SI" "SB" "SO" "ZA" "GS" "KR" "SS" "ES" "LK" "SD" "SR" "SJ" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "UM" "US" "UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW"
update_from_registers
boolean (Update from registers)

If you uncheck this, account address, company name etc. will not be updated from company registers.

default_payment_terms
integer or null (Default payment terms) [ -2147483648 .. 2147483647 ]

It will override organization level setting.

default_collection_method
string or null (Default collection method)
Enum: "payment_card" "invoice" "direct_debit"

It will override organization level setting.

is_getting_reminders
boolean (Is getting reminders)

If you uncheck this, no payment reminders will be sent for this account. You can also turn reminders off globally in Invoice Settings.

reseller
string or null <uuid> (Reseller)

Reseller which resells goods and subscriptions to this account.

reseller_code
string (Reseller code)

Should reference the account code (ID from external system). Can be used as an alternative to the UUID-field 'reseller'.

reseller_billing_frequency
string or null (Reseller billing frequency)
Enum: "daily" "end_of_month" "start_of_month" "end_of_week" "start_of_week" "start_and_end_of_month"

Choose how often to invoice the reseller account for resold goods and subscriptions: weekly invoices are sent every Sunday, and monthly invoices on the last day of the month.

reseller_billing_grouping
string or null (Group invoices by)
Enum: "currency" "currency_resold_account" "currency_resold_account_po_number"

Grouping of the invoices generated from the reseller invoice lines. Defaults to currency-grouping.

type
string (Account type)
Enum: "company" "person"
custom_fields
object (AccountCustomFields)

Responses

Request samples

Content type
application/json
{
  • "company_name": "string",
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "title": "mr",
  • "gender": "male",
  • "code": "string",
  • "erp_id": "string",
  • "partner": 0,
  • "ean_invoicing": true,
  • "einvoicing_identifier_schema": "GLN",
  • "ean_number": "string",
  • "invoice_note": "string",
  • "language": "en",
  • "legal_address": "string",
  • "legal_zipcode": "string",
  • "legal_city": "string",
  • "legal_country": "AF",
  • "legal_vat_number": "string",
  • "billing_same_as_legal": true,
  • "billing_address": "string",
  • "billing_zipcode": "string",
  • "billing_city": "string",
  • "billing_country": "AF",
  • "update_from_registers": true,
  • "default_payment_terms": -2147483648,
  • "default_collection_method": "payment_card",
  • "is_getting_reminders": true,
  • "reseller": "16bab917-518b-4590-b8d5-48af7a327279",
  • "reseller_code": "string",
  • "reseller_billing_frequency": "daily",
  • "reseller_billing_grouping": "currency",
  • "type": "company",
  • "custom_fields": { }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "display_name": "string",
  • "company_name": "string",
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "title": "mr",
  • "gender": "male",
  • "code": "string",
  • "erp_id": "string",
  • "partner": 0,
  • "ean_invoicing": true,
  • "einvoicing_identifier_schema": "GLN",
  • "ean_number": "string",
  • "invoice_note": "string",
  • "language": "en",
  • "legal_address": "string",
  • "legal_zipcode": "string",
  • "legal_city": "string",
  • "legal_country": "AF",
  • "legal_vat_number": "string",
  • "billing_same_as_legal": true,
  • "billing_address": "string",
  • "billing_zipcode": "string",
  • "billing_city": "string",
  • "billing_country": "AF",
  • "payment_gateway_account_set": [
    ],
  • "paymentcard_set": [
    ],
  • "subscription_set": [
    ],
  • "recipient_set": [
    ],
  • "draftinvoiceline_set": [
    ],
  • "created_date": "2019-08-24T14:15:22Z",
  • "last_modified_date": "2019-08-24T14:15:22Z",
  • "eu_vat_status": "string",
  • "update_from_registers": true,
  • "register_status": "active",
  • "industry": "string",
  • "default_payment_terms": -2147483648,
  • "default_collection_method": "payment_card",
  • "is_getting_reminders": true,
  • "is_archived": true,
  • "reseller": "16bab917-518b-4590-b8d5-48af7a327279",
  • "reseller_code": "string",
  • "reseller_billing_frequency": "daily",
  • "reseller_billing_grouping": "currency",
  • "type": "company",
  • "custom_fields": { },
  • "model": "string",
  • "schema": "string"
}

api_v1_accounts_export_balance

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

Authorizations:
Token
Request Body schema: application/json
required
company_name
string or null (Company name) [ 1 .. 256 ] characters
first_name
string or null (First name) [ 1 .. 128 ] characters
middle_name
string or null (Middle name) <= 128 characters
last_name
string or null (Last name) [ 1 .. 128 ] characters
title
string or null (Title)
Enum: "mr" "mrs" "ms"
gender
string or null (Gender)
Enum: "male" "female" "other"
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" "nb" "pl" "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 ZIP code) [ 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" "BO" "BQ" "BA" "BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "CV" "KH" "CM" "CA" "KY" "CF" "TD" "CL" "CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CW" "CY" "CZ" "DK" "DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "SZ" "ET" "FK" "FO" "FJ" "FI" "FR" "GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GG" "GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM" "IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU" "MO" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "NC" "NZ" "NI" "NE" "NG" "NU" "NF" "KP" "MK" "MP" "NO" "OM" "PK" "PW" "PS" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR" "QA" "RE" "RO" "RU" "RW" "BL" "SH" "KN" "LC" "MF" "PM" "VC" "WS" "SM" "ST" "SA" "SN" "RS" "SC" "SL" "SG" "SX" "SK" "SI" "SB" "SO" "ZA" "GS" "KR" "SS" "ES" "LK" "SD" "SR" "SJ" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "UM" "US" "UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW"
legal_vat_number
string (Legal VAT number) <= 128 characters
billing_same_as_legal
boolean (Billing address same as legal)
billing_address
string (Billing address)
billing_zipcode
string (Billing ZIP code) <= 128 characters
billing_city
string (Billing city) <= 128 characters
billing_country
string (Billing 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" "BO" "BQ" "BA" "BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "CV" "KH" "CM" "CA" "KY" "CF" "TD" "CL" "CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CW" "CY" "CZ" "DK" "DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "SZ" "ET" "FK" "FO" "FJ" "FI" "FR" "GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GG" "GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM" "IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU" "MO" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "NC" "NZ" "NI" "NE" "NG" "NU" "NF" "KP" "MK" "MP" "NO" "OM" "PK" "PW" "PS" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR" "QA" "RE" "RO" "RU" "RW" "BL" "SH" "KN" "LC" "MF" "PM" "VC" "WS" "SM" "ST" "SA" "SN" "RS" "SC" "SL" "SG" "SX" "SK" "SI" "SB" "SO" "ZA" "GS" "KR" "SS" "ES" "LK" "SD" "SR" "SJ" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "UM" "US" "UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW"
update_from_registers
boolean (Update from registers)

If you uncheck this, account address, company name etc. will not be updated from company registers.

default_payment_terms
integer or null (Default payment terms) [ -2147483648 .. 2147483647 ]

It will override organization level setting.

default_collection_method
string or null (Default collection method)
Enum: "payment_card" "invoice" "direct_debit"

It will override organization level setting.

is_getting_reminders
boolean (Is getting reminders)

If you uncheck this, no payment reminders will be sent for this account. You can also turn reminders off globally in Invoice Settings.

reseller
string or null <uuid> (Reseller)

Reseller which resells goods and subscriptions to this account.

reseller_code
string (Reseller code)

Should reference the account code (ID from external system). Can be used as an alternative to the UUID-field 'reseller'.

reseller_billing_frequency
string or null (Reseller billing frequency)
Enum: "daily" "end_of_month" "start_of_month" "end_of_week" "start_of_week" "start_and_end_of_month"

Choose how often to invoice the reseller account for resold goods and subscriptions: weekly invoices are sent every Sunday, and monthly invoices on the last day of the month.

reseller_billing_grouping
string or null (Group invoices by)
Enum: "currency" "currency_resold_account" "currency_resold_account_po_number"

Grouping of the invoices generated from the reseller invoice lines. Defaults to currency-grouping.

type
string (Account type)
Enum: "company" "person"
custom_fields
object (AccountCustomFields)

Responses

Request samples

Content type
application/json
{
  • "company_name": "string",
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "title": "mr",
  • "gender": "male",
  • "code": "string",
  • "erp_id": "string",
  • "partner": 0,
  • "ean_invoicing": true,
  • "einvoicing_identifier_schema": "GLN",
  • "ean_number": "string",
  • "invoice_note": "string",
  • "language": "en",
  • "legal_address": "string",
  • "legal_zipcode": "string",
  • "legal_city": "string",
  • "legal_country": "AF",
  • "legal_vat_number": "string",
  • "billing_same_as_legal": true,
  • "billing_address": "string",
  • "billing_zipcode": "string",
  • "billing_city": "string",
  • "billing_country": "AF",
  • "update_from_registers": true,
  • "default_payment_terms": -2147483648,
  • "default_collection_method": "payment_card",
  • "is_getting_reminders": true,
  • "reseller": "16bab917-518b-4590-b8d5-48af7a327279",
  • "reseller_code": "string",
  • "reseller_billing_frequency": "daily",
  • "reseller_billing_grouping": "currency",
  • "type": "company",
  • "custom_fields": { }
}

Response samples

Content type
application/json
{
  • "export_id": "string",
  • "job_uuid": "de25c4df-6d4e-439f-9d5f-a4c55d30f26e"
}

api_v1_accounts_export_mrr_per_month_report

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

Authorizations:
Token
Request Body schema: application/json
required

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "export_id": "string",
  • "job_uuid": "de25c4df-6d4e-439f-9d5f-a4c55d30f26e"
}

api_v1_accounts_export

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

Authorizations:
Token
Request Body schema: application/json
required

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "export_id": "string",
  • "job_uuid": "de25c4df-6d4e-439f-9d5f-a4c55d30f26e"
}

api_v1_accounts_read

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

Authorizations:
Token
path Parameters
code
required
string
header Parameters
Fields
string

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

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "display_name": "string",
  • "company_name": "string",
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "title": "mr",
  • "gender": "male",
  • "code": "string",
  • "erp_id": "string",
  • "partner": 0,
  • "ean_invoicing": true,
  • "einvoicing_identifier_schema": "GLN",
  • "ean_number": "string",
  • "invoice_note": "string",
  • "language": "en",
  • "legal_address": "string",
  • "legal_zipcode": "string",
  • "legal_city": "string",
  • "legal_country": "AF",
  • "legal_vat_number": "string",
  • "billing_same_as_legal": true,
  • "billing_address": "string",
  • "billing_zipcode": "string",
  • "billing_city": "string",
  • "billing_country": "AF",
  • "payment_gateway_account_set": [
    ],
  • "paymentcard_set": [
    ],
  • "subscription_set": [
    ],
  • "recipient_set": [
    ],
  • "draftinvoiceline_set": [
    ],
  • "created_date": "2019-08-24T14:15:22Z",
  • "last_modified_date": "2019-08-24T14:15:22Z",
  • "eu_vat_status": "string",
  • "update_from_registers": true,
  • "register_status": "active",
  • "industry": "string",
  • "default_payment_terms": -2147483648,
  • "default_collection_method": "payment_card",
  • "is_getting_reminders": true,
  • "is_archived": true,
  • "reseller": "16bab917-518b-4590-b8d5-48af7a327279",
  • "reseller_code": "string",
  • "reseller_billing_frequency": "daily",
  • "reseller_billing_grouping": "currency",
  • "type": "company",
  • "custom_fields": { },
  • "model": "string",
  • "schema": "string"
}

api_v1_accounts_update

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

Authorizations:
Token
path Parameters
code
required
string
Request Body schema: application/json
required
company_name
string or null (Company name) [ 1 .. 256 ] characters
first_name
string or null (First name) [ 1 .. 128 ] characters
middle_name
string or null (Middle name) <= 128 characters
last_name
string or null (Last name) [ 1 .. 128 ] characters
title
string or null (Title)
Enum: "mr" "mrs" "ms"
gender
string or null (Gender)
Enum: "male" "female" "other"
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" "nb" "pl" "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 ZIP code) [ 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" "BO" "BQ" "BA" "BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "CV" "KH" "CM" "CA" "KY" "CF" "TD" "CL" "CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CW" "CY" "CZ" "DK" "DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "SZ" "ET" "FK" "FO" "FJ" "FI" "FR" "GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GG" "GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM" "IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU" "MO" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "NC" "NZ" "NI" "NE" "NG" "NU" "NF" "KP" "MK" "MP" "NO" "OM" "PK" "PW" "PS" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR" "QA" "RE" "RO" "RU" "RW" "BL" "SH" "KN" "LC" "MF" "PM" "VC" "WS" "SM" "ST" "SA" "SN" "RS" "SC" "SL" "SG" "SX" "SK" "SI" "SB" "SO" "ZA" "GS" "KR" "SS" "ES" "LK" "SD" "SR" "SJ" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "UM" "US" "UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW"
legal_vat_number
string (Legal VAT number) <= 128 characters
billing_same_as_legal
boolean (Billing address same as legal)
billing_address
string (Billing address)
billing_zipcode
string (Billing ZIP code) <= 128 characters
billing_city
string (Billing city) <= 128 characters
billing_country
string (Billing 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" "BO" "BQ" "BA" "BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "CV" "KH" "CM" "CA" "KY" "CF" "TD" "CL" "CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CW" "CY" "CZ" "DK" "DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "SZ" "ET" "FK" "FO" "FJ" "FI" "FR" "GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GG" "GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM" "IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU" "MO" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "NC" "NZ" "NI" "NE" "NG" "NU" "NF" "KP" "MK" "MP" "NO" "OM" "PK" "PW" "PS" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR" "QA" "RE" "RO" "RU" "RW" "BL" "SH" "KN" "LC" "MF" "PM" "VC" "WS" "SM" "ST" "SA" "SN" "RS" "SC" "SL" "SG" "SX" "SK" "SI" "SB" "SO" "ZA" "GS" "KR" "SS" "ES" "LK" "SD" "SR" "SJ" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "UM" "US" "UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW"
update_from_registers
boolean (Update from registers)

If you uncheck this, account address, company name etc. will not be updated from company registers.

default_payment_terms
integer or null (Default payment terms) [ -2147483648 .. 2147483647 ]

It will override organization level setting.

default_collection_method
string or null (Default collection method)
Enum: "payment_card" "invoice" "direct_debit"

It will override organization level setting.

is_getting_reminders
boolean (Is getting reminders)

If you uncheck this, no payment reminders will be sent for this account. You can also turn reminders off globally in Invoice Settings.

reseller
string or null <uuid> (Reseller)

Reseller which resells goods and subscriptions to this account.

reseller_code
string (Reseller code)

Should reference the account code (ID from external system). Can be used as an alternative to the UUID-field 'reseller'.

reseller_billing_frequency
string or null (Reseller billing frequency)
Enum: "daily" "end_of_month" "start_of_month" "end_of_week" "start_of_week" "start_and_end_of_month"

Choose how often to invoice the reseller account for resold goods and subscriptions: weekly invoices are sent every Sunday, and monthly invoices on the last day of the month.

reseller_billing_grouping
string or null (Group invoices by)
Enum: "currency" "currency_resold_account" "currency_resold_account_po_number"

Grouping of the invoices generated from the reseller invoice lines. Defaults to currency-grouping.

type
string (Account type)
Enum: "company" "person"
custom_fields
object (AccountCustomFields)

Responses

Request samples

Content type
application/json
{
  • "company_name": "string",
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "title": "mr",
  • "gender": "male",
  • "code": "string",
  • "erp_id": "string",
  • "partner": 0,
  • "ean_invoicing": true,
  • "einvoicing_identifier_schema": "GLN",
  • "ean_number": "string",
  • "invoice_note": "string",
  • "language": "en",
  • "legal_address": "string",
  • "legal_zipcode": "string",
  • "legal_city": "string",
  • "legal_country": "AF",
  • "legal_vat_number": "string",
  • "billing_same_as_legal": true,
  • "billing_address": "string",
  • "billing_zipcode": "string",
  • "billing_city": "string",
  • "billing_country": "AF",
  • "update_from_registers": true,
  • "default_payment_terms": -2147483648,
  • "default_collection_method": "payment_card",
  • "is_getting_reminders": true,
  • "reseller": "16bab917-518b-4590-b8d5-48af7a327279",
  • "reseller_code": "string",
  • "reseller_billing_frequency": "daily",
  • "reseller_billing_grouping": "currency",
  • "type": "company",
  • "custom_fields": { }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "display_name": "string",
  • "company_name": "string",
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "title": "mr",
  • "gender": "male",
  • "code": "string",
  • "erp_id": "string",
  • "partner": 0,
  • "ean_invoicing": true,
  • "einvoicing_identifier_schema": "GLN",
  • "ean_number": "string",
  • "invoice_note": "string",
  • "language": "en",
  • "legal_address": "string",
  • "legal_zipcode": "string",
  • "legal_city": "string",
  • "legal_country": "AF",
  • "legal_vat_number": "string",
  • "billing_same_as_legal": true,
  • "billing_address": "string",
  • "billing_zipcode": "string",
  • "billing_city": "string",
  • "billing_country": "AF",
  • "payment_gateway_account_set": [
    ],
  • "paymentcard_set": [
    ],
  • "subscription_set": [
    ],
  • "recipient_set": [
    ],
  • "draftinvoiceline_set": [
    ],
  • "created_date": "2019-08-24T14:15:22Z",
  • "last_modified_date": "2019-08-24T14:15:22Z",
  • "eu_vat_status": "string",
  • "update_from_registers": true,
  • "register_status": "active",
  • "industry": "string",
  • "default_payment_terms": -2147483648,
  • "default_collection_method": "payment_card",
  • "is_getting_reminders": true,
  • "is_archived": true,
  • "reseller": "16bab917-518b-4590-b8d5-48af7a327279",
  • "reseller_code": "string",
  • "reseller_billing_frequency": "daily",
  • "reseller_billing_grouping": "currency",
  • "type": "company",
  • "custom_fields": { },
  • "model": "string",
  • "schema": "string"
}

api_v1_accounts_partial_update

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

Authorizations:
Token
path Parameters
code
required
string
Request Body schema: application/json
required
company_name
string or null (Company name) [ 1 .. 256 ] characters
first_name
string or null (First name) [ 1 .. 128 ] characters
middle_name
string or null (Middle name) <= 128 characters
last_name
string or null (Last name) [ 1 .. 128 ] characters
title
string or null (Title)
Enum: "mr" "mrs" "ms"
gender
string or null (Gender)
Enum: "male" "female" "other"
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" "nb" "pl" "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 ZIP code) [ 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" "BO" "BQ" "BA" "BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "CV" "KH" "CM" "CA" "KY" "CF" "TD" "CL" "CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CW" "CY" "CZ" "DK" "DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "SZ" "ET" "FK" "FO" "FJ" "FI" "FR" "GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GG" "GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM" "IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU" "MO" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "NC" "NZ" "NI" "NE" "NG" "NU" "NF" "KP" "MK" "MP" "NO" "OM" "PK" "PW" "PS" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR" "QA" "RE" "RO" "RU" "RW" "BL" "SH" "KN" "LC" "MF" "PM" "VC" "WS" "SM" "ST" "SA" "SN" "RS" "SC" "SL" "SG" "SX" "SK" "SI" "SB" "SO" "ZA" "GS" "KR" "SS" "ES" "LK" "SD" "SR" "SJ" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "UM" "US" "UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW"
legal_vat_number
string (Legal VAT number) <= 128 characters
billing_same_as_legal
boolean (Billing address same as legal)
billing_address
string (Billing address)
billing_zipcode
string (Billing ZIP code) <= 128 characters
billing_city
string (Billing city) <= 128 characters
billing_country
string (Billing 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" "BO" "BQ" "BA" "BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "CV" "KH" "CM" "CA" "KY" "CF" "TD" "CL" "CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CW" "CY" "CZ" "DK" "DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "SZ" "ET" "FK" "FO" "FJ" "FI" "FR" "GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GG" "GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM" "IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU" "MO" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "NC" "NZ" "NI" "NE" "NG" "NU" "NF" "KP" "MK" "MP" "NO" "OM" "PK" "PW" "PS" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR" "QA" "RE" "RO" "RU" "RW" "BL" "SH" "KN" "LC" "MF" "PM" "VC" "WS" "SM" "ST" "SA" "SN" "RS" "SC" "SL" "SG" "SX" "SK" "SI" "SB" "SO" "ZA" "GS" "KR" "SS" "ES" "LK" "SD" "SR" "SJ" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "UM" "US" "UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW"
update_from_registers
boolean (Update from registers)

If you uncheck this, account address, company name etc. will not be updated from company registers.

default_payment_terms
integer or null (Default payment terms) [ -2147483648 .. 2147483647 ]

It will override organization level setting.

default_collection_method
string or null (Default collection method)
Enum: "payment_card" "invoice" "direct_debit"

It will override organization level setting.

is_getting_reminders
boolean (Is getting reminders)

If you uncheck this, no payment reminders will be sent for this account. You can also turn reminders off globally in Invoice Settings.

reseller
string or null <uuid> (Reseller)

Reseller which resells goods and subscriptions to this account.

reseller_code
string (Reseller code)

Should reference the account code (ID from external system). Can be used as an alternative to the UUID-field 'reseller'.

reseller_billing_frequency
string or null (Reseller billing frequency)
Enum: "daily" "end_of_month" "start_of_month" "end_of_week" "start_of_week" "start_and_end_of_month"

Choose how often to invoice the reseller account for resold goods and subscriptions: weekly invoices are sent every Sunday, and monthly invoices on the last day of the month.

reseller_billing_grouping
string or null (Group invoices by)
Enum: "currency" "currency_resold_account" "currency_resold_account_po_number"

Grouping of the invoices generated from the reseller invoice lines. Defaults to currency-grouping.

type
string (Account type)
Enum: "company" "person"
custom_fields
object (AccountCustomFields)

Responses

Request samples

Content type
application/json
{
  • "company_name": "string",
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "title": "mr",
  • "gender": "male",
  • "code": "string",
  • "erp_id": "string",
  • "partner": 0,
  • "ean_invoicing": true,
  • "einvoicing_identifier_schema": "GLN",
  • "ean_number": "string",
  • "invoice_note": "string",
  • "language": "en",
  • "legal_address": "string",
  • "legal_zipcode": "string",
  • "legal_city": "string",
  • "legal_country": "AF",
  • "legal_vat_number": "string",
  • "billing_same_as_legal": true,
  • "billing_address": "string",
  • "billing_zipcode": "string",
  • "billing_city": "string",
  • "billing_country": "AF",
  • "update_from_registers": true,
  • "default_payment_terms": -2147483648,
  • "default_collection_method": "payment_card",
  • "is_getting_reminders": true,
  • "reseller": "16bab917-518b-4590-b8d5-48af7a327279",
  • "reseller_code": "string",
  • "reseller_billing_frequency": "daily",
  • "reseller_billing_grouping": "currency",
  • "type": "company",
  • "custom_fields": { }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "display_name": "string",
  • "company_name": "string",
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "title": "mr",
  • "gender": "male",
  • "code": "string",
  • "erp_id": "string",
  • "partner": 0,
  • "ean_invoicing": true,
  • "einvoicing_identifier_schema": "GLN",
  • "ean_number": "string",
  • "invoice_note": "string",
  • "language": "en",
  • "legal_address": "string",
  • "legal_zipcode": "string",
  • "legal_city": "string",
  • "legal_country": "AF",
  • "legal_vat_number": "string",
  • "billing_same_as_legal": true,
  • "billing_address": "string",
  • "billing_zipcode": "string",
  • "billing_city": "string",
  • "billing_country": "AF",
  • "payment_gateway_account_set": [
    ],
  • "paymentcard_set": [
    ],
  • "subscription_set": [
    ],
  • "recipient_set": [
    ],
  • "draftinvoiceline_set": [
    ],
  • "created_date": "2019-08-24T14:15:22Z",
  • "last_modified_date": "2019-08-24T14:15:22Z",
  • "eu_vat_status": "string",
  • "update_from_registers": true,
  • "register_status": "active",
  • "industry": "string",
  • "default_payment_terms": -2147483648,
  • "default_collection_method": "payment_card",
  • "is_getting_reminders": true,
  • "is_archived": true,
  • "reseller": "16bab917-518b-4590-b8d5-48af7a327279",
  • "reseller_code": "string",
  • "reseller_billing_frequency": "daily",
  • "reseller_billing_grouping": "currency",
  • "type": "company",
  • "custom_fields": { },
  • "model": "string",
  • "schema": "string"
}

api_v1_accounts_delete

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

Authorizations:
Token
path Parameters
code
required
string

Responses

api_v1_accounts_archive

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

Authorizations:
Token
path Parameters
code
required
string
Request Body schema: application/json
required
company_name
string or null (Company name) [ 1 .. 256 ] characters
first_name
string or null (First name) [ 1 .. 128 ] characters
middle_name
string or null (Middle name) <= 128 characters
last_name
string or null (Last name) [ 1 .. 128 ] characters
title
string or null (Title)
Enum: "mr" "mrs" "ms"
gender
string or null (Gender)
Enum: "male" "female" "other"
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" "nb" "pl" "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 ZIP code) [ 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" "BO" "BQ" "BA" "BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "CV" "KH" "CM" "CA" "KY" "CF" "TD" "CL" "CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CW" "CY" "CZ" "DK" "DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "SZ" "ET" "FK" "FO" "FJ" "FI" "FR" "GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GG" "GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM" "IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU" "MO" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "NC" "NZ" "NI" "NE" "NG" "NU" "NF" "KP" "MK" "MP" "NO" "OM" "PK" "PW" "PS" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR" "QA" "RE" "RO" "RU" "RW" "BL" "SH" "KN" "LC" "MF" "PM" "VC" "WS" "SM" "ST" "SA" "SN" "RS" "SC" "SL" "SG" "SX" "SK" "SI" "SB" "SO" "ZA" "GS" "KR" "SS" "ES" "LK" "SD" "SR" "SJ" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "UM" "US" "UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW"
legal_vat_number
string (Legal VAT number) <= 128 characters
billing_same_as_legal
boolean (Billing address same as legal)
billing_address
string (Billing address)
billing_zipcode
string (Billing ZIP code) <= 128 characters
billing_city
string (Billing city) <= 128 characters
billing_country
string (Billing 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" "BO" "BQ" "BA" "BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "CV" "KH" "CM" "CA" "KY" "CF" "TD" "CL" "CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CW" "CY" "CZ" "DK" "DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "SZ" "ET" "FK" "FO" "FJ" "FI" "FR" "GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GG" "GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM" "IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU" "MO" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "NC" "NZ" "NI" "NE" "NG" "NU" "NF" "KP" "MK" "MP" "NO" "OM" "PK" "PW" "PS" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR" "QA" "RE" "RO" "RU" "RW" "BL" "SH" "KN" "LC" "MF" "PM" "VC" "WS" "SM" "ST" "SA" "SN" "RS" "SC" "SL" "SG" "SX" "SK" "SI" "SB" "SO" "ZA" "GS" "KR" "SS" "ES" "LK" "SD" "SR" "SJ" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "UM" "US" "UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW"
update_from_registers
boolean (Update from registers)

If you uncheck this, account address, company name etc. will not be updated from company registers.

default_payment_terms
integer or null (Default payment terms) [ -2147483648 .. 2147483647 ]

It will override organization level setting.

default_collection_method
string or null (Default collection method)
Enum: "payment_card" "invoice" "direct_debit"

It will override organization level setting.

is_getting_reminders
boolean (Is getting reminders)

If you uncheck this, no payment reminders will be sent for this account. You can also turn reminders off globally in Invoice Settings.

reseller
string or null <uuid> (Reseller)

Reseller which resells goods and subscriptions to this account.

reseller_code
string (Reseller code)

Should reference the account code (ID from external system). Can be used as an alternative to the UUID-field 'reseller'.

reseller_billing_frequency
string or null (Reseller billing frequency)
Enum: "daily" "end_of_month" "start_of_month" "end_of_week" "start_of_week" "start_and_end_of_month"

Choose how often to invoice the reseller account for resold goods and subscriptions: weekly invoices are sent every Sunday, and monthly invoices on the last day of the month.

reseller_billing_grouping
string or null (Group invoices by)
Enum: "currency" "currency_resold_account" "currency_resold_account_po_number"

Grouping of the invoices generated from the reseller invoice lines. Defaults to currency-grouping.

type
string (Account type)
Enum: "company" "person"
custom_fields
object (AccountCustomFields)

Responses

Request samples

Content type
application/json
{
  • "company_name": "string",
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "title": "mr",
  • "gender": "male",
  • "code": "string",
  • "erp_id": "string",
  • "partner": 0,
  • "ean_invoicing": true,
  • "einvoicing_identifier_schema": "GLN",
  • "ean_number": "string",
  • "invoice_note": "string",
  • "language": "en",
  • "legal_address": "string",
  • "legal_zipcode": "string",
  • "legal_city": "string",
  • "legal_country": "AF",
  • "legal_vat_number": "string",
  • "billing_same_as_legal": true,
  • "billing_address": "string",
  • "billing_zipcode": "string",
  • "billing_city": "string",
  • "billing_country": "AF",
  • "update_from_registers": true,
  • "default_payment_terms": -2147483648,
  • "default_collection_method": "payment_card",
  • "is_getting_reminders": true,
  • "reseller": "16bab917-518b-4590-b8d5-48af7a327279",
  • "reseller_code": "string",
  • "reseller_billing_frequency": "daily",
  • "reseller_billing_grouping": "currency",
  • "type": "company",
  • "custom_fields": { }
}

api_v1_accounts_generate_invoice

This endpoint will create an invoice containing all DraftInvoiceLines that are not set to appear on the next invoice. There will be a separate invoice for every different currency used by DraftInvoiceLines.

Authorizations:
Token
path Parameters
code
required
string
Request Body schema: application/json
required
collection_method
string (Collection method)
Enum: "payment_card" "invoice" "direct_debit"

Default value is the account setting 'Default collection method'. When this setting is not set, the organization default will be used.

payment_terms
integer (Payment terms)

Default value is the account setting 'Default payment terms'. When this setting is not set, the organization default will be used.

Responses

Request samples

Content type
application/json
{
  • "collection_method": "payment_card",
  • "payment_terms": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

api_v1_accounts_deprecated_generate_invoice Deprecated

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

Authorizations:
Token
path Parameters
code
required
string
Request Body schema: application/json
required
collection_method
string (Collection method)
Enum: "payment_card" "invoice" "direct_debit"

Default value is the account setting 'Default collection method'. When this setting is not set, the organization default will be used.

payment_terms
integer (Payment terms)

Default value is the account setting 'Default payment terms'. When this setting is not set, the organization default will be used.

Responses

Request samples

Content type
application/json
{
  • "collection_method": "payment_card",
  • "payment_terms": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

api_v1_accounts_payment-gateways_read

One set of payment_gateway and payment_gateway_account_id is allowed per a customer account. Meaning each of your customers needs to match 1-to-1 with customer accounts set up in each payment gateway you use.

Authorizations:
Token
path Parameters
code
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

api_v1_accounts_payment-gateways_partial_update

One set of payment_gateway and payment_gateway_account_id is allowed per a customer account. Meaning each of your customers needs to match 1-to-1 with customer accounts set up in each payment gateway you use.

Authorizations:
Token
path Parameters
code
required
string
Request Body schema: application/json
required
Array
payment_gateway
required
string (Payment gateway)
Enum: "stripe" "stripe_new" "noop" "quickpay" "dibs" "dibs_easy"
payment_gateway_account_id
required
string (Payment gateway account ID) [ 1 .. 256 ] characters

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

api_v1_accounts_restore

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

Authorizations:
Token
path Parameters
code
required
string
Request Body schema: application/json
required
company_name
string or null (Company name) [ 1 .. 256 ] characters
first_name
string or null (First name) [ 1 .. 128 ] characters
middle_name
string or null (Middle name) <= 128 characters
last_name
string or null (Last name) [ 1 .. 128 ] characters
title
string or null (Title)
Enum: "mr" "mrs" "ms"
gender
string or null (Gender)
Enum: "male" "female" "other"
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" "nb" "pl" "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 ZIP code) [ 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" "BO" "BQ" "BA" "BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "CV" "KH" "CM" "CA" "KY" "CF" "TD" "CL" "CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CW" "CY" "CZ" "DK" "DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "SZ" "ET" "FK" "FO" "FJ" "FI" "FR" "GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GG" "GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM" "IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU" "MO" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "NC" "NZ" "NI" "NE" "NG" "NU" "NF" "KP" "MK" "MP" "NO" "OM" "PK" "PW" "PS" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR" "QA" "RE" "RO" "RU" "RW" "BL" "SH" "KN" "LC" "MF" "PM" "VC" "WS" "SM" "ST" "SA" "SN" "RS" "SC" "SL" "SG" "SX" "SK" "SI" "SB" "SO" "ZA" "GS" "KR" "SS" "ES" "LK" "SD" "SR" "SJ" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "UM" "US" "UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW"
legal_vat_number
string (Legal VAT number) <= 128 characters
billing_same_as_legal
boolean (Billing address same as legal)
billing_address
string (Billing address)
billing_zipcode
string (Billing ZIP code) <= 128 characters
billing_city
string (Billing city) <= 128 characters
billing_country
string (Billing 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" "BO" "BQ" "BA" "BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "CV" "KH" "CM" "CA" "KY" "CF" "TD" "CL" "CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CW" "CY" "CZ" "DK" "DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "SZ" "ET" "FK" "FO" "FJ" "FI" "FR" "GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GG" "GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM" "IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU" "MO" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "NC" "NZ" "NI" "NE" "NG" "NU" "NF" "KP" "MK" "MP" "NO" "OM" "PK" "PW" "PS" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR" "QA" "RE" "RO" "RU" "RW" "BL" "SH" "KN" "LC" "MF" "PM" "VC" "WS" "SM" "ST" "SA" "SN" "RS" "SC" "SL" "SG" "SX" "SK" "SI" "SB" "SO" "ZA" "GS" "KR" "SS" "ES" "LK" "SD" "SR" "SJ" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "UM" "US" "UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW"
update_from_registers
boolean (Update from registers)

If you uncheck this, account address, company name etc. will not be updated from company registers.

default_payment_terms
integer or null (Default payment terms) [ -2147483648 .. 2147483647 ]

It will override organization level setting.

default_collection_method
string or null (Default collection method)
Enum: "payment_card" "invoice" "direct_debit"

It will override organization level setting.

is_getting_reminders
boolean (Is getting reminders)

If you uncheck this, no payment reminders will be sent for this account. You can also turn reminders off globally in Invoice Settings.

reseller
string or null <uuid> (Reseller)

Reseller which resells goods and subscriptions to this account.

reseller_code
string (Reseller code)

Should reference the account code (ID from external system). Can be used as an alternative to the UUID-field 'reseller'.

reseller_billing_frequency
string or null (Reseller billing frequency)
Enum: "daily" "end_of_month" "start_of_month" "end_of_week" "start_of_week" "start_and_end_of_month"

Choose how often to invoice the reseller account for resold goods and subscriptions: weekly invoices are sent every Sunday, and monthly invoices on the last day of the month.

reseller_billing_grouping
string or null (Group invoices by)
Enum: "currency" "currency_resold_account" "currency_resold_account_po_number"

Grouping of the invoices generated from the reseller invoice lines. Defaults to currency-grouping.

type
string (Account type)
Enum: "company" "person"
custom_fields
object (AccountCustomFields)

Responses

Request samples

Content type
application/json
{
  • "company_name": "string",
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "title": "mr",
  • "gender": "male",
  • "code": "string",
  • "erp_id": "string",
  • "partner": 0,
  • "ean_invoicing": true,
  • "einvoicing_identifier_schema": "GLN",
  • "ean_number": "string",
  • "invoice_note": "string",
  • "language": "en",
  • "legal_address": "string",
  • "legal_zipcode": "string",
  • "legal_city": "string",
  • "legal_country": "AF",
  • "legal_vat_number": "string",
  • "billing_same_as_legal": true,
  • "billing_address": "string",
  • "billing_zipcode": "string",
  • "billing_city": "string",
  • "billing_country": "AF",
  • "update_from_registers": true,
  • "default_payment_terms": -2147483648,
  • "default_collection_method": "payment_card",
  • "is_getting_reminders": true,
  • "reseller": "16bab917-518b-4590-b8d5-48af7a327279",
  • "reseller_code": "string",
  • "reseller_billing_frequency": "daily",
  • "reseller_billing_grouping": "currency",
  • "type": "company",
  • "custom_fields": { }
}

api_v1_accounts_start_pending_subscriptions

This endpoint will trigger the renew() method on all pending_for_grouped subscriptions of the account.

Authorizations:
Token
path Parameters
code
required
string
Request Body schema: application/json
required

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "invoice_number": 0,
  • "external_invoice_number": "string",
  • "invoice_api_url": "string",
  • "account_uuid": "string",
  • "account_code": "string",
  • "account": {
    },
  • "pay_to_bank_account": 0,
  • "date": "2019-08-24",
  • "due_date": "2019-08-24",
  • "currency": "DKK",
  • "status": "open",
  • "kickback_status": "commission_pending",
  • "collection_method": "payment_card",
  • "pdf_base64": "string",
  • "total": "string",
  • "subtotal": "string",
  • "vat": "string",
  • "balance": "string",
  • "invoiceline_set": [
    ],
  • "imported": true,
  • "import_source": "manual",
  • "model": "string",
  • "schema": "string"
}

api_v1_accounts_subscribe

Subscribe an account to a plan terms. This endpoint creates a new subscription and cancels all other subscriptions. Do not use this along with Subscription POST and PUT endpoints.

This endpoint will make a pro-rated invoice immediately if there is a subscription being replaced on the account.

Authorizations:
Token
path Parameters
code
required
string
Request Body schema: application/json
required
terms
required
string <uuid> (Terms)
quantity
required
integer (Quantity) >= 1
collection_method
required
string (Collection method)
Enum: "payment_card" "invoice" "direct_debit"
group_on_invoice
boolean (Group on invoice)
Default: false

Responses

Request samples

Content type
application/json
{
  • "terms": "631338da-a0b5-4ef0-90ce-ca16c76d475c",
  • "quantity": 1,
  • "collection_method": "payment_card",
  • "group_on_invoice": false
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "account_uuid": "847548f7-9cde-4fe5-8751-32ff19825b7e",
  • "account_code": "6097a4f5-935a-4a3b-87a0-f379ae15fc06",
  • "account": {
    },
  • "terms": {
    },
  • "plan": {
    },
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "created_date": "2019-08-24T14:15:22Z",
  • "last_modified_date": "2019-08-24T14:15:22Z",
  • "next_renewal_date": "2019-08-24T14:15:22Z",
  • "last_renewal_date": "2019-08-24T14:15:22Z",
  • "base_renewal_date": "2019-08-24T14:15:22Z",
  • "original_start_date": "2019-08-24T14:15:22Z",
  • "quantity": 2147483647,
  • "collection_method": "payment_card",
  • "group_on_invoice": true,
  • "payment_terms": -2147483648,
  • "effective_payment_terms": "string",
  • "pre_renewal_days_offset": 32767,
  • "po_number": "string",
  • "invoice_supplement": "string",
  • "override_price": "string",
  • "reference_person": "string",
  • "account_reference_person": "string",
  • "case_number": "string",
  • "status": "active",
  • "current_mrr": "string",
  • "committed_mrr": "string",
  • "final_price": "string",
  • "churn_reason": {
    },
  • "custom_churn_reason": "string",
  • "custom_fields": { },
  • "model": "string",
  • "schema": "string"
}

Contract

api_v1_accounts_contracts_list

Authorizations:
Token
path Parameters
code
required
string
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,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1_accounts_contracts_create

Authorizations:
Token
path Parameters
code
required
string
Request Body schema: application/json
required
plan_terms
required
string <uuid> (Plan terms)
start_date
required
string <date-time> (Start date)
end_date
string or null <date-time> (End date)
commitment_length
integer (Commitment length (months)) [ -2147483648 .. 2147483647 ]

Before the commitment length is fulfilled subscription can't be canceled

exclusive_tiers
boolean (Discounts are exclusive (use best discount only))

Whether all tiers with met requirements are included in the discount (false) or only the one giving the best subscription price (true)

Responses

Request samples

Content type
application/json
{
  • "plan_terms": "66f9efe8-6b6a-483c-a74b-97841f59bbd0",
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "commitment_length": -2147483648,
  • "exclusive_tiers": true
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "plan_terms": "66f9efe8-6b6a-483c-a74b-97841f59bbd0",
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "commitment_length": -2147483648,
  • "exclusive_tiers": true,
  • "contracttier_set": [
    ],
  • "model": "string",
  • "schema": "string"
}

api_v1_accounts_contracts_read

Authorizations:
Token
path Parameters
code
required
string
uuid
required
string <uuid>

A UUID string identifying this Contract.

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "plan_terms": "66f9efe8-6b6a-483c-a74b-97841f59bbd0",
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "commitment_length": -2147483648,
  • "exclusive_tiers": true,
  • "contracttier_set": [
    ],
  • "model": "string",
  • "schema": "string"
}

api_v1_accounts_contracts_update

Authorizations:
Token
path Parameters
code
required
string
uuid
required
string <uuid>

A UUID string identifying this Contract.

Request Body schema: application/json
required
plan_terms
required
string <uuid> (Plan terms)
start_date
required
string <date-time> (Start date)
end_date
string or null <date-time> (End date)
commitment_length
integer (Commitment length (months)) [ -2147483648 .. 2147483647 ]

Before the commitment length is fulfilled subscription can't be canceled

exclusive_tiers
boolean (Discounts are exclusive (use best discount only))

Whether all tiers with met requirements are included in the discount (false) or only the one giving the best subscription price (true)

Responses

Request samples

Content type
application/json
{
  • "plan_terms": "66f9efe8-6b6a-483c-a74b-97841f59bbd0",
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "commitment_length": -2147483648,
  • "exclusive_tiers": true
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "plan_terms": "66f9efe8-6b6a-483c-a74b-97841f59bbd0",
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "commitment_length": -2147483648,
  • "exclusive_tiers": true,
  • "contracttier_set": [
    ],
  • "model": "string",
  • "schema": "string"
}

api_v1_accounts_contracts_partial_update

Authorizations:
Token
path Parameters
code
required
string
uuid
required
string <uuid>

A UUID string identifying this Contract.

Request Body schema: application/json
required
plan_terms
required
string <uuid> (Plan terms)
start_date
required
string <date-time> (Start date)
end_date
string or null <date-time> (End date)
commitment_length
integer (Commitment length (months)) [ -2147483648 .. 2147483647 ]

Before the commitment length is fulfilled subscription can't be canceled

exclusive_tiers
boolean (Discounts are exclusive (use best discount only))

Whether all tiers with met requirements are included in the discount (false) or only the one giving the best subscription price (true)

Responses

Request samples

Content type
application/json
{
  • "plan_terms": "66f9efe8-6b6a-483c-a74b-97841f59bbd0",
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "commitment_length": -2147483648,
  • "exclusive_tiers": true
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "plan_terms": "66f9efe8-6b6a-483c-a74b-97841f59bbd0",
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "commitment_length": -2147483648,
  • "exclusive_tiers": true,
  • "contracttier_set": [
    ],
  • "model": "string",
  • "schema": "string"
}

api_v1_accounts_contracts_delete

Authorizations:
Token
path Parameters
code
required
string
uuid
required
string <uuid>

A UUID string identifying this Contract.

Responses

ContractTier

api_v1_accounts_contracts_tiers_list

Authorizations:
Token
path Parameters
code
required
string
contract_pk
required
string
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,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1_accounts_contracts_tiers_create

Authorizations:
Token
path Parameters
code
required
string
contract_pk
required
string
Request Body schema: application/json
required
minimum_quantity
required
integer (Minimum quantity) [ -2147483648 .. 2147483647 ]

Apply the discount only when client buys at least that many licenses.

maximum_quantity
integer (Maximum quantity) [ -2147483648 .. 2147483647 ]

Apply the discount at max to that many licenses. 0 means unlimited.

discount
string <decimal> (Discount)
discount_type
string (Discount type)
Enum: "percent" "flat"
overall_flat_discount
string <decimal> (Fixed total discount)
only_apply_to_quantity_above_minimal
boolean (Apply only to quantity within range)

This field signifies if the tier applies to all of subscription's quantity (False) up to maximum quantity or only to the quantity between minimum quantity and maximum quantity, both ends included (True)

Responses

Request samples

Content type
application/json
{
  • "minimum_quantity": -2147483648,
  • "maximum_quantity": -2147483648,
  • "discount": "string",
  • "discount_type": "percent",
  • "overall_flat_discount": "string",
  • "only_apply_to_quantity_above_minimal": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "minimum_quantity": -2147483648,
  • "maximum_quantity": -2147483648,
  • "discount": "string",
  • "discount_type": "percent",
  • "overall_flat_discount": "string",
  • "only_apply_to_quantity_above_minimal": true,
  • "model": "string",
  • "schema": "string"
}

api_v1_accounts_contracts_tiers_read

Authorizations:
Token
path Parameters
code
required
string
contract_pk
required
string
id
required
integer

A unique integer value identifying this Contract Tier.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "minimum_quantity": -2147483648,
  • "maximum_quantity": -2147483648,
  • "discount": "string",
  • "discount_type": "percent",
  • "overall_flat_discount": "string",
  • "only_apply_to_quantity_above_minimal": true,
  • "model": "string",
  • "schema": "string"
}

api_v1_accounts_contracts_tiers_update

Authorizations:
Token
path Parameters
code
required
string
contract_pk
required
string
id
required
integer

A unique integer value identifying this Contract Tier.

Request Body schema: application/json
required
minimum_quantity
required
integer (Minimum quantity) [ -2147483648 .. 2147483647 ]

Apply the discount only when client buys at least that many licenses.

maximum_quantity
integer (Maximum quantity) [ -2147483648 .. 2147483647 ]

Apply the discount at max to that many licenses. 0 means unlimited.

discount
string <decimal> (Discount)
discount_type
string (Discount type)
Enum: "percent" "flat"
overall_flat_discount
string <decimal> (Fixed total discount)
only_apply_to_quantity_above_minimal
boolean (Apply only to quantity within range)

This field signifies if the tier applies to all of subscription's quantity (False) up to maximum quantity or only to the quantity between minimum quantity and maximum quantity, both ends included (True)

Responses

Request samples

Content type
application/json
{
  • "minimum_quantity": -2147483648,
  • "maximum_quantity": -2147483648,
  • "discount": "string",
  • "discount_type": "percent",
  • "overall_flat_discount": "string",
  • "only_apply_to_quantity_above_minimal": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "minimum_quantity": -2147483648,
  • "maximum_quantity": -2147483648,
  • "discount": "string",
  • "discount_type": "percent",
  • "overall_flat_discount": "string",
  • "only_apply_to_quantity_above_minimal": true,
  • "model": "string",
  • "schema": "string"
}

api_v1_accounts_contracts_tiers_partial_update

Authorizations:
Token
path Parameters
code
required
string
contract_pk
required
string
id
required
integer

A unique integer value identifying this Contract Tier.

Request Body schema: application/json
required
minimum_quantity
required
integer (Minimum quantity) [ -2147483648 .. 2147483647 ]

Apply the discount only when client buys at least that many licenses.

maximum_quantity
integer (Maximum quantity) [ -2147483648 .. 2147483647 ]

Apply the discount at max to that many licenses. 0 means unlimited.

discount
string <decimal> (Discount)
discount_type
string (Discount type)
Enum: "percent" "flat"
overall_flat_discount
string <decimal> (Fixed total discount)
only_apply_to_quantity_above_minimal
boolean (Apply only to quantity within range)

This field signifies if the tier applies to all of subscription's quantity (False) up to maximum quantity or only to the quantity between minimum quantity and maximum quantity, both ends included (True)

Responses

Request samples

Content type
application/json
{
  • "minimum_quantity": -2147483648,
  • "maximum_quantity": -2147483648,
  • "discount": "string",
  • "discount_type": "percent",
  • "overall_flat_discount": "string",
  • "only_apply_to_quantity_above_minimal": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "minimum_quantity": -2147483648,
  • "maximum_quantity": -2147483648,
  • "discount": "string",
  • "discount_type": "percent",
  • "overall_flat_discount": "string",
  • "only_apply_to_quantity_above_minimal": true,
  • "model": "string",
  • "schema": "string"
}

api_v1_accounts_contracts_tiers_delete

Authorizations:
Token
path Parameters
code
required
string
contract_pk
required
string
id
required
integer

A unique integer value identifying this Contract Tier.

Responses

Activity

api_v1_activities_list

Authorizations:
Token
query Parameters
account
string

Filter using account code (External ID)

uuid
string
subscription_uuid
string
type
string
mrr_change_type
string
is_manual
string
deleted
string
future
string
since
string

Deprecated

use_activity_date
string

Deprecated

activity_type
string
created_date__lte
string

Format: YYYY-MM-DD

created_date__org_tz_lte
string

Format: YYYY-MM-DD

created_date__gte
string

Format: YYYY-MM-DD

created_date__org_tz_gte
string

Format: YYYY-MM-DD

updated_date__lte
string

Format: YYYY-MM-DDTHH:MM:SSZ

updated_date__gte
string

Format: YYYY-MM-DDTHH:MM:SSZ

activity_date__lte
string

Format: YYYY-MM-DD

activity_date__org_tz_lte
string

Format: YYYY-MM-DD

activity_date__gte
string

Format: YYYY-MM-DD

activity_date__org_tz_gte
string

Format: YYYY-MM-DD

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.

Responses

Response samples

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

api_v1_activities_create

Create a Manual Activity

Authorizations:
Token
Request Body schema: application/json
required
subscription
required
string or null <uuid> (Subscription)
date
required
string <date-time> (Date)

The date the activity comes into effect

quantity
required
integer (Quantity) >= 1
terms
required
string <uuid> (Terms)
mrr
required
string <decimal> (MRR)

It is the MRR in the currency of Plan Terms

Responses

Request samples

Content type
application/json
{
  • "subscription": "da7489c5-d730-47b7-9958-07300ef9d3d8",
  • "date": "2019-08-24T14:15:22Z",
  • "quantity": 1,
  • "terms": "631338da-a0b5-4ef0-90ce-ca16c76d475c",
  • "mrr": "string"
}

Response samples

Content type
application/json
{
  • "subscription": "da7489c5-d730-47b7-9958-07300ef9d3d8",
  • "date": "2019-08-24T14:15:22Z",
  • "quantity": 1,
  • "terms": "631338da-a0b5-4ef0-90ce-ca16c76d475c",
  • "mrr": "string",
  • "model": "string",
  • "schema": "string"
}

api_v1_activities_account_list

Authorizations:
Token
query Parameters
account
string

Filter using account code (External ID)

uuid
string
subscription_uuid
string
is_manual
string
future
string
type
string
created_date__lte
string

Format: YYYY-MM-DD

created_date__org_tz_lte
string

Format: YYYY-MM-DD

created_date__gte
string

Format: YYYY-MM-DD

created_date__org_tz_gte
string

Format: YYYY-MM-DD

date__lte
string

Format: YYYY-MM-DD

date__org_tz_lte
string

Format: YYYY-MM-DD

date__gte
string

Format: YYYY-MM-DD

date__org_tz_gte
string

Format: YYYY-MM-DD

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.

Responses

Response samples

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

api_v1_activities_account_export

Authorizations:
Token
Request Body schema: application/json
required
account_uuid
required
string (Account uuid) non-empty
account_code
required
string (Account code) non-empty
company_name
required
string (Company name) non-empty
type
required
string (Type)
Enum: "new_business" "expansion" "contraction" "churn" "reactivation"
new_mrr
required
string or null <decimal> (New MRR)
old_mrr
required
string or null <decimal> (Old MRR)
date
required
string <date-time> (Date)

The date the activity comes into effect

subscription
required
string or null (Subscription) non-empty
is_manual
boolean (Is manual)
deleted
boolean (Deleted)

Responses

Request samples

Content type
application/json
{
  • "account_uuid": "string",
  • "account_code": "string",
  • "company_name": "string",
  • "type": "new_business",
  • "new_mrr": "string",
  • "old_mrr": "string",
  • "date": "2019-08-24T14:15:22Z",
  • "subscription": "string",
  • "is_manual": true,
  • "deleted": true
}

Response samples

Content type
application/json
{
  • "export_id": "string",
  • "job_uuid": "de25c4df-6d4e-439f-9d5f-a4c55d30f26e"
}

api_v1_activities_account_read

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this Activity.

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "account_uuid": "string",
  • "account_code": "string",
  • "company_name": "string",
  • "type": "new_business",
  • "mrr_change": "string",
  • "new_mrr": "string",
  • "old_mrr": "string",
  • "created_date": "2019-08-24T14:15:22Z",
  • "date": "2019-08-24T14:15:22Z",
  • "subscription": "string",
  • "is_manual": true,
  • "deleted": true,
  • "model": "string",
  • "schema": "string"
}

api_v1_activities_delete_list

Delete multiple Manual Activities matching filtering params

Authorizations:
Token

Responses

api_v1_activities_export

Authorizations:
Token
Request Body schema: application/json
required
account_uuid
required
string (Account uuid) non-empty
account_code
required
string (Account code) non-empty
subscription
required
string or null (Subscription) non-empty
invoice
string or null <uuid> (Invoice)
date
required
string <date-time> (Date)

The date the activity comes into effect

type
required
string (Type)
Enum: "new" "reactivate" "renew" "cancel" "upgrade_qty" "downgrade_qty" "upgrade_subscription" "downgraded_subscription" "modified" "invoice_sent" "invoice_paid" "payment_made" "currency_exchange"
is_manual
boolean (Is manual)
is_churn
boolean (Is churn)
old_currency
string or null (Old currency)
Enum: "DKK" "EUR" "USD" "GBP" "NZD" "CHF" "PLN" "SEK" "NOK" "ISK" "AUD" "CAD" "CZK"
new_currency
string or null (New currency)
Enum: "DKK" "EUR" "USD" "GBP" "NZD" "CHF" "PLN" "SEK" "NOK" "ISK" "AUD" "CAD" "CZK"
old_mrr_in_subscription_currency
string or null <decimal> (Old MRR in subscription currency)
new_mrr_in_subscription_currency
string or null <decimal> (New MRR in subscription currency)
old_mrr
string or null <decimal> (Old MRR)
new_mrr
string or null <decimal> (New MRR)
old_quantity
integer or null (Old quantity) [ -2147483648 .. 2147483647 ]
new_quantity
integer or null (New quantity) [ -2147483648 .. 2147483647 ]
old_terms
string or null <uuid> (Old terms)
new_terms
string or null <uuid> (New terms)
old_terms_name
required
string or null (Old terms name) non-empty
new_terms_name
required
string or null (New terms name) non-empty
required
object (EmbeddedPlan)
required
object (EmbeddedPlan)
old_plan_name
required
string or null (Old plan name) non-empty

DEPRECATED: use old_plan.name instead

new_plan_name
required
string or null (New plan name) non-empty

DEPRECATED: use new_plan.name instead

company_name
required
string (Company name) non-empty
ean_invoice
boolean (Electronic invoicing)
deleted
boolean (Deleted)

Responses

Request samples

Content type
application/json
{
  • "account_uuid": "string",
  • "account_code": "string",
  • "subscription": "string",
  • "invoice": "f5072b7b-65cb-48aa-bf69-c999195da70c",
  • "date": "2019-08-24T14:15:22Z",
  • "type": "new",
  • "is_manual": true,
  • "is_churn": true,
  • "old_currency": "DKK",
  • "new_currency": "DKK",
  • "old_mrr_in_subscription_currency": "string",
  • "new_mrr_in_subscription_currency": "string",
  • "old_mrr": "string",
  • "new_mrr": "string",
  • "old_quantity": -2147483648,
  • "new_quantity": -2147483648,
  • "old_terms": "ad992289-ddca-4bb6-ad6d-d633bfc37629",
  • "new_terms": "7f43d5df-307a-4725-a28d-3e5b9b27e92e",
  • "old_terms_name": "string",
  • "new_terms_name": "string",
  • "old_plan": {
    },
  • "new_plan": {
    },
  • "old_plan_name": "string",
  • "new_plan_name": "string",
  • "company_name": "string",
  • "ean_invoice": true,
  • "deleted": true
}

Response samples

Content type
application/json
{
  • "export_id": "string",
  • "job_uuid": "de25c4df-6d4e-439f-9d5f-a4c55d30f26e"
}

api_v1_activities_read

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this Activity.

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "account_uuid": "string",
  • "account_code": "string",
  • "subscription": "string",
  • "invoice": "f5072b7b-65cb-48aa-bf69-c999195da70c",
  • "date": "2019-08-24T14:15:22Z",
  • "created_date": "2019-08-24T14:15:22Z",
  • "updated_date": "2019-08-24T14:15:22Z",
  • "type": "new",
  • "is_manual": true,
  • "is_churn": true,
  • "old_currency": "DKK",
  • "new_currency": "DKK",
  • "old_mrr_in_subscription_currency": "string",
  • "new_mrr_in_subscription_currency": "string",
  • "old_mrr": "string",
  • "new_mrr": "string",
  • "old_quantity": -2147483648,
  • "new_quantity": -2147483648,
  • "old_terms": "ad992289-ddca-4bb6-ad6d-d633bfc37629",
  • "new_terms": "7f43d5df-307a-4725-a28d-3e5b9b27e92e",
  • "mrr_change": "string",
  • "quantity_change": "string",
  • "old_terms_name": "string",
  • "new_terms_name": "string",
  • "old_plan": {
    },
  • "new_plan": {
    },
  • "old_plan_name": "string",
  • "new_plan_name": "string",
  • "company_name": "string",
  • "ean_invoice": true,
  • "deleted": true,
  • "model": "string",
  • "schema": "string"
}

api_v1_activities_update

Update a Manual Activity

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this Activity.

Request Body schema: application/json
required
subscription
required
string or null <uuid> (Subscription)
date
required
string <date-time> (Date)

The date the activity comes into effect

quantity
required
integer (Quantity) >= 1
terms
required
string <uuid> (Terms)
mrr
required
string <decimal> (MRR)

It is the MRR in the currency of Plan Terms

Responses

Request samples

Content type
application/json
{
  • "subscription": "da7489c5-d730-47b7-9958-07300ef9d3d8",
  • "date": "2019-08-24T14:15:22Z",
  • "quantity": 1,
  • "terms": "631338da-a0b5-4ef0-90ce-ca16c76d475c",
  • "mrr": "string"
}

Response samples

Content type
application/json
{
  • "subscription": "da7489c5-d730-47b7-9958-07300ef9d3d8",
  • "date": "2019-08-24T14:15:22Z",
  • "quantity": 1,
  • "terms": "631338da-a0b5-4ef0-90ce-ca16c76d475c",
  • "mrr": "string",
  • "model": "string",
  • "schema": "string"
}

api_v1_activities_partial_update

Update a Manual Activity

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this Activity.

Request Body schema: application/json
required
subscription
required
string or null <uuid> (Subscription)
date
required
string <date-time> (Date)

The date the activity comes into effect

quantity
required
integer (Quantity) >= 1
terms
required
string <uuid> (Terms)
mrr
required
string <decimal> (MRR)

It is the MRR in the currency of Plan Terms

Responses

Request samples

Content type
application/json
{
  • "subscription": "da7489c5-d730-47b7-9958-07300ef9d3d8",
  • "date": "2019-08-24T14:15:22Z",
  • "quantity": 1,
  • "terms": "631338da-a0b5-4ef0-90ce-ca16c76d475c",
  • "mrr": "string"
}

Response samples

Content type
application/json
{
  • "subscription": "da7489c5-d730-47b7-9958-07300ef9d3d8",
  • "date": "2019-08-24T14:15:22Z",
  • "quantity": 1,
  • "terms": "631338da-a0b5-4ef0-90ce-ca16c76d475c",
  • "mrr": "string",
  • "model": "string",
  • "schema": "string"
}

api_v1_activities_delete

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this Activity.

Responses

BankAccount

api_v1_bank-accounts_list

Authorizations:
Token
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,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1_bank-accounts_cash_balance

Authorizations:
Token
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
{
  • "cash_balance": "string"
}

api_v1_bank-accounts_cash_flow

This endpoint will return an average of all bank account lines summarized in the organization's default currency for the last three whole months.

It only includes bank account lines from bank accounts that are active and not hidden. Amounts are converted to the organization's default currency using the exchange rate for the current day.

Authorizations:
Token
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
{
  • "cash_flow": "string"
}

api_v1_bank-accounts_read

Authorizations:
Token
path Parameters
id
required
integer

A unique integer value identifying this bank account.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "external_id": "string",
  • "account_name": "string",
  • "model": "string",
  • "schema": "string"
}

api

api_v1_cash-flow_read

Authorizations:
Token
path Parameters
month
required
stringMM-YYYY

Get cashflow for given month.

query Parameters
revenue_base
string
Default: "invoice"
Enum: "invoice" "due"

Which date should be taken as base for calculcation

Responses

Response samples

Content type
application/json
{
  • "customer_payments_forecast": "string",
  • "customer_invoices_vat": "string",
  • "customer_invoices_due": "string",
  • "customer_invoices_paid": "string",
  • "revenue_total": "string",
  • "supplier_payments_due": "string",
  • "supplier_payments_paid": "string",
  • "payments_total": "string",
  • "customer_payments_forecast_invoice": "string",
  • "customer_payments_forecast_payment_card": "string",
  • "customer_payments_forecast_direct_debit": "string",
  • "balance": "string"
}

api_v1_erp-accounts_list

Authorizations:
Token

Responses

Response samples

Content type
application/json
[
  • {
    }
]

api_v1_erp-accounts_read

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this erp account.

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "display_name": "string",
  • "account_number": 0,
  • "account_number_str": "string",
  • "model": "string",
  • "schema": "string"
}

api_v1_expense-documents_upload

Authorizations:
Token
Request Body schema: application/json
required
document_type
required
string (Document type)
Enum: "receipt" "supplier_invoice"
files
required
Array of strings <uri> [ items <uri > ]

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "document_type": "receipt",
  • "files": [],
  • "model": "string",
  • "schema": "string"
}

api_v1_exports_download

Authorizations:
Token
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{}

api_v1_revenue-recognition-algorithms_examples

Authorizations:
Token

Responses

api_v1_search_list

Authorizations:
Token
query Parameters
q
string

Search query to look for Accounts, Invoices, Plans, Products, Revenue Groups, Subscriptions, Supplier Invoices, Suppliers, Transactions

Responses

Response samples

Content type
application/json
{
  • "accounts": {
    },
  • "subscriptions": {
    },
  • "invoices": {
    },
  • "transactions": {
    },
  • "plans": {
    },
  • "products": {
    },
  • "revenue_groups": {
    },
  • "suppliers": {
    },
  • "supplier_invoices": {
    }
}

api_v1_vat-payments_upcoming_vat_payment

Authorizations:
Token
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

ChurnReason

api_v1_churn-reasons_list

Authorizations:
Token
query Parameters
is_active
string
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.

Responses

Response samples

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

api_v1_churn-reasons_create

Authorizations:
Token
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 128 ] characters
is_active
boolean (Is active)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "is_active": true
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "is_active": true,
  • "usage_count": 0,
  • "model": "string",
  • "schema": "string"
}

api_v1_churn-reasons_read

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this Churn Reason.

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "is_active": true,
  • "usage_count": 0,
  • "model": "string",
  • "schema": "string"
}

api_v1_churn-reasons_update

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this Churn Reason.

Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 128 ] characters
is_active
boolean (Is active)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "is_active": true
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "is_active": true,
  • "usage_count": 0,
  • "model": "string",
  • "schema": "string"
}

api_v1_churn-reasons_partial_update

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this Churn Reason.

Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 128 ] characters
is_active
boolean (Is active)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "is_active": true
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "is_active": true,
  • "usage_count": 0,
  • "model": "string",
  • "schema": "string"
}

api_v1_churn-reasons_delete

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this Churn Reason.

Responses

DirectDebitDebtor

api_v1_directdebitdebtors_list

Direct debit solutions for your accounts.

Authorizations:
Token
query Parameters
account
string

Filter using account code (External ID)

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,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1_directdebitdebtors_create

Direct debit solutions for your accounts.

Authorizations:
Token
Request Body schema: application/json
required
account
required
string <uuid> (Account)
gateway
required
string (Gateway)
Enum: "leverandoer" "pbs" "stripe_sepa" "noop"

Payment gateway from which this debtor is. This field determines what will be stored as token.
Possible values:
leverandoer - Leverandørservice. When using this gateway token should be a customer number.
stripe_sepa - SEPA debtor registered in Stripe. In this gateway token should be a payment method ID.
pbs - Betalingsservice payment provider. In this gateway token should be a customer number.
noop - Fake gateway for test purpose only. WARNING: charges with this cards WILL ALWAYS be marked as success in Fenerum, but will not charge anyone. Don't use on real accounts, but feel free to use for testing.

token
required
string (Token) non-empty

ID in payment gateway. What it is depends on the payment_gateway field.

Responses

Request samples

Content type
application/json
{
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "gateway": "leverandoer",
  • "token": "string"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "account": {
    },
  • "status": "not_send",
  • "payment_gateway": "leverandoer",
  • "payment_gateway_id": "string",
  • "model": "string",
  • "schema": "string"
}

api_v1_directdebitdebtors_generate

Returns a possible customer number for Betalingsservice debtor.

Authorizations:
Token
Request Body schema: application/json
required
gateway
required
string (Gateway)
Value: "pbs"

Responses

Request samples

Content type
application/json
{
  • "gateway": "pbs"
}

Response samples

Content type
application/json
{
  • "gateway": "pbs",
  • "generated_number": "string"
}

api_v1_directdebitdebtors_read

Direct debit solutions for your accounts.

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this Direct Debit Debtor.

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "account": {
    },
  • "status": "not_send",
  • "payment_gateway": "leverandoer",
  • "payment_gateway_id": "string",
  • "model": "string",
  • "schema": "string"
}

api_v1_directdebitdebtors_disable

Direct debit solutions for your accounts.

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this Direct Debit Debtor.

Request Body schema: application/json
required
object (DisableDirectDebitDebtor)

Responses

Request samples

Content type
application/json
{ }

DraftInvoiceLine

api_v1_draft-invoice-lines_products_list

Invoice lines that can be used to create a standalone invoice or added to an automatically-generated subscription renewal invoice. This endpoint allows for Invoice lines creation using Products feature.

Authorizations:
Token
query Parameters
account
string

Filter using account code (External ID)

date_from__lte
string

Format: YYYY-MM-DD

date_from__gte
string

Format: YYYY-MM-DD

date_to__lte
string

Format: YYYY-MM-DD

date_to__gte
string

Format: YYYY-MM-DD

last_modified_date__lte
string

Format: YYYY-MM-DD

last_modified_date__org_tz_lte
string

Format: YYYY-MM-DD

last_modified_date__gte
string

Format: YYYY-MM-DD

last_modified_date__org_tz_gte
string

Format: YYYY-MM-DD

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,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1_draft-invoice-lines_products_create

Invoice lines that can be used to create a standalone invoice or added to an automatically-generated subscription renewal invoice. This endpoint allows for Invoice lines creation using Products feature.

Authorizations:
Token
Request Body schema: application/json
required
account
required
string (Account)

Account code (ID from external system)

collect_vat
boolean (Collect VAT)

Collect VAT if required - uncheck for VAT-free items like shipping costs (DK)

date_from
required
string <date> (Date from)
date_to
required
string <date> (Date to)
price
string <decimal> (Price)
quantity
required
string <decimal> (Quantity)
discount_percentage
string or null <decimal> (Discount %)

Must be greater than 0 and less than or equal to 100. Cannot be combined with other discounts

discount_fixed_per_quantity
string or null <decimal> (Fixed discount per quantity)

Must be greater than 0, and cannot be combined with other discounts

discount_fixed_total
string or null <decimal> (Fixed discount total)

Cannot be combined with other discounts

include_in_next_renewal_invoice
boolean (Include in next renewal invoice)

Include as a line in the next subscription renewal invoice.

product_pricing
required
string or null <uuid> (Product pricing)
reference_person
string (Reference person) <= 128 characters
account_reference_person
string (Your reference) <= 128 characters
po_number
string (PO number) <= 128 characters
case_number
string (Case number) <= 128 characters

Responses

Request samples

Content type
application/json
{
  • "account": "string",
  • "collect_vat": true,
  • "date_from": "2019-08-24",
  • "date_to": "2019-08-24",
  • "price": "string",
  • "quantity": "string",
  • "discount_percentage": "string",
  • "discount_fixed_per_quantity": "string",
  • "discount_fixed_total": "string",
  • "include_in_next_renewal_invoice": true,
  • "product_pricing": "eb9bff53-30f1-4db5-866e-271ebb1d091e",
  • "reference_person": "string",
  • "account_reference_person": "string",
  • "po_number": "string",
  • "case_number": "string"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "account": "string",
  • "account_uuid": "847548f7-9cde-4fe5-8751-32ff19825b7e",
  • "vat_type": "physical",
  • "collect_vat": true,
  • "date_from": "2019-08-24",
  • "date_to": "2019-08-24",
  • "price": "string",
  • "quantity": "string",
  • "discount_percentage": "string",
  • "discount_fixed_per_quantity": "string",
  • "discount_fixed_total": "string",
  • "include_in_next_renewal_invoice": true,
  • "last_modified_date": "2019-08-24T14:15:22Z",
  • "product_pricing": "eb9bff53-30f1-4db5-866e-271ebb1d091e",
  • "reference_person": "string",
  • "account_reference_person": "string",
  • "po_number": "string",
  • "case_number": "string",
  • "invoice_supplement": "string",
  • "created_date": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "currency": "DKK",
  • "revenue_group": "string"
}

api_v1_draft-invoice-lines_products_read

Invoice lines that can be used to create a standalone invoice or added to an automatically-generated subscription renewal invoice. This endpoint allows for Invoice lines creation using Products feature.

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this Base Invoice Line.

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "account": "string",
  • "account_uuid": "847548f7-9cde-4fe5-8751-32ff19825b7e",
  • "vat_type": "physical",
  • "collect_vat": true,
  • "date_from": "2019-08-24",
  • "date_to": "2019-08-24",
  • "price": "string",
  • "quantity": "string",
  • "discount_percentage": "string",
  • "discount_fixed_per_quantity": "string",
  • "discount_fixed_total": "string",
  • "include_in_next_renewal_invoice": true,
  • "last_modified_date": "2019-08-24T14:15:22Z",
  • "product_pricing": "eb9bff53-30f1-4db5-866e-271ebb1d091e",
  • "reference_person": "string",
  • "account_reference_person": "string",
  • "po_number": "string",
  • "case_number": "string",
  • "invoice_supplement": "string",
  • "created_date": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "currency": "DKK",
  • "revenue_group": "string"
}

api_v1_draft-invoice-lines_products_update

Invoice lines that can be used to create a standalone invoice or added to an automatically-generated subscription renewal invoice. This endpoint allows for Invoice lines creation using Products feature.

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this Base Invoice Line.

Request Body schema: application/json
required
account
required
string (Account)

Account code (ID from external system)

collect_vat
boolean (Collect VAT)

Collect VAT if required - uncheck for VAT-free items like shipping costs (DK)

date_from
required
string <date> (Date from)
date_to
required
string <date> (Date to)
price
string <decimal> (Price)
quantity
required
string <decimal> (Quantity)
discount_percentage
string or null <decimal> (Discount %)

Must be greater than 0 and less than or equal to 100. Cannot be combined with other discounts

discount_fixed_per_quantity
string or null <decimal> (Fixed discount per quantity)

Must be greater than 0, and cannot be combined with other discounts

discount_fixed_total
string or null <decimal> (Fixed discount total)

Cannot be combined with other discounts

include_in_next_renewal_invoice
boolean (Include in next renewal invoice)

Include as a line in the next subscription renewal invoice.

product_pricing
required
string or null <uuid> (Product pricing)
reference_person
string (Reference person) <= 128 characters
account_reference_person
string (Your reference) <= 128 characters
po_number
string (PO number) <= 128 characters
case_number
string (Case number) <= 128 characters

Responses

Request samples

Content type
application/json
{
  • "account": "string",
  • "collect_vat": true,
  • "date_from": "2019-08-24",
  • "date_to": "2019-08-24",
  • "price": "string",
  • "quantity": "string",
  • "discount_percentage": "string",
  • "discount_fixed_per_quantity": "string",
  • "discount_fixed_total": "string",
  • "include_in_next_renewal_invoice": true,
  • "product_pricing": "eb9bff53-30f1-4db5-866e-271ebb1d091e",
  • "reference_person": "string",
  • "account_reference_person": "string",
  • "po_number": "string",
  • "case_number": "string"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "account": "string",
  • "account_uuid": "847548f7-9cde-4fe5-8751-32ff19825b7e",
  • "vat_type": "physical",
  • "collect_vat": true,
  • "date_from": "2019-08-24",
  • "date_to": "2019-08-24",
  • "price": "string",
  • "quantity": "string",
  • "discount_percentage": "string",
  • "discount_fixed_per_quantity": "string",
  • "discount_fixed_total": "string",
  • "include_in_next_renewal_invoice": true,
  • "last_modified_date": "2019-08-24T14:15:22Z",
  • "product_pricing": "eb9bff53-30f1-4db5-866e-271ebb1d091e",
  • "reference_person": "string",
  • "account_reference_person": "string",
  • "po_number": "string",
  • "case_number": "string",
  • "invoice_supplement": "string",
  • "created_date": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "currency": "DKK",
  • "revenue_group": "string"
}

api_v1_draft-invoice-lines_products_partial_update

Invoice lines that can be used to create a standalone invoice or added to an automatically-generated subscription renewal invoice. This endpoint allows for Invoice lines creation using Products feature.

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this Base Invoice Line.

Request Body schema: application/json
required
account
required
string (Account)

Account code (ID from external system)

collect_vat
boolean (Collect VAT)

Collect VAT if required - uncheck for VAT-free items like shipping costs (DK)

date_from
required
string <date> (Date from)
date_to
required
string <date> (Date to)
price
string <decimal> (Price)
quantity
required
string <decimal> (Quantity)
discount_percentage
string or null <decimal> (Discount %)

Must be greater than 0 and less than or equal to 100. Cannot be combined with other discounts

discount_fixed_per_quantity
string or null <decimal> (Fixed discount per quantity)

Must be greater than 0, and cannot be combined with other discounts

discount_fixed_total
string or null <decimal> (Fixed discount total)

Cannot be combined with other discounts

include_in_next_renewal_invoice
boolean (Include in next renewal invoice)

Include as a line in the next subscription renewal invoice.

product_pricing
required
string or null <uuid> (Product pricing)
reference_person
string (Reference person) <= 128 characters
account_reference_person
string (Your reference) <= 128 characters
po_number
string (PO number) <= 128 characters
case_number
string (Case number) <= 128 characters

Responses

Request samples

Content type
application/json
{
  • "account": "string",
  • "collect_vat": true,
  • "date_from": "2019-08-24",
  • "date_to": "2019-08-24",
  • "price": "string",
  • "quantity": "string",
  • "discount_percentage": "string",
  • "discount_fixed_per_quantity": "string",
  • "discount_fixed_total": "string",
  • "include_in_next_renewal_invoice": true,
  • "product_pricing": "eb9bff53-30f1-4db5-866e-271ebb1d091e",
  • "reference_person": "string",
  • "account_reference_person": "string",
  • "po_number": "string",
  • "case_number": "string"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "account": "string",
  • "account_uuid": "847548f7-9cde-4fe5-8751-32ff19825b7e",
  • "vat_type": "physical",
  • "collect_vat": true,
  • "date_from": "2019-08-24",
  • "date_to": "2019-08-24",
  • "price": "string",
  • "quantity": "string",
  • "discount_percentage": "string",
  • "discount_fixed_per_quantity": "string",
  • "discount_fixed_total": "string",
  • "include_in_next_renewal_invoice": true,
  • "last_modified_date": "2019-08-24T14:15:22Z",
  • "product_pricing": "eb9bff53-30f1-4db5-866e-271ebb1d091e",
  • "reference_person": "string",
  • "account_reference_person": "string",
  • "po_number": "string",
  • "case_number": "string",
  • "invoice_supplement": "string",
  • "created_date": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "currency": "DKK",
  • "revenue_group": "string"
}

api_v1_draft-invoice-lines_products_delete

Invoice lines that can be used to create a standalone invoice or added to an automatically-generated subscription renewal invoice. This endpoint allows for Invoice lines creation using Products feature.

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this Base Invoice Line.

Responses

api_v1_draftinvoicelines_list

Invoice lines that can be used to create a standalone invoice or added to an automatically-generated subscription renewal invoice. This endpoint allows for custom (without product feature) Invoice lines interaction.

Authorizations:
Token
query Parameters
account
string

Filter using account code (External ID)

date_from__lte
string

Format: YYYY-MM-DD

date_from__gte
string

Format: YYYY-MM-DD

date_to__lte
string

Format: YYYY-MM-DD

date_to__gte
string

Format: YYYY-MM-DD

last_modified_date__lte
string

Format: YYYY-MM-DD

last_modified_date__org_tz_lte
string

Format: YYYY-MM-DD

last_modified_date__gte
string

Format: YYYY-MM-DD

last_modified_date__org_tz_gte
string

Format: YYYY-MM-DD

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,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1_draftinvoicelines_create

Invoice lines that can be used to create a standalone invoice or added to an automatically-generated subscription renewal invoice. This endpoint allows for custom (without product feature) Invoice lines interaction.

Authorizations:
Token
Request Body schema: application/json
required
account
required
string (Account)

Account code (ID from external system)

description
required
string (Description) [ 1 .. 256 ] characters
vat_type
required
string (VAT type)
Enum: "physical" "services" "unknown"
collect_vat
boolean (Collect vat)
Default: true

Collect VAT if required - uncheck for VAT-free items like shipping costs (DK)

date_from
required
string <date> (Date from)
date_to
required
string <date> (Date to)
price
required
string <decimal> (Price)
quantity
required
string <decimal> (Quantity)
discount_percentage
string or null <decimal> (Discount %)

Must be greater than 0 and less than or equal to 100. Cannot be combined with other discounts

discount_fixed_per_quantity
string or null <decimal> (Fixed discount per quantity)

Must be greater than 0, and cannot be combined with other discounts

discount_fixed_total
string or null <decimal> (Fixed discount total)

Cannot be combined with other discounts

currency
required
string (Currency)
Enum: "DKK" "EUR" "USD" "GBP" "NZD" "CHF" "PLN" "SEK" "NOK" "ISK" "AUD" "CAD" "CZK"
include_in_next_renewal_invoice
boolean (Include in next renewal invoice)

Include as a line in the next subscription renewal invoice.

revenue_group
string or null (Revenue group)

Name of the Revenue Group (only if Revenue Group feature is enabled, also field is required then).

reference_person
string (Reference person) <= 128 characters
account_reference_person
string (Your reference) <= 128 characters
po_number
string (PO number) <= 128 characters
case_number
string (Case number) <= 128 characters
invoice_supplement
string or null (Invoice supplement)

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

custom_fields
object (BaseInvoiceLineCustomFields)

Responses

Request samples

Content type
application/json
{
  • "account": "string",
  • "description": "string",
  • "vat_type": "physical",
  • "collect_vat": true,
  • "date_from": "2019-08-24",
  • "date_to": "2019-08-24",
  • "price": "string",
  • "quantity": "string",
  • "discount_percentage": "string",
  • "discount_fixed_per_quantity": "string",
  • "discount_fixed_total": "string",
  • "currency": "DKK",
  • "include_in_next_renewal_invoice": true,
  • "revenue_group": "string",
  • "reference_person": "string",
  • "account_reference_person": "string",
  • "po_number": "string",
  • "case_number": "string",
  • "invoice_supplement": "string",
  • "custom_fields": { }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "account": "string",
  • "account_uuid": "847548f7-9cde-4fe5-8751-32ff19825b7e",
  • "description": "string",
  • "vat_type": "physical",
  • "collect_vat": true,
  • "date_from": "2019-08-24",
  • "date_to": "2019-08-24",
  • "price": "string",
  • "quantity": "string",
  • "discount_percentage": "string",
  • "discount_fixed_per_quantity": "string",
  • "discount_fixed_total": "string",
  • "currency": "DKK",
  • "include_in_next_renewal_invoice": true,
  • "revenue_group": "string",
  • "last_modified_date": "2019-08-24T14:15:22Z",
  • "reference_person": "string",
  • "account_reference_person": "string",
  • "po_number": "string",
  • "case_number": "string",
  • "invoice_supplement": "string",
  • "created_date": "2019-08-24T14:15:22Z",
  • "custom_fields": { },
  • "model": "string",
  • "schema": "string"
}

api_v1_draftinvoicelines_read

Invoice lines that can be used to create a standalone invoice or added to an automatically-generated subscription renewal invoice. This endpoint allows for custom (without product feature) Invoice lines interaction.

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this Base Invoice Line.

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "account": "string",
  • "account_uuid": "847548f7-9cde-4fe5-8751-32ff19825b7e",
  • "description": "string",
  • "vat_type": "physical",
  • "collect_vat": true,
  • "date_from": "2019-08-24",
  • "date_to": "2019-08-24",
  • "price": "string",
  • "quantity": "string",
  • "discount_percentage": "string",
  • "discount_fixed_per_quantity": "string",
  • "discount_fixed_total": "string",
  • "currency": "DKK",
  • "include_in_next_renewal_invoice": true,
  • "revenue_group": "string",
  • "last_modified_date": "2019-08-24T14:15:22Z",
  • "reference_person": "string",
  • "account_reference_person": "string",
  • "po_number": "string",
  • "case_number": "string",
  • "invoice_supplement": "string",
  • "created_date": "2019-08-24T14:15:22Z",
  • "custom_fields": { },
  • "model": "string",
  • "schema": "string"
}

api_v1_draftinvoicelines_update

Invoice lines that can be used to create a standalone invoice or added to an automatically-generated subscription renewal invoice. This endpoint allows for custom (without product feature) Invoice lines interaction.

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this Base Invoice Line.

Request Body schema: application/json
required
account
required
string (Account)

Account code (ID from external system)

description
required
string (Description) [ 1 .. 256 ] characters
vat_type
required
string (VAT type)
Enum: "physical" "services" "unknown"
collect_vat
boolean (Collect vat)
Default: true

Collect VAT if required - uncheck for VAT-free items like shipping costs (DK)

date_from
required
string <date> (Date from)
date_to
required
string <date> (Date to)
price
required
string <decimal> (Price)
quantity
required
string <decimal> (Quantity)
discount_percentage
string or null <decimal> (Discount %)

Must be greater than 0 and less than or equal to 100. Cannot be combined with other discounts

discount_fixed_per_quantity
string or null <decimal> (Fixed discount per quantity)

Must be greater than 0, and cannot be combined with other discounts

discount_fixed_total
string or null <decimal> (Fixed discount total)

Cannot be combined with other discounts

currency
required
string (Currency)
Enum: "DKK" "EUR" "USD" "GBP" "NZD" "CHF" "PLN" "SEK" "NOK" "ISK" "AUD" "CAD" "CZK"
include_in_next_renewal_invoice
boolean (Include in next renewal invoice)

Include as a line in the next subscription renewal invoice.

revenue_group
string or null (Revenue group)

Name of the Revenue Group (only if Revenue Group feature is enabled, also field is required then).

reference_person
string (Reference person) <= 128 characters
account_reference_person
string (Your reference) <= 128 characters
po_number
string (PO number) <= 128 characters
case_number
string (Case number) <= 128 characters
invoice_supplement
string or null (Invoice supplement)

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

custom_fields
object (BaseInvoiceLineCustomFields)

Responses

Request samples

Content type
application/json
{
  • "account": "string",
  • "description": "string",
  • "vat_type": "physical",
  • "collect_vat": true,
  • "date_from": "2019-08-24",
  • "date_to": "2019-08-24",
  • "price": "string",
  • "quantity": "string",
  • "discount_percentage": "string",
  • "discount_fixed_per_quantity": "string",
  • "discount_fixed_total": "string",
  • "currency": "DKK",
  • "include_in_next_renewal_invoice": true,
  • "revenue_group": "string",
  • "reference_person": "string",
  • "account_reference_person": "string",
  • "po_number": "string",
  • "case_number": "string",
  • "invoice_supplement": "string",
  • "custom_fields": { }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "account": "string",
  • "account_uuid": "847548f7-9cde-4fe5-8751-32ff19825b7e",
  • "description": "string",
  • "vat_type": "physical",
  • "collect_vat": true,
  • "date_from": "2019-08-24",
  • "date_to": "2019-08-24",
  • "price": "string",
  • "quantity": "string",
  • "discount_percentage": "string",
  • "discount_fixed_per_quantity": "string",
  • "discount_fixed_total": "string",
  • "currency": "DKK",
  • "include_in_next_renewal_invoice": true,
  • "revenue_group": "string",
  • "last_modified_date": "2019-08-24T14:15:22Z",
  • "reference_person": "string",
  • "account_reference_person": "string",
  • "po_number": "string",
  • "case_number": "string",
  • "invoice_supplement": "string",
  • "created_date": "2019-08-24T14:15:22Z",
  • "custom_fields": { },
  • "model": "string",
  • "schema": "string"
}

api_v1_draftinvoicelines_partial_update

Invoice lines that can be used to create a standalone invoice or added to an automatically-generated subscription renewal invoice. This endpoint allows for custom (without product feature) Invoice lines interaction.

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this Base Invoice Line.

Request Body schema: application/json
required
account
required
string (Account)

Account code (ID from external system)

description
required
string (Description) [ 1 .. 256 ] characters
vat_type
required
string (VAT type)
Enum: "physical" "services" "unknown"
collect_vat
boolean (Collect vat)
Default: true

Collect VAT if required - uncheck for VAT-free items like shipping costs (DK)

date_from
required
string <date> (Date from)
date_to
required
string <date> (Date to)
price
required
string <decimal> (Price)
quantity
required
string <decimal> (Quantity)
discount_percentage
string or null <decimal> (Discount %)

Must be greater than 0 and less than or equal to 100. Cannot be combined with other discounts

discount_fixed_per_quantity
string or null <decimal> (Fixed discount per quantity)

Must be greater than 0, and cannot be combined with other discounts

discount_fixed_total
string or null <decimal> (Fixed discount total)

Cannot be combined with other discounts

currency
required
string (Currency)
Enum: "DKK" "EUR" "USD" "GBP" "NZD" "CHF" "PLN" "SEK" "NOK" "ISK" "AUD" "CAD" "CZK"
include_in_next_renewal_invoice
boolean (Include in next renewal invoice)

Include as a line in the next subscription renewal invoice.

revenue_group
string or null (Revenue group)

Name of the Revenue Group (only if Revenue Group feature is enabled, also field is required then).

reference_person
string (Reference person) <= 128 characters
account_reference_person
string (Your reference) <= 128 characters
po_number
string (PO number) <= 128 characters
case_number
string (Case number) <= 128 characters
invoice_supplement
string or null (Invoice supplement)

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

custom_fields
object (BaseInvoiceLineCustomFields)

Responses

Request samples

Content type
application/json
{
  • "account": "string",
  • "description": "string",
  • "vat_type": "physical",
  • "collect_vat": true,
  • "date_from": "2019-08-24",
  • "date_to": "2019-08-24",
  • "price": "string",
  • "quantity": "string",
  • "discount_percentage": "string",
  • "discount_fixed_per_quantity": "string",
  • "discount_fixed_total": "string",
  • "currency": "DKK",
  • "include_in_next_renewal_invoice": true,
  • "revenue_group": "string",
  • "reference_person": "string",
  • "account_reference_person": "string",
  • "po_number": "string",
  • "case_number": "string",
  • "invoice_supplement": "string",
  • "custom_fields": { }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "account": "string",
  • "account_uuid": "847548f7-9cde-4fe5-8751-32ff19825b7e",
  • "description": "string",
  • "vat_type": "physical",
  • "collect_vat": true,
  • "date_from": "2019-08-24",
  • "date_to": "2019-08-24",
  • "price": "string",
  • "quantity": "string",
  • "discount_percentage": "string",
  • "discount_fixed_per_quantity": "string",
  • "discount_fixed_total": "string",
  • "currency": "DKK",
  • "include_in_next_renewal_invoice": true,
  • "revenue_group": "string",
  • "last_modified_date": "2019-08-24T14:15:22Z",
  • "reference_person": "string",
  • "account_reference_person": "string",
  • "po_number": "string",
  • "case_number": "string",
  • "invoice_supplement": "string",
  • "created_date": "2019-08-24T14:15:22Z",
  • "custom_fields": { },
  • "model": "string",
  • "schema": "string"
}

api_v1_draftinvoicelines_delete

Invoice lines that can be used to create a standalone invoice or added to an automatically-generated subscription renewal invoice. This endpoint allows for custom (without product feature) Invoice lines interaction.

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this Base Invoice Line.

Responses

ERPAccountLine

api_v1_erp-lines_list

Authorizations:
Token
query Parameters
created_date__lte
string

Format: YYYY-MM-DDTHH:MM:SSZ

created_date__gte
string

Format: YYYY-MM-DDTHH:MM:SSZ

updated_date__lte
string

Format: YYYY-MM-DDTHH:MM:SSZ

updated_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.

Responses

Response samples

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

api_v1_erp-lines_read

Authorizations:
Token
path Parameters
id
required
integer

A unique integer value identifying this erp account line.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "type": "financial",
  • "account_number": 0,
  • "account_number_str": "string",
  • "vat_code": "string",
  • "contra_account_number": 0,
  • "contra_account_number_str": "string",
  • "contra_vat_code": "string",
  • "currency": "DKK",
  • "text": "string",
  • "date": "2019-08-24",
  • "amount": "string",
  • "amount_default_currency": "string",
  • "sync_status": "open",
  • "voucher_id": -2147483648,
  • "sync_time": "2019-08-24T14:15:22Z",
  • "invoice_id": "string",
  • "expense_id": "string",
  • "transaction_id": "string",
  • "supplier_invoice_id": "string",
  • "created_date": "2019-08-24T14:15:22Z",
  • "updated_date": "2019-08-24T14:15:22Z",
  • "model": "string",
  • "schema": "string"
}

api_v1_erp-lines_resend

Authorizations:
Token
path Parameters
id
required
integer

A unique integer value identifying this erp account line.

Request Body schema: application/json
required
object (ResendERPAccountLine)

Responses

Request samples

Content type
application/json
{ }

InvoiceLine

api_v1_invoicelines_list

Authorizations:
Token
query Parameters
account
string

Filter using account code (External ID)

subscription_uuid
string

Filter using Subscription UUID

since
string

Deprecated, one should use date_from.

date__lte
string

Filter using date from the Invoice Format: YYYY-MM-DD

date__gte
string

Filter using date from the Invoice Format: YYYY-MM-DD

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,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1_invoicelines_read

Authorizations:
Token
path Parameters
id
required
integer

A unique integer value identifying this Invoice Line.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "invoice": "f5072b7b-65cb-48aa-bf69-c999195da70c",
  • "account": "string",
  • "account_code": "string",
  • "account_uuid": "847548f7-9cde-4fe5-8751-32ff19825b7e",
  • "description": "string",
  • "vat_type": "physical",
  • "collect_vat": true,
  • "date_from": "2019-08-24",
  • "date_to": "2019-08-24",
  • "price": "string",
  • "quantity": "string",
  • "subtotal": "string",
  • "vat": "string",
  • "total": "string",
  • "currency": "string",
  • "imported_line": true,
  • "refund_of": 0,
  • "subscription": "da7489c5-d730-47b7-9958-07300ef9d3d8",
  • "terms": "631338da-a0b5-4ef0-90ce-ca16c76d475c",
  • "sort_weight": -200,
  • "draft_invoice_line_pk": "e2ca90b8-7081-4327-afde-603d8dd159bd",
  • "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
  • "revenue_group_id": 0,
  • "reference_person": "string",
  • "account_reference_person": "string",
  • "po_number": "string",
  • "case_number": "string",
  • "invoice_supplement": "string",
  • "custom_fields": { },
  • "model": "string",
  • "schema": "string"
}

Invoice

api_v1_invoices_list

Invoices are uniquely numbered lists of sold items and services issued to a customer on a particular date

Authorizations:
Token
query Parameters
uuid
string
invoice_number
number
search
string

Filter by invoice number of company name

account
string

Filter using account code (External ID)

account_not
string

Filter using account code (External ID)

since
string

Deprecated, one should use date__gte.

status_not
string
total__gt
number
total__lt
number
subscription_uuid
string

Filter using Subscription UUID

debt_collection
string
status
string
currency
string
collection_method
string
kickback_status
string
balance
string
imported
string
import_source
string
date__lte
string

Format: YYYY-MM-DD

date__gte
string

Format: YYYY-MM-DD

created_date__lte
string

Format: YYYY-MM-DD

created_date__gte
string

Format: YYYY-MM-DD

last_modified_date__lte
string

Format: YYYY-MM-DD

last_modified_date__gte
string

Format: YYYY-MM-DD

due_date__lte
string

Format: YYYY-MM-DD

due_date__gte
string

Format: YYYY-MM-DD

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.

Responses

Response samples

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

api_v1_invoices_available_vat_billing_periods

Get available VAT billing periods for your organization. If it does not return any options it means that this feature is not available for your country.

Authorizations:
Token

Responses

Response samples

Content type
application/json
[
  • {
    }
]

api_v1_invoices_export_vat_report

Exports Sales and VAT report for the provided VAT billing period, countries, and granularity.

Authorizations:
Token
query Parameters
export_period
string

UUID of the VAT billing period to make export for. If not provided all invoices will be used for making the export.

export_countries
string
Default: "world_wide"
Enum: "world_wide" "eu_countries"

Which countries to include in the export. If not provided, all countries will be included.

export_granularity
string
Default: "invoice"
Enum: "invoice" "account"

The granularity of the report. If not provided, the report will be on invoice-level.

Request Body schema: application/json
required

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "export_id": "string",
  • "job_uuid": "de25c4df-6d4e-439f-9d5f-a4c55d30f26e"
}

api_v1_invoices_export

Invoices are uniquely numbered lists of sold items and services issued to a customer on a particular date

Authorizations:
Token
Request Body schema: application/json
required

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "export_id": "string",
  • "job_uuid": "de25c4df-6d4e-439f-9d5f-a4c55d30f26e"
}

api_v1_invoices_read

Invoices are uniquely numbered lists of sold items and services issued to a customer on a particular date

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this Invoice.

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "invoice_number": 0,
  • "external_invoice_number": "string",
  • "invoice_api_url": "string",
  • "account_uuid": "string",
  • "account_code": "string",
  • "account": {
    },
  • "pay_to_bank_account": 0,
  • "date": "2019-08-24",
  • "due_date": "2019-08-24",
  • "currency": "DKK",
  • "status": "open",
  • "kickback_status": "commission_pending",
  • "collection_method": "payment_card",
  • "pdf_base64": "string",
  • "total": "string",
  • "subtotal": "string",
  • "vat": "string",
  • "balance": "string",
  • "invoiceline_set": [
    ],
  • "imported": true,
  • "import_source": "manual",
  • "model": "string",
  • "schema": "string"
}

api_v1_invoices_partial_update

PATCH is only applicable if you have a KICKBACK feature enabled and want to update the kickback_status of the invoice.

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this Invoice.

Request Body schema: application/json
required
kickback_status
string or null (Kickback status)
Enum: "commission_pending" "commission_paid"

Available only when Kickback feature is turn on for the organization.

Responses

Request samples

Content type
application/json
{
  • "kickback_status": "commission_pending"
}

Response samples

Content type
application/json
{
  • "kickback_status": "commission_pending",
  • "model": "string",
  • "schema": "string"
}

api_v1_invoices_accept_loss

Accept loss for the invoice. Can only accept it if an invoice has a chargeback status and organization has the debt collection feature.

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this Invoice.

Request Body schema: application/json
required
registration_date
required
string <date> (Registration date)

Responses

Request samples

Content type
application/json
{
  • "registration_date": "2019-08-24"
}

api_v1_invoices_apply_credit_note

Creates and applies a credit note to the invoice. The status of the invoice must be chargeback and it must not be imported.

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this Invoice.

Responses

api_v1_invoices_apply_credit

Applies the credit balance of the invoice to another. The balance of the invoice must be less than 0 and the invoice must not be imported.

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this Invoice.

Request Body schema: application/json
required
target_invoice
required
string <uuid> (Target invoice)

The invoice the credit should be applied to.

amount
string <decimal> (Amount)

Amount to credit. Defaults to the balance of the invoice with the credit.

Responses

Request samples

Content type
application/json
{
  • "target_invoice": "8b0a3194-d33a-414b-a5d7-a1aa616a7236",
  • "amount": "string"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

api_v1_invoices_change_collection_method

Change collection method of the invoice. Can only change it if an invoice has a chargeback status.

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this Invoice.

Request Body schema: application/json
required
collection_method
required
string (Collection method)
Enum: "payment_card" "invoice" "direct_debit"

Responses

Request samples

Content type
application/json
{
  • "collection_method": "payment_card"
}

api_v1_invoices_mark_as_due

Mark invoice as due. Can only mark it if an invoice has a chargeback status.

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this Invoice.

Request Body schema: application/json
required

Responses

Request samples

Content type
application/json
{ }

api_v1_invoices_pay

Request paying the Invoice.

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this Invoice.

Request Body schema: application/json
required
collection_method
required
string (Collection method)
Enum: "payment_card" "invoice" "direct_debit"

Responses

Request samples

Content type
application/json
{
  • "collection_method": "payment_card"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

api_v1_invoices_refund

Refund the Invoice and return the representation of the Credit Note.

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this Invoice.

Request Body schema: application/json
required

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "invoice_number": 0,
  • "external_invoice_number": "string",
  • "invoice_api_url": "string",
  • "account_uuid": "string",
  • "account_code": "string",
  • "account": {
    },
  • "pay_to_bank_account": 0,
  • "date": "2019-08-24",
  • "due_date": "2019-08-24",
  • "currency": "DKK",
  • "status": "open",
  • "kickback_status": "commission_pending",
  • "collection_method": "payment_card",
  • "pdf_base64": "string",
  • "total": "string",
  • "subtotal": "string",
  • "vat": "string",
  • "balance": "string",
  • "invoiceline_set": [
    ],
  • "imported": true,
  • "import_source": "manual",
  • "model": "string",
  • "schema": "string"
}

api_v1_invoices_resend

Resend the Invoice. This is asynchronous action and the email will not be sent right away.

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this Invoice.

Request Body schema: application/json
required

Responses

Request samples

Content type
application/json
{ }

KickbackContract

api_v1_kickback_contracts_list

You need to have a Kickback feature enabled to use this endpoint.

Authorizations:
Token
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,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1_kickback_contracts_create

You need to have a Kickback feature enabled to use this endpoint.

Authorizations:
Token
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 128 ] characters
include_upgrades
boolean (Include upgrades)
indefinite
boolean (Indefinite)
duration_amount
integer or null (Duration amount) [ -2147483648 .. 2147483647 ]
duration_unit
string or null (Duration unit)
Enum: "month" "invoice"
percentage_rule_type
string (Commission rate)
Enum: "billing.flatpercentagerule" "billing.invoicesuccessionrule" "billing.accountmrrrule"

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "include_upgrades": true,
  • "indefinite": true,
  • "duration_amount": -2147483648,
  • "duration_unit": "month",
  • "percentage_rule_type": "billing.flatpercentagerule"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "terms": [
    ],
  • "rules": [
    ],
  • "model": "string",
  • "schema": "string",
  • "name": "string",
  • "include_upgrades": true,
  • "indefinite": true,
  • "duration_amount": -2147483648,
  • "duration_unit": "month",
  • "percentage_rule_type": "billing.flatpercentagerule"
}

api_v1_kickback_contracts_read

You need to have a Kickback feature enabled to use this endpoint.

Authorizations:
Token
path Parameters
id
required
integer

A unique integer value identifying this kickback contract.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "terms": [
    ],
  • "rules": [
    ],
  • "model": "string",
  • "schema": "string",
  • "name": "string",
  • "include_upgrades": true,
  • "indefinite": true,
  • "duration_amount": -2147483648,
  • "duration_unit": "month",
  • "percentage_rule_type": "billing.flatpercentagerule"
}

api_v1_kickback_contracts_update

You need to have a Kickback feature enabled to use this endpoint.

Authorizations:
Token
path Parameters
id
required
integer

A unique integer value identifying this kickback contract.

Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 128 ] characters
include_upgrades
boolean (Include upgrades)
indefinite
boolean (Indefinite)
duration_amount
integer or null (Duration amount) [ -2147483648 .. 2147483647 ]
duration_unit
string or null (Duration unit)
Enum: "month" "invoice"
percentage_rule_type
string (Commission rate)
Enum: "billing.flatpercentagerule" "billing.invoicesuccessionrule" "billing.accountmrrrule"

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "include_upgrades": true,
  • "indefinite": true,
  • "duration_amount": -2147483648,
  • "duration_unit": "month",
  • "percentage_rule_type": "billing.flatpercentagerule"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "terms": [
    ],
  • "rules": [
    ],
  • "model": "string",
  • "schema": "string",
  • "name": "string",
  • "include_upgrades": true,
  • "indefinite": true,
  • "duration_amount": -2147483648,
  • "duration_unit": "month",
  • "percentage_rule_type": "billing.flatpercentagerule"
}

api_v1_kickback_contracts_partial_update

You need to have a Kickback feature enabled to use this endpoint.

Authorizations:
Token
path Parameters
id
required
integer

A unique integer value identifying this kickback contract.

Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 128 ] characters
include_upgrades
boolean (Include upgrades)
indefinite
boolean (Indefinite)
duration_amount
integer or null (Duration amount) [ -2147483648 .. 2147483647 ]
duration_unit
string or null (Duration unit)
Enum: "month" "invoice"
percentage_rule_type
string (Commission rate)
Enum: "billing.flatpercentagerule" "billing.invoicesuccessionrule" "billing.accountmrrrule"

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "include_upgrades": true,
  • "indefinite": true,
  • "duration_amount": -2147483648,
  • "duration_unit": "month",
  • "percentage_rule_type": "billing.flatpercentagerule"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "terms": [
    ],
  • "rules": [
    ],
  • "model": "string",
  • "schema": "string",
  • "name": "string",
  • "include_upgrades": true,
  • "indefinite": true,
  • "duration_amount": -2147483648,
  • "duration_unit": "month",
  • "percentage_rule_type": "billing.flatpercentagerule"
}

KickbackPercentageRule

api_v1_kickback_rules_list

You need to have a Kickback feature enabled to use this endpoint.

Authorizations:
Token
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,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1_kickback_rules_create

You need to have a Kickback feature enabled to use this endpoint.

Authorizations:
Token
Request Body schema: application/json
required
percentage
string <decimal> (Percentage)
succession_position
integer (Invoice order) [ -2147483648 .. 2147483647 ]
mrr_value
integer (Minimal MRR Value) [ -2147483648 .. 2147483647 ]

Responses

Request samples

Content type
application/json
{
  • "percentage": "string",
  • "succession_position": -2147483648,
  • "mrr_value": -2147483648
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "description": "string",
  • "model": "string",
  • "schema": "string",
  • "type": "billing.flatpercentagerule",
  • "percentage": "string",
  • "succession_position": -2147483648,
  • "mrr_value": -2147483648
}

api_v1_kickback_rules_read

You need to have a Kickback feature enabled to use this endpoint.

Authorizations:
Token
path Parameters
id
required
integer

A unique integer value identifying this kickback percentage rule.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "description": "string",
  • "model": "string",
  • "schema": "string",
  • "type": "billing.flatpercentagerule",
  • "percentage": "string",
  • "succession_position": -2147483648,
  • "mrr_value": -2147483648
}

api_v1_kickback_rules_update

You need to have a Kickback feature enabled to use this endpoint.

Authorizations:
Token
path Parameters
id
required
integer

A unique integer value identifying this kickback percentage rule.

Request Body schema: application/json
required
percentage
string <decimal> (Percentage)
succession_position
integer (Invoice order) [ -2147483648 .. 2147483647 ]
mrr_value
integer (Minimal MRR Value) [ -2147483648 .. 2147483647 ]

Responses

Request samples

Content type
application/json
{
  • "percentage": "string",
  • "succession_position": -2147483648,
  • "mrr_value": -2147483648
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "description": "string",
  • "model": "string",
  • "schema": "string",
  • "type": "billing.flatpercentagerule",
  • "percentage": "string",
  • "succession_position": -2147483648,
  • "mrr_value": -2147483648
}

api_v1_kickback_rules_partial_update

You need to have a Kickback feature enabled to use this endpoint.

Authorizations:
Token
path Parameters
id
required
integer

A unique integer value identifying this kickback percentage rule.

Request Body schema: application/json
required
percentage
string <decimal> (Percentage)
succession_position
integer (Invoice order) [ -2147483648 .. 2147483647 ]
mrr_value
integer (Minimal MRR Value) [ -2147483648 .. 2147483647 ]

Responses

Request samples

Content type
application/json
{
  • "percentage": "string",
  • "succession_position": -2147483648,
  • "mrr_value": -2147483648
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "description": "string",
  • "model": "string",
  • "schema": "string",
  • "type": "billing.flatpercentagerule",
  • "percentage": "string",
  • "succession_position": -2147483648,
  • "mrr_value": -2147483648
}

OrganizationMember

api_v1_organization-members_available

List available Organization Members

Authorizations:
Token
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
[
  • {
    }
]

api_v1_organization-members_current

Retrieve details of the currently authenticated Organization Member

Authorizations:
Token
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
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "is_admin": true,
  • "language": "string",
  • "initials": "string",
  • "color": "string",
  • "organization": {
    },
  • "user": {
    },
  • "permissions": [
    ],
  • "model": "string",
  • "schema": "string"
}

Partner

api_v1_partners_list

You need to have a Kickback feature enabled to use this endpoint.

Authorizations:
Token
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,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1_partners_create

You need to have a Kickback feature enabled to use this endpoint.

Authorizations:
Token
Request Body schema: application/json
required
contract_id
required
integer (Contract id)
object (KickbackContract)
name
required
string (Name) [ 1 .. 128 ] characters
email
string or null <email> (Email) <= 254 characters
start_date
required
string <date> (Start date)
end_date
string or null <date> (End date)

Responses

Request samples

Content type
application/json
{
  • "contract_id": 0,
  • "contract": {
    },
  • "name": "string",
  • "email": "user@example.com",
  • "start_date": "2019-08-24",
  • "end_date": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "account_set": [
    ],
  • "contract_id": 0,
  • "contract": {
    },
  • "model": "string",
  • "schema": "string",
  • "name": "string",
  • "email": "user@example.com",
  • "start_date": "2019-08-24",
  • "end_date": "2019-08-24"
}

api_v1_partners_read

You need to have a Kickback feature enabled to use this endpoint.

Authorizations:
Token
path Parameters
id
required
integer

A unique integer value identifying this partner.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "account_set": [
    ],
  • "contract_id": 0,
  • "contract": {
    },
  • "model": "string",
  • "schema": "string",
  • "name": "string",
  • "email": "user@example.com",
  • "start_date": "2019-08-24",
  • "end_date": "2019-08-24"
}

api_v1_partners_update

You need to have a Kickback feature enabled to use this endpoint.

Authorizations:
Token
path Parameters
id
required
integer

A unique integer value identifying this partner.

Request Body schema: application/json
required
contract_id
required
integer (Contract id)
object (KickbackContract)
name
required
string (Name) [ 1 .. 128 ] characters
email
string or null <email> (Email) <= 254 characters
start_date
required
string <date> (Start date)
end_date
string or null <date> (End date)

Responses

Request samples

Content type
application/json
{
  • "contract_id": 0,
  • "contract": {
    },
  • "name": "string",
  • "email": "user@example.com",
  • "start_date": "2019-08-24",
  • "end_date": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "account_set": [
    ],
  • "contract_id": 0,
  • "contract": {
    },
  • "model": "string",
  • "schema": "string",
  • "name": "string",
  • "email": "user@example.com",
  • "start_date": "2019-08-24",
  • "end_date": "2019-08-24"
}

api_v1_partners_partial_update

You need to have a Kickback feature enabled to use this endpoint.

Authorizations:
Token
path Parameters
id
required
integer

A unique integer value identifying this partner.

Request Body schema: application/json
required
contract_id
required
integer (Contract id)
object (KickbackContract)
name
required
string (Name) [ 1 .. 128 ] characters
email
string or null <email> (Email) <= 254 characters
start_date
required
string <date> (Start date)
end_date
string or null <date> (End date)

Responses

Request samples

Content type
application/json
{
  • "contract_id": 0,
  • "contract": {
    },
  • "name": "string",
  • "email": "user@example.com",
  • "start_date": "2019-08-24",
  • "end_date": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "account_set": [
    ],
  • "contract_id": 0,
  • "contract": {
    },
  • "model": "string",
  • "schema": "string",
  • "name": "string",
  • "email": "user@example.com",
  • "start_date": "2019-08-24",
  • "end_date": "2019-08-24"
}

api_v1_partners_delete

You need to have a Kickback feature enabled to use this endpoint.

Authorizations:
Token
path Parameters
id
required
integer

A unique integer value identifying this partner.

Responses

api_v1_partners_kickback

Here you can obtain a kickback amount in specified time period for a given partner.

Authorizations:
Token
path Parameters
id
required
integer

A unique integer value identifying this partner.

query Parameters
start_date
string
Default: "Today's date"

Which date should be taken as base for calculcation

end_date
string
Default: "Today's date"

Which date should be taken as base for calculcation

Responses

Response samples

Content type
application/json
{
  • "kickbacks": [
    ],
  • "invoice_lines": [
    ]
}

PaymentCard

api_v1_paymentcards_list

Payment Cards cover both credit and debit cards attached to an account.

Authorizations:
Token
query Parameters
account
string

Filter using account code (External ID)

status
string
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,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1_paymentcards_create

Payment Cards cover both credit and debit cards attached to an account.

Authorizations:
Token
Request Body schema: application/json
required
account
required
string <uuid> (Account)
gateway
required
string (Gateway)
Enum: "stripe" "stripe_new" "noop" "quickpay" "dibs" "dibs_easy"

Payment gateway from which this card is. This field determines what will be stored as token.
Possible values:
stripe - (deprecated) Old Stripe integration using Sources API. Should not be used, as it does not support SCA.
stripe_new - Stripe using PaymentIntents. When using this gateway token should be a Stripe PaymentMethod ID.
quickpay - QuickPay payment provider. In this gateway token should be a QuickPay subscription identifier.
dibs - DIBS payments using D2 API. token will be a DIBS ticket used for ticket_auth.cgi.
dibs_easy - New NETS platfrom - Easy.token needs to be the payment id or subscription id (NOT charge id)
noop - Fake gateway for test purpose only. WARNING: charges with this cards WILL ALWAYS be marked as success in Fenerum, but will not charge anyone. Don't use on real accounts, but feel free to use for testing.

token
required
string (Token) non-empty

ID in payment gateway. What it is depends on the payment_gateway field.

currency
string (Currency)
Enum: "DKK" "EUR" "USD" "GBP" "NZD" "CHF" "PLN" "SEK" "NOK" "ISK" "AUD" "CAD" "CZK"

Required for the dibs_easy gateway unless you use payment id as the token.

Responses

Request samples

Content type
application/json
{
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "gateway": "stripe",
  • "token": "string",
  • "currency": "DKK"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "active": "string",
  • "brand": "string",
  • "card_number": "string",
  • "month": -2147483648,
  • "year": -2147483648,
  • "name": "string",
  • "payment_gateway": "stripe",
  • "payment_gateway_id": "string",
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "model": "string",
  • "schema": "string"
}

api_v1_paymentcards_initiate_setup

Payment Cards cover both credit and debit cards attached to an account.

Authorizations:
Token
Request Body schema: application/json
required
payment_gateway
required
string (Payment gateway)
Enum: "stripe" "stripe_new"

Responses

Request samples

Content type
application/json
{
  • "payment_gateway": "stripe"
}

Response samples

Content type
application/json
{
  • "payment_gateway": "stripe",
  • "setup_details": { }
}

api_v1_paymentcards_read

Payment Cards cover both credit and debit cards attached to an account.

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this Payment Card.

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "active": "string",
  • "brand": "string",
  • "card_number": "string",
  • "month": -2147483648,
  • "year": -2147483648,
  • "name": "string",
  • "payment_gateway": "stripe",
  • "payment_gateway_id": "string",
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "model": "string",
  • "schema": "string"
}

api_v1_paymentcards_disable

Payment Cards cover both credit and debit cards attached to an account.

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this Payment Card.

Request Body schema: application/json
required
object (DisablePaymentCard)

Responses

Request samples

Content type
application/json
{ }

Plan

api_v1_plans_list

Authorizations:
Token
query Parameters
code
string
with_code
string
last_modified_date__lte
string

Format: YYYY-MM-DD

last_modified_date__org_tz_lte
string

Format: YYYY-MM-DD

last_modified_date__gte
string

Format: YYYY-MM-DD

last_modified_date__org_tz_gte
string

Format: YYYY-MM-DD

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,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1_plans_create

Authorizations:
Token
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 128 ] characters
code
string or null (Custom ID from external system) <= 128 characters

ID from external system. If you don't have one you can just put any unique value here by which you will be able to reference this object on other items.

description
string or null (Description)
collect_vat
boolean (Collect VAT)
vat_type
required
string (VAT type)
Enum: "physical" "services" "unknown"

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "code": "string",
  • "description": "string",
  • "collect_vat": true,
  • "vat_type": "physical"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "code": "string",
  • "description": "string",
  • "collect_vat": true,
  • "vat_type": "physical",
  • "planterms_set": [
    ],
  • "last_modified_date": "2019-08-24T14:15:22Z",
  • "model": "string",
  • "schema": "string"
}

api_v1_plans_calculate

Authorizations:
Token
Request Body schema: application/json
required
account_code
string (Account code) non-empty
account_country_code
required
string (Account country code) non-empty
terms
required
string <uuid> (Terms)
quantity
required
integer (Quantity)

Responses

Request samples

Content type
application/json
{
  • "account_code": "string",
  • "account_country_code": "string",
  • "terms": "631338da-a0b5-4ef0-90ce-ca16c76d475c",
  • "quantity": 0
}

Response samples

Content type
application/json
{
  • "account_code": "string",
  • "account_country_code": "string",
  • "terms": "631338da-a0b5-4ef0-90ce-ca16c76d475c",
  • "quantity": 0,
  • "model": "string",
  • "schema": "string"
}

api_v1_plans_read

Authorizations:
Token
path Parameters
identifier
required
string
header Parameters
Lookup-Field
string

Name of field used as resource identifier. Possible values: uuid, code

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "code": "string",
  • "description": "string",
  • "collect_vat": true,
  • "vat_type": "physical",
  • "planterms_set": [
    ],
  • "last_modified_date": "2019-08-24T14:15:22Z",
  • "model": "string",
  • "schema": "string"
}

api_v1_plans_partial_update

Authorizations:
Token
path Parameters
identifier
required
string
header Parameters
Lookup-Field
string

Name of field used as resource identifier. Possible values: uuid, code

Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 128 ] characters
code
string or null (Custom ID from external system) <= 128 characters

ID from external system. If you don't have one you can just put any unique value here by which you will be able to reference this object on other items.

description
string or null (Description)
collect_vat
boolean (Collect VAT)
vat_type
required
string (VAT type)
Enum: "physical" "services" "unknown"

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "code": "string",
  • "description": "string",
  • "collect_vat": true,
  • "vat_type": "physical"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "code": "string",
  • "description": "string",
  • "collect_vat": true,
  • "vat_type": "physical",
  • "planterms_set": [
    ],
  • "last_modified_date": "2019-08-24T14:15:22Z",
  • "model": "string",
  • "schema": "string"
}

PlanTerms

api_v1_plans_terms_list

Authorizations:
Token
path Parameters
plan_identifier
required
string
query Parameters
code
string
header Parameters
Lookup-Field
string

Name of field used as resource identifiers. Possible values: uuid, code

Responses

Response samples

Content type
application/json
[
  • {
    }
]

api_v1_plans_terms_create

Authorizations:
Token
path Parameters
plan_identifier
required
string
header Parameters
Lookup-Field
string

Name of field used as resource identifiers. Possible values: uuid, code

Request Body schema: application/json
required
code
string or null (Custom ID from external system) <= 128 characters

ID from external system. If you don't have one you can just put any unique value here by which you will be able to reference this object on other items.

interval_type
required
string (Interval type)
Enum: "day" "month" "year"
interval_count
required
integer (Interval count) [ 1 .. 2147483647 ]
price
required
string <decimal> (Price)
currency
required
string (Currency)
Enum: "DKK" "EUR" "USD" "GBP" "NZD" "CHF" "PLN" "SEK" "NOK" "ISK" "AUD" "CAD" "CZK"
backwards_charging
boolean (Backwards charging)
active
boolean (Active)
revenue_group
string or null (Revenue group)

Name of the Revenue Group (only if Revenue Group feature is enabled, also field is required then).

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "interval_type": "day",
  • "interval_count": 1,
  • "price": "string",
  • "currency": "DKK",
  • "backwards_charging": true,
  • "active": true,
  • "revenue_group": "string"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "code": "string",
  • "interval_type": "day",
  • "interval_count": 1,
  • "price": "string",
  • "currency": "DKK",
  • "backwards_charging": true,
  • "active": true,
  • "revenue_group": "string",
  • "model": "string",
  • "schema": "string"
}

api_v1_plans_terms_read

Authorizations:
Token
path Parameters
identifier
required
string
plan_identifier
required
string
header Parameters
Lookup-Field
string

Name of field used as resource identifiers. Possible values: uuid, code

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "code": "string",
  • "interval_type": "day",
  • "interval_count": 1,
  • "price": "string",
  • "currency": "DKK",
  • "backwards_charging": true,
  • "active": true,
  • "revenue_group": "string",
  • "model": "string",
  • "schema": "string"
}

api_v1_plans_terms_partial_update

Authorizations:
Token
path Parameters
identifier
required
string
plan_identifier
required
string
header Parameters
Lookup-Field
string

Name of field used as resource identifiers. Possible values: uuid, code

Request Body schema: application/json
required
code
string or null (Custom ID from external system) <= 128 characters

ID from external system. If you don't have one you can just put any unique value here by which you will be able to reference this object on other items.

interval_type
required
string (Interval type)
Enum: "day" "month" "year"
interval_count
required
integer (Interval count) [ 1 .. 2147483647 ]
price
required
string <decimal> (Price)
currency
required
string (Currency)
Enum: "DKK" "EUR" "USD" "GBP" "NZD" "CHF" "PLN" "SEK" "NOK" "ISK" "AUD" "CAD" "CZK"
active
boolean (Active)
revenue_group
string or null (Revenue group)

Name of the Revenue Group (only if Revenue Group feature is enabled, also field is required then).

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "interval_type": "day",
  • "interval_count": 1,
  • "price": "string",
  • "currency": "DKK",
  • "active": true,
  • "revenue_group": "string"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "code": "string",
  • "interval_type": "day",
  • "interval_count": 1,
  • "price": "string",
  • "currency": "DKK",
  • "backwards_charging": true,
  • "active": true,
  • "revenue_group": "string",
  • "model": "string",
  • "schema": "string"
}

Product

api_v1_products_list

Authorizations:
Token
query Parameters
product_type
string
is_active
string
name
string
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.

Responses

Response samples

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

api_v1_products_create

Authorizations:
Token
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 100 ] characters
description
string (Description)

Will be displayed under the name of Invoice Line

revenue_group
required
integer (Revenue group)
product_type
required
string (Product type)
Enum: "goods" "services"
is_active
boolean (Is active)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "revenue_group": 0,
  • "product_type": "goods",
  • "is_active": true
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "description": "string",
  • "revenue_group": 0,
  • "product_type": "goods",
  • "is_active": true,
  • "product_pricings": [
    ]
}

api_v1_products_export_pricing

Authorizations:
Token
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 100 ] characters
description
string (Description)

Will be displayed under the name of Invoice Line

revenue_group
required
integer (Revenue group)
product_type
required
string (Product type)
Enum: "goods" "services"
is_active
boolean (Is active)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "revenue_group": 0,
  • "product_type": "goods",
  • "is_active": true
}

Response samples

Content type
application/json
{
  • "export_id": "string",
  • "job_uuid": "de25c4df-6d4e-439f-9d5f-a4c55d30f26e"
}

api_v1_products_export

Authorizations:
Token
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 100 ] characters
description
string (Description)

Will be displayed under the name of Invoice Line

revenue_group
required
integer (Revenue group)
product_type
required
string (Product type)
Enum: "goods" "services"
is_active
boolean (Is active)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "revenue_group": 0,
  • "product_type": "goods",
  • "is_active": true
}

Response samples

Content type
application/json
{
  • "export_id": "string",
  • "job_uuid": "de25c4df-6d4e-439f-9d5f-a4c55d30f26e"
}

api_v1_products_read

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this product.

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "description": "string",
  • "revenue_group": 0,
  • "product_type": "goods",
  • "is_active": true,
  • "product_pricings": [
    ]
}

api_v1_products_update

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this product.

Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 100 ] characters
description
string (Description)

Will be displayed under the name of Invoice Line

revenue_group
required
integer (Revenue group)
product_type
required
string (Product type)
Enum: "goods" "services"
is_active
boolean (Is active)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "revenue_group": 0,
  • "product_type": "goods",
  • "is_active": true
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "description": "string",
  • "revenue_group": 0,
  • "product_type": "goods",
  • "is_active": true,
  • "product_pricings": [
    ]
}

api_v1_products_partial_update

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this product.

Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 100 ] characters
description
string (Description)

Will be displayed under the name of Invoice Line

revenue_group
required
integer (Revenue group)
product_type
required
string (Product type)
Enum: "goods" "services"
is_active
boolean (Is active)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "revenue_group": 0,
  • "product_type": "goods",
  • "is_active": true
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "description": "string",
  • "revenue_group": 0,
  • "product_type": "goods",
  • "is_active": true,
  • "product_pricings": [
    ]
}

api_v1_products_delete

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this product.

Responses

ProductPricing

api_v1_products_pricings_list

Authorizations:
Token
path Parameters
product_uuid
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

api_v1_products_pricings_create

Authorizations:
Token
path Parameters
product_uuid
required
string
Request Body schema: application/json
required
price
required
string <decimal> (Price)
currency
required
string (Currency)
Enum: "DKK" "EUR" "USD" "GBP" "NZD" "CHF" "PLN" "SEK" "NOK" "ISK" "AUD" "CAD" "CZK"
is_active
boolean (Is active)

Responses

Request samples

Content type
application/json
{
  • "price": "string",
  • "currency": "DKK",
  • "is_active": true
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "price": "string",
  • "currency": "DKK",
  • "is_active": true
}

api_v1_products_pricings_read

Authorizations:
Token
path Parameters
product_uuid
required
string
uuid
required
string <uuid>

A UUID string identifying this product pricing.

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "price": "string",
  • "currency": "DKK",
  • "is_active": true
}

api_v1_products_pricings_update

Authorizations:
Token
path Parameters
product_uuid
required
string
uuid
required
string <uuid>

A UUID string identifying this product pricing.

Request Body schema: application/json
required
price
required
string <decimal> (Price)
currency
required
string (Currency)
Enum: "DKK" "EUR" "USD" "GBP" "NZD" "CHF" "PLN" "SEK" "NOK" "ISK" "AUD" "CAD" "CZK"
is_active
boolean (Is active)

Responses

Request samples

Content type
application/json
{
  • "price": "string",
  • "currency": "DKK",
  • "is_active": true
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "price": "string",
  • "currency": "DKK",
  • "is_active": true
}

api_v1_products_pricings_partial_update

Authorizations:
Token
path Parameters
product_uuid
required
string
uuid
required
string <uuid>

A UUID string identifying this product pricing.

Request Body schema: application/json
required
price
required
string <decimal> (Price)
currency
required
string (Currency)
Enum: "DKK" "EUR" "USD" "GBP" "NZD" "CHF" "PLN" "SEK" "NOK" "ISK" "AUD" "CAD" "CZK"
is_active
boolean (Is active)

Responses

Request samples

Content type
application/json
{
  • "price": "string",
  • "currency": "DKK",
  • "is_active": true
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "price": "string",
  • "currency": "DKK",
  • "is_active": true
}

api_v1_products_pricings_delete

Authorizations:
Token
path Parameters
product_uuid
required
string
uuid
required
string <uuid>

A UUID string identifying this product pricing.

Responses

Receipt

api_v1_receipts_list

Authorizations:
Token
query Parameters
currency
string
status
string
pending_match
string
verified
string
document_date__lte
string

Format: YYYY-MM-DD

document_date__gte
string

Format: YYYY-MM-DD

created_date__lte
string

Format: YYYY-MM-DD

created_date__org_tz_lte
string

Format: YYYY-MM-DD

created_date__gte
string

Format: YYYY-MM-DD

created_date__org_tz_gte
string

Format: YYYY-MM-DD

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.

Responses

Response samples

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

api_v1_receipts_bulk_action

Authorizations:
Token
Request Body schema: application/json
required
document_date
string or null <date> (Document date)
currency
required
string (Currency)
Enum: "DKK" "EUR" "USD" "GBP" "NZD" "CHF" "PLN" "SEK" "NOK" "ISK" "AUD" "CAD" "CZK"
required
object (Supplier)
supplier_receipt_number
string or null (Supplier receipt number) <= 128 characters
note
string (Note)
verified_by
string or null <uuid> (Verified by)
verified_on
string or null <date-time> (Verified on)
created_by
string or null <uuid> (Created by)
required
Array of objects (MinimalExpenseDocumentCost)
senders_email
string <email> (Senders email) <= 254 characters
original_filename
string (Original filename) <= 128 characters

Responses

Request samples

Content type
application/json
{
  • "document_date": "2019-08-24",
  • "currency": "DKK",
  • "supplier": {
    },
  • "supplier_receipt_number": "string",
  • "note": "string",
  • "verified_by": "8c493be0-efe2-4a3e-bdbd-7af0eab50aa2",
  • "verified_on": "2019-08-24T14:15:22Z",
  • "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
  • "costs": [
    ],
  • "senders_email": "user@example.com",
  • "original_filename": "string"
}

Response samples

Content type
application/json
{
  • "action_id": "string",
  • "job_uuid": "de25c4df-6d4e-439f-9d5f-a4c55d30f26e"
}

api_v1_receipts_read

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "id": 0,
  • "status": "unmatched",
  • "document_date": "2019-08-24",
  • "amount": "string",
  • "currency": "DKK",
  • "supplier": {
    },
  • "supplier_receipt_number": "string",
  • "cost_account": "string",
  • "note": "string",
  • "file_url": "string",
  • "verified_by": "8c493be0-efe2-4a3e-bdbd-7af0eab50aa2",
  • "verified_by_for_display": "string",
  • "verified_on": "2019-08-24T14:15:22Z",
  • "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
  • "created_by_for_display": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "matched_expenses_amount": "string",
  • "matched_expenses_remaining_amount": "string",
  • "expense_set": [
    ],
  • "costs": [
    ],
  • "senders_email": "user@example.com",
  • "original_filename": "string",
  • "model": "string",
  • "schema": "string"
}

Recipient

api_v1_recipients_list

Recipients are destinations where we send notifications for a given account. Each recipient may ask for certain notifications only.

Authorizations:
Token
query Parameters
email
string
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,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1_recipients_create

Recipients are destinations where we send notifications for a given account. Each recipient may ask for certain notifications only.

Authorizations:
Token
Request Body schema: application/json
required
account
required
string <uuid> (Account)

Account UUID for which recipient will be created.

name
required
string (Name) [ 1 .. 128 ] characters
email
required
string <email> (Email) [ 1 .. 254 ] characters
receive_invoice
required
boolean (Receive invoice)
receive_payment_confirmation
required
boolean (Receive payment confirmation)

When checked, the recipient will receive a payment confirmation whenever a payment succeeds. This applies to all collection methods.

receive_payment_card_notifications
boolean (Receive payment card notification)

In order to send card expiry notifications you also need to enable it in the payments section of the integrations settings

has_access_to_self_service
boolean (Has access to Self-Service)

When checked, the recipient has access to Self-Service

Responses

Request samples

Content type
application/json
{
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "name": "string",
  • "email": "user@example.com",
  • "receive_invoice": true,
  • "receive_payment_confirmation": true,
  • "receive_payment_card_notifications": true,
  • "has_access_to_self_service": true
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "account_code": "string",
  • "name": "string",
  • "email": "user@example.com",
  • "receive_invoice": true,
  • "receive_payment_confirmation": true,
  • "receive_payment_card_notifications": true,
  • "has_access_to_self_service": true,
  • "model": "string",
  • "schema": "string"
}

api_v1_recipients_export

Recipients are destinations where we send notifications for a given account. Each recipient may ask for certain notifications only.

Authorizations:
Token
Request Body schema: application/json
required

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "export_id": "string",
  • "job_uuid": "de25c4df-6d4e-439f-9d5f-a4c55d30f26e"
}

api_v1_recipients_read

Recipients are destinations where we send notifications for a given account. Each recipient may ask for certain notifications only.

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this Recipient.

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "account_code": "string",
  • "name": "string",
  • "email": "user@example.com",
  • "receive_invoice": true,
  • "receive_payment_confirmation": true,
  • "receive_payment_card_notifications": true,
  • "has_access_to_self_service": true,
  • "model": "string",
  • "schema": "string"
}

api_v1_recipients_update

Recipients are destinations where we send notifications for a given account. Each recipient may ask for certain notifications only.

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this Recipient.

Request Body schema: application/json
required
account
required
string <uuid> (Account)

Account UUID for which recipient will be created.

name
required
string (Name) [ 1 .. 128 ] characters
email
required
string <email> (Email) [ 1 .. 254 ] characters
receive_invoice
required
boolean (Receive invoice)
receive_payment_confirmation
required
boolean (Receive payment confirmation)

When checked, the recipient will receive a payment confirmation whenever a payment succeeds. This applies to all collection methods.

receive_payment_card_notifications
boolean (Receive payment card notification)

In order to send card expiry notifications you also need to enable it in the payments section of the integrations settings

has_access_to_self_service
boolean (Has access to Self-Service)

When checked, the recipient has access to Self-Service

Responses

Request samples

Content type
application/json
{
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "name": "string",
  • "email": "user@example.com",
  • "receive_invoice": true,
  • "receive_payment_confirmation": true,
  • "receive_payment_card_notifications": true,
  • "has_access_to_self_service": true
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "account_code": "string",
  • "name": "string",
  • "email": "user@example.com",
  • "receive_invoice": true,
  • "receive_payment_confirmation": true,
  • "receive_payment_card_notifications": true,
  • "has_access_to_self_service": true,
  • "model": "string",
  • "schema": "string"
}

api_v1_recipients_partial_update

Recipients are destinations where we send notifications for a given account. Each recipient may ask for certain notifications only.

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this Recipient.

Request Body schema: application/json
required
account
required
string <uuid> (Account)

Account UUID for which recipient will be created.

name
required
string (Name) [ 1 .. 128 ] characters
email
required
string <email> (Email) [ 1 .. 254 ] characters
receive_invoice
required
boolean (Receive invoice)
receive_payment_confirmation
required
boolean (Receive payment confirmation)

When checked, the recipient will receive a payment confirmation whenever a payment succeeds. This applies to all collection methods.

receive_payment_card_notifications
boolean (Receive payment card notification)

In order to send card expiry notifications you also need to enable it in the payments section of the integrations settings

has_access_to_self_service
boolean (Has access to Self-Service)

When checked, the recipient has access to Self-Service

Responses

Request samples

Content type
application/json
{
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "name": "string",
  • "email": "user@example.com",
  • "receive_invoice": true,
  • "receive_payment_confirmation": true,
  • "receive_payment_card_notifications": true,
  • "has_access_to_self_service": true
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  • "account_code": "string",
  • "name": "string",
  • "email": "user@example.com",
  • "receive_invoice": true,
  • "receive_payment_confirmation": true,
  • "receive_payment_card_notifications": true,
  • "has_access_to_self_service": true,
  • "model": "string",
  • "schema": "string"
}

api_v1_recipients_delete

Recipients are destinations where we send notifications for a given account. Each recipient may ask for certain notifications only.

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this Recipient.

Responses

RevenueGroup

api_v1_revenuegroup_list

Authorizations:
Token
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,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1_revenuegroup_create

Authorizations:
Token
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 100 ] characters
required
Array of objects (RevenueGroupCountry)
default_revenue_account_eu
string or null <uuid> (Revenue account for EU clients)
default_revenue_account_eu_vat_exempt
string or null <uuid> (Revenue account for EU VAT-exempt clients)

In most cases, you could use the same account that you use for domestic sales

default_revenue_account
string or null <uuid> (Revenue account for clients from the rest of the world)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "revenuegroupcountry_set": [
    ],
  • "default_revenue_account_eu": "f9583bcc-541a-4159-b188-3eceb6c658e8",
  • "default_revenue_account_eu_vat_exempt": "f8577732-8caf-4d88-ad11-4f43a9ec05bd",
  • "default_revenue_account": "e423f4ec-f607-4f5a-9676-bb4746c9b320"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "revenuegroupcountry_set": [
    ],
  • "default_revenue_account_eu": "f9583bcc-541a-4159-b188-3eceb6c658e8",
  • "default_revenue_account_eu_vat_exempt": "f8577732-8caf-4d88-ad11-4f43a9ec05bd",
  • "default_revenue_account": "e423f4ec-f607-4f5a-9676-bb4746c9b320",
  • "model": "string",
  • "schema": "string"
}

api_v1_revenuegroup_read

Authorizations:
Token
path Parameters
id
required
integer

A unique integer value identifying this Revenue Group.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "revenuegroupcountry_set": [
    ],
  • "default_revenue_account_eu": "f9583bcc-541a-4159-b188-3eceb6c658e8",
  • "default_revenue_account_eu_vat_exempt": "f8577732-8caf-4d88-ad11-4f43a9ec05bd",
  • "default_revenue_account": "e423f4ec-f607-4f5a-9676-bb4746c9b320",
  • "model": "string",
  • "schema": "string"
}

api_v1_revenuegroup_update

Authorizations:
Token
path Parameters
id
required
integer

A unique integer value identifying this Revenue Group.

Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 100 ] characters
required
Array of objects (RevenueGroupCountry)
default_revenue_account_eu
string or null <uuid> (Revenue account for EU clients)
default_revenue_account_eu_vat_exempt
string or null <uuid> (Revenue account for EU VAT-exempt clients)

In most cases, you could use the same account that you use for domestic sales

default_revenue_account
string or null <uuid> (Revenue account for clients from the rest of the world)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "revenuegroupcountry_set": [
    ],
  • "default_revenue_account_eu": "f9583bcc-541a-4159-b188-3eceb6c658e8",
  • "default_revenue_account_eu_vat_exempt": "f8577732-8caf-4d88-ad11-4f43a9ec05bd",
  • "default_revenue_account": "e423f4ec-f607-4f5a-9676-bb4746c9b320"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "revenuegroupcountry_set": [
    ],
  • "default_revenue_account_eu": "f9583bcc-541a-4159-b188-3eceb6c658e8",
  • "default_revenue_account_eu_vat_exempt": "f8577732-8caf-4d88-ad11-4f43a9ec05bd",
  • "default_revenue_account": "e423f4ec-f607-4f5a-9676-bb4746c9b320",
  • "model": "string",
  • "schema": "string"
}

api_v1_revenuegroup_partial_update

Authorizations:
Token
path Parameters
id
required
integer

A unique integer value identifying this Revenue Group.

Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 100 ] characters
required
Array of objects (RevenueGroupCountry)
default_revenue_account_eu
string or null <uuid> (Revenue account for EU clients)
default_revenue_account_eu_vat_exempt
string or null <uuid> (Revenue account for EU VAT-exempt clients)

In most cases, you could use the same account that you use for domestic sales

default_revenue_account
string or null <uuid> (Revenue account for clients from the rest of the world)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "revenuegroupcountry_set": [
    ],
  • "default_revenue_account_eu": "f9583bcc-541a-4159-b188-3eceb6c658e8",
  • "default_revenue_account_eu_vat_exempt": "f8577732-8caf-4d88-ad11-4f43a9ec05bd",
  • "default_revenue_account": "e423f4ec-f607-4f5a-9676-bb4746c9b320"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "revenuegroupcountry_set": [
    ],
  • "default_revenue_account_eu": "f9583bcc-541a-4159-b188-3eceb6c658e8",
  • "default_revenue_account_eu_vat_exempt": "f8577732-8caf-4d88-ad11-4f43a9ec05bd",
  • "default_revenue_account": "e423f4ec-f607-4f5a-9676-bb4746c9b320",
  • "model": "string",
  • "schema": "string"
}

api_v1_revenuegroup_delete

Authorizations:
Token
path Parameters
id
required
integer

A unique integer value identifying this Revenue Group.

Responses

Subscription

api_v1_subscriptions_list

Subscriptions are instances of plan terms on a specific account. You can modify subscriptions or cancel them.

Authorizations:
Token
query Parameters
account
string

Filter using account code (External ID)

plan
string

Filter using Plan UUID

terms
string

Filter using Plan Terms UUID

status
string
collection_method
string
account_active_payment_method
string
set_to_expire
string
has_recipient_receiving_invoices
string
has_custom_price
string
start_date__lte
string

Format: YYYY-MM-DD

start_date__org_tz_lte
string

Format: YYYY-MM-DD

start_date__gte
string

Format: YYYY-MM-DD

start_date__org_tz_gte
string

Format: YYYY-MM-DD

next_renewal_date__lte
string

Format: YYYY-MM-DD

next_renewal_date__org_tz_lte
string

Format: YYYY-MM-DD

next_renewal_date__gte
string

Format: YYYY-MM-DD

next_renewal_date__org_tz_gte
string

Format: YYYY-MM-DD

end_date__lte
string

Format: YYYY-MM-DD

end_date__org_tz_lte
string

Format: YYYY-MM-DD

end_date__gte
string

Format: YYYY-MM-DD

end_date__org_tz_gte
string

Format: YYYY-MM-DD

last_modified_date__lte
string

Format: YYYY-MM-DD

last_modified_date__org_tz_lte
string

Format: YYYY-MM-DD

last_modified_date__gte
string

Format: YYYY-MM-DD

last_modified_date__org_tz_gte
string

Format: YYYY-MM-DD

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.

Responses

Response samples

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

api_v1_subscriptions_create

Authorizations:
Token
Request Body schema: application/json
required
account
required
string (Account)

Account code (ID from external system)

terms
required
string <uuid> (Terms)
pre_renewal_invoicing
boolean (Pre renewal invoicing)
Default: false

DEPRECATED: use pre_renewal_days_offset instead

custom_fields
object (SubscriptionCustomFields)
start_date
string or null <date-time> (Start date)

If not set it will be set to the moment of creation to start immediately.

custom_churn_reason
string or null (Custom churn reason) <= 100 characters
quantity
integer (Quantity) [ 0 .. 2147483647 ]
Default: 1

Number of subscribed users

collection_method
required
string (Collection method)
Enum: "payment_card" "invoice" "direct_debit"
group_on_invoice
boolean (Group on invoice)

Subscription renewing on the same date, with same currency, payment terms, collection method and PO number will be charged on the single invoice.

payment_terms
integer or null (Payment terms) [ 0 .. 2147483647 ]
Default: 0

Days until payment, 0 means on receipt. If left empty default value will be used. Default value is taken from account setting (Default payment terms). If account setting is empty it will default to the organization setting.

override_price
string or null <decimal> (Override price)

Specify the price and override the one form the Plan Term. If any discounts are applicable to this Subscription, they will be applied to this price.

pre_renewal_days_offset
integer (Pre-renewal invoicing) [ 0 .. 32767 ]
Default: 0

Number of days before the renewal date a new invoice should be generated. It can be set only for forward-charging plans.

reference_person
string (Reference person) <= 128 characters
account_reference_person
string (Your reference) <= 128 characters
po_number
string (PO number) <= 128 characters
case_number
string (Case number) <= 128 characters
invoice_supplement
string or null (Invoice supplement)

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

churn_reason
string or null <uuid> (Churn reason)

You can define available churn reasons in Objects Settings

Responses

Request samples

Content type
application/json
{
  • "account": "string",
  • "terms": "631338da-a0b5-4ef0-90ce-ca16c76d475c",
  • "pre_renewal_invoicing": false,
  • "custom_fields": { },
  • "start_date": "2019-08-24T14:15:22Z",
  • "custom_churn_reason": "string",
  • "quantity": 1,
  • "collection_method": "payment_card",
  • "group_on_invoice": true,
  • "payment_terms": 0,
  • "override_price": "string",
  • "pre_renewal_days_offset": 0,
  • "reference_person": "string",
  • "account_reference_person": "string",
  • "po_number": "string",
  • "case_number": "string",
  • "invoice_supplement": "string",
  • "churn_reason": "b06e9988-1cd3-4228-a984-64110b49a9ec"
}

Response samples

Content type
application/json
{
  • "account": "string",
  • "terms": "631338da-a0b5-4ef0-90ce-ca16c76d475c",
  • "pre_renewal_invoicing": false,
  • "custom_fields": { },
  • "model": "string",
  • "schema": "string",
  • "start_date": "2019-08-24T14:15:22Z",
  • "custom_churn_reason": "string",
  • "quantity": 1,
  • "collection_method": "payment_card",
  • "group_on_invoice": true,
  • "payment_terms": 0,
  • "override_price": "string",
  • "pre_renewal_days_offset": 0,
  • "reference_person": "string",
  • "account_reference_person": "string",
  • "po_number": "string",
  • "case_number": "string",
  • "invoice_supplement": "string",
  • "last_modified_date": "2019-08-24T14:15:22Z",
  • "churn_reason": "b06e9988-1cd3-4228-a984-64110b49a9ec"
}

api_v1_subscriptions_activity_months

Subscriptions are instances of plan terms on a specific account. You can modify subscriptions or cancel them.

Authorizations:
Token
query Parameters
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.

Responses

Response samples

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

api_v1_subscriptions_deprecated_activity_months Deprecated

Subscriptions are instances of plan terms on a specific account. You can modify subscriptions or cancel them.

Authorizations:
Token
query Parameters
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.

Responses

Response samples

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

api_v1_subscriptions_bulk_action

Subscriptions are instances of plan terms on a specific account. You can modify subscriptions or cancel them.

Authorizations:
Token
Request Body schema: application/json
required
object (MinimalAccount)
object (PlanTerms)
object (EmbeddedPlan)
start_date
string or null <date-time> (Start date)

If not set it will be set to the moment of creation to start immediately.

end_date
string or null <date-time> (End date)
next_renewal_date
string or null <date-time> (Next renewal date)
last_renewal_date
string or null <date-time> (Last renewal date)
base_renewal_date
string or null <date-time> (Base renewal date)
quantity
integer (Quantity) [ 0 .. 2147483647 ]

Number of subscribed users

collection_method
string (Collection method)
Enum: "payment_card" "invoice" "direct_debit"
group_on_invoice
boolean (Group on invoice)

Subscription renewing on the same date, with same currency, payment terms, collection method and PO number will be charged on the single invoice.

payment_terms
integer or null (Payment terms) [ -2147483648 .. 2147483647 ]

Days until payment, 0 means on receipt. If left empty default value will be used. Default value is taken from account setting (Default payment terms). If account setting is empty it will default to the organization setting.

pre_renewal_days_offset
integer (Pre-renewal invoicing) [ 0 .. 32767 ]

Number of days before the renewal date a new invoice should be generated. It can be set only for forward-charging plans.

po_number
string (PO number) <= 128 characters
invoice_supplement
string or null (Invoice supplement)

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

override_price
string or null <decimal> (Override price)

Specify the price and override the one form the Plan Term. If any discounts are applicable to this Subscription, they will be applied to this price.

reference_person
string (Reference person) <= 128 characters
account_reference_person
string (Your reference) <= 128 characters
case_number
string (Case number) <= 128 characters
object (ChurnReason)
custom_churn_reason
string or null (Custom churn reason) <= 100 characters
custom_fields
object (SubscriptionCustomFields)

Responses

Request samples

Content type
application/json
{
  • "account": {
    },
  • "terms": {
    },
  • "plan": {
    },
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "next_renewal_date": "2019-08-24T14:15:22Z",
  • "last_renewal_date": "2019-08-24T14:15:22Z",
  • "base_renewal_date": "2019-08-24T14:15:22Z",
  • "quantity": 2147483647,
  • "collection_method": "payment_card",
  • "group_on_invoice": true,
  • "payment_terms": -2147483648,
  • "pre_renewal_days_offset": 32767,
  • "po_number": "string",
  • "invoice_supplement": "string",
  • "override_price": "string",
  • "reference_person": "string",
  • "account_reference_person": "string",
  • "case_number": "string",
  • "churn_reason": {
    },
  • "custom_churn_reason": "string",
  • "custom_fields": { }
}

Response samples

Content type
application/json
{
  • "action_id": "string",
  • "job_uuid": "de25c4df-6d4e-439f-9d5f-a4c55d30f26e"
}

api_v1_subscriptions_export

Subscriptions are instances of plan terms on a specific account. You can modify subscriptions or cancel them.

Authorizations:
Token
Request Body schema: application/json
required

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "export_id": "string",
  • "job_uuid": "de25c4df-6d4e-439f-9d5f-a4c55d30f26e"
}

api_v1_subscriptions_mrr_per_month

Subscriptions are instances of plan terms on a specific account. You can modify subscriptions or cancel them.

Authorizations:
Token
query Parameters
year
required
integer
month
required
integer
subscription
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

api_v1_subscriptions_deprecated_mrr_per_month Deprecated

Subscriptions are instances of plan terms on a specific account. You can modify subscriptions or cancel them.

Authorizations:
Token
query Parameters
year
required
integer
month
required
integer
subscription
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

api_v1_subscriptions_retention_cohort

Subscriptions are instances of plan terms on a specific account. You can modify subscriptions or cancel them.

Authorizations:
Token
query Parameters
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.

Responses

Response samples

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

api_v1_subscriptions_deprecated_retention_cohort Deprecated

Subscriptions are instances of plan terms on a specific account. You can modify subscriptions or cancel them.

Authorizations:
Token
query Parameters
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.

Responses

Response samples

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

api_v1_subscriptions_total_mrr

Returns current and future MRRs.

Authorizations:
Token
query Parameters
account
string

Filter using account code (External ID)

plan
string

Filter using Plan UUID

terms
string

Filter using Plan Terms UUID

status
string
collection_method
string
account_active_payment_method
string
set_to_expire
string
has_recipient_receiving_invoices
string
has_custom_price
string
start_date__lte
string

Format: YYYY-MM-DD

start_date__org_tz_lte
string

Format: YYYY-MM-DD

start_date__gte
string

Format: YYYY-MM-DD

start_date__org_tz_gte
string

Format: YYYY-MM-DD

next_renewal_date__lte
string

Format: YYYY-MM-DD

next_renewal_date__org_tz_lte
string

Format: YYYY-MM-DD

next_renewal_date__gte
string

Format: YYYY-MM-DD

next_renewal_date__org_tz_gte
string

Format: YYYY-MM-DD

end_date__lte
string

Format: YYYY-MM-DD

end_date__org_tz_lte
string

Format: YYYY-MM-DD

end_date__gte
string

Format: YYYY-MM-DD

end_date__org_tz_gte
string

Format: YYYY-MM-DD

last_modified_date__lte
string

Format: YYYY-MM-DD

last_modified_date__org_tz_lte
string

Format: YYYY-MM-DD

last_modified_date__gte
string

Format: YYYY-MM-DD

last_modified_date__org_tz_gte
string

Format: YYYY-MM-DD

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.

Responses

Response samples

Content type
application/json
{
  • "total_mrr": "string",
  • "future_mrr": "string",
  • "subscriptions_count": 0,
  • "model": "string",
  • "schema": "string"
}

api_v1_subscriptions_deprecated_total_mrr Deprecated

Subscriptions are instances of plan terms on a specific account. You can modify subscriptions or cancel them.

Authorizations:
Token
query Parameters
account
string

Filter using account code (External ID)

plan
string

Filter using Plan UUID

terms
string

Filter using Plan Terms UUID

status
string
collection_method
string
account_active_payment_method
string
set_to_expire
string
has_recipient_receiving_invoices
string
has_custom_price
string
start_date__lte
string

Format: YYYY-MM-DD

start_date__org_tz_lte
string

Format: YYYY-MM-DD

start_date__gte
string

Format: YYYY-MM-DD

start_date__org_tz_gte
string

Format: YYYY-MM-DD

next_renewal_date__lte
string

Format: YYYY-MM-DD

next_renewal_date__org_tz_lte
string

Format: YYYY-MM-DD

next_renewal_date__gte
string

Format: YYYY-MM-DD

next_renewal_date__org_tz_gte
string

Format: YYYY-MM-DD

end_date__lte
string

Format: YYYY-MM-DD

end_date__org_tz_lte
string

Format: YYYY-MM-DD

end_date__gte
string

Format: YYYY-MM-DD

end_date__org_tz_gte
string

Format: YYYY-MM-DD

last_modified_date__lte
string

Format: YYYY-MM-DD

last_modified_date__org_tz_lte
string

Format: YYYY-MM-DD

last_modified_date__gte
string

Format: YYYY-MM-DD

last_modified_date__org_tz_gte
string

Format: YYYY-MM-DD

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.

Responses

Response samples

Content type
application/json
{
  • "total_mrr": "string",
  • "future_mrr": "string",
  • "subscriptions_count": 0,
  • "model": "string",
  • "schema": "string"
}

api_v1_subscriptions_read

Subscriptions are instances of plan terms on a specific account. You can modify subscriptions or cancel them.

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this Subscription.

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "account_uuid": "847548f7-9cde-4fe5-8751-32ff19825b7e",
  • "account_code": "6097a4f5-935a-4a3b-87a0-f379ae15fc06",
  • "account": {
    },
  • "terms": {
    },
  • "plan": {
    },
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "created_date": "2019-08-24T14:15:22Z",
  • "last_modified_date": "2019-08-24T14:15:22Z",
  • "next_renewal_date": "2019-08-24T14:15:22Z",
  • "last_renewal_date": "2019-08-24T14:15:22Z",
  • "base_renewal_date": "2019-08-24T14:15:22Z",
  • "original_start_date": "2019-08-24T14:15:22Z",
  • "quantity": 2147483647,
  • "collection_method": "payment_card",
  • "group_on_invoice": true,
  • "payment_terms": -2147483648,
  • "effective_payment_terms": "string",
  • "pre_renewal_days_offset": 32767,
  • "po_number": "string",
  • "invoice_supplement": "string",
  • "override_price": "string",
  • "reference_person": "string",
  • "account_reference_person": "string",
  • "case_number": "string",
  • "status": "active",
  • "current_mrr": "string",
  • "committed_mrr": "string",
  • "final_price": "string",
  • "churn_reason": {
    },
  • "custom_churn_reason": "string",
  • "custom_fields": { },
  • "model": "string",
  • "schema": "string"
}

api_v1_subscriptions_update

Please consult documentation for details about updating a subscription.

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this Subscription.

Request Body schema: application/json
required
terms
string <uuid> (Terms)
prorate
boolean (Prorate)
Default: true

DEPRECATED: use change_type instead

change_type
string (Change type)
Enum: "immediate" "at_specified_time" "at_renewal"
prorate_date
string <date-time> (Prorate date)

Exact date at which scheduled prorate will happen. Provide this only if you have chosen 'at_specified_time' in the change_type field.

change_renewal
string (Change renewal)
Enum: 0 1 2 3 4 5 6 7 8 9 10 11

0 means next renewal, 1 means second renewal etc. Provide this only if you have chosen 'at_renewal' in the change_type field.

early_renewal
boolean (Early renewal)
Default: false

Provide this only if you have chosen 'immediate' or 'at_specified_time' in the change_type field.Selecting that option will cause renewing that subscription and create a refund for remaining period.This will happen right now (immediate option) or at a specified time (at_specified_time option)

custom_fields
object (SubscriptionCustomFields)
start_date
string or null <date-time> (Start date)

Can't be changed after subscription already started or renewed.

custom_churn_reason
string or null (Custom churn reason) <= 100 characters
quantity
integer (Quantity) [ 0 .. 2147483647 ]
Default: 1

Number of subscribed users

collection_method
string (Collection method)
Enum: "payment_card" "invoice" "direct_debit"
group_on_invoice
boolean (Group on invoice)

Subscription renewing on the same date, with same currency, payment terms, collection method and PO number will be charged on the single invoice.

payment_terms
integer or null (Payment terms) [ 0 .. 2147483647 ]
Default: 0

Days until payment, 0 means on receipt. If left empty default value will be used. Default value is taken from account setting (Default payment terms). If account setting is empty it will default to the organization setting.

override_price
string or null <decimal> (Override price)

Specify the price and override the one form the Plan Term. If any discounts are applicable to this Subscription, they will be applied to this price.

pre_renewal_days_offset
integer (Pre-renewal invoicing) [ 0 .. 32767 ]
Default: 0

Number of days before the renewal date a new invoice should be generated. It can be set only for forward-charging plans.

reference_person
string (Reference person) <= 128 characters
account_reference_person
string (Your reference) <= 128 characters
po_number
string (PO number) <= 128 characters
case_number
string (Case number) <= 128 characters
invoice_supplement
string or null (Invoice supplement)

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

churn_reason
string or null <uuid> (Churn reason)

You can define available churn reasons in Objects Settings

Responses

Request samples

Content type
application/json
{
  • "terms": "631338da-a0b5-4ef0-90ce-ca16c76d475c",
  • "prorate": true,
  • "change_type": "immediate",
  • "prorate_date": "2019-08-24T14:15:22Z",
  • "change_renewal": 0,
  • "early_renewal": false,
  • "custom_fields": { },
  • "start_date": "2019-08-24T14:15:22Z",
  • "custom_churn_reason": "string",
  • "quantity": 1,
  • "collection_method": "payment_card",
  • "group_on_invoice": true,
  • "payment_terms": 0,
  • "override_price": "string",
  • "pre_renewal_days_offset": 0,
  • "reference_person": "string",
  • "account_reference_person": "string",
  • "po_number": "string",
  • "case_number": "string",
  • "invoice_supplement": "string",
  • "churn_reason": "b06e9988-1cd3-4228-a984-64110b49a9ec"
}

Response samples

Content type
application/json
{
  • "terms": "631338da-a0b5-4ef0-90ce-ca16c76d475c",
  • "prorate": true,
  • "change_type": "immediate",
  • "prorate_date": "2019-08-24T14:15:22Z",
  • "change_renewal": 0,
  • "early_renewal": false,
  • "custom_fields": { },
  • "model": "string",
  • "schema": "string",
  • "start_date": "2019-08-24T14:15:22Z",
  • "custom_churn_reason": "string",
  • "quantity": 1,
  • "collection_method": "payment_card",
  • "group_on_invoice": true,
  • "payment_terms": 0,
  • "override_price": "string",
  • "pre_renewal_days_offset": 0,
  • "reference_person": "string",
  • "account_reference_person": "string",
  • "po_number": "string",
  • "case_number": "string",
  • "invoice_supplement": "string",
  • "last_modified_date": "2019-08-24T14:15:22Z",
  • "churn_reason": "b06e9988-1cd3-4228-a984-64110b49a9ec"
}

api_v1_subscriptions_partial_update

Subscriptions are instances of plan terms on a specific account. You can modify subscriptions or cancel them.

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this Subscription.

Request Body schema: application/json
required
terms
string <uuid> (Terms)
prorate
boolean (Prorate)
Default: true

DEPRECATED: use change_type instead

change_type
string (Change type)
Enum: "immediate" "at_specified_time" "at_renewal"
prorate_date
string <date-time> (Prorate date)

Exact date at which scheduled prorate will happen. Provide this only if you have chosen 'at_specified_time' in the change_type field.

change_renewal
string (Change renewal)
Enum: 0 1 2 3 4 5 6 7 8 9 10 11

0 means next renewal, 1 means second renewal etc. Provide this only if you have chosen 'at_renewal' in the change_type field.

early_renewal
boolean (Early renewal)
Default: false

Provide this only if you have chosen 'immediate' or 'at_specified_time' in the change_type field.Selecting that option will cause renewing that subscription and create a refund for remaining period.This will happen right now (immediate option) or at a specified time (at_specified_time option)

custom_fields
object (SubscriptionCustomFields)
start_date
string or null <date-time> (Start date)

Can't be changed after subscription already started or renewed.

custom_churn_reason
string or null (Custom churn reason) <= 100 characters
quantity
integer (Quantity) [ 0 .. 2147483647 ]
Default: 1

Number of subscribed users

collection_method
string (Collection method)
Enum: "payment_card" "invoice" "direct_debit"
group_on_invoice
boolean (Group on invoice)

Subscription renewing on the same date, with same currency, payment terms, collection method and PO number will be charged on the single invoice.

payment_terms
integer or null (Payment terms) [ 0 .. 2147483647 ]
Default: 0

Days until payment, 0 means on receipt. If left empty default value will be used. Default value is taken from account setting (Default payment terms). If account setting is empty it will default to the organization setting.

override_price
string or null <decimal> (Override price)

Specify the price and override the one form the Plan Term. If any discounts are applicable to this Subscription, they will be applied to this price.

pre_renewal_days_offset
integer (Pre-renewal invoicing) [ 0 .. 32767 ]
Default: 0

Number of days before the renewal date a new invoice should be generated. It can be set only for forward-charging plans.

reference_person
string (Reference person) <= 128 characters
account_reference_person
string (Your reference) <= 128 characters
po_number
string (PO number) <= 128 characters
case_number
string (Case number) <= 128 characters
invoice_supplement
string or null (Invoice supplement)

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

churn_reason
string or null <uuid> (Churn reason)

You can define available churn reasons in Objects Settings

Responses

Request samples

Content type
application/json
{
  • "terms": "631338da-a0b5-4ef0-90ce-ca16c76d475c",
  • "prorate": true,
  • "change_type": "immediate",
  • "prorate_date": "2019-08-24T14:15:22Z",
  • "change_renewal": 0,
  • "early_renewal": false,
  • "custom_fields": { },
  • "start_date": "2019-08-24T14:15:22Z",
  • "custom_churn_reason": "string",
  • "quantity": 1,
  • "collection_method": "payment_card",
  • "group_on_invoice": true,
  • "payment_terms": 0,
  • "override_price": "string",
  • "pre_renewal_days_offset": 0,
  • "reference_person": "string",
  • "account_reference_person": "string",
  • "po_number": "string",
  • "case_number": "string",
  • "invoice_supplement": "string",
  • "churn_reason": "b06e9988-1cd3-4228-a984-64110b49a9ec"
}

Response samples

Content type
application/json
{
  • "terms": "631338da-a0b5-4ef0-90ce-ca16c76d475c",
  • "prorate": true,
  • "change_type": "immediate",
  • "prorate_date": "2019-08-24T14:15:22Z",
  • "change_renewal": 0,
  • "early_renewal": false,
  • "custom_fields": { },
  • "model": "string",
  • "schema": "string",
  • "start_date": "2019-08-24T14:15:22Z",
  • "custom_churn_reason": "string",
  • "quantity": 1,
  • "collection_method": "payment_card",
  • "group_on_invoice": true,
  • "payment_terms": 0,
  • "override_price": "string",
  • "pre_renewal_days_offset": 0,
  • "reference_person": "string",
  • "account_reference_person": "string",
  • "po_number": "string",
  • "case_number": "string",
  • "invoice_supplement": "string",
  • "last_modified_date": "2019-08-24T14:15:22Z",
  • "churn_reason": "b06e9988-1cd3-4228-a984-64110b49a9ec"
}

api_v1_subscriptions_cancel

Please consult [charging types documentation] (https://www.fenerum.com/docs/billing/subscriptions/charging-options/#cancelling-subscriptions) to see the possible results of cancelling a subscriptions

Subscription can't be canceled if:

  1. It has a status of expired or not_renewing
  2. There is an active contract (i.e. before the expiration of commitment length) on subscription's plan terms
Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this Subscription.

Request Body schema: application/json
required
cancellation_type
required
string (Cancellation type)
Enum: "full_refund" "at_renewal" "today" "at_specified_time" "cancel_invalid"
cancel_renewal
integer (Cancel renewal)
Enum: 0 1 2 3 4 5 6 7 8 9 10 11

0 means next renewal, 1 means second renewal etc. Provide this only if you have chosen 'at_renewal' in the cancellation_type field.

cancel_date
string <date-time> (Cancel date)

Responses

Request samples

Content type
application/json
{
  • "cancellation_type": "full_refund",
  • "cancel_renewal": 0,
  • "cancel_date": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "account_uuid": "847548f7-9cde-4fe5-8751-32ff19825b7e",
  • "account_code": "6097a4f5-935a-4a3b-87a0-f379ae15fc06",
  • "account": {
    },
  • "terms": {
    },
  • "plan": {
    },
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "created_date": "2019-08-24T14:15:22Z",
  • "last_modified_date": "2019-08-24T14:15:22Z",
  • "next_renewal_date": "2019-08-24T14:15:22Z",
  • "last_renewal_date": "2019-08-24T14:15:22Z",
  • "base_renewal_date": "2019-08-24T14:15:22Z",
  • "original_start_date": "2019-08-24T14:15:22Z",
  • "quantity": 2147483647,
  • "collection_method": "payment_card",
  • "group_on_invoice": true,
  • "payment_terms": -2147483648,
  • "effective_payment_terms": "string",
  • "pre_renewal_days_offset": 32767,
  • "po_number": "string",
  • "invoice_supplement": "string",
  • "override_price": "string",
  • "reference_person": "string",
  • "account_reference_person": "string",
  • "case_number": "string",
  • "status": "active",
  • "current_mrr": "string",
  • "committed_mrr": "string",
  • "final_price": "string",
  • "churn_reason": {
    },
  • "custom_churn_reason": "string",
  • "custom_fields": { },
  • "model": "string",
  • "schema": "string"
}

api_v1_subscriptions_reactivate

A subscription can be reactivated when its status is either not_renewing or not_starting. The corresponding activity of the type cancel will then be deleted.

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this Subscription.

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "account_uuid": "847548f7-9cde-4fe5-8751-32ff19825b7e",
  • "account_code": "6097a4f5-935a-4a3b-87a0-f379ae15fc06",
  • "account": {
    },
  • "terms": {
    },
  • "plan": {
    },
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "created_date": "2019-08-24T14:15:22Z",
  • "last_modified_date": "2019-08-24T14:15:22Z",
  • "next_renewal_date": "2019-08-24T14:15:22Z",
  • "last_renewal_date": "2019-08-24T14:15:22Z",
  • "base_renewal_date": "2019-08-24T14:15:22Z",
  • "original_start_date": "2019-08-24T14:15:22Z",
  • "quantity": 2147483647,
  • "collection_method": "payment_card",
  • "group_on_invoice": true,
  • "payment_terms": -2147483648,
  • "effective_payment_terms": "string",
  • "pre_renewal_days_offset": 32767,
  • "po_number": "string",
  • "invoice_supplement": "string",
  • "override_price": "string",
  • "reference_person": "string",
  • "account_reference_person": "string",
  • "case_number": "string",
  • "status": "active",
  • "current_mrr": "string",
  • "committed_mrr": "string",
  • "final_price": "string",
  • "churn_reason": {
    },
  • "custom_churn_reason": "string",
  • "custom_fields": { },
  • "model": "string",
  • "schema": "string"
}

SubscriptionChange

api_v1_subscriptions_changes_list

Subscription Changes describe applied or scheduled changes of Subscription attributes that affect its price or MRR

Authorizations:
Token
path Parameters
subscription_uuid
required
string
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,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1_subscriptions_changes_read

Subscription Changes describe applied or scheduled changes of Subscription attributes that affect its price or MRR

Authorizations:
Token
path Parameters
subscription_uuid
required
string
uuid
required
string <uuid>

A UUID string identifying this Subscription Change.

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "planned_apply_date": "2019-08-24T14:15:22Z",
  • "change_type": "immediate",
  • "state": "scheduled",
  • "applied_at": "2019-08-24T14:15:22Z",
  • "terms": {
    },
  • "plan": {
    },
  • "quantity": -2147483648,
  • "override_price": "string",
  • "early_renewal": true,
  • "model": "string",
  • "schema": "string"
}

api_v1_subscriptions_changes_cancel

Cancel a scheduled Subscription Change

Authorizations:
Token
path Parameters
subscription_uuid
required
string
uuid
required
string <uuid>

A UUID string identifying this Subscription Change.

Request Body schema: application/json
required
object (SubscriptionChangeCancel)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "planned_apply_date": "2019-08-24T14:15:22Z",
  • "change_type": "immediate",
  • "state": "scheduled",
  • "applied_at": "2019-08-24T14:15:22Z",
  • "terms": {
    },
  • "plan": {
    },
  • "quantity": -2147483648,
  • "override_price": "string",
  • "early_renewal": true,
  • "model": "string",
  • "schema": "string"
}

SupplierInvoice

api_v1_supplier-invoices_list

Authorizations:
Token
query Parameters
currency
string
approved
string
status
string
pending_match
string
verified
string
document_date__lte
string

Format: YYYY-MM-DD

document_date__gte
string

Format: YYYY-MM-DD

created_date__lte
string

Format: YYYY-MM-DD

created_date__org_tz_lte
string

Format: YYYY-MM-DD

created_date__gte
string

Format: YYYY-MM-DD

created_date__org_tz_gte
string

Format: YYYY-MM-DD

pending_approval
string
pending_payment
string
payment_scheduled
string
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.

Responses

Response samples

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

api_v1_supplier-invoices_read

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "id": 0,
  • "status": "unmatched",
  • "document_date": "2019-08-24",
  • "amount": "string",
  • "currency": "DKK",
  • "supplier": {
    },
  • "supplier_receipt_number": "string",
  • "cost_account": "string",
  • "note": "string",
  • "file_url": "string",
  • "verified_by": "8c493be0-efe2-4a3e-bdbd-7af0eab50aa2",
  • "verified_by_for_display": "string",
  • "verified_on": "2019-08-24T14:15:22Z",
  • "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
  • "created_by_for_display": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "matched_expenses_amount": "string",
  • "matched_expenses_remaining_amount": "string",
  • "expense_set": [
    ],
  • "costs": [
    ],
  • "senders_email": "user@example.com",
  • "original_filename": "string",
  • "model": "string",
  • "schema": "string",
  • "document_type_label": "string",
  • "due_date": "2019-08-24",
  • "payment_identifier": "IBAN",
  • "payment_account": "string",
  • "payment_scheduled": true,
  • "approved": true,
  • "approved_by": "02030314-b162-4b4d-8af1-88eabdcc615d",
  • "approved_on": "2019-08-24T14:15:22Z",
  • "approved_by_for_display": "string"
}

Transaction

api_v1_transactions_list

Authorizations:
Token
query Parameters
method
string
type
string
currency
string
import_source
string
invoice
string
account
string

Filter using account code (External ID)

account_uuid
string

Filter using account UUID

is_loss
string
is_settlement
string
date__lte
string

Format: YYYY-MM-DD

date__gte
string

Format: YYYY-MM-DD

created_date__lte
string

Format: YYYY-MM-DD

created_date__org_tz_lte
string

Format: YYYY-MM-DD

created_date__gte
string

Format: YYYY-MM-DD

created_date__org_tz_gte
string

Format: YYYY-MM-DD

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.

Responses

Response samples

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

api_v1_transactions_create

Authorizations:
Token
Request Body schema: application/json
required
object (MinimalAccount)
invoice
required
string <uuid> (Invoice)
date
required
string <date> (Date)
amount
required
string <decimal> (Amount)
notes
required
string (Notes) non-empty
bank_account
required
integer (Bank account)

Responses

Request samples

Content type
application/json
{
  • "account": {
    },
  • "invoice": "f5072b7b-65cb-48aa-bf69-c999195da70c",
  • "date": "2019-08-24",
  • "amount": "string",
  • "notes": "string",
  • "bank_account": 0
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "account": {
    },
  • "invoice": "f5072b7b-65cb-48aa-bf69-c999195da70c",
  • "type": "payment",
  • "method": "payment_card",
  • "date": "2019-08-24",
  • "amount": "string",
  • "notes": "string",
  • "currency": "DKK",
  • "amount_in_default_currency": "string",
  • "bank_account": 0,
  • "bank_account_line": 0,
  • "bank_account_amount": "string",
  • "bank_account_currency": "DKK",
  • "external_transaction_id": "string",
  • "import_source": "manual",
  • "created_date": "2019-08-24T14:15:22Z",
  • "reverse_of": "166ec9b4-871b-4ade-94d3-5f95b4671052",
  • "model": "string",
  • "schema": "string"
}

api_v1_transactions_export

Authorizations:
Token
Request Body schema: application/json
required
object (MinimalAccount)
invoice
required
string <uuid> (Invoice)
date
required
string <date> (Date)
amount
required
string <decimal> (Amount)
notes
required
string (Notes) non-empty
bank_account
required
integer (Bank account)

Responses

Request samples

Content type
application/json
{
  • "account": {
    },
  • "invoice": "f5072b7b-65cb-48aa-bf69-c999195da70c",
  • "date": "2019-08-24",
  • "amount": "string",
  • "notes": "string",
  • "bank_account": 0
}

Response samples

Content type
application/json
{
  • "export_id": "string",
  • "job_uuid": "de25c4df-6d4e-439f-9d5f-a4c55d30f26e"
}

api_v1_transactions_read

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this Transaction.

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "account": {
    },
  • "invoice": "f5072b7b-65cb-48aa-bf69-c999195da70c",
  • "type": "payment",
  • "method": "payment_card",
  • "date": "2019-08-24",
  • "amount": "string",
  • "notes": "string",
  • "currency": "DKK",
  • "amount_in_default_currency": "string",
  • "bank_account": 0,
  • "bank_account_line": 0,
  • "bank_account_amount": "string",
  • "bank_account_currency": "DKK",
  • "external_transaction_id": "string",
  • "import_source": "manual",
  • "created_date": "2019-08-24T14:15:22Z",
  • "reverse_of": "166ec9b4-871b-4ade-94d3-5f95b4671052",
  • "model": "string",
  • "schema": "string"
}

WebhookEventMetadata

api_v1_webhook-events-metadata_list

A webhook event metadata entry represents a webhook-event that was created after a webhook was triggered.

Authorizations:
Token
query Parameters
uuid
string
event
string
success
string
retry_enabled
string
webhook_uuid
string

Filter using the UUID of the related webhook

created_date__lte
string

Format: YYYY-MM-DD

created_date__org_tz_lte
string

Format: YYYY-MM-DD

created_date__gte
string

Format: YYYY-MM-DD

created_date__org_tz_gte
string

Format: YYYY-MM-DD

last_modified_date__lte
string

Format: YYYY-MM-DD

last_modified_date__org_tz_lte
string

Format: YYYY-MM-DD

last_modified_date__gte
string

Format: YYYY-MM-DD

last_modified_date__org_tz_gte
string

Format: YYYY-MM-DD

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.

Responses

Response samples

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

api_v1_webhook-events-metadata_read

A webhook event metadata entry represents a webhook-event that was created after a webhook was triggered.

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this webhook event metadata.

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "webhook": "34cff408-bf77-4bc5-b31b-e3f4b806d7e8",
  • "endpoint": "string",
  • "event": "string",
  • "success": true,
  • "retry_enabled": true,
  • "created_date": "2019-08-24T14:15:22Z",
  • "last_modified_date": "2019-08-24T14:15:22Z",
  • "model": "string",
  • "schema": "string"
}

Webhook

api_v1_webhooks_list

A webhook is a custom callback that can be leveraged to be notified of events in Fenerum.

Authorizations:
Token
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,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1_webhooks_create

A webhook is a custom callback that can be leveraged to be notified of events in Fenerum.

Authorizations:
Token
Request Body schema: application/json
required
endpoint
required
string <uri> (Endpoint) non-empty
basic_auth_username
string or null (Basic auth username) <= 128 characters
basic_auth_password
string or null (Basic auth password) <= 128 characters
enabled
boolean (Enabled)
events
Array of strings (Events)
Items Enum: "account.updated" "account.created" "plan_terms.updated" "plan_terms.created" "new_invoice" "paid_invoice" "cancel_subscription" "reactivate_subscription" "renew_subscription_soon" "new_activity" "payment.authentication_required" "payment.declined" "card_expires_this_month" "payment_card.activated" "payment_card.deactivated"

Responses

Request samples

Content type
application/json
{
  • "endpoint": "http://example.com",
  • "basic_auth_username": "string",
  • "basic_auth_password": "string",
  • "enabled": true,
  • "events": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "endpoint": "http://example.com",
  • "basic_auth_username": "string",
  • "basic_auth_password": "string",
  • "enabled": true,
  • "events": [
    ],
  • "model": "string",
  • "schema": "string"
}

api_v1_webhooks_read

A webhook is a custom callback that can be leveraged to be notified of events in Fenerum.

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this webhook.

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "endpoint": "http://example.com",
  • "basic_auth_username": "string",
  • "basic_auth_password": "string",
  • "enabled": true,
  • "events": [
    ],
  • "model": "string",
  • "schema": "string"
}

api_v1_webhooks_update

A webhook is a custom callback that can be leveraged to be notified of events in Fenerum.

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this webhook.

Request Body schema: application/json
required
endpoint
required
string <uri> (Endpoint) non-empty
basic_auth_username
string or null (Basic auth username) <= 128 characters
basic_auth_password
string or null (Basic auth password) <= 128 characters
enabled
boolean (Enabled)
events
Array of strings (Events)
Items Enum: "account.updated" "account.created" "plan_terms.updated" "plan_terms.created" "new_invoice" "paid_invoice" "cancel_subscription" "reactivate_subscription" "renew_subscription_soon" "new_activity" "payment.authentication_required" "payment.declined" "card_expires_this_month" "payment_card.activated" "payment_card.deactivated"

Responses

Request samples

Content type
application/json
{
  • "endpoint": "http://example.com",
  • "basic_auth_username": "string",
  • "basic_auth_password": "string",
  • "enabled": true,
  • "events": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "endpoint": "http://example.com",
  • "basic_auth_username": "string",
  • "basic_auth_password": "string",
  • "enabled": true,
  • "events": [
    ],
  • "model": "string",
  • "schema": "string"
}

api_v1_webhooks_partial_update

A webhook is a custom callback that can be leveraged to be notified of events in Fenerum.

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this webhook.

Request Body schema: application/json
required
endpoint
required
string <uri> (Endpoint) non-empty
basic_auth_username
string or null (Basic auth username) <= 128 characters
basic_auth_password
string or null (Basic auth password) <= 128 characters
enabled
boolean (Enabled)
events
Array of strings (Events)
Items Enum: "account.updated" "account.created" "plan_terms.updated" "plan_terms.created" "new_invoice" "paid_invoice" "cancel_subscription" "reactivate_subscription" "renew_subscription_soon" "new_activity" "payment.authentication_required" "payment.declined" "card_expires_this_month" "payment_card.activated" "payment_card.deactivated"

Responses

Request samples

Content type
application/json
{
  • "endpoint": "http://example.com",
  • "basic_auth_username": "string",
  • "basic_auth_password": "string",
  • "enabled": true,
  • "events": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "endpoint": "http://example.com",
  • "basic_auth_username": "string",
  • "basic_auth_password": "string",
  • "enabled": true,
  • "events": [
    ],
  • "model": "string",
  • "schema": "string"
}

Webhook callbacks

account.created

Request Body schema: application/json
required
event
string (Event) non-empty
Default: "account.created"
object (Account)

Responses

Request samples

Content type
application/json
{
  • "event": "account.created",
  • "data": {
    }
}

account.updated

Request Body schema: application/json
required
event
string (Event) non-empty
Default: "account.updated"
object (Account)

Responses

Request samples

Content type
application/json
{
  • "event": "account.updated",
  • "data": {
    }
}

plan_terms.created

Request Body schema: application/json
required
event
string (Event) non-empty
Default: "plan_terms.created"
object (WebhookPlanTerms)

Responses

Request samples

Content type
application/json
{
  • "event": "plan_terms.created",
  • "data": {
    }
}

plan_terms.updated

Request Body schema: application/json
required
event
string (Event) non-empty
Default: "plan_terms.updated"
object (WebhookPlanTerms)

Responses

Request samples

Content type
application/json
{
  • "event": "plan_terms.updated",
  • "data": {
    }
}

new_invoice

Request Body schema: application/json
required
event
string (Event) non-empty
Default: "new_invoice"
object (WebhookInvoice)

Responses

Request samples

Content type
application/json
{
  • "event": "new_invoice",
  • "data": {
    }
}

paid_invoice

Request Body schema: application/json
required
event
string (Event) non-empty
Default: "paid_invoice"
object (WebhookInvoice)

Responses

Request samples

Content type
application/json
{
  • "event": "paid_invoice",
  • "data": {
    }
}

cancel_subscription

Request Body schema: application/json
required
event
string (Event) non-empty
Default: "cancel_subscription"
object (WebhookSubscription)

Responses

Request samples

Content type
application/json
{
  • "event": "cancel_subscription",
  • "data": {
    }
}

reactivate_subscription

Request Body schema: application/json
required
event
string (Event) non-empty
Default: "reactivate_subscription"
object (WebhookSubscription)

Responses

Request samples

Content type
application/json
{
  • "event": "reactivate_subscription",
  • "data": {
    }
}

renew_subscription_soon

Request Body schema: application/json
required
event
string (Event) non-empty
Default: "renew_subscription_soon"
object (WebhookSubscription)

Responses

Request samples

Content type
application/json
{
  • "event": "renew_subscription_soon",
  • "data": {
    }
}

new_activity

Request Body schema: application/json
required
event
string (Event) non-empty
Default: "new_activity"
object (Activity)

Responses

Request samples

Content type
application/json
{
  • "event": "new_activity",
  • "data": {
    }
}

payment.declined

Request Body schema: application/json
required
event
string (Event) non-empty
Default: "payment.declined"
object (WebhookCardPayment)

Responses

Request samples

Content type
application/json
{
  • "event": "payment.declined",
  • "data": {
    }
}

card_expires_this_month

Request Body schema: application/json
required
event
string (Event) non-empty
Default: "card_expires_this_month"
object (PaymentCard)

Responses

Request samples

Content type
application/json
{
  • "event": "card_expires_this_month",
  • "data": {
    }
}

payment_card.activated

Request Body schema: application/json
required
event
string (Event) non-empty
Default: "payment_card.activated"
object (PaymentCard)

Responses

Request samples

Content type
application/json
{
  • "event": "payment_card.activated",
  • "data": {
    }
}

payment_card.deactivated

Request Body schema: application/json
required
event
string (Event) non-empty
Default: "payment_card.deactivated"
object (PaymentCard)

Responses

Request samples

Content type
application/json
{
  • "event": "payment_card.deactivated",
  • "data": {
    }
}