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"
]
}
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,
- "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,
- "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"
}
{- "data": {
- "invoice_discount_amount": {
- "amount": "2000",
- "currency": "EUR"
}, - "invoice_discount_amount_left": {
- "amount": "2000",
- "currency": "EUR"
}
}
}
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,
- "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,
- "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"
}, - "discard_note": {
- "id": 0,
- "message": "string",
- "created_at": "2020-09-20",
- "updated_at": "2020-09-20"
}, - "rows": [
- {
- "id": 0,
- "invoice_id": 0,
- "short_description": "string",
- "long_description": "string",
- "start_date": "2020-09-20T18:30:00+03:00",
- "end_date": "2020-09-20T18:30:00+03:00",
- "quantity": 0.1,
- "unit_type": "PIECE",
- "unit_price": {
- "amount": "20000",
- "currency": "EUR"
}, - "contains_vat": true,
- "total_sum_without_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_no_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "discount_type": "SUM",
- "discount_percent": 0,
- "discount_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": 0,
- "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum_without_vat_before_discount": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum_with_vat_before_discount": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "row_type": "RECEIPT_EXPENSE"
}
], - "team_members": [
- {
- "name": "Maija Meikäläinen",
- "email": "team.member@mail.com",
- "percent": "20.8",
- "amount": {
- "amount": "2000",
- "currency": "EUR"
}, - "is_owner": true
}
], - "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"
]
}
}
]
}
], - "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"
}
}
Invoice
company_name | string Name of the client company |
business_id | string Finnish Business Id (Y-tunnus) or Registered Association id or so |
einvoice_address | string EINvoice/Finvoice address |
contact_person | string Client contact person |
client_type | string Enum: "COMPANY" "PERSON" The type of the client |
language | string Enum: "FI" "EN" "SV" Language of the invoice |
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) |
string <email> Client's email. Required if the delivery_method is EMAIL | |
additional_email_recipients | Array of strings <email> [ items <email > ] Additional invoice recipients email addresses as array list, MAX: 5 |
clients_reference | string Client's preferred reference string |
message_for_admin | string User given message for admins processing the invoice |
occupation_id | integer Id of the occupation the work done relates to |
user_confirmed_work_in_finland | boolean User's assurance that the work was performed in Finland if the country is other than FI. Not required if country is FI |
autocollect | boolean Deprecated Deprecated When true UKKO.fi takes care of invoice follow-up, overdue notices and debt collection |
notify_overdue_and_automatic_debt_collection | boolean When true UKKO.fi takes care of invoice follow-up, overdue notices and debt collection |
term_of_payment | integer Term of payment in days from now |
display_vat_rate_id | integer Id of the display vat rate. Required if vat_rate is not set |
vat_rate | string Enum: "VAT_REGULAR" "VAT_ARTISTS_REWARD" "VAT_COMPANY_IN_ANOTHER_EU_COUNTRY" "VAT_CONSTRUCTION_REVERSE_CHARGE" "VAT_COPYRIGHT" "VAT_DOMESTIC_SHIPPING_WORK" "VAT_EUROPEAN_UNION" "VAT_EXERCISE_GUIDANCE" "VAT_INVOICING_OUTSIDE_OF_EU" "VAT_WORK_ON_A_FOREIGN_SHIP" Vat rate of the invoice. Required if display_vat_rate_id is not set |
vat_rate_explanation | string Not required for REGULAR, RESTAURANT_AND_CATERING_SERVICES |
delivery_method | string Enum: "EINVOICE" "MAIL" "EMAIL" Invoice Delivery Option, EINVOICE allowed only for companies, if country is OTHER, then only email is allowed |
fast_payment | boolean null, true, false |
sent_to_public_sector_operator | boolean null, true, false |
cost_center | string Cost center |
order_number | string Order number |
agreement_number | string Agreement number |
Array of objects Send only user created rows, never rows with row_type being anything else but null
| |
Array of objects Emails and profit of the team members. Not including the owner. |
{- "company_name": "string",
- "business_id": "6811327-1",
- "einvoice_address": "FIxxxxxxxxxxxxxxxx",
- "contact_person": "string",
- "client_type": "COMPANY",
- "language": "FI",
- "street_address1": "string",
- "zip_code": "string",
- "city": "string",
- "country": "FI",
- "email": "user@example.com",
- "additional_email_recipients": [
- "user.name@example.org"
], - "clients_reference": "12342352345",
- "message_for_admin": "Added missing attachment",
- "occupation_id": 0,
- "user_confirmed_work_in_finland": true,
- "autocollect": true,
- "notify_overdue_and_automatic_debt_collection": true,
- "term_of_payment": "14",
- "display_vat_rate_id": 0,
- "vat_rate": "VAT_REGULAR",
- "vat_rate_explanation": "Text",
- "delivery_method": "EMAIL",
- "fast_payment": true,
- "sent_to_public_sector_operator": true,
- "cost_center": "Text",
- "order_number": "Text",
- "agreement_number": "Text",
- "rows": [
- {
- "short_description": "string",
- "long_description": "string",
- "quantity": "10.00",
- "discount_sum": "10.00",
- "discount_percent": {
- "amount": "20000",
- "currency": "EUR"
}, - "unit_price": {
- "amount": "20000",
- "currency": "EUR"
}, - "contains_vat": true,
- "unit_type": "PIECE",
- "start_date": "string",
- "end_date": "string"
}
], - "team_members": [
- {
- "email": "string",
- "amount": {
- "amount": "2000",
- "currency": "EUR"
}
}
]
}
{- "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"
}, - "discard_note": {
- "id": 0,
- "message": "string",
- "created_at": "2020-09-20",
- "updated_at": "2020-09-20"
}, - "rows": [
- {
- "id": 0,
- "invoice_id": 0,
- "short_description": "string",
- "long_description": "string",
- "start_date": "2020-09-20T18:30:00+03:00",
- "end_date": "2020-09-20T18:30:00+03:00",
- "quantity": 0.1,
- "unit_type": "PIECE",
- "unit_price": {
- "amount": "20000",
- "currency": "EUR"
}, - "contains_vat": true,
- "total_sum_without_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_no_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "discount_type": "SUM",
- "discount_percent": 0,
- "discount_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": 0,
- "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum_without_vat_before_discount": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum_with_vat_before_discount": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "row_type": "RECEIPT_EXPENSE"
}
], - "team_members": [
- {
- "name": "Maija Meikäläinen",
- "email": "team.member@mail.com",
- "percent": "20.8",
- "amount": {
- "amount": "2000",
- "currency": "EUR"
}, - "is_owner": true
}
], - "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"
]
}
}
]
}
], - "can": [
- {
- "": {
- "allowed": "true",
- "reasons": [
- "terms_of_service_not_signed"
]
}
}
]
}
}
{- "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"
}, - "discard_note": {
- "id": 0,
- "message": "string",
- "created_at": "2020-09-20",
- "updated_at": "2020-09-20"
}, - "rows": [
- {
- "id": 0,
- "invoice_id": 0,
- "short_description": "string",
- "long_description": "string",
- "start_date": "2020-09-20T18:30:00+03:00",
- "end_date": "2020-09-20T18:30:00+03:00",
- "quantity": 0.1,
- "unit_type": "PIECE",
- "unit_price": {
- "amount": "20000",
- "currency": "EUR"
}, - "contains_vat": true,
- "total_sum_without_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_no_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "discount_type": "SUM",
- "discount_percent": 0,
- "discount_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": 0,
- "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum_without_vat_before_discount": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum_with_vat_before_discount": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "row_type": "RECEIPT_EXPENSE"
}
], - "team_members": [
- {
- "name": "Maija Meikäläinen",
- "email": "team.member@mail.com",
- "percent": "20.8",
- "amount": {
- "amount": "2000",
- "currency": "EUR"
}, - "is_owner": true
}
], - "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"
]
}
}
]
}
], - "can": [
- {
- "": {
- "allowed": "true",
- "reasons": [
- "terms_of_service_not_signed"
]
}
}
]
}
}
invoice_id required | integer Invoice id |
Invoice
company_name | string Name of the client company |
business_id | string Finnish Business Id (Y-tunnus) or Registered Association id or so |
einvoice_address | string EINvoice/Finvoice address |
contact_person | string Client contact person |
client_type | string Enum: "COMPANY" "PERSON" The type of the client |
language | string Enum: "FI" "EN" "SV" Language of the invoice |
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) |
string <email> Client's email. Required if the delivery_method is EMAIL | |
additional_email_recipients | Array of strings <email> [ items <email > ] Additional invoice recipients email addresses as array list, MAX: 5 |
clients_reference | string Client's preferred reference string |
message_for_admin | string User given message for admins processing the invoice |
occupation_id | integer Id of the occupation the work done relates to |
user_confirmed_work_in_finland | boolean User's assurance that the work was performed in Finland if the country is other than FI. Not required if country is FI |
autocollect | boolean Deprecated Deprecated When true UKKO.fi takes care of invoice follow-up, overdue notices and debt collection |
notify_overdue_and_automatic_debt_collection | boolean When true UKKO.fi takes care of invoice follow-up, overdue notices and debt collection |
term_of_payment | integer Term of payment in days from now |
display_vat_rate_id | integer Id of the display vat rate. Required if vat_rate is not set |
vat_rate | string Enum: "VAT_REGULAR" "VAT_ARTISTS_REWARD" "VAT_COMPANY_IN_ANOTHER_EU_COUNTRY" "VAT_CONSTRUCTION_REVERSE_CHARGE" "VAT_COPYRIGHT" "VAT_DOMESTIC_SHIPPING_WORK" "VAT_EUROPEAN_UNION" "VAT_EXERCISE_GUIDANCE" "VAT_INVOICING_OUTSIDE_OF_EU" "VAT_WORK_ON_A_FOREIGN_SHIP" Vat rate of the invoice. Required if display_vat_rate_id is not set |
vat_rate_explanation | string Not required for REGULAR, RESTAURANT_AND_CATERING_SERVICES |
delivery_method | string Enum: "EINVOICE" "MAIL" "EMAIL" Invoice Delivery Option, EINVOICE allowed only for companies, if country is OTHER, then only email is allowed |
fast_payment | boolean null, true, false |
sent_to_public_sector_operator | boolean null, true, false |
cost_center | string Cost center |
order_number | string Order number |
agreement_number | string Agreement number |
Array of objects Send only user created rows, never rows with row_type being anything else but null
| |
Array of objects Emails and profit of the team members. Not including the owner. |
{- "company_name": "string",
- "business_id": "6811327-1",
- "einvoice_address": "FIxxxxxxxxxxxxxxxx",
- "contact_person": "string",
- "client_type": "COMPANY",
- "language": "FI",
- "street_address1": "string",
- "zip_code": "string",
- "city": "string",
- "country": "FI",
- "email": "user@example.com",
- "additional_email_recipients": [
- "user.name@example.org"
], - "clients_reference": "12342352345",
- "message_for_admin": "Added missing attachment",
- "occupation_id": 0,
- "user_confirmed_work_in_finland": true,
- "autocollect": true,
- "notify_overdue_and_automatic_debt_collection": true,
- "term_of_payment": "14",
- "display_vat_rate_id": 0,
- "vat_rate": "VAT_REGULAR",
- "vat_rate_explanation": "Text",
- "delivery_method": "EMAIL",
- "fast_payment": true,
- "sent_to_public_sector_operator": true,
- "cost_center": "Text",
- "order_number": "Text",
- "agreement_number": "Text",
- "rows": [
- {
- "short_description": "string",
- "long_description": "string",
- "quantity": "10.00",
- "discount_sum": "10.00",
- "discount_percent": {
- "amount": "20000",
- "currency": "EUR"
}, - "unit_price": {
- "amount": "20000",
- "currency": "EUR"
}, - "contains_vat": true,
- "unit_type": "PIECE",
- "start_date": "string",
- "end_date": "string"
}
], - "team_members": [
- {
- "email": "string",
- "amount": {
- "amount": "2000",
- "currency": "EUR"
}
}
]
}
{- "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"
}, - "discard_note": {
- "id": 0,
- "message": "string",
- "created_at": "2020-09-20",
- "updated_at": "2020-09-20"
}, - "rows": [
- {
- "id": 0,
- "invoice_id": 0,
- "short_description": "string",
- "long_description": "string",
- "start_date": "2020-09-20T18:30:00+03:00",
- "end_date": "2020-09-20T18:30:00+03:00",
- "quantity": 0.1,
- "unit_type": "PIECE",
- "unit_price": {
- "amount": "20000",
- "currency": "EUR"
}, - "contains_vat": true,
- "total_sum_without_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_no_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "discount_type": "SUM",
- "discount_percent": 0,
- "discount_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": 0,
- "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum_without_vat_before_discount": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum_with_vat_before_discount": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "row_type": "RECEIPT_EXPENSE"
}
], - "team_members": [
- {
- "name": "Maija Meikäläinen",
- "email": "team.member@mail.com",
- "percent": "20.8",
- "amount": {
- "amount": "2000",
- "currency": "EUR"
}, - "is_owner": true
}
], - "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"
]
}
}
]
}
], - "can": [
- {
- "": {
- "allowed": "true",
- "reasons": [
- "terms_of_service_not_signed"
]
}
}
]
}
}
{- "data": [
- {
- "id": 0,
- "invoice": [
- {
- "id": 0,
- "is_editable": true
}
], - "client_description": "string",
- "start_date": "2020-09-20T18:30:00+03:00",
- "end_date": "2020-09-20T18:30:00+03:00",
- "type": "string",
- "status": "DRAFT",
- "allowances": {
- "kilometers": {
- "kilometers_amount": 0
}
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "first_routepoint_address": "string",
- "last_routepoint_address": "string",
- "is_editable": true,
- "is_deletable": true
}
]
}
{- "data": [
- {
- "id": 0,
- "purpose_of_trip": "Alkusammuttimen tarkastus & huolto",
- "trip_destination": "Itämerenkatu 1, 00180 Helsinki",
- "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
}
], - "timespan": "PER_DAY",
- "country": "FI",
- "daily_allowance_city_id": "123",
- "start_date": "2020-09-20T18:30:00+03:00",
- "end_date": "2020-09-20T18:30:00+03:00",
- "whole_trip_start_date": "2020-09-20T18:30:00+03:00",
- "whole_trip_end_date": "2020-09-20T18:30:00+03:00",
- "provided_free_meals": 0,
- "work_time": 0,
- "assure_work_is_temporary": true,
- "additional_info": "string",
- "include_to_invoice_row": true,
- "is_round_trip": true,
- "status": "string",
- "vehicle": {
- "register_number": "BOI-111",
- "type": "CAR",
- "options": [
- "'HEAVY_LOAD', 'TRAILER'"
]
}, - "calculate_kilometer_allowances": true,
- "calculate_daily_allowances": true,
- "calculate_meal_allowances": true,
- "routes": [
- {
- "address": "string",
- "latitude": "string",
- "longitude": "string",
- "purpose_explanation": "string",
- "rough_terrain": true
}
], - "passengers": [
- {
- "id": 0,
- "first_name": "string",
- "last_name": "string",
- "full_name": "string",
- "description": "string",
- "travel_expense_id": "string"
}
], - "allowances": {
- "kilometers": {
- "distance_in_meters": "125000"
}, - "meals": {
- "amount": "0, 1, 2"
}, - "daily": {
- "full_day_100_percent_amount": "0, 1 or 2",
- "full_day_100_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "full_day_50_percent_amount": "0, 1 or 2",
- "full_day_50_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "half_day_100_percent_amount": "0, 1 or 2",
- "half_day_100_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "half_day_50_percent_amount": "0, 1 or 2",
- "half_day_50_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}
}, - "rejection_note": {
- "id": 0,
- "message": "string",
- "created_at": "2020-09-20",
- "updated_at": "2020-09-20"
}, - "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"
]
}
}
]
}
]
}
]
}
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"
}
}
invoice_id required | string |
user_id required | string |
withholding_tax_percentage | number Example: withholding_tax_percentage=20.00 If the user hasn't given his/her tax card withholding tax percentage, it can be given here |
{- "id": "2022",
- "invoicing_vat_percent": "24",
- "total_invoicing_sum_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_invoicing_sum_without_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_invoicing_sum_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "work_hours": "20.3",
- "company_fees": {
- "commission": {
- "percent": "24.00",
- "minimum": {
- "amount": "2000",
- "currency": "EUR"
}, - "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "invoice_discount_amount": {
- "amount": "2000",
- "currency": "EUR"
}, - "invoice_discount_amount_used": {
- "amount": "2000",
- "currency": "EUR"
}, - "invoice_discount_total_amount_used": {
- "amount": "2000",
- "currency": "EUR"
}, - "invoice_discount_amount_left": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "additional_cost": {
- "percent": "24.00",
- "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "health_insurance_debt": {
- "type": "string",
- "created_at": "string",
- "name": "string",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "percent": "24.00",
- "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00"
}, - "salary_advance": {
- "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "percent": "24.00",
- "minimum": {
- "amount": "2000",
- "currency": "EUR"
}, - "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "partner_commission": {
- "percent": "24.00",
- "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "includes_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "minimum_commission_applied": true,
- "maximum_commission_applied": true,
- "maximum_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "minimum_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "name": ""
}, - "extra_service_fee": {
- "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "percent": "24.00",
- "minimum": {
- "amount": "2000",
- "currency": "EUR"
}, - "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00"
}, - "fast_payment": {
- "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "percent": "24.00",
- "minimum": {
- "amount": "2000",
- "currency": "EUR"
}, - "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00"
}, - "accident_insurance": {
- "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "percent": "24.00",
- "minimum": {
- "amount": "2000",
- "currency": "EUR"
}, - "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}
}
}, - "company_fees_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_invoicing_sum_without_vat_minus_company_fees": {
- "amount": "2000",
- "currency": "EUR"
}, - "combined_expenses_sum_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "combined_expenses_sum_without_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "combined_expenses_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "receipt_expenses_without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "receipt_expenses_with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "receipt_expenses_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "travel_expenses": {
- "kilometer_allowances": {
- "amount": "2022",
- "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "cost_per": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "full_day_100_percent_allowances": {
- "amount": "2022",
- "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "cost_per": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "full_day_50_percent_allowances": {
- "amount": "2022",
- "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "cost_per": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "half_day_100_percent_allowances": {
- "amount": "2022",
- "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "cost_per": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "half_day_50_percent_allowances": {
- "amount": "2022",
- "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "cost_per": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "meal_allowances": {
- "amount": "2022",
- "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "cost_per": {
- "amount": "2000",
- "currency": "EUR"
}
}
}, - "travel_expenses_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "base_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "employer_fees": { },
- "gross_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "employee_fees": {
- "tax_percent": {
- "percent": "30.00",
- "sum": {
- "amount": "2000",
- "currency": "EUR"
}
}
}, - "employee_fees_percent": "24.00",
- "employee_fees_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "holiday_compensation_percent": "24.00",
- "salary_without_holiday_compensation": {
- "amount": "2000",
- "currency": "EUR"
}, - "holiday_compensation": {
- "amount": "2000",
- "currency": "EUR"
}, - "legacy_health_insurance_percent": "0.74",
- "legacy_health_insurance_fee": {
- "amount": "2000",
- "currency": "EUR"
}, - "health_insurance_debt_amount": {
- "amount": "2000",
- "currency": "EUR"
}, - "net_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "is_yel_enabled": "true",
- "is_required_yel_payments_paid": "true",
- "yel": {
- "percent": "24.00",
- "maximum": {
- "amount": "2000",
- "currency": "EUR"
}, - "is_discount": "true",
- "is_required_yel_payments_paid": "true",
- "withheld_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "withheld_health_insurance_fee_without_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "withheld_health_insurance_fee_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "withheld_health_insurance_fee_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "withheld_health_insurance_percent": "0.74",
- "withheld_health_insurance_vat_percent": "24.0",
- "sum_to_calculate_foreclosure_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum_before_foreclosure": {
- "amount": "2000",
- "currency": "EUR"
}, - "foreclosure": {
- "calculation_starting_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum_to_calculate_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum_to_calculate_from_extra": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum_to_calculate_from_without_other_income_per_month": {
- "amount": "2000",
- "currency": "EUR"
}, - "minimum": {
- "amount": "2000",
- "currency": "EUR"
}, - "maximum": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_amount": {
- "amount": "2000",
- "currency": "EUR"
}, - "maximum_monthly": {
- "amount": "2000",
- "currency": "EUR"
}, - "maximum_per_payment": {
- "amount": "2000",
- "currency": "EUR"
}, - "minimum_monthly": {
- "amount": "2000",
- "currency": "EUR"
}, - "minimum_per_payment": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_amount_paid": {
- "amount": "2000",
- "currency": "EUR"
}, - "amount_paid_this_month": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_amount_left_to_pay": {
- "amount": "2000",
- "currency": "EUR"
}, - "amount_left_to_pay_this_month": {
- "amount": "2000",
- "currency": "EUR"
}, - "percent": "24.00",
- "protected_per_day": {
- "amount": "2000",
- "currency": "EUR"
}, - "protected_total": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum_to_calculate_foreclosure_from_divided_by_protected_amount_total": {
- "amount": "2000",
- "currency": "EUR"
}, - "is_sum_to_calculate_foreclosure_from_less_than_protected_amount": "true",
- "is_sum_to_calculate_foreclosure_from_greater_than_protected_amount_and_less_than_2_times_protected_amount": "true",
- "is_sum_to_calculate_foreclosure_from_at_least_2_times_and_less_than_4_times_protected_amount": "true",
- "is_sum_to_calculate_foreclosure_from_at_least_4_times_protected_amount": "true",
- "extra_amount_to_leave": {
- "amount": "2000",
- "currency": "EUR"
}, - "other_income_per_month": {
- "amount": "2000",
- "currency": "EUR"
}, - "is_under_protected": "true",
- "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "is_monthly_maximum_paid": "true",
- "is_total_amount_paid": "true",
- "is_monthly_maximum_reached": "true",
- "is_total_amount_reached": "true",
- "is_maximum_payment_reached": "true",
- "is_under_monthly_minimum": "true",
- "is_under_payment_minimum": "true",
- "is_current_month_free_from_foreclosure": "true",
- "iban": "FI2112345600000785",
- "reference": "123123213",
- "salary_payment_setting": "true",
- "payment_term": "true",
- "calculation_method": "true",
- "calculation_date": "2020",
- "amount_to_leave_sum_used": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "sum_after_foreclosure": {
- "amount": "2000",
- "currency": "EUR"
}, - "salary_fees_without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "salary_fees_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "salary_fees_with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "salary_fees": {
- "commission": {
- "percent": "24.00",
- "minimum": {
- "amount": "2000",
- "currency": "EUR"
}, - "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "invoice_discount_amount": {
- "amount": "2000",
- "currency": "EUR"
}, - "invoice_discount_amount_used": {
- "amount": "2000",
- "currency": "EUR"
}, - "invoice_discount_total_amount_used": {
- "amount": "2000",
- "currency": "EUR"
}, - "invoice_discount_amount_left": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "additional_cost": {
- "percent": "24.00",
- "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "health_insurance_debt": {
- "type": "string",
- "created_at": "string",
- "name": "string",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "percent": "24.00",
- "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00"
}, - "salary_advance": {
- "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "percent": "24.00",
- "minimum": {
- "amount": "2000",
- "currency": "EUR"
}, - "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "partner_commission": {
- "percent": "24.00",
- "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "includes_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "minimum_commission_applied": true,
- "maximum_commission_applied": true,
- "maximum_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "minimum_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "name": ""
}, - "extra_service_fee": {
- "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "percent": "24.00",
- "minimum": {
- "amount": "2000",
- "currency": "EUR"
}, - "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00"
}, - "fast_payment": {
- "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "percent": "24.00",
- "minimum": {
- "amount": "2000",
- "currency": "EUR"
}, - "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00"
}, - "accident_insurance": {
- "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "percent": "24.00",
- "minimum": {
- "amount": "2000",
- "currency": "EUR"
}, - "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}
}
}, - "sum_after_salary_fees": {
- "amount": "2000",
- "currency": "EUR"
}, - "final_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "final_salary_with_expenses": {
- "amount": "2000",
- "currency": "EUR"
}, - "final_expenses": {
- "amount": "2000",
- "currency": "EUR"
}, - "personal_deductions_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "country": "",
- "calculation_year": "2020",
- "start_date": "2020-09-20T18:30:00+03:00",
- "end_date": "2020-09-20T18:30:00+03:00",
- "calculation_date": "2020-09-20T18:30:00+03:00",
- "user_age": "18",
- "user_birth_year": "1980",
- "is_strict_checked": "true",
- "is_fast_payment_enabled": "true",
- "is_extra_service_fee_enabled": "true",
- "adjusted_tax_percent": "true",
- "paid_salary_id": "123124",
- "paid_salary_date": "2020-09-20T18:30:00+03:00",
- "salary_buckets": [
- {
- "start_date": "Y-m-d\\TH:i:sP",
- "end_date": "Y-m-d\\TH:i:sP",
- "total_gross_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "health_insurance_obligated": "true",
- "is_of_age": "true",
- "type": "ADMIN_OVERRIDDEN",
- "retroactive_debt_handling": "NONE",
- "admin_explanation": "string"
}
], - "is_salary_too_small_for_fast_payment": "true",
- "juel_total_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}
invoice_id required | string |
user_id required | number |
withholding_tax_percentage | number Example: withholding_tax_percentage=20.00 If the user hasn't given his/her tax card withholding tax percentage, it can be given here |
invoice_id required | integer |
required | object (Money) Money value schema |
expense_vat_percent required | number |
receipt_expense_id required | integer |
{- "data": {
- "is_salary_valid": true
}
}
{- "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"
}, - "discard_note": {
- "id": 0,
- "message": "string",
- "created_at": "2020-09-20",
- "updated_at": "2020-09-20"
}, - "rows": [
- {
- "id": 0,
- "invoice_id": 0,
- "short_description": "string",
- "long_description": "string",
- "start_date": "2020-09-20T18:30:00+03:00",
- "end_date": "2020-09-20T18:30:00+03:00",
- "quantity": 0.1,
- "unit_type": "PIECE",
- "unit_price": {
- "amount": "20000",
- "currency": "EUR"
}, - "contains_vat": true,
- "total_sum_without_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_no_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "discount_type": "SUM",
- "discount_percent": 0,
- "discount_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": 0,
- "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum_without_vat_before_discount": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum_with_vat_before_discount": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "row_type": "RECEIPT_EXPENSE"
}
], - "team_members": [
- {
- "name": "Maija Meikäläinen",
- "email": "team.member@mail.com",
- "percent": "20.8",
- "amount": {
- "amount": "2000",
- "currency": "EUR"
}, - "is_owner": true
}
], - "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"
]
}
}
]
}
], - "can": [
- {
- "": {
- "allowed": "true",
- "reasons": [
- "terms_of_service_not_signed"
]
}
}
]
}
}
invoice_id required | integer Invoice id from which the credit note is created from |
{- "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"
}, - "discard_note": {
- "id": 0,
- "message": "string",
- "created_at": "2020-09-20",
- "updated_at": "2020-09-20"
}, - "rows": [
- {
- "id": 0,
- "invoice_id": 0,
- "short_description": "string",
- "long_description": "string",
- "start_date": "2020-09-20T18:30:00+03:00",
- "end_date": "2020-09-20T18:30:00+03:00",
- "quantity": 0.1,
- "unit_type": "PIECE",
- "unit_price": {
- "amount": "20000",
- "currency": "EUR"
}, - "contains_vat": true,
- "total_sum_without_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_no_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "discount_type": "SUM",
- "discount_percent": 0,
- "discount_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": 0,
- "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum_without_vat_before_discount": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum_with_vat_before_discount": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "row_type": "RECEIPT_EXPENSE"
}
], - "team_members": [
- {
- "name": "Maija Meikäläinen",
- "email": "team.member@mail.com",
- "percent": "20.8",
- "amount": {
- "amount": "2000",
- "currency": "EUR"
}, - "is_owner": true
}
], - "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"
]
}
}
]
}
], - "can": [
- {
- "": {
- "allowed": "true",
- "reasons": [
- "terms_of_service_not_signed"
]
}
}
]
}
}
{- "data": [
- {
- "id": 0,
- "invoice": [
- {
- "id": 0,
- "is_editable": true
}
], - "client_description": "string",
- "start_date": "2020-09-20T18:30:00+03:00",
- "end_date": "2020-09-20T18:30:00+03:00",
- "type": "string",
- "status": "DRAFT",
- "allowances": {
- "kilometers": {
- "kilometers_amount": 0
}
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "first_routepoint_address": "string",
- "last_routepoint_address": "string",
- "is_editable": true,
- "is_deletable": true
}
]
}
trip required | integer Trip ID |
travel_day required | integer Trip ID |
{- "data": [
- {
- "id": 0,
- "travel_day_id": 0,
- "position": 0,
- "address": "string",
- "is_rough_terrain": true,
- "has_heavy_load": true,
- "trailer_type": "string",
- "vehicle_type": "string",
- "register_plate": "string",
- "distance_to_next_route_point": 0,
- "explanation": "string",
- "passengers": [
- {
- "id": 0,
- "first_name": "string",
- "last_name": "string"
}
], - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}
], - "links": {
}, - "meta": {
- "current_page": "1",
- "from": "1",
- "last_page": "12",
- "path": "string",
- "per_page": "100",
- "to": "10",
- "total": "116"
}
}
trip_id required | integer Trip ID |
travel_day_id required | integer Trip ID |
Route Point
Array of objects (Travel expense route) |
{- "": [
- {
- "address": "string",
- "latitude": "string",
- "longitude": "string",
- "purpose_explanation": "string",
- "rough_terrain": true
}
]
}
{- "": {
- "data": [
- {
- "id": 0,
- "travel_day_id": 0,
- "position": 0,
- "address": "string",
- "is_rough_terrain": true,
- "has_heavy_load": true,
- "trailer_type": "string",
- "vehicle_type": "string",
- "register_plate": "string",
- "distance_to_next_route_point": 0,
- "explanation": "string",
- "passengers": [
- {
- "id": 0,
- "first_name": "string",
- "last_name": "string"
}
], - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}
], - "links": {
}, - "meta": {
- "current_page": "1",
- "from": "1",
- "last_page": "12",
- "path": "string",
- "per_page": "100",
- "to": "10",
- "total": "116"
}
}
}
{- "data": [
- {
- "id": 0,
- "trip_id": 0,
- "country": {
- "name": "string",
- "code": "string"
}, - "city": {
- "name": "string",
- "code": "string"
}, - "apply_for_kilometer_allowances": true,
- "apply_for_daily_allowances": true,
- "is_roundtrip": true,
- "provided_free_meals": 0,
- "allowances": {
- "daily": {
- "per_diem_partial_100_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_partial_100_percent_amount": 0,
- "per_diem_partial_50_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_partial_50_percent_amount": 0,
- "per_diem_full_100_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_full_100_percent_amount": 0,
- "per_diem_full_50_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_full_50_percent_amount": 0
}, - "last_day_extra_daily": {
- "per_diem_partial_100_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_partial_100_percent_amount": 0,
- "per_diem_partial_50_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_partial_50_percent_amount": 0,
- "per_diem_full_100_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_full_100_percent_amount": 0,
- "per_diem_full_50_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_full_50_percent_amount": 0
}, - "kilometers": {
- "kilometers_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "kilometers_amount": 0
}, - "meals": {
- "meal_money_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "meal_money_amount": 0
}
}, - "work_time": 1440,
- "created_at": "2020-09-20T18:30:00+03:00",
- "updated_at": "2020-09-20T18:30:00+03:00",
- "start_date": "2020-09-20T18:30:00+03:00",
- "end_date": "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"
}
}
trip_id required | integer Trip ID |
travel_day_id required | integer Trip ID |
Trip's travel day
travel_end_date | string (Date) date in Y-m-d format |
travel_start_time | string (Time) time in H:i:s format |
travel_end_time | string (Time) time in H:i:s format |
apply_for_daily_allowances | boolean Does this travel day include daily allowances (haen_päivärahoja) |
apply_for_kilometer_allowances | boolean Does this travel day include kilometer allowances (haen_kilometri_korvauksia) |
apply_for_meal_money | boolean Does this travel day include meal allowances (haen_ateria_korvauksia) |
is_roundtrip | boolean is this travel day a round trip |
provided_free_meals | integer Amount of free meals |
work_time | integer Work time in minutes |
{- "travel_end_date": "2020-09-20",
- "travel_start_time": "18:30:00",
- "travel_end_time": "18:30:00",
- "apply_for_daily_allowances": true,
- "apply_for_kilometer_allowances": true,
- "apply_for_meal_money": true,
- "is_roundtrip": true,
- "provided_free_meals": "0, 1, 2",
- "work_time": "1440"
}
{- "data": [
- {
- "id": 0,
- "trip_id": 0,
- "country": {
- "name": "string",
- "code": "string"
}, - "city": {
- "name": "string",
- "code": "string"
}, - "apply_for_kilometer_allowances": true,
- "apply_for_daily_allowances": true,
- "is_roundtrip": true,
- "provided_free_meals": 0,
- "allowances": {
- "daily": {
- "per_diem_partial_100_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_partial_100_percent_amount": 0,
- "per_diem_partial_50_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_partial_50_percent_amount": 0,
- "per_diem_full_100_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_full_100_percent_amount": 0,
- "per_diem_full_50_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_full_50_percent_amount": 0
}, - "last_day_extra_daily": {
- "per_diem_partial_100_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_partial_100_percent_amount": 0,
- "per_diem_partial_50_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_partial_50_percent_amount": 0,
- "per_diem_full_100_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_full_100_percent_amount": 0,
- "per_diem_full_50_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_full_50_percent_amount": 0
}, - "kilometers": {
- "kilometers_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "kilometers_amount": 0
}, - "meals": {
- "meal_money_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "meal_money_amount": 0
}
}, - "work_time": 1440,
- "created_at": "2020-09-20T18:30:00+03:00",
- "updated_at": "2020-09-20T18:30:00+03:00",
- "start_date": "2020-09-20T18:30:00+03:00",
- "end_date": "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"
}
}
trip_id required | integer Trip's id |
travel_day_id required | integer Travel Day's id |
{- "id": 0,
- "trip_id": 0,
- "country": {
- "name": "string",
- "code": "string"
}, - "city": {
- "name": "string",
- "code": "string"
}, - "apply_for_kilometer_allowances": true,
- "apply_for_daily_allowances": true,
- "is_roundtrip": true,
- "provided_free_meals": 0,
- "allowances": {
- "daily": {
- "per_diem_partial_100_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_partial_100_percent_amount": 0,
- "per_diem_partial_50_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_partial_50_percent_amount": 0,
- "per_diem_full_100_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_full_100_percent_amount": 0,
- "per_diem_full_50_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_full_50_percent_amount": 0
}, - "last_day_extra_daily": {
- "per_diem_partial_100_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_partial_100_percent_amount": 0,
- "per_diem_partial_50_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_partial_50_percent_amount": 0,
- "per_diem_full_100_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_full_100_percent_amount": 0,
- "per_diem_full_50_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_full_50_percent_amount": 0
}, - "kilometers": {
- "kilometers_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "kilometers_amount": 0
}, - "meals": {
- "meal_money_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "meal_money_amount": 0
}
}, - "work_time": 1440,
- "created_at": "2020-09-20T18:30:00+03:00",
- "updated_at": "2020-09-20T18:30:00+03:00",
- "start_date": "2020-09-20T18:30:00+03:00",
- "end_date": "2020-09-20T18:30:00+03:00"
}
trip_id required | integer Trip's id |
travel_day_id required | integer Travel Day's id |
{- "total_travel_day_count": 0,
- "allowances": {
- "daily": {
- "per_diem_partial_100_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_partial_100_percent_amount": 0,
- "per_diem_partial_50_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_partial_50_percent_amount": 0,
- "per_diem_full_100_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_full_100_percent_amount": 0,
- "per_diem_full_50_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_full_50_percent_amount": 0
}, - "last_day_extra_daily": {
- "per_diem_partial_100_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_partial_100_percent_amount": 0,
- "per_diem_partial_50_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_partial_50_percent_amount": 0,
- "per_diem_full_100_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_full_100_percent_amount": 0,
- "per_diem_full_50_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_full_50_percent_amount": 0
}, - "kilometers": {
- "kilometers_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "kilometers_amount": 0
}, - "meals": {
- "meal_money_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "meal_money_amount": 0
}
}
}
trip_id required | integer Trip's id |
travel_day_id required | integer Travel Day's id |
Allowance request
object |
{- "allowances": {
- "daily": {
- "per_diem_partial_100_percent_amount": 0,
- "per_diem_partial_50_percent_amount": 0,
- "per_diem_full_100_percent_amount": 0,
- "per_diem_full_50_percent_amount": 0
}, - "last_day_extra_daily": {
- "per_diem_partial_100_percent_amount": 0,
- "per_diem_partial_50_percent_amount": 0,
- "per_diem_full_100_percent_amount": 0,
- "per_diem_full_50_percent_amount": 0
}, - "meals": {
- "meal_money_amount": 0
}
}
}
{- "id": 0,
- "trip_id": 0,
- "country": {
- "name": "string",
- "code": "string"
}, - "city": {
- "name": "string",
- "code": "string"
}, - "apply_for_kilometer_allowances": true,
- "apply_for_daily_allowances": true,
- "is_roundtrip": true,
- "provided_free_meals": 0,
- "allowances": {
- "daily": {
- "per_diem_partial_100_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_partial_100_percent_amount": 0,
- "per_diem_partial_50_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_partial_50_percent_amount": 0,
- "per_diem_full_100_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_full_100_percent_amount": 0,
- "per_diem_full_50_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_full_50_percent_amount": 0
}, - "last_day_extra_daily": {
- "per_diem_partial_100_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_partial_100_percent_amount": 0,
- "per_diem_partial_50_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_partial_50_percent_amount": 0,
- "per_diem_full_100_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_full_100_percent_amount": 0,
- "per_diem_full_50_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_full_50_percent_amount": 0
}, - "kilometers": {
- "kilometers_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "kilometers_amount": 0
}, - "meals": {
- "meal_money_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "meal_money_amount": 0
}
}, - "work_time": 1440,
- "created_at": "2020-09-20T18:30:00+03:00",
- "updated_at": "2020-09-20T18:30:00+03:00",
- "start_date": "2020-09-20T18:30:00+03:00",
- "end_date": "2020-09-20T18:30:00+03:00"
}
trip_id required | integer Trip's id |
travel_day_id required | integer Travel Day's id |
{- "data": [
- {
- "id": 0,
- "trip_id": 0,
- "country": {
- "name": "string",
- "code": "string"
}, - "city": {
- "name": "string",
- "code": "string"
}, - "apply_for_kilometer_allowances": true,
- "apply_for_daily_allowances": true,
- "is_roundtrip": true,
- "provided_free_meals": 0,
- "allowances": {
- "daily": {
- "per_diem_partial_100_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_partial_100_percent_amount": 0,
- "per_diem_partial_50_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_partial_50_percent_amount": 0,
- "per_diem_full_100_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_full_100_percent_amount": 0,
- "per_diem_full_50_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_full_50_percent_amount": 0
}, - "last_day_extra_daily": {
- "per_diem_partial_100_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_partial_100_percent_amount": 0,
- "per_diem_partial_50_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_partial_50_percent_amount": 0,
- "per_diem_full_100_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_full_100_percent_amount": 0,
- "per_diem_full_50_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_full_50_percent_amount": 0
}, - "kilometers": {
- "kilometers_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "kilometers_amount": 0
}, - "meals": {
- "meal_money_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "meal_money_amount": 0
}
}, - "work_time": 1440,
- "created_at": "2020-09-20T18:30:00+03:00",
- "updated_at": "2020-09-20T18:30:00+03:00",
- "start_date": "2020-09-20T18:30:00+03:00",
- "end_date": "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"
}
}
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 |
page | integer Pagination page id |
limit | integer Example: limit=50 Limit per page. Default 50, max 1000 |
sort | string Example: sort=-start_date Sort by ascending order, add '-' prefix to get descending order, ie. -total. |
filter[*field_name*] | string Filter fields. Array of filtered fields, so filter[common_search] = 'Foo' or '5.00` etc filter[client_description] = 'Foo', filter[work_description] = 'Bar', filter[search_date_between] = 2022-01-01|2022-01-31. If you omit the start date use |2022-01-31. NOTE: This is an AND search |
{- "data": [
- {
- "id": 0,
- "invoice_id": 0,
- "default_country": "FI",
- "default_city_id": 0,
- "invoice_from_customer": true,
- "apply_for_kilometers": true,
- "apply_for_allowances": true,
- "client_description": "string",
- "work_description": "string",
- "type": "string",
- "additional_information": "string",
- "start_date": "2020-09-20T18:30:00+03:00",
- "end_date": "2020-09-20T18:30:00+03:00",
- "default_vehicle_register_plate": "string",
- "default_vehicle_type": "CAR",
- "status": "DRAFT",
- "allowances": {
- "kilometers": {
- "kilometers_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "kilometers_amount": 0
}, - "daily": {
- "per_diem_partial_100_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_partial_100_percent_amount": 0,
- "per_diem_partial_50_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_partial_50_percent_amount": 0,
- "per_diem_full_100_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_full_100_percent_amount": 0,
- "per_diem_full_50_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_full_50_percent_amount": 0
}, - "meals": {
- "meal_money_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "meal_money_amount": 0
}
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "first_routepoint_address": "string",
- "last_routepoint_address": "string",
- "created_at": "2020-09-20T18:30:00+03:00",
- "updated_at": "2020-09-20T18:30:00+03:00",
- "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
}
], - "action_message": [
- {
- "id": 0,
- "user_id": 0,
- "action": "string",
- "message": "string"
}
]
}
], - "links": {
}, - "meta": {
- "current_page": "1",
- "from": "1",
- "last_page": "12",
- "path": "string",
- "per_page": "100",
- "to": "10",
- "total": "116"
}
}
{- "id": 0,
- "invoice_id": 0,
- "default_country": "FI",
- "default_city_id": 0,
- "invoice_from_customer": true,
- "apply_for_kilometers": true,
- "apply_for_allowances": true,
- "client_description": "string",
- "work_description": "string",
- "type": "string",
- "additional_information": "string",
- "start_date": "2020-09-20T18:30:00+03:00",
- "end_date": "2020-09-20T18:30:00+03:00",
- "default_vehicle_register_plate": "string",
- "default_vehicle_type": "CAR",
- "status": "DRAFT",
- "allowances": {
- "kilometers": {
- "kilometers_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "kilometers_amount": 0
}, - "daily": {
- "per_diem_partial_100_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_partial_100_percent_amount": 0,
- "per_diem_partial_50_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_partial_50_percent_amount": 0,
- "per_diem_full_100_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_full_100_percent_amount": 0,
- "per_diem_full_50_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_full_50_percent_amount": 0
}, - "meals": {
- "meal_money_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "meal_money_amount": 0
}
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "first_routepoint_address": "string",
- "last_routepoint_address": "string",
- "created_at": "2020-09-20T18:30:00+03:00",
- "updated_at": "2020-09-20T18:30:00+03:00",
- "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
}
], - "action_message": [
- {
- "id": 0,
- "user_id": 0,
- "action": "string",
- "message": "string"
}
]
}
Travel Expense Trip
apply_for_allowances | boolean Does this travel expense include daily allowances (haen_päivärahoja) |
apply_for_kilometers | boolean Does this travel expense include kilometer allowances (haen_kilometrejä) |
default_country | string (Takes ISO code of the country in countries table and saves id in the database) |
default_city_id | integer Id of the city in cities table (GET /countries endpoint returns all caountries and their cities name and id) |
client_description | string Customers name or work item |
work_description | string Description of the work that was done |
additional_information | string Additional information |
type | string Enum: "MULTI_DAY" "PER_DAY" Type of the trip |
start_date | string (DateTime) date time in Y-m-d\TH:i:sP format |
end_date | string (DateTime) date time in Y-m-d\TH:i:sP format |
register_plate | string Is one-day trip from home / work back to home or work instead of spanning into one long multi-day trip? |
vehicle_type | string (VehicleType) Enum: "CAR" "MOTOR_BOAT_MAX_50_HP" "MOTOR_BOAT_OVER_50_HP" "SNOWMOBILE" "ATV" "MOTORCYCLE" "MOPED" "BICYCLE" Type of vehicle |
{- "apply_for_allowances": true,
- "apply_for_kilometers": true,
- "default_country": "FI",
- "default_city_id": 0,
- "client_description": "string",
- "work_description": "string",
- "additional_information": "string",
- "type": "MULTI_DAY",
- "start_date": "2020-09-20T18:30:00+03:00",
- "end_date": "2020-09-20T18:30:00+03:00",
- "register_plate": "BOI-111",
- "vehicle_type": "CAR"
}
{- "data": {
- "id": 0,
- "invoice_id": 0,
- "default_country": "FI",
- "default_city_id": 0,
- "invoice_from_customer": true,
- "apply_for_kilometers": true,
- "apply_for_allowances": true,
- "client_description": "string",
- "work_description": "string",
- "type": "string",
- "additional_information": "string",
- "start_date": "2020-09-20T18:30:00+03:00",
- "end_date": "2020-09-20T18:30:00+03:00",
- "default_vehicle_register_plate": "string",
- "default_vehicle_type": "CAR",
- "status": "DRAFT",
- "allowances": {
- "kilometers": {
- "kilometers_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "kilometers_amount": 0
}, - "daily": {
- "per_diem_partial_100_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_partial_100_percent_amount": 0,
- "per_diem_partial_50_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_partial_50_percent_amount": 0,
- "per_diem_full_100_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_full_100_percent_amount": 0,
- "per_diem_full_50_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_full_50_percent_amount": 0
}, - "meals": {
- "meal_money_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "meal_money_amount": 0
}
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "first_routepoint_address": "string",
- "last_routepoint_address": "string",
- "created_at": "2020-09-20T18:30:00+03:00",
- "updated_at": "2020-09-20T18:30:00+03:00",
- "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
}
], - "action_message": [
- {
- "id": 0,
- "user_id": 0,
- "action": "string",
- "message": "string"
}
]
}
}
trip required | integer Trips's id |
Travel Expense Trip
apply_for_allowances | boolean Does this travel expense include daily allowances (haen_päivärahoja) |
apply_for_kilometers | boolean Does this travel expense include kilometer allowances (haen_kilometrejä) |
default_country | string (Takes ISO code of the country in countries table and saves id in the database) |
default_city_id | integer Id of the city in cities table (GET /countries endpoint returns all caountries and their cities name and id) |
client_description | string Customers name or work item |
work_description | string Description of the work that was done |
additional_information | string Additional information |
type | string Enum: "MULTI_DAY" "PER_DAY" Type of the trip |
start_date | string (DateTime) date time in Y-m-d\TH:i:sP format |
end_date | string (DateTime) date time in Y-m-d\TH:i:sP format |
register_plate | string Is one-day trip from home / work back to home or work instead of spanning into one long multi-day trip? |
vehicle_type | string (VehicleType) Enum: "CAR" "MOTOR_BOAT_MAX_50_HP" "MOTOR_BOAT_OVER_50_HP" "SNOWMOBILE" "ATV" "MOTORCYCLE" "MOPED" "BICYCLE" Type of vehicle |
{- "apply_for_allowances": true,
- "apply_for_kilometers": true,
- "default_country": "FI",
- "default_city_id": 0,
- "client_description": "string",
- "work_description": "string",
- "additional_information": "string",
- "type": "MULTI_DAY",
- "start_date": "2020-09-20T18:30:00+03:00",
- "end_date": "2020-09-20T18:30:00+03:00",
- "register_plate": "BOI-111",
- "vehicle_type": "CAR"
}
travel_expense_id required | integer Travel expense's id |
Travel Expense Trip
apply_for_allowances | boolean Does this travel expense include daily allowances (haen_päivärahoja) |
apply_for_kilometers | boolean Does this travel expense include kilometer allowances (haen_kilometrejä) |
default_country | string (Takes ISO code of the country in countries table and saves id in the database) |
default_city_id | integer Id of the city in cities table (GET /countries endpoint returns all caountries and their cities name and id) |
client_description | string Customers name or work item |
work_description | string Description of the work that was done |
additional_information | string Additional information |
type | string Enum: "MULTI_DAY" "PER_DAY" Type of the trip |
start_date | string (DateTime) date time in Y-m-d\TH:i:sP format |
end_date | string (DateTime) date time in Y-m-d\TH:i:sP format |
register_plate | string Is one-day trip from home / work back to home or work instead of spanning into one long multi-day trip? |
vehicle_type | string (VehicleType) Enum: "CAR" "MOTOR_BOAT_MAX_50_HP" "MOTOR_BOAT_OVER_50_HP" "SNOWMOBILE" "ATV" "MOTORCYCLE" "MOPED" "BICYCLE" Type of vehicle |
{- "apply_for_allowances": true,
- "apply_for_kilometers": true,
- "default_country": "FI",
- "default_city_id": 0,
- "client_description": "string",
- "work_description": "string",
- "additional_information": "string",
- "type": "MULTI_DAY",
- "start_date": "2020-09-20T18:30:00+03:00",
- "end_date": "2020-09-20T18:30:00+03:00",
- "register_plate": "BOI-111",
- "vehicle_type": "CAR"
}
{- "data": {
- "id": 0,
- "invoice_id": 0,
- "default_country": "FI",
- "default_city_id": 0,
- "invoice_from_customer": true,
- "apply_for_kilometers": true,
- "apply_for_allowances": true,
- "client_description": "string",
- "work_description": "string",
- "type": "string",
- "additional_information": "string",
- "start_date": "2020-09-20T18:30:00+03:00",
- "end_date": "2020-09-20T18:30:00+03:00",
- "default_vehicle_register_plate": "string",
- "default_vehicle_type": "CAR",
- "status": "DRAFT",
- "allowances": {
- "kilometers": {
- "kilometers_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "kilometers_amount": 0
}, - "daily": {
- "per_diem_partial_100_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_partial_100_percent_amount": 0,
- "per_diem_partial_50_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_partial_50_percent_amount": 0,
- "per_diem_full_100_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_full_100_percent_amount": 0,
- "per_diem_full_50_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_full_50_percent_amount": 0
}, - "meals": {
- "meal_money_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "meal_money_amount": 0
}
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "first_routepoint_address": "string",
- "last_routepoint_address": "string",
- "created_at": "2020-09-20T18:30:00+03:00",
- "updated_at": "2020-09-20T18:30:00+03:00",
- "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
}
], - "action_message": [
- {
- "id": 0,
- "user_id": 0,
- "action": "string",
- "message": "string"
}
]
}
}
trip_id required | integer Trip's id |
invoice_id required | integer Invoice's id |
{- "data": {
- "id": 0,
- "invoice_id": 0,
- "default_country": "FI",
- "default_city_id": 0,
- "invoice_from_customer": true,
- "apply_for_kilometers": true,
- "apply_for_allowances": true,
- "client_description": "string",
- "work_description": "string",
- "type": "string",
- "additional_information": "string",
- "start_date": "2020-09-20T18:30:00+03:00",
- "end_date": "2020-09-20T18:30:00+03:00",
- "default_vehicle_register_plate": "string",
- "default_vehicle_type": "CAR",
- "status": "DRAFT",
- "allowances": {
- "kilometers": {
- "kilometers_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "kilometers_amount": 0
}, - "daily": {
- "per_diem_partial_100_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_partial_100_percent_amount": 0,
- "per_diem_partial_50_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_partial_50_percent_amount": 0,
- "per_diem_full_100_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_full_100_percent_amount": 0,
- "per_diem_full_50_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_full_50_percent_amount": 0
}, - "meals": {
- "meal_money_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "meal_money_amount": 0
}
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "first_routepoint_address": "string",
- "last_routepoint_address": "string",
- "created_at": "2020-09-20T18:30:00+03:00",
- "updated_at": "2020-09-20T18:30:00+03:00",
- "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
}
], - "action_message": [
- {
- "id": 0,
- "user_id": 0,
- "action": "string",
- "message": "string"
}
]
}
}
Calculate and save sums to Trip from the Trip's TravelDays
trip_id required | integer Trip's id |
{- "data": {
- "id": 0,
- "invoice_id": 0,
- "default_country": "FI",
- "default_city_id": 0,
- "invoice_from_customer": true,
- "apply_for_kilometers": true,
- "apply_for_allowances": true,
- "client_description": "string",
- "work_description": "string",
- "type": "string",
- "additional_information": "string",
- "start_date": "2020-09-20T18:30:00+03:00",
- "end_date": "2020-09-20T18:30:00+03:00",
- "default_vehicle_register_plate": "string",
- "default_vehicle_type": "CAR",
- "status": "DRAFT",
- "allowances": {
- "kilometers": {
- "kilometers_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "kilometers_amount": 0
}, - "daily": {
- "per_diem_partial_100_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_partial_100_percent_amount": 0,
- "per_diem_partial_50_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_partial_50_percent_amount": 0,
- "per_diem_full_100_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_full_100_percent_amount": 0,
- "per_diem_full_50_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_full_50_percent_amount": 0
}, - "meals": {
- "meal_money_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "meal_money_amount": 0
}
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "first_routepoint_address": "string",
- "last_routepoint_address": "string",
- "created_at": "2020-09-20T18:30:00+03:00",
- "updated_at": "2020-09-20T18:30:00+03:00",
- "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
}
], - "action_message": [
- {
- "id": 0,
- "user_id": 0,
- "action": "string",
- "message": "string"
}
]
}
}
Overview data for trip
trip_id required | integer Trip's id |
{- "data": {
- "id": 0,
- "invoice_id": 0,
- "default_country": "FI",
- "default_city_id": 0,
- "invoice_from_customer": true,
- "apply_for_kilometers": true,
- "apply_for_allowances": true,
- "client_description": "string",
- "work_description": "string",
- "type": "string",
- "additional_information": "string",
- "start_date": "2020-09-20T18:30:00+03:00",
- "end_date": "2020-09-20T18:30:00+03:00",
- "default_vehicle_register_plate": "string",
- "default_vehicle_type": "CAR",
- "status": "DRAFT",
- "allowances": {
- "kilometers": {
- "kilometers_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "kilometers_amount": 0
}, - "daily": {
- "per_diem_partial_100_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_partial_100_percent_amount": 0,
- "per_diem_partial_50_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_partial_50_percent_amount": 0,
- "per_diem_full_100_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_full_100_percent_amount": 0,
- "per_diem_full_50_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_full_50_percent_amount": 0
}, - "meals": {
- "meal_money_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "meal_money_amount": 0
}
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "first_routepoint_address": "string",
- "last_routepoint_address": "string",
- "created_at": "2020-09-20T18:30:00+03:00",
- "updated_at": "2020-09-20T18:30:00+03:00",
- "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
}
], - "action_message": [
- {
- "id": 0,
- "user_id": 0,
- "action": "string",
- "message": "string"
}
], - "default_country_id": 0,
- "": {
- "kilometers": {
- "kilometers_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "kilometers_amount": 0
}, - "daily": {
- "per_diem_partial_100_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_partial_100_percent_amount": 0,
- "per_diem_partial_50_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_partial_50_percent_amount": 0,
- "per_diem_full_100_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_full_100_percent_amount": 0,
- "per_diem_full_50_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_full_50_percent_amount": 0
}, - "meals": {
- "meal_money_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "meal_money_amount": 0
}
}, - "travel_days": [
- {
- "id": 0,
- "trip_id": 0,
- "country": {
- "name": "string",
- "code": "string"
}, - "city": {
- "name": "string",
- "code": "string"
}, - "apply_for_kilometer_allowances": true,
- "apply_for_daily_allowances": true,
- "is_roundtrip": true,
- "provided_free_meals": 0,
- "allowances": {
- "daily": {
- "per_diem_partial_100_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_partial_100_percent_amount": 0,
- "per_diem_partial_50_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_partial_50_percent_amount": 0,
- "per_diem_full_100_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_full_100_percent_amount": 0,
- "per_diem_full_50_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_full_50_percent_amount": 0
}, - "last_day_extra_daily": {
- "per_diem_partial_100_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_partial_100_percent_amount": 0,
- "per_diem_partial_50_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_partial_50_percent_amount": 0,
- "per_diem_full_100_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_full_100_percent_amount": 0,
- "per_diem_full_50_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_full_50_percent_amount": 0
}, - "kilometers": {
- "kilometers_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "kilometers_amount": 0
}, - "meals": {
- "meal_money_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "meal_money_amount": 0
}
}, - "work_time": 1440,
- "created_at": "2020-09-20T18:30:00+03:00",
- "updated_at": "2020-09-20T18:30:00+03:00",
- "start_date": "2020-09-20T18:30:00+03:00",
- "end_date": "2020-09-20T18:30:00+03:00"
}
]
}
}
Duplicates Trip, TravelDays, RoutePoints and Passengers
trip_id required | integer Original trip's id |
{ }
{- "data": {
- "id": 0,
- "invoice_id": 0,
- "default_country": "FI",
- "default_city_id": 0,
- "invoice_from_customer": true,
- "apply_for_kilometers": true,
- "apply_for_allowances": true,
- "client_description": "string",
- "work_description": "string",
- "type": "string",
- "additional_information": "string",
- "start_date": "2020-09-20T18:30:00+03:00",
- "end_date": "2020-09-20T18:30:00+03:00",
- "default_vehicle_register_plate": "string",
- "default_vehicle_type": "CAR",
- "status": "DRAFT",
- "allowances": {
- "kilometers": {
- "kilometers_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "kilometers_amount": 0
}, - "daily": {
- "per_diem_partial_100_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_partial_100_percent_amount": 0,
- "per_diem_partial_50_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_partial_50_percent_amount": 0,
- "per_diem_full_100_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_full_100_percent_amount": 0,
- "per_diem_full_50_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "per_diem_full_50_percent_amount": 0
}, - "meals": {
- "meal_money_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "meal_money_amount": 0
}
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "first_routepoint_address": "string",
- "last_routepoint_address": "string",
- "created_at": "2020-09-20T18:30:00+03:00",
- "updated_at": "2020-09-20T18:30:00+03:00",
- "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
}
], - "action_message": [
- {
- "id": 0,
- "user_id": 0,
- "action": "string",
- "message": "string"
}
]
}
}
{- "data": [
- {
- "id": 0,
- "purpose_of_trip": "Alkusammuttimen tarkastus & huolto",
- "trip_destination": "Itämerenkatu 1, 00180 Helsinki",
- "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
}
], - "timespan": "PER_DAY",
- "country": "FI",
- "daily_allowance_city_id": "123",
- "start_date": "2020-09-20T18:30:00+03:00",
- "end_date": "2020-09-20T18:30:00+03:00",
- "whole_trip_start_date": "2020-09-20T18:30:00+03:00",
- "whole_trip_end_date": "2020-09-20T18:30:00+03:00",
- "provided_free_meals": 0,
- "work_time": 0,
- "assure_work_is_temporary": true,
- "additional_info": "string",
- "include_to_invoice_row": true,
- "is_round_trip": true,
- "status": "string",
- "vehicle": {
- "register_number": "BOI-111",
- "type": "CAR",
- "options": [
- "'HEAVY_LOAD', 'TRAILER'"
]
}, - "calculate_kilometer_allowances": true,
- "calculate_daily_allowances": true,
- "calculate_meal_allowances": true,
- "routes": [
- {
- "address": "string",
- "latitude": "string",
- "longitude": "string",
- "purpose_explanation": "string",
- "rough_terrain": true
}
], - "passengers": [
- {
- "id": 0,
- "first_name": "string",
- "last_name": "string",
- "full_name": "string",
- "description": "string",
- "travel_expense_id": "string"
}
], - "allowances": {
- "kilometers": {
- "distance_in_meters": "125000"
}, - "meals": {
- "amount": "0, 1, 2"
}, - "daily": {
- "full_day_100_percent_amount": "0, 1 or 2",
- "full_day_100_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "full_day_50_percent_amount": "0, 1 or 2",
- "full_day_50_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "half_day_100_percent_amount": "0, 1 or 2",
- "half_day_100_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "half_day_50_percent_amount": "0, 1 or 2",
- "half_day_50_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}
}, - "rejection_note": {
- "id": 0,
- "message": "string",
- "created_at": "2020-09-20",
- "updated_at": "2020-09-20"
}, - "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,
- "purpose_of_trip": "Alkusammuttimen tarkastus & huolto",
- "trip_destination": "Itämerenkatu 1, 00180 Helsinki",
- "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
}
], - "timespan": "PER_DAY",
- "country": "FI",
- "daily_allowance_city_id": "123",
- "start_date": "2020-09-20T18:30:00+03:00",
- "end_date": "2020-09-20T18:30:00+03:00",
- "whole_trip_start_date": "2020-09-20T18:30:00+03:00",
- "whole_trip_end_date": "2020-09-20T18:30:00+03:00",
- "provided_free_meals": 0,
- "work_time": 0,
- "assure_work_is_temporary": true,
- "additional_info": "string",
- "include_to_invoice_row": true,
- "is_round_trip": true,
- "status": "string",
- "vehicle": {
- "register_number": "BOI-111",
- "type": "CAR",
- "options": [
- "'HEAVY_LOAD', 'TRAILER'"
]
}, - "calculate_kilometer_allowances": true,
- "calculate_daily_allowances": true,
- "calculate_meal_allowances": true,
- "routes": [
- {
- "address": "string",
- "latitude": "string",
- "longitude": "string",
- "purpose_explanation": "string",
- "rough_terrain": true
}
], - "passengers": [
- {
- "id": 0,
- "first_name": "string",
- "last_name": "string",
- "full_name": "string",
- "description": "string",
- "travel_expense_id": "string"
}
], - "allowances": {
- "kilometers": {
- "distance_in_meters": "125000"
}, - "meals": {
- "amount": "0, 1, 2"
}, - "daily": {
- "full_day_100_percent_amount": "0, 1 or 2",
- "full_day_100_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "full_day_50_percent_amount": "0, 1 or 2",
- "full_day_50_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "half_day_100_percent_amount": "0, 1 or 2",
- "half_day_100_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "half_day_50_percent_amount": "0, 1 or 2",
- "half_day_50_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}
}, - "rejection_note": {
- "id": 0,
- "message": "string",
- "created_at": "2020-09-20",
- "updated_at": "2020-09-20"
}, - "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"
]
}
}
]
}
]
}
}
parent_travel_expense_id required | integer Parent travel expense's id |
{- "data": [
- {
- "id": 0,
- "purpose_of_trip": "Alkusammuttimen tarkastus & huolto",
- "trip_destination": "Itämerenkatu 1, 00180 Helsinki",
- "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
}
], - "timespan": "PER_DAY",
- "country": "FI",
- "daily_allowance_city_id": "123",
- "start_date": "2020-09-20T18:30:00+03:00",
- "end_date": "2020-09-20T18:30:00+03:00",
- "whole_trip_start_date": "2020-09-20T18:30:00+03:00",
- "whole_trip_end_date": "2020-09-20T18:30:00+03:00",
- "provided_free_meals": 0,
- "work_time": 0,
- "assure_work_is_temporary": true,
- "additional_info": "string",
- "include_to_invoice_row": true,
- "is_round_trip": true,
- "status": "string",
- "vehicle": {
- "register_number": "BOI-111",
- "type": "CAR",
- "options": [
- "'HEAVY_LOAD', 'TRAILER'"
]
}, - "calculate_kilometer_allowances": true,
- "calculate_daily_allowances": true,
- "calculate_meal_allowances": true,
- "routes": [
- {
- "address": "string",
- "latitude": "string",
- "longitude": "string",
- "purpose_explanation": "string",
- "rough_terrain": true
}
], - "passengers": [
- {
- "id": 0,
- "first_name": "string",
- "last_name": "string",
- "full_name": "string",
- "description": "string",
- "travel_expense_id": "string"
}
], - "allowances": {
- "kilometers": {
- "distance_in_meters": "125000"
}, - "meals": {
- "amount": "0, 1, 2"
}, - "daily": {
- "full_day_100_percent_amount": "0, 1 or 2",
- "full_day_100_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "full_day_50_percent_amount": "0, 1 or 2",
- "full_day_50_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "half_day_100_percent_amount": "0, 1 or 2",
- "half_day_100_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "half_day_50_percent_amount": "0, 1 or 2",
- "half_day_50_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}
}, - "rejection_note": {
- "id": 0,
- "message": "string",
- "created_at": "2020-09-20",
- "updated_at": "2020-09-20"
}, - "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"
]
}
}
]
}
]
}
], - "links": {
}, - "meta": {
- "current_page": "1",
- "from": "1",
- "last_page": "12",
- "path": "string",
- "per_page": "100",
- "to": "10",
- "total": "116"
}
}
child_travel_expense_id required | integer Child travel expense's id |
{- "id": 0,
- "purpose_of_trip": "Alkusammuttimen tarkastus & huolto",
- "trip_destination": "Itämerenkatu 1, 00180 Helsinki",
- "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
}
], - "timespan": "PER_DAY",
- "country": "FI",
- "daily_allowance_city_id": "123",
- "start_date": "2020-09-20T18:30:00+03:00",
- "end_date": "2020-09-20T18:30:00+03:00",
- "whole_trip_start_date": "2020-09-20T18:30:00+03:00",
- "whole_trip_end_date": "2020-09-20T18:30:00+03:00",
- "provided_free_meals": 0,
- "work_time": 0,
- "assure_work_is_temporary": true,
- "additional_info": "string",
- "include_to_invoice_row": true,
- "is_round_trip": true,
- "status": "string",
- "vehicle": {
- "register_number": "BOI-111",
- "type": "CAR",
- "options": [
- "'HEAVY_LOAD', 'TRAILER'"
]
}, - "calculate_kilometer_allowances": true,
- "calculate_daily_allowances": true,
- "calculate_meal_allowances": true,
- "routes": [
- {
- "address": "string",
- "latitude": "string",
- "longitude": "string",
- "purpose_explanation": "string",
- "rough_terrain": true
}
], - "passengers": [
- {
- "id": 0,
- "first_name": "string",
- "last_name": "string",
- "full_name": "string",
- "description": "string",
- "travel_expense_id": "string"
}
], - "allowances": {
- "kilometers": {
- "distance_in_meters": "125000"
}, - "meals": {
- "amount": "0, 1, 2"
}, - "daily": {
- "full_day_100_percent_amount": "0, 1 or 2",
- "full_day_100_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "full_day_50_percent_amount": "0, 1 or 2",
- "full_day_50_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "half_day_100_percent_amount": "0, 1 or 2",
- "half_day_100_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "half_day_50_percent_amount": "0, 1 or 2",
- "half_day_50_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}
}, - "rejection_note": {
- "id": 0,
- "message": "string",
- "created_at": "2020-09-20",
- "updated_at": "2020-09-20"
}, - "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"
]
}
}
]
}
]
}
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 |
page | integer Pagination page id |
limit | integer Example: limit=50 Limit per page. Default 50, max 1000 |
sort | string Example: sort=@TODO Sort by ascending order, add '-' prefix to get * descending order, ie. -total. |
filter[*field_name*] | string Filter fields. Array of filtered fields, so * filter[common_search] = 'Nuorgam' or '5.00` etc * filter[trip_destination] = 'Nuorgam' * filter[search_date_between] = 2022-01-01|2022-01-31 * If you omit the start date use |2022-01-31 * NOTE: This is an AND search |
{- "data": [
- {
- "id": 0,
- "purpose_of_trip": "Alkusammuttimen tarkastus & huolto",
- "trip_destination": "Itämerenkatu 1, 00180 Helsinki",
- "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
}
], - "timespan": "PER_DAY",
- "country": "FI",
- "daily_allowance_city_id": "123",
- "start_date": "2020-09-20T18:30:00+03:00",
- "end_date": "2020-09-20T18:30:00+03:00",
- "whole_trip_start_date": "2020-09-20T18:30:00+03:00",
- "whole_trip_end_date": "2020-09-20T18:30:00+03:00",
- "provided_free_meals": 0,
- "work_time": 0,
- "assure_work_is_temporary": true,
- "additional_info": "string",
- "include_to_invoice_row": true,
- "is_round_trip": true,
- "status": "string",
- "vehicle": {
- "register_number": "BOI-111",
- "type": "CAR",
- "options": [
- "'HEAVY_LOAD', 'TRAILER'"
]
}, - "calculate_kilometer_allowances": true,
- "calculate_daily_allowances": true,
- "calculate_meal_allowances": true,
- "routes": [
- {
- "address": "string",
- "latitude": "string",
- "longitude": "string",
- "purpose_explanation": "string",
- "rough_terrain": true
}
], - "passengers": [
- {
- "id": 0,
- "first_name": "string",
- "last_name": "string",
- "full_name": "string",
- "description": "string",
- "travel_expense_id": "string"
}
], - "allowances": {
- "kilometers": {
- "distance_in_meters": "125000"
}, - "meals": {
- "amount": "0, 1, 2"
}, - "daily": {
- "full_day_100_percent_amount": "0, 1 or 2",
- "full_day_100_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "full_day_50_percent_amount": "0, 1 or 2",
- "full_day_50_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "half_day_100_percent_amount": "0, 1 or 2",
- "half_day_100_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "half_day_50_percent_amount": "0, 1 or 2",
- "half_day_50_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}
}, - "rejection_note": {
- "id": 0,
- "message": "string",
- "created_at": "2020-09-20",
- "updated_at": "2020-09-20"
}, - "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"
]
}
}
]
}
]
}
], - "links": {
}, - "meta": {
- "current_page": "1",
- "from": "1",
- "last_page": "12",
- "path": "string",
- "per_page": "100",
- "to": "10",
- "total": "116"
}
}
travel_expense_id required | integer |
{- "data": {
- "purpose_of_trip": "Erinäiset kodin putkityöt: Seinä wc asennus, vanhan wc:n purku.",
- "trip_destination": "Itämerenkatu 1, 00180 Helsinki",
- "kilometer_allowance_distance": "250000",
- "kilometer_allowance_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "kilometer_allowance_unit_price": {
- "amount": "2000",
- "currency": "EUR"
}, - "meal_money_amount": "2",
- "meal_money_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "meal_money_unit_price": {
- "amount": "2000",
- "currency": "EUR"
}, - "full_day_100_percent_amount": "2",
- "full_day_100_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "full_day_100_percent_unit_price": {
- "amount": "2000",
- "currency": "EUR"
}, - "full_day_50_percent_amount": "2",
- "full_day_50_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "full_day_50_percent_unit_price": {
- "amount": "2000",
- "currency": "EUR"
}, - "half_day_100_percent_amount": "2",
- "half_day_100_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "half_day_100_percent_unit_price": {
- "amount": "2000",
- "currency": "EUR"
}, - "half_day_50_percent_amount": "2",
- "half_day_50_percent_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "half_day_50_percent_unit_price": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "include_to_invoice_row": true,
- "trip_start_date": "2020-09-20T18:30:00+03:00",
- "trip_end_date": "2020-09-20T18:30:00+03:00"
}
}
invoice_id required | string |
user_id required | string |
withholding_tax_percentage | number Example: withholding_tax_percentage=20.00 If the user hasn't given his/her tax card withholding tax percentage, it can be given here |
{- "id": "2022",
- "invoicing_vat_percent": "24",
- "total_invoicing_sum_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_invoicing_sum_without_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_invoicing_sum_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "work_hours": "20.3",
- "company_fees": {
- "commission": {
- "percent": "24.00",
- "minimum": {
- "amount": "2000",
- "currency": "EUR"
}, - "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "invoice_discount_amount": {
- "amount": "2000",
- "currency": "EUR"
}, - "invoice_discount_amount_used": {
- "amount": "2000",
- "currency": "EUR"
}, - "invoice_discount_total_amount_used": {
- "amount": "2000",
- "currency": "EUR"
}, - "invoice_discount_amount_left": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "additional_cost": {
- "percent": "24.00",
- "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "health_insurance_debt": {
- "type": "string",
- "created_at": "string",
- "name": "string",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "percent": "24.00",
- "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00"
}, - "salary_advance": {
- "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "percent": "24.00",
- "minimum": {
- "amount": "2000",
- "currency": "EUR"
}, - "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "partner_commission": {
- "percent": "24.00",
- "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "includes_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "minimum_commission_applied": true,
- "maximum_commission_applied": true,
- "maximum_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "minimum_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "name": ""
}, - "extra_service_fee": {
- "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "percent": "24.00",
- "minimum": {
- "amount": "2000",
- "currency": "EUR"
}, - "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00"
}, - "fast_payment": {
- "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "percent": "24.00",
- "minimum": {
- "amount": "2000",
- "currency": "EUR"
}, - "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00"
}, - "accident_insurance": {
- "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "percent": "24.00",
- "minimum": {
- "amount": "2000",
- "currency": "EUR"
}, - "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}
}
}, - "company_fees_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_invoicing_sum_without_vat_minus_company_fees": {
- "amount": "2000",
- "currency": "EUR"
}, - "combined_expenses_sum_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "combined_expenses_sum_without_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "combined_expenses_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "receipt_expenses_without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "receipt_expenses_with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "receipt_expenses_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "travel_expenses": {
- "kilometer_allowances": {
- "amount": "2022",
- "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "cost_per": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "full_day_100_percent_allowances": {
- "amount": "2022",
- "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "cost_per": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "full_day_50_percent_allowances": {
- "amount": "2022",
- "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "cost_per": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "half_day_100_percent_allowances": {
- "amount": "2022",
- "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "cost_per": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "half_day_50_percent_allowances": {
- "amount": "2022",
- "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "cost_per": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "meal_allowances": {
- "amount": "2022",
- "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "cost_per": {
- "amount": "2000",
- "currency": "EUR"
}
}
}, - "travel_expenses_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "base_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "employer_fees": { },
- "gross_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "employee_fees": {
- "tax_percent": {
- "percent": "30.00",
- "sum": {
- "amount": "2000",
- "currency": "EUR"
}
}
}, - "employee_fees_percent": "24.00",
- "employee_fees_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "holiday_compensation_percent": "24.00",
- "salary_without_holiday_compensation": {
- "amount": "2000",
- "currency": "EUR"
}, - "holiday_compensation": {
- "amount": "2000",
- "currency": "EUR"
}, - "legacy_health_insurance_percent": "0.74",
- "legacy_health_insurance_fee": {
- "amount": "2000",
- "currency": "EUR"
}, - "health_insurance_debt_amount": {
- "amount": "2000",
- "currency": "EUR"
}, - "net_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "is_yel_enabled": "true",
- "is_required_yel_payments_paid": "true",
- "yel": {
- "percent": "24.00",
- "maximum": {
- "amount": "2000",
- "currency": "EUR"
}, - "is_discount": "true",
- "is_required_yel_payments_paid": "true",
- "withheld_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "withheld_health_insurance_fee_without_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "withheld_health_insurance_fee_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "withheld_health_insurance_fee_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "withheld_health_insurance_percent": "0.74",
- "withheld_health_insurance_vat_percent": "24.0",
- "sum_to_calculate_foreclosure_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum_before_foreclosure": {
- "amount": "2000",
- "currency": "EUR"
}, - "foreclosure": {
- "calculation_starting_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum_to_calculate_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum_to_calculate_from_extra": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum_to_calculate_from_without_other_income_per_month": {
- "amount": "2000",
- "currency": "EUR"
}, - "minimum": {
- "amount": "2000",
- "currency": "EUR"
}, - "maximum": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_amount": {
- "amount": "2000",
- "currency": "EUR"
}, - "maximum_monthly": {
- "amount": "2000",
- "currency": "EUR"
}, - "maximum_per_payment": {
- "amount": "2000",
- "currency": "EUR"
}, - "minimum_monthly": {
- "amount": "2000",
- "currency": "EUR"
}, - "minimum_per_payment": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_amount_paid": {
- "amount": "2000",
- "currency": "EUR"
}, - "amount_paid_this_month": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_amount_left_to_pay": {
- "amount": "2000",
- "currency": "EUR"
}, - "amount_left_to_pay_this_month": {
- "amount": "2000",
- "currency": "EUR"
}, - "percent": "24.00",
- "protected_per_day": {
- "amount": "2000",
- "currency": "EUR"
}, - "protected_total": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum_to_calculate_foreclosure_from_divided_by_protected_amount_total": {
- "amount": "2000",
- "currency": "EUR"
}, - "is_sum_to_calculate_foreclosure_from_less_than_protected_amount": "true",
- "is_sum_to_calculate_foreclosure_from_greater_than_protected_amount_and_less_than_2_times_protected_amount": "true",
- "is_sum_to_calculate_foreclosure_from_at_least_2_times_and_less_than_4_times_protected_amount": "true",
- "is_sum_to_calculate_foreclosure_from_at_least_4_times_protected_amount": "true",
- "extra_amount_to_leave": {
- "amount": "2000",
- "currency": "EUR"
}, - "other_income_per_month": {
- "amount": "2000",
- "currency": "EUR"
}, - "is_under_protected": "true",
- "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "is_monthly_maximum_paid": "true",
- "is_total_amount_paid": "true",
- "is_monthly_maximum_reached": "true",
- "is_total_amount_reached": "true",
- "is_maximum_payment_reached": "true",
- "is_under_monthly_minimum": "true",
- "is_under_payment_minimum": "true",
- "is_current_month_free_from_foreclosure": "true",
- "iban": "FI2112345600000785",
- "reference": "123123213",
- "salary_payment_setting": "true",
- "payment_term": "true",
- "calculation_method": "true",
- "calculation_date": "2020",
- "amount_to_leave_sum_used": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "sum_after_foreclosure": {
- "amount": "2000",
- "currency": "EUR"
}, - "salary_fees_without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "salary_fees_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "salary_fees_with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "salary_fees": {
- "commission": {
- "percent": "24.00",
- "minimum": {
- "amount": "2000",
- "currency": "EUR"
}, - "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "invoice_discount_amount": {
- "amount": "2000",
- "currency": "EUR"
}, - "invoice_discount_amount_used": {
- "amount": "2000",
- "currency": "EUR"
}, - "invoice_discount_total_amount_used": {
- "amount": "2000",
- "currency": "EUR"
}, - "invoice_discount_amount_left": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "additional_cost": {
- "percent": "24.00",
- "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "health_insurance_debt": {
- "type": "string",
- "created_at": "string",
- "name": "string",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "percent": "24.00",
- "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00"
}, - "salary_advance": {
- "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "percent": "24.00",
- "minimum": {
- "amount": "2000",
- "currency": "EUR"
}, - "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "partner_commission": {
- "percent": "24.00",
- "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "includes_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "minimum_commission_applied": true,
- "maximum_commission_applied": true,
- "maximum_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "minimum_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "name": ""
}, - "extra_service_fee": {
- "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "percent": "24.00",
- "minimum": {
- "amount": "2000",
- "currency": "EUR"
}, - "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00"
}, - "fast_payment": {
- "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "percent": "24.00",
- "minimum": {
- "amount": "2000",
- "currency": "EUR"
}, - "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00"
}, - "accident_insurance": {
- "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "percent": "24.00",
- "minimum": {
- "amount": "2000",
- "currency": "EUR"
}, - "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}
}
}, - "sum_after_salary_fees": {
- "amount": "2000",
- "currency": "EUR"
}, - "final_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "final_salary_with_expenses": {
- "amount": "2000",
- "currency": "EUR"
}, - "final_expenses": {
- "amount": "2000",
- "currency": "EUR"
}, - "personal_deductions_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "country": "",
- "calculation_year": "2020",
- "start_date": "2020-09-20T18:30:00+03:00",
- "end_date": "2020-09-20T18:30:00+03:00",
- "calculation_date": "2020-09-20T18:30:00+03:00",
- "user_age": "18",
- "user_birth_year": "1980",
- "is_strict_checked": "true",
- "is_fast_payment_enabled": "true",
- "is_extra_service_fee_enabled": "true",
- "adjusted_tax_percent": "true",
- "paid_salary_id": "123124",
- "paid_salary_date": "2020-09-20T18:30:00+03:00",
- "salary_buckets": [
- {
- "start_date": "Y-m-d\\TH:i:sP",
- "end_date": "Y-m-d\\TH:i:sP",
- "total_gross_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "health_insurance_obligated": "true",
- "is_of_age": "true",
- "type": "ADMIN_OVERRIDDEN",
- "retroactive_debt_handling": "NONE",
- "admin_explanation": "string"
}
], - "is_salary_too_small_for_fast_payment": "true",
- "juel_total_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}
invoice_id required | string |
user_id required | number |
withholding_tax_percentage | number Example: withholding_tax_percentage=20.00 If the user hasn't given his/her tax card withholding tax percentage, it can be given here |
invoice_id required | integer |
required | object (Money) Money value schema |
expense_vat_percent required | number |
receipt_expense_id required | integer |
{- "data": {
- "is_salary_valid": true
}
}
business_id required | string Example: 1234567-8 Finnish Business Id (Y-tunnus) |
{- "data": {
- "name": "Ollin Matkapuhelinyritys Oyj",
- "company_form": "Limited Company",
- "business_id": "1234567-8",
- "vat_id": "FI12345678",
- "registration_date": "1983-09-22",
- "addresses": [
- {
- "street_address1": "Itämerenkatu 1",
- "street_address2": "null",
- "zip_code": "00120",
- "city": "Helsinki"
}
]
}
}
vat_id required | string Example: FI12345678 VAT Id in country specific format |
{- "data": {
- "name": "Ollin Matkapuhelinyritys Oyj",
- "company_form": "Limited Company",
- "business_id": "1234567-8",
- "vat_id": "FI12345678",
- "registration_date": "1983-09-22",
- "addresses": [
- {
- "street_address1": "Itämerenkatu 1",
- "street_address2": "null",
- "zip_code": "00120",
- "city": "Helsinki"
}
]
}
}
{- "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"
}
}
questionnaire_slug required | string Questionnaire slug that's used for every questionnaire |
language | string Example: language=EN Defines what language is used for questions and answers (FI, EN, SV, RU, ET), fallbacks to FI |
{- "data": {
- "answer_set": {
- "id": 0
}, - "question": {
- "id": 0,
- "description": "string",
- "type": 0,
- "questionnaire_id": 0,
- "options": [
- {
- "id": 0,
- "answer_text": "string"
}
]
}
}
}
questionnaire_slug required | string Questionnaire slug that's used for every questionnaire |
answer_set_id required | integer User's Answer Set id |
question_id required | integer Question id the user answered |
language | string Example: language=EN Defines what language is used for questions and answers (FI, EN, SV, RU, ET), fallbacks to FI |
Answer to Questionnaire Question
option_id required | any (Option id) Id for option the user has selected |
{- "option_id": "321"
}
{- "data": {
- "type": "Either 'decision' or 'question'",
- "question": {
- "id": 0,
- "description": "string",
- "type": 0,
- "questionnaire_id": 0,
- "options": [
- {
- "id": 0,
- "answer_text": "string"
}
]
}, - "decision": {
- "id": 0,
- "value": "string",
- "required_text_answer": true
}
}
}
questionnaire_slug required | string Questionnaire slug that's used for every questionnaire |
answer_set_id required | integer Users Answer Set id |
target_model_id required | integer Target Model Id (ie. TravelExpense.id) to be attached to the answerset |
language | string Example: language=EN Defines what language is used for questions and answers (FI, EN, SV, RU, ET), fallbacks to FI |
questionnaire_slug required | string Questionnaire slug that's used for every questionnaire |
answer_set_id required | integer Users Answer Set id |
language | string Example: language=EN Defines what language is used for questions and answers (FI, EN, SV, RU, ET), fallbacks to FI |
{- "data": {
- "answer_set": [
- {
- "id": 0,
- "decision_answer_text": "string"
}
], - "decision": [
- {
- "id": 0,
- "value": "string",
- "required_text_answer": true
}
], - "question": {
- "id": 0,
- "description": "string",
- "type": 0,
- "questionnaire_id": 0,
- "options": [
- {
- "id": 0,
- "answer_text": "string"
}
]
}
}
}
questionnaire_slug required | string Questionnaire slug that's used for every questionnaire |
target_model_id required | integer Target Model's id |
language | string Example: language=EN Defines what language is used for questions and answers (FI, EN, SV, RU, ET), fallbacks to FI |
{- "data": {
- "answer_set": [
- {
- "id": 0,
- "decision_answer_text": "string"
}
], - "decision": [
- {
- "id": 0,
- "value": "string",
- "required_text_answer": true
}
], - "questionnaire_slug": "string"
}
}
questionnaire_slug required | string Questionnaire slug that's used for every questionnaire |
language | string Example: language=EN Defines what language is used for questions and answers (FI, EN, SV, RU, ET), fallbacks to FI |
{- "data": {
- "answer_set": {
- "id": 0,
- "decision_answer_text": "string"
}, - "decision": {
- "id": 0,
- "value": "string",
- "required_decision_answer": true
}, - "questionnaire_slug": "string",
- "target_model_id": 0
}
}
questionnaire_slug required | string Questionnaire slug that's used for every questionnaire |
language | string Example: language=EN Defines what language is used for questions and answers (FI, EN, SV, RU, ET), fallbacks to FI |
{- "data": {
- "answer_set": {
- "id": 0,
- "decision_answer_text": "string"
}, - "decision": {
- "id": 0,
- "value": "string",
- "required_decision_answer": true
}, - "questionnaire_slug": "string"
}
}
questionnaire_slug required | string Questionnaire slug that's used for every questionnaire |
answer_set_id required | integer User's Answer Set id |
previous_question_id required | integer Previous question id the user answered |
language | string Example: language=EN Defines what language is used for questions and answers (FI, EN, SV, RU, ET), fallbacks to FI |
{- "data": {
- "type": "question",
- "question": {
- "id": 0,
- "description": "string",
- "type": 0,
- "questionnaire_id": 0,
- "options": [
- {
- "id": 0,
- "answer_text": "string"
}
]
}
}
}
questionnaire_slug required | string Questionnaire slug that's used for every questionnaire |
answer_set_id required | integer User's Answer Set id |
language | string Example: language=EN Defines what language is used for questions and answers (FI, EN, SV, RU, ET), fallbacks to FI |
{- "data": {
- "answer_set": {
- "decision_answer": "string"
}
}
}
questionnaire_slug required | string Questionnaire slug that's used for every questionnaire |
answer_set_id required | integer User's Answer Set id |
language | string Example: language=EN Defines what language is used for questions and answers (FI, EN, SV, RU, ET), fallbacks to FI |
list_type required | string List type: 'all' or 'unpaid' |
{- "data": {
- "id": 0,
- "user_id": 0,
- "comments": "string",
- "filename": "string",
- "paid": true,
- "notes": "string",
- "company_commission_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "invoices": [
- {
- "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
}
], - "receipt_expenses_total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "receipt_expenses_total_sum_without_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "receipt_expenses_total_sum_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "gross_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "net_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "final_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "juel_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "salary_without_holiday_compensation": {
- "amount": "2000",
- "currency": "EUR"
}, - "holiday_bonus_pay": {
- "amount": "2000",
- "currency": "EUR"
}, - "holiday_pay": {
- "amount": "2000",
- "currency": "EUR"
}, - "accident_insurance_percent": 0.1,
- "accident_insurance": {
- "amount": "2000",
- "currency": "EUR"
}, - "group_life_insurance": {
- "amount": "2000",
- "currency": "EUR"
}, - "unemployment_insurance": {
- "amount": "2000",
- "currency": "EUR"
}, - "withheld_yel": {
- "amount": "2000",
- "currency": "EUR"
}, - "yel_percent": 0.1,
- "ssn": 0.1,
- "calculation_date": "2020-09-20",
- "created_at": "2020-09-20T18:30:00+03:00",
- "updated_at": "2020-09-20T18:30:00+03:00"
}
}
{- "data": {
- "id": 0,
- "user_id": 0,
- "comments": "string",
- "filename": "string",
- "paid": true,
- "notes": "string",
- "company_commission_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "invoices": [
- {
- "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
}
], - "receipt_expenses_total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "receipt_expenses_total_sum_without_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "receipt_expenses_total_sum_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "gross_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "net_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "final_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "juel_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "salary_without_holiday_compensation": {
- "amount": "2000",
- "currency": "EUR"
}, - "holiday_bonus_pay": {
- "amount": "2000",
- "currency": "EUR"
}, - "holiday_pay": {
- "amount": "2000",
- "currency": "EUR"
}, - "accident_insurance_percent": 0.1,
- "accident_insurance": {
- "amount": "2000",
- "currency": "EUR"
}, - "group_life_insurance": {
- "amount": "2000",
- "currency": "EUR"
}, - "unemployment_insurance": {
- "amount": "2000",
- "currency": "EUR"
}, - "withheld_yel": {
- "amount": "2000",
- "currency": "EUR"
}, - "yel_percent": 0.1,
- "ssn": 0.1,
- "calculation_date": "2020-09-20",
- "created_at": "2020-09-20T18:30:00+03:00",
- "updated_at": "2020-09-20T18:30:00+03:00"
}
}
calculated_salary_id required | integer Calculated salary id |
{- "data": {
- "id": 0,
- "user_id": 0,
- "comments": "string",
- "filename": "string",
- "paid": true,
- "notes": "string",
- "company_commission_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "invoices": [
- {
- "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
}
], - "receipt_expenses_total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "receipt_expenses_total_sum_without_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "receipt_expenses_total_sum_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "gross_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "net_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "final_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "juel_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "salary_without_holiday_compensation": {
- "amount": "2000",
- "currency": "EUR"
}, - "holiday_bonus_pay": {
- "amount": "2000",
- "currency": "EUR"
}, - "holiday_pay": {
- "amount": "2000",
- "currency": "EUR"
}, - "accident_insurance_percent": 0.1,
- "accident_insurance": {
- "amount": "2000",
- "currency": "EUR"
}, - "group_life_insurance": {
- "amount": "2000",
- "currency": "EUR"
}, - "unemployment_insurance": {
- "amount": "2000",
- "currency": "EUR"
}, - "withheld_yel": {
- "amount": "2000",
- "currency": "EUR"
}, - "yel_percent": 0.1,
- "ssn": 0.1,
- "calculation_date": "2020-09-20",
- "created_at": "2020-09-20T18:30:00+03:00",
- "updated_at": "2020-09-20T18:30:00+03:00"
}
}
Satisfy SPA and modern consumers by returning calculated_salary.dataJson like it is.
calculated_salary_id required | integer Calculated salary id |
{- "id": "2022",
- "invoicing_vat_percent": "24",
- "total_invoicing_sum_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_invoicing_sum_without_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_invoicing_sum_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "work_hours": "20.3",
- "company_fees": {
- "commission": {
- "percent": "24.00",
- "minimum": {
- "amount": "2000",
- "currency": "EUR"
}, - "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "invoice_discount_amount": {
- "amount": "2000",
- "currency": "EUR"
}, - "invoice_discount_amount_used": {
- "amount": "2000",
- "currency": "EUR"
}, - "invoice_discount_total_amount_used": {
- "amount": "2000",
- "currency": "EUR"
}, - "invoice_discount_amount_left": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "additional_cost": {
- "percent": "24.00",
- "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "health_insurance_debt": {
- "type": "string",
- "created_at": "string",
- "name": "string",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "percent": "24.00",
- "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00"
}, - "salary_advance": {
- "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "percent": "24.00",
- "minimum": {
- "amount": "2000",
- "currency": "EUR"
}, - "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "partner_commission": {
- "percent": "24.00",
- "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "includes_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "minimum_commission_applied": true,
- "maximum_commission_applied": true,
- "maximum_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "minimum_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "name": ""
}, - "extra_service_fee": {
- "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "percent": "24.00",
- "minimum": {
- "amount": "2000",
- "currency": "EUR"
}, - "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00"
}, - "fast_payment": {
- "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "percent": "24.00",
- "minimum": {
- "amount": "2000",
- "currency": "EUR"
}, - "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00"
}, - "accident_insurance": {
- "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "percent": "24.00",
- "minimum": {
- "amount": "2000",
- "currency": "EUR"
}, - "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}
}
}, - "company_fees_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_invoicing_sum_without_vat_minus_company_fees": {
- "amount": "2000",
- "currency": "EUR"
}, - "combined_expenses_sum_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "combined_expenses_sum_without_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "combined_expenses_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "receipt_expenses_without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "receipt_expenses_with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "receipt_expenses_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "travel_expenses": {
- "kilometer_allowances": {
- "amount": "2022",
- "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "cost_per": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "full_day_100_percent_allowances": {
- "amount": "2022",
- "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "cost_per": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "full_day_50_percent_allowances": {
- "amount": "2022",
- "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "cost_per": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "half_day_100_percent_allowances": {
- "amount": "2022",
- "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "cost_per": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "half_day_50_percent_allowances": {
- "amount": "2022",
- "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "cost_per": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "meal_allowances": {
- "amount": "2022",
- "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "cost_per": {
- "amount": "2000",
- "currency": "EUR"
}
}
}, - "travel_expenses_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "base_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "employer_fees": { },
- "gross_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "employee_fees": {
- "tax_percent": {
- "percent": "30.00",
- "sum": {
- "amount": "2000",
- "currency": "EUR"
}
}
}, - "employee_fees_percent": "24.00",
- "employee_fees_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "holiday_compensation_percent": "24.00",
- "salary_without_holiday_compensation": {
- "amount": "2000",
- "currency": "EUR"
}, - "holiday_compensation": {
- "amount": "2000",
- "currency": "EUR"
}, - "legacy_health_insurance_percent": "0.74",
- "legacy_health_insurance_fee": {
- "amount": "2000",
- "currency": "EUR"
}, - "health_insurance_debt_amount": {
- "amount": "2000",
- "currency": "EUR"
}, - "net_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "is_yel_enabled": "true",
- "is_required_yel_payments_paid": "true",
- "yel": {
- "percent": "24.00",
- "maximum": {
- "amount": "2000",
- "currency": "EUR"
}, - "is_discount": "true",
- "is_required_yel_payments_paid": "true",
- "withheld_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "withheld_health_insurance_fee_without_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "withheld_health_insurance_fee_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "withheld_health_insurance_fee_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "withheld_health_insurance_percent": "0.74",
- "withheld_health_insurance_vat_percent": "24.0",
- "sum_to_calculate_foreclosure_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum_before_foreclosure": {
- "amount": "2000",
- "currency": "EUR"
}, - "foreclosure": {
- "calculation_starting_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum_to_calculate_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum_to_calculate_from_extra": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum_to_calculate_from_without_other_income_per_month": {
- "amount": "2000",
- "currency": "EUR"
}, - "minimum": {
- "amount": "2000",
- "currency": "EUR"
}, - "maximum": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_amount": {
- "amount": "2000",
- "currency": "EUR"
}, - "maximum_monthly": {
- "amount": "2000",
- "currency": "EUR"
}, - "maximum_per_payment": {
- "amount": "2000",
- "currency": "EUR"
}, - "minimum_monthly": {
- "amount": "2000",
- "currency": "EUR"
}, - "minimum_per_payment": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_amount_paid": {
- "amount": "2000",
- "currency": "EUR"
}, - "amount_paid_this_month": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_amount_left_to_pay": {
- "amount": "2000",
- "currency": "EUR"
}, - "amount_left_to_pay_this_month": {
- "amount": "2000",
- "currency": "EUR"
}, - "percent": "24.00",
- "protected_per_day": {
- "amount": "2000",
- "currency": "EUR"
}, - "protected_total": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum_to_calculate_foreclosure_from_divided_by_protected_amount_total": {
- "amount": "2000",
- "currency": "EUR"
}, - "is_sum_to_calculate_foreclosure_from_less_than_protected_amount": "true",
- "is_sum_to_calculate_foreclosure_from_greater_than_protected_amount_and_less_than_2_times_protected_amount": "true",
- "is_sum_to_calculate_foreclosure_from_at_least_2_times_and_less_than_4_times_protected_amount": "true",
- "is_sum_to_calculate_foreclosure_from_at_least_4_times_protected_amount": "true",
- "extra_amount_to_leave": {
- "amount": "2000",
- "currency": "EUR"
}, - "other_income_per_month": {
- "amount": "2000",
- "currency": "EUR"
}, - "is_under_protected": "true",
- "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "is_monthly_maximum_paid": "true",
- "is_total_amount_paid": "true",
- "is_monthly_maximum_reached": "true",
- "is_total_amount_reached": "true",
- "is_maximum_payment_reached": "true",
- "is_under_monthly_minimum": "true",
- "is_under_payment_minimum": "true",
- "is_current_month_free_from_foreclosure": "true",
- "iban": "FI2112345600000785",
- "reference": "123123213",
- "salary_payment_setting": "true",
- "payment_term": "true",
- "calculation_method": "true",
- "calculation_date": "2020",
- "amount_to_leave_sum_used": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "sum_after_foreclosure": {
- "amount": "2000",
- "currency": "EUR"
}, - "salary_fees_without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "salary_fees_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "salary_fees_with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "salary_fees": {
- "commission": {
- "percent": "24.00",
- "minimum": {
- "amount": "2000",
- "currency": "EUR"
}, - "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "invoice_discount_amount": {
- "amount": "2000",
- "currency": "EUR"
}, - "invoice_discount_amount_used": {
- "amount": "2000",
- "currency": "EUR"
}, - "invoice_discount_total_amount_used": {
- "amount": "2000",
- "currency": "EUR"
}, - "invoice_discount_amount_left": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "additional_cost": {
- "percent": "24.00",
- "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "health_insurance_debt": {
- "type": "string",
- "created_at": "string",
- "name": "string",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "percent": "24.00",
- "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00"
}, - "salary_advance": {
- "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "percent": "24.00",
- "minimum": {
- "amount": "2000",
- "currency": "EUR"
}, - "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "partner_commission": {
- "percent": "24.00",
- "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "includes_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "minimum_commission_applied": true,
- "maximum_commission_applied": true,
- "maximum_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "minimum_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "name": ""
}, - "extra_service_fee": {
- "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "percent": "24.00",
- "minimum": {
- "amount": "2000",
- "currency": "EUR"
}, - "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00"
}, - "fast_payment": {
- "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "percent": "24.00",
- "minimum": {
- "amount": "2000",
- "currency": "EUR"
}, - "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00"
}, - "accident_insurance": {
- "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "percent": "24.00",
- "minimum": {
- "amount": "2000",
- "currency": "EUR"
}, - "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}
}
}, - "sum_after_salary_fees": {
- "amount": "2000",
- "currency": "EUR"
}, - "final_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "final_salary_with_expenses": {
- "amount": "2000",
- "currency": "EUR"
}, - "final_expenses": {
- "amount": "2000",
- "currency": "EUR"
}, - "personal_deductions_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "country": "",
- "calculation_year": "2020",
- "start_date": "2020-09-20T18:30:00+03:00",
- "end_date": "2020-09-20T18:30:00+03:00",
- "calculation_date": "2020-09-20T18:30:00+03:00",
- "user_age": "18",
- "user_birth_year": "1980",
- "is_strict_checked": "true",
- "is_fast_payment_enabled": "true",
- "is_extra_service_fee_enabled": "true",
- "adjusted_tax_percent": "true",
- "paid_salary_id": "123124",
- "paid_salary_date": "2020-09-20T18:30:00+03:00",
- "salary_buckets": [
- {
- "start_date": "Y-m-d\\TH:i:sP",
- "end_date": "Y-m-d\\TH:i:sP",
- "total_gross_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "health_insurance_obligated": "true",
- "is_of_age": "true",
- "type": "ADMIN_OVERRIDDEN",
- "retroactive_debt_handling": "NONE",
- "admin_explanation": "string"
}
], - "is_salary_too_small_for_fast_payment": "true",
- "juel_total_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=payment_date | gross_salary | withheld_yel | travel_expenses_sum |
* receipt_expenses_with_vat_sum | foreclosure_sum | final_salary Sort by ascending order, add '-' prefix to get * descending order, ie. -final_salary |
filter[*field_name*] | string Search fields. Array of filtered fields, so * filter[common_search] = 5.00 or 5,00 * filter[search_date_between] (format: YYYY-m-d|YYYY-m-d) * either one can be omitted |
{- "data": [
- {
- "id": 0,
- "user_id": 0,
- "salary_transaction_id": 0,
- "expenses_transaction_id": 0,
- "foreclosure_transaction_id": 0,
- "calculated_salary_ids_json": "string",
- "invoice_ids_json": "string",
- "total_invoicing_sum_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_invoicing_sum_without_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "company_fees_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "expenses_with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "expenses_without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "receipt_expenses_with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "receipt_expenses_without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "travel_expenses_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "base_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "employer_fees_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "gross_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "salary_without_holiday_compensation": {
- "amount": "2000",
- "currency": "EUR"
}, - "holiday_compensation": {
- "amount": "2000",
- "currency": "EUR"
}, - "employee_fees_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "net_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "withheld_yel": {
- "amount": "2000",
- "currency": "EUR"
}, - "health_insurance_fee_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "salary_fees_with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "salary_fees_without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "salary_fees_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "fast_payment_fee": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum_to_foreclose_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "foreclosure_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "final_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "final_salary_with_expenses": {
- "amount": "2000",
- "currency": "EUR"
}, - "juel_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "personal_deductions_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "health_insurance_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "notes": "string",
- "work_hours": 0.1,
- "refunded": true,
- "is_yel_discount": true,
- "is_yel_required_paid": true,
- "is_fast_payment_enabled": true,
- "transaction_date": "2020-09-20",
- "payment_date": "2020-09-20",
- "start_date": "2020-09-20",
- "end_date": "2020-09-20",
- "created_at": "2020-09-20T18:30:00+03:00",
- "updated_at": "2020-09-20T18:30:00+03:00",
- "deleted_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"
}
}
Satisfy SPA and other API consumers by returning paid_salary.dataJson as modern PaidSalaryResult.
paid_salary_id required | integer Paid salary id |
{- "calculation_period_start_date": "2020",
- "calculation_period_end_date": "2020",
- "start_date": "2020",
- "end_date": "2020",
- "payment_date": "2020",
- "calculated_salary_periods": [
- {
- "calculated_salary_period": "2020"
}
], - "total_invoicing_sum_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_invoicing_sum_without_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "company_fees": [
- {
- "type": "string",
- "percent": "24.00",
- "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "created_at": "2020",
- "name": "string",
- "includes_vat": true,
- "invoice_discount_amount_used": true,
- "invoice_discount_total_amount_used": null,
- "invoice_discount_amount_left": true,
- "invoice_discount_amount": true
}
], - "receipt_expenses_with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "receipt_expenses_without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "receipt_expenses": [
- {
- "id": "2022",
- "created_at": "2020",
- "processed_at": "2020",
- "additional_information": "string",
- "place_of_purchase": "string",
- "purchase_date": "2020",
- "sum_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum_without_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "filename": "string"
}
], - "travel_expenses_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "travel_expenses": [
- {
- "kilometer_allowances": {
- "amount": "24.00",
- "cost_per": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "full_day_allowance_100_percent": {
- "amount": "24.00",
- "cost_per": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "full_day_allowance_50_percent": {
- "amount": "24.00",
- "cost_per": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "half_day_allowance_100_percent": {
- "amount": "24.00",
- "cost_per": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "half_day_allowance_50_percent": {
- "amount": "24.00",
- "cost_per": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "meal_allowances": {
- "amount": "24.00",
- "cost_per": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}
}
], - "gross_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "average_employee_fee_percent": "24.00",
- "average_health_insurance_fee_percent": "24.00",
- "average_legacy_health_insurance_fee_percent": "24.00",
- "average_health_insurance_fee_without_vat_percent": "24.00",
- "employee_fees_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "average_yel_percent": "24.00",
- "employee_fees": [
- {
- "type": "string",
- "percent": "24.00",
- "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "created_at": "2020"
}
], - "net_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "yel_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "is_required_yel_payments_paid": true,
- "yel_fees": [
- {
- "name": "string",
- "type": "string",
- "percent": "24.00",
- "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "created_at": "2020"
}
], - "is_yel_discount": true,
- "withheld_health_insurance_fee_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "withheld_health_insurance_fee_without_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "withheld_health_insurance_fee_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "health_insurance_fees": [
- {
- "name": "string",
- "type": "string",
- "percent": "24.00",
- "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "created_at": "2020"
}
], - "is_fast_payment_enabled": true,
- "payment_calculation_starting_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "fast_payment": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum_to_foreclose": {
- "amount": "2000",
- "currency": "EUR"
}, - "foreclosure": {
- "sum_to_calculate_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum_to_calculate_from_extra": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum_to_calculate_from_without_other_income_per_month": {
- "amount": "2000",
- "currency": "EUR"
}, - "minimum": {
- "amount": "2000",
- "currency": "EUR"
}, - "maximum": {
- "amount": "2000",
- "currency": "EUR"
}, - "maximum_total": {
- "amount": "2000",
- "currency": "EUR"
}, - "maximum_monthly": {
- "amount": "2000",
- "currency": "EUR"
}, - "maximum_per_payment": {
- "amount": "2000",
- "currency": "EUR"
}, - "minimum_monthly": {
- "amount": "2000",
- "currency": "EUR"
}, - "minimum_per_payment": {
- "amount": "2000",
- "currency": "EUR"
}, - "paid_total_before": {
- "amount": "2000",
- "currency": "EUR"
}, - "amount_paid_this_month": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_amount_left_to_pay": {
- "amount": "2000",
- "currency": "EUR"
}, - "amount_left_to_pay_this_month": {
- "amount": "2000",
- "currency": "EUR"
}, - "percent": "24.00",
- "protected_per_day": {
- "amount": "2000",
- "currency": "EUR"
}, - "protected_total": {
- "amount": "2000",
- "currency": "EUR"
}, - "extra_amount_to_leave": {
- "amount": "2000",
- "currency": "EUR"
}, - "other_income_per_month": {
- "amount": "2000",
- "currency": "EUR"
}, - "is_under_protected": true,
- "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "is_monthly_maximum_paid": true,
- "is_total_amount_paid": true,
- "is_monthly_maximum_reached": true,
- "is_maximum_payment_reached": true,
- "is_total_amount_reached": true,
- "is_payment_maximum_paid": true,
- "is_under_monthly_minimum": true,
- "is_under_payment_minimum": true,
- "is_current_month_free_from_foreclosure": true,
- "iban": "string",
- "reference": "string",
- "salary_payment_setting": "123124",
- "calculation_method": "123124",
- "calculation_date": "2020"
}, - "sum_before_salary_fees": {
- "amount": "2000",
- "currency": "EUR"
}, - "salary_fees_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "salary_fees_with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "salary_fees_without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "combined_expenses_sum_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum_to_calculate_foreclosure_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "combined_expenses_sum_without_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "salary_fees": [
- {
- "type": "string",
- "percent": "24.00",
- "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "created_at": "2020",
- "name": "string",
- "includes_vat": true
}
], - "sum_after_salary_fees": {
- "amount": "2000",
- "currency": "EUR"
}, - "final_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "final_salary_with_expenses": {
- "amount": "2000",
- "currency": "EUR"
}, - "juel_total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "created_at": "2020",
- "personal_deductions": {
- "yel": {
- "amount": "2000",
- "currency": "EUR"
}, - "commission": {
- "amount": "2000",
- "currency": "EUR"
}, - "additional_cost": {
- "amount": "2000",
- "currency": "EUR"
}, - "fast_payment": {
- "amount": "2000",
- "currency": "EUR"
}, - "health_insurance_fee": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "personal_deductions_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "work_hours": "24.00",
- "holiday_compensation": {
- "amount": "2000",
- "currency": "EUR"
}, - "salary_without_holiday_compensation": {
- "amount": "2000",
- "currency": "EUR"
}, - "legacy_health_insurance_sum_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "legacy_health_insurance_sum_without_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "legacy_health_insurance_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "user_id": "123124",
- "payer_user_id": "123124",
- "calculated_salary_ids": [
- {
- "calculated_salary_id": 0
}
], - "invoice_ids": [
- {
- "invoice_id": 0
}
], - "bank_account": "string",
- "periods": [
- {
- "period": "2020-10-10 - 2020-11-11"
}
]
}
user_id required | integer User id |
null
{- "calculation_period_start_date": "2020",
- "calculation_period_end_date": "2020",
- "start_date": "2020",
- "end_date": "2020",
- "payment_date": "2020",
- "calculated_salary_periods": [
- {
- "calculated_salary_period": "2020"
}
], - "total_invoicing_sum_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_invoicing_sum_without_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "company_fees": [
- {
- "type": "string",
- "percent": "24.00",
- "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "created_at": "2020",
- "name": "string",
- "includes_vat": true,
- "invoice_discount_amount_used": true,
- "invoice_discount_total_amount_used": null,
- "invoice_discount_amount_left": true,
- "invoice_discount_amount": true
}
], - "receipt_expenses_with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "receipt_expenses_without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "receipt_expenses": [
- {
- "id": "2022",
- "created_at": "2020",
- "processed_at": "2020",
- "additional_information": "string",
- "place_of_purchase": "string",
- "purchase_date": "2020",
- "sum_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum_without_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "filename": "string"
}
], - "travel_expenses_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "travel_expenses": [
- {
- "kilometer_allowances": {
- "amount": "24.00",
- "cost_per": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "full_day_allowance_100_percent": {
- "amount": "24.00",
- "cost_per": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "full_day_allowance_50_percent": {
- "amount": "24.00",
- "cost_per": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "half_day_allowance_100_percent": {
- "amount": "24.00",
- "cost_per": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "half_day_allowance_50_percent": {
- "amount": "24.00",
- "cost_per": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "meal_allowances": {
- "amount": "24.00",
- "cost_per": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}
}
], - "gross_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "average_employee_fee_percent": "24.00",
- "average_health_insurance_fee_percent": "24.00",
- "average_legacy_health_insurance_fee_percent": "24.00",
- "average_health_insurance_fee_without_vat_percent": "24.00",
- "employee_fees_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "average_yel_percent": "24.00",
- "employee_fees": [
- {
- "type": "string",
- "percent": "24.00",
- "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "created_at": "2020"
}
], - "net_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "yel_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "is_required_yel_payments_paid": true,
- "yel_fees": [
- {
- "name": "string",
- "type": "string",
- "percent": "24.00",
- "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "created_at": "2020"
}
], - "is_yel_discount": true,
- "withheld_health_insurance_fee_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "withheld_health_insurance_fee_without_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "withheld_health_insurance_fee_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "health_insurance_fees": [
- {
- "name": "string",
- "type": "string",
- "percent": "24.00",
- "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "created_at": "2020"
}
], - "is_fast_payment_enabled": true,
- "payment_calculation_starting_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "fast_payment": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum_to_foreclose": {
- "amount": "2000",
- "currency": "EUR"
}, - "foreclosure": {
- "sum_to_calculate_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum_to_calculate_from_extra": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum_to_calculate_from_without_other_income_per_month": {
- "amount": "2000",
- "currency": "EUR"
}, - "minimum": {
- "amount": "2000",
- "currency": "EUR"
}, - "maximum": {
- "amount": "2000",
- "currency": "EUR"
}, - "maximum_total": {
- "amount": "2000",
- "currency": "EUR"
}, - "maximum_monthly": {
- "amount": "2000",
- "currency": "EUR"
}, - "maximum_per_payment": {
- "amount": "2000",
- "currency": "EUR"
}, - "minimum_monthly": {
- "amount": "2000",
- "currency": "EUR"
}, - "minimum_per_payment": {
- "amount": "2000",
- "currency": "EUR"
}, - "paid_total_before": {
- "amount": "2000",
- "currency": "EUR"
}, - "amount_paid_this_month": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_amount_left_to_pay": {
- "amount": "2000",
- "currency": "EUR"
}, - "amount_left_to_pay_this_month": {
- "amount": "2000",
- "currency": "EUR"
}, - "percent": "24.00",
- "protected_per_day": {
- "amount": "2000",
- "currency": "EUR"
}, - "protected_total": {
- "amount": "2000",
- "currency": "EUR"
}, - "extra_amount_to_leave": {
- "amount": "2000",
- "currency": "EUR"
}, - "other_income_per_month": {
- "amount": "2000",
- "currency": "EUR"
}, - "is_under_protected": true,
- "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "is_monthly_maximum_paid": true,
- "is_total_amount_paid": true,
- "is_monthly_maximum_reached": true,
- "is_maximum_payment_reached": true,
- "is_total_amount_reached": true,
- "is_payment_maximum_paid": true,
- "is_under_monthly_minimum": true,
- "is_under_payment_minimum": true,
- "is_current_month_free_from_foreclosure": true,
- "iban": "string",
- "reference": "string",
- "salary_payment_setting": "123124",
- "calculation_method": "123124",
- "calculation_date": "2020"
}, - "sum_before_salary_fees": {
- "amount": "2000",
- "currency": "EUR"
}, - "salary_fees_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "salary_fees_with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "salary_fees_without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "combined_expenses_sum_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum_to_calculate_foreclosure_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "combined_expenses_sum_without_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "salary_fees": [
- {
- "type": "string",
- "percent": "24.00",
- "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "created_at": "2020",
- "name": "string",
- "includes_vat": true
}
], - "sum_after_salary_fees": {
- "amount": "2000",
- "currency": "EUR"
}, - "final_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "final_salary_with_expenses": {
- "amount": "2000",
- "currency": "EUR"
}, - "juel_total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "created_at": "2020",
- "personal_deductions": {
- "yel": {
- "amount": "2000",
- "currency": "EUR"
}, - "commission": {
- "amount": "2000",
- "currency": "EUR"
}, - "additional_cost": {
- "amount": "2000",
- "currency": "EUR"
}, - "fast_payment": {
- "amount": "2000",
- "currency": "EUR"
}, - "health_insurance_fee": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "personal_deductions_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "work_hours": "24.00",
- "holiday_compensation": {
- "amount": "2000",
- "currency": "EUR"
}, - "salary_without_holiday_compensation": {
- "amount": "2000",
- "currency": "EUR"
}, - "legacy_health_insurance_sum_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "legacy_health_insurance_sum_without_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "legacy_health_insurance_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "user_id": "123124",
- "payer_user_id": "123124",
- "calculated_salary_ids": [
- {
- "calculated_salary_id": 0
}
], - "invoice_ids": [
- {
- "invoice_id": 0
}
], - "bank_account": "string",
- "periods": [
- {
- "period": "2020-10-10 - 2020-11-11"
}
]
}
Modern version of the above but for SPA.
Satisfy SPA and other API consumers by returning ModernPaidSalaryResult.
null
{- "calculation_period_start_date": "2020",
- "calculation_period_end_date": "2020",
- "start_date": "2020",
- "end_date": "2020",
- "payment_date": "2020",
- "calculated_salary_periods": [
- {
- "calculated_salary_period": "2020"
}
], - "total_invoicing_sum_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_invoicing_sum_without_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "company_fees": [
- {
- "type": "string",
- "percent": "24.00",
- "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "created_at": "2020",
- "name": "string",
- "includes_vat": true,
- "invoice_discount_amount_used": true,
- "invoice_discount_total_amount_used": null,
- "invoice_discount_amount_left": true,
- "invoice_discount_amount": true
}
], - "receipt_expenses_with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "receipt_expenses_without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "receipt_expenses": [
- {
- "id": "2022",
- "created_at": "2020",
- "processed_at": "2020",
- "additional_information": "string",
- "place_of_purchase": "string",
- "purchase_date": "2020",
- "sum_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum_without_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "filename": "string"
}
], - "travel_expenses_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "travel_expenses": [
- {
- "kilometer_allowances": {
- "amount": "24.00",
- "cost_per": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "full_day_allowance_100_percent": {
- "amount": "24.00",
- "cost_per": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "full_day_allowance_50_percent": {
- "amount": "24.00",
- "cost_per": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "half_day_allowance_100_percent": {
- "amount": "24.00",
- "cost_per": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "half_day_allowance_50_percent": {
- "amount": "24.00",
- "cost_per": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "meal_allowances": {
- "amount": "24.00",
- "cost_per": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}
}
], - "gross_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "average_employee_fee_percent": "24.00",
- "average_health_insurance_fee_percent": "24.00",
- "average_legacy_health_insurance_fee_percent": "24.00",
- "average_health_insurance_fee_without_vat_percent": "24.00",
- "employee_fees_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "average_yel_percent": "24.00",
- "employee_fees": [
- {
- "type": "string",
- "percent": "24.00",
- "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "created_at": "2020"
}
], - "net_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "yel_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "is_required_yel_payments_paid": true,
- "yel_fees": [
- {
- "name": "string",
- "type": "string",
- "percent": "24.00",
- "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "created_at": "2020"
}
], - "is_yel_discount": true,
- "withheld_health_insurance_fee_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "withheld_health_insurance_fee_without_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "withheld_health_insurance_fee_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "health_insurance_fees": [
- {
- "name": "string",
- "type": "string",
- "percent": "24.00",
- "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "created_at": "2020"
}
], - "is_fast_payment_enabled": true,
- "payment_calculation_starting_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "fast_payment": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum_to_foreclose": {
- "amount": "2000",
- "currency": "EUR"
}, - "foreclosure": {
- "sum_to_calculate_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum_to_calculate_from_extra": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum_to_calculate_from_without_other_income_per_month": {
- "amount": "2000",
- "currency": "EUR"
}, - "minimum": {
- "amount": "2000",
- "currency": "EUR"
}, - "maximum": {
- "amount": "2000",
- "currency": "EUR"
}, - "maximum_total": {
- "amount": "2000",
- "currency": "EUR"
}, - "maximum_monthly": {
- "amount": "2000",
- "currency": "EUR"
}, - "maximum_per_payment": {
- "amount": "2000",
- "currency": "EUR"
}, - "minimum_monthly": {
- "amount": "2000",
- "currency": "EUR"
}, - "minimum_per_payment": {
- "amount": "2000",
- "currency": "EUR"
}, - "paid_total_before": {
- "amount": "2000",
- "currency": "EUR"
}, - "amount_paid_this_month": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_amount_left_to_pay": {
- "amount": "2000",
- "currency": "EUR"
}, - "amount_left_to_pay_this_month": {
- "amount": "2000",
- "currency": "EUR"
}, - "percent": "24.00",
- "protected_per_day": {
- "amount": "2000",
- "currency": "EUR"
}, - "protected_total": {
- "amount": "2000",
- "currency": "EUR"
}, - "extra_amount_to_leave": {
- "amount": "2000",
- "currency": "EUR"
}, - "other_income_per_month": {
- "amount": "2000",
- "currency": "EUR"
}, - "is_under_protected": true,
- "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "is_monthly_maximum_paid": true,
- "is_total_amount_paid": true,
- "is_monthly_maximum_reached": true,
- "is_maximum_payment_reached": true,
- "is_total_amount_reached": true,
- "is_payment_maximum_paid": true,
- "is_under_monthly_minimum": true,
- "is_under_payment_minimum": true,
- "is_current_month_free_from_foreclosure": true,
- "iban": "string",
- "reference": "string",
- "salary_payment_setting": "123124",
- "calculation_method": "123124",
- "calculation_date": "2020"
}, - "sum_before_salary_fees": {
- "amount": "2000",
- "currency": "EUR"
}, - "salary_fees_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "salary_fees_with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "salary_fees_without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "combined_expenses_sum_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum_to_calculate_foreclosure_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "combined_expenses_sum_without_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "salary_fees": [
- {
- "type": "string",
- "percent": "24.00",
- "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "created_at": "2020",
- "name": "string",
- "includes_vat": true
}
], - "sum_after_salary_fees": {
- "amount": "2000",
- "currency": "EUR"
}, - "final_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "final_salary_with_expenses": {
- "amount": "2000",
- "currency": "EUR"
}, - "juel_total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "created_at": "2020",
- "personal_deductions": {
- "yel": {
- "amount": "2000",
- "currency": "EUR"
}, - "commission": {
- "amount": "2000",
- "currency": "EUR"
}, - "additional_cost": {
- "amount": "2000",
- "currency": "EUR"
}, - "fast_payment": {
- "amount": "2000",
- "currency": "EUR"
}, - "health_insurance_fee": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "personal_deductions_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "work_hours": "24.00",
- "holiday_compensation": {
- "amount": "2000",
- "currency": "EUR"
}, - "salary_without_holiday_compensation": {
- "amount": "2000",
- "currency": "EUR"
}, - "legacy_health_insurance_sum_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "legacy_health_insurance_sum_without_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "legacy_health_insurance_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "user_id": "123124",
- "payer_user_id": "123124",
- "calculated_salary_ids": [
- {
- "calculated_salary_id": 0
}
], - "invoice_ids": [
- {
- "invoice_id": 0
}
], - "bank_account": "string",
- "periods": [
- {
- "period": "2020-10-10 - 2020-11-11"
}
]
}
{- "data": {
- "id": 0,
- "user_id": 0,
- "salary_transaction_id": 0,
- "expenses_transaction_id": 0,
- "foreclosure_transaction_id": 0,
- "calculated_salary_ids_json": "string",
- "invoice_ids_json": "string",
- "total_invoicing_sum_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_invoicing_sum_without_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "company_fees_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "expenses_with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "expenses_without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "receipt_expenses_with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "receipt_expenses_without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "travel_expenses_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "base_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "employer_fees_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "gross_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "salary_without_holiday_compensation": {
- "amount": "2000",
- "currency": "EUR"
}, - "holiday_compensation": {
- "amount": "2000",
- "currency": "EUR"
}, - "employee_fees_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "net_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "withheld_yel": {
- "amount": "2000",
- "currency": "EUR"
}, - "health_insurance_fee_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "salary_fees_with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "salary_fees_without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "salary_fees_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "fast_payment_fee": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum_to_foreclose_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "foreclosure_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "final_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "final_salary_with_expenses": {
- "amount": "2000",
- "currency": "EUR"
}, - "juel_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "personal_deductions_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "health_insurance_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "notes": "string",
- "work_hours": 0.1,
- "refunded": true,
- "is_yel_discount": true,
- "is_yel_required_paid": true,
- "is_fast_payment_enabled": true,
- "transaction_date": "2020-09-20",
- "payment_date": "2020-09-20",
- "start_date": "2020-09-20",
- "end_date": "2020-09-20",
- "created_at": "2020-09-20T18:30:00+03:00",
- "updated_at": "2020-09-20T18:30:00+03:00",
- "deleted_at": "2020-09-20T18:30:00+03:00"
}
}
InvoicingSumFromTargetSalaryRequest
object (Money) Money value schema | |
object (Money) Money value schema | |
contains_vat | boolean |
invoicing_vat_percentage | number <float> |
withholding_tax_percentage | number <float> |
yel_obligated | boolean |
yel_start_date | string <date> |
age | integer Ages between 18 and 67 get YEL calculations based on this |
country | string Client's country as ISO short code (FI, GB, RU etc) |
object | |
object |
{- "target_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "price_per_hour": {
- "amount": "2000",
- "currency": "EUR"
}, - "contains_vat": "true",
- "invoicing_vat_percentage": "24.00",
- "withholding_tax_percentage": "60.00",
- "yel_obligated": "true",
- "yel_start_date": "2020-06-09",
- "age": "30",
- "country": "FI",
- "travel_expenses": {
- "kilometer_amount": "200",
- "full_day_amount": "10",
- "half_day_amount": "2",
- "meal_amount": "3"
}, - "receipt_expenses": {
- "vat_percentage": "24.00",
- "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}
}
{ }
SalaryFromInvoicingSumRequest
object (Money) Money value schema | |
object (Money) Money value schema | |
contains_vat | boolean |
invoicing_vat_percentage | number <float> |
withholding_tax_percentage | number <float> |
yel_obligated | boolean |
yel_start_date | string <date> |
age | integer Ages between 18 and 67 get YEL calculations based on this |
country | string Client's country as ISO short code (FI, GB, RU etc) |
commission_percent | number <float> Custom commission percent |
object | |
object |
{- "total_invoicing_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "price_per_hour": {
- "amount": "2000",
- "currency": "EUR"
}, - "contains_vat": "true",
- "invoicing_vat_percentage": "24.00",
- "withholding_tax_percentage": "60.00",
- "yel_obligated": "true",
- "yel_start_date": "2020-06-09",
- "age": "30",
- "country": "FI",
- "commission_percent": "5.0",
- "travel_expenses": {
- "kilometer_amount": "200",
- "full_day_amount": "10",
- "half_day_amount": "2",
- "meal_amount": "3"
}, - "receipt_expenses": {
- "vat_percentage": "24.00",
- "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}
}
{ }
InvoicingSumFromTargetSalaryRequest
object (Money) Money value schema | |
object (Money) Money value schema | |
contains_vat | boolean |
invoicing_vat_percentage | number <float> |
withholding_tax_percentage | number <float> |
yel_obligated | boolean |
yel_start_date | string <date> |
age | integer Ages between 18 and 67 get YEL calculations based on this |
country | string Client's country as ISO short code (FI, GB, RU etc) |
object | |
object |
{- "target_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "price_per_hour": {
- "amount": "2000",
- "currency": "EUR"
}, - "contains_vat": "true",
- "invoicing_vat_percentage": "24.00",
- "withholding_tax_percentage": "60.00",
- "yel_obligated": "true",
- "yel_start_date": "2020-06-09",
- "age": "30",
- "country": "FI",
- "travel_expenses": {
- "kilometer_amount": "200",
- "full_day_amount": "10",
- "half_day_amount": "2",
- "meal_amount": "3"
}, - "receipt_expenses": {
- "vat_percentage": "24.00",
- "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}
}
{ }
list_type required | string List type: 'all' or 'unpaid' |
{- "data": {
- "id": 0,
- "user_id": 0,
- "comments": "string",
- "filename": "string",
- "paid": true,
- "notes": "string",
- "company_commission_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "invoices": [
- {
- "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
}
], - "receipt_expenses_total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "receipt_expenses_total_sum_without_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "receipt_expenses_total_sum_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "gross_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "net_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "final_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "juel_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "salary_without_holiday_compensation": {
- "amount": "2000",
- "currency": "EUR"
}, - "holiday_bonus_pay": {
- "amount": "2000",
- "currency": "EUR"
}, - "holiday_pay": {
- "amount": "2000",
- "currency": "EUR"
}, - "accident_insurance_percent": 0.1,
- "accident_insurance": {
- "amount": "2000",
- "currency": "EUR"
}, - "group_life_insurance": {
- "amount": "2000",
- "currency": "EUR"
}, - "unemployment_insurance": {
- "amount": "2000",
- "currency": "EUR"
}, - "withheld_yel": {
- "amount": "2000",
- "currency": "EUR"
}, - "yel_percent": 0.1,
- "ssn": 0.1,
- "calculation_date": "2020-09-20",
- "created_at": "2020-09-20T18:30:00+03:00",
- "updated_at": "2020-09-20T18:30:00+03:00"
}
}
{- "data": {
- "id": 0,
- "user_id": 0,
- "comments": "string",
- "filename": "string",
- "paid": true,
- "notes": "string",
- "company_commission_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "invoices": [
- {
- "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
}
], - "receipt_expenses_total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "receipt_expenses_total_sum_without_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "receipt_expenses_total_sum_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "gross_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "net_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "final_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "juel_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "salary_without_holiday_compensation": {
- "amount": "2000",
- "currency": "EUR"
}, - "holiday_bonus_pay": {
- "amount": "2000",
- "currency": "EUR"
}, - "holiday_pay": {
- "amount": "2000",
- "currency": "EUR"
}, - "accident_insurance_percent": 0.1,
- "accident_insurance": {
- "amount": "2000",
- "currency": "EUR"
}, - "group_life_insurance": {
- "amount": "2000",
- "currency": "EUR"
}, - "unemployment_insurance": {
- "amount": "2000",
- "currency": "EUR"
}, - "withheld_yel": {
- "amount": "2000",
- "currency": "EUR"
}, - "yel_percent": 0.1,
- "ssn": 0.1,
- "calculation_date": "2020-09-20",
- "created_at": "2020-09-20T18:30:00+03:00",
- "updated_at": "2020-09-20T18:30:00+03:00"
}
}
calculated_salary_id required | integer Calculated salary id |
{- "data": {
- "id": 0,
- "user_id": 0,
- "comments": "string",
- "filename": "string",
- "paid": true,
- "notes": "string",
- "company_commission_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "invoices": [
- {
- "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
}
], - "receipt_expenses_total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "receipt_expenses_total_sum_without_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "receipt_expenses_total_sum_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "gross_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "net_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "final_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "juel_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "salary_without_holiday_compensation": {
- "amount": "2000",
- "currency": "EUR"
}, - "holiday_bonus_pay": {
- "amount": "2000",
- "currency": "EUR"
}, - "holiday_pay": {
- "amount": "2000",
- "currency": "EUR"
}, - "accident_insurance_percent": 0.1,
- "accident_insurance": {
- "amount": "2000",
- "currency": "EUR"
}, - "group_life_insurance": {
- "amount": "2000",
- "currency": "EUR"
}, - "unemployment_insurance": {
- "amount": "2000",
- "currency": "EUR"
}, - "withheld_yel": {
- "amount": "2000",
- "currency": "EUR"
}, - "yel_percent": 0.1,
- "ssn": 0.1,
- "calculation_date": "2020-09-20",
- "created_at": "2020-09-20T18:30:00+03:00",
- "updated_at": "2020-09-20T18:30:00+03:00"
}
}
Satisfy SPA and modern consumers by returning calculated_salary.dataJson like it is.
calculated_salary_id required | integer Calculated salary id |
{- "id": "2022",
- "invoicing_vat_percent": "24",
- "total_invoicing_sum_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_invoicing_sum_without_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_invoicing_sum_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "work_hours": "20.3",
- "company_fees": {
- "commission": {
- "percent": "24.00",
- "minimum": {
- "amount": "2000",
- "currency": "EUR"
}, - "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "invoice_discount_amount": {
- "amount": "2000",
- "currency": "EUR"
}, - "invoice_discount_amount_used": {
- "amount": "2000",
- "currency": "EUR"
}, - "invoice_discount_total_amount_used": {
- "amount": "2000",
- "currency": "EUR"
}, - "invoice_discount_amount_left": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "additional_cost": {
- "percent": "24.00",
- "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "health_insurance_debt": {
- "type": "string",
- "created_at": "string",
- "name": "string",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "percent": "24.00",
- "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00"
}, - "salary_advance": {
- "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "percent": "24.00",
- "minimum": {
- "amount": "2000",
- "currency": "EUR"
}, - "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "partner_commission": {
- "percent": "24.00",
- "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "includes_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "minimum_commission_applied": true,
- "maximum_commission_applied": true,
- "maximum_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "minimum_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "name": ""
}, - "extra_service_fee": {
- "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "percent": "24.00",
- "minimum": {
- "amount": "2000",
- "currency": "EUR"
}, - "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00"
}, - "fast_payment": {
- "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "percent": "24.00",
- "minimum": {
- "amount": "2000",
- "currency": "EUR"
}, - "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00"
}, - "accident_insurance": {
- "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "percent": "24.00",
- "minimum": {
- "amount": "2000",
- "currency": "EUR"
}, - "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}
}
}, - "company_fees_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_invoicing_sum_without_vat_minus_company_fees": {
- "amount": "2000",
- "currency": "EUR"
}, - "combined_expenses_sum_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "combined_expenses_sum_without_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "combined_expenses_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "receipt_expenses_without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "receipt_expenses_with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "receipt_expenses_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "travel_expenses": {
- "kilometer_allowances": {
- "amount": "2022",
- "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "cost_per": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "full_day_100_percent_allowances": {
- "amount": "2022",
- "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "cost_per": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "full_day_50_percent_allowances": {
- "amount": "2022",
- "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "cost_per": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "half_day_100_percent_allowances": {
- "amount": "2022",
- "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "cost_per": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "half_day_50_percent_allowances": {
- "amount": "2022",
- "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "cost_per": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "meal_allowances": {
- "amount": "2022",
- "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "cost_per": {
- "amount": "2000",
- "currency": "EUR"
}
}
}, - "travel_expenses_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "base_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "employer_fees": { },
- "gross_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "employee_fees": {
- "tax_percent": {
- "percent": "30.00",
- "sum": {
- "amount": "2000",
- "currency": "EUR"
}
}
}, - "employee_fees_percent": "24.00",
- "employee_fees_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "holiday_compensation_percent": "24.00",
- "salary_without_holiday_compensation": {
- "amount": "2000",
- "currency": "EUR"
}, - "holiday_compensation": {
- "amount": "2000",
- "currency": "EUR"
}, - "legacy_health_insurance_percent": "0.74",
- "legacy_health_insurance_fee": {
- "amount": "2000",
- "currency": "EUR"
}, - "health_insurance_debt_amount": {
- "amount": "2000",
- "currency": "EUR"
}, - "net_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "is_yel_enabled": "true",
- "is_required_yel_payments_paid": "true",
- "yel": {
- "percent": "24.00",
- "maximum": {
- "amount": "2000",
- "currency": "EUR"
}, - "is_discount": "true",
- "is_required_yel_payments_paid": "true",
- "withheld_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "withheld_health_insurance_fee_without_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "withheld_health_insurance_fee_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "withheld_health_insurance_fee_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "withheld_health_insurance_percent": "0.74",
- "withheld_health_insurance_vat_percent": "24.0",
- "sum_to_calculate_foreclosure_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum_before_foreclosure": {
- "amount": "2000",
- "currency": "EUR"
}, - "foreclosure": {
- "calculation_starting_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum_to_calculate_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum_to_calculate_from_extra": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum_to_calculate_from_without_other_income_per_month": {
- "amount": "2000",
- "currency": "EUR"
}, - "minimum": {
- "amount": "2000",
- "currency": "EUR"
}, - "maximum": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_amount": {
- "amount": "2000",
- "currency": "EUR"
}, - "maximum_monthly": {
- "amount": "2000",
- "currency": "EUR"
}, - "maximum_per_payment": {
- "amount": "2000",
- "currency": "EUR"
}, - "minimum_monthly": {
- "amount": "2000",
- "currency": "EUR"
}, - "minimum_per_payment": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_amount_paid": {
- "amount": "2000",
- "currency": "EUR"
}, - "amount_paid_this_month": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_amount_left_to_pay": {
- "amount": "2000",
- "currency": "EUR"
}, - "amount_left_to_pay_this_month": {
- "amount": "2000",
- "currency": "EUR"
}, - "percent": "24.00",
- "protected_per_day": {
- "amount": "2000",
- "currency": "EUR"
}, - "protected_total": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum_to_calculate_foreclosure_from_divided_by_protected_amount_total": {
- "amount": "2000",
- "currency": "EUR"
}, - "is_sum_to_calculate_foreclosure_from_less_than_protected_amount": "true",
- "is_sum_to_calculate_foreclosure_from_greater_than_protected_amount_and_less_than_2_times_protected_amount": "true",
- "is_sum_to_calculate_foreclosure_from_at_least_2_times_and_less_than_4_times_protected_amount": "true",
- "is_sum_to_calculate_foreclosure_from_at_least_4_times_protected_amount": "true",
- "extra_amount_to_leave": {
- "amount": "2000",
- "currency": "EUR"
}, - "other_income_per_month": {
- "amount": "2000",
- "currency": "EUR"
}, - "is_under_protected": "true",
- "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "is_monthly_maximum_paid": "true",
- "is_total_amount_paid": "true",
- "is_monthly_maximum_reached": "true",
- "is_total_amount_reached": "true",
- "is_maximum_payment_reached": "true",
- "is_under_monthly_minimum": "true",
- "is_under_payment_minimum": "true",
- "is_current_month_free_from_foreclosure": "true",
- "iban": "FI2112345600000785",
- "reference": "123123213",
- "salary_payment_setting": "true",
- "payment_term": "true",
- "calculation_method": "true",
- "calculation_date": "2020",
- "amount_to_leave_sum_used": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "sum_after_foreclosure": {
- "amount": "2000",
- "currency": "EUR"
}, - "salary_fees_without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "salary_fees_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "salary_fees_with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "salary_fees": {
- "commission": {
- "percent": "24.00",
- "minimum": {
- "amount": "2000",
- "currency": "EUR"
}, - "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "invoice_discount_amount": {
- "amount": "2000",
- "currency": "EUR"
}, - "invoice_discount_amount_used": {
- "amount": "2000",
- "currency": "EUR"
}, - "invoice_discount_total_amount_used": {
- "amount": "2000",
- "currency": "EUR"
}, - "invoice_discount_amount_left": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "additional_cost": {
- "percent": "24.00",
- "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "health_insurance_debt": {
- "type": "string",
- "created_at": "string",
- "name": "string",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "percent": "24.00",
- "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00"
}, - "salary_advance": {
- "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "percent": "24.00",
- "minimum": {
- "amount": "2000",
- "currency": "EUR"
}, - "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "partner_commission": {
- "percent": "24.00",
- "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "includes_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "minimum_commission_applied": true,
- "maximum_commission_applied": true,
- "maximum_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "minimum_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "name": ""
}, - "extra_service_fee": {
- "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "percent": "24.00",
- "minimum": {
- "amount": "2000",
- "currency": "EUR"
}, - "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00"
}, - "fast_payment": {
- "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "percent": "24.00",
- "minimum": {
- "amount": "2000",
- "currency": "EUR"
}, - "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00"
}, - "accident_insurance": {
- "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "percent": "24.00",
- "minimum": {
- "amount": "2000",
- "currency": "EUR"
}, - "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}
}
}, - "sum_after_salary_fees": {
- "amount": "2000",
- "currency": "EUR"
}, - "final_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "final_salary_with_expenses": {
- "amount": "2000",
- "currency": "EUR"
}, - "final_expenses": {
- "amount": "2000",
- "currency": "EUR"
}, - "personal_deductions_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "country": "",
- "calculation_year": "2020",
- "start_date": "2020-09-20T18:30:00+03:00",
- "end_date": "2020-09-20T18:30:00+03:00",
- "calculation_date": "2020-09-20T18:30:00+03:00",
- "user_age": "18",
- "user_birth_year": "1980",
- "is_strict_checked": "true",
- "is_fast_payment_enabled": "true",
- "is_extra_service_fee_enabled": "true",
- "adjusted_tax_percent": "true",
- "paid_salary_id": "123124",
- "paid_salary_date": "2020-09-20T18:30:00+03:00",
- "salary_buckets": [
- {
- "start_date": "Y-m-d\\TH:i:sP",
- "end_date": "Y-m-d\\TH:i:sP",
- "total_gross_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "health_insurance_obligated": "true",
- "is_of_age": "true",
- "type": "ADMIN_OVERRIDDEN",
- "retroactive_debt_handling": "NONE",
- "admin_explanation": "string"
}
], - "is_salary_too_small_for_fast_payment": "true",
- "juel_total_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}
Satisfy SPA and other API consumers by returning paid_salary.dataJson as modern PaidSalaryResult.
paid_salary_id required | integer Paid salary id |
{- "calculation_period_start_date": "2020",
- "calculation_period_end_date": "2020",
- "start_date": "2020",
- "end_date": "2020",
- "payment_date": "2020",
- "calculated_salary_periods": [
- {
- "calculated_salary_period": "2020"
}
], - "total_invoicing_sum_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_invoicing_sum_without_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "company_fees": [
- {
- "type": "string",
- "percent": "24.00",
- "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "created_at": "2020",
- "name": "string",
- "includes_vat": true,
- "invoice_discount_amount_used": true,
- "invoice_discount_total_amount_used": null,
- "invoice_discount_amount_left": true,
- "invoice_discount_amount": true
}
], - "receipt_expenses_with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "receipt_expenses_without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "receipt_expenses": [
- {
- "id": "2022",
- "created_at": "2020",
- "processed_at": "2020",
- "additional_information": "string",
- "place_of_purchase": "string",
- "purchase_date": "2020",
- "sum_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum_without_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "filename": "string"
}
], - "travel_expenses_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "travel_expenses": [
- {
- "kilometer_allowances": {
- "amount": "24.00",
- "cost_per": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "full_day_allowance_100_percent": {
- "amount": "24.00",
- "cost_per": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "full_day_allowance_50_percent": {
- "amount": "24.00",
- "cost_per": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "half_day_allowance_100_percent": {
- "amount": "24.00",
- "cost_per": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "half_day_allowance_50_percent": {
- "amount": "24.00",
- "cost_per": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "meal_allowances": {
- "amount": "24.00",
- "cost_per": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}
}
], - "gross_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "average_employee_fee_percent": "24.00",
- "average_health_insurance_fee_percent": "24.00",
- "average_legacy_health_insurance_fee_percent": "24.00",
- "average_health_insurance_fee_without_vat_percent": "24.00",
- "employee_fees_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "average_yel_percent": "24.00",
- "employee_fees": [
- {
- "type": "string",
- "percent": "24.00",
- "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "created_at": "2020"
}
], - "net_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "yel_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "is_required_yel_payments_paid": true,
- "yel_fees": [
- {
- "name": "string",
- "type": "string",
- "percent": "24.00",
- "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "created_at": "2020"
}
], - "is_yel_discount": true,
- "withheld_health_insurance_fee_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "withheld_health_insurance_fee_without_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "withheld_health_insurance_fee_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "health_insurance_fees": [
- {
- "name": "string",
- "type": "string",
- "percent": "24.00",
- "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "created_at": "2020"
}
], - "is_fast_payment_enabled": true,
- "payment_calculation_starting_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "fast_payment": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum_to_foreclose": {
- "amount": "2000",
- "currency": "EUR"
}, - "foreclosure": {
- "sum_to_calculate_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum_to_calculate_from_extra": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum_to_calculate_from_without_other_income_per_month": {
- "amount": "2000",
- "currency": "EUR"
}, - "minimum": {
- "amount": "2000",
- "currency": "EUR"
}, - "maximum": {
- "amount": "2000",
- "currency": "EUR"
}, - "maximum_total": {
- "amount": "2000",
- "currency": "EUR"
}, - "maximum_monthly": {
- "amount": "2000",
- "currency": "EUR"
}, - "maximum_per_payment": {
- "amount": "2000",
- "currency": "EUR"
}, - "minimum_monthly": {
- "amount": "2000",
- "currency": "EUR"
}, - "minimum_per_payment": {
- "amount": "2000",
- "currency": "EUR"
}, - "paid_total_before": {
- "amount": "2000",
- "currency": "EUR"
}, - "amount_paid_this_month": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_amount_left_to_pay": {
- "amount": "2000",
- "currency": "EUR"
}, - "amount_left_to_pay_this_month": {
- "amount": "2000",
- "currency": "EUR"
}, - "percent": "24.00",
- "protected_per_day": {
- "amount": "2000",
- "currency": "EUR"
}, - "protected_total": {
- "amount": "2000",
- "currency": "EUR"
}, - "extra_amount_to_leave": {
- "amount": "2000",
- "currency": "EUR"
}, - "other_income_per_month": {
- "amount": "2000",
- "currency": "EUR"
}, - "is_under_protected": true,
- "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "is_monthly_maximum_paid": true,
- "is_total_amount_paid": true,
- "is_monthly_maximum_reached": true,
- "is_maximum_payment_reached": true,
- "is_total_amount_reached": true,
- "is_payment_maximum_paid": true,
- "is_under_monthly_minimum": true,
- "is_under_payment_minimum": true,
- "is_current_month_free_from_foreclosure": true,
- "iban": "string",
- "reference": "string",
- "salary_payment_setting": "123124",
- "calculation_method": "123124",
- "calculation_date": "2020"
}, - "sum_before_salary_fees": {
- "amount": "2000",
- "currency": "EUR"
}, - "salary_fees_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "salary_fees_with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "salary_fees_without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "combined_expenses_sum_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum_to_calculate_foreclosure_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "combined_expenses_sum_without_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "salary_fees": [
- {
- "type": "string",
- "percent": "24.00",
- "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "created_at": "2020",
- "name": "string",
- "includes_vat": true
}
], - "sum_after_salary_fees": {
- "amount": "2000",
- "currency": "EUR"
}, - "final_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "final_salary_with_expenses": {
- "amount": "2000",
- "currency": "EUR"
}, - "juel_total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "created_at": "2020",
- "personal_deductions": {
- "yel": {
- "amount": "2000",
- "currency": "EUR"
}, - "commission": {
- "amount": "2000",
- "currency": "EUR"
}, - "additional_cost": {
- "amount": "2000",
- "currency": "EUR"
}, - "fast_payment": {
- "amount": "2000",
- "currency": "EUR"
}, - "health_insurance_fee": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "personal_deductions_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "work_hours": "24.00",
- "holiday_compensation": {
- "amount": "2000",
- "currency": "EUR"
}, - "salary_without_holiday_compensation": {
- "amount": "2000",
- "currency": "EUR"
}, - "legacy_health_insurance_sum_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "legacy_health_insurance_sum_without_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "legacy_health_insurance_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "user_id": "123124",
- "payer_user_id": "123124",
- "calculated_salary_ids": [
- {
- "calculated_salary_id": 0
}
], - "invoice_ids": [
- {
- "invoice_id": 0
}
], - "bank_account": "string",
- "periods": [
- {
- "period": "2020-10-10 - 2020-11-11"
}
]
}
Modern version of the above but for SPA.
Satisfy SPA and other API consumers by returning ModernPaidSalaryResult.
null
{- "calculation_period_start_date": "2020",
- "calculation_period_end_date": "2020",
- "start_date": "2020",
- "end_date": "2020",
- "payment_date": "2020",
- "calculated_salary_periods": [
- {
- "calculated_salary_period": "2020"
}
], - "total_invoicing_sum_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_invoicing_sum_without_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "company_fees": [
- {
- "type": "string",
- "percent": "24.00",
- "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "created_at": "2020",
- "name": "string",
- "includes_vat": true,
- "invoice_discount_amount_used": true,
- "invoice_discount_total_amount_used": null,
- "invoice_discount_amount_left": true,
- "invoice_discount_amount": true
}
], - "receipt_expenses_with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "receipt_expenses_without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "receipt_expenses": [
- {
- "id": "2022",
- "created_at": "2020",
- "processed_at": "2020",
- "additional_information": "string",
- "place_of_purchase": "string",
- "purchase_date": "2020",
- "sum_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum_without_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "filename": "string"
}
], - "travel_expenses_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "travel_expenses": [
- {
- "kilometer_allowances": {
- "amount": "24.00",
- "cost_per": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "full_day_allowance_100_percent": {
- "amount": "24.00",
- "cost_per": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "full_day_allowance_50_percent": {
- "amount": "24.00",
- "cost_per": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "half_day_allowance_100_percent": {
- "amount": "24.00",
- "cost_per": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "half_day_allowance_50_percent": {
- "amount": "24.00",
- "cost_per": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "meal_allowances": {
- "amount": "24.00",
- "cost_per": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}
}
], - "gross_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "average_employee_fee_percent": "24.00",
- "average_health_insurance_fee_percent": "24.00",
- "average_legacy_health_insurance_fee_percent": "24.00",
- "average_health_insurance_fee_without_vat_percent": "24.00",
- "employee_fees_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "average_yel_percent": "24.00",
- "employee_fees": [
- {
- "type": "string",
- "percent": "24.00",
- "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "created_at": "2020"
}
], - "net_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "yel_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "is_required_yel_payments_paid": true,
- "yel_fees": [
- {
- "name": "string",
- "type": "string",
- "percent": "24.00",
- "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "created_at": "2020"
}
], - "is_yel_discount": true,
- "withheld_health_insurance_fee_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "withheld_health_insurance_fee_without_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "withheld_health_insurance_fee_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "health_insurance_fees": [
- {
- "name": "string",
- "type": "string",
- "percent": "24.00",
- "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "created_at": "2020"
}
], - "is_fast_payment_enabled": true,
- "payment_calculation_starting_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "fast_payment": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum_to_foreclose": {
- "amount": "2000",
- "currency": "EUR"
}, - "foreclosure": {
- "sum_to_calculate_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum_to_calculate_from_extra": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum_to_calculate_from_without_other_income_per_month": {
- "amount": "2000",
- "currency": "EUR"
}, - "minimum": {
- "amount": "2000",
- "currency": "EUR"
}, - "maximum": {
- "amount": "2000",
- "currency": "EUR"
}, - "maximum_total": {
- "amount": "2000",
- "currency": "EUR"
}, - "maximum_monthly": {
- "amount": "2000",
- "currency": "EUR"
}, - "maximum_per_payment": {
- "amount": "2000",
- "currency": "EUR"
}, - "minimum_monthly": {
- "amount": "2000",
- "currency": "EUR"
}, - "minimum_per_payment": {
- "amount": "2000",
- "currency": "EUR"
}, - "paid_total_before": {
- "amount": "2000",
- "currency": "EUR"
}, - "amount_paid_this_month": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_amount_left_to_pay": {
- "amount": "2000",
- "currency": "EUR"
}, - "amount_left_to_pay_this_month": {
- "amount": "2000",
- "currency": "EUR"
}, - "percent": "24.00",
- "protected_per_day": {
- "amount": "2000",
- "currency": "EUR"
}, - "protected_total": {
- "amount": "2000",
- "currency": "EUR"
}, - "extra_amount_to_leave": {
- "amount": "2000",
- "currency": "EUR"
}, - "other_income_per_month": {
- "amount": "2000",
- "currency": "EUR"
}, - "is_under_protected": true,
- "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "is_monthly_maximum_paid": true,
- "is_total_amount_paid": true,
- "is_monthly_maximum_reached": true,
- "is_maximum_payment_reached": true,
- "is_total_amount_reached": true,
- "is_payment_maximum_paid": true,
- "is_under_monthly_minimum": true,
- "is_under_payment_minimum": true,
- "is_current_month_free_from_foreclosure": true,
- "iban": "string",
- "reference": "string",
- "salary_payment_setting": "123124",
- "calculation_method": "123124",
- "calculation_date": "2020"
}, - "sum_before_salary_fees": {
- "amount": "2000",
- "currency": "EUR"
}, - "salary_fees_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "salary_fees_with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "salary_fees_without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "combined_expenses_sum_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum_to_calculate_foreclosure_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "combined_expenses_sum_without_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "salary_fees": [
- {
- "type": "string",
- "percent": "24.00",
- "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "created_at": "2020",
- "name": "string",
- "includes_vat": true
}
], - "sum_after_salary_fees": {
- "amount": "2000",
- "currency": "EUR"
}, - "final_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "final_salary_with_expenses": {
- "amount": "2000",
- "currency": "EUR"
}, - "juel_total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "created_at": "2020",
- "personal_deductions": {
- "yel": {
- "amount": "2000",
- "currency": "EUR"
}, - "commission": {
- "amount": "2000",
- "currency": "EUR"
}, - "additional_cost": {
- "amount": "2000",
- "currency": "EUR"
}, - "fast_payment": {
- "amount": "2000",
- "currency": "EUR"
}, - "health_insurance_fee": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "personal_deductions_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "work_hours": "24.00",
- "holiday_compensation": {
- "amount": "2000",
- "currency": "EUR"
}, - "salary_without_holiday_compensation": {
- "amount": "2000",
- "currency": "EUR"
}, - "legacy_health_insurance_sum_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "legacy_health_insurance_sum_without_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "legacy_health_insurance_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "user_id": "123124",
- "payer_user_id": "123124",
- "calculated_salary_ids": [
- {
- "calculated_salary_id": 0
}
], - "invoice_ids": [
- {
- "invoice_id": 0
}
], - "bank_account": "string",
- "periods": [
- {
- "period": "2020-10-10 - 2020-11-11"
}
]
}
user_id required | integer User id |
null
{- "calculation_period_start_date": "2020",
- "calculation_period_end_date": "2020",
- "start_date": "2020",
- "end_date": "2020",
- "payment_date": "2020",
- "calculated_salary_periods": [
- {
- "calculated_salary_period": "2020"
}
], - "total_invoicing_sum_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_invoicing_sum_without_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "company_fees": [
- {
- "type": "string",
- "percent": "24.00",
- "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "created_at": "2020",
- "name": "string",
- "includes_vat": true,
- "invoice_discount_amount_used": true,
- "invoice_discount_total_amount_used": null,
- "invoice_discount_amount_left": true,
- "invoice_discount_amount": true
}
], - "receipt_expenses_with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "receipt_expenses_without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "receipt_expenses": [
- {
- "id": "2022",
- "created_at": "2020",
- "processed_at": "2020",
- "additional_information": "string",
- "place_of_purchase": "string",
- "purchase_date": "2020",
- "sum_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum_without_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "filename": "string"
}
], - "travel_expenses_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "travel_expenses": [
- {
- "kilometer_allowances": {
- "amount": "24.00",
- "cost_per": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "full_day_allowance_100_percent": {
- "amount": "24.00",
- "cost_per": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "full_day_allowance_50_percent": {
- "amount": "24.00",
- "cost_per": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "half_day_allowance_100_percent": {
- "amount": "24.00",
- "cost_per": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "half_day_allowance_50_percent": {
- "amount": "24.00",
- "cost_per": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "meal_allowances": {
- "amount": "24.00",
- "cost_per": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}
}
], - "gross_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "average_employee_fee_percent": "24.00",
- "average_health_insurance_fee_percent": "24.00",
- "average_legacy_health_insurance_fee_percent": "24.00",
- "average_health_insurance_fee_without_vat_percent": "24.00",
- "employee_fees_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "average_yel_percent": "24.00",
- "employee_fees": [
- {
- "type": "string",
- "percent": "24.00",
- "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "created_at": "2020"
}
], - "net_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "yel_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "is_required_yel_payments_paid": true,
- "yel_fees": [
- {
- "name": "string",
- "type": "string",
- "percent": "24.00",
- "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "created_at": "2020"
}
], - "is_yel_discount": true,
- "withheld_health_insurance_fee_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "withheld_health_insurance_fee_without_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "withheld_health_insurance_fee_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "health_insurance_fees": [
- {
- "name": "string",
- "type": "string",
- "percent": "24.00",
- "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "created_at": "2020"
}
], - "is_fast_payment_enabled": true,
- "payment_calculation_starting_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "fast_payment": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum_to_foreclose": {
- "amount": "2000",
- "currency": "EUR"
}, - "foreclosure": {
- "sum_to_calculate_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum_to_calculate_from_extra": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum_to_calculate_from_without_other_income_per_month": {
- "amount": "2000",
- "currency": "EUR"
}, - "minimum": {
- "amount": "2000",
- "currency": "EUR"
}, - "maximum": {
- "amount": "2000",
- "currency": "EUR"
}, - "maximum_total": {
- "amount": "2000",
- "currency": "EUR"
}, - "maximum_monthly": {
- "amount": "2000",
- "currency": "EUR"
}, - "maximum_per_payment": {
- "amount": "2000",
- "currency": "EUR"
}, - "minimum_monthly": {
- "amount": "2000",
- "currency": "EUR"
}, - "minimum_per_payment": {
- "amount": "2000",
- "currency": "EUR"
}, - "paid_total_before": {
- "amount": "2000",
- "currency": "EUR"
}, - "amount_paid_this_month": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_amount_left_to_pay": {
- "amount": "2000",
- "currency": "EUR"
}, - "amount_left_to_pay_this_month": {
- "amount": "2000",
- "currency": "EUR"
}, - "percent": "24.00",
- "protected_per_day": {
- "amount": "2000",
- "currency": "EUR"
}, - "protected_total": {
- "amount": "2000",
- "currency": "EUR"
}, - "extra_amount_to_leave": {
- "amount": "2000",
- "currency": "EUR"
}, - "other_income_per_month": {
- "amount": "2000",
- "currency": "EUR"
}, - "is_under_protected": true,
- "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "is_monthly_maximum_paid": true,
- "is_total_amount_paid": true,
- "is_monthly_maximum_reached": true,
- "is_maximum_payment_reached": true,
- "is_total_amount_reached": true,
- "is_payment_maximum_paid": true,
- "is_under_monthly_minimum": true,
- "is_under_payment_minimum": true,
- "is_current_month_free_from_foreclosure": true,
- "iban": "string",
- "reference": "string",
- "salary_payment_setting": "123124",
- "calculation_method": "123124",
- "calculation_date": "2020"
}, - "sum_before_salary_fees": {
- "amount": "2000",
- "currency": "EUR"
}, - "salary_fees_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "salary_fees_with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "salary_fees_without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "combined_expenses_sum_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum_to_calculate_foreclosure_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "combined_expenses_sum_without_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "salary_fees": [
- {
- "type": "string",
- "percent": "24.00",
- "without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "vat_percent": "24.00",
- "calculated_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "created_at": "2020",
- "name": "string",
- "includes_vat": true
}
], - "sum_after_salary_fees": {
- "amount": "2000",
- "currency": "EUR"
}, - "final_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "final_salary_with_expenses": {
- "amount": "2000",
- "currency": "EUR"
}, - "juel_total_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "created_at": "2020",
- "personal_deductions": {
- "yel": {
- "amount": "2000",
- "currency": "EUR"
}, - "commission": {
- "amount": "2000",
- "currency": "EUR"
}, - "additional_cost": {
- "amount": "2000",
- "currency": "EUR"
}, - "fast_payment": {
- "amount": "2000",
- "currency": "EUR"
}, - "health_insurance_fee": {
- "amount": "2000",
- "currency": "EUR"
}
}, - "personal_deductions_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "work_hours": "24.00",
- "holiday_compensation": {
- "amount": "2000",
- "currency": "EUR"
}, - "salary_without_holiday_compensation": {
- "amount": "2000",
- "currency": "EUR"
}, - "legacy_health_insurance_sum_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "legacy_health_insurance_sum_without_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "legacy_health_insurance_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "user_id": "123124",
- "payer_user_id": "123124",
- "calculated_salary_ids": [
- {
- "calculated_salary_id": 0
}
], - "invoice_ids": [
- {
- "invoice_id": 0
}
], - "bank_account": "string",
- "periods": [
- {
- "period": "2020-10-10 - 2020-11-11"
}
]
}
{- "data": {
- "id": 0,
- "user_id": 0,
- "salary_transaction_id": 0,
- "expenses_transaction_id": 0,
- "foreclosure_transaction_id": 0,
- "calculated_salary_ids_json": "string",
- "invoice_ids_json": "string",
- "total_invoicing_sum_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_invoicing_sum_without_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "company_fees_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "expenses_with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "expenses_without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "receipt_expenses_with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "receipt_expenses_without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "travel_expenses_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "base_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "employer_fees_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "gross_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "salary_without_holiday_compensation": {
- "amount": "2000",
- "currency": "EUR"
}, - "holiday_compensation": {
- "amount": "2000",
- "currency": "EUR"
}, - "employee_fees_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "net_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "withheld_yel": {
- "amount": "2000",
- "currency": "EUR"
}, - "health_insurance_fee_with_vat": {
- "amount": "2000",
- "currency": "EUR"
}, - "salary_fees_with_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "salary_fees_without_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "salary_fees_vat_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "fast_payment_fee": {
- "amount": "2000",
- "currency": "EUR"
}, - "sum_to_foreclose_from": {
- "amount": "2000",
- "currency": "EUR"
}, - "foreclosure_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "final_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "final_salary_with_expenses": {
- "amount": "2000",
- "currency": "EUR"
}, - "juel_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "personal_deductions_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "health_insurance_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "notes": "string",
- "work_hours": 0.1,
- "refunded": true,
- "is_yel_discount": true,
- "is_yel_required_paid": true,
- "is_fast_payment_enabled": true,
- "transaction_date": "2020-09-20",
- "payment_date": "2020-09-20",
- "start_date": "2020-09-20",
- "end_date": "2020-09-20",
- "created_at": "2020-09-20T18:30:00+03:00",
- "updated_at": "2020-09-20T18:30:00+03:00",
- "deleted_at": "2020-09-20T18:30:00+03:00"
}
}
InvoicingSumFromTargetSalaryRequest
object (Money) Money value schema | |
object (Money) Money value schema | |
contains_vat | boolean |
invoicing_vat_percentage | number <float> |
withholding_tax_percentage | number <float> |
yel_obligated | boolean |
yel_start_date | string <date> |
age | integer Ages between 18 and 67 get YEL calculations based on this |
country | string Client's country as ISO short code (FI, GB, RU etc) |
object | |
object |
{- "target_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "price_per_hour": {
- "amount": "2000",
- "currency": "EUR"
}, - "contains_vat": "true",
- "invoicing_vat_percentage": "24.00",
- "withholding_tax_percentage": "60.00",
- "yel_obligated": "true",
- "yel_start_date": "2020-06-09",
- "age": "30",
- "country": "FI",
- "travel_expenses": {
- "kilometer_amount": "200",
- "full_day_amount": "10",
- "half_day_amount": "2",
- "meal_amount": "3"
}, - "receipt_expenses": {
- "vat_percentage": "24.00",
- "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}
}
{ }
SalaryFromInvoicingSumRequest
object (Money) Money value schema | |
object (Money) Money value schema | |
contains_vat | boolean |
invoicing_vat_percentage | number <float> |
withholding_tax_percentage | number <float> |
yel_obligated | boolean |
yel_start_date | string <date> |
age | integer Ages between 18 and 67 get YEL calculations based on this |
country | string Client's country as ISO short code (FI, GB, RU etc) |
commission_percent | number <float> Custom commission percent |
object | |
object |
{- "total_invoicing_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "price_per_hour": {
- "amount": "2000",
- "currency": "EUR"
}, - "contains_vat": "true",
- "invoicing_vat_percentage": "24.00",
- "withholding_tax_percentage": "60.00",
- "yel_obligated": "true",
- "yel_start_date": "2020-06-09",
- "age": "30",
- "country": "FI",
- "commission_percent": "5.0",
- "travel_expenses": {
- "kilometer_amount": "200",
- "full_day_amount": "10",
- "half_day_amount": "2",
- "meal_amount": "3"
}, - "receipt_expenses": {
- "vat_percentage": "24.00",
- "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}
}
{ }
InvoicingSumFromTargetSalaryRequest
object (Money) Money value schema | |
object (Money) Money value schema | |
contains_vat | boolean |
invoicing_vat_percentage | number <float> |
withholding_tax_percentage | number <float> |
yel_obligated | boolean |
yel_start_date | string <date> |
age | integer Ages between 18 and 67 get YEL calculations based on this |
country | string Client's country as ISO short code (FI, GB, RU etc) |
object | |
object |
{- "target_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "price_per_hour": {
- "amount": "2000",
- "currency": "EUR"
}, - "contains_vat": "true",
- "invoicing_vat_percentage": "24.00",
- "withholding_tax_percentage": "60.00",
- "yel_obligated": "true",
- "yel_start_date": "2020-06-09",
- "age": "30",
- "country": "FI",
- "travel_expenses": {
- "kilometer_amount": "200",
- "full_day_amount": "10",
- "half_day_amount": "2",
- "meal_amount": "3"
}, - "receipt_expenses": {
- "vat_percentage": "24.00",
- "total_sum": {
- "amount": "2000",
- "currency": "EUR"
}
}
}
{ }
Display a listing of the resource.
type required | string Enum: "allow_for_invoicing" "allow_for_nationality" "allow_for_iban_payments" "allow_for_travel_expense" (Optional) filter countries by attribute e.g. /countries/allow_for_invoicing |
{- "data": {
- "id": 0,
- "name": "string",
- "code": "string",
- "is_domestic": true,
- "is_eu": true,
- "is_eea": true,
- "allowed_for": {
- "invoicing": true,
- "nationality": true,
- "iban_payments": true,
- "travel_expense": true
}, - "cities": {
- "id": 0,
- "name": "string"
}
}
}
Display a countries and cities with daily allowances.
{- "data": [
- {
- "name": "Suomi",
- "code": "FI",
- "daily_allowance": {
- "amount": "66000",
- "currency": "EUR"
}, - "cities": [
- {
- "id": "69",
- "name": "Rovaniemi",
- "daily_allowance": {
- "amount": "69000",
- "currency": "EUR"
}
}
]
}
]
}
date | string Example: date=2024-04-04 Date that defines if VAT_REGULAR is 24% / 25.5% |
{- "data": [
- {
- "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": [
- { }
]
}
]
}
type required | string Type of service agreement; terms-of-service |
language | string Example: language=FI Defines the language of service agreement (FI, EN, SV, RU, ET), fallbacks to FI |
{- "data": {
- "terms": "string",
- "type": "string",
- "language": "string",
- "published_at": "2020-09-20T18:30:00+03:00"
}
}
lang | string Language, options: en|fi |
filter | string Hakusana |
{- "Industry's name": [
- {
- "id": 0,
- "title_fi": "string",
- "title_en": "string",
- "description_fi": "string",
- "description_en": "string"
}
]
}
{- "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"
]
}
}
]
}
]
}
}
user_id required | integer User id |
{- "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"
]
}
}
]
}
]
}
}
{- "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"
]
}
}
]
}
]
}
}
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"
]
}
}
]
}
]
}
}
{- "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": {
- "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"
}
}
}
}
New start new signature
auth_method | string Prod: tupas-osuuspankki,tupas-nordea,tupas-danske,tupas-spankki,tupas-handelsbanken,tupas-elisa,tupas-aktia,tupas-poppankki,tupas-sp,tupas-omasp,tupas-alandsbanken |
{- "auth_method": "string"
}
{- "url": "string",
- "signature": {
- "id": 0,
- "document_type": "yel"
}
}
{- "": {
- "identifier": "tupas-osuuspankki",
- "name": "Osuuspankki",
- "country_of_authentication": "fi"
}
}
{- "withholding_enabled": true,
- "obligation_verdict_reason": "string",
- "percent": "18.8",
- "manuallySetYelPercent": "18.8",
- "is_discount_enabled": true,
- "invoice_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "invoice_due_date": "2020-09-20T18:30:00+03:00",
- "invoice_sum_last_update": "2020-09-20T18:30:00+03:00",
- "current_invoicing_estimate": {
- "amount": "2000",
- "currency": "EUR"
}, - "current_income_estimate": {
- "amount": "2000",
- "currency": "EUR"
}, - "current_income_estimate_start_date": "2020-09-20T18:30:00+03:00",
- "current_income_estimate_set_by_user": null,
- "estimate_periods": {
- "start_date": "2020-09-20T18:30:00+03:00",
- "end_date": "2020-09-20T18:30:00+03:00",
- "income_estimate": {
- "amount": "2000",
- "currency": "EUR"
}, - "payments": {
- "amount": "2000",
- "currency": "EUR"
}, - "period_days": "string",
- "set_by_user": 0
}, - "start_date": "2020-09-20T18:30:00+03:00",
- "end_date": "2020-09-20T18:30:00+03:00",
- "last_day_of_discount": "2020-09-20T18:30:00+03:00",
- "payments": {
- "date": "2020-09-20T18:30:00+03:00",
- "amount": {
- "amount": "2000",
- "currency": "EUR"
}, - "iban": "string",
- "reference_number": "string",
- "payment_transaction_id": "string",
- "paid_by_admin": {
- "amount": "2000",
- "currency": "EUR"
}, - "procountor_id": 0
}, - "total_withheld": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_paid": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_refunded": {
- "amount": "2000",
- "currency": "EUR"
}, - "refunds": {
- "date": "2020-09-20T18:30:00+03:00",
- "amount": {
- "amount": "2000",
- "currency": "EUR"
}, - "transaction_id": 0
}, - "payment_amount_left": {
- "amount": "2000",
- "currency": "EUR"
}, - "withheld_amount": {
- "amount": "2000",
- "currency": "EUR"
}, - "signed_with_ssn": "string",
- "signed_date": "2020-09-20T18:30:00+03:00",
- "contract_sent_date": "2020-09-20T18:30:00+03:00",
- "occupation_id": 1,
- "estimated_weekly_working_hours": 1,
- "additional_employment_income_information": "I work as a light entrepreneur for a one day a week."
}
{- "withholding_enabled": true,
- "obligation_verdict_reason": "string",
- "percent": "18.8",
- "manuallySetYelPercent": "18.8",
- "is_discount_enabled": true,
- "invoice_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "invoice_due_date": "2020-09-20T18:30:00+03:00",
- "invoice_sum_last_update": "2020-09-20T18:30:00+03:00",
- "current_invoicing_estimate": {
- "amount": "2000",
- "currency": "EUR"
}, - "current_income_estimate": {
- "amount": "2000",
- "currency": "EUR"
}, - "current_income_estimate_start_date": "2020-09-20T18:30:00+03:00",
- "current_income_estimate_set_by_user": null,
- "estimate_periods": {
- "start_date": "2020-09-20T18:30:00+03:00",
- "end_date": "2020-09-20T18:30:00+03:00",
- "income_estimate": {
- "amount": "2000",
- "currency": "EUR"
}, - "payments": {
- "amount": "2000",
- "currency": "EUR"
}, - "period_days": "string",
- "set_by_user": 0
}, - "start_date": "2020-09-20T18:30:00+03:00",
- "end_date": "2020-09-20T18:30:00+03:00",
- "last_day_of_discount": "2020-09-20T18:30:00+03:00",
- "payments": {
- "date": "2020-09-20T18:30:00+03:00",
- "amount": {
- "amount": "2000",
- "currency": "EUR"
}, - "iban": "string",
- "reference_number": "string",
- "payment_transaction_id": "string",
- "paid_by_admin": {
- "amount": "2000",
- "currency": "EUR"
}, - "procountor_id": 0
}, - "total_withheld": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_paid": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_refunded": {
- "amount": "2000",
- "currency": "EUR"
}, - "refunds": {
- "date": "2020-09-20T18:30:00+03:00",
- "amount": {
- "amount": "2000",
- "currency": "EUR"
}, - "transaction_id": 0
}, - "payment_amount_left": {
- "amount": "2000",
- "currency": "EUR"
}, - "withheld_amount": {
- "amount": "2000",
- "currency": "EUR"
}, - "signed_with_ssn": "string",
- "signed_date": "2020-09-20T18:30:00+03:00",
- "contract_sent_date": "2020-09-20T18:30:00+03:00",
- "occupation_id": 1,
- "estimated_weekly_working_hours": 1,
- "additional_employment_income_information": "I work as a light entrepreneur for a one day a week."
}
{- "data": {
- "discount": {
- "maximum_previous_periods": 0,
- "months": 0,
- "percentage": 0.1
}, - "maximum": {
- "amount": "2000",
- "currency": "EUR"
}, - "limit": {
- "amount": "2000",
- "currency": "EUR"
}, - "monthly_gross_salary_limit": {
- "amount": "2000",
- "currency": "EUR"
}, - "age_groups": {
- "normal": {
- "minimum_age": 0,
- "maximum_age": 0,
- "percentage": 0.1
}, - "older": {
- "minimum_age": 0,
- "maximum_age": 0,
- "percentage": 0.1
}, - "oldest": {
- "minimum_age": 0,
- "maximum_age": 0,
- "percentage": 0.1
}
}
}
}
income_estimate required | integer Income estimate in cents |
{- "income_estimate": {
- "amount": "2000",
- "currency": "EUR"
}, - "percent_estimate": "18.8",
- "annual_estimate": {
- "amount": "2000",
- "currency": "EUR"
}, - "daily_estimate": {
- "amount": "2000",
- "currency": "EUR"
}
}
{- "data": [
- {
- "id": 0,
- "user_id": 0,
- "start_date": "2020-09-20T18:30:00+03:00",
- "end_date": "2020-09-20T18:30:00+03:00",
- "contract_number": "2020-09-20T18:30:00+03:00",
- "type": "Ukko",
- "terminated_by": "USER",
- "last_name": "string",
- "is_editable": true,
- "is_active": true
}
]
}
OtherContractRequest
start_date | string <date> |
{- "start_date": "2020-12-12"
}
{- "withholding_enabled": true,
- "obligation_verdict_reason": "string",
- "percent": "18.8",
- "manuallySetYelPercent": "18.8",
- "is_discount_enabled": true,
- "invoice_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "invoice_due_date": "2020-09-20T18:30:00+03:00",
- "invoice_sum_last_update": "2020-09-20T18:30:00+03:00",
- "current_invoicing_estimate": {
- "amount": "2000",
- "currency": "EUR"
}, - "current_income_estimate": {
- "amount": "2000",
- "currency": "EUR"
}, - "current_income_estimate_start_date": "2020-09-20T18:30:00+03:00",
- "current_income_estimate_set_by_user": null,
- "estimate_periods": {
- "start_date": "2020-09-20T18:30:00+03:00",
- "end_date": "2020-09-20T18:30:00+03:00",
- "income_estimate": {
- "amount": "2000",
- "currency": "EUR"
}, - "payments": {
- "amount": "2000",
- "currency": "EUR"
}, - "period_days": "string",
- "set_by_user": 0
}, - "start_date": "2020-09-20T18:30:00+03:00",
- "end_date": "2020-09-20T18:30:00+03:00",
- "last_day_of_discount": "2020-09-20T18:30:00+03:00",
- "payments": {
- "date": "2020-09-20T18:30:00+03:00",
- "amount": {
- "amount": "2000",
- "currency": "EUR"
}, - "iban": "string",
- "reference_number": "string",
- "payment_transaction_id": "string",
- "paid_by_admin": {
- "amount": "2000",
- "currency": "EUR"
}, - "procountor_id": 0
}, - "total_withheld": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_paid": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_refunded": {
- "amount": "2000",
- "currency": "EUR"
}, - "refunds": {
- "date": "2020-09-20T18:30:00+03:00",
- "amount": {
- "amount": "2000",
- "currency": "EUR"
}, - "transaction_id": 0
}, - "payment_amount_left": {
- "amount": "2000",
- "currency": "EUR"
}, - "withheld_amount": {
- "amount": "2000",
- "currency": "EUR"
}, - "signed_with_ssn": "string",
- "signed_date": "2020-09-20T18:30:00+03:00",
- "contract_sent_date": "2020-09-20T18:30:00+03:00",
- "occupation_id": 1,
- "estimated_weekly_working_hours": 1,
- "additional_employment_income_information": "I work as a light entrepreneur for a one day a week."
}
UkkoContractRequest
signature_id | integer Internal id of of an Visma Sign Signature |
start_date | string <date> |
object (Money) Money value schema | |
Array of objects Array of start and end dates that user has had previous YEL periods | |
occupation_id | integer Id of the selected occupation |
estimated_weekly_working_hours | integer Number of hours user has estimated to work per week |
additional_employment_income_information | string |
{- "signature_id": "96",
- "start_date": "2020-12-12",
- "gross_salary": {
- "amount": "2000",
- "currency": "EUR"
}, - "previous_yel_periods": "[ {start: 2022-01-01, end: 2022-02-01}, {start: 2022-04-01, end: 2022-05-01}, ]",
- "occupation_id": "1234",
- "estimated_weekly_working_hours": "24",
- "additional_employment_income_information": "I work as a light entrepreneur for a one day a week. I also have a part-time job as a teacher in a local school."
}
{- "withholding_enabled": true,
- "obligation_verdict_reason": "string",
- "percent": "18.8",
- "manuallySetYelPercent": "18.8",
- "is_discount_enabled": true,
- "invoice_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "invoice_due_date": "2020-09-20T18:30:00+03:00",
- "invoice_sum_last_update": "2020-09-20T18:30:00+03:00",
- "current_invoicing_estimate": {
- "amount": "2000",
- "currency": "EUR"
}, - "current_income_estimate": {
- "amount": "2000",
- "currency": "EUR"
}, - "current_income_estimate_start_date": "2020-09-20T18:30:00+03:00",
- "current_income_estimate_set_by_user": null,
- "estimate_periods": {
- "start_date": "2020-09-20T18:30:00+03:00",
- "end_date": "2020-09-20T18:30:00+03:00",
- "income_estimate": {
- "amount": "2000",
- "currency": "EUR"
}, - "payments": {
- "amount": "2000",
- "currency": "EUR"
}, - "period_days": "string",
- "set_by_user": 0
}, - "start_date": "2020-09-20T18:30:00+03:00",
- "end_date": "2020-09-20T18:30:00+03:00",
- "last_day_of_discount": "2020-09-20T18:30:00+03:00",
- "payments": {
- "date": "2020-09-20T18:30:00+03:00",
- "amount": {
- "amount": "2000",
- "currency": "EUR"
}, - "iban": "string",
- "reference_number": "string",
- "payment_transaction_id": "string",
- "paid_by_admin": {
- "amount": "2000",
- "currency": "EUR"
}, - "procountor_id": 0
}, - "total_withheld": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_paid": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_refunded": {
- "amount": "2000",
- "currency": "EUR"
}, - "refunds": {
- "date": "2020-09-20T18:30:00+03:00",
- "amount": {
- "amount": "2000",
- "currency": "EUR"
}, - "transaction_id": 0
}, - "payment_amount_left": {
- "amount": "2000",
- "currency": "EUR"
}, - "withheld_amount": {
- "amount": "2000",
- "currency": "EUR"
}, - "signed_with_ssn": "string",
- "signed_date": "2020-09-20T18:30:00+03:00",
- "contract_sent_date": "2020-09-20T18:30:00+03:00",
- "occupation_id": 1,
- "estimated_weekly_working_hours": 1,
- "additional_employment_income_information": "I work as a light entrepreneur for a one day a week."
}
{- "withholding_enabled": true,
- "obligation_verdict_reason": "string",
- "percent": "18.8",
- "manuallySetYelPercent": "18.8",
- "is_discount_enabled": true,
- "invoice_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "invoice_due_date": "2020-09-20T18:30:00+03:00",
- "invoice_sum_last_update": "2020-09-20T18:30:00+03:00",
- "current_invoicing_estimate": {
- "amount": "2000",
- "currency": "EUR"
}, - "current_income_estimate": {
- "amount": "2000",
- "currency": "EUR"
}, - "current_income_estimate_start_date": "2020-09-20T18:30:00+03:00",
- "current_income_estimate_set_by_user": null,
- "estimate_periods": {
- "start_date": "2020-09-20T18:30:00+03:00",
- "end_date": "2020-09-20T18:30:00+03:00",
- "income_estimate": {
- "amount": "2000",
- "currency": "EUR"
}, - "payments": {
- "amount": "2000",
- "currency": "EUR"
}, - "period_days": "string",
- "set_by_user": 0
}, - "start_date": "2020-09-20T18:30:00+03:00",
- "end_date": "2020-09-20T18:30:00+03:00",
- "last_day_of_discount": "2020-09-20T18:30:00+03:00",
- "payments": {
- "date": "2020-09-20T18:30:00+03:00",
- "amount": {
- "amount": "2000",
- "currency": "EUR"
}, - "iban": "string",
- "reference_number": "string",
- "payment_transaction_id": "string",
- "paid_by_admin": {
- "amount": "2000",
- "currency": "EUR"
}, - "procountor_id": 0
}, - "total_withheld": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_paid": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_refunded": {
- "amount": "2000",
- "currency": "EUR"
}, - "refunds": {
- "date": "2020-09-20T18:30:00+03:00",
- "amount": {
- "amount": "2000",
- "currency": "EUR"
}, - "transaction_id": 0
}, - "payment_amount_left": {
- "amount": "2000",
- "currency": "EUR"
}, - "withheld_amount": {
- "amount": "2000",
- "currency": "EUR"
}, - "signed_with_ssn": "string",
- "signed_date": "2020-09-20T18:30:00+03:00",
- "contract_sent_date": "2020-09-20T18:30:00+03:00",
- "occupation_id": 1,
- "estimated_weekly_working_hours": 1,
- "additional_employment_income_information": "I work as a light entrepreneur for a one day a week."
}
NoYelObligationRequest
object (Money) Money value schema | |
object (Money) Money value schema |
{- "income_estimate": {
- "amount": "2000",
- "currency": "EUR"
}, - "invoicing_estimate": {
- "amount": "2000",
- "currency": "EUR"
}
}
{- "withholding_enabled": true,
- "obligation_verdict_reason": "string",
- "percent": "18.8",
- "manuallySetYelPercent": "18.8",
- "is_discount_enabled": true,
- "invoice_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "invoice_due_date": "2020-09-20T18:30:00+03:00",
- "invoice_sum_last_update": "2020-09-20T18:30:00+03:00",
- "current_invoicing_estimate": {
- "amount": "2000",
- "currency": "EUR"
}, - "current_income_estimate": {
- "amount": "2000",
- "currency": "EUR"
}, - "current_income_estimate_start_date": "2020-09-20T18:30:00+03:00",
- "current_income_estimate_set_by_user": null,
- "estimate_periods": {
- "start_date": "2020-09-20T18:30:00+03:00",
- "end_date": "2020-09-20T18:30:00+03:00",
- "income_estimate": {
- "amount": "2000",
- "currency": "EUR"
}, - "payments": {
- "amount": "2000",
- "currency": "EUR"
}, - "period_days": "string",
- "set_by_user": 0
}, - "start_date": "2020-09-20T18:30:00+03:00",
- "end_date": "2020-09-20T18:30:00+03:00",
- "last_day_of_discount": "2020-09-20T18:30:00+03:00",
- "payments": {
- "date": "2020-09-20T18:30:00+03:00",
- "amount": {
- "amount": "2000",
- "currency": "EUR"
}, - "iban": "string",
- "reference_number": "string",
- "payment_transaction_id": "string",
- "paid_by_admin": {
- "amount": "2000",
- "currency": "EUR"
}, - "procountor_id": 0
}, - "total_withheld": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_paid": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_refunded": {
- "amount": "2000",
- "currency": "EUR"
}, - "refunds": {
- "date": "2020-09-20T18:30:00+03:00",
- "amount": {
- "amount": "2000",
- "currency": "EUR"
}, - "transaction_id": 0
}, - "payment_amount_left": {
- "amount": "2000",
- "currency": "EUR"
}, - "withheld_amount": {
- "amount": "2000",
- "currency": "EUR"
}, - "signed_with_ssn": "string",
- "signed_date": "2020-09-20T18:30:00+03:00",
- "contract_sent_date": "2020-09-20T18:30:00+03:00",
- "occupation_id": 1,
- "estimated_weekly_working_hours": 1,
- "additional_employment_income_information": "I work as a light entrepreneur for a one day a week."
}
UpdateUkkoContractDetailsRequest
occupation_id | integer Id of the selected occupation |
estimated_weekly_working_hours | integer Number of hours user has estimated to work per week |
additional_employment_income_information | string |
{- "occupation_id": "1234",
- "estimated_weekly_working_hours": "24",
- "additional_employment_income_information": "I work as a light entrepreneur for a one day a week. I also have a part-time job as a teacher in a local school."
}
{- "withholding_enabled": true,
- "obligation_verdict_reason": "string",
- "percent": "18.8",
- "manuallySetYelPercent": "18.8",
- "is_discount_enabled": true,
- "invoice_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "invoice_due_date": "2020-09-20T18:30:00+03:00",
- "invoice_sum_last_update": "2020-09-20T18:30:00+03:00",
- "current_invoicing_estimate": {
- "amount": "2000",
- "currency": "EUR"
}, - "current_income_estimate": {
- "amount": "2000",
- "currency": "EUR"
}, - "current_income_estimate_start_date": "2020-09-20T18:30:00+03:00",
- "current_income_estimate_set_by_user": null,
- "estimate_periods": {
- "start_date": "2020-09-20T18:30:00+03:00",
- "end_date": "2020-09-20T18:30:00+03:00",
- "income_estimate": {
- "amount": "2000",
- "currency": "EUR"
}, - "payments": {
- "amount": "2000",
- "currency": "EUR"
}, - "period_days": "string",
- "set_by_user": 0
}, - "start_date": "2020-09-20T18:30:00+03:00",
- "end_date": "2020-09-20T18:30:00+03:00",
- "last_day_of_discount": "2020-09-20T18:30:00+03:00",
- "payments": {
- "date": "2020-09-20T18:30:00+03:00",
- "amount": {
- "amount": "2000",
- "currency": "EUR"
}, - "iban": "string",
- "reference_number": "string",
- "payment_transaction_id": "string",
- "paid_by_admin": {
- "amount": "2000",
- "currency": "EUR"
}, - "procountor_id": 0
}, - "total_withheld": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_paid": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_refunded": {
- "amount": "2000",
- "currency": "EUR"
}, - "refunds": {
- "date": "2020-09-20T18:30:00+03:00",
- "amount": {
- "amount": "2000",
- "currency": "EUR"
}, - "transaction_id": 0
}, - "payment_amount_left": {
- "amount": "2000",
- "currency": "EUR"
}, - "withheld_amount": {
- "amount": "2000",
- "currency": "EUR"
}, - "signed_with_ssn": "string",
- "signed_date": "2020-09-20T18:30:00+03:00",
- "contract_sent_date": "2020-09-20T18:30:00+03:00",
- "occupation_id": 1,
- "estimated_weekly_working_hours": 1,
- "additional_employment_income_information": "I work as a light entrepreneur for a one day a week."
}
{- "withholding_enabled": true,
- "obligation_verdict_reason": "string",
- "percent": "18.8",
- "manuallySetYelPercent": "18.8",
- "is_discount_enabled": true,
- "invoice_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "invoice_due_date": "2020-09-20T18:30:00+03:00",
- "invoice_sum_last_update": "2020-09-20T18:30:00+03:00",
- "current_invoicing_estimate": {
- "amount": "2000",
- "currency": "EUR"
}, - "current_income_estimate": {
- "amount": "2000",
- "currency": "EUR"
}, - "current_income_estimate_start_date": "2020-09-20T18:30:00+03:00",
- "current_income_estimate_set_by_user": null,
- "estimate_periods": {
- "start_date": "2020-09-20T18:30:00+03:00",
- "end_date": "2020-09-20T18:30:00+03:00",
- "income_estimate": {
- "amount": "2000",
- "currency": "EUR"
}, - "payments": {
- "amount": "2000",
- "currency": "EUR"
}, - "period_days": "string",
- "set_by_user": 0
}, - "start_date": "2020-09-20T18:30:00+03:00",
- "end_date": "2020-09-20T18:30:00+03:00",
- "last_day_of_discount": "2020-09-20T18:30:00+03:00",
- "payments": {
- "date": "2020-09-20T18:30:00+03:00",
- "amount": {
- "amount": "2000",
- "currency": "EUR"
}, - "iban": "string",
- "reference_number": "string",
- "payment_transaction_id": "string",
- "paid_by_admin": {
- "amount": "2000",
- "currency": "EUR"
}, - "procountor_id": 0
}, - "total_withheld": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_paid": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_refunded": {
- "amount": "2000",
- "currency": "EUR"
}, - "refunds": {
- "date": "2020-09-20T18:30:00+03:00",
- "amount": {
- "amount": "2000",
- "currency": "EUR"
}, - "transaction_id": 0
}, - "payment_amount_left": {
- "amount": "2000",
- "currency": "EUR"
}, - "withheld_amount": {
- "amount": "2000",
- "currency": "EUR"
}, - "signed_with_ssn": "string",
- "signed_date": "2020-09-20T18:30:00+03:00",
- "contract_sent_date": "2020-09-20T18:30:00+03:00",
- "occupation_id": 1,
- "estimated_weekly_working_hours": 1,
- "additional_employment_income_information": "I work as a light entrepreneur for a one day a week."
}
YelObligatedWithoutHealthInsuranceRequest
object (Money) Money value schema | |
object (Money) Money value schema | |
Array of objects |
{- "income_estimate": {
- "amount": "2000",
- "currency": "EUR"
}, - "invoicing_estimate": {
- "amount": "2000",
- "currency": "EUR"
}, - "yel_contract_periods": [
- {
- "type": "ukko",
- "source": "string",
- "start_date": "2020-12-12",
- "end_date": "2020-12-12"
}
]
}
{- "withholding_enabled": true,
- "obligation_verdict_reason": "string",
- "percent": "18.8",
- "manuallySetYelPercent": "18.8",
- "is_discount_enabled": true,
- "invoice_sum": {
- "amount": "2000",
- "currency": "EUR"
}, - "invoice_due_date": "2020-09-20T18:30:00+03:00",
- "invoice_sum_last_update": "2020-09-20T18:30:00+03:00",
- "current_invoicing_estimate": {
- "amount": "2000",
- "currency": "EUR"
}, - "current_income_estimate": {
- "amount": "2000",
- "currency": "EUR"
}, - "current_income_estimate_start_date": "2020-09-20T18:30:00+03:00",
- "current_income_estimate_set_by_user": null,
- "estimate_periods": {
- "start_date": "2020-09-20T18:30:00+03:00",
- "end_date": "2020-09-20T18:30:00+03:00",
- "income_estimate": {
- "amount": "2000",
- "currency": "EUR"
}, - "payments": {
- "amount": "2000",
- "currency": "EUR"
}, - "period_days": "string",
- "set_by_user": 0
}, - "start_date": "2020-09-20T18:30:00+03:00",
- "end_date": "2020-09-20T18:30:00+03:00",
- "last_day_of_discount": "2020-09-20T18:30:00+03:00",
- "payments": {
- "date": "2020-09-20T18:30:00+03:00",
- "amount": {
- "amount": "2000",
- "currency": "EUR"
}, - "iban": "string",
- "reference_number": "string",
- "payment_transaction_id": "string",
- "paid_by_admin": {
- "amount": "2000",
- "currency": "EUR"
}, - "procountor_id": 0
}, - "total_withheld": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_paid": {
- "amount": "2000",
- "currency": "EUR"
}, - "total_refunded": {
- "amount": "2000",
- "currency": "EUR"
}, - "refunds": {
- "date": "2020-09-20T18:30:00+03:00",
- "amount": {
- "amount": "2000",
- "currency": "EUR"
}, - "transaction_id": 0
}, - "payment_amount_left": {
- "amount": "2000",
- "currency": "EUR"
}, - "withheld_amount": {
- "amount": "2000",
- "currency": "EUR"
}, - "signed_with_ssn": "string",
- "signed_date": "2020-09-20T18:30:00+03:00",
- "contract_sent_date": "2020-09-20T18:30:00+03:00",
- "occupation_id": 1,
- "estimated_weekly_working_hours": 1,
- "additional_employment_income_information": "I work as a light entrepreneur for a one day a week."
}
{- "data": [
- {
- "id": 0,
- "user_id": 0,
- "start_date": "2020-09-20T18:30:00+03:00",
- "end_date": "2020-09-20T18:30:00+03:00",
- "contract_number": "2020-09-20T18:30:00+03:00",
- "type": "Ukko",
- "terminated_by": "USER",
- "last_name": "string",
- "is_editable": true,
- "is_active": true
}
]
}