test

accountbudgets_list

GET /account-budgets/

accountbudgets_read

GET /account-budgets/{id}/

GET /account-budgets/

Request parameters

page

integer optional

A page number within the paginated result set.

page_size

integer optional

Number of results to return per page.

Responses

200 200

Body

Object

count

integer required

results

Array of ERPAccountBudget required

GET /account-budgets/{id}/

Path variables

id

integer required

A unique integer value identifying this erp account budget.

Responses

200 200

Body

ERPAccountBudget

accounts_list

GET /accounts/

accounts_create

POST /accounts/

accounts_contracts_list

GET /accounts/{account_pk}/contracts/

accounts_contracts_create

POST /accounts/{account_pk}/contracts/

accounts_contracts_tiers_list

GET /accounts/{account_pk}/contracts/{contract_pk}/tiers/

accounts_contracts_tiers_create

POST /accounts/{account_pk}/contracts/{contract_pk}/tiers/

accounts_contracts_tiers_read

GET /accounts/{account_pk}/contracts/{contract_pk}/tiers/{id}/

accounts_contracts_tiers_update

PUT /accounts/{account_pk}/contracts/{contract_pk}/tiers/{id}/

accounts_contracts_tiers_partial_update

PATCH /accounts/{account_pk}/contracts/{contract_pk}/tiers/{id}/

accounts_contracts_tiers_delete

DELETE /accounts/{account_pk}/contracts/{contract_pk}/tiers/{id}/

accounts_contracts_read

GET /accounts/{account_pk}/contracts/{uuid}/

accounts_contracts_update

PUT /accounts/{account_pk}/contracts/{uuid}/

accounts_contracts_partial_update

PATCH /accounts/{account_pk}/contracts/{uuid}/

accounts_contracts_delete

DELETE /accounts/{account_pk}/contracts/{uuid}/

accounts_read

GET /accounts/{code}/

accounts_update

PUT /accounts/{code}/

accounts_partial_update

PATCH /accounts/{code}/

accounts_generate_invoice

POST /accounts/{code}/generate_invoice/

accounts_subscribe

POST /accounts/{code}/subscribe/

GET /accounts/

Request parameters

page

integer optional

A page number within the paginated result set.

Responses

200 200

Body

Object

count

integer required

results

Array of Account required

POST /accounts/

Request body

Account

Responses

201 201

Body

Account

GET /accounts/{account_pk}/contracts/

Path variables

account_pk

string required

Request parameters

page

integer optional

A page number within the paginated result set.

Responses

200 200

Body

Object

count

integer required

results

Array of Contract required

POST /accounts/{account_pk}/contracts/

Path variables

account_pk

string required

Request body

Contract

Responses

201 201

Body

Contract

GET /accounts/{account_pk}/contracts/{contract_pk}/tiers/

Path variables

account_pk

string required

contract_pk

string required

Request parameters

page

integer optional

A page number within the paginated result set.

Responses

200 200

Body

Object

count

integer required

results

Array of ContractTier required

POST /accounts/{account_pk}/contracts/{contract_pk}/tiers/

Path variables

account_pk

string required

contract_pk

string required

Request body

ContractTier

Responses

201 201

Body

ContractTier

GET /accounts/{account_pk}/contracts/{contract_pk}/tiers/{id}/

Path variables

account_pk

string required

contract_pk

string required

id

integer required

A unique integer value identifying this contract tier.

Responses

200 200

Body

ContractTier

PUT /accounts/{account_pk}/contracts/{contract_pk}/tiers/{id}/

Path variables

account_pk

string required

contract_pk

string required

id

integer required

A unique integer value identifying this contract tier.

Request body

ContractTier

Responses

200 200

Body

ContractTier

PATCH /accounts/{account_pk}/contracts/{contract_pk}/tiers/{id}/

Path variables

account_pk

string required

contract_pk

string required

id

integer required

A unique integer value identifying this contract tier.

Request body

ContractTier

Responses

200 200

Body

ContractTier

DELETE /accounts/{account_pk}/contracts/{contract_pk}/tiers/{id}/

