> For the complete documentation index, see [llms.txt](https://developers-v3.zortout.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers-v3.zortout.com/api-reference/finance.md).
# Finance
## Get Incomes
`GET` `https://api.zortout.com/api.aspx`
Get list of incomes.
#### Query Parameters
| Name | Type | Description |
| ----------------------------------------- | ------ | ---------------------------------------------------------- |
| 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)
|
#### 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”
|
{% tabs %}
{% tab title="200: OK Success" %}
{% tabs %}
{% tab title="Response" %}
{% endtab %}
{% endtabs %}
{% endtab %}
{% endtabs %}
| 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)
|
| IncomeItem (Array) | Type | Description/Example |
| ------------------ | ------ | ------------------- |
| id | Int | Item ID |
| name | String | Item Name |
| categoryname | String | Item Category |
| totalprice | Double | Total Price |
| 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 |
| 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 |
| Parameter | Type | Description/Example |
| --------- | ------------------------- | ------------------------------------- |
| res | Response | Response Code
200- Success
|
| list | IncomeTransaction (Array) | Income Transaction List (Array) |
| count | Int | Total income number by filter |
## Get Income Detail
`GET` `https://api.zortout.com/api.aspx`
Get income detail.
#### Query Parameters
| Name | Type | Description |
| ----------------------------------------- | ------ | ------------------- |
| method\* | String | "GETINCOMEDETAIL" |
| format | String | json (Default), xml |
| version\* | String | 3 |
| id\* | Int | Income ID |
#### Headers
| Name | Type | Description |
| ------------------------------------------- | ------ | ----------- |
| storename\* | String | Store Name |
| apikey\* | String | API Key |
| apisecret\* | String | API Secret |
{% tabs %}
{% tab title="200: OK Success" %}
{% tabs %}
{% tab title="Response" %}
{% endtab %}
{% endtabs %}
{% endtab %}
{% endtabs %}
| 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)
|
| IncomeItem (Array) | Type | Description/Example |
| ------------------ | ------ | ------------------- |
| id | Int | Item ID |
| name | String | Item Name |
| categoryname | String | Item Category |
| totalprice | Double | Total Price |
| 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 |
| 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 |
## Add Income
`POST` `https://api.zortout.com/api.aspx`
Add income.
#### Query Parameters
| Name | Type | Description |
| ----------------------------------------- | ------ | ------------------------------------------------------------------------------------------- |
| 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.
|
#### 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 |
{% tabs %}
{% tab title="200: OK Success" %}
{% tabs %}
{% tab title="Response" %}
{% endtab %}
{% tab title="Ex. URL" %}
URL :
{% endtab %}
{% tab title="Ex. Request JSON" %}
```
{
"incomedate": "2021-05-31",
"amount": 58,
"vatamount": 0,
"paymentmethod": "Cash",
"list": [
{
"name": "Income1",
"categoryname": "Others",
"totalprice": 48
},
{
"name": "Income2",
"totalprice": 10
}
]
}
```
{% endtab %}
{% endtabs %}
{% endtab %}
{% endtabs %}
| Parameter | Type | Description/Example |
| --------- | ------ | ------------------------------------- |
| resCode | String | Response Code
200- Success
|
| resDesc | String | Response Description |
## Update Income Payment
`POST` `https://api.zortout.com/api.aspx`
Update payment of income.
#### Query Parameters
| Name | Type | 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 |
#### Headers
| Name | Type | Description |
| ------------------------------------------- | ------ | ----------- |
| storename\* | String | Store Name |
| apikey\* | String | API Key |
| apisecret\* | String | API Secret |
{% tabs %}
{% tab title="200: OK Success" %}
{% tabs %}
{% tab title="Response" %}
{% endtab %}
{% endtabs %}
{% endtab %}
{% endtabs %}
| Parameter | Type | Description/Example |
| --------- | ------ | ------------------------------------- |
| resCode | String | Response Code
200- Success
|
| resDesc | String | Response Description |
## Get Expenses
`GET` `https://api.zortout.com/api.aspx`
Get list of expenses.
#### Path Parameters
| Name | Type | Description |
| ------ | ------ | ------------------- |
| format | String | json (Default), xml |
#### Query Parameters
| Name | Type | Description |
| ----------------------------------------- | ------ | ---------------------------------------------------------- |
| 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 |
#### 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”
|
{% tabs %}
{% tab title="200: OK Success" %}
{% tabs %}
{% tab title="Response" %}
{% endtab %}
{% endtabs %}
{% endtab %}
{% endtabs %}
| 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)
|
| ExpenseItem (Array) | Type | Description/Example |
| ------------------- | ------ | ------------------- |
| id | Int | Item ID |
| name | String | Item Name |
| categoryname | String | Item Category |
| totalprice | Double | Total Price |
| 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 |
| 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 |
| Parameter | Type | Description/Example |
| --------- | -------------------------- | ------------------------------------- |
| res | Response | Response Code
200- Success
|
| list | ExpenseTransaction (Array) | Expense Transaction List (Array) |
| count | Int | Total expense number by filter |
## Get Expense Detail
`GET` `https://api.zortout.com/api.aspx`
Get expense detail.
#### Query Parameters
| Name | Type | Description |
| ----------------------------------------- | ------ | ------------------- |
| method\* | String | "GETEXPENSEDETAIL" |
| id\* | Int | Expense ID |
| version\* | String | 3 |
| format | String | json (Default), xml |
#### Headers
| Name | Type | Description |
| ------------------------------------------- | ------ | ----------- |
| storename\* | String | Store Name |
| apikey\* | String | API Key |
| apisecret\* | String | API Secret |
{% tabs %}
{% tab title="200: OK Success" %}
{% tabs %}
{% tab title="Response" %}
{% endtab %}
{% endtabs %}
{% endtab %}
{% endtabs %}
| 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)
|
| ExpenseItem (Array) | Type | Description/Example |
| ------------------- | ------ | ------------------- |
| id | Int | Item ID |
| name | String | Item Name |
| categoryname | String | Item Category |
| totalprice | Double | Total Price |
| 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 |
| 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 |
## Add Expense
`POST` `https://api.zortout.com/api.aspx`
Add expense.
#### Query Parameters
| Name | Type | Description |
| ----------------------------------------- | ------ | ------------------------------------------------------------------------------------------- |
| 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 |
#### 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 |
{% tabs %}
{% tab title="200: OK Success" %}
{% tabs %}
{% tab title="Response" %}
{% endtab %}
{% tab title="Ex. URL" %}
URL :
{% endtab %}
{% tab title="Ex. Request JSON" %}
```
{
"expensedate": "2021-05-31",
"amount": 58,
"vatamount": 0,
"paymentmethod": "Cash",
"list": [
{
"name": "Income1",
"categoryname": "Others",
"totalprice": 48
},
{
"name": "Income2",
"totalprice": 10
}
]
}
```
{% endtab %}
{% endtabs %}
{% endtab %}
{% endtabs %}
| Parameter | Type | Description/Example |
| --------- | ------ | ------------------------------------- |
| resCode | String | Response Code
200- Success
|
| resDesc | String | Response Description |
## Update Expense Payment
`POST` `https://api.zortout.com/api.aspx`
Update payment of expense.
#### Query Parameters
| Name | Type | 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 |
#### Headers
| Name | Type | Description |
| ------------------------------------------- | ------ | ----------- |
| storename\* | String | Store Name |
| apikey\* | String | API Key |
| apisecret\* | String | API Secret |
{% tabs %}
{% tab title="200: OK Success" %}
{% tabs %}
{% tab title="Response" %}
{% endtab %}
{% endtabs %}
{% endtab %}
{% endtabs %}
| Parameter | Type | Description/Example |
| --------- | ------ | ------------------------------------- |
| resCode | String | Response Code
200- Success
|
| resDesc | String | Response Description |