Konto REST API
Authentication
Authenticate test
Test auth with konto api
GEThttps://dev.konto.is/api/v1/hello
Parameter | Type | Example | Description |
---|---|---|---|
username |
string | required | |
api_key |
string | required |
200
Parameter | Type | Example | Description |
---|---|---|---|
status |
boolean | Return TRUE when success | |
message |
string |
if status is TRUE then messge will "Connection succeeded"
if status is FALSE then messge will describe this error |
|
name |
string | ||
registration_no |
string | ||
vat_no |
string |
curl -k -X GET -F username=testuser -F api_key=3a62cd2568635f115c975b8bd1317e3d https://dev.konto.is/api/v1/hello |
Customer
Customer detail
Customer detail example json
Parameter | Type | Example | Description |
---|---|---|---|
guid |
string | ||
output_select |
string | 2: Send e-invoice to a particular Trading Partner ID, 3: Do not send e-invoice(XML), 4: Print - Do not send email | |
address |
string | ||
zip |
string | ||
city |
string | ||
registration_no |
string | ||
email |
string | ||
term |
string | ||
photo |
base64string | ||
due_date |
integer | ||
settlement_date |
integer | ||
trading_partner_id |
string | ||
phone_number |
string | ||
vat |
string | ||
lang |
string | is or en | |
currency |
string | ISK,EUR,USD,DKK,NOK,SEK,JPY,GBP,AUD,PLN,CAD,CHF,CNY,NZD,MXN,SGD,HKD,KRW,TRY,RUB,INR,VND,BRL,ZAR,UAH,CZK | |
tax_exempt |
boolean | ||
updated_timestamp |
string | ||
is_claim |
boolean | Only available If user has active claim subscription | |
is_discount |
boolean | Only available If user has active discount subscription |
List Customers
Get list customers with konto api
GEThttps://dev.konto.is/api/v1/get-customers
Parameter | Type | Example | Description |
---|---|---|---|
username |
string | required | |
api_key |
string | required | |
search |
string | (optional) search key with name customer | |
limit |
integer | (optional) item per page default all customer | |
page |
integer | (optional) page number |
200
Parameter | Type | Example | Description |
---|---|---|---|
status |
boolean | Return TRUE when success | |
message |
string | if status is FALSE then messge will describe this error | |
result |
object | if status is TRUE is show list customer |
curl -k -X GET -F username=testuser -F api_key=3a62cd2568635f115c975b8bd1317e3d https://dev.konto.is/api/v1/get-customers |
Count Customers
Get count customers with konto api
GEThttps://dev.konto.is/api/v1/get-count-customers
Parameter | Type | Example | Description |
---|---|---|---|
username |
string | required | |
api_key |
string | required | |
search |
string | (optional) search key with name customer |
200
Parameter | Type | Example | Description |
---|---|---|---|
status |
boolean | Return TRUE when success | |
message |
string | if status is FALSE then messge will describe this error | |
result |
integer | if status is TRUE is show count customer |
curl -k -X GET -F username=testuser -F api_key=3a62cd2568635f115c975b8bd1317e3d https://dev.konto.is/api/v1/get-count-customers |
Get Customer
Get detail customer with konto api
GEThttps://dev.konto.is/api/v1/get-customer
Parameter | Type | Example | Description |
---|---|---|---|
username |
string | required | |
api_key |
string | required | |
guid |
string | required |
200
Parameter | Type | Example | Description |
---|---|---|---|
status |
boolean | Return TRUE when success | |
message |
string | if status is FALSE then messge will describe this error | |
result |
json | if status is TRUE is detail customer |
curl -k -X GET -F username=testuser -F api_key=3a62cd2568635f115c975b8bd1317e3d -F guid=5a140a1c-13c6-11e7-9914-408d5c6208bc https://dev.konto.is/api/v1/get-customer |
Create Customer
Create a customer with konto api
POSThttps://dev.konto.is/api/v1/create-customer
Parameter | Type | Example | Description |
---|---|---|---|
username |
string | required | |
api_key |
string | required | |
data |
json |
|
(required) json of detail customer |
200
Parameter | Type | Example | Description |
---|---|---|---|
status |
boolean | Return TRUE when success | |
message |
string | if status is FALSE then messge will describe this error | |
result |
integer | if status is TRUE is GUID of customer |
curl -k -X POST -F username="testuser" -F api_key="3a62cd2568635f115c975b8bd1317e3d" -F data="{\"output_select\":3,\"registration_no\":\"1111111111\",\"name\":\"Test\",\"address\":\"Abc\",\"zip\":\"104\",\"city\":\"Abc\",\"email\":\"xxxx@gmail.com\",\"lang\":\"is\",\"currency\":\"ISK\"}" https://dev.konto.is/api/v1/create-customer |
Update Customer
Update a customer with konto api
POSThttps://dev.konto.is/api/v1/update-customer
Parameter | Type | Example | Description |
---|---|---|---|
username |
string | required | |
api_key |
string | required | |
guid |
string | required | |
data |
json |
|
(required) json of detail customer |
200
Parameter | Type | Example | Description |
---|---|---|---|
status |
boolean | Return TRUE when success | |
message |
string | if status is FALSE then messge will describe this error | |
result |
integer | if status is TRUE is GUID of customer |
curl -k -X POST -F username="testuser" -F api_key="3a62cd2568635f115c975b8bd1317e3d" -F guid="614669f6-3560-11e7-8d19-408d5c6208bc" -F data="{\"output_select\":3,\"registration_no\":\"1111111111\",\"name\":\"Test\",\"address\":\"Abc\",\"zip\":\"104\",\"city\":\"Abc\",\"email\":\"xxxx@gmail.com\",\"lang\":\"is\",\"currency\":\"ISK\"}" https://dev.konto.is/api/v1/update-customer |
Item
Item detail
Item detail example json
Parameter | Type | Example | Description |
---|---|---|---|
guid |
string | ||
item_number |
string | Auto generate by konto | |
description |
string | ||
uom |
string | Unit of measure (C62,KGS,MTR,LTR,MTK,MTQ,TNE,KWH,DAY,HUR,MIN,KTM) | |
tax |
string | S,AA,Z | |
unit_price |
float | ||
category |
string | ||
active |
boolean | ||
updated_timestamp |
string |
List Items
Get list items with konto api
GEThttps://dev.konto.is/api/v1/get-items
Parameter | Type | Example | Description |
---|---|---|---|
username |
string | required | |
api_key |
string | required | |
limit |
integer | (optional) item per page default all customer | |
page |
integer | (optional) page number |
200
Parameter | Type | Example | Description |
---|---|---|---|
status |
boolean | Return TRUE when success | |
message |
string | if status is FALSE then messge will describe this error | |
result |
object | if status is TRUE is show list item |
curl -k -X GET -F username=testuser -F api_key=3a62cd2568635f115c975b8bd1317e3d https://dev.konto.is/api/v1/get-items |
Count Items
Get count items with konto api
GEThttps://dev.konto.is/api/v1/get-count-items
Parameter | Type | Example | Description |
---|---|---|---|
username |
string | required | |
api_key |
string | required |
200
Parameter | Type | Example | Description |
---|---|---|---|
status |
boolean | Return TRUE when success | |
message |
string | if status is FALSE then messge will describe this error | |
result |
integer | if status is TRUE is show count item |
curl -k -X GET -F username=testuser -F api_key=3a62cd2568635f115c975b8bd1317e3d https://dev.konto.is/api/v1/get-count-items |
Get Item
Get detail item with konto api
GEThttps://dev.konto.is/api/v1/get-item
Parameter | Type | Example | Description |
---|---|---|---|
username |
string | required | |
api_key |
string | required | |
guid |
string | required |
200
Parameter | Type | Example | Description |
---|---|---|---|
status |
boolean | Return TRUE when success | |
message |
string | if status is FALSE then messge will describe this error | |
result |
json | if status is TRUE is detail item |
curl -k -X GET -F username=testuser -F api_key=3a62cd2568635f115c975b8bd1317e3d -F guid=f120bb56-f080-11e6-a96f-0050560102f2 https://dev.konto.is/api/v1/get-item |
Create Item
Create a item with konto api
POSThttps://dev.konto.is/api/v1/create-item
Parameter | Type | Example | Description |
---|---|---|---|
username |
string | required | |
api_key |
string | required | |
data |
json |
|
(required) json of detail item |
200
Parameter | Type | Example | Description |
---|---|---|---|
status |
boolean | Return TRUE when success | |
message |
string | if status is FALSE then messge will describe this error | |
result |
integer | if status is TRUE is GUID of item |
curl -k -X POST -F username=testuser -F api_key=3a62cd2568635f115c975b8bd1317e3d -F data="{\"description\":\"Test\",\"uom\":\"KGS\",\"tax\":\"AA\",\"unit_price\":\"200\",\"category\":\"\",\"active\":\"1\"}" https://dev.konto.is/api/v1/create-item |
Update Item
Update a item with konto api
POSThttps://dev.konto.is/api/v1/update-item
Parameter | Type | Example | Description |
---|---|---|---|
username |
string | required | |
api_key |
string | required | |
guid |
string | required | |
data |
json |
|
(required) json of detail item |
200
Parameter | Type | Example | Description |
---|---|---|---|
status |
boolean | Return TRUE when success | |
message |
string | if status is FALSE then messge will describe this error | |
result |
integer | if status is TRUE is GUID of item |
curl -k -X POST -F username=testuser -F api_key=3a62cd2568635f115c975b8bd1317e3d -F guid=053a639f-3565-11e7-8d19-408d5c6208bc -F data="{\"description\":\"Test\",\"uom\":\"KGS\",\"tax\":\"AA\",\"unit_price\":\"200\",\"category\":\"\",\"active\":\"1\"}" https://dev.konto.is/api/v1/update-item |
Invoice
Invoice detail
Invoice detail example json
Parameter | Type | Example | Description |
---|---|---|---|
guid |
string | ||
number |
string | ||
amount |
float | ||
currency |
string | ISK,EUR,USD,DKK,NOK,SEK,JPY,GBP,AUD,PLN,CAD,CHF,CNY,NZD,MXN,SGD,HKD,KRW,TRY,RUB,INR,VND,BRL,ZAR,UAH,CZK, | |
status |
string | Saved, Sent, Cancelled, Paid | |
issue_date |
datetime | Format (Y-m-d) | |
due_date |
datetime | Format (Y-m-d) | |
settlement_date |
datetime | Format (Y-m-d) | |
description |
string | ||
booking |
string | ||
cost_provide |
string | ||
delivery_date |
datetime | Format (Y-m-d) | |
terms |
string | ||
type |
string | invoice,credit | |
refer_guid |
string | ||
accounting_status |
string | Created,Posted,Skipped,Error | |
accounting_message |
string | ||
updated_timestamp |
string | ||
items |
string | list invoice item | |
customer |
string | invoice customer |
Invoice item detail
Invoice item detail example json
Parameter | Type | Example | Description |
---|---|---|---|
guid |
string | ||
item_number |
string | ||
description |
string | ||
qty |
integer | ||
uom |
string | Unit of measure (C62,KGS,MTR,LTR,MTK,MTQ,TNE,KWH,DAY,HUR,MIN,KTM) | |
tax |
string | S,AA,Z | |
unit_price |
float | ||
discount |
float | ||
discount_type |
boolean | 1: %, 0: price |
Invoice customer detail
Invoice customer detail example json
Parameter | Type | Example | Description |
---|---|---|---|
guid |
string | ||
name |
string | ||
address |
string | ||
zip |
string | ||
city |
string | ||
registration_no |
string | ||
email |
string |
Invoice item detail for create
Invoice item detail for create example json
Parameter | Type | Example | Description |
---|---|---|---|
guid |
string | ||
item_number |
string | required | |
description |
string | required | |
qty |
integer | required | |
uom |
string | required Unit of measure (C62,KGS,MTR,LTR,MTK,MTQ,TNE,KWH,DAY,HUR,MIN,KTM) | |
unit_price |
float | required | |
tax |
string | required S,AA,Z | |
discount |
float | ||
discount_type |
boolean | 1: %, 0: price |
Invoice customer detail for create
Invoice customer detail for create example json
Parameter | Type | Example | Description |
---|---|---|---|
output_select |
string | 2: Send e-invoice to a particular Trading Partner ID, 3: Do not send e-invoice(XML), 4: Print - Do not send email | |
guid |
string | ||
name |
string | ||
address |
string | ||
zip |
string | ||
city |
string | ||
registration_no |
string | ||
email |
string | ||
term |
string | ||
photo |
base64string | ||
due_date |
integer | ||
settlement_date |
integer | ||
trading_partner_id |
string | ||
lang |
string | is or en | |
currency |
string | ISK,EUR,USD,DKK,NOK,SEK,JPY,GBP,AUD,PLN,CAD,CHF,CNY,NZD,MXN,SGD,HKD,KRW,TRY,RUB,INR,VND,BRL,ZAR,UAH,CZK | |
tax_exempt |
boolean | ||
updated_timestamp |
string | ||
phone_number |
string | ||
vat |
string | ||
is_claim |
boolean | Only available If user has active claim subscription | |
is_discount |
boolean | Only available If user has active discount subscription |
Invoice detail for create
Invoice detail for create example json
Parameter | Type | Example | Description |
---|---|---|---|
amount |
float | required | |
currency |
string | required ISK,EUR,USD,DKK,NOK,SEK,JPY,GBP,AUD,PLN,CAD,CHF,CNY,NZD,MXN,SGD,HKD,KRW,TRY,RUB,INR,VND,BRL,ZAR,UAH,CZK | |
issue_date |
datetime | required Format (Y-m-d) | |
due_date |
datetime | required Format (Y-m-d) | |
settlement_date |
datetime | required Format (Y-m-d) | |
description |
string | ||
booking |
string | ||
cost_provide |
string | ||
delivery_date |
datetime | Format (Y-m-d) | |
terms |
string | ||
type |
string | required invoice,credit | |
items |
string | required list invoice item | |
customer |
string | required invoice customer | |
trading_partner_id |
string | ||
is_claim |
boolean | ||
is_discount |
boolean | ||
discount_type |
boolean | 1: %, 0: price | |
discount_value |
float | ||
payment_fee |
float | ||
mark_paid |
boolean | ||
files |
string | 1111,1222 | Id get from api upload |
save |
boolean | Use for save invoice |
List Invoices
Get list invoices with konto api
GEThttps://dev.konto.is/api/v1/get-invoices
Parameter | Type | Example | Description |
---|---|---|---|
username |
string | required | |
api_key |
string | required | |
accounting_status |
string | (optional) list accounting status. Example: "Created,Error" or "Skipped" or "Created,Posted,Skipped" | |
limit |
integer | (optional) item per page default all invoice | |
page |
integer | (optional) page number |
200
Parameter | Type | Example | Description |
---|---|---|---|
status |
boolean | Return TRUE when success | |
message |
string | if status is FALSE then messge will describe this error | |
result |
object | if status is TRUE is show list invoice |
curl -k -X GET -F username=testuser -F api_key=3a62cd2568635f115c975b8bd1317e3d https://dev.konto.is/api/v1/get-invoices |
Count Invoices
Get count invoices with konto api
GEThttps://dev.konto.is/api/v1/get-count-invoices
Parameter | Type | Example | Description |
---|---|---|---|
username |
string | required | |
api_key |
string | required | |
accounting_status |
string | (optional) list accounting status. Example: "Created,Error" or "Skipped" or "Created,Posted,Skipped" |
200
Parameter | Type | Example | Description |
---|---|---|---|
status |
boolean | Return TRUE when success | |
message |
string | if status is FALSE then messge will describe this error | |
result |
integer | if status is TRUE is show count invoices |
curl -k -X GET -F username=testuser -F api_key=3a62cd2568635f115c975b8bd1317e3d https://dev.konto.is/api/v1/get-count-invoices |
Get Invoice
Get detail invoice with konto api
GEThttps://dev.konto.is/api/v1/get-invoice
Parameter | Type | Example | Description |
---|---|---|---|
username |
string | required | |
api_key |
string | required | |
guid |
string | required |
200
Parameter | Type | Example | Description |
---|---|---|---|
status |
boolean | Return TRUE when success | |
message |
string | if status is FALSE then messge will describe this error | |
result |
json | if status is TRUE is detail invoice |
curl -k -X GET -F username=testuser -F api_key=3a62cd2568635f115c975b8bd1317e3d -F guid=f110ef1e-f080-11e6-a96f-0050560102f2 https://dev.konto.is/api/v1/get-invoice |
Update Invoice
Update a invoice with konto api
POSThttps://dev.konto.is/api/v1/update-invoice
Parameter | Type | Example | Description |
---|---|---|---|
username |
string | required | |
api_key |
string | required | |
guid |
string | required | |
data |
json |
|
(required) |
200
Parameter | Type | Example | Description |
---|---|---|---|
status |
boolean | Return TRUE when success | |
message |
string | if status is FALSE then messge will describe this error | |
result |
integer | if status is TRUE is GUID of invoice |
curl -k -X POST -F username=testuser -F api_key=3a62cd2568635f115c975b8bd1317e3d -F guid=f110ef1e-f080-11e6-a96f-0050560102f2 -F data="{\"accounting_status\":\"Skipped\",\"accounting_message\":\"Test\"}" https://dev.konto.is/api/v1/update-invoice |
Create Invoice
Create invoice with konto api
POSThttps://dev.konto.is/api/v1/create-invoice
Parameter | Type | Example | Description |
---|---|---|---|
username |
string | required | |
api_key |
string | required | |
data |
string |
|
(required) json of detail invoice |
200
Parameter | Type | Example | Description |
---|---|---|---|
status |
boolean | Return TRUE when success | |
message |
string | if status is FALSE then messge will describe this error | |
result |
integer | if status is TRUE is GUID of invoice |
curl -k -X POST -F username=testuser -F api_key=3a62cd2568635f115c975b8bd1317e3d -F data="{\"amount\":2,\"currency\":\"USD\",\"customer\":{\"guid\":\"5a14796e-13c6-11e7-9914-408d5c6208bc\"},\"settlement_date\":\"2017-5-20\",\"due_date\":\"2017-5-20\",\"issue_date\":\"2017-5-20\",\"type\":\"invoice\",\"description\":\"Test\",\"booking\":\"Test\",\"cost_provide\":\"Test\",\"terms\":\"Test\",\"delivery_date\":\"\",\"is_claim\":1,\"mark_paid\":0,\"is_discount\":0,\"discount_type\":0,\"discount_value\":0,\"items\":[{\"item_number\":\"1\",\"description\":\"111\",\"qty\":1,\"uom\":\"C62\",\"tax\":\"Z\",\"unit_price\":1,\"discount\":0,\"save\":0,\"discount_type\":0,\"add_new\":1},{\"guid\":\"43521ec8-3413-11e7-b148-408d5c6208bc\",\"qty\":1,\"discount\":0,\"discount_type\":0}]}" https://dev.konto.is/api/v1/create-invoice |
Create Recurring Invoice
Create recurring invoice with konto api
POSThttps://dev.konto.is/api/v1/create-recurring-invoice
Parameter | Type | Example | Description |
---|---|---|---|
username |
string | required | |
api_key |
string | required | |
data |
string |
|
(required) json of detail invoice |
200
Parameter | Type | Example | Description |
---|---|---|---|
status |
boolean | Return TRUE when success | |
message |
string | if status is FALSE then messge will describe this error | |
result |
integer | if status is TRUE is GUID of invoice |
curl -k -X POST -F username=testuser -F api_key=3a62cd2568635f115c975b8bd1317e3d -F data="{\"recurring_name\" : \"Recurring test\",\"recurring_max_invoice\" : 3,\"recurring_interval\" : \"quarterly\",\"recurring_start_date\" : \"2018-10-10\",\"recurring_link_national\" : 0,\"amount\" : 2,\"currency\" : \"USD\",\"customer\" : {\"guid\" : \"5a14796e-13c6-11e7-9914-408d5c6208bc\"},\"settlement_date\" : \"2018-10-10\",\"due_date\" : \"2018-10-10\",\"issue_date\" : \"2018-09-30\",\"description\" : \"Test\",\"booking\" : \"Test\",\"cost_provide\" : \"Test\",\"terms\" : \"Test\",\"delivery_date\" : \"\",\"is_claim\" : 1,\"is_discount\" : 0,\"discount_type\" : 0,\"discount_value\" : 0,\"mark_paid\" : 0,\"items\" : [{\"item_number\": \"1\",\"description\": \"111\",\"qty\": 1,\"uom\": \"C62\",\"tax\": \"Z\",\"unit_price\": 1,\"discount\": 0,\"discount_type\": 0,\"add_new\": 1},{\"guid\": \"43521ec8-3413-11e7-b148-408d5c6208bc\",\"qty\": 1,\"discount\": 0,\"discount_type\": 0}]}" https://dev.konto.is/api/v1/create-recurring-invoice |
Attachment Invoice
add attachment to invoice with konto api
POSThttps://dev.konto.is/api/v1/upload-file?username={username}&api_key={api_key}
Parameter | Type | Example | Description |
---|---|---|---|
file |
file | required |
200
Parameter | Type | Example | Description |
---|---|---|---|
status |
boolean | Return TRUE when success | |
message |
string | if status is FALSE then messge will describe this error | |
result |
integer | if status is TRUE is file id of invoice |
curl -X POST "https://dev.konto.is/api/v1/create-recurring-invoice?username=testuser&api_key=3a62cd2568635f115c975b8bd1317e3d" -H "content-type: multipart/form-data" -F "file=@10121.pdf" |
Cost
Cost detail
Cost detail example json
Parameter | Type | Example | Description |
---|---|---|---|
guid |
string | ||
description |
string | ||
vat_no |
string | ||
amount |
float | ||
vat_AA |
float | ||
vat_S |
float | ||
cost_code |
string | Items,Service,Travel,Sales,Finance,RawMaterial,Other,3028,2173,3033,3085,3090,2093,2243,2193,2423,2443,2353,2383,2403,2263,3163,2333,3140,2283,2533,2633,3653,5028,2153,3080 | |
how_paid |
integer |
1: Í reikning 2: Debitkort/Bankareikningur 3: Kreditkort 4: Eigandi/Starfsmaður greiddi |
|
file |
base64string | ||
posting_date |
datetime | Format (Y-m-d) | |
xml |
base64string | ||
accounting_status |
string | Created,Posted,Skipped,Error | |
updated_timestamp |
datetime | Format (Y-m-d) |
List Costs
Get list costs with konto api
GEThttps://dev.konto.is/api/v1/get-costs
Parameter | Type | Example | Description |
---|---|---|---|
username |
string | required | |
api_key |
string | required | |
accounting_status |
string | (optional) list accounting status. Example: "Created,Error" or "Skipped" or "Created,Posted,Skipped" | |
limit |
integer | (optional) item per page default 10 cost | |
page |
integer | (optional) page number |
200
Parameter | Type | Example | Description |
---|---|---|---|
status |
boolean | Return TRUE when success | |
message |
string | if status is FALSE then messge will describe this error | |
result |
object | if status is TRUE is show list cost | |
hasMore |
boolean | if true it has more items | |
limit |
integer | item per page | |
page |
integer | page number | |
next_url |
string | url next items |
curl -k -X GET -F username=testuser -F api_key=3a62cd2568635f115c975b8bd1317e3d https://dev.konto.is/api/v1/get-costs |
Count Costs
Get count costs with konto api
GEThttps://dev.konto.is/api/v1/get-count-costs
Parameter | Type | Example | Description |
---|---|---|---|
username |
string | required | |
api_key |
string | required | |
accounting_status |
string | (optional) list accounting status. Example: "Created,Error" or "Skipped" or "Created,Posted,Skipped" |
200
Parameter | Type | Example | Description |
---|---|---|---|
status |
boolean | Return TRUE when success | |
message |
string | if status is FALSE then messge will describe this error | |
result |
integer | if status is TRUE is show count costs |
curl -k -X GET -F username=testuser -F api_key=3a62cd2568635f115c975b8bd1317e3d https://dev.konto.is/api/v1/get-count-costs |
Get Cost
Get detail cost with konto api
GEThttps://dev.konto.is/api/v1/get-cost
Parameter | Type | Example | Description |
---|---|---|---|
username |
string | required | |
api_key |
string | required | |
guid |
string | required |
200
Parameter | Type | Example | Description |
---|---|---|---|
status |
boolean | Return TRUE when success | |
message |
string | if status is FALSE then messge will describe this error | |
result |
json | if status is TRUE is detail cost |
curl -k -X GET -F username=testuser -F api_key=3a62cd2568635f115c975b8bd1317e3d -F guid=f110ef1e-f080-11e6-a96f-0050560102f2 https://dev.konto.is/api/v1/get-cost |
Cost Invoice
Update a cost with konto api
POSThttps://dev.konto.is/api/v1/update-cost
Parameter | Type | Example | Description |
---|---|---|---|
username |
string | required | |
api_key |
string | required | |
guid |
string | required | |
data |
json |
|
(required) |
200
Parameter | Type | Example | Description |
---|---|---|---|
status |
boolean | Return TRUE when success | |
message |
string | if status is FALSE then messge will describe this error | |
result |
integer | if status is TRUE is GUID of cost |
curl -k -X POST -F username=testuser -F api_key=3a62cd2568635f115c975b8bd1317e3d -F guid=f110ef1e-f080-11e6-a96f-0050560102f2 -F data="{\"accounting_status\":\"Skipped\",\"accounting_message\":\"Test\"}" https://dev.konto.is/api/v1/update-cost |
Bookkeeper
Bookkeeper detail
Bookkeeper detail example json
Parameter | Type | Example | Description |
---|---|---|---|
guid |
string | ||
name |
string | ||
username |
string | ||
registration_no |
string | ||
vat_no |
string | ||
email |
string | ||
service_provider_guid |
string | ||
status |
String | Registered,Active,Inactive | |
count_of_bookkeepers |
integer | ||
instance_config |
json |
Tenant detail
Tenant detail example json
Parameter | Type | Example | Description |
---|---|---|---|
guid |
string | ||
name |
string | ||
username |
string | ||
api_key |
string | ||
registration_no |
string | ||
vat_no |
string | ||
email |
string | ||
address |
string | ||
zip |
string | ||
city |
string | ||
phone_number |
string | ||
bank_account |
string | ||
bank_provider |
string | ||
claim_identifier |
string | ||
bank_username |
string | ||
bank_password |
string | ||
claim_branch |
string | ||
bookkeeper_guid |
string | ||
active_plan |
string | ||
count_of_payusers |
integer | ||
active_item |
string |
Get Bookkeeper
Get detail bookkeeper with konto api
GEThttps://dev.konto.is/api/v1/get-bookkeeper
Parameter | Type | Example | Description |
---|---|---|---|
username |
string | required | |
api_key |
string | required | |
guid |
string | required |
200
Parameter | Type | Example | Description |
---|---|---|---|
status |
boolean | Return TRUE when success | |
message |
string | if status is FALSE then messge will describe this error | |
result |
json | if status is TRUE is detail bookkeeper |
curl -k -X GET -F username=testuser -F api_key=3a62cd2568635f115c975b8bd1317e3d -F guid=f110ef1e-f080-11e6-a96f-0050560102f2 https://dev.konto.is/api/v1/get-bookkeeper |
Get Tenant
Get detail tenant with konto api
GEThttps://dev.konto.is/api/v1/get-tenant
Parameter | Type | Example | Description |
---|---|---|---|
username |
string | required | |
api_key |
string | required | |
guid |
string | required |
200
Parameter | Type | Example | Description |
---|---|---|---|
status |
boolean | Return TRUE when success | |
message |
string | if status is FALSE then messge will describe this error | |
result |
json | if status is TRUE is detail tenant |
curl -k -X GET -F username=testuser -F api_key=3a62cd2568635f115c975b8bd1317e3d -F guid=f110ef1e-f080-11e6-a96f-0050560102f2 https://dev.konto.is/api/v1/get-tenant |
Bookkeeper
Update a bookkeeper with konto api
POSThttps://dev.konto.is/api/v1/update-bookkeeper
Parameter | Type | Example | Description |
---|---|---|---|
username |
string | required | |
api_key |
string | required | |
guid |
string | required | |
status |
string | Registered,Active,Inactive | |
count_of_bookkeepers |
integer | ||
instance_config |
json |
200
Parameter | Type | Example | Description |
---|---|---|---|
status |
boolean | Return TRUE when success | |
message |
string | if status is FALSE then messge will describe this error | |
result |
integer | if status is TRUE is GUID of bookkeeper |
curl -k -X POST -F username=testuser -F api_key=3a62cd2568635f115c975b8bd1317e3d -F guid=f110ef1e-f080-11e6-a96f-0050560102f2 -F status=Active https://dev.konto.is/api/v1/update-bookkeeper |
Bill-to-Invoices
Invoice detail for create save
Invoice detail for create save example json
Parameter | Type | Example | Description |
---|---|---|---|
amount |
float | required | |
currency |
string | required ISK,EUR,USD,DKK,NOK,SEK,JPY,GBP,AUD,PLN,CAD,CHF,CNY,NZD,MXN,SGD,HKD,KRW,TRY,RUB,INR,VND,BRL,ZAR,UAH,CZK | |
issue_date |
datetime | required Format (Y-m-d) | |
due_date |
datetime | required Format (Y-m-d) | |
settlement_date |
datetime | required Format (Y-m-d) | |
description |
string | ||
booking |
string | ||
cost_provide |
string | ||
delivery_date |
datetime | Format (Y-m-d) | |
terms |
string | ||
type |
string | required invoice,credit | |
items |
string | required list invoice item | |
trading_partner_id |
string | ||
is_claim |
boolean | ||
is_discount |
boolean | ||
discount_type |
boolean | 1: %, 0: price | |
discount_value |
float | ||
mark_paid |
boolean | ||
create_type |
string | required user,email | |
kennitala |
string | required if create_type is user | |
email |
string | required if create_type is email |
Create Save Invoice
Create save invoice with konto api
POSThttps://dev.konto.is/api/v1/create-save-invoice
Parameter | Type | Example | Description |
---|---|---|---|
username |
string | required | |
api_key |
string | required | |
data |
string |
|
(required) json of detail invoice |
200
Parameter | Type | Example | Description |
---|---|---|---|
status |
boolean | Return TRUE when success | |
message |
string | if status is FALSE then messge will describe this error | |
result |
integer | This is GUID of invoice if create_type is "user" and status is "TRUE" |
curl -k -X POST -F username=testuser -F api_key=3a62cd2568635f115c975b8bd1317e3d -F data="{\"amount\":\"2095.6\",\"currency\":\"ISK\",\"create_type\":\"user\",\"kennitala\":\"4444444444\",\"settlement_date\":\"2021-06-09\",\"due_date\":\"2021-06-09\",\"issue_date\":\"2021-06-07\",\"type\":\"invoice\",\"items\":[{\"guid\":\"6be71e6c-d7dd-11e7-b836-005056c00001\",\"qty\":1}]}" https://dev.konto.is/api/v1/create-save-invoice |
Order Invoices
Order invoice detail
Order invoice example json
Parameter | Type | Example | Description |
---|---|---|---|
guid |
string | ||
number |
string | ||
amount |
float | ||
issue_date |
datetime | Format (Y-m-d) |
Invoice detail for create save
Invoice detail for create save example json
Parameter | Type | Example | Description |
---|---|---|---|
amount |
float | required | |
currency |
string | required ISK,EUR,USD,DKK,NOK,SEK,JPY,GBP,AUD,PLN,CAD,CHF,CNY,NZD,MXN,SGD,HKD,KRW,TRY,RUB,INR,VND,BRL,ZAR,UAH,CZK | |
settlement_date |
number | required | |
description |
string | ||
booking |
string | required | |
cost_provide |
string | ||
delivery_date |
datetime | Format (Y-m-d) | |
terms |
string | ||
items |
string | required list invoice item | |
trading_partner_id |
string | ||
is_claim |
boolean | ||
is_discount |
boolean | ||
discount_type |
boolean | 1: %, 0: price | |
discount_value |
float | ||
mark_paid |
boolean | ||
kennitala |
string | required |
Invoice detail for update order
Invoice detail for update order example json
Parameter | Type | Example | Description |
---|---|---|---|
amount |
float | ||
currency |
string | ISK,EUR,USD,DKK,NOK,SEK,JPY,GBP,AUD,PLN,CAD,CHF,CNY,NZD,MXN,SGD,HKD,KRW,TRY,RUB,INR,VND,BRL,ZAR,UAH,CZK | |
settlement_date |
number | ||
description |
string | ||
booking |
string | ||
cost_provide |
string | ||
delivery_date |
datetime | Format (Y-m-d) | |
terms |
string | ||
items |
string | list invoice item | |
trading_partner_id |
string | ||
is_claim |
boolean | ||
is_discount |
boolean | ||
discount_type |
boolean | 1: %, 0: price | |
discount_value |
float | ||
mark_paid |
boolean | ||
kennitala |
string |
Create Order Invoice
Create order invoice with konto api
POSThttps://dev.konto.is/api/v1/create-order-invoice
Parameter | Type | Example | Description |
---|---|---|---|
username |
string | required | |
api_key |
string | required | |
data |
string |
|
(required) json of detail invoice |
200
Parameter | Type | Example | Description |
---|---|---|---|
status |
boolean | Return TRUE when success | |
message |
string | if status is FALSE then messge will describe this error | |
result |
integer | if status is TRUE is GUID of invoice |
curl -k -X POST -F username=testuser -F api_key=3a62cd2568635f115c975b8bd1317e3d -F data="{\"amount\":\"2095.6\",\"currency\":\"ISK\",\"kennitala\":\"4444444444\",\"booking\":\"test\",\"settlement_date\":\"10\",\"items\":[{\"guid\":\"6be71e6c-d7dd-11e7-b836-005056c00001\",\"qty\":1}]}" https://dev.konto.is/api/v1/create-order-invoice |
Update Order Invoice
Update order invoice with konto api
POSThttps://dev.konto.is/api/v1/update-order-invoice
Parameter | Type | Example | Description |
---|---|---|---|
username |
string | required | |
api_key |
string | required | |
guid |
string | required | |
data |
string |
|
(required) json of detail invoice |
200
Parameter | Type | Example | Description |
---|---|---|---|
status |
boolean | Return TRUE when success | |
message |
string | if status is FALSE then messge will describe this error | |
result |
integer | if status is TRUE is GUID of invoice |
curl -k -X POST -F username=testuser -F api_key=3a62cd2568635f115c975b8bd1317e3d -F guid=f110ef1e-f080-11e6-a96f-0050560102f2 -F data="{\"amount\":\"2095.6\",\"currency\":\"ISK\",\"kennitala\":\"4444444444\",\"settlement_date\":\"10\",\"items\":[{\"guid\":\"6be71e6c-d7dd-11e7-b836-005056c00001\",\"qty\":1}]}" https://dev.konto.is/api/v1/update-order-invoice |
Delete Order Invoice
Delete order invoice with konto api
POSThttps://dev.konto.is/api/v1/delete-order-invoice
Parameter | Type | Example | Description |
---|---|---|---|
username |
string | required | |
api_key |
string | required | |
guid |
string | required |
200
Parameter | Type | Example | Description |
---|---|---|---|
status |
boolean | Return TRUE when success | |
message |
string | if status is FALSE then messge will describe this error |
curl -k -X POST -F username=testuser -F api_key=3a62cd2568635f115c975b8bd1317e3d -F guid=f110ef1e-f080-11e6-a96f-0050560102f2 https://dev.konto.is/api/v1/delete-order-invoice |
Get Invoice From Order
Get list invoice from order with konto api
POSThttps://dev.konto.is/api/v1/get-invoices-from-order
Parameter | Type | Example | Description |
---|---|---|---|
username |
string | required | |
api_key |
string | required | |
guid |
string | required | |
limit |
integer | (optional) item per page default all invoice | |
page |
integer | (optional) page number |
200
Parameter | Type | Example | Description |
---|---|---|---|
status |
boolean | Return TRUE when success | |
message |
string | if status is FALSE then messge will describe this error | |
result |
object | if status is TRUE is show list invoice |
curl -k -X POST -F username=testuser -F api_key=3a62cd2568635f115c975b8bd1317e3d -F guid=f110ef1e-f080-11e6-a96f-0050560102f2 https://dev.konto.is/api/v1/get-invoices-from-order |
Dashboard Data
Invoice detail
Invoice detail example json
Parameter | Type | Example | Description |
---|---|---|---|
invoice_creator_username |
string | The unique username from Konto system | |
invoice_issue_date |
date | Format (Y-m-d) | |
invoice_number |
string | The unique invoice number | |
invoice_status |
string | Invoice can be either Paid or Not Paid | |
customer_number |
string | Value from the customer profile (other information) - does not have to be unique - used to group users | |
customer_name |
string | Customer name - from customer profile | |
customer_guid |
string | Unique ID for this customer profile | |
invoice_description |
string | The description value from this invoice | |
document_type |
string | "Invoice" or "Credit Note" | |
invoice_booking_information |
string | The booking information value from this invoice | |
invoice_order_reference |
string | The order reference value from this invoice | |
invoice_cost_location |
string | The Cost location value selected for this invoice | |
invoice_total_excluding_vat |
string | Invoice total amount, excluding VAT | |
invoice_vat_total |
string | Total amount of VAT for this invoice | |
invoice_total_discount |
string | Total amount discounted from this invoice | |
invoice_total_including_vat |
string | Invoice total amount, including VAT | |
items |
string | list invoice item |
Invoice item detail
Invoice item detail example json
Parameter | Type | Example | Description |
---|---|---|---|
number |
string | The given Product number | |
name |
string | The given Product Name | |
description |
string | Product Description | |
qty |
integer | Quantity | |
uom |
string | Unit of measure (C62,KGS,MTR,LTR,MTK,MTQ,TNE,KWH,DAY,HUR,MIN,KTM) | |
vat_code |
string | S,AA,Z | |
category_code |
string | Registered value on Product in item-list | |
guid |
string | Unique ID for this product | |
product_cost |
string | Product cost value used to calculate the margin and profit | |
total_excluding_vat |
float | Item line total, excluding the VAT | |
total_vat |
float | Total VAT on the item-line | |
total_including_vat |
float | Item line total, including VAT | |
total_discount |
float | Total amount discounted for this item line (including VAT) | |
profit |
number | Total amount (excluding VAT) minus the Product cost | |
margin |
number | Ratio of Product cost and Sales amount |
Get data
Get list invoice for dashboard data konto api
POSThttps://dev.konto.is/api/v1/get-dashboard-data
Parameter | Type | Example | Description |
---|---|---|---|
username |
string | required | |
api_key |
string | required | |
start_date |
date | (optional) Format (Y-m-d) | |
end_date |
date | (optional) Format (Y-m-d) | |
limit |
integer | (optional) item per page default all invoice | |
page |
integer | (optional) page number |
200
curl -k -X POST -F username=testuser -F api_key=3a62cd2568635f115c975b8bd1317e3d -F guid=f110ef1e-f080-11e6-a96f-0050560102f2 https://dev.konto.is/api/v1/get-dashboard-data |