Download OpenAPI specification:Download
Attachment request
file required | string Base64 encoded file, currently supported mime types:
|
file_name required | string File name |
target_model_type | string Type of resource |
target_model_id | integer ID of resource where want link this attachment. |
document_type | string Enum: "POWER-OF-ATTORNEY" "GUARDIANS-CONSENT" "TAX-CARD" "IDENTIFICATION" "PASSPORT" "RESIDENCE-PERMIT" "OTHER" Type of document. Currently used only when target_model_type is 'USER' |
{- "file": "iVBORw0KGgoAAAANSUhEUgAAAGQAAABkBAMAAACCzIhnAAAAG1BMVEUAAAD///+fn58/Pz8fHx+/v7/f399/f39fX1/PwBUlAAAACXBIWXMAAA7EAAAOxAGVKw4bAAABOUlEQVRYhe2SvU7DQBCEV/GPUvIIoSGtJYhpjaKkRiCilJHsEJcpSO8i5rnZvdmzskGGioodKc55Ps/d3t0SuVwul8vlcv2RloU80/tvQC1w1a28lPvNkSh5fztcAbXAVas7JklN6QuDglYzA9RSruseciZ5F34tG60BaimHyk7IJ4+mz9Md//UGqAWu5IOEzGXam4mU+0Sy37MCtcCHzQjZyqDJZOm8WleYUYBa4CZSy+A1FJ8V/D2nANQCN5EwwTaXD3neOVYNEVjgP0TWj7PfI6Ywvr5qiIwWZrZP6X4A49s3h0yTvotg/JBLkqtKdhSusk+bCNQCN5HQEEXoDu6mBi0wNEwd+WUkadGWnfQg158dYwSW8ssILdD8G+n0E9ddRwBLudUynGv6cO1HC9zlcrlcLtd/0hccA0mFpeebygAAAABJRU5ErkJggg==",
- "file_name": "sample-file.png",
- "target_model_type": "TAX_CARD | INVOICE | RECEIPT_EXPENSE | TRAVEL_EXPENSE (DEPRECATED) | TRIP | USER",
- "target_model_id": 0,
- "document_type": "POWER-OF-ATTORNEY | GUARDIANS-CONSENT | TAX-CARD | IDENTIFICATION | PASSPORT | RESIDENCE-PERMIT | OTHER"
}
{- "data": {
- "id": 0,
- "file_name": "string",
- "description": "string",
- "preview_url": "string",
- "download_url": "string",
- "target_model_type": "string",
- "target_model_id": 0,
- "document_type": "string",
- "mime_type": "string",
- "created_at": "2020-09-20T18:30:00+03:00",
- "can": [
- {
- "": {
- "allowed": "true",
- "reasons": [
- "terms_of_service_not_signed"
]
}
}
]
}
}
{- "data": {
- "id": 0,
- "file_name": "string",
- "description": "string",
- "preview_url": "string",
- "download_url": "string",
- "target_model_type": "string",
- "target_model_id": 0,
- "document_type": "string",
- "mime_type": "string",
- "created_at": "2020-09-20T18:30:00+03:00",
- "can": [
- {
- "": {
- "allowed": "true",
- "reasons": [
- "terms_of_service_not_signed"
]
}
}
]
}
}
target_model_type required | string Example: USER | INVOICE | RECEIPT_EXPENSE | TRAVEL_EXPENSE Type of attachment list: user | invoice | receipt-expense | travel-expense |
document_type required | string Example: POWER_OF_ATTORNEY |GUARDIANS_CONSENT | TAX_CARD |
* IDENTIFICATION | PASSPORT | RESIDENCE PERMIT | OTHER Optional parameter for document type list. Used currently for User related documents |
page | integer Pagination page id |
limit | integer Example: limit=50 Limit per page. Default 50, max 1000 |
sort | string Example: sort=document_type | created_at | mime_type Sort by ascending order, add '-' prefix to get
* descending order, ie. -total. To sort by
* client_name, use |
{- "data": [
- {
- "id": 0,
- "file_name": "string",
- "description": "string",
- "preview_url": "string",
- "download_url": "string",
- "target_model_type": "string",
- "target_model_id": 0,
- "document_type": "string",
- "mime_type": "string",
- "created_at": "2020-09-20T18:30:00+03:00",
- "can": [
- {
- "": {
- "allowed": "true",
- "reasons": [
- "terms_of_service_not_signed"
]
}
}
]
}
], - "links": {
}, - "meta": {
- "current_page": "1",
- "from": "1",
- "last_page": "12",
- "path": "string",
- "per_page": "100",
- "to": "10",
- "total": "116"
}
}
attachment_id required | integer Example: 123 Attachment Id |
{- "place_of_purchase": "string",
- "purchase_date": "2020-09-20",
- "rows": [
- {
- "total_vat_percent": "14.00",
- "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}
]
}
page | integer Pagination page id |
limit | integer Example: limit=50 Limit per page. Default 50, max 1000 |
sort | string Example: sort=company_name | type | contact_person | email |
* | street_address1 | street_address2 | zip_code
* | city | country | company_name, contact_person Sort by ascending order, add -company_name to
* get descending order. To sort by client_name, use
* |
filter[*field_name*] | string Example: filter[*field_name*]=filter[common_search] = 'foobar', other keys:
* type | company_name | contact_person | email | city
* | street_address1 | street_address2 | zip_code
* | city | country | client_name Search from fields. Array field, so * filter[common_search] = 'string. * Note common_search searches from multiple fields |
{- "data": [
- {
- "id": 0,
- "occupation": {
- "id": 0,
- "title_fi": "string",
- "title_en": "string",
- "description_fi": "string",
- "description_en": "string"
}, - "type": "COMPANY|PERSON",
- "business_id": "123456-7",
- "einvoice_address": "string",
- "einvoice_operator": "string",
- "company_name": "string",
- "contact_person": "string",
- "email": "string",
- "street_address1": "string",
- "zip_code": "string",
- "city": "string",
- "country": "FI",
- "phone": "string",
- "delivery_method": "EMAIL",
- "display_vat_rate": {
- "id": 0,
- "name_en": "string",
- "name_fi": "string",
- "parent_id": 0,
- "vat_rate": {
- "name": "string",
- "type": "string",
- "percentage": 0,
- "region": "string",
- "customer_type": "string"
}, - "region": "string",
- "customer_type": "string",
- "children": [
- { }
]
}, - "vat_rate": {
- "name": "string",
- "type": "string",
- "percentage": 0,
- "region": "string",
- "customer_type": "string"
}, - "notify_overdue_and_automatic_debt_collection": true,
- "language": "FI",
- "clients_reference": "string",
- "created_at": "2020-09-20T18:30:00+03:00",
- "updated_at": "2020-09-20T18:30:00+03:00"
}
], - "links": {
}, - "meta": {
- "current_page": "1",
- "from": "1",
- "last_page": "12",
- "path": "string",
- "per_page": "100",
- "to": "10",
- "total": "116"
}
}
{- "data": {
- "id": 0,
- "occupation": {
- "id": 0,
- "title_fi": "string",
- "title_en": "string",
- "description_fi": "string",
- "description_en": "string"
}, - "type": "COMPANY|PERSON",
- "business_id": "123456-7",
- "einvoice_address": "string",
- "einvoice_operator": "string",
- "company_name": "string",
- "contact_person": "string",
- "email": "string",
- "street_address1": "string",
- "zip_code": "string",
- "city": "string",
- "country": "FI",
- "phone": "string",
- "delivery_method": "EMAIL",
- "display_vat_rate": {
- "id": 0,
- "name_en": "string",
- "name_fi": "string",
- "parent_id": 0,
- "vat_rate": {
- "name": "string",
- "type": "string",
- "percentage": 0,
- "region": "string",
- "customer_type": "string"
}, - "region": "string",
- "customer_type": "string",
- "children": [
- { }
]
}, - "vat_rate": {
- "name": "string",
- "type": "string",
- "percentage": 0,
- "region": "string",
- "customer_type": "string"
}, - "notify_overdue_and_automatic_debt_collection": true,
- "language": "FI",
- "clients_reference": "string",
- "created_at": "2020-09-20T18:30:00+03:00",
- "updated_at": "2020-09-20T18:30:00+03:00"
}
}
CompanyRequest
occupation_id | integer |
business_id | string Business Id (Y-tunnus in Finnish) |
einvoice_address | string EINvoice/Finvoice address |
einvoice_operator | string EInvoice/Finvoice operator |
company_name | string Company name |
contact_person | string Contact Person |
string | |
street_address1 | string Street address of the client |
zip_code | string Zipcode of the client |
city | string City of the client |
country | string Client's country as ISO short code (FI, GB, RU etc) |
phone | string Phone number |
delivery_method | string Enum: "EINVOICE" "MAIL" "EMAIL" Default Invoice Delivery Option |
display_vat_rate_id | integer Id of the display vat rate. Required if vat_rate is not set |
vat_rate | string Default VAT rate for the Client's invoices. Related endpoint: /system/vat-rates/invoice |
notify_overdue_and_automatic_debt_collection | boolean Default value for Client's overdue and automatic debt collection setting |
language | string Short country code, ie. FI, SV, EN, EE, RU |
clients_reference | string Clients own invoicing reference |
{- "occupation_id": 0,
- "business_id": "1234567-8",
- "einvoice_address": "string",
- "einvoice_operator": "string",
- "company_name": "string",
- "contact_person": "string",
- "email": "string",
- "street_address1": "string",
- "zip_code": "string",
- "city": "string",
- "country": "FI",
- "phone": "+3581234567",
- "delivery_method": "EMAIL",
- "display_vat_rate_id": 0,
- "vat_rate": "VAT_REGULAR",
- "notify_overdue_and_automatic_debt_collection": true,
- "language": "FI",
- "clients_reference": "string"
}
{- "data": {
- "id": 0,
- "occupation": {
- "id": 0,
- "title_fi": "string",
- "title_en": "string",
- "description_fi": "string",
- "description_en": "string"
}, - "type": "COMPANY|PERSON",
- "business_id": "123456-7",
- "einvoice_address": "string",
- "einvoice_operator": "string",
- "company_name": "string",
- "contact_person": "string",
- "email": "string",
- "street_address1": "string",
- "zip_code": "string",
- "city": "string",
- "country": "FI",
- "phone": "string",
- "delivery_method": "EMAIL",
- "display_vat_rate": {
- "id": 0,
- "name_en": "string",
- "name_fi": "string",
- "parent_id": 0,
- "vat_rate": {
- "name": "string",
- "type": "string",
- "percentage": 0,
- "region": "string",
- "customer_type": "string"
}, - "region": "string",
- "customer_type": "string",
- "children": [
- { }
]
}, - "vat_rate": {
- "name": "string",
- "type": "string",
- "percentage": 0,
- "region": "string",
- "customer_type": "string"
}, - "notify_overdue_and_automatic_debt_collection": true,
- "language": "FI",
- "clients_reference": "string",
- "created_at": "2020-09-20T18:30:00+03:00",
- "updated_at": "2020-09-20T18:30:00+03:00"
}
}
client_id required | integer Client id |
CompanyRequest
occupation_id | integer |
business_id | string Business Id (Y-tunnus in Finnish) |
einvoice_address | string EINvoice/Finvoice address |
einvoice_operator | string EInvoice/Finvoice operator |
company_name | string Company name |
contact_person | string Contact Person |
string | |
street_address1 | string Street address of the client |
zip_code | string Zipcode of the client |
city | string City of the client |
country | string Client's country as ISO short code (FI, GB, RU etc) |
phone | string Phone number |
delivery_method | string Enum: "EINVOICE" "MAIL" "EMAIL" Default Invoice Delivery Option |
display_vat_rate_id | integer Id of the display vat rate. Required if vat_rate is not set |
vat_rate | string Default VAT rate for the Client's invoices. Related endpoint: /system/vat-rates/invoice |
notify_overdue_and_automatic_debt_collection | boolean Default value for Client's overdue and automatic debt collection setting |
language | string Short country code, ie. FI, SV, EN, EE, RU |
clients_reference | string Clients own invoicing reference |
{- "occupation_id": 0,
- "business_id": "1234567-8",
- "einvoice_address": "string",
- "einvoice_operator": "string",
- "company_name": "string",
- "contact_person": "string",
- "email": "string",
- "street_address1": "string",
- "zip_code": "string",
- "city": "string",
- "country": "FI",
- "phone": "+3581234567",
- "delivery_method": "EMAIL",
- "display_vat_rate_id": 0,
- "vat_rate": "VAT_REGULAR",
- "notify_overdue_and_automatic_debt_collection": true,
- "language": "FI",
- "clients_reference": "string"
}
{- "data": {
- "id": 0,
- "occupation": {
- "id": 0,
- "title_fi": "string",
- "title_en": "string",
- "description_fi": "string",
- "description_en": "string"
}, - "type": "COMPANY|PERSON",
- "business_id": "123456-7",
- "einvoice_address": "string",
- "einvoice_operator": "string",
- "company_name": "string",
- "contact_person": "string",
- "email": "string",
- "street_address1": "string",
- "zip_code": "string",
- "city": "string",
- "country": "FI",
- "phone": "string",
- "delivery_method": "EMAIL",
- "display_vat_rate": {
- "id": 0,
- "name_en": "string",
- "name_fi": "string",
- "parent_id": 0,
- "vat_rate": {
- "name": "string",
- "type": "string",
- "percentage": 0,
- "region": "string",
- "customer_type": "string"
}, - "region": "string",
- "customer_type": "string",
- "children": [
- { }
]
}, - "vat_rate": {
- "name": "string",
- "type": "string",
- "percentage": 0,
- "region": "string",
- "customer_type": "string"
}, - "notify_overdue_and_automatic_debt_collection": true,
- "language": "FI",
- "clients_reference": "string",
- "created_at": "2020-09-20T18:30:00+03:00",
- "updated_at": "2020-09-20T18:30:00+03:00"
}
}
PersonRequest
occupation_id | integer |
einvoice_address | string EINvoice/Finvoice address |
einvoice_operator | string EInvoice/Finvoice operator |
contact_person | string Contact Person |
string | |
street_address1 | string Street address of the client |
zip_code | string Zipcode of the client |
city | string City of the client |
country | string Client's country as ISO short code (FI, GB, RU etc) |
phone | string Phone number |
delivery_method | string Enum: "EINVOICE" "MAIL" "EMAIL" Default Invoice Delivery Option |
display_vat_rate_id | integer Id of the display vat rate. Required if vat_rate is not set |
vat_rate | string Default VAT rate for the Client's invoices. Related endpoint: /system/vat-rates/invoice |
notify_overdue_and_automatic_debt_collection | boolean Default value for Client's overdue and automatic debt collection setting |
language | string Short country code, ie. FI, SV, EN, EE, RU |
clients_reference | string Clients own invoicing reference |
{- "occupation_id": 0,
- "einvoice_address": "string",
- "einvoice_operator": "string",
- "contact_person": "string",
- "email": "string",
- "street_address1": "string",
- "zip_code": "string",
- "city": "string",
- "country": "FI",
- "phone": "+3581234567",
- "delivery_method": "EMAIL",
- "display_vat_rate_id": 0,
- "vat_rate": "VAT_REGULAR",
- "notify_overdue_and_automatic_debt_collection": true,
- "language": "FI",
- "clients_reference": "string"
}
{- "data": {
- "id": 0,
- "occupation": {
- "id": 0,
- "title_fi": "string",
- "title_en": "string",
- "description_fi": "string",
- "description_en": "string"
}, - "type": "COMPANY|PERSON",
- "business_id": "123456-7",
- "einvoice_address": "string",
- "einvoice_operator": "string",
- "company_name": "string",
- "contact_person": "string",
- "email": "string",
- "street_address1": "string",
- "zip_code": "string",
- "city": "string",
- "country": "FI",
- "phone": "string",
- "delivery_method": "EMAIL",
- "display_vat_rate": {
- "id": 0,
- "name_en": "string",
- "name_fi": "string",
- "parent_id": 0,
- "vat_rate": {
- "name": "string",
- "type": "string",
- "percentage": 0,
- "region": "string",
- "customer_type": "string"
}, - "region": "string",
- "customer_type": "string",
- "children": [
- { }
]
}, - "vat_rate": {
- "name": "string",
- "type": "string",
- "percentage": 0,
- "region": "string",
- "customer_type": "string"
}, - "notify_overdue_and_automatic_debt_collection": true,
- "language": "FI",
- "clients_reference": "string",
- "created_at": "2020-09-20T18:30:00+03:00",
- "updated_at": "2020-09-20T18:30:00+03:00"
}
}
client_id required | integer Client id |
PersonRequest
occupation_id | integer |
einvoice_address | string EINvoice/Finvoice address |
einvoice_operator | string EInvoice/Finvoice operator |
contact_person | string Contact Person |
string | |
street_address1 | string Street address of the client |
zip_code | string Zipcode of the client |
city | string City of the client |
country | string Client's country as ISO short code (FI, GB, RU etc) |
phone | string Phone number |
delivery_method | string Enum: "EINVOICE" "MAIL" "EMAIL" Default Invoice Delivery Option |
display_vat_rate_id | integer Id of the display vat rate. Required if vat_rate is not set |
vat_rate | string Default VAT rate for the Client's invoices. Related endpoint: /system/vat-rates/invoice |
notify_overdue_and_automatic_debt_collection | boolean Default value for Client's overdue and automatic debt collection setting |
language | string Short country code, ie. FI, SV, EN, EE, RU |
clients_reference | string Clients own invoicing reference |
{- "occupation_id": 0,
- "einvoice_address": "string",
- "einvoice_operator": "string",
- "contact_person": "string",
- "email": "string",
- "street_address1": "string",
- "zip_code": "string",
- "city": "string",
- "country": "FI",
- "phone": "+3581234567",
- "delivery_method": "EMAIL",
- "display_vat_rate_id": 0,
- "vat_rate": "VAT_REGULAR",
- "notify_overdue_and_automatic_debt_collection": true,
- "language": "FI",
- "clients_reference": "string"
}
{- "data": {
- "id": 0,
- "occupation": {
- "id": 0,
- "title_fi": "string",
- "title_en": "string",
- "description_fi": "string",
- "description_en": "string"
}, - "type": "COMPANY|PERSON",
- "business_id": "123456-7",
- "einvoice_address": "string",
- "einvoice_operator": "string",
- "company_name": "string",
- "contact_person": "string",
- "email": "string",
- "street_address1": "string",
- "zip_code": "string",
- "city": "string",
- "country": "FI",
- "phone": "string",
- "delivery_method": "EMAIL",
- "display_vat_rate": {
- "id": 0,
- "name_en": "string",
- "name_fi": "string",
- "parent_id": 0,
- "vat_rate": {
- "name": "string",
- "type": "string",
- "percentage": 0,
- "region": "string",
- "customer_type": "string"
}, - "region": "string",
- "customer_type": "string",
- "children": [
- { }
]
}, - "vat_rate": {
- "name": "string",
- "type": "string",
- "percentage": 0,
- "region": "string",
- "customer_type": "string"
}, - "notify_overdue_and_automatic_debt_collection": true,
- "language": "FI",
- "clients_reference": "string",
- "created_at": "2020-09-20T18:30:00+03:00",
- "updated_at": "2020-09-20T18:30:00+03:00"
}
}
attachment_id required | integer Example: 123 Attachment Id |
{- "place_of_purchase": "string",
- "purchase_date": "2020-09-20",
- "rows": [
- {
- "total_vat_percent": "14.00",
- "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}
]
}
attachment_id required | integer Example: 123 Attachment Id |
{- "place_of_purchase": "string",
- "purchase_date": "2020-09-20",
- "rows": [
- {
- "total_vat_percent": "14.00",
- "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}
]
}
invoice_id required | string |
sort | string Enum: "purchase_date" "place_of_purchase" "client_name" "total_sum" Example: sort=purchase_date | place_of_purchase | client_name | total_sum Sort by ascending order, add -place_of_purchase to get descending order |
limit | integer Example: limit=50 Limit per page. Default 50, max 1000 |
page | integer Pagination page id |
filter[*field_name*] | string Example: filter[*field_name*]=filter[place_of_purchase] = 'prisma', other keys: type | purchase_date_start | purchase_end_date | common_search Sort fields. Array field, so filter[email] = foobar@doobar.com
|
{- "data": [
- {
- "id": 0,
- "user_id": 0,
- "invoice_id": 0,
- "place_of_purchase": "string",
- "deduction_type": "MATERIAL",
- "additional_information": "string",
- "total_vat_percent": "14.00",
- "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum_without_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "purchase_date": "2020-09-20",
- "include_to_invoice_row": true,
- "rows": [
- {
- "id": 0,
- "description": "string",
- "vat_percent": {
- "name": "string",
- "type": "string",
- "percentage": 0,
- "region": "string",
- "customer_type": "string"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}
], - "attachments": [
- {
- "id": 0,
- "file_name": "string",
- "description": "string",
- "preview_url": "string",
- "download_url": "string",
- "target_model_type": "string",
- "target_model_id": 0,
- "document_type": "string",
- "mime_type": "string",
- "created_at": "2020-09-20T18:30:00+03:00",
- "can": [
- {
- "": {
- "allowed": "true",
- "reasons": [
- "terms_of_service_not_signed"
]
}
}
]
}
], - "is_editable": true,
- "is_deletable": true,
- "rejection_note": {
- "id": 0,
- "message": "string",
- "created_at": "2020-09-20",
- "updated_at": "2020-09-20"
}, - "invoice": {
- "id": 0,
- "invoice_number": 0,
- "company_name": "string",
- "contact_person": "string",
- "client_type": "COMPANY",
- "language": "FI",
- "status": "DRAFT",
- "created_at": "2020-09-20T18:30:00+03:00",
- "updated_at": "2020-09-20T18:30:00+03:00",
- "fast_payment": true
}, - "updated_at": "2020-09-20T18:30:00+03:00"
}
], - "links": {
}, - "meta": {
- "current_page": "1",
- "from": "1",
- "last_page": "12",
- "path": "string",
- "per_page": "100",
- "to": "10",
- "total": "116"
}
}
Receipt Expense
place_of_purchase | string Name of the place where the product/service was purchased from |
additional_information | string Additional information text field |
purchase_date | string <date> When product/service was purchased |
deduction_type | string Enum: "MATERIAL" "TRAVEL" Type of the deduction |
invoice_id | integer Id of receipt expense's invoice |
include_to_invoice_row | boolean Is the expense charged from client as part of the invoice |
Array of objects |
{- "place_of_purchase": "string",
- "additional_information": "string",
- "purchase_date": "2019-08-24",
- "deduction_type": "MATERIAL",
- "invoice_id": 0,
- "include_to_invoice_row": true,
- "rows": [
- {
- "vat_percent": "string",
- "description": "string",
- "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}
]
}
{- "data": {
- "id": 0,
- "user_id": 0,
- "invoice_id": 0,
- "place_of_purchase": "string",
- "deduction_type": "MATERIAL",
- "additional_information": "string",
- "total_vat_percent": "14.00",
- "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum_without_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "purchase_date": "2020-09-20",
- "include_to_invoice_row": true,
- "rows": [
- {
- "id": 0,
- "description": "string",
- "vat_percent": {
- "name": "string",
- "type": "string",
- "percentage": 0,
- "region": "string",
- "customer_type": "string"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}
], - "attachments": [
- {
- "id": 0,
- "file_name": "string",
- "description": "string",
- "preview_url": "string",
- "download_url": "string",
- "target_model_type": "string",
- "target_model_id": 0,
- "document_type": "string",
- "mime_type": "string",
- "created_at": "2020-09-20T18:30:00+03:00",
- "can": [
- {
- "": {
- "allowed": "true",
- "reasons": [
- "terms_of_service_not_signed"
]
}
}
]
}
], - "is_editable": true,
- "is_deletable": true,
- "rejection_note": {
- "id": 0,
- "message": "string",
- "created_at": "2020-09-20",
- "updated_at": "2020-09-20"
}, - "invoice": {
- "id": 0,
- "invoice_number": 0,
- "company_name": "string",
- "contact_person": "string",
- "client_type": "COMPANY",
- "language": "FI",
- "status": "DRAFT",
- "created_at": "2020-09-20T18:30:00+03:00",
- "updated_at": "2020-09-20T18:30:00+03:00",
- "fast_payment": true
}, - "updated_at": "2020-09-20T18:30:00+03:00"
}
}
{- "data": {
- "id": 0,
- "user_id": 0,
- "invoice_id": 0,
- "place_of_purchase": "string",
- "deduction_type": "MATERIAL",
- "additional_information": "string",
- "total_vat_percent": "14.00",
- "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum_without_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "purchase_date": "2020-09-20",
- "include_to_invoice_row": true,
- "rows": [
- {
- "id": 0,
- "description": "string",
- "vat_percent": {
- "name": "string",
- "type": "string",
- "percentage": 0,
- "region": "string",
- "customer_type": "string"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}
], - "attachments": [
- {
- "id": 0,
- "file_name": "string",
- "description": "string",
- "preview_url": "string",
- "download_url": "string",
- "target_model_type": "string",
- "target_model_id": 0,
- "document_type": "string",
- "mime_type": "string",
- "created_at": "2020-09-20T18:30:00+03:00",
- "can": [
- {
- "": {
- "allowed": "true",
- "reasons": [
- "terms_of_service_not_signed"
]
}
}
]
}
], - "is_editable": true,
- "is_deletable": true,
- "rejection_note": {
- "id": 0,
- "message": "string",
- "created_at": "2020-09-20",
- "updated_at": "2020-09-20"
}, - "invoice": {
- "id": 0,
- "invoice_number": 0,
- "company_name": "string",
- "contact_person": "string",
- "client_type": "COMPANY",
- "language": "FI",
- "status": "DRAFT",
- "created_at": "2020-09-20T18:30:00+03:00",
- "updated_at": "2020-09-20T18:30:00+03:00",
- "fast_payment": true
}, - "updated_at": "2020-09-20T18:30:00+03:00"
}
}
receipt_expense_id required | integer |
Receipt Expense
place_of_purchase | string Name of the place where the product/service was purchased from |
additional_information | string Additional information text field |
purchase_date | string <date> When product/service was purchased |
deduction_type | string Enum: "MATERIAL" "TRAVEL" Type of the deduction |
invoice_id | integer Id of receipt expense's invoice |
include_to_invoice_row | boolean Is the expense charged from client as part of the invoice |
Array of objects |
{- "place_of_purchase": "string",
- "additional_information": "string",
- "purchase_date": "2019-08-24",
- "deduction_type": "MATERIAL",
- "invoice_id": 0,
- "include_to_invoice_row": true,
- "rows": [
- {
- "vat_percent": "string",
- "description": "string",
- "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}
]
}
{- "data": {
- "id": 0,
- "user_id": 0,
- "invoice_id": 0,
- "place_of_purchase": "string",
- "deduction_type": "MATERIAL",
- "additional_information": "string",
- "total_vat_percent": "14.00",
- "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum_without_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "purchase_date": "2020-09-20",
- "include_to_invoice_row": true,
- "rows": [
- {
- "id": 0,
- "description": "string",
- "vat_percent": {
- "name": "string",
- "type": "string",
- "percentage": 0,
- "region": "string",
- "customer_type": "string"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}
], - "attachments": [
- {
- "id": 0,
- "file_name": "string",
- "description": "string",
- "preview_url": "string",
- "download_url": "string",
- "target_model_type": "string",
- "target_model_id": 0,
- "document_type": "string",
- "mime_type": "string",
- "created_at": "2020-09-20T18:30:00+03:00",
- "can": [
- {
- "": {
- "allowed": "true",
- "reasons": [
- "terms_of_service_not_signed"
]
}
}
]
}
], - "is_editable": true,
- "is_deletable": true,
- "rejection_note": {
- "id": 0,
- "message": "string",
- "created_at": "2020-09-20",
- "updated_at": "2020-09-20"
}, - "invoice": {
- "id": 0,
- "invoice_number": 0,
- "company_name": "string",
- "contact_person": "string",
- "client_type": "COMPANY",
- "language": "FI",
- "status": "DRAFT",
- "created_at": "2020-09-20T18:30:00+03:00",
- "updated_at": "2020-09-20T18:30:00+03:00",
- "fast_payment": true
}, - "updated_at": "2020-09-20T18:30:00+03:00"
}
}
{- "data": {
- "vat_amount_for_percentages": [
- {
- "amount": "2000",
- "currency": "EUR"
}
], - "vat_free_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum": {
- "amount": "2000",
- "currency": "EUR"
}
}
}
Receipt Expense
place_of_purchase | string Name of the place where the product/service was purchased from |
additional_information | string Additional information text field |
purchase_date | string <date> When product/service was purchased |
deduction_type | string Enum: "MATERIAL" "TRAVEL" Type of the deduction |
invoice_id | integer Id of receipt expense's invoice |
include_to_invoice_row | boolean Is the expense charged from client as part of the invoice |
Array of objects |
{- "place_of_purchase": "string",
- "additional_information": "string",
- "purchase_date": "2019-08-24",
- "deduction_type": "MATERIAL",
- "invoice_id": 0,
- "include_to_invoice_row": true,
- "rows": [
- {
- "vat_percent": "string",
- "description": "string",
- "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}
]
}
{- "data": {
- "row_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}
}
type required | string Example: empty/all | draft | in_review
* | rejected | discarded | approved
* | waiting_for_invoice_sending | user_action_required Type of Receipt Expense list: all | draft | in_review * | rejected | discarded | approved * | waiting_for_invoice_sending | user_action_required |
sort | string Enum: "purchase_date" "place_of_purchase" "client_name" "total_sum" Example: sort=purchase_date | place_of_purchase | client_name | total_sum Sort by ascending order, add -place_of_purchase to get descending order |
limit | integer Example: limit=50 Limit per page. Default 50, max 1000 |
page | integer Pagination page id |
filter[*field_name*] | string Example: filter[*field_name*]=filter[place_of_purchase] = 'prisma', other keys: type | purchase_date_start | purchase_end_date | common_search Sort fields. Array field, so filter[email] = foobar@doobar.com
|
{- "data": [
- {
- "id": 0,
- "user_id": 0,
- "invoice_id": 0,
- "place_of_purchase": "string",
- "deduction_type": "MATERIAL",
- "additional_information": "string",
- "total_vat_percent": "14.00",
- "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum_without_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "purchase_date": "2020-09-20",
- "include_to_invoice_row": true,
- "rows": [
- {
- "id": 0,
- "description": "string",
- "vat_percent": {
- "name": "string",
- "type": "string",
- "percentage": 0,
- "region": "string",
- "customer_type": "string"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}
], - "attachments": [
- {
- "id": 0,
- "file_name": "string",
- "description": "string",
- "preview_url": "string",
- "download_url": "string",
- "target_model_type": "string",
- "target_model_id": 0,
- "document_type": "string",
- "mime_type": "string",
- "created_at": "2020-09-20T18:30:00+03:00",
- "can": [
- {
- "": {
- "allowed": "true",
- "reasons": [
- "terms_of_service_not_signed"
]
}
}
]
}
], - "is_editable": true,
- "is_deletable": true,
- "rejection_note": {
- "id": 0,
- "message": "string",
- "created_at": "2020-09-20",
- "updated_at": "2020-09-20"
}, - "invoice": {
- "id": 0,
- "invoice_number": 0,
- "company_name": "string",
- "contact_person": "string",
- "client_type": "COMPANY",
- "language": "FI",
- "status": "DRAFT",
- "created_at": "2020-09-20T18:30:00+03:00",
- "updated_at": "2020-09-20T18:30:00+03:00",
- "fast_payment": true
}, - "updated_at": "2020-09-20T18:30:00+03:00"
}
], - "links": {
}, - "meta": {
- "current_page": "1",
- "from": "1",
- "last_page": "12",
- "path": "string",
- "per_page": "100",
- "to": "10",
- "total": "116"
}
}
ProofOfAssignmentRequest
start_date | string <date> |
end_date | string <date> |
options | Array of strings Items Enum: "NUMBER_OF_ASSIGNMENTS" "SUM_OF_ASSIGNMENTS" "WORK_HOURS" "PAID_GROSS_SALARY" "PAID_NET_SALARY" "UNPAID_GROSS_SALARY" |
{- "start_date": "2020-12-12",
- "end_date": "2020-12-12",
- "options": [
- "NUMBER_OF_ASSIGNMENTS"
]
}
source | string Example: source=spa Set this to SPA |
RegisterRequest
email required | string (email) User's registration email |
first_name required | string User's first name |
last_name required | string User's last name |
phone | string User's phone number |
language | string Enum: "fi" "en" "sv" "et" "ru" User's locale |
utmcsr | integer Referring user id for referer bonus |
utmccn | string Enum: "" "inviteFriend" "nordea" User referral parameter, should be inviteFriend when utmcsr is filled |
utmcmd | string Enum: "" "inviteFriend" User referral code, should be inviteFriend when utmcsr is filled |
{- "email": "matti.meikalainen@example.com",
- "first_name": "Matti",
- "last_name": "Meikäläinen",
- "phone": "+358401234567",
- "language": "fi",
- "utmcsr": "1234",
- "utmccn": "inviteFriend",
- "utmcmd": "inviteFriend"
}
Registration Email Verification Request
new_password required | string New Password. Rules: Must have 8 characters, with small and big letters and numbers |
new_password_confirmation required | string Must match with the new_password field |
{- "new_password": "string",
- "new_password_confirmation": "string"
}
{ }
hash required | string Example: qkl3jrl2jrlj4rl24j24lkj2lk4j1ewflkj Password change token hash sent in the email |
Password Change Request
new_password required | string New Password. Rules: Must have 8 characters, with small and big letters and numbers |
new_password_confirmation required | string Must match with the new_password field |
{- "new_password": "string",
- "new_password_confirmation": "string"
}
{- "data": {
- "id": 0,
- "created_at": "2020-09-20T18:30:00+03:00",
- "first_name": "string",
- "last_name": "string",
- "full_name": "string",
- "email": "string",
- "language": "string",
- "nationality": "string",
- "profession": "string",
- "marketing_name": "string",
- "phone_numbers": {
- "primary": "string",
- "secondary": "string"
}, - "home_address": {
- "street_address1": "string",
- "street_address2": "null",
- "city": "string",
- "country": "string"
}, - "bank_details": {
- "iban": "string"
}, - "active_tax_card": {
- "id": 0,
- "tax_percent": 0.1,
- "extra_percent": 0.1,
- "income_limit": {
- "amount": "2000",
- "currency": "EUR"
}, - "valid_from": "2020-09-20",
- "valid_to": "2020-09-20",
- "source": "string",
- "attachments": [
- {
- "id": 0,
- "file_name": "string",
- "description": "string",
- "preview_url": "string",
- "download_url": "string",
- "target_model_type": "string",
- "target_model_id": 0,
- "document_type": "string",
- "mime_type": "string",
- "created_at": "2020-09-20T18:30:00+03:00",
- "can": [
- {
- "": {
- "allowed": "true",
- "reasons": [
- "terms_of_service_not_signed"
]
}
}
]
}
]
}, - "options": {
- "show_primary_phone_number_on_invoice": true,
- "is_fast_payment_enabled": true,
- "salary_payment_setting": "string"
}, - "referrer": {
- "referral_source": "string",
- "utmccn": "string",
- "utmcmd": "string"
}, - "terms_and_services": {
- "privacy_policy_accepted": true,
- "terms_of_service_accepted": true
}, - "flags": {
- "can_enable_fast_payment": true,
- "has_active_foreclosure": "true",
- "has_pending_name_change_lock": true,
- "can_change_name": true,
- "has_active_strong_identification": true,
- "is_intro_done": true,
- "registered_with_2023_new_pipeline": true,
- "has_mfa_enabled": true
}, - "notifications": {
- "salary_paid": [
- "email and/or sms"
], - "invoice_paid": [
- "email and/or sms"
], - "invoice_overdue": [
- "email and/or sms"
], - "allow_marketing_email": true
}
}
}
first_name | string User's first name. Currently can be changed until the strong identification has been done. |
last_name | string User's last name. Currently can be changed until the strong identification has been done. |
marketing_name | string |
profession | string |
show_primary_phone_number_on_invoice | boolean |
{- "first_name": "string",
- "last_name": "string",
- "marketing_name": "string",
- "profession": "string",
- "show_primary_phone_number_on_invoice": true
}
{- "data": {
- "id": 0,
- "created_at": "2020-09-20T18:30:00+03:00",
- "first_name": "string",
- "last_name": "string",
- "full_name": "string",
- "email": "string",
- "language": "string",
- "nationality": "string",
- "profession": "string",
- "marketing_name": "string",
- "phone_numbers": {
- "primary": "string",
- "secondary": "string"
}, - "home_address": {
- "street_address1": "string",
- "street_address2": "null",
- "city": "string",
- "country": "string"
}, - "bank_details": {
- "iban": "string"
}, - "active_tax_card": {
- "id": 0,
- "tax_percent": 0.1,
- "extra_percent": 0.1,
- "income_limit": {
- "amount": "2000",
- "currency": "EUR"
}, - "valid_from": "2020-09-20",
- "valid_to": "2020-09-20",
- "source": "string",
- "attachments": [
- {
- "id": 0,
- "file_name": "string",
- "description": "string",
- "preview_url": "string",
- "download_url": "string",
- "target_model_type": "string",
- "target_model_id": 0,
- "document_type": "string",
- "mime_type": "string",
- "created_at": "2020-09-20T18:30:00+03:00",
- "can": [
- {
- "": {
- "allowed": "true",
- "reasons": [
- "terms_of_service_not_signed"
]
}
}
]
}
]
}, - "options": {
- "show_primary_phone_number_on_invoice": true,
- "is_fast_payment_enabled": true,
- "salary_payment_setting": "string"
}, - "referrer": {
- "referral_source": "string",
- "utmccn": "string",
- "utmcmd": "string"
}, - "terms_and_services": {
- "privacy_policy_accepted": true,
- "terms_of_service_accepted": true
}, - "flags": {
- "can_enable_fast_payment": true,
- "has_active_foreclosure": "true",
- "has_pending_name_change_lock": true,
- "can_change_name": true,
- "has_active_strong_identification": true,
- "is_intro_done": true,
- "registered_with_2023_new_pipeline": true,
- "has_mfa_enabled": true
}, - "notifications": {
- "salary_paid": [
- "email and/or sms"
], - "invoice_paid": [
- "email and/or sms"
], - "invoice_overdue": [
- "email and/or sms"
], - "allow_marketing_email": true
}
}
}
The phone number must be in international format (starts with '+') and only contain numeric * characters (other than the '+' sign of course) e.g. '+358501234567'
type required | string Example: primary Type of phone number. Must be either 'primary' or 'secondary' |
phone | string (Phone number) User's new phone number |
{- "phone": "+358501234567"
}
The phone number must be in international format (starts with '+') and only contain numeric * characters (other than the '+' sign of course) e.g. '+358501234567'
phone | string (Phone number) User's phone number |
{- "phone": "+358501234567"
}
street_address1 | string (Street Address 1) User's home address; number 1 at the end is just for consistency, member table has only 1 street address |
zip_code | string (Zip Code) User's home address zip code |
city | string (City) User's home city |
country | string (Country) User's home country's ISO code (i.e. 'FI', 'RU') or 'OTHER' |
{- "street_address1": "Tunkkaajakuja 1",
- "zip_code": "69420",
- "city": "Vantaa",
- "country": "FI"
}
password | string (Password) User's password |
iban | string (Iban) User's bank account's iban number |
is_fast_payment_enabled | boolean (Fast payment enabled) Should users salary always be paid as fast payment |
salary_payment_setting | string (Salary payment setting) Enum: "PAY_MYSELF" "IMMEDIATE" "TWICE_PER_MONTH" "LAST_OF_MONTH" "IN_MID_MONTH" "BEGINNING_OF_MONTH" When users salary should be paid |
{- "password": "kissa123",
- "iban": "FI58 4702 8173 0000 15",
- "is_fast_payment_enabled": true,
- "salary_payment_setting": "PAY_MYSELF"
}
ProofOfAssignmentRequest
start_date | string <date> |
end_date | string <date> |
options | Array of strings Items Enum: "NUMBER_OF_ASSIGNMENTS" "SUM_OF_ASSIGNMENTS" "WORK_HOURS" "PAID_GROSS_SALARY" "PAID_NET_SALARY" "UNPAID_GROSS_SALARY" |
{- "start_date": "2020-12-12",
- "end_date": "2020-12-12",
- "options": [
- "NUMBER_OF_ASSIGNMENTS"
]
}
questionnaire required | integer Example: 123 Questionnaire id |
QuestionnaireRequest
health_insurance_obligated required | string Enum: "YES" "NO" "OLD_AGE_PENSION" "INSURANCE_ELSEWHERE" Is user health insurance obligated? |
{- "health_insurance_obligated": "YES"
}
{- "data": {
- "id": 0,
- "answer": "string",
- "user": {
- "id": 0,
- "first_name": "string",
- "last_name": "string",
- "full_name": "string"
}, - "created_at": "2020-09-20T18:30:00+03:00",
- "update_at": "2020-09-20T18:30:00+03:00"
}
}
hash required | string Example: qkl3jrl2jrlj4rl24j24lkj2lk4j1ewflkj Password change token hash sent in the email |
Password Change Request
new_password required | string New Password. Rules: Must have 8 characters, with small and big letters and numbers |
new_password_confirmation required | string Must match with the new_password field |
{- "new_password": "string",
- "new_password_confirmation": "string"
}
DebtRequest
tax_percent | number <float> |
{- "tax_percent": "15.5"
}
{- "data": {
- "id": 0,
- "tax_percent": 0.1,
- "extra_percent": 0.1,
- "income_limit": {
- "amount": "2000",
- "currency": "EUR"
}, - "valid_from": "2020-09-20",
- "valid_to": "2020-09-20",
- "source": "string",
- "attachments": [
- {
- "id": 0,
- "file_name": "string",
- "description": "string",
- "preview_url": "string",
- "download_url": "string",
- "target_model_type": "string",
- "target_model_id": 0,
- "document_type": "string",
- "mime_type": "string",
- "created_at": "2020-09-20T18:30:00+03:00",
- "can": [
- {
- "": {
- "allowed": "true",
- "reasons": [
- "terms_of_service_not_signed"
]
}
}
]
}
]
}
}
{- "data": {
- "id": 0,
- "tax_percent": 0.1,
- "extra_percent": 0.1,
- "income_limit": {
- "amount": "2000",
- "currency": "EUR"
}, - "valid_from": "2020-09-20",
- "valid_to": "2020-09-20",
- "source": "string",
- "attachments": [
- {
- "id": 0,
- "file_name": "string",
- "description": "string",
- "preview_url": "string",
- "download_url": "string",
- "target_model_type": "string",
- "target_model_id": 0,
- "document_type": "string",
- "mime_type": "string",
- "created_at": "2020-09-20T18:30:00+03:00",
- "can": [
- {
- "": {
- "allowed": "true",
- "reasons": [
- "terms_of_service_not_signed"
]
}
}
]
}
]
}
}
{- "overdue": [
- {
- "id": 0,
- "invoice_number": 0,
- "company_name": "string",
- "contact_person": "string",
- "client_type": "COMPANY",
- "language": "FI",
- "status": "DRAFT",
- "created_at": "2020-09-20T18:30:00+03:00",
- "updated_at": "2020-09-20T18:30:00+03:00",
- "fast_payment": true
}
], - "rejected": [
- {
- "id": 0,
- "invoice_number": 0,
- "company_name": "string",
- "contact_person": "string",
- "client_type": "COMPANY",
- "language": "FI",
- "status": "DRAFT",
- "created_at": "2020-09-20T18:30:00+03:00",
- "updated_at": "2020-09-20T18:30:00+03:00",
- "fast_payment": true
}
], - "drafts": [
- {
- "id": 0,
- "invoice_number": 0,
- "company_name": "string",
- "contact_person": "string",
- "client_type": "COMPANY",
- "language": "FI",
- "status": "DRAFT",
- "created_at": "2020-09-20T18:30:00+03:00",
- "updated_at": "2020-09-20T18:30:00+03:00",
- "fast_payment": true
}
]
}
{- "invoices_customer_paid_recently": [
- {
- "id": 0,
- "invoice_number": 0,
- "company_name": "string",
- "contact_person": "string",
- "client_type": "COMPANY",
- "language": "FI",
- "status": "DRAFT",
- "created_at": "2020-09-20T18:30:00+03:00",
- "updated_at": "2020-09-20T18:30:00+03:00",
- "fast_payment": true
}
], - "invoices_soon_to_overdue": [
- {
- "id": 0,
- "invoice_number": 0,
- "company_name": "string",
- "contact_person": "string",
- "client_type": "COMPANY",
- "language": "FI",
- "status": "DRAFT",
- "created_at": "2020-09-20T18:30:00+03:00",
- "updated_at": "2020-09-20T18:30:00+03:00",
- "fast_payment": true
}
], - "invoices_sent": [
- {
- "id": 0,
- "invoice_number": 0,
- "company_name": "string",
- "contact_person": "string",
- "client_type": "COMPANY",
- "language": "FI",
- "status": "DRAFT",
- "created_at": "2020-09-20T18:30:00+03:00",
- "updated_at": "2020-09-20T18:30:00+03:00",
- "fast_payment": true
}
], - "invoices_in_review": [
- {
- "id": 0,
- "invoice_number": 0,
- "company_name": "string",
- "contact_person": "string",
- "client_type": "COMPANY",
- "language": "FI",
- "status": "DRAFT",
- "created_at": "2020-09-20T18:30:00+03:00",
- "updated_at": "2020-09-20T18:30:00+03:00",
- "fast_payment": true
}
]
}
{- "data": {
- "points": {
- "total": "10000",
- "total_for_period": "5000",
- "threshold": "20000"
}, - "membership": {
- "enabled": "true",
- "eligible": "true",
- "terms_of_membership_approved": "false",
- "period": {
- "start_date": "2020-12-12",
- "end_date": "2020-12-12"
}
}
}
}
{- "data": [
- {
- "id": "ace927cd-cc4d-4953-90c8-c467fdf7727e",
- "type": "INVOICE_SENT",
- "resource_type": "invoice",
- "resource_id": "1234",
- "read_at": "2020-09-20",
- "created_at": "2020-09-20",
- "updated_at": "2020-09-20",
- "data": { }
}
]
}
{- "data": {
- "total_invoicing_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_client_paid_invoicing_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_open_invoicing_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_withdrawable_salary_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}
}
year | int Example: year=2024 Year to get the statistics from |
{- "data": {
- "2": {
- "amount": "2000",
- "currency": "EUR"
}, - "total": {
- "amount": "2000",
- "currency": "EUR"
}
}
}
year | int Example: year=2024 Year to get the statistics from |
{- "data": {
- "2": {
- "amount": "2000",
- "currency": "EUR"
}, - "total": {
- "amount": "2000",
- "currency": "EUR"
}
}
}
{- "data": {
- "current_tax_percentage": 0.1,
- "service_commission_percentage": 0.1,
- "additional_fee_percentage": 0.1,
- "annual_withholding_tax": {
- "amount": "2000",
- "currency": "EUR"
}, - "annual_paid_gross_salary": {
- "amount": "2000",
- "currency": "EUR"
}
}
}
{- "data": {
- "draft_travel_expense": 0,
- "in_review_travel_expense": 0,
- "waiting_for_sending_travel_expense": 0,
- "draft_receipt_expenses": 0,
- "in_review_receipt_expenses": 0,
- "waiting_for_sending_receipt_expenses": 0,
- "total_open_travel_expense_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_open_receipt_expense_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}
}
{- "data": {
- "id": 0,
- "created_at": "2020-09-20T18:30:00+03:00",
- "first_name": "string",
- "last_name": "string",
- "full_name": "string",
- "email": "string",
- "language": "string",
- "nationality": "string",
- "profession": "string",
- "marketing_name": "string",
- "phone_numbers": {
- "primary": "string",
- "secondary": "string"
}, - "home_address": {
- "street_address1": "string",
- "street_address2": "null",
- "city": "string",
- "country": "string"
}, - "bank_details": {
- "iban": "string"
}, - "active_tax_card": {
- "id": 0,
- "tax_percent": 0.1,
- "extra_percent": 0.1,
- "income_limit": {
- "amount": "2000",
- "currency": "EUR"
}, - "valid_from": "2020-09-20",
- "valid_to": "2020-09-20",
- "source": "string",
- "attachments": [
- {
- "id": 0,
- "file_name": "string",
- "description": "string",
- "preview_url": "string",
- "download_url": "string",
- "target_model_type": "string",
- "target_model_id": 0,
- "document_type": "string",
- "mime_type": "string",
- "created_at": "2020-09-20T18:30:00+03:00",
- "can": [
- {
- "": {
- "allowed": "true",
- "reasons": [
- "terms_of_service_not_signed"
]
}
}
]
}
]
}, - "options": {
- "show_primary_phone_number_on_invoice": true,
- "is_fast_payment_enabled": true,
- "salary_payment_setting": "string"
}, - "referrer": {
- "referral_source": "string",
- "utmccn": "string",
- "utmcmd": "string"
}, - "terms_and_services": {
- "privacy_policy_accepted": true,
- "terms_of_service_accepted": true
}, - "flags": {
- "can_enable_fast_payment": true,
- "has_active_foreclosure": "true",
- "has_pending_name_change_lock": true,
- "can_change_name": true,
- "has_active_strong_identification": true,
- "is_intro_done": true,
- "registered_with_2023_new_pipeline": true,
- "has_mfa_enabled": true
}, - "notifications": {
- "salary_paid": [
- "email and/or sms"
], - "invoice_paid": [
- "email and/or sms"
], - "invoice_overdue": [
- "email and/or sms"
], - "allow_marketing_email": true
}
}
}
first_name | string User's first name. Currently can be changed until the strong identification has been done. |
last_name | string User's last name. Currently can be changed until the strong identification has been done. |
marketing_name | string |
profession | string |
show_primary_phone_number_on_invoice | boolean |
{- "first_name": "string",
- "last_name": "string",
- "marketing_name": "string",
- "profession": "string",
- "show_primary_phone_number_on_invoice": true
}
{- "data": {
- "id": 0,
- "created_at": "2020-09-20T18:30:00+03:00",
- "first_name": "string",
- "last_name": "string",
- "full_name": "string",
- "email": "string",
- "language": "string",
- "nationality": "string",
- "profession": "string",
- "marketing_name": "string",
- "phone_numbers": {
- "primary": "string",
- "secondary": "string"
}, - "home_address": {
- "street_address1": "string",
- "street_address2": "null",
- "city": "string",
- "country": "string"
}, - "bank_details": {
- "iban": "string"
}, - "active_tax_card": {
- "id": 0,
- "tax_percent": 0.1,
- "extra_percent": 0.1,
- "income_limit": {
- "amount": "2000",
- "currency": "EUR"
}, - "valid_from": "2020-09-20",
- "valid_to": "2020-09-20",
- "source": "string",
- "attachments": [
- {
- "id": 0,
- "file_name": "string",
- "description": "string",
- "preview_url": "string",
- "download_url": "string",
- "target_model_type": "string",
- "target_model_id": 0,
- "document_type": "string",
- "mime_type": "string",
- "created_at": "2020-09-20T18:30:00+03:00",
- "can": [
- {
- "": {
- "allowed": "true",
- "reasons": [
- "terms_of_service_not_signed"
]
}
}
]
}
]
}, - "options": {
- "show_primary_phone_number_on_invoice": true,
- "is_fast_payment_enabled": true,
- "salary_payment_setting": "string"
}, - "referrer": {
- "referral_source": "string",
- "utmccn": "string",
- "utmcmd": "string"
}, - "terms_and_services": {
- "privacy_policy_accepted": true,
- "terms_of_service_accepted": true
}, - "flags": {
- "can_enable_fast_payment": true,
- "has_active_foreclosure": "true",
- "has_pending_name_change_lock": true,
- "can_change_name": true,
- "has_active_strong_identification": true,
- "is_intro_done": true,
- "registered_with_2023_new_pipeline": true,
- "has_mfa_enabled": true
}, - "notifications": {
- "salary_paid": [
- "email and/or sms"
], - "invoice_paid": [
- "email and/or sms"
], - "invoice_overdue": [
- "email and/or sms"
], - "allow_marketing_email": true
}
}
}
NotificationRequest
salary_paid required | Array of strings Items Enum: "sms" "email" Notify about paid salary through sms and/or email or not. Empty array disables all. |
invoice_paid required | Array of strings Items Enum: "sms" "email" Notify about paid invoice through sms and/or email or not. Empty array disables all. |
invoice_overdue required | Array of strings Items Enum: "sms" "email" Notify about overdue invoice through sms and/or email or not. Empty array disables all. |
is_missing_tax_card_notifications_enabled | boolean Whether we need to notify the user about missing tax card or not |
allow_marketing_email | boolean Changes whether the user wants to receive marketing emails or not |
{- "salary_paid": [
- "email"
], - "invoice_paid": [
- "email"
], - "invoice_overdue": [
- "email"
], - "is_missing_tax_card_notifications_enabled": true,
- "allow_marketing_email": true
}
The phone number must be in international format (starts with '+') and only contain numeric * characters (other than the '+' sign of course) e.g. '+358501234567'
type required | string Example: primary Type of phone number. Must be either 'primary' or 'secondary' |
phone | string (Phone number) User's new phone number |
{- "phone": "+358501234567"
}
The phone number must be in international format (starts with '+') and only contain numeric * characters (other than the '+' sign of course) e.g. '+358501234567'
phone | string (Phone number) User's phone number |
{- "phone": "+358501234567"
}
street_address1 | string (Street Address 1) User's home address; number 1 at the end is just for consistency, member table has only 1 street address |
zip_code | string (Zip Code) User's home address zip code |
city | string (City) User's home city |
country | string (Country) User's home country's ISO code (i.e. 'FI', 'RU') or 'OTHER' |
{- "street_address1": "Tunkkaajakuja 1",
- "zip_code": "69420",
- "city": "Vantaa",
- "country": "FI"
}
password | string (Password) User's password |
iban | string (Iban) User's bank account's iban number |
is_fast_payment_enabled | boolean (Fast payment enabled) Should users salary always be paid as fast payment |
salary_payment_setting | string (Salary payment setting) Enum: "PAY_MYSELF" "IMMEDIATE" "TWICE_PER_MONTH" "LAST_OF_MONTH" "IN_MID_MONTH" "BEGINNING_OF_MONTH" When users salary should be paid |
{- "password": "kissa123",
- "iban": "FI58 4702 8173 0000 15",
- "is_fast_payment_enabled": true,
- "salary_payment_setting": "PAY_MYSELF"
}
{
}
{- "data": {
- "active": true,
- "added": "2020-09-20T18:30:00+03:00",
- "salary_payment_setting": "PAY_MYSELF",
- "protected_amount": {
- "amount": "2000",
- "currency": "EUR"
}, - "percent": 0,
- "from": "2020-09-20T18:30:00+03:00",
- "other_income_per_month": {
- "amount": "2000",
- "currency": "EUR"
}, - "calculation_method": "REGULAR",
- "withholding_notice_number": "string",
- "maximum_amount_to_foreclose_per_month": {
- "amount": "2000",
- "currency": "EUR"
}, - "maximum_amount_to_foreclose_per_payment": {
- "amount": "2000",
- "currency": "EUR"
}, - "amount_to_foreclose_total": {
- "amount": "2000",
- "currency": "EUR"
}, - "number": 0,
- "free_months": {
- "": {
- "month": "string"
}
}
}
}
code | string Exchange Code from Telias authentication system |
{- "code": "string"
}
{- "data": {
- "authentication_state": "success | pending_name_lock",
- "user_names": {
- "old": {
- "first_name": "string",
- "last_name": "string"
}, - "new": {
- "first_names": [
- {
- "": "string"
}
], - "last_name": "string"
}
}
}
}
{- "data": {
- "authentication_state": "success | pending_name_lock",
- "user_names": {
- "old": {
- "first_name": "string",
- "last_name": "string"
}, - "new": {
- "first_names": [
- {
- "": "string"
}
], - "last_name": "string"
}
}
}
}
ProofOfAssignmentRequest
start_date | string <date> |
end_date | string <date> |
options | Array of strings Items Enum: "NUMBER_OF_ASSIGNMENTS" "SUM_OF_ASSIGNMENTS" "WORK_HOURS" "PAID_GROSS_SALARY" "PAID_NET_SALARY" "UNPAID_GROSS_SALARY" |
{- "start_date": "2020-12-12",
- "end_date": "2020-12-12",
- "options": [
- "NUMBER_OF_ASSIGNMENTS"
]
}
questionnaire required | integer Example: 123 Questionnaire id |
QuestionnaireRequest
health_insurance_obligated required | string Enum: "YES" "NO" "OLD_AGE_PENSION" "INSURANCE_ELSEWHERE" Is user health insurance obligated? |
{- "health_insurance_obligated": "YES"
}
{- "data": {
- "id": 0,
- "answer": "string",
- "user": {
- "id": 0,
- "first_name": "string",
- "last_name": "string",
- "full_name": "string"
}, - "created_at": "2020-09-20T18:30:00+03:00",
- "update_at": "2020-09-20T18:30:00+03:00"
}
}
{- "data": {
- "name": "string",
- "official_name": "string",
- "customer_service_email": "string",
- "website": "string",
- "phone": "string",
- "address": "string",
- "zip_code": "string",
- "city": "string",
- "noreply_email": "string",
- "company_id": "string"
}
}
Display a listing of the resource.
search | string (Optional) search industries by name e.g. /invoices/industries?search=tarkastaja |
{- "data": {
- "id": 0,
- "industry_id": "string",
- "name": "string",
- "subcategories": { }
}
}
category_type required | string Example: empty / own / team / partof Type of Invoices list: empty / own / team / partof |
type required | string Example: empty/all | paid | unpaid | open | user_action_required Type of Invoices list: empty/all | paid | unpaid | open | user_action_required |
page | integer Pagination page id |
limit | integer Example: limit=50 Limit per page. Default 50, max 1000 |
sort | string Example: sort=created_at | updated_at | invoice_number
* | due_date | company_name | contact_person
* | total_sum_with_vat | delivery_method | status
* | company_name, contact_person Sort by ascending order, add '-' prefix to get
* descending order, ie. -total. To sort by
* client_name, use |
filter[*field_name*] | string Example: filter[*field_name*]=filter[common_search] = 'foobar', other keys:
* common_search
* | created_at | updated_at | invoice_number
* | due_date | contact_person | company_name
* | client_name | delivery_method
* | due_date_start (format: YYYY-m-d)
* | due_date_end (format: YYYY-m-d)
* | search_date_between (format: YYYY-m-d|YYYY-m-d)
* either one can be omitted Sort fields. Array of filtered fields, so * filter[email] = foobar@doobar.com * filter[due_date_start] = 2022-01-01 * filter[due_date_end] = 2022-01-31 * NOTE: This is an AND search |
{- "data": [
- {
- "id": 0,
- "invoice_number": 0,
- "company_name": "string",
- "contact_person": "string",
- "client_type": "COMPANY",
- "language": "FI",
- "email": "user@example.com",
- "street_address1": "string",
- "zip_code": "string",
- "city": "string",
- "country": "FI",
- "clients_reference": "string",
- "description": "string",
- "occupation": {
- "id": 0,
- "title_fi": "string",
- "title_en": "string",
- "description_fi": "string",
- "description_en": "string"
}, - "user_confirmed_work_in_finland": true,
- "autocollect": true,
- "vat_rate": "VAT_REGULAR",
- "vat_rate_explanation": "Text",
- "display_vat_rate": {
- "id": 0,
- "name_en": "string",
- "name_fi": "string",
- "parent_id": 0,
- "vat_rate": {
- "name": "string",
- "type": "string",
- "percentage": 0,
- "region": "string",
- "customer_type": "string"
}, - "region": "string",
- "customer_type": "string",
- "children": [
- { }
]
}, - "vat_rate_description": "10% Exercise guidance (Value Added Tax Act 85a§)",
- "cost_center": "Text",
- "order_number": "Text",
- "agreement_number": "Text",
- "sent_to_public_sector_operator": true,
- "delivery_method": "EMAIL",
- "einvoice_address": "FIxxxxxxxxxxxxxxxx",
- "term_of_payment": "14",
- "due_date": "2020-09-20",
- "reference_number": "1234567",
- "barcode": "4301237300012305600120000000000000000000012345674200213",
- "sent_at": "2020-09-20T18:30:00+03:00",
- "created_at": "2020-09-20T18:30:00+03:00",
- "updated_at": "2020-09-20T18:30:00+03:00",
- "fast_payment": true,
- "total_sum_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum_without_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "status": "DRAFT",
- "salary_status": "NONE",
- "extra_statuses": [
- "RECEIPT_EXPENSES_PENDING"
], - "is_editable": true,
- "is_deletable": true,
- "is_creditable": true,
- "has_legacy_travel_expenses": true,
- "message_for_admin": "Added missing attachment",
- "rejection_note": {
- "id": 0,
- "message": "string",
- "created_at": "2020-09-20",
- "updated_at": "2020-09-20"