Finance
Last updated
Last updated
GET
https://api.zortout.com/api.aspx
Get list of incomes.
Name | Type | Description |
---|---|---|
GET
https://api.zortout.com/api.aspx
Get income detail.
POST
https://api.zortout.com/api.aspx
Add income.
POST
https://api.zortout.com/api.aspx
Update payment of income.
GET
https://api.zortout.com/api.aspx
Get list of expenses.
GET
https://api.zortout.com/api.aspx
Get expense detail.
POST
https://api.zortout.com/api.aspx
Add expense.
POST
https://api.zortout.com/api.aspx
Update payment of expense.
Name | Type | Description |
---|---|---|
Parameter | Type | Description/Example |
---|---|---|
IncomeTransaction (Array) | Type | Description/Example |
---|---|---|
IncomeItem (Array) | Type | Description/Example |
---|---|---|
Payment (Array) | Type | Description/Example |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Parameter | Type | Description/Example |
---|---|---|
IncomeItem (Array) | Type | Description/Example |
---|---|---|
Payment (Array) | Type | Description/Example |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Parameter | Type | Description/Example |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Parameter | Type | Description/Example |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Parameter | Type | Description/Example |
---|---|---|
ExpenseTransaction (Array) | Type | Description/Example |
---|---|---|
ExpenseItem (Array) | Type | Description/Example |
---|---|---|
Payment (Array) | Type | Description/Example |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Parameter | Type | Description/Example |
---|---|---|
ExpenseItem (Array) | Type | Description/Example |
---|---|---|
Payment (Array) | Type | Description/Example |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Parameter | Type | Description/Example |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Parameter | Type | Description/Example |
---|---|---|
method*
String
"GETINCOMES"
createdatetimeafter
String
Created Datetime After ..... (yyyy-MM-dd HH:mm)
paymentbefore
String
Paid Date Before ..... (yyyy-MM-dd)
paymentafter
String
Paid Date After ..... (yyyy-MM-dd)
updatedbefore
String
Updated Date Before ..... (yyyy-MM-dd)
updatedafter
String
Updated Date After ..... (yyyy-MM-dd)
createdbefore
String
Created Date Before ..... (yyyy-MM-dd)
createdafter
String
Created Date After ..... (yyyy-MM-dd)
incomedatebefore
String
Income Date Before ..... (yyyy-MM-dd)
incomedateafter
String
Income Date After ..... (yyyy-MM-dd)
version*
String
3
format
String
json (Default), xml
limit
Int
Limit per page (Max = 2000)
page
Int
Page (Default = 1)
keyword
String
Keyword to search
updatedatetimebefore
String
Updated Datetime Before ..... (yyyy-MM-dd HH:mm)
updatedatetimeafter
String
Updated Datetime After ..... (yyyy-MM-dd HH:mm)
createdatetimebefore
String
Created Datetime Before ..... (yyyy-MM-dd HH:mm)
storename*
String
Store Name
apikey*
String
API Key
apisecret*
String
API Secret
incomeidlist
String
List Of Income ID Ex. “123,124,125”
res
Response
Response Code 200- Success
list
IncomeTransaction (Array)
Income Transaction List (Array)
count
Int
Total income number by filter
id
Int
Income ID
contactid
Int
Contact ID
contactname
String
Contact Name
contactidnumber
String
Contact ID Number/Tax ID
contactemail
String
Contact Email
contactphone
String
Contact Phone
contactaddress
String
Contact Address
contactbranchname
String
Contact Branch Name
contactbranchno
String
Contact Branch No
paymentstatus
String
Payment Status (Pending, Paid, Partial Payment, Excess Payment)
amount
Double
Net Amount
vatamount
Double
Vat Amount
incomedate
Date
Income Date (yyyy-MM-dd)
incomedateString
String
Income Date Text (yyyy-MM-dd)
paymentamount
Double
Payment Amount
reference
String
Reference
description
String
Description
discount
String
Discount Ex.5.00, 10%
vattype
Int
Vat Type 1 – No Vat (Default) 2 – Exclude Vat 3 – Include Vat
list
IncomeItem (Array)
Item List
payments
Payment (Array)
Payment List
tag
String (Array)
Tag List (Array)
createdatetime
Datetime
Created Datetime
createdatetimeString
String
Created Datetime Text (yyyy-MM-dd HH:mm)
updatedatetime
Datetime
Updated Datetime
updatedatetimeString
String
Updated Datetime Text (yyyy-MM-dd HH:mm)
createuserid
Int
Created User ID
createusername
String
Created User (Username)
createdby
String
Created User (Display name)
uniquenumber
String
Unique Number
id
Int
Item ID
name
String
Item Name
categoryname
String
Item Category
totalprice
Double
Total Price
id
Int
Payment ID
name
String
Payment Method Name
amount
Double
Payment Amount
paymentdatetime
Datetime
Payment Datetime
paymentdatetimeString
String
Payment Datetime Text (yyyy-MM-dd HH:mm)
method*
String
"GETINCOMEDETAIL"
format
String
json (Default), xml
version*
String
3
id*
Int
Income ID
storename*
String
Store Name
apikey*
String
API Key
apisecret*
String
API Secret
id
Int
Income ID
contactid
Int
Contact ID
contactname
String
Contact Name
contactidnumber
String
Contact ID Number/Tax ID
contactemail
String
Contact Email
contactphone
String
Contact Phone
contactaddress
String
Contact Address
contactbranchname
String
Contact Branch Name
contactbranchno
String
Contact Branch No
paymentstatus
String
Payment Status (Pending, Paid, Partial Payment, Excess Payment)
amount
Double
Net Amount
vatamount
Double
Vat Amount
incomedate
Date
Income Date (yyyy-MM-dd)
incomedateString
String
Income Date Text (yyyy-MM-dd)
paymentamount
Double
Payment Amount
reference
String
Reference
description
String
Description
discount
String
Discount Ex.5.00, 10%
vattype
Int
Vat Type 1 – No Vat (Default) 2 – Exclude Vat 3 – Include Vat
list
IncomeItem (Array)
Item List
payments
Payment (Array)
Payment List
tag
String (Array)
Tag List (Array)
createdatetime
Datetime
Created Datetime
createdatetimeString
String
Created Datetime Text (yyyy-MM-dd HH:mm)
updatedatetime
Datetime
Updated Datetime
updatedatetimeString
String
Updated Datetime Text (yyyy-MM-dd HH:mm)
createuserid
Int
Created User ID
createusername
String
Created User (Username)
createdby
String
Created User (Display name)
uniquenumber
String
Unique Number
id
Int
Item ID
name
String
Item Name
categoryname
String
Item Category
totalprice
Double
Total Price
id
Int
Payment ID
name
String
Payment Method Name
amount
Double
Payment Amount
paymentdatetime
Datetime
Payment Datetime
paymentdatetimeString
String
Payment Datetime Text (yyyy-MM-dd HH:mm)
method*
String
"ADDINCOME"
format
String
json (Default), xml
version*
String
3
uniquenumber
String
Unique Number.
This value is unique and used to prevent duplicate transaction.
storename*
String
Store Name
apikey*
String
API Key
apisecret*
String
API Secret
contactname
String
Contact Name
contactidnumber
String
Contact ID Number/Tax ID
contactemail
String
Contact Email
contactphone
String
Contact Phone
contactaddress
String
Contact Address
contactbranchname
String
Contact Branch Name
amount*
Double
Net Amount
customerbranchno
String
Contact Branch No
vatamount
Double
Vat Amount
vattype
Int
Vat Type 1 – No Vat 2 – Exclude Vat 3 – Include Vat If vattype is not defined, the system will use vatamount to calculate and define automatically. If vattype = 1, 2 or 3, the system will ignore vatamount and calculate vatamount value automatically.
incomedate
String
Income Date Ex. "2021-09-15"
paymentmethod
String
Payment Method
paymentamount
Double
Payment Amount
("paymentmethod" must be required.)
paymentdate
String
Payment Datetime Ex. “2021-09-15 21:05”
description
String
Description
discount
String
Discount Ex. 5.00, 10%
tag
String (Array)
Tag List (Array)
list
IncomeItem (Array)
Item List
∟ name*
String
Item Name
∟ categoryname
String
Item Category
∟ totalprice*
Double
Total Price
reference
String
Reference
resCode
String
Response Code 200- Success
resDesc
String
Response Description
method*
String
“UPDATEINCOMEPAYMENT”
paymentdate
String
Payment Datetime Ex. “2021-09-15 21:05”
paymentamount*
Double
Payment Amount
paymentmethod*
String
Payment Method
version*
String
3
format
String
json (Default), xml
id*
Int
Income ID
storename*
String
Store Name
apikey*
String
API Key
apisecret*
String
API Secret
resCode
String
Response Code 200- Success
resDesc
String
Response Description
format
String
json (Default), xml
method*
String
"GETEXPENSES"
expensedatebefore
String
Expense Date Before ..... (yyyy-MM-dd)
expensedateafter
String
Expense Date After ..... (yyyy-MM-dd)
version*
String
3
format
String
json (Default), xml
updatedbefore
String
Updated Date Before ..... (yyyy-MM-dd)
updatedafter
String
Updated Date After ..... (yyyy-MM-dd)
createdbefore
String
Created Date Before ..... (yyyy-MM-dd)
createdafter
String
Created Date After ..... (yyyy-MM-dd)
createdatetimeafter
String
Created Datetime After ..... (yyyy-MM-dd HH:mm)
paymentbefore
String
Paid Date Before ..... (yyyy-MM-dd)
paymentafter
String
Paid Date After ..... (yyyy-MM-dd)
updatedatetimebefore
String
Updated Datetime Before ..... (yyyy-MM-dd HH:mm)
updatedatetimeafter
String
Updated Datetime After ..... (yyyy-MM-dd HH:mm)
createdatetimebefore
String
Created Datetime Before ..... (yyyy-MM-dd HH:mm)
limit
Int
Limit per page (Max = 2000)
page
Int
Page (Default = 1)
keyword
String
Keyword to search
storename*
String
Store Name
apikey*
String
API Key
apisecret*
String
API Secret
expenseidlist
String
List Of Expense ID Ex. “123,124,125”
res
Response
Response Code 200- Success
list
ExpenseTransaction (Array)
Expense Transaction List (Array)
count
Int
Total expense number by filter
id
Int
Expense ID
contactid
Int
Contact ID
contactname
String
Contact Name
contactidnumber
String
Contact ID Number/Tax ID
contactemail
String
Contact Email
contactphone
String
Contact Phone
contactaddress
String
Contact Address
contactbranchname
String
Contact Branch Name
contactbranchno
String
Contact Branch No
paymentstatus
String
Payment Status (Pending, Paid, Partial Payment, Excess Payment)
amount
Double
Net Amount
vatamount
Double
Vat Amount
expensedate
Date
Expense Date (yyyy-MM-dd)
expensedateString
String
Expense Date Text (yyyy-MM-dd)
paymentamount
Double
Payment Amount
reference
String
Reference
description
String
Description
discount
String
Discount Ex.5.00, 10%
vattype
Int
Vat Type 1 – No Vat (Default) 2 – Exclude Vat 3 – Include Vat
list
ExpenseItem (Array)
Item List
payments
Payment (Array)
Payment List
tag
String (Array)
Tag List (Array)
createdatetime
Datetime
Created Datetime
createdatetimeString
String
Created Datetime Text (yyyy-MM-dd HH:mm)
updatedatetime
Datetime
Updated Datetime
updatedatetimeString
String
Updated Datetime Text (yyyy-MM-dd HH:mm)
createuserid
Int
Created User ID
createusername
String
Created User (Username)
createdby
String
Created User (Display name)
uniquenumber
String
Unique Number
id
Int
Item ID
name
String
Item Name
categoryname
String
Item Category
totalprice
Double
Total Price
id
Int
Payment ID
name
String
Payment Method Name
amount
Double
Payment Amount
paymentdatetime
Datetime
Payment Datetime
paymentdatetimeString
String
Payment Datetime Text (yyyy-MM-dd HH:mm)
method*
String
"GETEXPENSEDETAIL"
id*
Int
Expense ID
version*
String
3
format
String
json (Default), xml
storename*
String
Store Name
apikey*
String
API Key
apisecret*
String
API Secret
id
Int
Expense ID
contactid
Int
Contact ID
contactname
String
Contact Name
contactidnumber
String
Contact ID Number/Tax ID
contactemail
String
Contact Email
contactphone
String
Contact Phone
contactaddress
String
Contact Address
contactbranchname
String
Contact Branch Name
contactbranchno
String
Contact Branch No
paymentstatus
String
Payment Status (Pending, Paid, Partial Payment, Excess Payment)
amount
Double
Net Amount
vatamount
Double
Vat Amount
expensedate
Date
Expense Date
expensedateString
String
Expense Date Text (yyyy-MM-dd)
paymentamount
Double
Payment Amount
reference
String
Reference
description
String
Description
discount
String
Discount Ex.5.00, 10%
vattype
Int
Vat Type 1 – No Vat (Default) 2 – Exclude Vat 3 – Include Vat
list
ExpenseItem (Array)
Item List
payments
Payment (Array)
Payment List
tag
String (Array)
Tag List (Array)
createdatetime
Datetime
Created Datetime
createdatetimeString
String
Created Datetime Text (yyyy-MM-dd HH:mm)
updatedatetime
Datetime
Updated Datetime
updatedatetimeString
String
Updated Datetime Text (yyyy-MM-dd HH:mm)
createuserid
Int
Created User ID
createusername
String
Created User (Username)
createdby
String
Created User (Display name)
uniquenumber
String
Unique Number
id
Int
Item ID
name
String
Item Name
categoryname
String
Item Category
totalprice
Double
Total Price
id
Int
Payment ID
name
String
Payment Method Name
amount
Double
Payment Amount
paymentdatetime
Datetime
Payment Datetime
paymentdatetimeString
String
Payment Datetime Text (yyyy-MM-dd HH:mm)
method*
String
"ADDEXPENSE"
uniquenumber
String
Unique Number.
This value is unique and used to prevent duplicate transaction.
version*
String
3
format
String
json (Default), xml
storename*
String
Store Name
apikey*
String
API Key
apisecret*
String
API Secret
contactname
String
Contact Name
contactidnumber
String
Contact ID Number/Tax ID
contactemail
String
Contact Email
contactphone
String
Contact Phone
contactaddress
String
Contact Address
paymentamount
Double
Payment Amount
("paymentmethod" must be required.)
paymentmethod
String
Payment Method
expensedate
String
Expense Date Ex. "2021-09-15"
vattype
Int
Vat Type 1 – No Vat 2 – Exclude Vat 3 – Include Vat If vattype is not defined, the system will use vatamount to calculate and define automatically. If vattype = 1, 2 or 3, the system will ignore vatamount and calculate vatamount value automatically.
vatamount
Double
Vat Amount
amount*
Double
Net Amount
contactbranchno
String
Contact Branch No
contactbranchname
String
Contact Branch Name
∟ name*
String
Item Name
list
ExpenseItem (Array)
Item List
tag
String (Array)
Tag List (Array)
discount
String
Discount Ex. 5.00, 10%
description
String
Description
paymentdate
String
Payment Datetime Ex. “2021-09-15 21:05”
∟ categoryname
String
Item Category
∟ totalprice*
Double
Total Price
reference
String
Reference
resCode
String
Response Code 200- Success
resDesc
String
Response Description
method*
String
“UPDATEEXPENSEPAYMENT”
paymentdate
String
Payment Datetime Ex. “2021-09-15 21:05”
paymentamount*
Double
Payment Amount
paymentmethod*
String
Payment Method
id*
Int
Expense ID
version*
String
3
format
String
json (Default), xml
storename*
String
Store Name
apikey*
String
API Key
apisecret*
String
API Secret
resCode
String
Response Code 200- Success
resDesc
String
Response Description