Path variables

account_pk

string required

contract_pk

string required

id

integer required

A unique integer value identifying this contract tier.

Responses

204 204

GET /accounts/{account_pk}/contracts/{uuid}/

Path variables

account_pk

string required

uuid

string uuid required

A UUID string identifying this contract.

Responses

200 200

Body

Contract

PUT /accounts/{account_pk}/contracts/{uuid}/

Path variables

account_pk

string required

uuid

string uuid required

A UUID string identifying this contract.

Request body

Contract

Responses

200 200

Body

Contract

PATCH /accounts/{account_pk}/contracts/{uuid}/

Path variables

account_pk

string required

uuid

string uuid required

A UUID string identifying this contract.

Request body

Contract

Responses

200 200

Body

Contract

DELETE /accounts/{account_pk}/contracts/{uuid}/

Path variables

account_pk

string required

uuid

string uuid required

A UUID string identifying this contract.

Responses

204 204

GET /accounts/{code}/

Path variables

code

string required

Responses

200 200

Body

Account

PUT /accounts/{code}/

Path variables

code

string required

Request body

Account

Responses

200 200

Body

Account

PATCH /accounts/{code}/

Path variables

code

string required

Request body

Account

Responses

200 200

Body

Account

POST /accounts/{code}/generate_invoice/

Path variables

code

string required

Request body

GenerateInvoice

Responses

201 201

Body

GenerateInvoice

POST /accounts/{code}/subscribe/

Path variables

code

string required

Request body

AccountSubscribe

Responses

201 201

Body

AccountSubscribe

activities_list

GET /activities/

activities_read

GET /activities/{uuid}/

GET /activities/

Request parameters

page

integer optional

A page number within the paginated result set.

Responses

200 200

Body

Object

count

integer required

results

Array of Activity required

GET /activities/{uuid}/

Path variables

uuid

string uuid required

A UUID string identifying this activity.

Responses

200 200

Body

Activity

draftinvoicelines_list

GET /draftinvoicelines/

draftinvoicelines_create

POST /draftinvoicelines/

draftinvoicelines_read

GET /draftinvoicelines/{uuid}/

draftinvoicelines_update

PUT /draftinvoicelines/{uuid}/

draftinvoicelines_partial_update

PATCH /draftinvoicelines/{uuid}/

draftinvoicelines_delete

DELETE /draftinvoicelines/{uuid}/

GET /draftinvoicelines/

Request parameters

page

integer optional

A page number within the paginated result set.

Responses

200 200

Body

Object

count

integer required

results

Array of DraftInvoiceLine required

POST /draftinvoicelines/

Request body

DraftInvoiceLine

Responses

201 201

Body

DraftInvoiceLine

GET /draftinvoicelines/{uuid}/

Path variables

uuid

string uuid required

A UUID string identifying this draft invoice line.

Responses

200 200

Body

DraftInvoiceLine

PUT /draftinvoicelines/{uuid}/

Path variables

uuid

string uuid required

A UUID string identifying this draft invoice line.

Request body

DraftInvoiceLine

Responses

200 200

Body

DraftInvoiceLine

PATCH /draftinvoicelines/{uuid}/

Path variables

uuid

string uuid required

A UUID string identifying this draft invoice line.

Request body

DraftInvoiceLine

Responses

200 200

Body

DraftInvoiceLine

DELETE /draftinvoicelines/{uuid}/

Path variables

uuid

string uuid required

A UUID string identifying this draft invoice line.

Responses

204 204

hook_create

POST /hook/{organization_uuid}/{payment_gateway}/

Path variables

organization_uuid

string required

payment_gateway

string required

Responses

201 201

invoicelines_list

GET /invoicelines/

invoicelines_read

GET /invoicelines/{id}/

GET /invoicelines/

Request parameters

page

integer optional

A page number within the paginated result set.

Responses

200 200

Body

Object

count

integer required

results

Array of InvoiceLine required

GET /invoicelines/{id}/

Path variables

id

integer required

A unique integer value identifying this invoice line.

Responses

200 200

