Finance

Get Incomes

GET https://open-api.zortout.com/v4/Finance/GetIncomes

Get list of incomes.

Query Parameters

Name	Type	Description
incomedateafter	String	Income Date After ..... (yyyy-MM-dd)
incomedatebefore	String	Income Date Before ..... (yyyy-MM-dd)
createdafter	String	Created Date After ..... (yyyy-MM-dd)
createdbefore	String	Created Date Before ..... (yyyy-MM-dd)
updatedafter	String	Updated Date After ..... (yyyy-MM-dd)
updatedbefore	String	Updated Date Before ..... (yyyy-MM-dd)
paymentafter	String	Paid Date After ..... (yyyy-MM-dd)
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)
createdatetimeafter	String	Created Datetime After ..... (yyyy-MM-dd HH:mm)
paymentbefore	String	Paid Date Before ..... (yyyy-MM-dd)
limit	Int	Limit per page (Max = 500)

Headers

Name	Type	Description
storename*	String	Store Name
apikey*	String	API Key
apisecret*	String	API Secret
incomeidlist	String	List Of Income ID Ex. “123,124,125”

Response

Parameter	Type	Description/Example
res	Response	Response Code 200- Success
list	IncomeTransaction (Array)	IncomeTransaction List (Array)
count	Int	Total income number by filter

IncomeTransaction (Array)	Type	Description/Example
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
amount_pretax	Double	Pretax 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

IncomeItem (Array)	Type	Description/Example
id	Int	Item ID
name	String	Item Name
categoryname	String	Item Category
totalprice	Double	Total Price
totalprice_pretax	Double	Pretax Total Price
totalprice_vat	Double	Total Vat

Payment (Array)	Type	Description/Example
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)

Get Income Detail

GET https://open-api.zortout.com/v4/Finance/GetIncomeDetail

Get income detail.

Query Parameters

Name	Type	Description
id*	Int	Income ID

Headers

Name	Type	Description
storename*	String	Store Name
apikey*	String	API Key
apisecret*	String	API Secret

Response

Parameter	Type	Description/Example
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
amount_pretax	Double	Pretax Amount
vatamount	Double	Vat Amount
incomedate	Date	Income Date Text (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

IncomeItem (Array)	Type	Description/Example
id	Int	Item ID
name	String	Item Name
categoryname	String	Item Category
totalprice	Double	Total Price
totalprice_pretax	Double	Pretax Total Price
totalprice_vat	Double	Total Vat

Payment (Array)	Type	Description/Example
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)

Add Income

POST https://open-api.zortout.com/v4/Finance/AddIncome

Add income.

Query Parameters

Name	Type	Description
uniquenumber	String	Unique Number. This value is unique and used to prevent duplicate transaction.

Headers

Name	Type	Description
storename*	String	Store Name
apikey*	String	API Key
apisecret*	String	API Secret

Request Body

Name	Type	Description
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

Response

Parameter	Type	Description/Example
resCode	String	Response Code 200- Success
resDesc	String	Response Description
detail	Detail	Detail

Detail	Type	Description/Example
id	Int	Income ID

Ex. Request JSON

{
  "incomedate": "2021-05-31",
  "amount": 58,
  "vatamount": 0,
  "paymentmethod": "Cash",
  "list": [
    {
      "name": "Income1",
      "categoryname": "Others",
      "totalprice": 48
    },
    {
      "name": "Income2",
      "totalprice": 10
    }
  ]
}

Update Income Payment

POST https://open-api.zortout.com/v4/Finance/UpdateIncomePayment

Update payment of income.

Query Parameters

Name	Type	Description
id*	Int	Income ID
paymentdate	String	Payment Datetime Ex. “2021-09-15 21:05”
paymentamount*	Double	Payment Amount
paymentmethod*	String	Payment Method

Headers

Name	Type	Description
storename*	String	Store Name
apikey*	String	API Key
apisecret*	String	API Secret

Response

Parameter	Type	Description/Example
resCode	String	Response Code 200- Success
resDesc	String	Response Description

Get Expenses

GET https://open-api.zortout.com/v4/Finance/GetExpenses

Get list of expenses.

Query Parameters

Name	Type	Description
expensedateafter	String	Expense Date After ..... (yyyy-MM-dd)
limit	Int	Limit per page (Max = 500)
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)
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)
expensedatebefore	String	Expense Date Before ..... (yyyy-MM-dd)

Headers

Name	Type	Description
storename*	String	Store Name
apikey*	String	API Key
apisecret*	String	API Secret
expenseidlist	String	List Of Expense ID Ex. “123,124,125”

Response

Parameter	Type	Description/Example
res	Response	Response Code 200- Success
list	ExpenseTransaction (Array)	ExpenseTransaction List (Array)
count	Int	Total expense number by filter

ExpenseTransaction (Array)	Type	Description/Example
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
amount_pretax	Double	Pretax Amount
vatamount	Double	Vat Amount
expensedate	Date	Expense Date Text (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

ExpenseItem (Array)	Type	Description/Example
id	Int	Item ID
name	String	Item Name
categoryname	String	Item Category
totalprice	Double	Total Price
totalprice_pretax	Double	Pretax Total Price
totalprice_vat	Double	Total Vat

Payment (Array)	Type	Description/Example
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)

Get Expense Detail

GET https://open-api.zortout.com/v4/Finance/GetExpenseDetail

Get expense detail.

Query Parameters

Name	Type	Description
id*	Int	Expense ID

Headers

Name	Type	Description
storename*	String	Store Name
apikey*	String	API Key
apisecret*	String	API Secret