Body

InvoiceLine

invoices_list

GET /invoices/

invoices_read

GET /invoices/{uuid}/

GET /invoices/

Request parameters

page

integer optional

A page number within the paginated result set.

Responses

200 200

Body

Object

count

integer required

results

Array of ListInvoice required

GET /invoices/{uuid}/

Path variables

uuid

string uuid required

A UUID string identifying this invoice.

Responses

200 200

Body

Invoice

paymentcards_list

GET /paymentcards/

paymentcards_create

POST /paymentcards/

paymentcards_read

GET /paymentcards/{uuid}/

paymentcards_disable

POST /paymentcards/{uuid}/disable/

GET /paymentcards/

Request parameters

page

integer optional

A page number within the paginated result set.

Responses

200 200

Body

Object

count

integer required

results

Array of PaymentCard required

POST /paymentcards/

Request body

PaymentCardFromToken

Responses

201 201

Body

PaymentCardFromToken

GET /paymentcards/{uuid}/

Path variables

uuid

string uuid required

A UUID string identifying this payment card.

Responses

200 200

Body

PaymentCard

POST /paymentcards/{uuid}/disable/

Path variables

uuid

string uuid required

A UUID string identifying this payment card.

Request body

PaymentCard

Responses

201 201

Body

PaymentCard

plans_list

GET /plans/

plans_calculate

POST /plans/calculate/

plans_read

GET /plans/{uuid}/

GET /plans/

Request parameters

page

integer optional

A page number within the paginated result set.

Responses

200 200

Body

Object

count

integer required

results

Array of Plan required

POST /plans/calculate/

Request body

CalculatePlanTerms

Responses

201 201

Body

CalculatePlanTerms

GET /plans/{uuid}/

Path variables

uuid

string uuid required

A UUID string identifying this plan.

Responses

200 200

Body

Plan

recipients_list

GET /recipients/

recipients_create

POST /recipients/

recipients_read

GET /recipients/{uuid}/

recipients_update

PUT /recipients/{uuid}/

recipients_partial_update

PATCH /recipients/{uuid}/

recipients_delete

DELETE /recipients/{uuid}/

GET /recipients/

Request parameters

page

integer optional

A page number within the paginated result set.

Responses

200 200

Body

Object

count

integer required

results

Array of Recipient required

POST /recipients/

Request body

Recipient

Responses

201 201

Body

Recipient

GET /recipients/{uuid}/

Path variables

uuid

string uuid required

A UUID string identifying this recipient.

Responses

200 200

Body

Recipient

PUT /recipients/{uuid}/

Path variables

uuid

string uuid required

A UUID string identifying this recipient.

Request body

Recipient

Responses

200 200

Body

Recipient

PATCH /recipients/{uuid}/

Path variables

uuid

string uuid required

A UUID string identifying this recipient.

Request body

Recipient

Responses

200 200

Body

Recipient

DELETE /recipients/{uuid}/

Path variables

uuid

string uuid required

A UUID string identifying this recipient.

Responses

204 204

subscriptions_list

GET /subscriptions/

subscriptions_create

POST /subscriptions/

subscriptions_activity_months

GET /subscriptions/activity_months/

subscriptions_mrr_per_month

GET /subscriptions/mrr_per_month/

subscriptions_retention_cohort

GET /subscriptions/retention_cohort/

subscriptions_total_mrr

GET /subscriptions/total_mrr/

subscriptions_read

GET /subscriptions/{uuid}/

subscriptions_update

PUT /subscriptions/{uuid}/

subscriptions_partial_update

PATCH /subscriptions/{uuid}/

subscriptions_cancel

POST /subscriptions/{uuid}/cancel/

GET /subscriptions/

Request parameters

page

integer optional

A page number within the paginated result set.

Responses

200 200

Body

Object

count

integer required

results

Array of Subscription required

POST /subscriptions/

Request body

CreateSubscription

Responses

201 201

Body

CreateSubscription

GET /subscriptions/activity_months/

Request parameters

page

integer optional

A page number within the paginated result set.

Responses

200 200

Body

Object

count

integer required

results

Array of Subscription required

GET /subscriptions/mrr_per_month/

Request parameters

page

integer optional

A page number within the paginated result set.

Responses

200 200

Body

Object

count

integer required

results

Array of Subscription required

GET /subscriptions/retention_cohort/

Request parameters

page

integer optional

A page number within the paginated result set.

Responses

200 200

Body

Object

count

integer required

results

Array of Subscription required

GET /subscriptions/total_mrr/

Request parameters

page

integer optional

A page number within the paginated result set.

Responses

200 200

Body

Object

count

integer required

results

Array of Subscription required

GET /subscriptions/{uuid}/

Path variables

uuid

string uuid required

A UUID string identifying this subscription.

Responses

200 200

Body

Subscription

PUT /subscriptions/{uuid}/

Path variables

uuid

string uuid required

A UUID string identifying this subscription.

Request body

UpdateSubscription

Responses

200 200

Body

UpdateSubscription

PATCH /subscriptions/{uuid}/

Path variables

uuid

string uuid required

A UUID string identifying this subscription.

Request body

Subscription

Responses

200 200

Body

Subscription

POST /subscriptions/{uuid}/cancel/

Path variables

uuid

string uuid required

A UUID string identifying this subscription.

Request body

CancelSubscription

Responses

201 201

Body

CancelSubscription

webhooks_list

GET /webhooks/

webhooks_create

POST /webhooks/

webhooks_read

GET /webhooks/{uuid}/

webhooks_update

PUT /webhooks/{uuid}/

webhooks_partial_update

PATCH /webhooks/{uuid}/

GET /webhooks/

Request parameters

page

integer optional

A page number within the paginated result set.

Responses

200 200

Body

Object

count

integer required

results

Array of Webhook required

POST /webhooks/

Request body

Webhook

Responses

201 201

Body

Webhook

GET /webhooks/{uuid}/

Path variables

uuid

string uuid required

A UUID string identifying this webhook.

Responses

200 200

Body

Webhook

PUT /webhooks/{uuid}/

Path variables

uuid

string uuid required

A UUID string identifying this webhook.

Request body

Webhook

Responses

200 200

Body

Webhook

PATCH /webhooks/{uuid}/

Path variables

uuid

string uuid required

A UUID string identifying this webhook.

Request body

Webhook

Responses

200 200

Body

Webhook

Object

name

string required

Min length: 1

Max length: 128

account_number

integer required

Min: -2,147,483,648

Max: 2,147,483,647

model

string

schema

string

Object

erp_account

ERPAccount

start_date

string date required

end_date

string

start_amount

string decimal required

calculated_amount

string decimal

model

string

schema

string

Object

uuid

string uuid

active

boolean

brand

string required

Min length: 1

Max length: 128

card_number

string required

Min length: 1

Max length: 16

month

integer required

Min: -2,147,483,648

Max: 2,147,483,647

year

integer required

Min: -2,147,483,648

Max: 2,147,483,647

name

string

Max length: 128

payment_gateway

string required

Enumeration:

stripe

noop

payment_gateway_id

string required

Min length: 1

Max length: 128

account

string uuid required

model

string

schema

string

Object

uuid

string uuid

interval_type

string required

Enumeration:

day

month

year

interval_count

integer required

Min: -2,147,483,648

Max: 2,147,483,647

price

string decimal required

currency

string required

Enumeration:

DKK

EUR

USD

GBP

NZD

CHF

PLN

backwards_charging

boolean

active

boolean

revenue_group

string required

model

string

schema

string

Object

uuid

string uuid

name

string required

Min length: 1

Max length: 128

code

string

Max length: 128

collect_vat

boolean

vat_type

string required

Enumeration:

physical

services

unknown

model

string

schema

string

Object

uuid

string uuid

account

string uuid required

terms

PlanTerms

plan

EmbeddedPlan

start_date

string date-time

end_date

string date-time

next_renewal_date

string date-time

quantity

integer

Min: -2,147,483,648

Max: 2,147,483,647

payment_terms

integer