Response

Parameter	Type	Description/Example
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
amount_pretax	Double	Pretax 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

ExpenseItem (Array)	Type	Description/Example
id	Int	Item ID
name	String	Item Name
categoryname	String	Item Category
totalprice	Double	Total Price
totalprice_pretax	Double	Pretax Total Price
totalprice_vat	Double	Total Vat

Payment (Array)	Type	Description/Example
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)

Add Expense

POST https://open-api.zortout.com/v4/Finance/AddExpense

Add expense.

Query Parameters

Name	Type	Description
uniquenumber	String	Unique Number. This value is unique and used to prevent duplicate transaction.

Headers

Name	Type	Description
storename*	String	Store Name
apikey*	String	API Key
apisecret*	String	API Secret

Request Body

Name	Type	Description
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

Response

Parameter	Type	Description/Example
resCode	String	Response Code 200- Success
resDesc	String	Response Description
detail	Detail	Detail

Detail	Type	Description/Example
id	Int	Expense ID

Ex. Request JSON

{
  "expensedate": "2021-05-31",
  "amount": 58,
  "vatamount": 0,
  "paymentmethod": "Cash",
  "list": [
    {
      "name": "Income1",
      "categoryname": "Others",
      "totalprice": 48
    },
    {
      "name": "Income2",
      "totalprice": 10
    }
  ]
}

Update Expense Payment

POST https://open-api.zortout.com/v4/Finance/UpdateExpensePayment

Update payment of expense.

Query Parameters

Name	Type	Description
id*	Int	Expense ID
paymentdate	String	Payment Datetime Ex. “2021-09-15 21:05”
paymentamount*	Double	Payment Amount
paymentmethod*	String	Payment Method

Headers

Name	Type	Description
storename*	String	Store Name
apikey*	String	API Key
apisecret*	String	API Secret

Response

Parameter	Type	Description/Example
resCode	String	Response Code 200- Success
resDesc	String	Response Description

Get Money Transfers

GET https://open-api.zortout.com/v4/Finance/GetMoneyTransfers

Get list of money transfer.

Query Parameters

Name	Type	Description
dateafter	String	Date After ..... (yyyy-MM-dd)
page	Int	Page (Default = 1)
keyword	String	Keyword to search
createdatetimebefore	String	Created Datetime Before ..... (yyyy-MM-dd HH:mm)
createdatetimeafter	String	Created Datetime After ..... (yyyy-MM-dd HH:mm)
datebefore	String	Date Before ..... (yyyy-MM-dd)
limit	Int	Limit per page (Max = 500)

Headers

Name	Type	Description
storename*	String	Store Name
apikey*	String	API Key
apisecret*	String	API Secret
moneytransferidlist	String	List Of Money Transfer ID Ex. “123,124,125”

Response

Parameter	Type	Description/Example
res	Response	Response Code 200- Success
list	Money Transfer (Array)	Money Transfer List (Array)
count	Int	Total money transfer number by filter

Money Transfer (Array)	Type	Description/Example
id	Int	Money Transfer ID
status	String	Status (Success, Voided)
amount	Double	Amount
actiondate	Date	Date (yyyy-MM-dd)
actiondateString	String	Date Text (yyyy-MM-dd)
fromPaymentMethodId	Int	Payment Method ID for transferring money
fromPaymentMethodName	String	Payment Method Name for transferring money
toPaymentMethodId	Int	Payment Method ID for receiving money
toPaymentMethodName	String	Payment Method Name for receiving money
reference	String	Reference
description	String	Description
createdatetime	Datetime	Created Datetime
createdatetimeString	String	Created 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

Get Money Transfer Detail

GET https://open-api.zortout.com/v4/Finance/GetMoneyTransferDetail

Get money transfer detail.

Query Parameters

Name	Type	Description
id*	Int	Money Transfer ID

Headers

Name	Type	Description
storename*	String	Store Name
apikey*	String	API Key
apisecret*	String	API Secret

Response

Parameter	Type	Description/Example
res	Response	Response Code 200- Success
list	MoneyTransfer (Array)	Money Transfer List (Array)
count	Int	Total money transfer number by filter

MoneyTransfer (Array)	Type	Description/Example
id	Int	Money Transfer ID
status	String	Status (Success, Voided)
amount	Double	Amount
actiondate	Date	Date (yyyy-MM-dd)
actiondateString	String	Date Text (yyyy-MM-dd)
fromPaymentMethodId	Int	Payment Method ID for transferring money
fromPaymentMethodName	String	Payment Method Name for transferring money
toPaymentMethodId	Int	Payment Method ID for receiving money
toPaymentMethodName	String	Payment Method Name for receiving money
reference	String	Reference
description	String	Description
createdatetime	Datetime	Created Datetime
createdatetimeString	String	Created 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

Add Money Transfer.

POST https://open-api.zortout.com/v4/Finance/AddMoneyTransfer

Add money transfer.

Query Parameters

Name	Type	Description
uniquenumber	String	Unique Number. This value is unique and used to prevent duplicate transaction.

Headers

Name	Type	Description
storename*	String	Store Name
apikey*	String	API Key
apisecret*	String	API Secret

Response

Parameter	Type	Description/Example
resCode	String	Response Code 200- Success
resDesc	String	Response Description

Ex. Request JSON

{
    "fromPaymentMethodName": "Cash",
    "toPaymentMethodName": "Credit Card",
    "amount": 100,
    "reference": "Test Reference",
    "actiondate": "2023-08-07",
    "description": "Test Description"
}