Days until payment, 0 means on receipt

Min: -2,147,483,648

Max: 2,147,483,647

collection_method

string required

Enumeration:

payment_card

invoice

status

string

group_on_invoice

boolean

model

string

schema

string

Object

uuid

string uuid

account

string uuid required

name

string required

Min length: 1

Max length: 128

email

string email required

Min length: 1

Max length: 254

receive_invoice

boolean required

receive_payment_confirmation

boolean required

receive_subscription_notifications

boolean required

model

string

schema

string

Object

uuid

string uuid

account

string required

description

string required

Min length: 1

Max length: 256

vat_type

string required

Enumeration:

physical

services

unknown

collect_vat

boolean

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

date_from

string date

date_to

string date

price

string decimal required

quantity

string decimal required

currency

string required

Enumeration:

DKK

EUR

USD

GBP

NZD

CHF

PLN

include_in_next_renewal_invoice

boolean

Include as a line in the next subscription renewal invoice.

revenue_group

string

model

string

schema

string

Object

uuid

string uuid

company_name

string required

Min length: 1

Max length: 128

code

string required

Min length: 1

Max length: 128

legal_address

string required

Min length: 1

legal_zipcode

string required

Min length: 1

Max length: 128

legal_city

string required

Min length: 1

Max length: 128

legal_country

string required

Enumeration:

AF

AL

DZ

AD

AO

AI

AQ

AG

SA

AR

AM

AW

AU

AT

AZ

BS

BH

BD

BB

BE

BZ

BJ

BM

BT

BY

BO

BQ

BA

BW

BR

BN

IO

VG

BG

BF

BI

CL

CN

HR

CW

CY

TD

ME

CZ

UM

DK

DM

DO

DJ

EG

EC

ER

EE

ET

FK

FJ

PH

FI

FR

TF

GA

GM

GS

GH

GI

GR

GD

GL

GE

GU

GG

GY

GF

GP

GT

GN

GW

GQ

HT

ES

NL

HN

HK

IN

ID

IQ

IR

IE

IS

IL

JM

JP

YE

JE

JO

KY

KH

CM

CA

QA

KZ

KE

KG

KI

CO

KM

CD

CG

KP

KR

CR

CU

KW

LA

LS

LB

LR

LY

LI

LT

LU

MK

MG

YT

MO

MW

MV

MY

ML

MT

MP

MA

MQ

MR

MU

MX

FM

MM

MD

MC

MN

MS

MZ

NA

NR

NP

DE

NE

NG

NI

NU

NF

NO

NC

NZ

OM

PK

PW

PS

PA

PG

PY

PE

PN

PF

PL

PR

PT

ZA

CF

CV

RE

RU

RO

RW

EH

KN

LC

VC

BL

MF

PM

SV

WS

AS

SM

SN

RS

SC

SL

SG

SX

SO

SK

SI

LK

US

SZ

SD

SS

SR

SJ

SY

CH

SE

TJ

TH

TW

TZ

TL

TG

TK

TO

TT

TN

TR

TM

TC

TV

UG

UA

UY

UZ

VU

WF

VA

HU

VE

GB

VN

IT

CI

BV

CX

IM

SH

AX

CK

VI

HM

CC

MH

FO

SB

ST

ZM

ZW

AE

LV

legal_vat_number

string

Max length: 128

paymentcard_set

Array of PaymentCard

subscription_set

Array of Subscription

recipient_set

Array of Recipient

draftinvoiceline_set

Array of DraftInvoiceLine

model

string

schema

string

Object

id

integer

minimum_quantity

integer required

Min: -2,147,483,648

Max: 2,147,483,647

maximum_quantity

integer

0 means unlimited

Min: -2,147,483,648

Max: 2,147,483,647

discount

string decimal

discount_type

string required

Enumeration:

percent

flat

overall_flat_discount

string decimal

only_apply_to_quantity_above_minimal

boolean

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)

model

string

schema

string

Object

uuid

string uuid

plan_terms

string uuid required

start_date

string date-time required

end_date

string date-time

commitment_length

integer required

Enumeration:

1

3

6

12

24

36

exclusive_tiers

boolean

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

contracttier_set

Array of ContractTier

model

string

schema

string

Object

collection_method

string required

Enumeration:

payment_card

invoice

payment_terms

integer required

model

string

schema

string

Object

terms

string uuid required

quantity

integer required

Min: 1

collection_method

string required

Enumeration:

payment_card

invoice

group_on_invoice

boolean

model

string

schema

string

Object

uuid

string uuid

account_code

string

subscription

string uuid

invoice

string uuid

date

string date-time required

created_date

string date-time

type

string required

Enumeration:

new

reactivate

renew

cancel

upgrade_qty

downgrade_qty

upgrade_subscription

downgraded_subscription

modified

old_mrr

string decimal

new_mrr

string decimal

old_quantity

integer

Min: -2,147,483,648

Max: 2,147,483,647

new_quantity

integer

Min: -2,147,483,648

Max: 2,147,483,647

old_terms

string uuid

new_terms

string uuid

mrr_change

string

quantity_change

string

old_terms_name

string

new_terms_name

string

old_plan_name

string

new_plan_name

string

company_name

string

model

string

schema

string

Object

id

integer

invoice

string uuid required

account

string

description

string required

Min length: 1

Max length: 256

vat_type

string required

Enumeration:

physical

services

unknown

collect_vat

boolean required

date_from

string date

date_to

string date

price

string decimal required

quantity

string decimal required

currency

string

imported_line

boolean

refund_of

integer

subscription

string uuid

terms

string uuid

sort_weight

integer

Min: -200

Max: 200

model

string

schema

string

Object

uuid

string uuid

invoice_number

integer

account_code

string

pay_to_bank_account

integer

date

string date

due_date

string date

currency

string

Enumeration:

DKK

EUR

USD

GBP

NZD

CHF

PLN

status

string

Enumeration:

open

due

paid

nonpayment

collection_method

string

Enumeration:

payment_card

invoice

total

string

subtotal

string

vat

string

model

string

schema

string

Object

uuid

string uuid

invoice_number

integer

account_code

string

pay_to_bank_account

integer

date

string date

due_date

string date

currency

string

Enumeration:

DKK

EUR

USD

GBP

NZD

CHF

PLN

status

string

Enumeration:

open

due

paid

nonpayment

collection_method

string

Enumeration:

payment_card

invoice

pdf_base64

string

total

string

subtotal

string

vat

string

model

string

schema

string

Object

account

string uuid required

gateway

string required

Enumeration:

stripe

noop

token

string required

Min length: 1

model

string

schema

string

Object

uuid

string uuid

name

string required

Min length: 1

Max length: 128

code

string

Max length: 128

collect_vat

boolean

vat_type

string required

Enumeration:

physical

services

unknown

planterms_set

Array of PlanTerms

model

string

schema

string

Object

account_code

string

Min length: 1

account_country_code

string required

Min length: 1

terms

string uuid required

quantity

integer required

model

string

schema

string

Object

account

string required

terms

string uuid required

start_date

string date-time

quantity

integer

Min: -2,147,483,648

Max: 2,147,483,647

collection_method

string required

Enumeration:

payment_card

invoice

group_on_invoice

boolean

payment_terms

integer

Days until payment, 0 means on receipt

Min: -2,147,483,648

Max: 2,147,483,647

model

string

schema

string

Object

terms

string uuid required

quantity

integer

Min: -2,147,483,648

Max: 2,147,483,647

collection_method

string required

Enumeration:

payment_card

invoice

group_on_invoice

boolean

payment_terms

integer

Days until payment, 0 means on receipt

Min: -2,147,483,648

Max: 2,147,483,647

prorate

boolean

model

string

schema

string

Object

cancellation_type

string required

Enumeration:

full_refund

at_renewal

today

model

string

schema

string

Object

uuid

string uuid

endpoint

string required

Min length: 1

Max length: 255

basic_auth_username

string

Max length: 128

basic_auth_password

string

Max length: 128

enabled

boolean

model

string

schema

string