Get started
The Moon Invoice API Provides Online Billing Software for Small Business Owners.
To use this API, you need a secret_key and access_token.
Please contact us at support@mooninvoice.com to get your API secret_key or If you have any queries.
API Endpoint https://www.mooninvoice.com/
Get Access Token
To get Access Token, you need to make a POST call to the following URL:
https://www.mooninvoice.com/api_mi/public/get_auth_token
parameters for Get Access Token
required fields
| Field | Type | Description |
|---|---|---|
| String | Email of your Moon Invoice account. | |
| secret_key | String | Your Moon Invoice secret_key. |
Result example Get Access Token JSON Response: {
"status": "200",
"message": "Auth token generated successfully!",
"data": {
"token": "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOioPUzI1NiJ9.eyJhdWQiOiI0IiwianRpIjoiYTViMjdhOTdlZDIyNzNlZGJmNTE4ZTE4ODdhNGZkNDhjYTdhZmQ1NmFlOTU4NjdkODcwMDE2NjQ2YmQyZjBjNDliM2E5NzQxMWI1NjQ1MjciLCJpYXQiOjE2NjU3NTE3MTAsIm5iZiI6MTY2NTc1MTcxYUwiZXhwIjoxNjk3Mjg3NzEwLCJzdWIiOiI4NzU4OCIsInNjb3BlcyI6W119.NQtDWHUtKVsB2VLNpRmkf56xC-B10ghXvMou2JZhkXcDSFBmpxFb6YyeW94W1MpUgf3_Ua5nY0XmMd2-_L7UH4dNLLauAEHKOsD0HjuxR6mfUqEhTdGazkYw06HBE0v0ZpyzbTIE35VQmciDBqd2tLeGF1AVVs2IZO_wFPtegS8KYUxiPfbzLzk3IwMDxtknrcD3hCo96PCBUobnQAls2cYIXPIiGangNRlp5YhbK4RQlbahAIq3IXkBtWGy-STQvUG9qjT3ZzsSs6zZLrqdzOZcYpAnJinPtsg76sFDNN0EV3fNvVkTONMT5_kgqIpTPtrszxfpL103Vtq1pJq1KgJ3m63MQ_FcIiEqDkfTb09HbhSFRkST-q0wCKhG5yPlCdKQCZWqVdWfE1rWPhRVmVgicCY8PNQWSpgTr11YO1WS59FJNKUm3NB65GXtg6noxTpkmnFb_jdWNT-apka5Y9XoMZM8tvVfUWPhJr-_jN05IM4eCFMppyx1VQhbHEFJY4IHeJgxAgxvasLRm0lhor8hqHqdFNAFVEAU3pwKTUaYcXbHCdzdXL9Li65DfWfnkU04ORFUT5MJhBCoitiaBAG1apXRM5-rF2TdYPuwQR--31mA31xm2H-TwtmvKlPZGH5gsOEBz4IuUUym49UCs7XrM56WJYRHoboby7QqjNA"
}
}
Get Product
To Get Product, you need to make a GET call to the following URL:
https://www.mooninvoice.com/api_mi/public/product_list
parameters for GET Products
required fields
| Field | Type | Description |
|---|---|---|
| ProductSort | String | ProductSort is for sorting record by ascending or decending order wise record. ProductSort must be contain asc or desc value. |
| PageSize | Integer | PageSize is for size of per page record. |
| ProductSortColumn | String | ProductSortColumn is for sort record by specific Column of table. |
| CompanyID | String | CompanyId is for get record by specific Company. |
| ServiceType | Integer | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
optional fields
| Field | Type | Description |
|---|---|---|
| page | Integer | Enter page no. for get page wise records. |
Request Sample
Example GET Product JSON Request: {
"ProductSort": "ASC",
"PageSize": 25,
"page": 1,
"ProductSortColumn": "ProductName",
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"ServiceType": "1"
}
Response Sample
Result example GET Product JSON Response: {
"status": 200,
"message": "Data received.",
"data": {
"current_page": 1,
"first_page_url": "https://www.mooninvoice.com/api_mi/public/product_list?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "https://www.mooninvoice.com/api_mi/public/product_list?page=1",
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "https://www.mooninvoice.com/api_mi/public/product_list?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
],
"next_page_url": null,
"path": "https://www.mooninvoice.com/api_mi/public/product_list",
"per_page": 25,
"prev_page_url": null,
"to": 15,
"total": 15,
"products": [
{
"ProductID": "95D21F5C-3723-472F-BB3E-2FC09219989E",
"ProductBuyCost": "0.00",
"ProductQuantity": "1.00",
"ProductUnitCost": "1145.00",
"ProductName": "Apple iPhone 11 Pro (64GB) - Silver",
"ProductNotes": "5.8-inch (14.7 cm diagonal) Super Retina XDR OLED display.",
"ProductExtra1": "",
"ProductCategory": "",
"ProductCode": "",
"ProductStockManage": "",
"ProductExtra2": "",
"IsProductDelete": 0,
"ProductModificationDate": "2022-05-20 11:12:55",
"IsUsed": 1,
"Stock": -2,
"Currency": {
"CurrencyLocale": "en_US",
"Code": "USD",
"Symbol": "$"
},
"Category": {
"CategoryName": "",
"CategoryID": ""
}
},
{
"ProductID": "182BA686-499F-4B07-9040-83E3A6B23225",
"ProductBuyCost": "100.00",
"ProductQuantity": "2.00",
"ProductUnitCost": "160.00",
"ProductName": "Black Shirt",
"ProductNotes": "Black Shirt update test",
"ProductExtra1": "en_US",
"ProductCategory": "504F5CAD-640B-49CA-992E-EA90E3C943EF",
"ProductCode": "{\"ProductCode\":\"BSHIRT123\"}",
"ProductStockManage": "0",
"ProductExtra2": "",
"IsProductDelete": 0,
"ProductModificationDate": "2022-05-18 05:30:44",
"IsUsed": 1,
"Stock": -6,
"Currency": {
"CurrencyLocale": "en_US",
"Code": "USD",
"Symbol": "$"
},
"Category": {
"CategoryName": "Business & Industrial",
"CategoryID": "504F5CAD-640B-49CA-992E-EA90E3C943EF"
}
},
]
}
}
Create Product
To Create Product, you need to make a POST call to the following URL:
https://www.mooninvoice.com/api_mi/public/add_product
parameters for CREATE Products
required fields
| Field | Type | Description |
|---|---|---|
| CompanyID | String | CompanyId is for create product by specific Company. |
| ServiceType | Integer | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
| DeviceID | Float | DeviceID is an unique identifier of your device. |
| ProductName | String | Name of product. |
optional fields
| Field | Type | Description |
|---|---|---|
| ProductCode | String | SKU code of product. |
| ProductBuyCost | Float | Buy cost of product |
| ProductUnitCost | Float | Sell or Unit cost of product. |
| ProductType | String | Type of product like kg, piece, liter etc. |
| ProductQuantity | Float | Quantity of product. |
| ProductNotes | Text | Note or Description about product. |
| ProductCategory | String | Category of product. |
| ProductStockManage | Boolean | ProductStockManage is boolean value 0 or 1. If Stock manage then 1 otherwise 0. |
| ProductTaxable | Boolean | ProductTaxable is boolean value 0 or 1. If tax is apply on product then 1 otherwise 0. |
| ProductExtra1 | String | ProductExtra1 is about code of language like en_IN, en_US etc. |
| ProductLineToTax | Array | ProductLinetoTax is array of default tax identifier of product. Like ["95A1956E-E60A-4FAC-8EC4-C88EE7431280"]. |
| ProductOrder | Integer | ProductOrder is a serial number or order no. of products. |
| ProductLogo | File | Product logo is an image file of product. ProductLogo supported file types are png,jpeg,gif,jpg. |
Request Sample
Example CREATE Product JSON Request: {
"ProductName" : "New Game",
"ProductCode" : "NGB123",
"ProductBuyCost" : "157.56",
"ProductUnitCost" : "180.25",
"ProductType" : "kg",
"ProductQuantity" : 1,
"ProductNotes" : "Test",
"ProductCategory" : "wages",
"ProductStockManage" : 0,
"ProductTaxable" : 0,
"ProductExtra1" : "en_US",
"ProductLineToTax" : "",
"CompanyID" : "8D5D856F-E370-45EC-8128-11EB9802805D",
"ServiceType" : 1,
"DeviceID" : "1093193415.1644912014",
"ProductOrder" : "1",
"ProductExtra2" : "",
"ProductLogo" : "Image File Data"
}
Response Sample
Result example CREATE Product JSON Response: {
"status": 200,
"message": "Product Added.",
"data": {
"ProductData": {
"ProductID": "BC391212-4D36-413A-A458-1490AB75B37C",
"ProductBuyCost": "150.00",
"ProductQuantity": 1,
"ProductUnitCost": "180.00",
"ProductName": "Product 401",
"ProductNotes": "Testing Product 401",
"ProductExtra1": "en_US",
"ProductExtra2": "",
"ProductCategory": "Wages",
"ProductCode": "{\"itemCode\":\"RGB48\"}",
"ProductType": "kg",
"ProductLineToTax": "",
"ProductStockManage": "0",
"ProductTaxable": 0,
"ProductOrder": 1,
"Stock": 0,
"ProductCurrencySymbol": "$",
"Currency": {
"Code": "USD",
"Symbol": "$",
"CurrencyLocale": "en_US"
}
},
"ProductLogo": {
"ProductLogoID": "",
"ProductLogo": ""
}
}
}
Update Product
To Update Product, you need to make a PUT call to the following URL:
https://www.mooninvoice.com/api_mi/public/update_product
parameters for UPDATE Products
required fields
| Field | Type | Description |
|---|---|---|
| CompanyID | String | CompanyId is for update product by specific Company. |
| ServiceType | Integer | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
| DeviceID | Float | DeviceID is an unique identifier of your device. |
| ProductID | String | ProductID is a Product Identifier. |
| ProductName | String | Name of product. |
optional fields
| Field | Type | Description |
|---|---|---|
| ProductCode | String | SKU code of product. |
| ProductBuyCost | Float | Buy cost of product |
| ProductUnitCost | Float | Sell or Unit cost of product. |
| ProductType | String | Type of product like kg, piece, liter etc. |
| ProductQuantity | Float | Quantity of product. |
| ProductNotes | Text | Note or Description about product. |
| ProductCategory | String | Category of product. |
| ProductStockManage | Boolean | ProductStockManage is boolean value 0 or 1. If Stock manage then 1 otherwise 0. |
| ProductTaxable | Boolean | ProductTaxable is boolean value 0 or 1. If tax is apply on product then 1 otherwise 0. |
| ProductExtra1 | String | ProductExtra1 is about code of language like en_IN, en_US etc. |
| ProductLineToTax | Array | ProductLinetoTax is array of default tax identifier of product. Like ["95A1956E-E60A-4FAC-8EC4-C88EE7431280"]. |
| ProductOrder | Integer | ProductOrder is a serial number or order no. of products. |
| ProductLogo | File | ProductLogo is an image file of product. ProductLogo supported file types are png,jpeg,gif,jpg. |
| ProductLogoID | String | ProductLogoID is an identifier of product logo. |
Request Sample
Example UPDATE Product JSON Request: {
"ProductID" : "BC391212-4D36-413A-A458-1490AB75B37C",
"ProductName" : "New Game",
"ProductCode" : "NGB123",
"ProductBuyCost" : "157.56",
"ProductUnitCost" : "180.25",
"ProductType" : "kg",
"ProductQuantity" : 1,
"ProductNotes" : "Test",
"ProductCategory" : "wages",
"ProductStockManage" : 0,
"ProductTaxable" : 0,
"ProductExtra1" : "en_US",
"ProductLineToTax" : "",
"CompanyID" : "8D5D856F-E370-45EC-8128-11EB9802805D",
"ServiceType" : 1,
"DeviceID" : "1093193415.1644912014",
"ProductOrder" : "1",
"ProductExtra2" : "",
"ProductLogo" : "Image File Data",
"ProductLogoID" : "C47EB217-0867-4B09-816E-0A6716B4BAEF"
}
Response Sample
Result example UPDATE Product JSON Response: {
"status": 200,
"message": "Product updated.",
"data": {
"ProductData": {
"ProductID": "BC391212-4D36-413A-A458-1490AB75B37C",
"ProductBuyCost": "150.00",
"ProductQuantity": 1,
"ProductUnitCost": "180.00",
"ProductName": "Product Name is",
"ProductNotes": "Testing Product 401",
"ProductExtra1": "en_US",
"ProductExtra2": "",
"ProductCategory": "Wages",
"ProductCode": "{\"itemCode\":\"RGB48\"}",
"ProductType": "kg",
"ProductLineToTax": "",
"ProductStockManage": "0",
"ProductTaxable": 0,
"ProductOrder": 1,
"Stock": 0,
"ProductCurrencySymbol": "$",
"Currency": {
"Code": "USD",
"Symbol": "$",
"CurrencyLocale": "en_US"
}
},
"ProductLogo": {
"ProductLogoID": "",
"ProductLogo": ""
}
}
}
Details Product
To Get Product Details, you need to make a GET call to the following URL:
https://www.mooninvoice.com/api_mi/public/product_details
parameters for DETAILS Products
required fields
| Field | Type | Description |
|---|---|---|
| CompanyID | String | CompanyId is for get details of product of specific Company. |
| ServiceType | Integer | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
| ProductID | String | ProductID is a Product Identifier. |
Request Sample
Example DETAILS Product JSON Request: {
"ProductID": "FE87BE06-2FE5-4D47-BA14-53CEF577D3B2",
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"ServiceType": "1"
}
Response Sample
Result example DETAILS Product JSON Response: {
"status": 200,
"message": "Data Received.",
"data": {
"ProductData": {
"ProductID": "1A0699A7-E0C9-44B5-85B2-E73A3CF4DDD6",
"ProductBuyCost": "100.00",
"ProductQuantity": 1,
"ProductUnitCost": "150.00",
"ProductName": "Black Shirt 2",
"ProductNotes": "Balsk shirt desc update.",
"ProductExtra1": "en_US",
"ProductExtra2": "",
"ProductCategory": "Baby & Toddler",
"ProductCode": "{\"itemCode\":\"PROBLACK12\"}",
"ProductType": "",
"ProductLineToTax": "",
"ProductStockManage": "0",
"ProductTaxable": 0,
"ProductOrder": 0,
"Stock": 0,
"ProductCurrencySymbol": "$",
"Currency": {
"Code": "USD",
"Symbol": "$",
"CurrencyLocale": "en_US"
}
},
"ProductLogo": {
"ProductLogoID": "C47EB217-0867-4B09-816E-0A6716B4BAEF",
"ProductLogo": "https://mi-doc.s3.amazonaws.com/local/9561/imageinfo/C47EB217-0867-4B09-816E-0A6716B4BAEF.png?AWSAccessKeyId=AKIA43TXFBRTCBXKZYZ6&Expires=1653638814&Signature=fRs%2BYkexSRmKJo45U%2FyLJbrYc94%3D?r=420442"
}
}
}
Delete Product
To Delete Product, you need to make a DELETE call to the following URL:
https://www.mooninvoice.com/api_mi/public/delete_product
parameters for DELETE Products
required fields
| Field | Type | Description |
|---|---|---|
| CompanyID | String | CompanyId is for delete product of specific Company. |
| ServiceType | Integer | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
| ProductID | String | ProductID is a Product Identifier. |
| DeviceID | Float | DeviceID is an unique identifier of your device. |
Request Sample
Example DELETE Product JSON Request: {
"ProductID": "EE970937-E877-4AA1-A785-8A3B5AB209C4",
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"DeviceID": "1093193415.1644912014",
"ServiceType": "1"
}
Response Sample
Result example DELETE Product JSON Response: {
"status": 200,
"message": "1 product(s) deleted.",
"data": []
}
Get Contact
To Get Contact, you need to make a GET call to the following URL:
https://www.mooninvoice.com/api_mi/public/contact_list
parameters for GET Contact
required fields
| Field | Type | Description |
|---|---|---|
| CompanyID | String | CompanyId is for get record by specific Company. |
| ServiceType | Integer | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
| PageSize | Integer | PageSize is for size of per page record. |
| ContactSort | String | ContactSort is for sorting record by ascending or decending order wise record. ContactSort must be contain asc or desc value. |
optional fields
| Field | Type | Description |
|---|---|---|
| page | Integer | Enter page no. for get page wise records. |
Request Sample
Example GET Contact JSON Request: {
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"ServiceType": "1",
"PageSize": 25,
"page": 1,
"ContactSort": "desc"
}
Response Sample
Result example GET Contact JSON Response: {
"status": 200,
"message": "Data received.",
"data": {
"current_page": 1,
"first_page_url": "https://www.mooninvoice.com/api_mi/public/contact_list?page=1",
"from": 1,
"last_page": 2,
"last_page_url": "https://www.mooninvoice.com/api_mi/public/contact_list?page=2",
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "https://www.mooninvoice.com/api_mi/public/contact_list?page=1",
"label": "1",
"active": true
},
{
"url": "https://www.mooninvoice.com/api_mi/public/contact_list?page=2",
"label": "2",
"active": false
},
{
"url": "https://www.mooninvoice.com/api_mi/public/contact_list?page=2",
"label": "Next »",
"active": false
}
],
"next_page_url": "https://www.mooninvoice.com/api_mi/public/contact_list?page=2",
"path": "https://www.mooninvoice.com/api_mi/public/contact_list",
"per_page": 25,
"prev_page_url": null,
"to": 25,
"total": 26,
"contacts": [
{
"ContactID": "1132358E-402A-408E-BCE9-28A567E0E01F",
"FirstName": "My f Name",
"LastName": "My L Name",
"Status": "Cactive",
"Organization": "ZImZam",
"SelectedCurrency": "",
"MobileNo": "8745124578",
"Email": "testzim@yopmail.com",
"Name": "ZImZam"
},
{
"ContactID": "7068E024-5C0E-4A08-8FFD-3D898F71D1E4",
"FirstName": "Zack",
"LastName": "Leach",
"Status": "Cactive",
"Organization": "Zack And Company",
"SelectedCurrency": "en_US",
"MobileNo": "8876543210",
"Email": "zackstuart@email.com",
"Name": "Zack And Company"
},
]
}
}
Create Contact
To Create Contact, you need to make a POST call to the following URL:
https://www.mooninvoice.com/api_mi/public/add_contact
parameters for CREATE Contact
required fields
| Field | Type | Description |
|---|---|---|
| CompanyID | String | CompanyId is for create contact of specific Company. |
| ServiceType | Integer | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
| DeviceID | Float | DeviceID is an unique identifier of your device. |
| Organization | String | Name of Organization/Company. |
| FirstName | String | First Name of Contact. |
| LastName | String | Last Name of Contact. |
optional fields
| Field | Type | Description |
|---|---|---|
| VatNo | String | Vat No. of Contact. |
| String | Email of Contact person. | |
| MobileNo | Double | Mobile No. of Contact person. |
| BusinessNo | Double | Business Ph No. of Contact person. |
| HomeNo | Double | Home Ph No. of Contact person. |
| InternalNotes | Text | Internal Notes of Contact |
| HourlyRate | Float | Hourly Rate of Contact person. |
| SelectedCurrency | String | Selected Currency is code of local currency language. Like en_IN, en_US etc. |
| FaxNo | String | Fax No. |
| StatusCustomer | Boolean | StatusCustomer is a boolean value 0 and 1. If Contact is customer then 1 otherwise 0. |
| StatusVendor | Boolean | StatusVendor is a boolean value 0 and 1. If Contact is vendor then 1 otherwise 0. |
| BillingAddressStreet1 | String | Billing Address Street1 of Contact person. |
| BillingAddressStreet2 | String | Billing Address Street2 of Contact person. |
| BillingAddressZip | String | Billing Address Zip of Contact person. |
| BillingAddressCity | String | Billing Address City of Contact person. |
| BillingAddressState | String | Billing Address State of Contact person. |
| BillingAddressCountry | String | Billing Address Country of Contact person. |
| ShippingAddressStreet1 | String | Shipping Address Street1 of Contact person. |
| ShippingAddressStreet2 | String | Shipping Address Street2 of Contact person. |
| ShippingAddressZip | String | Shipping Address Zip of Contact person. |
| ShippingAddressCity | String | Shipping Address City of Contact person. |
| ShippingAddressState | String | Shipping Address State of Contact person. |
| ShippingAddressCountry | String | Shipping Address Country of Contact person. |
| ProductTax | Array | ProductTax is a default tax of contact person on product. It Contain array of tax title like ["GST18","GST12"]. |
| TaskTax | Array | TaskTax is a default tax of contact person on task. It Contain array of tax title like ["GST18","GST12"]. |
Request Sample
Example CREATE Contact JSON Request: {
"Organization": "Lonza",
"FirstName": "Tikus",
"LastName": "tamsa",
"VatNo": "457221444",
"Email": "tikutdsddamnjok@email.com",
"MobileNo": "9820151002",
"BusinessNo": "9679009581",
"HomeNo": "7510004505",
"InternalNotes": null,
"HourlyRate": "10",
"SelectedCurrency": "en_US",
"RegNo": "45611879",
"FaxNo": "455361230",
"StatusVendor": true,
"StatusCustomer": true,
"BillingAddressStreet1": "st123456",
"BillingAddressStreet2": "st218975",
"BillingAddressZip": "505005",
"BillingAddressCity": "BarodaA",
"BillingAddressState": "GUJARAT",
"BillingAddressCountry": "India",
"ShippingAddressStreet1": "st11789",
"ShippingAddressStreet2": "st22456",
"ShippingAddressZip": "505005",
"ShippingAddressCity": "ABDF",
"ShippingAddressState": "GUJARAT",
"ShippingAddressCountry": "India",
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"DeviceID": "1093193415.1644912014",
"ServiceType": "1",
"ProductTax": [
"NewGST18"
],
"TaskTax": [
"Default"
]
}
Response Sample
Result example CREATE Contact JSON Response: {
{
"status": 200,
"message": "Contact added.",
"data": {
"ContactID": "9E02CFA0-9E6C-4545-AAFC-94E87C0C0187",
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"BillingAddressCity": "BarodaA",
"BillingAddressCountry": "India",
"BillingAddressState": "GUJARATS",
"BillingAddressStreet1": "st123456",
"BillingAddressStreet2": "st218975",
"BillingAddressZip": "505005",
"BusinessNo": "812487123074",
"Email": "crshbsui@email.com",
"Extra1": "1",
"Extra2": "{\"TaxDic\":{\"Product\":[{\"Tax1\":\"NewGST18\"}],\"Task\":[{\"Tax1\":\"Default\"}]}}",
"HourlyRate": "10",
"FaxNo": "{ \"RegNo\":45611879, \"FaxNo\":455361230 }",
"FirstName": "Cridh",
"From": null,
"HomeNo": "88217744155",
"InteralNotes": "",
"LastName": "Stuart",
"MobileNo": "84565489105",
"Organization": "Crish COMsd",
"ShippingAddressCity": "ABDF",
"ShippingAddressCountry": "India",
"ShippingAddressState": "GUJARATd",
"ShippingAddressStreet1": "st11789",
"ShippingAddressStreet2": "st22456",
"ShippingAddressZip": "505005",
"SelectedCurrency": "en_US",
"Status": "active",
"DeviceID": "1093193415.1644912014",
"VatNo": "4561111444",
"CreatedDate": "2022-06-30 09:46:12",
"ModificationDate": "2022-06-30 09:46:12",
"CreatedAt": "2022-06-30T09:34:33.000000Z",
"UpdatedAt": "2022-06-30T09:34:33.000000Z",
"ServiceType": "1",
"Name": "Crish COMsd",
"CurrencySymbol": "$"
}
}
}
Update Contact
To Update Contact, you need to make a PUT call to the following URL:
https://www.mooninvoice.com/api_mi/public/update_contact
parameters for UPDATE Contact
required fields
| Field | Type | Description |
|---|---|---|
| CompanyID | String | CompanyId is for update contact of specific Company. |
| ServiceType | Integer | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
| DeviceID | Float | DeviceID is an unique identifier of your device. |
| ContactID | String | Contact Identifier. |
| Organization | String | Name of Organization/Company. |
| FirstName | String | First Name of Contact. |
| LastName | String | Last Name of Contact. |
optional fields
| Field | Type | Description |
|---|---|---|
| VatNo | String | Vat No. of Contact. |
| String | Email of Contact person. | |
| MobileNo | Double | Mobile No. of Contact person. |
| BusinessNo | Double | Business Ph No. of Contact person. |
| HomeNo | Double | Home Ph No. of Contact person. |
| InternalNotes | Text | Internal Notes of Contact |
| HourlyRate | Float | Hourly Rate of Contact person. |
| SelectedCurrency | String | Selected Currency is code of local currency language. Like en_IN, en_US etc. |
| FaxNo | String | Enter fax no. |
| StatusCustomer | Boolean | StatusCustomer is a boolean value 0 and 1. If Contact is customer then 1 otherwise 0. |
| StatusVendor | Boolean | StatusVendor is a boolean value 0 and 1. If Contact is vendor then 1 otherwise 0. |
| BillingAddressStreet1 | String | Billing Address Street1 of Contact person. |
| BillingAddressStreet2 | String | Billing Address Street2 of Contact person. |
| BillingAddressZip | String | Billing Address Zip of Contact person. |
| BillingAddressCity | String | Billing Address City of Contact person. |
| BillingAddressState | String | Billing Address State of Contact person. |
| BillingAddressCountry | String | Billing Address Country of Contact person. |
| ShippingAddressStreet1 | String | Shipping Address Street1 of Contact person. |
| ShippingAddressStreet2 | String | Shipping Address Street2 of Contact person. |
| ShippingAddressZip | String | Shipping Address Zip of Contact person. |
| ShippingAddressCity | String | Shipping Address City of Contact person. |
| ShippingAddressState | String | Shipping Address State of Contact person. |
| ShippingAddressCountry | String | Shipping Address Country of Contact person. |
| ProductTax | Array | ProductTax is a default tax of contact person on product. It Contain array of tax title like ["GST18","GST12"]. |
| TaskTax | Array | TaskTax is a default tax of contact person on task. It Contain array of tax title like ["GST18","GST12"]. |
Request Sample
Example UPDATE Contact JSON Request: {
"ContactID": "3FD25F74-651C-455C-B3C2-920BD332200B",
"Organization": "Likoz Rsoz update Again",
"FirstName": "Likoz update",
"LastName": "Roz",
"VatNo": "4561111444",
"Email": "likoz123@email.com",
"MobileNo": "8529637414",
"BusinessNo": "9517534865",
"HomeNo": "8426842686",
"InternalNotes": null,
"HourlyRate": "10",
"SelectedCurrency": "en_US",
"RegNo": "45611879",
"FaxNo": "455361230",
"StatusVendor": true,
"StatusCustomer": true,
"BillingAddressStreet1": "st123456",
"BillingAddressStreet2": "st218975",
"BillingAddressZip": "505005",
"BillingAddressCity": "Baroda",
"BillingAddressState": "GUJARAT",
"BillingAddressCountry": "India",
"ShippingAddressStreet1": "st11789",
"ShippingAddressStreet2": "st22456",
"ShippingAddressZip": "505005",
"ShippingAddressCity": "ABDF",
"ShippingAddressState": "GUJARAT",
"ShippingAddressCountry": "India",
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"DeviceID": "1093193415.1644912014",
"ServiceType": "1",
"ProductTax": [
"NewGST18"
],
"TaskTax": [
"Default"
]
}
Response Sample
Result example UPDATE Contact JSON Response: {
"status": 200,
"message": "Contact updated.",
"data": {
"ContactID": "9E02CFA0-9E6C-4545-AAFC-94E87C0C0187",
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"BillingAddressCity": "BarodaA",
"BillingAddressCountry": "India",
"BillingAddressState": "GUJARATS",
"BillingAddressStreet1": "st123456",
"BillingAddressStreet2": "st218975",
"BillingAddressZip": "505005",
"BusinessNo": "812487123074",
"Email": "crshbsui@email.com",
"Extra1": "1",
"Extra2": "{\"TaxDic\":{\"Product\":[{\"Tax1\":\"NewGST18\"}],\"Task\":[{\"Tax1\":\"Default\"}]}}",
"HourlyRate": "10",
"FaxNo": "{ \"RegNo\":45611879, \"FaxNo\":455361230 }",
"FirstName": "Cridh",
"From": null,
"HomeNo": "88217744155",
"InteralNotes": "",
"LastName": "Stuart",
"MobileNo": "84565489105",
"Organization": "Crish COMsd",
"ShippingAddressCity": "ABDF",
"ShippingAddressCountry": "India",
"ShippingAddressState": "GUJARATd",
"ShippingAddressStreet1": "st11789",
"ShippingAddressStreet2": "st22456",
"ShippingAddressZip": "505005",
"SelectedCurrency": "en_US",
"Status": "active",
"DeviceID": "1093193415.1644912014",
"VatNo": "4561111444",
"CreatedDate": "2022-06-30 09:46:12",
"ModificationDate": "2022-06-30 09:46:12",
"CreatedAt": "2022-06-30T09:34:33.000000Z",
"UpdatedAt": "2022-06-30T09:34:33.000000Z",
"ServiceType": "1",
"Name": "Crish COMsd",
"CurrencySymbol": "$"
}
}
Details Contact
To Get Contact Details, you need to make a GET call to the following URL:
https://www.mooninvoice.com/api_mi/public/contact_details
parameters for DETAILS Contact
required fields
| Field | Type | Description |
|---|---|---|
| CompanyID | String | CompanyId is for get details of contact of specific Company. |
| ServiceType | Integer | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
| ContactID | String | Contact Identifier. |
Request Sample
Example DETAILS Contact JSON Request: {
"ContactID": "9E02CFA0-9E6C-4545-AAFC-94E87C0C0187",
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"ServiceType": "1"
}
Response Sample
Result example DETAILS Contact JSON Response: {
{
"status": 200,
"message": "Data received.",
"data": {
"ContactID": "9E02CFA0-9E6C-4545-AAFC-94E87C0C0187",
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"BillingAddressCity": "BarodaA",
"BillingAddressCountry": "India",
"BillingAddressState": "GUJARATS",
"BillingAddressStreet1": "st123456",
"BillingAddressStreet2": "st218975",
"BillingAddressZip": "505005",
"BusinessNo": "812487123074",
"Email": "crshbsui@email.com",
"Extra1": "1",
"Extra2": "{\"TaxDic\":{\"Product\":[{\"Tax1\":\"NewGST18\"}],\"Task\":[{\"Tax1\":\"Default\"}]}}",
"HourlyRate": "10",
"FaxNo": "{ \"RegNo\":45611879, \"FaxNo\":455361230 }",
"FirstName": "Cridh",
"From": null,
"HomeNo": "88217744155",
"InteralNotes": "",
"LastName": "Stuart",
"MobileNo": "84565489105",
"Organization": "Crish COMsd",
"ShippingAddressCity": "ABDF",
"ShippingAddressCountry": "India",
"ShippingAddressState": "GUJARATd",
"ShippingAddressStreet1": "st11789",
"ShippingAddressStreet2": "st22456",
"ShippingAddressZip": "505005",
"SelectedCurrency": "en_US",
"Status": "active",
"DeviceID": "1093193415.1644912014",
"VatNo": "4561111444",
"CreatedDate": "2022-06-30 09:46:12",
"ModificationDate": "2022-06-30 09:46:12",
"CreatedAt": "2022-06-30T09:34:33.000000Z",
"UpdatedAt": "2022-06-30T09:34:33.000000Z",
"ServiceType": "1",
"Name": "Crish COMsd",
"CurrencySymbol": "$"
}
}
}
Delete Contact
To Delete Contact, you need to make a DELETE call to the following URL:
https://www.mooninvoice.com/api_mi/public/delete_contact
parameters for DELETE Contact
required fields
| Field | Type | Description |
|---|---|---|
| CompanyID | String | CompanyId is for delete contact of specific Company. |
| ServiceType | Integer | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
| DeviceID | Float | DeviceID is an unique identifier of your device. |
| ContactID | String | Contact Identifier. |
Request Sample
Example DETAILS Contact JSON Request: {
"ContactID": "BEB0B2B8-8410-45DF-A3FA-6010F04A2282",
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"DeviceID": "1093193415.1644912014",
"ServiceType": "1"
}
Response Sample
Result example DELETE Contact JSON Response: {
"status": 200,
"message": "1 contact(s) deleted.",
"data": []
}
Get Invoice
To Get Invoice, you need to make a GET call to the following URL:
https://www.mooninvoice.com/api_mi/public/invoice_list
parameters for GET Invoice
required fields
| Field | Type | Description |
|---|---|---|
| InvoiceSort | String | InvoiceSort is for sorting record by ascending or decending order wise record. InvoiceSort must be contain asc or desc value. |
| PageSize | Integer | PageSize is for size of per page record. |
| CompanyID | String | CompanyId is for get record by specific Company. |
| ServiceType | Integer | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
optional fields
| Field | Type | Description |
|---|---|---|
| page | Integer | Enter page no. for get page wise records. |
Request Sample
Example GET Invoice JSON Request: {
"InvoiceSort": "desc",
"page": 1,
"PageSize": 25,
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"ServiceType": "1"
}
Response Sample
Result example GET Invoice JSON Response: {
"status": 200,
"message": "Data received.",
"data": {
"current_page": 1,
"first_page_url": "https://www.mooninvoice.com/api_mi/public/invoice_list?page=1",
"from": 1,
"last_page": 2,
"last_page_url": "https://www.mooninvoice.com/api_mi/public/invoice_list?page=2",
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "https://www.mooninvoice.com/api_mi/public/invoice_list?page=1",
"label": "1",
"active": true
},
{
"url": "https://www.mooninvoice.com/api_mi/public/invoice_list?page=2",
"label": "2",
"active": false
},
{
"url": "https://www.mooninvoice.com/api_mi/public/invoice_list?page=2",
"label": "Next »",
"active": false
}
],
"next_page_url": "https://www.mooninvoice.com/api_mi/public/invoice_list?page=2",
"path": "https://www.mooninvoice.com/api_mi/public/invoice_list",
"per_page": 25,
"prev_page_url": null,
"to": 25,
"total": 36,
"invoices": [
{
"InvoiceID": "C7599CEA-A9E1-49CB-B202-C2B65725205E",
"InvoiceEntryDate": "2022-06-22 12:45:36",
"SelectedCurrency": "en_US",
"CreatedAt": "2022-06-22T12:46:21.000000Z",
"InvoiceStatus": "Draft",
"Status": "active",
"IsInvoiceDelete": 0,
"InvoiceTotal": "1351.1000",
"Invoiceterms": "x",
"InvoiceHeader": "xss",
"InvoiceOrganization": "aaa",
"FirstName": "pp",
"LastName": "pp",
"InvoiceId": 0,
"InvoiceNotes": "w",
"InvoiceNumber": "49",
"InvoiceRecurring": 0,
"InvoiceSubTotal": "1145.0000",
"InvoiceAmountPaid": "0.0000",
"InvoiceToRecurringInvoice": "",
"IsPaypalPayment": 0,
"InvoiceFolder": "{\"payment_str\":\"cash\",\"isroundoff\":\"0\",\"rounded_amount\":\"0\",\"Billing\":\"0\",\"Billing_Add\":{\"Street1\":\"\",\"Street2\":\"\",\"City\":\"\",\"State\":\"\",\"Country\":\"\",\"Zip\":\"\"},\"Secondary\":\"0\",\"Secondary_Add\":{\"Street1\":\"\",\"Street2\":\"\",\"City\":\"\",\"State\":\"\",\"Country\":\"\",\"Zip\":\"\"},\"Percentage\":\"0\",\"depositeAmount\":\"0.00\"}",
"ContactID": "0B505706-B5F2-435B-B2AF-7DD81B89893C",
"PaypalEmail": "",
"AmountDue": "1351.1000",
"InvoiceDueDate": "2022-06-22 12:45:36",
"CompanyName": "Web64 Test",
"TotalDueAmount": "1351.1000",
"TotalPaidAmount": "0.0000",
"ContactName": "aaa",
"CustomerEmail": "pp@yopmail.com",
"Currency": {
"CurrencyLocale": "en_US",
"Code": "INR",
"Symbol": "₹"
}
},
{
"InvoiceID": "875C970F-1747-4637-A15A-FA5BFA65CDA6",
"InvoiceEntryDate": "2022-05-18 12:40:27",
"SelectedCurrency": "en_US",
"CreatedAt": "2022-06-24T10:29:43.000000Z",
"InvoiceStatus": "Draft",
"Status": "active",
"IsInvoiceDelete": 0,
"InvoiceTotal": "356.8000",
"Invoiceterms": "",
"InvoiceHeader": "Invoice to Frank",
"InvoiceOrganization": "aaa",
"FirstName": "pp",
"LastName": "pp",
"InvoiceId": 0,
"InvoiceNotes": "",
"InvoiceNumber": "106",
"InvoiceRecurring": 0,
"InvoiceSubTotal": "313.8000",
"InvoiceAmountPaid": "0.0000",
"InvoiceToRecurringInvoice": "",
"IsPaypalPayment": 0,
"InvoiceFolder": "{\"payment_str\":\"cash\",\"isroundoff\":{\"Zip\":\"\"},\"rounded_amount\":\"\",\"Billing\":\"0\",\"Billing_Add\":{\"Street1\":\"\",\"Street2\":\"\",\"City\":\"\",\"State\":\"\",\"Country\":\"\"},\"Secondary\":\"0\",\"Secondary_Add\":{\"Street1\":\"\",\"Street2\":\"\",\"City\":\"\",\"State\":\"\",\"Country\":\"\",\"Zip\":\"\"},\"Percentage\":\"0\",\"depositeAmount\":\"0.00\"}",
"ContactID": "0B505706-B5F2-435B-B2AF-7DD81B89893C",
"PaypalEmail": "",
"AmountDue": "356.8000",
"InvoiceDueDate": "2022-05-18 12:40:27",
"CompanyName": "Web64 Test",
"TotalDueAmount": "356.8000",
"TotalPaidAmount": "0.0000",
"ContactName": "aaa",
"CustomerEmail": "pp@yopmail.com",
"Currency": {
"CurrencyLocale": "en_US",
"Code": "INR",
"Symbol": "₹"
}
}
]
}
}
Create Invoice
To Create Invoice, you need to make a POST call to the following URL:
https://www.mooninvoice.com/api_mi/public/create_invoice
parameters for CREATE Invoice
required fields
| Field | Type | Description |
|---|---|---|
| CompanyID | String | CompanyId is for create invoice of specific Company. |
| ContactID | String | Contact Identifier of Invoice. |
| InvoiceNumber | String | Invoice Number. |
| EntryDate | DateTime | Entry Date of Invoice. |
| DueDate | DateTime | Payment Due Date of Invoice. |
optional fields
| Field | Type | Description |
|---|---|---|
| InvoiceHeader | String | Title or Header of Invoice. |
| ShippingCost | Float | Shipping Cost of Invoice. |
| ShippingMethod | String | Shipping Method of Invoice. |
| InvoicePoNo | String | PO No of Invoice. |
| DiscountDec | Float | Discont on invoice total. |
| InvoiceTerms | String | Terms of Invoice. |
| InvoiceNotes | String | Notes/Description of Invoice. |
| IsRecurring | Boolean | IsRecurring is a boolean value 0 or 1. If Invoice is recurring then 1 otherwise 0. |
| RecurringEndDate | DateTime | End Date of Invoice recurring. |
| RecurringIntervalInDay | Integer | No of Days for invoice recurring. |
| RecurringIntervalInString | String | Invoice recurring period. Like Daily, Weekly, Fortnightly, Monthly, BiMonthly, Quarterly, 6-Months, Annually, 2-Years |
| TotalAmount | Float | Total Amount of Invoice. |
| SubTotal | Float | Sub Total Amount of Invoice. |
| AmountDue | Float | Remaining Payment Amount of Invoice. |
| IsPaypalPayment | Boolean | IsPaypalPayment is contain boolean value 0 or 1. |
| AmountPaid | Float | Total Paid Amount of Invoice. |
| DeviceID | String | DeviceID is an unique identifier of your device. |
| SelectedCurrency | String | Selected Currency is code of local currency language. Like en_IN, en_US etc. |
| AttachmentFile | File | Invoice Attachment File. |
| PaypalEmail | String | Paypal Email of Invoice. |
| ServiceType | String | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
| TimeZone | String | TimeZone of contact person for Invoice. |
| InvoiceFolder | Array | Invoice Folder is array and contain below fields. |
isroundoff |
Boolean | isroundoff is a contain boolean value 1 and 0. isroundoff is a rounded amount of invoice. |
rounded_amount |
Float | Rounded amount of Invoice. |
Percentage |
Float | Discount Percentage from total amount of invoice. |
depositeAmount |
Float | Deposite Amount of Invoice. |
Billing_Add |
Array | Billing_Add is array and contain below fields. |
Street1 |
String | Billing Address Street1. |
Street2 |
String | Billing Address Street2 |
City |
String | Billing Address City |
State |
String | Billing Address State |
Country |
String | Billing Address Country |
Zip |
String | Billing Address Zip |
Secondary_Add |
Array | Secondary_Add is array and contain below fields. |
Street1 |
String | Shipping Address Street1. |
Street2 |
String | Shipping Address Street2 |
City |
String | Shipping Address City |
State |
String | Shipping Address State |
Country |
String | Shipping Address Country |
Zip |
String | Shipping Address Zip |
| ProductData | Array | Product Data is a contain array of all product of invoice. ProductData contain multidimensional array. |
ProductName |
String | Name of Product. |
Quantity |
Integer | Quantity of Product. |
UnitCost |
Float | Selling price of Product. |
ProductNotes |
String | Product Notes. |
ProductID |
String | Product Identifier. |
Total |
String | Total Amount of Product. |
SubAmount |
String | SubAmount of Product. |
DiscountIsPercentage |
Boolean | Discount on product is in percetage or not. If in percentage then 1 otherwise 0. |
ProductType |
String | ProductType is contain type like kg, piece etc. |
DiscountValue |
String | Discount amount. |
TaxUpdate |
Boolean | TaxUpdate is a contain boolean value. If Tax Update then 1 otherwise 0. |
StockUpdate |
Boolean | StockUpdate is a contain boolean value. If Tax Update then 1 otherwise 0. |
TaxID |
Array | Array of Tax ID which is apply on product. Like ["95A1956E-E60A-4FAC-8EC4-C88EE7431280"] |
ItemlineToTaxList |
Array | ItemlineToTaxList is multidimensional array and contain all tax data which are applied on product. |
ItemlineToTaxListID |
String | Identifier of TAX. |
PercentageDec |
Float | Tax percentage of product. |
Name |
String | Name of Tax. |
| TaskData | Array | Task Data is a contain array of all task of invoice. TaskData contain multidimensional array. |
TaskName |
String | Name of Task. |
Hours |
Float | Total hours of task for invoice. |
TaskRate |
Float | Rate of task. |
TimeNotes |
String | Task Notes. |
TaskID |
String | Task Identifier. |
Total |
Float | Total amount of task. |
DiscountIsPercentage |
Boolean | Discount on task is in percetage or not. If in percentage then 1 otherwise 0. |
TaskType |
String | Type of task. |
DiscountValue |
String | Dicount value on task in percentage. Like 1P, 2P etc. |
TaxID |
Array | Array of Tax ID which is apply on tax. Like ["95A1956E-E60A-4FAC-8EC4-C88EE7431280"] |
TasklineToTax |
Array | TasklineToTax contains a tax details array with the below fields. |
TasklineToTaxID |
String | TaxID of task tax. |
PercentageDec |
Float | Tax percentage of task. |
Name |
String | Name of tax. |
Request Sample
Example CREATE Invoice JSON Request: {
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"InvoiceNumber": "103",
"InvoiceHeader": "New Tev",
"ShippingCost": 10,
"ShippingMethod": "Standard Ground",
"PoNo": "7454",
"DiscountDec": "0.00",
"Terms": "Test",
"Notes": "Notes Test",
"EntryDate": "2022-5-18 18:10:27",
"DueDate": "2022-5-18 18:10:27",
"IsRecurring": 0,
"RecurringEnddate": "0000-00-00",
"RecurringIntervalInDay": 0,
"RecurringIntervalInString": "",
"TotalAmount": 356.8,
"SubTotal": 313.8,
"AmountDue": 356.8,
"IsPaypalPayment": 0,
"AmountPaid": 0,
"InvoiceFolder": {
"isroundoff": 0,
"rounded_amount": 0,
"Billing": "0",
"Billing_Add": {
"Street1": "Near GH Road",
"Street2":101, partmentt",
"City": "Sydney",
"State": "Sydeny",
"Country": "Australia",
"Zip": "360005"
},
"Secondary": "0",
"Secondary_Add": {
"Street1": "",
"Street2": "",
"City": "",
"State": "",
"Country": "",
"Zip": ""
},
"Percentage": "0",
"depositeAmount": "0.00"
},
"DeviceID": "1093193415.1644912014",
"ContactID": "0B505706-B5F2-435B-B2AF-7DD81B89893C",
"SelectedCurrency": "en_IN",
"PaypalEmail": "",
"AttachmentFile": {},
"AttachmentType": "",
"ProductData": [
{
"ProductName": "Black Shirt",
"Quantity": 2,
"UnitCost": "160.00",
"ProductNotes": "Black Shirt update test",
"ProductID": "",
"Total": 304,
"SubAmount": 304,
"DiscountIsPercentage": "1",
"ProductType": "",
"DiscountValue": "5P",
"StockUpdate": 1,
"ItemlineToTaxList": [
{
"ItemlineToTaxListID": "95A1956E-E60A-4FAC-8EC4-C88EE7431280",
"PercentageDec": "10.0000",
"Name": "Default"
}
],
"TaxID": [
"95A1956E-E60A-4FAC-8EC4-C88EE7431280"
],
"orderindex": 1
}
],
"TaskData": [
{
"TaskName": "Task1",
"Hours": "1.00",
"TaskRate": "10.00",
"TimeNotes": "",
"TaskID": "",
"Total": 9.8,
"DiscountIsPercentage": "1",
"DiscountValue": "2P",
"TasklineToTax": [
{
"TasklineToTaxID": "95A1956E-E60A-4FAC-8EC4-C88EE7431280",
"PercentageDec": "10.0000",
"Name": "Default"
}
],
"TaxID": [
"95A1956E-E60A-4FAC-8EC4-C88EE7431280"
],
"TaskType": "Hours",
"orderindex": 2
}
],
"UsedTax": [],
"ServiceType": "1",
"TimeZone": "Asia/Calcutta"
}
Response Sample
Result example CREATE Invoice JSON Response: {
{
"status": 200,
"message": "Invoice added.",
"data": {
"IsPaypalPayment": 0,
"IsRecurring": 0,
"RecurringIntervalInDay": "0",
"InvoiceToExpense": "",
"InvoiceToImageInfo": "",
"InvoiceToRecurringExpense": "",
"InvoiceToItemline": "",
"invoiceToPayment": "",
"ContactID": "0B505706-B5F2-435B-B2AF-7DD81B89893C",
"ExpenseID": "",
"InvoiceToUsedtax": "",
"InvoiceToRecurringInvoice": "",
"InvoiceToTablelist": null,
"InvoiceDueDate": "2022-05-18 12:40:27",
"InvoiceEntryDate": "2022-05-18 12:40:27",
"ModificationDate": "2022-06-24 10:29:40",
"RecurringEndDate": "0000-00-00 00:00:00",
"AmountDue": 356.8,
"AmountPaid": 0,
"DiscountDec": 0,
"ShippingCost": 5,
"SubTotal": 313.8,
"Total": 356.8,
"Discount": "A|N",
"DiscountValue": "",
"Extra1": "",
"Extra2": "",
"Extra3": "",
"InvoiceFolder": "{\"payment_str\":\"cash\",\"isroundoff\":{\"Zip\":\"\"},\"rounded_amount\":\"\",\"Billing\":\"0\",\"Billing_Add\":{\"Street1\":\"\",\"Street2\":\"\",\"City\":\"\",\"State\":\"\",\"Country\":\"\"},\"Secondary\":\"0\",\"Secondary_Add\":{\"Street1\":\"\",\"Street2\":\"\",\"City\":\"\",\"State\":\"\",\"Country\":\"\",\"Zip\":\"\"},\"Percentage\":\"0\",\"depositeAmount\":\"0.00\"}",
"InvoiceHeader": "Invoice to Frank",
"InvoiceStatus": "Draft",
"InvoiceNotes": "",
"InvoiceNumber": "106",
"InvoicePoNo": "",
"RecurringIntervalInString": "",
"SelectedCurrency": "en_IN",
"SelectedTemplate": "",
"ShippingMethod": "Standard Ground",
"ArchiveStatus": 0,
"Status": "active",
"SyncID": "",
"TaxValue": "",
"InvoiceTerms": "",
"InvoiceID": "875C970F-1747-4637-A15A-FA5BFA65CDA6",
"DeviceID": "1093193415.1644912014",
"CreatedDate": "2022-06-24 10:29:43",
"SyncDate": "",
"IsInvoiceDelete": 0,
"CreatedAt": "2022-06-24T10:29:43.000000Z",
"UpdatedAt": "2022-06-24T10:29:43.000000Z",
"ServiceType": "1",
"Type": 0,
"PaymentTypes": "",
"Extra4": "",
"Extra5": "",
"Extra6": "",
"UsedDiscountInfo": [],
"CustomerEmail": "pp@yopmail.com",
"CompanyId": "8D5D856F-E370-45CC-8128-11EB9801805D",
"IsCreditNote": 0,
"PaynowLink": "",
"DueDateFormat": "May 18, 2022",
"EntryDateFormat": "May 18, 2022",
"OutStanding": [
{
"symbol": "$",
"code": "USD",
"currencylocale": "en_US",
"amount": 0,
"amount_f": "$0.00"
}
],
"ContactName": "aaa",
"ContactFirstLastname": "pp pp",
"NextRecurring": 0,
"RecurringDay": "",
"RecurringDate": "",
"PaypalEmail": "",
"EmailFontName": "Arial",
"EmailFontSize": 12,
"Attachment": "https://mi-doc.s3.amazonaws.com/local/9561/imageinfo/F4D717A8-0444-42CC-A6A5-2DFB02EC6AD4.png?AWSAccessKeyId=AKIA43TXFBRTCBXKZYZ6&Expires=1656067784&Signature=kDzmj6%2FmRv5H3b%2BqY73jls9Drh0%3D",
"Products": [
{
"ProductID": "182BA686-499F-4B07-9040-83E3A6B23225",
"InvoiceProductID": "23FEEE2C-F68C-468D-B08A-E22ACB764147",
"ProductName": "Black Shirt",
"ModificationDate": "2022-06-24 10:29:43",
"Quantity": 2,
"Total": 304,
"UnitCost": 160,
"DiscountIsPercentage": 1,
"DiscountValue": "5",
"ProductNotes": "Black Shirt update test",
"ProductImage": "",
"TaxID": "95A1956E-E60A-4FAC-8EC4-C88EE7431280"
}
],
"Tasks": [
{
"TaskID": "2908192A-85C7-49D8-A18F-502782EC2EAE",
"InvoiceTaskID": "72A3C787-2418-4E8D-B280-0B81E6B618E7",
"taskName": "Task1",
"ModificationDate": "2022-06-24 10:29:43",
"Hours": 1,
"Total": 9.8,
"Rate": 10,
"DiscountIsPercentage": 1,
"DiscountValue": "2",
"TaskNotes": "",
"TaxID": "95A1956E-E60A-4FAC-8EC4-C88EE7431280"
}
]
}
}
}
Update Invoice
To Update Invoice, you need to make a PUT call to the following URL:
https://www.mooninvoice.com/api_mi/public/update_invoice
parameters for UPDATE Invoice
required fields
| Field | Type | Description |
|---|---|---|
| InvoiceID | String | Invoice Identifier. |
| CompanyID | String | CompanyId is for create invoice of specific Company. |
| ContactID | String | Contact Identifier of Invoice. |
| InvoiceNumber | String | Invoice Number. |
| EntryDate | DateTime | Entry Date of Invoice. |
| DueDate | DateTime | Payment Due Date of Invoice. |
optional fields
| Field | Type | Description |
|---|---|---|
| InvoiceHeader | String | Title or Header of Invoice. |
| ShippingCost | Float | Shipping Cost of Invoice. |
| ShippingMethod | String | Shipping Method of Invoice. |
| InvoicePoNo | String | PO No of Invoice. |
| DiscountDec | Float | Discont on invoice total. |
| InvoiceTerms | String | Terms of Invoice. |
| InvoiceNotes | String | Notes/Description of Invoice. |
| IsRecurring | Boolean | IsRecurring is a boolean value 0 or 1. If Invoice is recurring then 1 otherwise 0. |
| RecurringEndDate | DateTime | End Date of Invoice recurring. |
| RecurringIntervalInDay | Integer | No of Days for invoice recurring. |
| RecurringIntervalInString | String | Invoice recurring period. Like Daily, Weekly, Fortnightly, Monthly, BiMonthly, Quarterly, 6-Months, Annually, 2-Years |
| TotalAmount | Float | Total Amount of Invoice. |
| SubTotal | Float | Sub Total Amount of Invoice. |
| AmountDue | Float | Remaining Payment Amount of Invoice. |
| IsPaypalPayment | Boolean | IsPaypalPayment is contain boolean value 0 or 1. |
| AmountPaid | Float | Total Paid Amount of Invoice. |
| DeviceID | String | DeviceID is an unique identifier of your device. |
| SelectedCurrency | String | Selected Currency is code of local currency language. Like en_IN, en_US etc. |
| AttachmentFile | File | Invoice Attachment File. |
| PaypalEmail | String | Paypal Email of Invoice. |
| ServiceType | String | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
| TimeZone | String | TimeZone of contact person for Invoice. |
| InvoiceFolder | Array | Invoice Folder is array and contain below fields. |
isroundoff |
Boolean | isroundoff is a contain boolean value 1 and 0. isroundoff is a rounded amount of invoice. |
rounded_amount |
Float | Rounded amount of Invoice. |
Percentage |
Float | Discount Percentage from total amount of invoice. |
depositeAmount |
Float | Deposite Amount of Invoice. |
Billing_Add |
Array | Billing_Add is array and contain below fields. |
Street1 |
String | Billing Address Street1. |
Street2 |
String | Billing Address Street2 |
City |
String | Billing Address City |
State |
String | Billing Address State |
Country |
String | Billing Address Country |
Zip |
String | Billing Address Zip |
Secondary_Add |
Array | Secondary_Add is array and contain below fields. |
Street1 |
String | Shipping Address Street1. |
Street2 |
String | Shipping Address Street2 |
City |
String | Shipping Address City |
State |
String | Shipping Address State |
Country |
String | Shipping Address Country |
Zip |
String | Shipping Address Zip |
| ProductData | Array | Product Data is a contain array of all product of invoice. ProductData contain multidimensional array. |
ProductName |
String | Name of Product. |
Quantity |
Integer | Quantity of Product. |
UnitCost |
Float | Selling price of Product. |
ProductNotes |
String | Product Notes. |
ProductID |
String | Product Identifier. |
Total |
String | Total Amount of Product. |
SubAmount |
String | SubAmount of Product. |
DiscountIsPercentage |
Boolean | Discount on product is in percetage or not. If in percentage then 1 otherwise 0. |
ProductType |
String | Type of product like kg, piece, liter etc. |
DiscountValue |
String | Discount amount. |
TaxUpdate |
Boolean | TaxUpdate is a contain boolean value. If Tax Update then 1 otherwise 0. |
StockUpdate |
Boolean | StockUpdate is a contain boolean value. If Tax Update then 1 otherwise 0. |
TaxID |
Array | Array of Tax ID which is apply on product. Like ["95A1956E-E60A-4FAC-8EC4-C88EE7431280"] |
ItemlineToTaxList |
Array | ItemlineToTaxList is multidimensional array and contain all tax data which are applied on product. |
ItemlineToTaxListID |
String | Identifier of TAX. |
PercentageDec |
Float | Tax percentage of product. |
Name |
String | Name of Tax. |
| TaskData | Array | Task Data is a contain array of all task of invoice. TaskData contain multidimensional array. |
TaskName |
String | Name of Task. |
Hours |
Float | Total hours of task for invoice. |
TaskRate |
Float | Rate of task. |
TimeNotes |
String | Task Notes. |
TaskID |
String | Task Identifier. |
Total |
Float | Total amount of task. |
DiscountIsPercentage |
Boolean | Discount on task is in percetage or not. If in percentage then 1 otherwise 0. |
TaskType |
String | Type of task. |
DiscountValue |
String | Dicount value on task in percentage. Like 1P, 2P etc. |
TaxID |
Array | Array of Tax ID which is apply on tax. Like ["95A1956E-E60A-4FAC-8EC4-C88EE7431280"] |
TasklineToTax |
Array | TasklineToTax contains a tax details array with the below fields. |
TasklineToTaxID |
String | TaxID of task tax. |
PercentageDec |
Float | Tax percentage of task. |
Name |
String | Name of tax. |
Request Sample
Example Update Invoice JSON Request: {
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"InvoiceID": "3EEED566-07F3-4964-8C15-E7762706B756",
"InvoiceNumber": "103",
"InvoiceHeader": "New Tev",
"ShippingCost": 10,
"ShippingMethod": "Standard Ground",
"PoNo": "7454",
"DiscountDec": "0.00",
"Terms": "Test",
"Notes": "Notes Test",
"EntryDate": "2022-5-18 18:10:27",
"DueDate": "2022-5-18 18:10:27",
"IsRecurring": 0,
"RecurringEnddate": "0000-00-00",
"RecurringIntervalInDay": 0,
"RecurringIntervalInString": "",
"TotalAmount": 356.8,
"SubTotal": 313.8,
"AmountDue": 356.8,
"IsPaypalPayment": 0,
"AmountPaid": 0,
"InvoiceFolder": {
"isroundoff": 0,
"rounded_amount": 0,
"Billing": "0",
"Billing_Add": {
"Street1": "Near GH Road",
"Street2":101, partmentt",
"City": "Sydney",
"State": "Sydeny",
"Country": "Australia",
"Zip": "360005"
},
"Secondary": "0",
"Secondary_Add": {
"Street1": "",
"Street2": "",
"City": "",
"State": "",
"Country": "",
"Zip": ""
},
"Percentage": "0",
"depositeAmount": "0.00"
},
"DeviceID": "1093193415.1644912014",
"ContactID": "0B505706-B5F2-435B-B2AF-7DD81B89893C",
"SelectedCurrency": "en_IN",
"PaypalEmail": "",
"AttachmentFile": {},
"AttachmentType": "",
"ProductData": [
{
"ProductName": "Black Shirt",
"Quantity": 2,
"UnitCost": "160.00",
"ProductNotes": "Black Shirt update test",
"ProductID": "",
"Total": 304,
"SubAmount": 304,
"DiscountIsPercentage": "1",
"ProductType": "",
"DiscountValue": "5P",
"StockUpdate": 1,
"ItemlineToTaxList": [
{
"ItemlineToTaxListID": "95A1956E-E60A-4FAC-8EC4-C88EE7431280",
"PercentageDec": "10.0000",
"Name": "Default"
}
],
"TaxID": [
"95A1956E-E60A-4FAC-8EC4-C88EE7431280"
],
"orderindex": 1
}
],
"TaskData": [
{
"TaskName": "Task1",
"Hours": "1.00",
"TaskRate": "10.00",
"TimeNotes": "",
"TaskID": "",
"Total": 9.8,
"DiscountIsPercentage": "1",
"DiscountValue": "2P",
"TasklineToTax": [
{
"TasklineToTaxID": "95A1956E-E60A-4FAC-8EC4-C88EE7431280",
"PercentageDec": "10.0000",
"Name": "Default"
}
],
"TaxID": [
"95A1956E-E60A-4FAC-8EC4-C88EE7431280"
],
"TaskType": "Hours",
"orderindex": 2
}
],
"UsedTax": [],
"ServiceType": "1",
"TimeZone": "Asia/Calcutta"
}
Response Sample
Result example UPDATE Invoice JSON Response: {
{
"status": 200,
"message": "Invoice updated.",
"data": {
"IsPaypalPayment": 0,
"IsRecurring": 0,
"RecurringIntervalInDay": "0",
"InvoiceToExpense": "",
"InvoiceToImageInfo": "",
"InvoiceToRecurringExpense": "",
"InvoiceToItemline": "",
"invoiceToPayment": "",
"ContactID": "0B505706-B5F2-435B-B2AF-7DD81B89893C",
"ExpenseID": "",
"InvoiceToUsedtax": "",
"InvoiceToRecurringInvoice": "",
"InvoiceToTablelist": null,
"InvoiceDueDate": "2022-05-18 12:40:27",
"InvoiceEntryDate": "2022-05-18 12:40:27",
"ModificationDate": "2022-06-24 10:29:40",
"RecurringEndDate": "0000-00-00 00:00:00",
"AmountDue": 356.8,
"AmountPaid": 0,
"DiscountDec": 0,
"ShippingCost": 5,
"SubTotal": 313.8,
"Total": 356.8,
"Discount": "A|N",
"DiscountValue": "",
"Extra1": "",
"Extra2": "",
"Extra3": "",
"InvoiceFolder": "{\"payment_str\":\"cash\",\"isroundoff\":{\"Zip\":\"\"},\"rounded_amount\":\"\",\"Billing\":\"0\",\"Billing_Add\":{\"Street1\":\"\",\"Street2\":\"\",\"City\":\"\",\"State\":\"\",\"Country\":\"\"},\"Secondary\":\"0\",\"Secondary_Add\":{\"Street1\":\"\",\"Street2\":\"\",\"City\":\"\",\"State\":\"\",\"Country\":\"\",\"Zip\":\"\"},\"Percentage\":\"0\",\"depositeAmount\":\"0.00\"}",
"InvoiceHeader": "Invoice to Frank",
"InvoiceStatus": "Draft",
"InvoiceNotes": "",
"InvoiceNumber": "106",
"InvoicePoNo": "",
"RecurringIntervalInString": "",
"SelectedCurrency": "en_IN",
"SelectedTemplate": "",
"ShippingMethod": "Standard Ground",
"ArchiveStatus": 0,
"Status": "active",
"SyncID": "",
"TaxValue": "",
"InvoiceTerms": "",
"InvoiceID": "875C970F-1747-4637-A15A-FA5BFA65CDA6",
"DeviceID": "1093193415.1644912014",
"CreatedDate": "2022-06-24 10:29:43",
"SyncDate": "",
"IsInvoiceDelete": 0,
"CreatedAt": "2022-06-24T10:29:43.000000Z",
"UpdatedAt": "2022-06-24T10:29:43.000000Z",
"ServiceType": "1",
"Type": 0,
"PaymentTypes": "",
"Extra4": "",
"Extra5": "",
"Extra6": "",
"UsedDiscountInfo": [],
"CustomerEmail": "pp@yopmail.com",
"CompanyId": "8D5D856F-E370-45CC-8128-11EB9801805D",
"IsCreditNote": 0,
"PaynowLink": "",
"DueDateFormat": "May 18, 2022",
"EntryDateFormat": "May 18, 2022",
"OutStanding": [
{
"symbol": "$",
"code": "USD",
"currencylocale": "en_US",
"amount": 0,
"amount_f": "$0.00"
}
],
"ContactName": "aaa",
"ContactFirstLastname": "pp pp",
"NextRecurring": 0,
"RecurringDay": "",
"RecurringDate": "",
"PaypalEmail": "",
"EmailFontName": "Arial",
"EmailFontSize": 12,
"Attachment": "https://mi-doc.s3.amazonaws.com/local/9561/imageinfo/F4D717A8-0444-42CC-A6A5-2DFB02EC6AD4.png?AWSAccessKeyId=AKIA43TXFBRTCBXKZYZ6&Expires=1656067784&Signature=kDzmj6%2FmRv5H3b%2BqY73jls9Drh0%3D",
"Products": [
{
"ProductID": "182BA686-499F-4B07-9040-83E3A6B23225",
"InvoiceProductID": "23FEEE2C-F68C-468D-B08A-E22ACB764147",
"ProductName": "Black Shirt",
"ModificationDate": "2022-06-24 10:29:43",
"Quantity": 2,
"Total": 304,
"UnitCost": 160,
"DiscountIsPercentage": 1,
"DiscountValue": "5",
"ProductNotes": "Black Shirt update test",
"ProductImage": "",
"TaxID": "95A1956E-E60A-4FAC-8EC4-C88EE7431280"
}
],
"Tasks": [
{
"TaskID": "2908192A-85C7-49D8-A18F-502782EC2EAE",
"InvoiceTaskID": "72A3C787-2418-4E8D-B280-0B81E6B618E7",
"taskName": "Task1",
"ModificationDate": "2022-06-24 10:29:43",
"Hours": 1,
"Total": 9.8,
"Rate": 10,
"DiscountIsPercentage": 1,
"DiscountValue": "2",
"TaskNotes": "",
"TaxID": "95A1956E-E60A-4FAC-8EC4-C88EE7431280"
}
]
}
}
}
Details Invoice
To Get Invoice Details, you need to make a GET call to the following URL:
https://www.mooninvoice.com/api_mi/public/invoice_details
parameters for DETAILS Invoice
required fields
| Field | Type | Description |
|---|---|---|
| CompanyID | String | CompanyId is for get details of invoice of specific Company. |
| ServiceType | String | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
| InvoiceID | String | Invoice Identifier. |
Request Sample
Example DETAILS Invoice JSON Request: {
"InvoiceID": "7F7CD9ED-C796-4CE0-8694-ECFA74392AF3",
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D5",
"ServiceType": "1"
}
Response Sample
Result example DETAILS Invoice JSON Response: {
{
"status": 200,
"message": "Data received.",
"data": {
"IsPaypalPayment": 0,
"IsRecurring": 0,
"RecurringIntervalInDay": "0",
"InvoiceToExpense": "",
"InvoiceToImageInfo": "",
"InvoiceToRecurringExpense": "",
"InvoiceToItemline": "",
"invoiceToPayment": "",
"ContactID": "0B505706-B5F2-435B-B2AF-7DD81B89893C",
"ExpenseID": "",
"InvoiceToUsedtax": "",
"InvoiceToRecurringInvoice": "",
"InvoiceToTablelist": null,
"InvoiceDueDate": "2022-05-18 12:40:27",
"InvoiceEntryDate": "2022-05-18 12:40:27",
"ModificationDate": "2022-06-24 11:43:17",
"RecurringEndDate": "0000-00-00 00:00:00",
"AmountDue": 351.8,
"AmountPaid": 0,
"DiscountDec": 0,
"ShippingCost": 5,
"SubTotal": 313.8,
"Total": 351.8,
"Discount": "A|N",
"DiscountValue": "",
"Extra1": "",
"Extra2": "",
"Extra3": "",
"InvoiceFolder": "{\"payment_str\":\"cash\",\"isroundoff\":\"0\",\"rounded_amount\":\"0\",\"Billing\":\"0\",\"Billing_Add\":{\"Street1\":\"\",\"Street2\":\"\",\"City\":\"\",\"State\":\"\",\"Country\":\"\",\"Zip\":\"\"},\"Secondary\":\"0\",\"Secondary_Add\":{\"Street1\":\"\",\"Street2\":\"\",\"City\":\"\",\"State\":\"\",\"Country\":\"\",\"Zip\":\"\"},\"Percentage\":\"0\",\"depositeAmount\":\"0.00\"}",
"InvoiceHeader": "23 june Invoice update again",
"InvoiceStatus": "Draft",
"InvoiceNotes": "",
"InvoiceNumber": "105",
"InvoicePoNo": "",
"RecurringIntervalInString": "",
"SelectedCurrency": "en_IN",
"SelectedTemplate": "",
"ShippingMethod": "Standard Ground",
"ArchiveStatus": 0,
"Status": "active",
"SyncID": "",
"TaxValue": "",
"InvoiceTerms": "",
"InvoiceID": "3EEED566-07F3-4964-8C15-E7762706B756",
"DeviceID": "1093193415.1644912014",
"CreatedDate": "2022-06-24 11:43:19",
"SyncDate": "",
"IsInvoiceDelete": 0,
"CreatedAt": "2022-06-23T05:54:40.000000Z",
"UpdatedAt": "2022-06-23T05:54:40.000000Z",
"ServiceType": "1",
"Type": 0,
"PaymentTypes": "{\"paymentmethod\":[]}",
"Extra4": "",
"Extra5": "",
"Extra6": "",
"UsedDiscountInfo": [],
"CustomerEmail": "pp@yopmail.com",
"CompanyId": "8D5D856F-E370-45CC-8128-11EB9801805D5",
"IsCreditNote": 0,
"PaynowLink": "",
"DueDateFormat": "May 18, 2022",
"EntryDateFormat": "May 18, 2022",
"OutStanding": [
{
"symbol": "₹",
"code": "INR",
"currencylocale": "en-IN",
"amount": 0,
"amount_f": "₹0.00"
}
],
"ContactName": "aaa",
"ContactFirstLastname": "pp pp",
"NextRecurring": 0,
"RecurringDay": "",
"RecurringDate": "",
"PaypalEmail": "",
"EmailFontName": "",
"EmailFontSize": "",
"Attachment": "https://mi-doc.s3.amazonaws.com/local/9561/imageinfo/1A8C6A1E-275C-4B01-8684-4B19BE2B4A6C.png?AWSAccessKeyId=AKIA43TXFBRTCBXKZYZ6&Expires=1656072238&Signature=8qH5S3v4ivFmG%2FGn1jec3isilmc%3D",
"Products": [
{
"ProductID": "182BA686-499F-4B07-9040-83E3A6B23225",
"InvoiceProductID": "69779A84-AEE2-4114-A6EF-FC7C3CB3DE79",
"ProductName": "Black Shirt",
"ModificationDate": "2022-06-24 11:43:19",
"Quantity": 2,
"Total": 304,
"UnitCost": 160,
"DiscountIsPercentage": 1,
"DiscountValue": "5",
"ProductNotes": "Black Shirt update test",
"ProductImage": "",
"TaxID": "95A1956E-E60A-4FAC-8EC4-C88EE7431280"
}
],
"Tasks": [
{
"TaskID": "2908192A-85C7-49D8-A18F-502782EC2EAE",
"InvoiceTaskID": "F66CF5B9-D747-4D54-A6DE-D5ED0DC04D40",
"taskName": "Task1",
"ModificationDate": "2022-06-24 11:43:24",
"Hours": 1,
"Total": 9.8,
"Rate": 10,
"DiscountIsPercentage": 1,
"DiscountValue": "2",
"TaskNotes": "",
"TaxID": "95A1956E-E60A-4FAC-8EC4-C88EE7431280"
}
]
}
}
}
Invoice Delete
To Delete Invoice, you need to make a DELETE call to the following URL:
https://www.mooninvoice.com/api_mi/public/invoice_delete
parameters for Invoice Delete
required fields
| Field | Type | Description |
|---|---|---|
| InvoiceID | String | Invoice Identifier. |
| CompanyID | String | CompanyId is for delete invoice of specific Company. |
| DeviceID | Float | DeviceID is an unique identifier of your device. |
| ServiceType | Integer | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
Request Sample
Example Invoice DELETE JSON Request: {
"InvoiceID": "B52A1695-5B62-4639-AF56-68D1192DC249",
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"DeviceID": "1093193415.1644912014",
"ServiceType": "1"
}
Response Sample
Result example Invoice DELETE JSON Response: {
"status": 200,
"message": "1 invoice(s) moved to trash.",
"data": []
}
Get Project
To Get Project, you need to make a GET call to the following URL:
https://www.mooninvoice.com/api_mi/public/project_list
parameters for GET Project
required fields
| Field | Type | Description |
|---|---|---|
| ProjectSort | String | ProjectSort is for sorting record by ascending or decending order wise record. ProjectSort must be contain asc or desc value. |
| PageSize | Integer | PageSize is for size of per page record. |
| ProjectSortColumn | String | ProjectSortColumn is for sort record by specific Column of table. |
| CompanyID | String | CompanyId is for get record by specific Company. |
| ServiceType | Integer | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
optional fields
| Field | Type | Description |
|---|---|---|
| page | Integer | Enter page no. for get page wise records. |
Request Sample
Example GET Project JSON Request: {
"PageSize": 2,
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"ProjectSortColumn": "ProjectName",
"ProjectSort": "asc",
"ServiceType": "1"
}
Response Sample
Result example GET Project JSON Response: {
"status": 200,
"message": "Data received.",
"data": {
"current_page": 1,
"first_page_url": "https://www.mooninvoice.com/api_mi/public/project_list?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "https://www.mooninvoice.com/api_mi/public/project_list?page=1",
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "https://www.mooninvoice.com/api_mi/public/project_list?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
],
"next_page_url": null,
"path": "https://www.mooninvoice.com/api_mi/public/project_list",
"per_page": 25,
"prev_page_url": null,
"to": 14,
"total": 14,
"total_hours": "00:00",
"projects": [
{
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"DefaultRate": "15",
"ProjectName": "FB to MI",
"ProjectSecond": "20:00",
"ProjectIsUsed": 0,
"ProjectID": "10FEB5E6-8FF4-4476-A4FE-865DAB318819",
"Contact": {
"ContactID": "",
"ContactName": ""
}
},
{
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"DefaultRate": "10",
"ProjectName": "Mi to Freshbook Beta",
"ProjectSecond": "00:00",
"ProjectIsUsed": 0,
"ProjectID": "E60983B8-A812-4046-B4E4-5AC1D79B2C78",
"Contact": {
"ContactID": "5ACC3AEF-8EAB-4DB1-B709-279261C59E0C",
"ContactName": "Web64 Test"
}
}
]
}
}
Create Project
To Create Project, you need to make a POST call to the following URL:
https://www.mooninvoice.com/api_mi/public/create_project
parameters for CREATE Project
required fields
| Field | Type | Description |
|---|---|---|
| CompanyID | String | CompanyID is for create project of specific Company. |
| ServiceType | Integer | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
| DeviceID | Float | DeviceID is an unique identifier of your device. |
| ProjectName | String | Name of Project. |
optional fields
| Field | Type | Description |
|---|---|---|
| ContactID | String | Contact Identifier. |
| DefaultRate | Float | Project Default Rate. |
Request Sample
Example CREATE Project JSON Request: {
"ProjectName": "Project For TEST",
"ContactID": "5ACC3AEF-8EAB-4DB1-B709-279261C59E0C",
"DefaultRate": 5,
"DeviceID": "1093193415.1644912014",
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"ServiceType": "1"
}
Response Sample
Result example CREATE Project JSON Response: {
"status": 200,
"message": "Project Added.",
"data": {
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"ContactID": "5ACC3AEF-8EAB-4DB1-B709-279261C59E0C",
"DefaultRate": "1",
"ProjectID": "DA9AA481-5E56-4890-BBCE-DE9F2AB390C1",
"ProjectName": "Project For Invoice",
"TotalHours": "00:00",
"TotalBilledHours": "00:00"
}
}
Update Project
To Update Project, you need to make a PUT call to the following URL:
https://www.mooninvoice.com/api_mi/public/update_project
parameters for UPDATE Project
required fields
| Field | Type | Description |
|---|---|---|
| ProjectID | String | Project Identifier. |
| CompanyID | String | CompanyID is for create project of specific Company. |
| ServiceType | Integer | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
| DeviceID | Float | DeviceID is an unique identifier of your device. |
| ProjectName | String | Name of Project. |
optional fields
| Field | Type | Description |
|---|---|---|
| ContactID | String | Contact Identifier. |
| DefaultRate | Float | Project Default Rate. |
Request Sample
Example UPDATE Project JSON Request: {
"ProjectID":"DA9AA481-5E56-4890-BBCE-DE9F2AB390C1",
"ProjectName": "Project For TEST",
"ContactID": "5ACC3AEF-8EAB-4DB1-B709-279261C59E0C",
"DefaultRate": 5,
"DeviceID": "1093193415.1644912014",
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"ServiceType": "1"
}
Response Sample
Result example UPDATE Project JSON Response: {
"status": 200,
"message": "Project updated.",
"data": {
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"ContactID": "5ACC3AEF-8EAB-4DB1-B709-279261C59E0C",
"DefaultRate": "3",
"ProjectID": "DA9AA481-5E56-4890-BBCE-DE9F2AB390C1",
"ProjectName": "Project For Invoice Update",
"TotalHours": "00:00",
"TotalBilledHours": "00:00"
}
}
Details Project
To Get Project Details, you need to make a GET call to the following URL:
https://www.mooninvoice.com/api_mi/public/project_details
parameters for DETAILS Project
required fields
| Field | Type | Description |
|---|---|---|
| CompanyID | String | CompanyID is for details of project of specific Company. |
| ServiceType | String | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
| ProjectID | String | Project Identifier. |
| DeviceID | Float | DeviceID is an unique identifier of your device. |
Request Sample
Example DETAILS Project JSON Request: {
"ProjectID": "DA9AA481-5E56-4890-BBCE-DE9F2AB390C1",
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"ServiceType": "1",
"DeviceID": "1093193415.1644912014"
}
Response Sample
Result example DETAILS Project JSON Response: {
"status": 200,
"message": "Data received.",
"data": {
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"ContactID": "5ACC3AEF-8EAB-4DB1-B709-279261C59E0C",
"DefaultRate": "3",
"ProjectID": "DA9AA481-5E56-4890-BBCE-DE9F2AB390C1",
"ProjectName": "Project For Invoice Update",
"TotalHours": "00:00",
"TotalBilledHours": "00:00"
}
}
Delete Project
To Delete Project, you need to make a DELETE call to the following URL:
https://www.mooninvoice.com/api_mi/public/delete_project
parameters for DELETE Project
required fields
| Field | Type | Description |
|---|---|---|
| CompanyID | String | CompanyID is for delete project of specific Company. |
| ServiceType | Integer | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
| ProjectID | String | Project Identifier. |
| DeviceID | Float | DeviceID is an unique identifier of your device. |
Request Sample
Example DELETE Project JSON Request: {
"ProjectID": "BB863B60-ACEC-4E51-97F2-6E26821AE4CD",
"DeviceID": "1093193415.1644912014",
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"ServiceType": "1"
}
Response Sample
Result example DELETE Project JSON Response: {
"status": 200,
"message": "1 project(s) deleted.",
"data": []
}
Get Task
To Get Task, you need to make a GET call to the following URL:
https://www.mooninvoice.com/api_mi/public/task_list
parameters for GET Task
required fields
| Field | Type | Description |
|---|---|---|
| TaskSort | String | TaskSort is for sorting record by ascending or decending order wise record. TaskSort must be contain asc or desc value. |
| ProjectID | String | ProjectID is use for get task of perticular project. |
| CompanyID | String | CompanyId is for get record by specific Company. |
| ServiceType | Integer | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
| PageSize | Integer | PageSize is for size of per page record. |
required fields
| Field | Type | Description |
|---|---|---|
| page | Integer | Enter page no. for get page wise records. |
Request Sample
Example GET Task JSON Request: {
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"ProjectID": "E580EBEF-1501-410D-BFC7-9B483C04D204",
"TaskSort": "asc",
"ServiceType": "1",
"PageSize": 25,
"page": 1
}
Response Sample
Result example GET Task JSON Response: {
"status": 200,
"message": "Data received.",
"data": {
"current_page": 1,
"first_page_url": "https://www.mooninvoice.com/api_mi/public/task_list?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "https://www.mooninvoice.com/api_mi/public/task_list?page=1",
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "https://www.mooninvoice.com/api_mi/public/task_list?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
],
"next_page_url": null,
"path": "https://www.mooninvoice.com/api_mi/public/task_list",
"per_page": 25,
"prev_page_url": null,
"to": 4,
"total": 3,
"tasks": [
{
"ProjectID": "E580EBEF-1501-410D-BFC7-9B483C04D204",
"Hours": 1,
"Rate": "0.000",
"TaskName": "new",
"Notes": "cdcdc",
"TaskType": "hour",
"TaskID": "70E9D330-9F2A-49EF-950A-633250CE2F0C",
"TaskIsDelete": 0,
"Taxes": "",
"TaskIsUsed": 0,
"TaskTax": []
},
{
"ProjectID": "E580EBEF-1501-410D-BFC7-9B483C04D204",
"Hours": 1,
"Rate": "10.000",
"TaskName": "Task 1",
"Notes": "Test Notes",
"TaskType": "Hour",
"TaskID": "32956DB4-6DDF-4CCE-8035-8CBD9ADD08AE",
"TaskIsDelete": 0,
"Taxes": "Default",
"TaskIsUsed": 1,
"TaskTax": [
"95A1956E-E60A-4FAC-8EC4-C88EE7431280"
]
}
]
}
}
Create Task
To Create Task, you need to make a POST call to the following URL:
https://www.mooninvoice.com/api_mi/public/add_task
parameters for CREATE Task
required fields
| Field | Type | Description |
|---|---|---|
| CompanyID | String | CompanyID is for create task of specific Company. |
| ServiceType | Integer | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
| DeviceID | Float | DeviceID is an unique identifier of your device. |
| TaskName | String | Name of Task. |
| ProjectID | String | Project Identifier. |
optional fields
| Field | Type | Description |
|---|---|---|
| Hours | Float | Task hours. |
| Notes | String | Task notes. |
| Rate | Float | Rate of task. |
| TaskTax | Array | Array of TaxID for task. Like ["95A1956E-E60A-4FAC-8EC4-C88EE7431280","CBC0A8DD-EDF5-47B2-B8DB-E7BA953E2C86"] |
| IsFromTimeLog | String | IsFromTimeLog is from time log and contain value YES or NO only. |
| TaskType | String | TaskType is describe type of task. Like Hours, Minutes etc. |
| IsTaxable | Boolean | IsTaxable is contain boolean value true or false. If Task is taxable then 1 otherwise 0. |
Request Sample
Example CREATE Task JSON Request: {
"Hours": 1,
"Notes": "House Furniture",
"Rate": 250,
"TaskName": "House Furniture",
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"ProjectID": "non-project",
"TaskTax": [
"D61E8F48-5073-458D-A908-99213C2B9C98",
"EBD10E4E-461E-4DAC-8583-1E478C234B94"
],
"IsFromTimeLog": "NO",
"TaskType": "Hours",
"IsTaxable": "1",
"DeviceID": "949097987.1650435533",
"ServiceType": "1"
}
Response Sample
Result example CREATE Task JSON Response: {
"status": 200,
"message": "Task added.",
"data": {
"ProjectID": "DA9AA481-5E56-4890-BBCE-DE9F2AB390C1",
"Hours": "1.000",
"Rate": "10.000",
"TaskName": "Task for Invoice",
"Notes": "Task for Invoice Project Notes",
"TaskType": "Hours",
"TaskToTax": "",
"IsTaxable": 0
}
}
Update Task
To Update Task, you need to make a PUT call to the following URL:
https://www.mooninvoice.com/api_mi/public/update_task
parameters for UPDATE Task
required fields
| Field | Type | Description |
|---|---|---|
| TaskID | String | Task Identifier. |
| CompanyID | String | CompanyID is for create task of specific Company. |
| ServiceType | Integer | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
| DeviceID | Float | DeviceID is an unique identifier of your device. |
| TaskName | String | Name of Task. |
| ProjectID | String | Project Identifier. |
optional fields
| Field | Type | Description |
|---|---|---|
| Hours | Float | Task hours. |
| Notes | String | Task notes. |
| Rate | Float | Rate of task. |
| TaskTax | Array | Array of TaxID for task. Like ["95A1956E-E60A-4FAC-8EC4-C88EE7431280","CBC0A8DD-EDF5-47B2-B8DB-E7BA953E2C86"] |
| IsFromTimeLog | String | IsFromTimeLog is from time log and contain value YES or NO only. |
| TaskType | String | TaskType is describe type of task. Like Hours, Minutes etc. |
| IsTaxable | Boolean | IsTaxable is contain boolean value true or false. If Task is taxable then 1 otherwise 0. |
Request Sample
Example UPDATE Task JSON Request: {
"TaskID": "524EB6BF-C4E6-4992-A12E-4E82DDF8D464",
"Hours": 1,
"Notes": "House Furniture",
"Rate": 250,
"TaskName": "House Furniture",
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"ProjectID": "non-project",
"TaskTax": [
"D61E8F48-5073-458D-A908-99213C2B9C98",
"EBD10E4E-461E-4DAC-8583-1E478C234B94"
],
"IsFromTimeLog": "NO",
"TaskType": "Hours",
"IsTaxable": "1",
"DeviceID": "949097987.1650435533",
"ServiceType": "1"
}
Response Sample
Result example UPDATE Task JSON Response: {
"status": 200,
"message": "Task updated.",
"data": {
"ProjectID": "60D1B405-D22E-4D42-853D-90890A40DA4F",
"TaskID": "524EB6BF-C4E6-4992-A12E-4E82DDF8D464",
"Hours": "1.000",
"Rate": "15.000",
"TaskName": "Task for Invoice Update",
"Notes": "Task for Invoice Project Notes Update",
"TaskType": "Hours",
"TaskToTax": "",
"IsTaxable": 0
}
}
Details Task
To Get Task Details, you need to make a GET call to the following URL:
https://www.mooninvoice.com/api_mi/public/task_details
parameters for DETAILS Task
required fields
| Field | Type | Description |
|---|---|---|
| CompanyID | String | CompanyID is for get details of task of specific Company. |
| ServiceType | String | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
| TaskID | String | Task Identifier. |
| DeviceID | Float | DeviceID is an unique identifier of your device. |
Request Sample
Example DETAILS Task JSON Request: {
"TaskID": "524EB6BF-C4E6-4992-A12E-4E82DDF8D464",
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"ServiceType": "1",
"DeviceID": "1093193415.1644912014"
}
Response Sample
Result example DETAILS Task JSON Response: {
"status": 200,
"message": "Data received.",
"data": {
"ProjectID": "60D1B405-D22E-4D42-853D-90890A40DA4F",
"TaskID": "524EB6BF-C4E6-4992-A12E-4E82DDF8D464",
"Hours": "1.000",
"Rate": "15.000",
"TaskName": "Task for Invoice Update",
"Notes": "Task for Invoice Project Notes Update",
"TaskType": "Hours",
"TaskToTax": "",
"IsTaxable": 0
}
}
Delete Task
To Delete Task, you need to make a DELETE call to the following URL:
https://www.mooninvoice.com/api_mi/public/delete_task
parameters for DELETE Task
required fields
| Field | Type | Description |
|---|---|---|
| CompanyID | String | CompanyID is for delete task of specific Company. |
| ServiceType | Integer | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
| TaskID | String | Task Identifier. |
| DeviceID | Float | DeviceID is an unique identifier of your device. |
Request Sample
Example DELETE Task JSON Request: {
"TaskID": "524EB6BF-C4E6-4992-A12E-4E82DDF8D464",
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"ServiceType": "1",
"DeviceID": "1093193415.1644912014"
}
Response Sample
Result example DELETE Task JSON Response: {
"status": 200,
"message": "1 task(s) deleted.",
"data": []
}
Get Estimate
To Get Estimate, you need to make a GET call to the following URL:
https://www.mooninvoice.com/api_mi/public/estimate_list
parameters for GET Estimate
required fields
| Field | Type | Description |
|---|---|---|
| EstimateSort | String | EstimateSort is for sorting record by ascending or decending order wise record. EstimateSort must be contain asc or desc value. |
| PageSize | Integer | PageSize is for size of per page record. |
| CompanyID | String | CompanyId is for get record by specific Company. |
| ServiceType | Integer | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
required fields
| Field | Type | Description |
|---|---|---|
| page | Integer | Enter page no. for get page wise records. |
Request Sample
Example GET Estimate JSON Request: {
"EstimateSort": "desc",
"PageSize": 25,
"page": 1,
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"ServiceType": "1"
}
Response Sample
Result example GET Estimate JSON Response: {
"status": 200,
"message": "Data received.",
"data": {
"current_page": 1,
"first_page_url": "https://www.mooninvoice.com/api_mi/public/estimate_list?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "https://www.mooninvoice.com/api_mi/public/estimate_list?page=1",
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "https://www.mooninvoice.com/api_mi/public/estimate_list?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
],
"next_page_url": null,
"path": "https://www.mooninvoice.com/api_mi/public/estimate_list",
"per_page": 25,
"prev_page_url": null,
"to": 18,
"total": 18,
"estimates": [
{
"EstimateID": "CCF9369A-9A3F-4BF2-AFFF-A11FCC7B78E9",
"EstimateEntryDate": "2022-06-20 13:02:30",
"SelectedCurrency": "en_US",
"EstimateStatus": "Draft",
"Status": "active",
"IsEstimateDelete": 0,
"EstimateTotal": "356.3000",
"Estimateterms": "TEST term estimate",
"EstimateOrganization": "aaa",
"FirstName": "pp",
"LastName": "pp",
"EstimateNotes": "Test Note Estimate",
"EstimateNumber": "25",
"EstimateFolder": "{\"isroundoff\":\"0\",\"rounded_amount\":\"0\",\"Billing\":\"0\",\"Billing_Add\":{\"Street1\":\"\",\"Street2\":\"\",\"City\":\"\",\"State\":\"\",\"Country\":\"\",\"Zip\":\"\"},\"Secondary\":\"0\",\"Secondary_Add\":{\"Street1\":\"\",\"Street2\":\"\",\"City\":\"\",\"State\":\"\",\"Country\":\"\",\"Zip\":\"\"},\"Percentage\":\"0\",\"depositeAmount\":\"0.00\"}",
"TotalAmount": "0.0000",
"ContactName": "aaa",
"Currency": {
"CurrencyLocale": "en_US",
"Code": "INR",
"Symbol": "₹"
}
},
{
"EstimateID": "55AAE324-06B2-4478-8CB2-DEF37D103EC0",
"EstimateEntryDate": "2022-05-20 11:25:35",
"SelectedCurrency": "en_US",
"EstimateStatus": "Draft",
"Status": "active",
"IsEstimateDelete": 0,
"EstimateTotal": "1280.5000",
"Estimateterms": "Terms and Condition",
"EstimateOrganization": "My Company",
"FirstName": "Real Name 1",
"LastName": "Real Name 2",
"EstimateNotes": "Notes test",
"EstimateNumber": "19",
"EstimateFolder": "{\"isroundoff\":\"0\",\"rounded_amount\":\"0\",\"Billing\":\"1\",\"Billing_Add\":{\"Street1\":\"Near NG Road\",\"Street2\":\"HIghschool side\",\"City\":\"Mumbai\",\"State\":\"Gujarat\",\"Country\":\"India\",\"Zip\":\"360005\"},\"Secondary\":\"0\",\"Secondary_Add\":{\"Street1\":\"\",\"Street2\":\"\",\"City\":\"\",\"State\":\"\",\"Country\":\"\",\"Zip\":\"\"},\"Percentage\":\"0\",\"depositeAmount\":\"0.00\"}",
"TotalAmount": "0.0000",
"ContactName": "My Company",
"Currency": {
"CurrencyLocale": "en_US",
"Code": "INR",
"Symbol": "₹"
}
}
]
}
}
Create Estimate
To Create Estimate, you need to make a POST call to the following URL:
https://www.mooninvoice.com/api_mi/public/create_estimate
parameters for CREATE Estimate
required fields
| Field | Type | Description |
|---|---|---|
| CompanyID | String | CompanyID is for create estimate of specific Company. |
| ContactID | String | Contact Identifier of Estimate. |
| EstimateNumber | String | Estimate Number. |
| EntryDate | DateTime | Entry Date of Estimate. |
optional fields
| Field | Type | Description |
|---|---|---|
| EstimateHeader | String | Title or Header of Estimate. |
| ShippingCost | Float | Shipping Cost of Estimate |
| ShippingMethod | String | Shipping Method of Estimate. |
| DiscountDec | Float | Discont on Estimate total. |
| EstimateTerms | String | Terms of Estimate. |
| EstimateNotes | String | Notes/Description of Estimate. |
| TotalAmount | Float | Total Amount of Estimate. |
| SubTotal | Float | Sub Total Amount of Estimate. |
| DeviceID | String | DeviceID is an unique identifier of your device. |
| SelectedCurrency | String | Selected Currency is code of local currency language. Like en_IN, en_US etc. |
| AttachmentFile | File | Estimate Attachment File. |
| ServiceType | String | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
| TimeZone | String | TimeZone of contact person for Estimate. |
| EstimateFolder | Array | Estimate Folder is array and contain below fields. |
isroundoff |
Boolean | isroundoff is a contain boolean value 1 and 0. isroundoff is a rounded amount of Estimate. |
rounded_amount |
Float | Rounded amount of Estimate. |
Percentage |
Float | Discount Percentage from total amount of Estimate. |
depositeAmount |
Float | Deposite Amount of Estimate. |
Billing_Add |
Array | Billing_Add is array and contain below fields. |
Street1 |
String | Billing Address Street1. |
Street2 |
String | Billing Address Street2 |
City |
String | Billing Address City |
State |
String | Billing Address State |
Country |
String | Billing Address Country |
Zip |
String | Billing Address Zip |
Secondary_Add |
Array | Secondary_Add is array and contain below fields. |
Street1 |
String | Shipping Address Street1. |
Street2 |
String | Shipping Address Street2 |
City |
String | Shipping Address City |
State |
String | Shipping Address State |
Country |
String | Shipping Address Country |
Zip |
String | Shipping Address Zip |
| ProductData | Array | Product Data is a contain array of all product of estimate. ProductData contain multidimensional array. |
ProductName |
String | Name of Product. |
Quantity |
Integer | Quantity of Product. |
UnitCost |
Float | Selling price of Product. |
ProductNotes |
String | Product Notes. |
ProductID |
String | Product Identifier. |
Total |
String | Total Amount of Product. |
SubAmount |
String | SubAmount of Product. |
DiscountIsPercentage |
Boolean | Discount on product is in percetage or not. If in percentage then 1 otherwise 0. |
ProductType |
String | Type of product like kg, piece, liter etc. |
DiscountValue |
String | Discount amount |
TaxUpdate |
Boolean | TaxUpdate is a contain boolean value. If Tax Update then 1 otherwise 0. |
StockUpdate |
Boolean | StockUpdate is a contain boolean value. If Tax Update then 1 otherwise 0. |
TaxID |
Array | Array of Tax ID which is apply on product. Like ["95A1956E-E60A-4FAC-8EC4-C88EE7431280"] |
ItemlineToTaxList |
Array | ItemlineToTaxList is multidimensional array and contain all tax data which are applied on product. |
ItemlineToTaxListID |
String | Identifier of TAX. |
PercentageDec |
Float | Tax percentage of product. |
Name |
String | Name of Tax. |
| TaskData | Array | Task Data is a contain array of all task of estimate. TaskData contain multidimensional array. |
TaskName |
String | Name of Task. |
Hours |
Float | Total hours of task for invoice. |
TaskRate |
Float | Rate of task. |
TimeNotes |
String | Task Notes. |
TaskID |
String | Task Identifier. |
Total |
Float | Total amount of task. |
DiscountIsPercentage |
Boolean | Discount on task is in percetage or not. If in percentage then 1 otherwise 0. |
TaskType |
String | Type of task. |
DiscountValue |
String | Dicount value on task in percentage. Like 1P, 2P etc. |
TaxID |
Array | Array of Tax ID which is apply on tax. Like ["95A1956E-E60A-4FAC-8EC4-C88EE7431280"] |
TasklineToTax |
Array | TasklineToTax contains a tax details array with the below fields. |
TasklineToTaxID |
String | TaxID of task tax. |
PercentageDec |
Float | Tax percentage of task. |
Name |
String | Name of tax. |
Request Sample
Example CREATE Estimate JSON Request: {
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"EstimateHeader": "New Estimate 202",
"EstimateNumber": "126",
"ShippingCost": "",
"ShippingMethod": "Standard Ground",
"DiscountDec": "0.00",
"EstimateTerms": "Testing",
"EstimateNotes": "Testing Notes",
"EntryDate": "2022-8-12 13:57:44",
"TotalAmount": 335,
"SubTotal": 335,
"folder": {
"isroundoff": 0,
"rounded_amount": 0,
"Billing": "1",
"Billing_Add": {
"Street1": "35 a",
"Street2": "102 No.",
"City": "35 A",
"State": "Rajasthan",
"Country": "India",
"Zip": "335701"
},
"Secondary": "0",
"Secondary_Add": {
"Street1": "35 a",
"Street2": "102 No.",
"City": "35 A",
"State": "Rajasthan",
"Country": "India",
"Zip": "335701"
},
"Percentage": 0,
"depositeAmount": "0.00"
},
"DeviceID": "1093193415.1644912014",
"ContactID": "5B1D02B6-FBC8-49EC-A818-D6E2E8299E39",
"SelectedCurrency": "en_IN",
"AttachmentFile": "File DATA",
"AttachmentType": 4,
"ProductData": [
{
"ProductName": "Black Shirt",
"Quantity": 2,
"UnitCost": "160.00",
"ProductNotes": "Black Shirt update test",
"ProductID": "",
"Total": 320,
"SubAmount": 320,
"DiscountIsPercentage": "1",
"ProductType": "",
"DiscountValue": "P",
"StockUpdate": 1,
"ItemlineToTaxList": [
{
"ItemlineToTaxListID": "95A1956E-E60A-4FAC-8EC4-C88EE7431280",
"PercentageDec": 10,
"Name": "Default"
}
],
"TaxID": [],
"orderindex": 1
}
],
"TaskData": [
{
"TaskName": "Task1",
"Hours": "1.00",
"TaskRate": "10.00",
"TimeNotes": "",
"TaskID": "",
"Total": 9.8,
"DiscountIsPercentage": "1",
"DiscountValue": "2P",
"TasklineToTax": [
{
"TasklineToTaxID": "95A1956E-E60A-4FAC-8EC4-C88EE7431280",
"PercentageDec": "10.0000",
"Name": "Default"
}
],
"TaxID": [
"95A1956E-E60A-4FAC-8EC4-C88EE7431280"
],
"TaskType": "Hours",
"orderindex": 2
}
],
"UsedTax": [],
"ServiceType": "1",
"TimeZone": "Asia/Calcutta"
}
Response Sample
Result example CREATE Estimate JSON Response: {
{
"status": 200,
"message": "Estimate added.",
"data": {
"EstimateID": "B4B6C665-B95A-4F61-8617-D6F3645EBDB8",
"Amount": "0.0000",
"AmountPaid": "0.0000",
"Discount": "A|N",
"DiscountDec": 0,
"DiscountValue": "",
"EntryDate": "2022-05-18 12:40:27",
"EstimateHeader": "Estimate to Zack",
"EstimateStatus": "Draft",
"ArchiveStatus": 0,
"EstimateToPayment": "",
"Extra1": "",
"Extra2": "",
"Extra3": "",
"EstimateFolder": "{\"isroundoff\":{\"Zip\":\"360005\"},\"rounded_amount\":\"\",\"Billing\":\"0\",\"Billing_Add\":{\"Street1\":\"Near Sardar Nagar\",\"Street2\":\"105 Alfa Heights\",\"City\":\"Rajkot\",\"State\":\"Gujarat\",\"Country\":\"India\"},\"Secondary\":\"0\",\"Secondary_Add\":{\"Street1\":\"Near Sardar Nagar\",\"Street2\":\"105 Alfa Heights\",\"City\":\"Rajkot\",\"State\":\"Gujarat\",\"Country\":\"India\",\"Zip\":\"360005\"},\"Percentage\":\"0\",\"depositeAmount\":\"0.00\"}",
"EstimateNotes": "Notes Test",
"EstimateNumber": "102",
"EstimatePoNo": "",
"EstimateSectionRange": "",
"SelectedCurrency": "en_IN",
"ShippingCost": 5,
"ShippingMethod": "Standard Ground",
"Status": "active",
"SubTotal": 313.8,
"TaxValue": "",
"Terms": "Test",
"Total": 356.8,
"Type": 0,
"EstimateToImageInfo": "",
"EstimateToItemline": "",
"ContactID": "0B505706-B5F2-435B-B2AF-7DD81B89893C",
"EstimateToTaskLine": "",
"EstimateToUsedTax": "",
"DeviceID": "1093193415.1644912014",
"CreatedDate": "2022-06-24 12:05:04",
"SyncDate": "",
"ModificationDate": "2022-06-24 12:05:04",
"IsInvoiceDelete": 0,
"CreatedAt": "2022-06-24T12:05:04.000000Z",
"UpdatedAt": "2022-06-24T12:05:04.000000Z",
"ServiceType": "1",
"CustomerEmail": "pp@yopmail.com",
"CompanyId": "8D5D856F-E370-45CC-8128-11EB9801805D",
"EntryDateFormat": "May 18, 2022",
"ContactName": "aaa",
"ContactFirstLastname": "pp pp",
"EmailFontName": "Arial",
"EmailFontSize": 12,
"Attachment": "https://mi-doc.s3.amazonaws.com/local/9561/imageinfo/DBF754E6-A0A3-4951-92BF-5980D42F3261.png?AWSAccessKeyId=AKIA43TXFBRTCBXKZYZ6&Expires=1656073506&Signature=EgmygMrcsdm4Q%2Bn7FT9dSZ9TsdM%3D",
"Currency": {
"CurrencyLocale": "en_IN",
"Code": "INR",
"Symbol": "₹"
},
"Products": [
{
"ProductID": "182BA686-499F-4B07-9040-83E3A6B23225",
"InvoiceProductID": "23A2F3C9-C156-44DA-A2E8-49C105680261",
"ProductName": "Black Shirt",
"ModificationDate": "2022-06-24 12:05:05",
"Quantity": 2,
"Total": 304,
"UnitCost": 160,
"DiscountIsPercentage": 1,
"DiscountValue": "5",
"ProductNotes": "Black Shirt update test",
"ProductImage": "",
"TaxID": "95A1956E-E60A-4FAC-8EC4-C88EE7431280"
}
],
"Tasks": [
{
"TaskID": "2908192A-85C7-49D8-A18F-502782EC2EAE",
"InvoiceTaskID": "8125E2D5-8078-4D13-BE54-15050B393C1B",
"taskName": "Task1",
"ModificationDate": "2022-06-24 12:05:05",
"Hours": 1,
"Total": 9.8,
"Rate": 10,
"DiscountIsPercentage": 1,
"DiscountValue": "2",
"TaskNotes": "",
"TaxID": "95A1956E-E60A-4FAC-8EC4-C88EE7431280"
}
]
}
}
}
Update Estimate
To Update Estimate, you need to make a PUT call to the following URL:
https://www.mooninvoice.com/api_mi/public/update_estimate
parameters for UPDATE Estimate
required fields
| Field | Type | Description |
|---|---|---|
| EstimateID | String | Estimate Identifier. |
| CompanyID | String | CompanyID is for create estimate of specific Company. |
| ContactID | String | Contact Identifier of Estimate. |
| EstimateNumber | String | Estimate Number. |
| EntryDate | DateTime | Entry Date of Estimate. |
optional fields
| Field | Type | Description |
|---|---|---|
| EstimateHeader | String | Title or Header of Estimate. |
| ShippingCost | Float | Shipping Cost of Estimate |
| ShippingMethod | String | Shipping Method of Estimate. |
| DiscountDec | Float | Discont on Estimate total. |
| EstimateTerms | String | Terms of Estimate. |
| EstimateNotes | String | Notes/Description of Estimate. |
| TotalAmount | Float | Total Amount of Estimate. |
| SubTotal | Float | Sub Total Amount of Estimate. |
| DeviceID | String | DeviceID is an unique identifier of your device. |
| SelectedCurrency | String | Selected Currency is code of local currency language. Like en_IN, en_US etc. |
| AttachmentFile | File | Estimate Attachment File. |
| ServiceType | String | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
| TimeZone | String | TimeZone of contact person for Estimate. |
| EstimateFolder | Array | Estimate Folder is array and contain below fields. |
isroundoff |
Boolean | isroundoff is a contain boolean value 1 and 0. isroundoff is a rounded amount of Estimate. |
rounded_amount |
Float | Rounded amount of Estimate. |
Percentage |
Float | Discount Percentage from total amount of Estimate. |
depositeAmount |
Float | Deposite Amount of Estimate. |
Billing_Add |
Array | Billing_Add is array and contain below fields. |
Street1 |
String | Billing Address Street1. |
Street2 |
String | Billing Address Street2 |
City |
String | Billing Address City |
State |
String | Billing Address State |
Country |
String | Billing Address Country |
Zip |
String | Billing Address Zip |
Secondary_Add |
Array | Secondary_Add is array and contain below fields. |
Street1 |
String | Shipping Address Street1. |
Street2 |
String | Shipping Address Street2 |
City |
String | Shipping Address City |
State |
String | Shipping Address State |
Country |
String | Shipping Address Country |
Zip |
String | Shipping Address Zip |
| ProductData | Array | Product Data is a contain array of all product of invoice. ProductData contain multidimensional array. |
ProductName |
String | Name of Product. |
Quantity |
Integer | Quantity of Product. |
UnitCost |
Float | Selling price of Product. |
ProductNotes |
String | Product Notes. |
ProductID |
String | Product Identifier. |
Total |
String | Total Amount of Product. |
SubAmount |
String | SubAmount of Product. |
DiscountIsPercentage |
Boolean | Discount on product is in percetage or not. If in percentage then 1 otherwise 0. |
ProductType |
String | Type of product like kg, piece, liter etc. |
DiscountValue |
String | Discount amount |
TaxUpdate |
Boolean | TaxUpdate is a contain boolean value. If Tax Update then 1 otherwise 0. |
StockUpdate |
Boolean | StockUpdate is a contain boolean value. If Tax Update then 1 otherwise 0. |
TaxID |
Array | Array of Tax ID which is apply on product. Like ["95A1956E-E60A-4FAC-8EC4-C88EE7431280"] |
ItemlineToTaxList |
Array | ItemlineToTaxList is multidimensional array and contain all tax data which are applied on product. |
ItemlineToTaxListID |
String | Identifier of TAX. |
PercentageDec |
Float | Tax percentage of product. |
Name |
String | Name of Tax. |
| TaskData | Array | Task Data is a contain array of all task of invoice. TaskData contain multidimensional array. |
TaskName |
String | Name of Task. |
Hours |
Float | Total hours of task for invoice. |
TaskRate |
Float | Rate of task. |
TimeNotes |
String | Task Notes. |
TaskID |
String | Task Identifier. |
Total |
Float | Total amount of task. |
DiscountIsPercentage |
Boolean | Discount on task is in percetage or not. If in percentage then 1 otherwise 0. |
TaskType |
String | Type of task. |
DiscountValue |
String | Dicount value on task in percentage. Like 1P, 2P etc. |
TaxID |
Array | Array of Tax ID which is apply on tax. Like ["95A1956E-E60A-4FAC-8EC4-C88EE7431280"] |
TasklineToTax |
Array | TasklineToTax contains a tax details array with the below fields. |
TasklineToTaxID |
String | TaxID of task tax. |
PercentageDec |
Float | Tax percentage of task. |
Name |
String | Name of tax. |
Request Sample
Example UPDATE Estimate JSON Request: {
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"EstimateHeader": "New Estimate 202",
"EstimateNumber": "126",
"ShippingCost": "",
"ShippingMethod": "Standard Ground",
"DiscountDec": "0.00",
"EstimateTerms": "Testing",
"EstimateNotes": "Testing Notes",
"EntryDate": "2022-8-12 13:57:44",
"TotalAmount": 335,
"SubTotal": 335,
"folder": {
"isroundoff": 0,
"rounded_amount": 0,
"Billing": "1",
"Billing_Add": {
"Street1": "35 a",
"Street2": "102 No.",
"City": "35 A",
"State": "Rajasthan",
"Country": "India",
"Zip": "335701"
},
"Secondary": "0",
"Secondary_Add": {
"Street1": "35 a",
"Street2": "102 No.",
"City": "35 A",
"State": "Rajasthan",
"Country": "India",
"Zip": "335701"
},
"Percentage": 0,
"depositeAmount": "0.00"
},
"DeviceID": "1093193415.1644912014",
"ContactID": "5B1D02B6-FBC8-49EC-A818-D6E2E8299E39",
"SelectedCurrency": "en_IN",
"AttachmentFile": "File DATA",
"AttachmentType": 4,
"ProductData": [
{
"ProductName": "Black Shirt",
"Quantity": 2,
"UnitCost": "160.00",
"ProductNotes": "Black Shirt update test",
"ProductID": "",
"Total": 320,
"SubAmount": 320,
"DiscountIsPercentage": "1",
"ProductType": "",
"DiscountValue": "P",
"StockUpdate": 1,
"ItemlineToTaxList": [
{
"ItemlineToTaxListID": "95A1956E-E60A-4FAC-8EC4-C88EE7431280",
"PercentageDec": 10,
"Name": "Default"
}
],
"TaxID": [],
"orderindex": 1
}
],
"TaskData": [
{
"TaskName": "Task1",
"Hours": "1.00",
"TaskRate": "10.00",
"TimeNotes": "",
"TaskID": "",
"Total": 9.8,
"DiscountIsPercentage": "1",
"DiscountValue": "2P",
"TasklineToTax": [
{
"TasklineToTaxID": "95A1956E-E60A-4FAC-8EC4-C88EE7431280",
"PercentageDec": "10.0000",
"Name": "Default"
}
],
"TaxID": [
"95A1956E-E60A-4FAC-8EC4-C88EE7431280"
],
"TaskType": "Hours",
"orderindex": 2
}
],
"UsedTax": [],
"ServiceType": "1",
"TimeZone": "Asia/Calcutta"
}
Response Sample
Result example UPDATE Estimate JSON Response:
{
"status": 200,
"message": "Estimate updated.",
"data": {
"EstimateID": "D35AB55D-AEB3-4C45-A268-596036E56465",
"Amount": "0.0000",
"AmountPaid": "0.0000",
"Discount": "A|N",
"DiscountDec": 0,
"DiscountValue": "",
"EntryDate": "2022-05-18 12:40:27",
"EstimateHeader": "Estimate to zack Update",
"EstimateStatus": "Draft",
"ArchiveStatus": 0,
"EstimateToPayment": "",
"Extra1": "",
"Extra2": "",
"Extra3": "",
"EstimateFolder": "{\"isroundoff\":{\"Zip\":\"360005\"},\"rounded_amount\":\"\",\"Billing\":\"0\",\"Billing_Add\":{\"Street1\":\"Near Sardar Nagar\",\"Street2\":\"105 Alfa Heights\",\"City\":\"Rajkot\",\"State\":\"Gujarat\",\"Country\":\"India\"},\"Secondary\":\"0\",\"Secondary_Add\":{\"Street1\":\"Near Sardar Nagar\",\"Street2\":\"105 Alfa Heights\",\"City\":\"Rajkot\",\"State\":\"Gujarat\",\"Country\":\"India\",\"Zip\":\"360005\"},\"Percentage\":\"0\",\"depositeAmount\":\"0.00\"}",
"EstimateNotes": "Notes Test",
"EstimateNumber": "101",
"EstimatePoNo": "",
"EstimateSectionRange": "",
"SelectedCurrency": "en_IN",
"ShippingCost": 5,
"ShippingMethod": "Standard Ground",
"Status": "active",
"SubTotal": 313.8,
"TaxValue": "",
"Terms": "Test",
"Total": 356.8,
"Type": 0,
"EstimateToImageInfo": "",
"EstimateToItemline": "",
"ContactID": "0B505706-B5F2-435B-B2AF-7DD81B89893C",
"EstimateToTaskLine": "",
"EstimateToUsedTax": "",
"DeviceID": "1093193415.1644912014",
"CreatedDate": "2022-06-24 12:19:25",
"SyncDate": "",
"ModificationDate": "2022-06-24 12:19:25",
"IsInvoiceDelete": 0,
"CreatedAt": "2022-06-24T12:19:25.000000Z",
"UpdatedAt": "2022-06-24T12:19:25.000000Z",
"ServiceType": "1",
"CustomerEmail": "pp@yopmail.com",
"CompanyId": "8D5D856F-E370-45CC-8128-11EB9801805D",
"EntryDateFormat": "May 18, 2022",
"ContactName": "aaa",
"ContactFirstLastname": "pp pp",
"EmailFontName": "Arial",
"EmailFontSize": 12,
"Attachment": "https://mi-doc.s3.amazonaws.com/local/9561/imageinfo/84838A58-762E-4408-AB08-5C6BE356CE98.png?AWSAccessKeyId=AKIA43TXFBRTCBXKZYZ6&Expires=1656074368&Signature=zhSmekD1qKleHdLTK6%2BDzuV7XyQ%3D",
"Currency": {
"CurrencyLocale": "en_IN",
"Code": "INR",
"Symbol": "₹"
},
"Products": [
{
"ProductID": "182BA686-499F-4B07-9040-83E3A6B23225",
"InvoiceProductID": "52887A94-16F5-471A-BF89-F5AEC6CC0804",
"ProductName": "Black Shirt",
"ModificationDate": "2022-06-24 12:18:58",
"Quantity": 2,
"Total": 304,
"UnitCost": 160,
"DiscountIsPercentage": 1,
"DiscountValue": "5",
"ProductNotes": "Black Shirt update test",
"ProductImage": "",
"TaxID": "95A1956E-E60A-4FAC-8EC4-C88EE7431280"
},
{
"ProductID": "182BA686-499F-4B07-9040-83E3A6B23225",
"InvoiceProductID": "BA6C050E-2FC1-42BA-ACD0-6541EE0E4270",
"ProductName": "Black Shirt",
"ModificationDate": "2022-06-24 12:19:26",
"Quantity": 2,
"Total": 304,
"UnitCost": 160,
"DiscountIsPercentage": 1,
"DiscountValue": "5",
"ProductNotes": "Black Shirt update test",
"ProductImage": "",
"TaxID": "95A1956E-E60A-4FAC-8EC4-C88EE7431280"
},
{
"ProductID": "182BA686-499F-4B07-9040-83E3A6B23225",
"InvoiceProductID": "DEC4FF9F-8CA6-4B06-B81E-AB00DE5E3C3E",
"ProductName": "Black Shirt",
"ModificationDate": "2022-06-23 12:10:22",
"Quantity": 2,
"Total": 304,
"UnitCost": 160,
"DiscountIsPercentage": 1,
"DiscountValue": "5",
"ProductNotes": "Black Shirt update test",
"ProductImage": "",
"TaxID": "95A1956E-E60A-4FAC-8EC4-C88EE7431280"
}
],
"Tasks": [
{
"TaskID": "2908192A-85C7-49D8-A18F-502782EC2EAE",
"InvoiceTaskID": "0D890E20-0F9E-4879-BCBD-3CF900A55C3F",
"taskName": "Task1",
"ModificationDate": "2022-06-24 12:18:58",
"Hours": 1,
"Total": 9.8,
"Rate": 10,
"DiscountIsPercentage": 1,
"DiscountValue": "2",
"TaskNotes": "",
"TaxID": "95A1956E-E60A-4FAC-8EC4-C88EE7431280"
},
{
"TaskID": "2908192A-85C7-49D8-A18F-502782EC2EAE",
"InvoiceTaskID": "D5E6B7C4-B64A-44B3-A206-E74DA83ED523",
"taskName": "Task1",
"ModificationDate": "2022-06-24 12:19:26",
"Hours": 1,
"Total": 9.8,
"Rate": 10,
"DiscountIsPercentage": 1,
"DiscountValue": "2",
"TaskNotes": "",
"TaxID": "95A1956E-E60A-4FAC-8EC4-C88EE7431280"
},
{
"TaskID": "2908192A-85C7-49D8-A18F-502782EC2EAE",
"InvoiceTaskID": "F6FFB8C5-6F5F-40A5-8350-61E2D130B7DE",
"taskName": "Task1",
"ModificationDate": "2022-06-23 12:10:26",
"Hours": 1,
"Total": 9.8,
"Rate": 10,
"DiscountIsPercentage": 1,
"DiscountValue": "2",
"TaskNotes": "",
"TaxID": "95A1956E-E60A-4FAC-8EC4-C88EE7431280"
}
]
}
}
Details Estimate
To Get Estimate Details, you need to make a GET call to the following URL:
https://www.mooninvoice.com/api_mi/public/estimate_details
parameters for DETAILS Estimate
required fields
| Field | Type | Description |
|---|---|---|
| CompanyID | String | CompanyID is for details of estimate of specific Company. |
| ServiceType | String | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
| EstimateID | String | Estimate Identifier. |
Request Sample
Example DETAILS Estimate JSON Request: {
"EstimateID": "CCF9369A-9A3F-4BF2-AFFF-A11FCC7B78E9",
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"ServiceType": "1"
}
Response Sample
Result example DETAILS Estimate JSON Response: {
{
"status": 200,
"message": "Data received.",
"data": {
"EstimateID": "CCF9369A-9A3F-4BF2-AFFF-A11FCC7B78E9",
"Amount": "0.0000",
"AmountPaid": "0.0000",
"Discount": "A|N",
"DiscountDec": 0,
"DiscountValue": "",
"EntryDate": "2022-06-20 13:02:30",
"EstimateHeader": "New Estimate Sub TEst",
"EstimateStatus": "Draft",
"ArchiveStatus": 0,
"EstimateToPayment": "",
"Extra1": "",
"Extra2": "",
"Extra3": "",
"EstimateFolder": "{\"isroundoff\":\"0\",\"rounded_amount\":\"0\",\"Billing\":\"0\",\"Billing_Add\":{\"Street1\":\"\",\"Street2\":\"\",\"City\":\"\",\"State\":\"\",\"Country\":\"\",\"Zip\":\"\"},\"Secondary\":\"0\",\"Secondary_Add\":{\"Street1\":\"\",\"Street2\":\"\",\"City\":\"\",\"State\":\"\",\"Country\":\"\",\"Zip\":\"\"},\"Percentage\":\"0\",\"depositeAmount\":\"0.00\"}",
"EstimateNotes": "Test Note Estimate",
"EstimateNumber": "25",
"EstimatePoNo": "",
"EstimateSectionRange": "",
"SelectedCurrency": "en_IN",
"ShippingCost": 0,
"ShippingMethod": "Standard Ground",
"Status": "active",
"SubTotal": 323.3,
"TaxValue": "",
"Terms": "TEST term estimate",
"Total": 356.3,
"Type": 0,
"EstimateToImageInfo": "",
"EstimateToItemline": "",
"ContactID": "0B505706-B5F2-435B-B2AF-7DD81B89893C",
"EstimateToTaskLine": "",
"EstimateToUsedTax": "",
"DeviceID": "1093193415.1644912014",
"CreatedDate": "2022-06-23 12:03:34",
"SyncDate": "",
"ModificationDate": "2022-06-23 12:03:34",
"IsInvoiceDelete": 0,
"CreatedAt": "2022-06-23T12:03:34.000000Z",
"UpdatedAt": "2022-06-23T12:03:34.000000Z",
"ServiceType": "1",
"CustomerEmail": "pp@yopmail.com",
"CompanyId": "8D5D856F-E370-45CC-8128-11EB9801805D",
"EntryDateFormat": "Jun 20, 2022",
"ContactName": "aaa",
"ContactFirstLastname": "pp pp",
"EmailFontName": "Arial",
"EmailFontSize": 12,
"Attachment": "",
"Currency": {
"CurrencyLocale": "en_IN",
"Code": "INR",
"Symbol": "₹"
},
"Products": [
{
"ProductID": "182BA686-499F-4B07-9040-83E3A6B23225",
"InvoiceProductID": "5CCC018F-CB96-4B07-A245-C33AFFD75BD6",
"ProductName": "Black Shirt",
"ModificationDate": "2022-06-23 12:03:35",
"Quantity": 2,
"Total": 313.6,
"UnitCost": 160,
"DiscountIsPercentage": 1,
"DiscountValue": "2",
"ProductNotes": "Black Shirt update test",
"ProductImage": "",
"TaxID": "95A1956E-E60A-4FAC-8EC4-C88EE7431280"
}
],
"Tasks": [
{
"TaskID": "2908192A-85C7-49D8-A18F-502782EC2EAE",
"InvoiceTaskID": "B3230109-5B43-4CA8-AA10-A12B4AF38F8D",
"taskName": "Task1",
"ModificationDate": "2022-06-23 12:03:39",
"Hours": 1,
"Total": 9.7,
"Rate": 10,
"DiscountIsPercentage": 1,
"DiscountValue": "3",
"TaskNotes": "",
"TaxID": "95A1956E-E60A-4FAC-8EC4-C88EE7431280"
}
]
}
}
}
Estimate Delete
To Delete Estimate, you need to make a DELETE call to the following URL:
https://www.mooninvoice.com/api_mi/public/estimate_delete
parameters for Estimate Delete
required fields
| Field | Type | Description |
|---|---|---|
| EstimateID | String | Estimate Identifier. |
| CompanyID | String | CompanyID is for delete estimate of specific Company. |
| DeviceID | Float | DeviceID is an unique identifier of your device. |
| ServiceType | Integer | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
Request Sample
Example Delete Estimate JSON Request: {
"EstimateID": "CCF9369A-9A3F-4BF2-AFFF-A11FCC7B78E9",
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"ServiceType": "1",
"DeviceID":"1093193415.1644912014"
}
Response Sample
Result example Estimate Delete JSON Response: {
"status": 200,
"message": "1 estimate(s) moved to trash.",
"data": []
}
Get Expense
To Get Expense, you need to make a GET call to the following URL:
https://www.mooninvoice.com/api_mi/public/expense_list
parameters for GET Expense
required fields
| Field | Type | Description |
|---|---|---|
| PageSize | Integer | PageSize is for size of per page record. |
| ExpenseSort | String | ExpenseSort is for sorting record by ascending or decending order wise record. ExpenseSort must be contain asc or desc value. |
| CompanyID | String | CompanyId is for get record by specific Company. |
| ServiceType | Integer | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
optional fields
| Field | Type | Description |
|---|---|---|
| page | Integer | Enter page no. for get page wise records. |
Request Sample
Example GET Expense JSON Request: {
"PageSize": 25,
"page": 1,
"ExpenseSortColumn": "date",
"ExpenseSort": "desc",
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"ServiceType": "1"
}
Response Sample
Result example GET Expense JSON Response: {
"status": 200,
"message": "Data received.",
"data": {
"current_page": 1,
"first_page_url": "https://www.mooninvoice.com/api_mi/public/expense_list?page=1",
"from": 1,
"last_page": 2,
"last_page_url": "https://www.mooninvoice.com/api_mi/public/expense_list?page=2",
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "https://www.mooninvoice.com/api_mi/public/expense_list?page=1",
"label": "1",
"active": true
},
{
"url": "https://www.mooninvoice.com/api_mi/public/expense_list?page=2",
"label": "2",
"active": false
},
{
"url": "https://www.mooninvoice.com/api_mi/public/expense_list?page=2",
"label": "Next »",
"active": false
}
],
"next_page_url": "https://www.mooninvoice.com/api_mi/public/expense_list?page=2",
"path": "https://www.mooninvoice.com/api_mi/public/expense_list",
"per_page": 25,
"prev_page_url": null,
"to": 25,
"total": 44,
"expenses": [
{
"ExpenseID": "8A446898-EDF6-4006-9739-D4AC00525CB0",
"Date": "2022-06-23 11:21:27",
"SelectedCurrency": "en_US",
"InvoiceInfoID": "",
"ExpenseStatus": "Draft",
"Status": "active",
"IsExpenseDelete": 0,
"ExpenseTotalAmount": "721.0000",
"ExpenseCost": "650.0000",
"ExpenseDiscount": "6.0000",
"ExpenseOrganization": "Test",
"FirstName": "",
"LastName": "",
"ExpenseNotes": "xTest SData",
"ExpenseNumber": "7089919",
"ExpenseRecurring": 0,
"ExpenseToRecurringExpense": "",
"ContactID": "2ECBC6EF-8E11-4BEC-B6FD-7AD4F5681AA1",
"CategoryName": "Taxes",
"ContactName": "Test",
"Currency": {
"CurrencyLocale": "en_US",
"Code": "INR",
"Symbol": "₹"
}
},
{
"ExpenseID": "DA99793E-3BBB-419B-9782-1F80579D42EE",
"Date": "2022-06-23 11:20:40",
"SelectedCurrency": "en_US",
"InvoiceInfoID": "",
"ExpenseStatus": "Draft",
"Status": "active",
"IsExpenseDelete": 0,
"ExpenseTotalAmount": "252.0000",
"ExpenseCost": "250.0000",
"ExpenseDiscount": "2.0000",
"ExpenseOrganization": "Test 1",
"FirstName": "",
"LastName": "",
"ExpenseNotes": "New Expenses added",
"ExpenseNumber": "7089918",
"ExpenseRecurring": 0,
"ExpenseToRecurringExpense": "",
"ContactID": "14025A45-4EA9-4932-8A80-E41A440E16A9",
"CategoryName": "Taxes",
"ContactName": "Test 1",
"Currency": {
"CurrencyLocale": "en_US",
"Code": "INR",
"Symbol": "₹"
}
}
]
}
}
Create Expense
To Create Expense, you need to make a POST call to the following URL:
https://www.mooninvoice.com/api_mi/public/create_expense
parameters for CREATE Expense
required fields
| Field | Type | Description |
|---|---|---|
| CompanyID | String | CompanyID is for create expense of specific Company. |
| ServiceType | Integer | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
| DeviceID | Float | DeviceID is an unique identifier of your device. |
| Date | DateTime | Date of Expense. |
| ExpenseNumber | String | Expense Number. |
| ContactID | String | Contact Identifier. |
optional fields
| Field | Type | Description |
|---|---|---|
| ExpenseCost | Float | Cost of Expense. |
| ExpenseDiscount | Float | Discount on Expense. |
| ExpenseNotes | String | Expense Notes. |
| IsRecurring | Boolean | IsRecurring is a boolean value 0 or 1. If Expense is recurring then 1 otherwise 0. |
| RecurringEndDate | DateTime | End Date of Expense recurring. |
| RecurringIntervalInDay | Integer | No of Days for Expense recurring. |
| RecurringIntervalInString | String | Expense recurring period. Like Daily, Weekly, Fortnightly, Monthly, BiMonthly, Quarterly, 6-Months, Annually, 2-Years |
| PaymentType | String | Type of Payment. Like Visa, Cash etc. |
| SelectedCurrency | String | Selected Currency is code of local currency language. Like en_IN, en_US etc. |
| TotalAmount | Float | Total Amount of Expense. |
| CategoryName | String | Category Name of Expense. |
| AttachmentFile | File | Attachment file of expense. Supported types are png,jpeg,gif,jpg,pdf. |
| TimeZone | String | TimeZone of contact person for Expense. |
| IsRoundOff | Boolean | IsRoundOff is a contain boolean value 1 and 0. Total Amount Round off or not describe. |
| RoundedAmount | String | Total Amount Rounded. |
| UsedTax | Array | UsedTax is multidimensional array and contain all tax data which are applied on expense. |
| - PercentageDec | Float | Tax percentage value. |
| - TaxID | String | Tax Identifier. |
| - TaxName | String | Tax Name. |
Request Sample
Example CREATE Expense JSON Request: {
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"Date": "2022-5-24 13:36:28",
"ExpenseCost": 150,
"ExpenseDiscount": 0,
"ExpenseNotes": "Testing Description",
"ExpenseNumber": "7089902",
"IsRecurring": 0,
"PaymentType": "Cash",
"RecurringEndDate": "2022-5-24 00:00:00",
"SelectedCurrency": "en_US",
"RecurringIntervalDay": 0,
"RecurringIntervalInString": "Day",
"IsRoundOff": 0,
"RoundedAmount": 0,
"TotalAmount": 150,
"ContactID": "2ECBC6EF-8E11-4BEC-B6FD-7AD4F5681AA1",
"CategoryName": "Travel",
"DeviceID": "1093193415.1644912014",
"ServiceType": "1",
"AttachmentFile": "",
"UsedTax": [
{
"PercentageDec": "10.0000",
"TaxID": "95A1956E-E60A-4FAC-8EC4-C88EE7431280",
"TaxName": "Default"
}
],
"TimeZone": "Asia/Calcutta"
}
Response Sample
Result example CREATE Expense JSON Response: {
"status": 200,
"message": "Expense added.",
"data": {
"ExpenseID": "3D3BF53E-4BFA-4961-979C-B9519543BF45",
"DeviceID": "1093193415.1644912014",
"Category": "",
"Date": "2022-05-24 08:06:28",
"ExpenseDiscount": "0.0000",
"ExpenseCost": 150,
"ExpenseNotes": "Expense of invoice description",
"ExpenseNumber": "7089921",
"ExpenseStatus": "Draft",
"ExpenseToUsedTax": "",
"ExpenseToRecurringExpense": "",
"IsRecurring": 0,
"PaymentType": "Cash",
"RecurringEndDate": "2022-05-24 00:00:00",
"RecurringIntervalDay": 0,
"RecurringIntervalInString": "Day",
"SelectedCurrency": "en_US",
"Status": "active",
"ArchiveStatus": 0,
"ExpenseTotalAmount": 150,
"CreatedDate": "2022-06-27 09:29:39",
"SyncDate": "",
"ModificationDate": "2022-06-27 09:29:38",
"CategoryID": "Travel",
"ImageInfoID": "",
"InvoiceInfoID": "",
"ItemlineInfoID": "7EEBE7A8-4090-41D4-8AF4-E6CBDB0EF11B",
"Extra1": "",
"Extra2": "",
"Extra3": "",
"SyncID": "{\"isroundoff\":\"0\",\"rounded_amount\":\"0\"}",
"ContactID": "2ECBC6EF-8E11-4BEC-B6FD-7AD4F5681AA1",
"UsedtaxID": "",
"ExpenseIsDelete": 0,
"CreatedAt": "2022-06-27T09:29:39.000000Z",
"UpdatedAt": "-000001-11-30T00:00:00.000000Z",
"ServiceType": "1",
"ProjectID": "",
"UsedTaxInfo": [
{
"TaxID": "95A1956E-E60A-4FAC-8EC4-C88EE7431280",
"UsedTaxID": "822CDDC2-F072-4D5A-974E-0D738E8FA951",
"Rate": "10.000",
"TaxName": "Default",
"TaxType": "P"
}
],
"ExpenseLogo": "https://mi-doc.s3.amazonaws.com/local/9561/imageinfo/6F3D64B7-4FD2-4105-88C7-5767F8EE6E16_thumb.png?AWSAccessKeyId=AKIA43TXFBRTCBXKZYZ6&Expires=1656323380&Signature=WFbvhnRtRDgcQf2yfQXEIM2xH2Y%3D",
"ExpenseLogoOG": "https://mi-doc.s3.amazonaws.com/local/9561/imageinfo/6F3D64B7-4FD2-4105-88C7-5767F8EE6E16.png?AWSAccessKeyId=AKIA43TXFBRTCBXKZYZ6&Expires=1656323380&Signature=t1MKw%2B0T%2F7lY0z92i6A8%2FPQCogc%3D",
"DateFormate": "May 24, 2022",
"ContactName": "Test",
"ContactFirstLastname": "Test",
"NextRecurring": 0,
"RecurringDay": "",
"RecurringDate": "",
"Currency": {
"CurrencyLocale": "en_US",
"Code": "USD",
"Symbol": "$"
}
}
}
Update Expense
To Update Expense, you need to make a PUT call to the following URL:
https://www.mooninvoice.com/api_mi/public/update_expense
parameters for UPDATE Expense
required fields
| Field | Type | Description |
|---|---|---|
| ExpenseID | String | Expense Identifier. |
| CompanyID | String | CompanyID is for create expense of specific Company. |
| ServiceType | Integer | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
| DeviceID | Float | DeviceID is an unique identifier of your device. |
| Date | DateTime | Date of Expense. |
| ExpenseNumber | String | Expense Number. |
| ContactID | String | Contact Identifier. |
optional fields
| Field | Type | Description |
|---|---|---|
| ExpenseCost | Float | Cost of Expense. |
| ExpenseDiscount | Float | Discount on Expense. |
| ExpenseNotes | String | Expense Notes. |
| IsRecurring | Boolean | IsRecurring is a boolean value 0 or 1. If Expense is recurring then 1 otherwise 0. |
| RecurringEndDate | DateTime | End Date of Expense recurring. |
| RecurringIntervalInDay | Integer | No of Days for Expense recurring. |
| RecurringIntervalInString | String | Expense recurring period. Like Daily, Weekly, Fortnightly, Monthly, BiMonthly, Quarterly, 6-Months, Annually, 2-Years |
| PaymentType | String | Type of Payment. Like Visa, Cash etc. |
| SelectedCurrency | String | Selected Currency is code of local currency language. Like en_IN, en_US etc. |
| TotalAmount | Float | Total Amount of Expense. |
| CategoryName | String | Category Name of Expense. |
| AttachmentFile | File | Attachment file of expense. Supported types are png,jpeg,gif,jpg,pdf. |
| TimeZone | String | TimeZone of contact person for Expense. |
| IsRoundOff | Boolean | IsRoundOff is a contain boolean value 1 and 0. Total Amount Round off or not describe. |
| RoundedAmount | Float | Total Amount Rounded. |
| UsedTax | Array | UsedTax is multidimensional array and contain all tax data which are applied on expense. |
| - PercentageDec | Float | Tax percentage value. |
| - TaxID | String | Tax Identifier. |
| - TaxName | String | Tax Name. |
Request Sample
Example UPDATE Expense JSON Request: {
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"ExpenseID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"Date": "2022-5-24 13:36:28",
"ExpenseCost": 150,
"ExpenseDiscount": 0,
"ExpenseNotes": "Testing Description",
"ExpenseNumber": "7089902",
"IsRecurring": 0,
"PaymentType": "Cash",
"RecurringEndDate": "2022-5-24 00:00:00",
"SelectedCurrency": "en_US",
"RecurringIntervalDay": 0,
"RecurringIntervalInString": "Day",
"IsRoundOff": 0,
"RoundedAmount": 0,
"TotalAmount": 150,
"ContactID": "2ECBC6EF-8E11-4BEC-B6FD-7AD4F5681AA1",
"CategoryName": "Travel",
"DeviceID": "1093193415.1644912014",
"ServiceType": "1",
"AttachmentFile": "",
"UsedTax": [
{
"PercentageDec": "10.0000",
"TaxID": "95A1956E-E60A-4FAC-8EC4-C88EE7431280",
"TaxName": "Default"
}
],
"TimeZone": "Asia/Calcutta"
}
Result example Expense UPDATE JSON Response: {
"status": 200,
"message": "Expense updated.",
"data": {
"ExpenseID": "2CDF9243-9091-4076-A750-F74AF733632A",
"DeviceID": "1093193415.1644912014",
"Category": "",
"Date": "2022-05-24 08:06:28",
"ExpenseDiscount": "0.0000",
"ExpenseCost": 150,
"ExpenseNotes": "Testing Description update",
"ExpenseNumber": "7089917",
"ExpenseStatus": "Draft",
"ExpenseToUsedTax": "",
"ExpenseToRecurringExpense": "",
"IsRecurring": 0,
"PaymentType": "Cash",
"RecurringEndDate": "2022-05-24 00:00:00",
"RecurringIntervalDay": 0,
"RecurringIntervalInString": "Day",
"SelectedCurrency": "en_US",
"Status": "active",
"ArchiveStatus": 0,
"ExpenseTotalAmount": 150,
"CreatedDate": "2022-06-27 10:08:45",
"SyncDate": "",
"ModificationDate": "2022-06-27 10:08:43",
"CategoryID": "Travel",
"ImageInfoID": "",
"InvoiceInfoID": "",
"ItemlineInfoID": "EEF090DF-D06D-499C-ABE9-7417289E2CA5",
"Extra1": "",
"Extra2": "",
"Extra3": "",
"SyncID": "{\"isroundoff\":\"0\",\"rounded_amount\":\"0\"}",
"ContactID": "2ECBC6EF-8E11-4BEC-B6FD-7AD4F5681AA1",
"UsedtaxID": "",
"ExpenseIsDelete": 0,
"CreatedAt": "2022-06-27T10:08:45.000000Z",
"UpdatedAt": "2022-06-27T10:08:45.000000Z",
"ServiceType": "1",
"ProjectID": "",
"UsedTaxInfo": [
{
"TaxID": "95A1956E-E60A-4FAC-8EC4-C88EE7431280",
"UsedTaxID": "A4BE0194-71E5-4A7E-A67D-754B31A6D9BE",
"Rate": "10.000",
"TaxName": "Default",
"TaxType": "P"
}
],
"ExpenseLogo": "https://mi-doc.s3.amazonaws.com/local/9561/imageinfo/0EB7BACF-047A-4EA8-A816-838D4B4387A9_thumb.png?AWSAccessKeyId=AKIA43TXFBRTCBXKZYZ6&Expires=1656325725&Signature=qzUfW4G47%2F5jChd9%2Fdz47UocciY%3D",
"ExpenseLogoOG": "https://mi-doc.s3.amazonaws.com/local/9561/imageinfo/0EB7BACF-047A-4EA8-A816-838D4B4387A9.png?AWSAccessKeyId=AKIA43TXFBRTCBXKZYZ6&Expires=1656325725&Signature=V9qSdo8vYdtDFP8XBtOPXvtt40s%3D",
"DateFormate": "May 24, 2022",
"ContactName": "Test",
"ContactFirstLastname": "Test",
"NextRecurring": 0,
"RecurringDay": "",
"RecurringDate": "",
"Currency": {
"CurrencyLocale": "en_US",
"Code": "USD",
"Symbol": "$"
}
}
}
Details Expense
To Get Expense Details, you need to make a GET call to the following URL:
https://www.mooninvoice.com/api_mi/public/expense_details
parameters for DETAILS Expense
required fields
| Field | Type | Description |
|---|---|---|
| CompanyID | String | CompanyID is for details of expense of specific Company. |
| ServiceType | String | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
| ExpenseID | String | Expense Identifier. |
Response Sample
Example DETAILS Expense JSON Request: {
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"ExpenseID": "4208B04F-6480-438A-8A05-4ED5D0D4DD3E",
"ServiceType": "1"
}
Result example DETAILS Expense JSON Response: {
"status": 200,
"message": "Data received.",
"data": {
"ExpenseID": "4208B04F-6480-438A-8A05-4ED5D0D4DD3E",
"DeviceID": "1093193415.1644912014",
"Category": "",
"Date": "2022-05-24 08:06:28",
"ExpenseDiscount": "0.0000",
"ExpenseCost": 150,
"ExpenseNotes": "Expense of invoice description",
"ExpenseNumber": "7089922",
"ExpenseStatus": "Draft",
"ExpenseToUsedTax": "",
"ExpenseToRecurringExpense": "",
"IsRecurring": 0,
"PaymentType": "Cash",
"RecurringEndDate": "2022-05-24 00:00:00",
"RecurringIntervalDay": 0,
"RecurringIntervalInString": "Day",
"SelectedCurrency": "en_US",
"Status": "active",
"ArchiveStatus": 0,
"ExpenseTotalAmount": 150,
"CreatedDate": "2022-06-27 09:35:18",
"SyncDate": "",
"ModificationDate": "2022-06-27 09:35:14",
"CategoryID": "Travel",
"ImageInfoID": "",
"InvoiceInfoID": "",
"ItemlineInfoID": "1FEF082F-1218-4548-A45C-D3394413724B",
"Extra1": "",
"Extra2": "",
"Extra3": "",
"SyncID": "{\"isroundoff\":\"0\",\"rounded_amount\":\"0\"}",
"ContactID": "2ECBC6EF-8E11-4BEC-B6FD-7AD4F5681AA1",
"UsedtaxID": "",
"ExpenseIsDelete": 0,
"CreatedAt": "2022-06-27T09:35:18.000000Z",
"UpdatedAt": "-000001-11-30T00:00:00.000000Z",
"ServiceType": "1",
"ProjectID": "",
"UsedTaxInfo": [
{
"TaxID": "95A1956E-E60A-4FAC-8EC4-C88EE7431280",
"UsedTaxID": "2AED1066-0FBE-4AA4-A82A-C0FBC9EE4B16",
"Rate": "10.000",
"TaxName": "Default",
"TaxType": "P"
}
],
"ExpenseLogo": "https://mi-doc.s3.amazonaws.com/local/9561/imageinfo/13135949-2C0A-413E-856E-BF243D52571A_thumb.png?AWSAccessKeyId=AKIA43TXFBRTCBXKZYZ6&Expires=1656325989&Signature=SW5NlCVOle9MPa6J%2BxzwQVIIx3w%3D",
"ExpenseLogoOG": "https://mi-doc.s3.amazonaws.com/local/9561/imageinfo/13135949-2C0A-413E-856E-BF243D52571A.png?AWSAccessKeyId=AKIA43TXFBRTCBXKZYZ6&Expires=1656325989&Signature=tJOnw59ISd9uy9OTEzKAy79peNQ%3D",
"DateFormate": "May 24, 2022",
"ContactName": "Test",
"ContactFirstLastname": "Test",
"NextRecurring": 0,
"RecurringDay": "",
"RecurringDate": "",
"Currency": {
"CurrencyLocale": "en_US",
"Code": "USD",
"Symbol": "$"
}
}
}
Delete Expense
To Delete Expense, you need to make a DELETE call to the following URL:
https://www.mooninvoice.com/api_mi/public/expense_delete
parameters for DELETE Expense
required fields
| Field | Type | Description |
|---|---|---|
| CompanyID | String | CompanyID is for delete expense of specific Company. |
| ServiceType | Integer | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
| ExpenseID | String | Expense Identifier. |
| DeviceID | Float | DeviceID is an unique identifier of your device. |
Request Sample
Example DELETE Expense JSON Request: {
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"ExpenseID": "4208B04F-6480-438A-8A05-4ED5D0D4DD3E",
"ServiceType": "1",
"DeviceID":"1093193415.1644912014"
}
Response Sample
Result example DELETE Expense JSON Response: {
"status": 200,
"message": "1 expense(s) move to trash.",
"data": []
}
Get Sales Receipt
To Get Sales Receipt, you need to make a GET call to the following URL:
https://www.mooninvoice.com/api_mi/public/salesreceipt_list
parameters for GET Sales Receipt
required fields
| Field | Type | Description |
|---|---|---|
| SalesReceiptSort | String | SalesReceiptSort is for sorting record by ascending or decending order wise record. SalesReceiptSort must be contain asc or desc value. |
| PageSize | Integer | PageSize is for size of per page record. |
| CompanyID | String | CompanyId is for get record by specific Company. |
| ServiceType | Integer | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
optional fields
| Field | Type | Description |
|---|---|---|
| page | Integer | Enter page no. for get page wise records. |
Request Sample
Example GET Sales Receipt JSON Request: {
"SalesReceiptSort": "desc",
"PageSize": 25,
"page": 1,
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"ServiceType": "1"
}
Response Sample
Result example GET Sales Receipt JSON Response: {
"status": 200,
"message": "Data received.",
"data": {
"current_page": 1,
"first_page_url": "https://www.mooninvoice.com/api_mi/public/salesreceipt_list?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "https://www.mooninvoice.com/api_mi/public/salesreceipt_list?page=1",
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "https://www.mooninvoice.com/api_mi/public/salesreceipt_list?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
],
"next_page_url": null,
"path": "https://www.mooninvoice.com/api_mi/public/salesreceipt_list",
"per_page": 25,
"prev_page_url": null,
"to": 16,
"total": 16,
"sales_receipts": [
{
"SalesReceiptID": "BB4D8A31-8886-4DF3-B40F-A76C598177B1",
"SalesReceiptEntryDate": "2022-06-27 12:48:33",
"SelectedCurrency": "en_US",
"CreatedAt": "2022-06-27T12:49:44.000000Z",
"SalesReceiptStatus": "Paid",
"Status": "active",
"IsInvoiceDelete": 0,
"SalesReceiptTotal": "356.0000",
"SalesReceiptTerms": "Test Terms",
"SalesReceiptHeader": "New Sales Receipt Generate",
"SalesReceiptOrganization": "Firmi",
"FirstName": "Firmi name",
"LastName": "Firmi Last",
"SalesReceiptId": 0,
"SalesReceiptNotes": "Test Notes",
"SalesReceiptNumber": "37",
"SalesReceiptRecurring": 0,
"SalesReceiptSubTotal": "323.0000",
"SalesReceiptAmountPaid": "356.0000",
"SalesReceiptToRecurringInvoice": "",
"IsPaypalPayment": 0,
"SalesReceiptFolder": "{\"payment_str\":\"\",\"isroundoff\":\"0\",\"rounded_amount\":\"0\",\"Billing\":\"1\",\"Billing_Add\":{\"Street1\":\"st123456\",\"Street2\":\"st218975\",\"City\":\"BarodaA\",\"State\":\"GUJARATS\",\"Country\":\"India\",\"Zip\":\"505005\"},\"Secondary\":\"0\",\"Secondary_Add\":{\"Street1\":\"\",\"Street2\":\"\",\"City\":\"\",\"State\":\"\",\"Country\":\"\",\"Zip\":\"\"},\"Percentage\":\"0\",\"depositeAmount\":\"0.00\"}",
"ContactID": "710EF861-076C-4AD2-876D-AFAF4AF75E6C",
"PaypalEmail": "",
"AmountDue": "0.0000",
"SalesReceiptDueDate": "2022-06-27 12:48:33",
"CompanyName": "Web64 Test",
"TotalDueAmount": "0.0000",
"TotalPaidAmount": "356.0000",
"ContactName": "Firmi",
"CustomerEmail": "rainsfirmima@email.com",
"Currency": {
"CurrencyLocale": "en_US",
"Code": "INR",
"Symbol": "₹"
}
},
{
"SalesReceiptID": "45D74D29-3E95-4503-9204-59C08EF441EA",
"SalesReceiptEntryDate": "2022-05-31 05:28:19",
"SelectedCurrency": "en_US",
"CreatedAt": "2022-05-31T05:29:21.000000Z",
"SalesReceiptStatus": "Paid",
"Status": "active",
"IsInvoiceDelete": 0,
"SalesReceiptTotal": "225.6000",
"SalesReceiptTerms": "Terms and test",
"SalesReceiptHeader": "Test Firmi",
"SalesReceiptOrganization": "Firmi",
"FirstName": "Firmi name",
"LastName": "Firmi Last",
"SalesReceiptId": 0,
"SalesReceiptNotes": "Notes",
"SalesReceiptNumber": "15",
"SalesReceiptRecurring": 0,
"SalesReceiptSubTotal": "196.0000",
"SalesReceiptAmountPaid": "225.6000",
"SalesReceiptToRecurringInvoice": "",
"IsPaypalPayment": 0,
"SalesReceiptFolder": "{\"payment_str\":\"\",\"isroundoff\":0,\"rounded_amount\":0,\"Billing\":\"1\",\"Billing_Add\":{\"Street1\":\"st123456\",\"Street2\":\"st218975\",\"City\":\"BarodaA\",\"State\":\"GUJARATS\",\"Country\":\"India\",\"Zip\":\"505005\"},\"Secondary\":\"0\",\"Secondary_Add\":{\"Street1\":\"\",\"Street2\":\"\",\"City\":\"\",\"State\":\"\",\"Country\":\"\",\"Zip\":\"\"},\"Percentage\":\"0\",\"depositeAmount\":\"0.00\"}",
"ContactID": "710EF861-076C-4AD2-876D-AFAF4AF75E6C",
"PaypalEmail": "",
"AmountDue": "0.0000",
"SalesReceiptDueDate": "2022-05-31 05:28:19",
"CompanyName": "Web64 Test",
"TotalDueAmount": "0.0000",
"TotalPaidAmount": "225.6000",
"ContactName": "Firmi",
"CustomerEmail": "rainsfirmima@email.com",
"Currency": {
"CurrencyLocale": "en_US",
"Code": "INR",
"Symbol": "₹"
}
}
]
}
}
Create Sales Receipt
To Create Sales Receipt, you need to make a POST call to the following URL:
https://www.mooninvoice.com/api_mi/public/create_salesreceipt
parameters for CREATE Sales Receipt
required fields
| Field | Type | Description |
|---|---|---|
| CompanyID | String | CompanyId is for create invoice of specific Company. |
| ContactID | String | Contact Identifier of Sales Receipt. |
| SalesReceiptNumber | String | Sales Receipt Number. |
| EntryDate | DateTime | Entry Date of Sales Receipt. |
| DueDate | DateTime | Payment Due Date of Sales Receipt. |
| ServiceType | Integer | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
optional fields
| Field | Type | Description |
|---|---|---|
| PaymentType | String | Type of Payment. |
| PaymentNumber | String | Payment Number. |
| Terms | String | Terms of Sales Receipt. |
| Notes | String | Notes/Description of Sales Receipt. |
| SalesReceiptHeader | Float | Title or Header of Sales Receipt. |
| ShippingCost | Float | Shipping Cost of Sales Receipt. |
| ShippingMethod | String | Shipping Method of Sales Receipt. |
| PoNo | String | PO No of Sales Receipt. |
| DiscountDec | Float | Discont on Sales Receipt total. |
| IsRecurring | Boolean | IsRecurring is a boolean value 0 or 1. If Sales Receipt is recurring then 1 otherwise 0. |
| RecurringEnddate | DateTime | End Date of Sales Receipt recurring. |
| RecurringIntervalInDay | Integer | No of Days for Sales Receipt recurring. |
| RecurringIntervalInString | String | Sales Receipt recurring period. Like Daily, Weekly, Fortnightly, Monthly, BiMonthly, Quarterly, 6-Months, Annually, 2-Years |
| TotalAmount | Float | Total Amount of Sales Receipt. |
| SubTotal | Float | Sub Total Amount of Sales Receipt. |
| AmountDue | Float | Remaining Payment Amount of Sales Receipt. |
| IsPaypalPayment | Boolean | IsPaypalPayment is contain boolean value 0 or 1. |
| AmountPaid | Float | Total Paid Amount of Sales Receipt. |
| SelectedCurrency | String | Selected Currency is code of local currency language. Like en_IN, en_US etc. |
| AttachmentFile | File | Sales Receipt Attachment File. |
| PaypalEmail | String | Paypal Email of Sales Receipt. |
| TimeZone | String | TimeZone of contact person for Sales Receipt. |
| SalesReceiptFolder | Array | Purchase Order Identifier. |
isroundoff |
Boolean | isroundoff is a contain boolean value 1 and 0. isroundoff is a rounded amount of Sales Receipt. |
rounded_amount |
Float | Rounded amount of Sales Receipt. |
Percentage |
Float | Discount Percentage from total amount of Sales Receipt. |
depositeAmount |
Float | Deposite Amount of Sales Receipt. |
Billing_Add |
Array | Billing_Add is array and contain below fields. |
Street1 |
String | Billing Address Street1. |
Street2 |
String | Billing Address Street2 |
City |
String | Billing Address City |
State |
String | Billing Address State |
Country |
String | Billing Address Country |
Zip |
String | Billing Address Zip |
Secondary_Add |
Array | Secondary_Add is array and contain below fields. |
Street1 |
String | Shipping Address Street1. |
Street2 |
String | Shipping Address Street2 |
City |
String | Shipping Address City |
State |
String | Shipping Address State |
Country |
String | Shipping Address Country |
Zip |
String | Shipping Address Zip |
| ProductData | Array | Product Data is a contain array of all product of invoice. ProductData contain multidimensional array. |
ProductName |
String | Name of Product. |
Quantity |
Integer | Quantity of Product. |
UnitCost |
Float | Selling price of Product. |
ProductNotes |
String | Product Notes. |
ProductID |
String | Product Identifier. |
Total |
String | Total Amount of Product. |
SubAmount |
String | SubAmount of Product. |
DiscountIsPercentage |
Boolean | Discount on product is in percetage or not. If in percentage then 1 otherwise 0. |
ProductType |
String | Type of product like kg, piece, liter etc. |
DiscountValue |
String | Discount amount |
TaxUpdate |
Boolean | TaxUpdate is a contain boolean value. If Tax Update then 1 otherwise 0. |
StockUpdate |
Boolean | StockUpdate is a contain boolean value. If Tax Update then 1 otherwise 0. |
TaxID |
Array | Array of Tax ID which is apply on product. Like ["95A1956E-E60A-4FAC-8EC4-C88EE7431280"] |
ItemlineToTaxList |
Array | ItemlineToTaxList is multidimensional array and contain all tax data which are applied on product. |
ItemlineToTaxListID |
String | Identifier of TAX. |
PercentageDec |
Float | Tax percentage of product. |
Name |
String | Name of Tax. |
| TaskData | Array | Task Data is a contain array of all task of invoice. TaskData contain multidimensional array. |
TaskName |
String | Name of Task. |
Hours |
Float | Total hours of task for invoice. |
TaskRate |
Float | Rate of task. |
TimeNotes |
String | Task Notes. |
TaskID |
String | Task Identifier. |
Total |
Float | Total amount of task. |
DiscountIsPercentage |
Boolean | Discount on task is in percetage or not. If in percentage then 1 otherwise 0. |
TaskType |
String | Type of task. |
DiscountValue |
String | Dicount value on task in percentage. Like 1P, 2P etc. |
TaxID |
Array | Array of Tax ID which is apply on tax. Like ["95A1956E-E60A-4FAC-8EC4-C88EE7431280"] |
TasklineToTax |
Array | TasklineToTax contains a tax details array with the below fields. |
TasklineToTaxID |
String | TaxID of task tax. |
PercentageDec |
Float | Tax percentage of task. |
Name |
String | Name of tax. |
Request Sample
Example CREATE Sales Receipt JSON Request: {
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"PaymentType": "Cash",
"PaymentNumber": 1,
"SalesReceiptNumber": "29",
"SalesReceiptHeader": "Public Test and Test Again default",
"ShippingCost": 5,
"ShippingMethod": "Standard Ground",
"PoNo": "",
"DiscountDec": "0.00",
"Terms": "terms",
"Notes": "notes",
"EntryDate": "2022-4-27 10:58:52",
"DueDate": "2022-4-27 10:58:52",
"IsRecurring": 0,
"RecurringEnddate": "0000-00-00",
"RecurringIntervalInDay": 0,
"RecurringIntervalInString": "",
"TotalAmount": "215.6",
"SubTotal": 196,
"AmountDue": 0,
"IsPaypalPayment": 0,
"AmountPaid": "215.6",
"SalesReceiptFolder": {
"isroundoff": 0,
"rounded_amount": 0,
"Billing_Add": {
"Street1": "ST145",
"Street2": "St5656",
"City": "Ahemdabad",
"State": "Gujarat",
"Country": "India",
"Zip": "360005"
},
"Secondary_Add": {
"Street1": "",
"Street2": "",
"City": "",
"State": "",
"Country": "",
"Zip": ""
},
"Percentage": "0",
"depositeAmount": "0.00"
},
"DeviceID": "1093193415.1644912014",
"ContactID": "5ACC3AEF-8EAB-4DB1-B709-279261C59E0C",
"SelectedCurrency": "en_US",
"PaypalEmail": "",
"AttachmentFile": "FILE DATA",
"AttachmentType": "4",
"ProductData": [
{
"ProductName": "Green Book",
"Quantity": 1,
"UnitCost": "186.00",
"ProductNotes": "Testing Travel",
"ProductID": "",
"Total": 186,
"SubAmount": 186,
"DiscountIsPercentage": "1",
"ProductType": "kg",
"DiscountValue": "3P",
"StockUpdate": 1,
"ItemlineToTaxList": [
{
"ItemlineToTaxListID": "95A1956E-E60A-4FAC-8EC4-C88EE7431280",
"PercentageDec": "10.0000",
"Name": "Default"
}
],
"TaxID": [
"95A1956E-E60A-4FAC-8EC4-C88EE7431280"
],
"orderindex": 1
}
],
"TaskData": [
{
"TaskName": "Task1",
"Hours": "1.00",
"TaskRate": "10.00",
"TimeNotes": "",
"TaskID": "",
"Total": 10,
"DiscountIsPercentage": "1",
"DiscountValue": "6P",
"TasklineToTax": [
{
"TasklineToTaxID": "95A1956E-E60A-4FAC-8EC4-C88EE7431280",
"PercentageDec": "10.0000",
"Name": "Default"
}
],
"TaxID": [
"95A1956E-E60A-4FAC-8EC4-C88EE7431280"
],
"TaskType": "Hours",
"orderindex": 2
}
],
"UsedTax": [],
"ServiceType": "1",
"TimeZone": "Asia/Calcutta"
}
Response Sample
Result example CREATE Sales Receipt JSON Response: {
"status": 200,
"message": "Sales Receipt Added",
"data": {
"PaymentType": "",
"IsPaypalPayment": 0,
"IsRecurring": 0,
"RecurringIntervalInDay": "0",
"SalesReceiptToExpense": "",
"SalesReceiptToImageInfo": "",
"SalesReceiptToRecurringExpense": "",
"SalesReceiptToItemline": "",
"SalesReceiptToPayment": "",
"ContactID": "0B505706-B5F2-435B-B2AF-7DD81B89893C",
"ExpenseID": "",
"SalesReceiptToUsedtax": "",
"SalesReceiptToRecurringInvoice": "",
"SalesReceiptToTablelist": null,
"SalesReceiptDueDate": "2022-05-18 12:40:27",
"SalesReceiptEntryDate": "2022-05-18 12:40:27",
"ModificationDate": "2022-06-27 11:54:36",
"RecurringEndDate": "0000-00-00 00:00:00",
"AmountDue": 0,
"AmountPaid": 0,
"DiscountDec": 0,
"ShippingCost": 5,
"SubTotal": 313.8,
"Total": 356.8,
"Discount": "A|N",
"DiscountValue": "",
"Extra1": "",
"Extra2": "",
"Extra3": "",
"SalesReceiptFolder": "{\"payment_str\":\"cash\",\"isroundoff\":{\"Zip\":\"\"},\"rounded_amount\":\"\",\"Billing\":\"0\",\"Billing_Add\":{\"Street1\":\"\",\"Street2\":\"\",\"City\":\"\",\"State\":\"\",\"Country\":\"\"},\"Secondary\":\"0\",\"Secondary_Add\":{\"Street1\":\"\",\"Street2\":\"\",\"City\":\"\",\"State\":\"\",\"Country\":\"\",\"Zip\":\"\"},\"Percentage\":\"0\",\"depositeAmount\":\"0.00\"}",
"SalesReceiptHeader": "Sales Receipt 36",
"SalesReceiptStatus": "Paid",
"SalesReceiptNotes": "",
"SalesReceiptNumber": "36",
"SalesReceiptPoNo": "",
"RecurringIntervalInString": "",
"SelectedCurrency": "en_IN",
"SelectedTemplate": "",
"ShippingMethod": "Standard Ground",
"ArchiveStatus": 0,
"Status": "active",
"SyncID": "",
"TaxValue": "",
"SalesReceiptTerms": "",
"SalesReceiptID": "2F284208-E687-4CD4-9A62-E8431F109068",
"DeviceID": "1093193415.1644912014",
"CreatedDate": "2022-06-27 11:54:39",
"SyncDate": "",
"SalesReceiptIsDelete": 0,
"CreatedAt": "2022-06-27T11:54:39.000000Z",
"UpdatedAt": "2022-06-27T11:54:39.000000Z",
"ServiceType": "1",
"Type": 1,
"PaymentTypes": null,
"Extra4": "",
"Extra5": "",
"Extra6": "",
"UsedDiscountInfo": [],
"CustomerEmail": "pp@yopmail.com",
"CompanyId": "8D5D856F-E370-45CC-8128-11EB9801805D",
"IsCreditNote": 0,
"PaynowLink": "",
"DueDateFormat": "May 18, 2022",
"EntryDateFormat": "May 18, 2022",
"OutStanding": [
{
"symbol": "$",
"code": "USD",
"currencylocale": "en_US",
"amount": 0,
"amount_f": "$0.00"
}
],
"ContactName": "aaa",
"ContactFirstLastname": "pp pp",
"NextRecurring": 0,
"RecurringDay": "",
"RecurringDate": "",
"PaypalEmail": "",
"EmailFontName": "Arial",
"EmailFontSize": 12,
"Attachment": "https://mi-doc.s3.amazonaws.com/local/9561/imageinfo/DB711697-081B-467D-8518-3A407E771DD8.png?AWSAccessKeyId=AKIA43TXFBRTCBXKZYZ6&Expires=1656332081&Signature=93Mr1%2F8tP%2BVYA9h7kCd48gw1n8A%3D",
"Products": [
{
"ProductID": "182BA686-499F-4B07-9040-83E3A6B23225",
"InvoiceProductID": "10E9DE78-100D-4F0A-ACA9-79CD0364D376",
"ProductName": "Black Shirt",
"ModificationDate": "2022-06-27 11:54:40",
"Quantity": 2,
"Total": 304,
"UnitCost": 160,
"DiscountIsPercentage": 1,
"DiscountValue": "5",
"ProductNotes": "Black Shirt update test",
"ProductImage": "",
"TaxID": "95A1956E-E60A-4FAC-8EC4-C88EE7431280"
}
],
"Tasks": [
{
"TaskID": "2908192A-85C7-49D8-A18F-502782EC2EAE",
"InvoiceTaskID": "3660C2FB-5142-4A14-A310-9FE25B2B3917",
"taskName": "Task1",
"ModificationDate": "2022-06-27 11:54:40",
"Hours": 1,
"Total": 9.8,
"Rate": 10,
"DiscountIsPercentage": 1,
"DiscountValue": "2",
"TaskNotes": "",
"TaxID": "95A1956E-E60A-4FAC-8EC4-C88EE7431280"
}
]
}
}
Update Sales Receipt
To Update Sales Receipt, you need to make a PUT call to the following URL:
https://www.mooninvoice.com/api_mi/public/update_estimate
parameters for UPDATE Sales Receipt
required fields
| Field | Type | Description |
|---|---|---|
| SalesReceiptID | String | Sales Receipt Identifier. |
| CompanyID | String | CompanyId is for create invoice of specific Company. |
| ContactID | String | Contact Identifier of Sales Receipt. |
| SalesReceiptNumber | String | Sales Receipt Number. |
| EntryDate | DateTime | Entry Date of Sales Receipt. |
| DueDate | DateTime | Payment Due Date of Sales Receipt. |
| ServiceType | Integer | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
optional fields
| Field | Type | Description |
|---|---|---|
| PaymentType | String | Type of Payment. |
| PaymentNumber | String | Payment Number. |
| Terms | String | Terms of Sales Receipt. |
| Notes | String | Notes/Description of Sales Receipt. |
| SalesReceiptHeader | Float | Title or Header of Sales Receipt. |
| ShippingCost | Float | Shipping Cost of Sales Receipt. |
| ShippingMethod | String | Shipping Method of Sales Receipt. |
| PoNo | String | PO No of Sales Receipt. |
| DiscountDec | Float | Discont on Sales Receipt total. |
| IsRecurring | Boolean | IsRecurring is a boolean value 0 or 1. If Sales Receipt is recurring then 1 otherwise 0. |
| RecurringEnddate | DateTime | End Date of Sales Receipt recurring. |
| RecurringIntervalInDay | Integer | No of Days for Sales Receipt recurring. |
| RecurringIntervalInString | String | Sales Receipt recurring period. Like Daily, Weekly, Fortnightly, Monthly, BiMonthly, Quarterly, 6-Months, Annually, 2-Years |
| TotalAmount | Float | Total Amount of Sales Receipt. |
| SubTotal | Float | Sub Total Amount of Sales Receipt. |
| AmountDue | Float | Remaining Payment Amount of Sales Receipt. |
| IsPaypalPayment | Boolean | IsPaypalPayment is contain boolean value 0 or 1. |
| AmountPaid | Float | Total Paid Amount of Sales Receipt. |
| SelectedCurrency | String | Selected Currency is code of local currency language. Like en_IN, en_US etc. |
| AttachmentFile | File | Sales Receipt Attachment File. |
| PaypalEmail | String | Paypal Email of Sales Receipt. |
| TimeZone | String | TimeZone of contact person for Sales Receipt. |
| SalesReceiptFolder | Array | Sales Receipt folder is contains array with the below fields. |
isroundoff |
Boolean | isroundoff is a contain boolean value 1 and 0. isroundoff is a rounded amount of Sales Receipt. |
rounded_amount |
Float | Rounded amount of Sales Receipt. |
Percentage |
Float | Discount Percentage from total amount of Sales Receipt. |
depositeAmount |
Float | Deposite Amount of Sales Receipt. |
Billing_Add |
Array | Billing_Add is array and contain below fields. |
Street1 |
String | Billing Address Street1. |
Street2 |
String | Billing Address Street2 |
City |
String | Billing Address City |
State |
String | Billing Address State |
Country |
String | Billing Address Country |
Zip |
String | Billing Address Zip |
Secondary_Add |
Array | Secondary_Add is array and contain below fields. |
Street1 |
String | Shipping Address Street1. |
Street2 |
String | Shipping Address Street2 |
City |
String | Shipping Address City |
State |
String | Shipping Address State |
Country |
String | Shipping Address Country |
Zip |
String | Shipping Address Zip |
| ProductData | Array | Product Data is a contain array of all product of invoice. ProductData contain multidimensional array. |
ProductName |
String | Name of Product. |
Quantity |
Integer | Quantity of Product. |
UnitCost |
Float | Selling price of Product. |
ProductNotes |
String | Product Notes. |
ProductID |
String | Product Identifier. |
Total |
String | Total Amount of Product. |
SubAmount |
String | SubAmount of Product. |
DiscountIsPercentage |
Boolean | Discount on product is in percetage or not. If in percentage then 1 otherwise 0. |
ProductType |
String | Type of product like kg, piece, liter etc. |
DiscountValue |
String | Discount amount |
TaxUpdate |
Boolean | TaxUpdate is a contain boolean value. If Tax Update then 1 otherwise 0. |
StockUpdate |
Boolean | StockUpdate is a contain boolean value. If Tax Update then 1 otherwise 0. |
TaxID |
Array | Array of Tax ID which is apply on product. Like ["95A1956E-E60A-4FAC-8EC4-C88EE7431280"] |
ItemlineToTaxList |
Array | ItemlineToTaxList is multidimensional array and contain all tax data which are applied on product. |
ItemlineToTaxListID |
String | Identifier of TAX. |
PercentageDec |
Float | Tax percentage of product. |
Name |
String | Name of Tax. |
| TaskData | Array | Task Data is a contain array of all task of invoice. TaskData contain multidimensional array. |
TaskName |
String | Name of Task. |
Hours |
Float | Total hours of task for invoice. |
TaskRate |
Float | Rate of task. |
TimeNotes |
String | Task Notes. |
TaskID |
String | Task Identifier. |
Total |
Float | Total amount of task. |
DiscountIsPercentage |
Boolean | Discount on task is in percetage or not. If in percentage then 1 otherwise 0. |
TaskType |
String | Type of task. |
DiscountValue |
String | Dicount value on task in percentage. Like 1P, 2P etc. |
TaxID |
Array | Array of Tax ID which is apply on tax. Like ["95A1956E-E60A-4FAC-8EC4-C88EE7431280"] |
TasklineToTax |
Array | TasklineToTax contains a tax details array with the below fields. |
TasklineToTaxID |
String | TaxID of task tax. |
PercentageDec |
Float | Tax percentage of task. |
Name |
String | Name of tax. |
Request Sample
Example UPDATE Sales Receipt JSON Request: {
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"SalesReceiptID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"PaymentType": "Cash",
"PaymentNumber": 1,
"SalesReceiptNumber": "29",
"SalesReceiptHeader": "Public Test and Test Again default",
"ShippingCost": 5,
"ShippingMethod": "Standard Ground",
"PoNo": "",
"DiscountDec": "0.00",
"Terms": "terms",
"Notes": "notes",
"EntryDate": "2022-4-27 10:58:52",
"DueDate": "2022-4-27 10:58:52",
"IsRecurring": 0,
"RecurringEnddate": "0000-00-00",
"RecurringIntervalInDay": 0,
"RecurringIntervalInString": "",
"TotalAmount": "215.6",
"SubTotal": 196,
"AmountDue": 0,
"IsPaypalPayment": 0,
"AmountPaid": "215.6",
"SalesReceiptFolder": {
"isroundoff": 0,
"rounded_amount": 0,
"Billing_Add": {
"Street1": "ST145",
"Street2": "St5656",
"City": "Ahemdabad",
"State": "Gujarat",
"Country": "India",
"Zip": "360005"
},
"Secondary_Add": {
"Street1": "",
"Street2": "",
"City": "",
"State": "",
"Country": "",
"Zip": ""
},
"Percentage": "0",
"depositeAmount": "0.00"
},
"DeviceID": "1093193415.1644912014",
"ContactID": "5ACC3AEF-8EAB-4DB1-B709-279261C59E0C",
"SelectedCurrency": "en_US",
"PaypalEmail": "",
"AttachmentFile": "FILE DATA",
"AttachmentType": "4",
"ProductData": [
{
"ProductName": "Green Book",
"Quantity": 1,
"UnitCost": "186.00",
"ProductNotes": "Testing Travel",
"ProductID": "",
"Total": 186,
"SubAmount": 186,
"DiscountIsPercentage": "1",
"ProductType": "kg",
"DiscountValue": "3P",
"StockUpdate": 1,
"ItemlineToTaxList": [
{
"ItemlineToTaxListID": "95A1956E-E60A-4FAC-8EC4-C88EE7431280",
"PercentageDec": "10.0000",
"Name": "Default"
}
],
"TaxID": [
"95A1956E-E60A-4FAC-8EC4-C88EE7431280"
],
"orderindex": 1
}
],
"TaskData": [
{
"TaskName": "Task1",
"Hours": "1.00",
"TaskRate": "10.00",
"TimeNotes": "",
"TaskID": "",
"Total": 10,
"DiscountIsPercentage": "1",
"DiscountValue": "6P",
"TasklineToTax": [
{
"TasklineToTaxID": "95A1956E-E60A-4FAC-8EC4-C88EE7431280",
"PercentageDec": "10.0000",
"Name": "Default"
}
],
"TaxID": [
"95A1956E-E60A-4FAC-8EC4-C88EE7431280"
],
"TaskType": "Hours",
"orderindex": 2
}
],
"UsedTax": [],
"ServiceType": "1",
"TimeZone": "Asia/Calcutta"
}
Response Sample
Result example UPDATE Sales Receipt JSON Response:
{
"status": 200,
"message": "SalesReceipt Updated",
"data": {
"PaymentType": "",
"IsPaypalPayment": 0,
"IsRecurring": 0,
"RecurringIntervalInDay": "0",
"SalesReceiptToExpense": "",
"SalesReceiptToImageInfo": "",
"SalesReceiptToRecurringExpense": "",
"SalesReceiptToItemline": "",
"SalesReceiptToPayment": "",
"ContactID": "0B505706-B5F2-435B-B2AF-7DD81B89893C",
"ExpenseID": "",
"SalesReceiptToUsedtax": "",
"SalesReceiptToRecurringInvoice": "",
"SalesReceiptToTablelist": null,
"SalesReceiptDueDate": "2022-05-18 12:40:27",
"SalesReceiptEntryDate": "2022-05-18 12:40:27",
"ModificationDate": "2022-06-27 13:14:39",
"RecurringEndDate": "0000-00-00 00:00:00",
"AmountDue": 0,
"AmountPaid": 0,
"DiscountDec": 0,
"ShippingCost": 5,
"SubTotal": 313.8,
"Total": 356.8,
"Discount": "A|N",
"DiscountValue": "",
"Extra1": "",
"Extra2": "",
"Extra3": "",
"SalesReceiptFolder": "{\"payment_str\":\"cash\",\"isroundoff\":{\"Zip\":\"\"},\"rounded_amount\":\"\",\"Billing\":\"0\",\"Billing_Add\":{\"Street1\":\"\",\"Street2\":\"\",\"City\":\"\",\"State\":\"\",\"Country\":\"\"},\"Secondary\":\"0\",\"Secondary_Add\":{\"Street1\":\"\",\"Street2\":\"\",\"City\":\"\",\"State\":\"\",\"Country\":\"\",\"Zip\":\"\"},\"Percentage\":\"0\",\"depositeAmount\":\"0.00\"}",
"SalesReceiptHeader": "Sales Receipt 36 Update",
"SalesReceiptStatus": "Paid",
"SalesReceiptNotes": "",
"SalesReceiptNumber": "31",
"SalesReceiptPoNo": "",
"RecurringIntervalInString": "",
"SelectedCurrency": "en_IN",
"SelectedTemplate": "",
"ShippingMethod": "Standard Ground",
"ArchiveStatus": 0,
"Status": "active",
"SyncID": "",
"TaxValue": "",
"SalesReceiptTerms": "",
"SalesReceiptID": "2F284208-E687-4CD4-9A62-E8431F109068",
"DeviceID": "1093193415.1644912014",
"CreatedDate": "2022-06-27 13:14:41",
"SyncDate": "",
"SalesReceiptIsDelete": 0,
"CreatedAt": "2022-06-27T11:54:39.000000Z",
"UpdatedAt": "2022-06-27T11:54:39.000000Z",
"ServiceType": "1",
"Type": 1,
"PaymentTypes": null,
"Extra4": "",
"Extra5": "",
"Extra6": "",
"UsedDiscountInfo": [],
"CustomerEmail": "pp@yopmail.com",
"CompanyId": "8D5D856F-E370-45CC-8128-11EB9801805D",
"IsCreditNote": 0,
"PaynowLink": "",
"DueDateFormat": "May 18, 2022",
"EntryDateFormat": "May 18, 2022",
"OutStanding": [
{
"symbol": "$",
"code": "USD",
"currencylocale": "en_US",
"amount": 0,
"amount_f": "$0.00"
}
],
"ContactName": "aaa",
"ContactFirstLastname": "pp pp",
"NextRecurring": 0,
"RecurringDay": "",
"RecurringDate": "",
"PaypalEmail": "",
"EmailFontName": "Arial",
"EmailFontSize": 12,
"Attachment": "https://mi-doc.s3.amazonaws.com/local/9561/imageinfo/DB711697-081B-467D-8518-3A407E771DD8.png?AWSAccessKeyId=AKIA43TXFBRTCBXKZYZ6&Expires=1656336882&Signature=GDA7XsLkuP%2BKRkheKl9xR0PJo8c%3D",
"Products": [
{
"ProductID": "182BA686-499F-4B07-9040-83E3A6B23225",
"InvoiceProductID": "B0D224DA-BC65-4C31-B6D8-FF2295E4CDF6",
"ProductName": "Black Shirt",
"ModificationDate": "2022-06-27 13:14:41",
"Quantity": 2,
"Total": 304,
"UnitCost": 160,
"DiscountIsPercentage": 1,
"DiscountValue": "5",
"ProductNotes": "Black Shirt update test",
"ProductImage": "",
"TaxID": "95A1956E-E60A-4FAC-8EC4-C88EE7431280"
}
],
"Tasks": [
{
"TaskID": "2908192A-85C7-49D8-A18F-502782EC2EAE",
"InvoiceTaskID": "CB41A21A-2C4C-488B-A5BC-1E18086062CD",
"taskName": "Task1",
"ModificationDate": "2022-06-27 13:14:41",
"Hours": 1,
"Total": 9.8,
"Rate": 10,
"DiscountIsPercentage": 1,
"DiscountValue": "2",
"TaskNotes": "",
"TaxID": "95A1956E-E60A-4FAC-8EC4-C88EE7431280"
}
]
}
}
Details Sales Receipt
To Get Sales Receipt Details, you need to make a GET call to the following URL:
https://www.mooninvoice.com/api_mi/public/salesreceipt_details
parameters for DETAILS Sales Receipt
required fields
| Field | Type | Description |
|---|---|---|
| CompanyID | String | CompanyID is for details of sales receipt of specific Company. |
| ServiceType | String | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
| SalesReceiptID | String | Sales Receipt Identifier. |
Request Sample
Example DETAILS Sales Receipt JSON Request: {
"SalesReceiptID": "2F284208-E687-4CD4-9A62-E8431F109068",
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"ServiceType": "1"
}
Response Sample
Result example DETAILS Sales Receipt JSON Response: {
"status": 200,
"message": "Data received.",
"data": {
"PaymentType": "",
"IsPaypalPayment": 0,
"IsRecurring": 0,
"RecurringIntervalInDay": "0",
"SalesReceiptToExpense": "",
"SalesReceiptToImageInfo": "",
"SalesReceiptToRecurringExpense": "",
"SalesReceiptToItemline": "",
"SalesReceiptToPayment": "",
"ContactID": "0B505706-B5F2-435B-B2AF-7DD81B89893C",
"ExpenseID": "",
"SalesReceiptToUsedtax": "",
"SalesReceiptToRecurringInvoice": "",
"SalesReceiptToTablelist": null,
"SalesReceiptDueDate": "2022-05-18 12:40:27",
"SalesReceiptEntryDate": "2022-05-18 12:40:27",
"ModificationDate": "2022-06-27 13:14:39",
"RecurringEndDate": "0000-00-00 00:00:00",
"AmountDue": 0,
"AmountPaid": 0,
"DiscountDec": 0,
"ShippingCost": 5,
"SubTotal": 313.8,
"Total": 356.8,
"Discount": "A|N",
"DiscountValue": "",
"Extra1": "",
"Extra2": "",
"Extra3": "",
"SalesReceiptFolder": "{\"payment_str\":\"cash\",\"isroundoff\":{\"Zip\":\"\"},\"rounded_amount\":\"\",\"Billing\":\"0\",\"Billing_Add\":{\"Street1\":\"\",\"Street2\":\"\",\"City\":\"\",\"State\":\"\",\"Country\":\"\"},\"Secondary\":\"0\",\"Secondary_Add\":{\"Street1\":\"\",\"Street2\":\"\",\"City\":\"\",\"State\":\"\",\"Country\":\"\",\"Zip\":\"\"},\"Percentage\":\"0\",\"depositeAmount\":\"0.00\"}",
"SalesReceiptHeader": "Sales Receipt 36 Update",
"SalesReceiptStatus": "Paid",
"SalesReceiptNotes": "",
"SalesReceiptNumber": "31",
"SalesReceiptPoNo": "",
"RecurringIntervalInString": "",
"SelectedCurrency": "en_IN",
"SelectedTemplate": "",
"ShippingMethod": "Standard Ground",
"ArchiveStatus": 0,
"Status": "active",
"SyncID": "",
"TaxValue": "",
"SalesReceiptTerms": "",
"SalesReceiptID": "2F284208-E687-4CD4-9A62-E8431F109068",
"DeviceID": "1093193415.1644912014",
"CreatedDate": "2022-06-27 13:14:41",
"SyncDate": "",
"SalesReceiptIsDelete": 0,
"CreatedAt": "2022-06-27T11:54:39.000000Z",
"UpdatedAt": "2022-06-27T11:54:39.000000Z",
"ServiceType": "1",
"Type": 1,
"PaymentTypes": null,
"Extra4": "",
"Extra5": "",
"Extra6": "",
"UsedDiscountInfo": [],
"CustomerEmail": "pp@yopmail.com",
"CompanyId": "8D5D856F-E370-45CC-8128-11EB9801805D",
"IsCreditNote": 0,
"PaynowLink": "",
"DueDateFormat": "May 18, 2022",
"EntryDateFormat": "May 18, 2022",
"OutStanding": [
{
"symbol": "$",
"code": "USD",
"currencylocale": "en_US",
"amount": 0,
"amount_f": "$0.00"
}
],
"ContactName": "aaa",
"ContactFirstLastname": "pp pp",
"NextRecurring": 0,
"RecurringDay": "",
"RecurringDate": "",
"PaypalEmail": "",
"EmailFontName": "Arial",
"EmailFontSize": 12,
"Attachment": "https://mi-doc.s3.amazonaws.com/local/9561/imageinfo/DB711697-081B-467D-8518-3A407E771DD8.png?AWSAccessKeyId=AKIA43TXFBRTCBXKZYZ6&Expires=1656337725&Signature=iSzeUQQPcDuUWmJENTe9Wbdwlks%3D",
"Products": [
{
"ProductID": "182BA686-499F-4B07-9040-83E3A6B23225",
"InvoiceProductID": "B0D224DA-BC65-4C31-B6D8-FF2295E4CDF6",
"ProductName": "Black Shirt",
"ModificationDate": "2022-06-27 13:14:41",
"Quantity": 2,
"Total": 304,
"UnitCost": 160,
"DiscountIsPercentage": 1,
"DiscountValue": "5",
"ProductNotes": "Black Shirt update test",
"ProductImage": "",
"TaxID": "95A1956E-E60A-4FAC-8EC4-C88EE7431280"
}
],
"Tasks": [
{
"TaskID": "2908192A-85C7-49D8-A18F-502782EC2EAE",
"InvoiceTaskID": "CB41A21A-2C4C-488B-A5BC-1E18086062CD",
"taskName": "Task1",
"ModificationDate": "2022-06-27 13:14:41",
"Hours": 1,
"Total": 9.8,
"Rate": 10,
"DiscountIsPercentage": 1,
"DiscountValue": "2",
"TaskNotes": "",
"TaxID": "95A1956E-E60A-4FAC-8EC4-C88EE7431280"
}
]
}
}
Sales Receipt Delete
To Delete Sales Receipt, you need to make a DELETE call to the following URL:
https://www.mooninvoice.com/api_mi/public/salesreceipt_delete
parameters for Sales Receipt Delete
required fields
| Field | Type | Description |
|---|---|---|
| SalesReceiptID | String | Sales Receipt Identifier. |
| CompanyID | String | CompanyID is for delete sales receipt of specific Company. |
| DeviceID | Float | DeviceID is an unique identifier of your device. |
| ServiceType | Integer | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
Request Sample
Example DELETE Sales Receipt JSON Request: {
"SalesReceiptID": "2F284208-E687-4CD4-9A62-E8431F109068",
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"DeviceID":"1093193415.1644912014",
"ServiceType": "1"
}
Response Sample
Result example Sales Receipt DELETE JSON Response: {
"status": 200,
"message": "1 invoice(s) moved to trash.",
"data": []
}
Get Payment
To Get Payment, you need to make a GET call to the following URL:
https://www.mooninvoice.com/api_mi/public/payment_list
parameters for GET Payment
required fields
| Field | Type | Description |
|---|---|---|
| PaymentSort | String | PaymentSort is for sorting record by ascending or decending order wise record. PaymentSort must be contain asc or desc value. |
| CompanyID | String | CompanyId is for get record by specific Company. |
| ServiceType | Integer | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
| PageSize | Integer | PageSize is for size of per page record. |
optional fields
| Field | Type | Description |
|---|---|---|
| page | Integer | Enter page no. for get page wise records. |
Request Sample
Example GET Payment JSON Request: {
"PageSize": 25,
"page": 1,
"PaymentSort": "desc",
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"ServiceType": "1"
}
Response Sample
Result example GET Payment JSON Response: {
"status": 200,
"message": "Data received.",
"data": {
"current_page": 1,
"first_page_url": "https://www.mooninvoice.com/api_mi/public/payment_list?page=1",
"from": 1,
"last_page": 2,
"last_page_url": "https://www.mooninvoice.com/api_mi/public/payment_list?page=2",
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "https://www.mooninvoice.com/api_mi/public/payment_list?page=1",
"label": "1",
"active": true
},
{
"url": "https://www.mooninvoice.com/api_mi/public/payment_list?page=2",
"label": "2",
"active": false
},
{
"url": "https://www.mooninvoice.com/api_mi/public/payment_list?page=2",
"label": "Next »",
"active": false
}
],
"next_page_url": "https://www.mooninvoice.com/api_mi/public/payment_list?page=2",
"path": "https://www.mooninvoice.com/api_mi/public/payment_list",
"per_page": 25,
"prev_page_url": null,
"to": 25,
"total": 28,
"payments": [
{
"IsDirectPayment": 0,
"ContactID": "DFEA8A07-0EFE-455B-A46E-EABDA9C09C81",
"EntryDate": "2022-06-28 16:40:37",
"PaymentAmount": "110.00",
"PaymentNote": "Payment demo update",
"PaymentNumber": "33",
"PaymentType": "",
"PaymentID": "8FD9C30F-7EFB-406F-B7F6-88C3AC370738",
"InvoiceID": "42B447BB-4804-4B6D-8DE2-ACA784795ACF",
"Number": "8",
"SelectedCurrency": "en_US",
"FirstName": "Fb 1",
"LastName": "FB2",
"Organization": "Fbook User",
"CurrencyCode": "INR",
"CurrencySymbol": "₹",
"PaymentTotalAmount": "110.0000"
},
{
"IsDirectPayment": 0,
"ContactID": "DFEA8A07-0EFE-455B-A46E-EABDA9C09C81",
"EntryDate": "2022-06-28 11:10:37",
"PaymentAmount": "45.00",
"PaymentNote": "Payment demo",
"PaymentNumber": "32",
"PaymentType": "Cash",
"PaymentID": "861EE713-D1CC-4290-89E0-8896E85AB7CD",
"InvoiceID": "42B447BB-4804-4B6D-8DE2-ACA784795ACF",
"Number": "8",
"SelectedCurrency": "en_US",
"FirstName": "Fb 1",
"LastName": "FB2",
"Organization": "Fbook User",
"CurrencyCode": "INR",
"CurrencySymbol": "₹",
"PaymentTotalAmount": "45.0000"
}
]
}
}
Create Payment
To Create Payment, you need to make a POST call to the following URL:
https://www.mooninvoice.com/api_mi/public/add_payment
parameters for CREATE Payment
required fields
| Field | Type | Description |
|---|---|---|
| CompanyID | String | CompanyID is for create payment receipt of specific Company. |
| ServiceType | Integer | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
| DeviceID | Float | DeviceID is an unique identifier of your device. |
| InvoiceID | String | Invoice Identifier for payment. |
| PaymentNumber | String | Payment Number. |
| PaymentAmount | Float | Amount of Payment. |
| EntryDate | DateTime | Entry Date of Payment. |
| PaymentType | String | Type of Payment. Like Paypal, Paytm, Cash etc. |
optional fields
| Field | Type | Description |
|---|---|---|
| PaymentNote | String | Payment Notes. |
| TimeZone | String | TimeZone of contact person for payment. |
Request Sample
Example CREATE Payment JSON Request: {
"PaymentAmount": 15,
"EntryDate": "2022-6-28 16:40:37",
"PaymentNote": "Payment demo",
"PaymentNumber": 33,
"InvoiceID": "42B447BB-4804-4B6D-8DE2-ACA784795ACF",
"PaymentType": "Cash",
"ServiceType": "1",
"DeviceID": "1093193415.1644912014",
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"TimeZone": "Asia/Calcutta"
}
Response Sample
Result example CREATE Payment JSON Response: {
"status": 200,
"message": "Payment added.",
"data": {
"IsDirectPayment": 0,
"EntryDate": "2022-06-28 11:10:37",
"PaymentToCreditNote": "",
"PaymentAmount": 1232,
"PaymentNote": "Payment demo",
"PaymentNumber": "33",
"PaymentType": "Cash",
"PaymentID": "50F48420-DDB6-4754-A560-A6C4BDF9CDC3",
"InvoiceID": "42B447BB-4804-4B6D-8DE2-ACA784795ACF",
"Number": "8",
"SelectedCurrency": "en_US",
"ContactID": "DFEA8A07-0EFE-455B-A46E-EABDA9C09C81",
"Organization": "Fbook User",
"FirstName": "Fb 1",
"LastName": "FB2",
"CurrencyCode": "USD",
"CurrencySymbol": "$",
"PaymentAmountDue": "250.00",
"PayemntFolder": "{\"payment_str\":\"cash\",\"isroundoff\":0,\"rounded_amount\":0,\"Billing\":\"0\",\"Billing_Add\":{\"Street1\":\"st 1\",\"Street2\":\"st 2\",\"City\":\"Rajkot\",\"State\":\"Gujarat\",\"Country\":\"India\",\"Zip\":\"360005\"},\"Secondary\":\"0\",\"Secondary_Add\":{\"Street1\":\"\",\"Street2\":\"\",\"City\":\"\",\"State\":\"\",\"Country\":\"\",\"Zip\":\"\"},\"Percentage\":\"0\",\"depositeAmount\":\"0.00\"}",
"PaymentTotal": "505.0000",
"PaymentAmountPaid": "50.0000",
"PaymentTotalAmount": "50.0000",
"CreditNoteNumber": ""
}
}
Update Payment
To Update Payment, you need to make a PUT call to the following URL:
https://www.mooninvoice.com/api_mi/public/update_payment
parameters for UPDATE Payment
required fields
| Field | Type | Description |
|---|---|---|
| PaymentID | String | Payment Identifier. |
| CompanyID | String | CompanyID is for create payment receipt of specific Company. |
| ServiceType | Integer | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
| DeviceID | Float | DeviceID is an unique identifier of your device. |
| InvoiceID | String | Invoice Identifier for payment. |
| PaymentNumber | String | Payment Number. |
| PaymentAmount | Float | Amount of Payment. |
| EntryDate | DateTime | Entry Date of Payment. |
| PaymentType | String | Type of Payment. Like Paypal, Paytm, Cash etc. |
optional fields
| Field | Type | Description |
|---|---|---|
| PaymentNote | String | Payment Notes. |
| TimeZone | String | TimeZone of contact person for payment. |
Request Sample
Example UPDATE Payment JSON Request: {
"PaymentID":"A835C778-1F48-4C20-AC1D-992263574E30",
"PaymentAmount": 15,
"EntryDate": "2022-6-28 16:40:37",
"PaymentNote": "Payment demo",
"PaymentNumber": 33,
"InvoiceID": "42B447BB-4804-4B6D-8DE2-ACA784795ACF",
"PaymentType": "Cash",
"ServiceType": "1",
"DeviceID": "1093193415.1644912014",
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"TimeZone": "Asia/Calcutta"
}
Response Sample
Result example UPDATE Payment JSON Response: {
"status": 200,
"message": "Payment updated.",
"data": {
"IsDirectPayment": 0,
"EntryDate": "2022-06-28 16:40:37",
"PaymentToCreditNote": "",
"PaymentAmount": 1352,
"PaymentNote": "Payment demo update",
"PaymentNumber": "33",
"PaymentType": "",
"PaymentID": "A835C778-1F48-4C20-AC1D-992263574E30",
"InvoiceID": "42B447BB-4804-4B6D-8DE2-ACA784795ACF",
"Number": "8",
"SelectedCurrency": "en_US",
"ContactID": "DFEA8A07-0EFE-455B-A46E-EABDA9C09C81",
"Organization": "Fbook User",
"FirstName": "Fb 1",
"LastName": "FB2",
"CurrencyCode": "USD",
"CurrencySymbol": "$",
"PaymentAmountDue": "190.00",
"PaymentFolder": "{\"payment_str\":\"cash\",\"isroundoff\":0,\"rounded_amount\":0,\"Billing\":\"0\",\"Billing_Add\":{\"Street1\":\"st 1\",\"Street2\":\"st 2\",\"City\":\"Rajkot\",\"State\":\"Gujarat\",\"Country\":\"India\",\"Zip\":\"360005\"},\"Secondary\":\"0\",\"Secondary_Add\":{\"Street1\":\"\",\"Street2\":\"\",\"City\":\"\",\"State\":\"\",\"Country\":\"\",\"Zip\":\"\"},\"Percentage\":\"0\",\"depositeAmount\":\"0.00\"}",
"PaymentTotal": "505.0000",
"PaymentAmountPaid": "60.0000",
"PaymentTotalAmount": "60.0000",
"CreditNoteNumber": ""
}
}
Details Payment
To Get Payment Details, you need to make a GET call to the following URL:
https://www.mooninvoice.com/api_mi/public/payment_details
parameters for DETAILS Payment
required fields
| Field | Type | Description |
|---|---|---|
| CompanyID | String | CompanyID is for details of payment receipt of specific Company. |
| ServiceType | String | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
| PaymentID | String | Payment Identifier. |
Request Sample
Example DETAILS Payment JSON Request: {
"PaymentID": "A835C778-1F48-4C20-AC1D-992263574E30",
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"ServiceType": "1"
}
Response Sample
Result example DETAILS Payment JSON Response: {
"status": 200,
"message": "Data received.",
"data": {
"IsDirectPayment": 0,
"EntryDate": "2022-06-28 16:40:37",
"PaymentToCreditNote": "",
"PaymentAmount": 1352,
"PaymentNote": "Payment demo update",
"PaymentNumber": "33",
"PaymentType": "",
"PaymentID": "A835C778-1F48-4C20-AC1D-992263574E30",
"InvoiceID": "42B447BB-4804-4B6D-8DE2-ACA784795ACF",
"Number": "8",
"SelectedCurrency": "en_US",
"ContactID": "DFEA8A07-0EFE-455B-A46E-EABDA9C09C81",
"Organization": "Fbook User",
"FirstName": "Fb 1",
"LastName": "FB2",
"CurrencyCode": "USD",
"CurrencySymbol": "$",
"PaymentAmountDue": "190.00",
"PaymentFolder": "{\"payment_str\":\"cash\",\"isroundoff\":0,\"rounded_amount\":0,\"Billing\":\"0\",\"Billing_Add\":{\"Street1\":\"st 1\",\"Street2\":\"st 2\",\"City\":\"Rajkot\",\"State\":\"Gujarat\",\"Country\":\"India\",\"Zip\":\"360005\"},\"Secondary\":\"0\",\"Secondary_Add\":{\"Street1\":\"\",\"Street2\":\"\",\"City\":\"\",\"State\":\"\",\"Country\":\"\",\"Zip\":\"\"},\"Percentage\":\"0\",\"depositeAmount\":\"0.00\"}",
"PaymentTotal": "505.0000",
"PaymentAmountPaid": "60.0000",
"PaymentTotalAmount": "60.0000",
"CreditNoteNumber": ""
}
}
Delete Payment
To Delete Payment, you need to make a DELETE call to the following URL:
https://www.mooninvoice.com/api_mi/public/delete_payment
parameters for DELETE Payment
required fields
| Field | Type | Description |
|---|---|---|
| CompanyID | String | CompanyID is for delete payment receipt of specific Company. |
| ServiceType | Integer | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
| PaymentID | String | Payment Identifier. |
| DeviceID | Float | DeviceID is an unique identifier of your device. |
Request Sample
Example DELETE Payment JSON Request: {
"PaymentID": "A835C778-1F48-4C20-AC1D-992263574E30",
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"DeviceID":"1093193415.1644912014",
"ServiceType": "1"
}
Response Sample
Result example DELETE Payment JSON Response: {
"status": 200,
"message": "1 payment(s) moved to trash.",
"data": []
}
Get Time Log
To Get Time Log, you need to make a GET call to the following URL:
https://www.mooninvoice.com/api_mi/public/timelog_list_global
parameters for GET Time Log
required fields
| Field | Type | Description |
|---|---|---|
| TimeLogSort | String | TimeLogSort is for sorting record by ascending or decending order wise record. TimeLogSort must be contain asc or desc value. |
| CompanyID | String | CompanyId is for get record by specific Company. |
| ServiceType | Integer | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
| PageSize | Integer | PageSize is for size of per page record. |
optional fields
| Field | Type | Description |
|---|---|---|
| Page | Integer | Enter page no. for get page wise records. |
Request Sample
Example GET Time Log JSON Request: {
"PageSize": 25,
"page": 1,
"TimeLogSort": "desc",
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"ServiceType": "1"
}
Response Sample
Result example GET Time Log JSON Response: {
"status": 200,
"message": "Data received.",
"data": {
"current_page": 1,
"first_page_url": "https://www.mooninvoice.com/api_mi/public/timelog_list?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "https://www.mooninvoice.com/api_mi/public/timelog_list?page=1",
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "https://www.mooninvoice.com/api_mi/public/timelog_list?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
],
"next_page_url": null,
"path": "https://www.mooninvoice.com/api_mi/public/timelog_list",
"per_page": 25,
"prev_page_url": null,
"to": 4,
"total": 4,
"timelogs": [
{
"EntryDate": "2022-05-25 08:40:51",
"Second": "3600",
"TimeLogID": "656631D9-2CC4-40A3-B68C-43CDAC8E546A",
"TimeLogNotes": "Testing public Update Again Update",
"LastElapsedTime": 0,
"IsContinue": 0,
"LastContinueDate": "0000-00-00 00:00:00",
"IsCreatedInvoice": "",
"TimerType": 3,
"Seconds": "01:00",
"Seconds1": "01:00:00",
"EntryDates": "May 25, 2022",
"Name": "Task 1",
"Task": {
"TaskID": "DDDC24D9-F7BE-4CF6-9D67-AF9D22B3AB7F",
"TaskName": "Task 1",
"Hours": "1.000",
"Rate": "0.000",
"TaskType": "hour",
"Project": {
"ProjectName": "New Project",
"ProjectID": "E580EBEF-1501-410D-BFC7-9B483C04D204"
},
"ContactID": "DDDC24D9-F7BE-4CF6-9D67-AF9D22B3AB7F",
"ContactName": "New Customer",
"HourlyRate": "10"
}
},
{
"EntryDate": "2022-05-25 08:40:51",
"Second": "3600",
"TimeLogID": "8276DC29-8B3A-413F-AC28-1D6D94A51005",
"TimeLogNotes": "Testing public Update",
"LastElapsedTime": 0,
"IsContinue": 0,
"LastContinueDate": "0000-00-00 00:00:00",
"IsCreatedInvoice": "",
"TimerType": 3,
"Seconds": "01:00",
"Seconds1": "01:00:00",
"EntryDates": "May 25, 2022",
"Name": "Task 1",
"Task": {
"TaskID": "DDDC24D9-F7BE-4CF6-9D67-AF9D22B3AB7F",
"TaskName": "Task 1",
"Hours": "1.000",
"Rate": "0.000",
"TaskType": "hour",
"Project": {
"ProjectName": "New Project",
"ProjectID": "E580EBEF-1501-410D-BFC7-9B483C04D204"
},
"ContactID": "DDDC24D9-F7BE-4CF6-9D67-AF9D22B3AB7F",
"ContactName": "New Customer",
"HourlyRate": "10"
}
}
]
}
}
Create Time Log
To Create Time Log, you need to make a POST call to the following URL:
https://www.mooninvoice.com/api_mi/public/create_timelog
parameters for CREATE Time Log
required fields
| Field | Type | Description |
|---|---|---|
| CompanyID | String | CompanyID is for create time logs of specific Company. |
| ServiceType | Integer | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
| DeviceID | Float | DeviceID is an unique identifier of your device. |
| TaskID | String | Task Identifier. |
optional fields
| Field | Type | Description |
|---|---|---|
| IsContinue | Boolean | IsContinue is a contain boolean value 1 and 0. if time log is continue then 1 otherwise 0. |
| EntryDate | DateTime | Time Logs Entry Date. |
| Notes | String | Time Logs Notes. |
| Second | String | Time logs time count in second. |
| TimeZone | String | TimeZone of contact person for Time Logs. |
| InDate | String | A search word to find character by name. |
| OutDate | String | A search word to find character by name. |
Request Sample
Example CREATE Time Log JSON Request: {
"IsContinue": 0,
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"TaskID": "824EEA4A-5F72-482D-84B0-C147C6F0A0C0",
"EntryDate": "2022-5-13 14:10:51",
"Notes": "Time Log for demo",
"Second": 3600,
"InDate": "13-May-2022 at 14:10:00 PM",
"OutDate": "13-May-2022 at 14:10:00 PM",
"DeviceID": "1093193415.1644912014",
"ServiceType": "1",
"TimeZone": "Asia/Calcutta"
}
Response Sample
Result example CREATE Time Log JSON Response: {
"status": 200,
"message": "Time log created.",
"data": {
"IsContinue": 0,
"EntryDate": "2022-05-13 08:40:51",
"LastContinueDate": "0000-00-00 00:00:00",
"LastElapsedTime": 0,
"InvoiceID": "",
"IsCreatedInvoice": "",
"TimeLogNotes": "Time Log for demo",
"Second": "3600",
"SyncID": "",
"TimeLogID": "9EE6C025-1905-4FD2-91E6-6BFED083A610",
"CreatedDate": "2022-06-28 09:24:40",
"SyncDate": "",
"ModificationDate": "2022-06-28 09:24:40",
"IsDelete": 0,
"ServiceType": "1",
"Hrs": 1,
"Mins": 0,
"Sec": 0,
"InsyncDate": "2022-05-13",
"InsyncTime": "14:10",
"OutsyncDate": "2022-05-13",
"OutsyncTime": "14:10",
"Type": "inout",
"DateFormat": "May 13, 2022",
"Task": {
"TaskID": "824EEA4A-5F72-482D-84B0-C147C6F0A0C0",
"TaskName": "Task for Invoice",
"Hours": "1.000",
"Rate": "10.000",
"TaskType": "Hours",
"Project": {
"ProjectName": "Project For Invoice Update",
"ProjectID": "DA9AA481-5E56-4890-BBCE-DE9F2AB390C1"
},
"ContactID": "824EEA4A-5F72-482D-84B0-C147C6F0A0C0",
"ContactName": "Web64 Test",
"HourlyRate": "10.000"
}
}
}
Update Time Log
To Update Time Log, you need to make a PUT call to the following URL:
https://www.mooninvoice.com/api_mi/public/update_timelog
parameters for UPDATE Time Log
required fields
| Field | Type | Description |
|---|---|---|
| TimeLogID | String | Time Logs Identifier. |
| CompanyID | String | CompanyID is for create time logs of specific Company. |
| ServiceType | Integer | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
| DeviceID | Float | DeviceID is an unique identifier of your device. |
| TaskID | String | Task Identifier. |
optional fields
| Field | Type | Description |
|---|---|---|
| IsContinue | Boolean | IsContinue is a contain boolean value 1 and 0. if time log is continue then 1 otherwise 0. |
| EntryDate | DateTime | Time Logs Entry Date. |
| Notes | String | Time Logs Notes. |
| Second | String | Time logs time count in second. |
| TimeZone | String | TimeZone of contact person for Time Logs. |
| InDate | String | A search word to find character by name. |
| OutDate | String | A search word to find character by name. |
Request Sample
Example UPDATE Time Log JSON Request: {
"TimeLogID":"9EE6C025-1905-4FD2-91E6-6BFED083A610",
"IsContinue": 0,
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"TaskID": "824EEA4A-5F72-482D-84B0-C147C6F0A0C0",
"EntryDate": "2022-5-13 14:10:51",
"Notes": "Time Log for demo",
"Second": 3600,
"InDate": "13-May-2022 at 14:10:00 PM",
"OutDate": "13-May-2022 at 14:10:00 PM",
"DeviceID": "1093193415.1644912014",
"ServiceType": "1",
"TimeZone": "Asia/Calcutta"
}
Response Sample
Result example UPDATE Time Log JSON Response: {
"status": 200,
"message": "Time log updated.",
"data": {
"IsContinue": 0,
"EntryDate": "2022-05-25 08:40:51",
"LastContinueDate": "0000-00-00 00:00:00",
"LastElapsedTime": 0,
"InvoiceID": "",
"IsCreatedInvoice": "",
"TimeLogNotes": "Time Log for demo update",
"Second": "3600",
"SyncID": "",
"TimeLogID": "9EE6C025-1905-4FD2-91E6-6BFED083A610",
"CreatedDate": "2022-06-28 09:42:30",
"SyncDate": "",
"ModificationDate": "2022-06-28 09:42:30",
"IsDelete": 0,
"ServiceType": "1",
"Hrs": 1,
"Mins": 0,
"Sec": 0,
"InsyncDate": "2022-05-25",
"InsyncTime": "14:10",
"OutsyncDate": "2022-05-25",
"OutsyncTime": "14:10",
"Type": "inout",
"DateFormat": "May 25, 2022",
"Task": {
"TaskID": "824EEA4A-5F72-482D-84B0-C147C6F0A0C0",
"TaskName": "Task for Invoice",
"Hours": "1.000",
"Rate": "10.000",
"TaskType": "Hours",
"Project": {
"ProjectName": "Project For Invoice Update",
"ProjectID": "DA9AA481-5E56-4890-BBCE-DE9F2AB390C1"
},
"ContactID": "824EEA4A-5F72-482D-84B0-C147C6F0A0C0",
"ContactName": "Web64 Test",
"HourlyRate": "10.000"
}
}
}
Details Time Log
To Get Time Log Details, you need to make a GET call to the following URL:
https://www.mooninvoice.com/api_mi/public/timelog_details
parameters for DETAILS Time Logs
required fields
| Field | Type | Description |
|---|---|---|
| CompanyID | String | CompanyID is for get details of time logs of specific Company. |
| ServiceType | String | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
| TimeLogID | String | Time Logs Identifier. |
Request Sample
Example DETAILS Time Log JSON Request: {
"TimeLogID": "9EE6C025-1905-4FD2-91E6-6BFED083A610",
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"ServiceType": "1"
}
Response Sample
Result example DETAILS Time Logs JSON Response: {
"status": 200,
"message": "Data received.",
"data": {
"IsContinue": 0,
"EntryDate": "2022-05-25 08:40:51",
"LastContinueDate": "0000-00-00 00:00:00",
"LastElapsedTime": 0,
"InvoiceID": "",
"IsCreatedInvoice": "",
"TimeLogNotes": "Time Log for demo update",
"Second": "3600",
"SyncID": "",
"TimeLogID": "9EE6C025-1905-4FD2-91E6-6BFED083A610",
"CreatedDate": "2022-06-28 09:42:30",
"SyncDate": "",
"ModificationDate": "2022-06-28 09:42:30",
"IsDelete": 0,
"ServiceType": "1",
"Hrs": 1,
"Mins": 0,
"Sec": 0,
"InsyncDate": "2022-05-25",
"InsyncTime": "14:10",
"OutsyncDate": "2022-05-25",
"OutsyncTime": "14:10",
"Type": "inout",
"DateFormat": "May 25, 2022",
"Task": {
"TaskID": "824EEA4A-5F72-482D-84B0-C147C6F0A0C0",
"TaskName": "Task for Invoice",
"Hours": "1.000",
"Rate": "10.000",
"TaskType": "Hours",
"Project": {
"ProjectName": "Project For Invoice Update",
"ProjectID": "DA9AA481-5E56-4890-BBCE-DE9F2AB390C1"
},
"ContactID": "824EEA4A-5F72-482D-84B0-C147C6F0A0C0",
"ContactName": "Web64 Test",
"HourlyRate": "10.000"
}
}
}
Delete Time Log
To Delete Time Log, you need to make a DELETE call to the following URL:
https://www.mooninvoice.com/api_mi/public/delete_timelog
parameters for DELETE Time Logs
required fields
| Field | Type | Description |
|---|---|---|
| CompanyID | String | CompanyID is for delete time logs of specific Company. |
| ServiceType | Integer | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
| TimeLogID | String | Time Logs Identifier. |
| DeviceID | Float | DeviceID is an unique identifier of your device. |
Request Sample
Example DELETE Time Log JSON Request: {
"TimeLogID": "9EE6C025-1905-4FD2-91E6-6BFED083A610",
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"DeviceID":"1093193415.1644912014",
"ServiceType": "1"
}
Response Sample
Result example DELETE Time Logs JSON Response: {
"status": 200,
"message": "1 Time log(s) deleted",
"data": []
}
Get Purchase Order
To Get Purchase Order, you need to make a GET call to the following URL:
https://www.mooninvoice.com/api_mi/public/purchase_order_list
parameters for GET Purchase Order
required fields
| Field | Type | Description |
|---|---|---|
| PurchaseOrderSort | String | PurchaseOrderSort is for sorting record by ascending or decending order wise record. PurchaseOrderSort must be contain asc or desc value. |
| PageSize | Integer | PageSize is for size of per page record. |
| CompanyID | String | CompanyId is for get record by specific Company. |
| ServiceType | Integer | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
optional fields
| Field | Type | Description |
|---|---|---|
| page | Integer | Enter page no. for get page wise records. |
Request Sample
Example GET Purchase Order JSON Request: {
"PurchaseOrderSort": "desc",
"PageSize": 25,
"PurchaseOrderSortColumn": "entrydate",
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"ServiceType": "1",
"page": 1
}
Response Sample
Result example GET Purchase Order JSON Response: {
"status": 200,
"message": "Data received.",
"data": {
"current_page": 1,
"first_page_url": "https://www.mooninvoice.com/api_mi/public/purchase_order_list?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "https://www.mooninvoice.com/api_mi/public/purchase_order_list?page=1",
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "https://www.mooninvoice.com/api_mi/public/purchase_order_list?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
],
"next_page_url": null,
"path": "https://www.mooninvoice.com/api_mi/public/purchase_order_list",
"per_page": 25,
"prev_page_url": null,
"to": 13,
"total": 13,
"purchase_order": [
{
"PurchaseOrderID": "7C0AFFA0-F2CC-451A-B14B-3A31EB4E9885",
"PurchaseOrderEntryDate": "2022-04-22 06:02:10",
"SelectedCurrency": "en_US",
"PurchaseOrderStatus": "Draft",
"Status": "active",
"IsPurchaseOrderDelete": 0,
"PurchaseOrderTotal": "1156.9000",
"PurchaseOrderTerms": "Testing Terms and Conditions 10 number Update",
"PurchaseOrderOrganization": "Web64 Test",
"FirstName": "Test",
"LastName": "Test2",
"PurchaseOrderNotes": "Testing Notes 4 number",
"PurchaseOrderNumber": "13",
"PurchaseOrderFolder": "{\"isroundoff\":\"0\",\"rounded_amount\":\"0\",\"Billing\":\"0\",\"Billing_Add\":{\"Street1\":\"Near Sardar Nagar\",\"Street2\":\"105 Alfa Heights\",\"City\":\"Ra\",\"State\":\"Guj\",\"Country\":\"India\",\"Zip\":\"360005\"},\"Secondary\":\"0\",\"Secondary_Add\":{\"Street1\":\"Near Sardar Nagar\",\"Street2\":\"105 Alfa Heights\",\"City\":\"Ra\",\"State\":\"Guj\",\"Country\":\"India\",\"Zip\":\"360005\"},\"Percentage\":\"0\",\"depositeAmount\":\"0.00\"}",
"TotalAmount": "0.0000",
"ContactName": "Web64 Test",
"Currency": {
"CurrencyLocale": "en_US",
"Code": "INR",
"Symbol": "₹"
}
},
{
"PurchaseOrderID": "28E3870C-52E9-4D0E-B60C-75FB3632A7C4",
"PurchaseOrderEntryDate": "2022-04-22 06:02:10",
"SelectedCurrency": "en_US",
"PurchaseOrderStatus": "Draft",
"Status": "active",
"IsPurchaseOrderDelete": 0,
"PurchaseOrderTotal": "1156.9000",
"PurchaseOrderTerms": "Testing Terms and Conditions 10 number Update",
"PurchaseOrderOrganization": "Web64 Test",
"FirstName": "Test",
"LastName": "Test2",
"PurchaseOrderNotes": "Testing Notes 4 number",
"PurchaseOrderNumber": "11",
"PurchaseOrderFolder": "{\"isroundoff\":0,\"rounded_amount\":0,\"Billing\":\"0\",\"Billing_Add\":{\"Street1\":\"Near Sardar Nagar\",\"Street2\":\"105 Alfa Heights\",\"City\":\"Ra\",\"State\":\"Guj\",\"Country\":\"India\",\"Zip\":\"360005\"},\"Secondary\":\"0\",\"Secondary_Add\":{\"Street1\":\"Near Sardar Nagar\",\"Street2\":\"105 Alfa Heights\",\"City\":\"Ra\",\"State\":\"Guj\",\"Country\":\"India\",\"Zip\":\"360005\"},\"Percentage\":0,\"depositeAmount\":\"0.00\"}",
"TotalAmount": "0.0000",
"ContactName": "Web64 Test",
"Currency": {
"CurrencyLocale": "en_US",
"Code": "INR",
"Symbol": "₹"
}
}
]
}
}
Create Purchase Order
To Create Purchase Order, you need to make a POST call to the following URL:
https://www.mooninvoice.com/api_mi/public/create_purchase_order
parameters for CREATE Purchase Order
required fields
| Field | Type | Description |
|---|---|---|
| CompanyID | String | CompanyID is for create purchase order of specific Company. |
| ContactID | String | Contact Identifier of Purchase Order. |
| PurchaseOrderNumber | String | Purchase Order Number. |
| EntryDate | DateTime | Entry Date of Purchase Order. |
| ServiceType | Integer | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
optional fields
| Field | Type | Description |
|---|---|---|
| PurchaseOrderHeader | String | Title or Header of Purchase Order. |
| ShippingCost | Float | Shipping Cost of Purchase Order |
| ShippingMethod | Float | Shipping Method of Purchase Order. |
| DiscountDec | Float | Discont on Purchase Order total. |
| PurchaseOrderTerms | String | Terms of Purchase Order. |
| PurchaseOrderNotes | String | Notes/Description of Purchase Order. |
| TotalAmount | Float | Total Amount of Purchase Order. |
| SubTotal | Float | Sub Total Amount of Purchase Order. |
| DeviceID | String | DeviceID is an unique identifier of your device. |
| SelectedCurrency | String | Selected Currency is code of local currency language. Like en_IN, en_US etc. |
| AttachmentFile | File | Purchase Order Attachment File. |
| ServiceType | Integer | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
| TimeZone | String | TimeZone of contact person for Purchase Order. |
| PurchaseOrderFolder | Array | Purchase Order Folder is array and contain below fields. |
isroundoff |
Boolean | isroundoff is a contain boolean value 1 and 0. isroundoff is a rounded amount of Purchase Order. |
rounded_amount |
Float | Rounded amount of Purchase Order. |
Percentage |
Float | Discount Percentage from total amount of Purchase Order. |
depositeAmount |
Float | Deposite Amount of Purchase Order. |
Billing_Add |
Array | Billing_Add is array and contain below fields. |
Street1 |
String | Billing Address Street1. |
Street2 |
String | Billing Address Street2 |
City |
String | Billing Address City |
State |
String | Billing Address State |
Country |
String | Billing Address Country |
Zip |
String | Billing Address Zip |
Secondary_Add |
Array | Secondary_Add is array and contain below fields. |
Street1 |
String | Shipping Address Street1. |
Street2 |
String | Shipping Address Street2 |
City |
String | Shipping Address City |
State |
String | Shipping Address State |
Country |
String | Shipping Address Country |
Zip |
String | Shipping Address Zip |
| ProductData | Array | Product Data is a contain array of all product of Purchase Order. ProductData contain multidimensional array. |
ProductName |
String | Name of Product. |
Quantity |
Integer | Quantity of Product. |
UnitCost |
Float | Selling price of Product. |
ProductNotes |
String | Product Notes. |
ProductID |
String | Product Identifier. |
Total |
String | Total Amount of Product. |
SubAmount |
String | SubAmount of Product. |
DiscountIsPercentage |
Boolean | Discount on product is in percetage or not. If in percentage then 1 otherwise 0. |
ProductType |
String | Type of product like kg, piece, liter etc. |
DiscountValue |
String | Discount amount |
TaxUpdate |
Boolean | TaxUpdate is a contain boolean value. If Tax Update then 1 otherwise 0. |
StockUpdate |
Boolean | StockUpdate is a contain boolean value. If Tax Update then 1 otherwise 0. |
TaxID |
Array | Array of Tax ID which is apply on product. Like ["95A1956E-E60A-4FAC-8EC4-C88EE7431280"] |
ItemlineToTaxList |
Array | ItemlineToTaxList is multidimensional array and contain all tax data which are applied on product. |
ItemlineToTaxListID |
String | Identifier of TAX. |
PercentageDec |
Float | Tax percentage of product. |
Name |
String | Name of Tax. |
| TaskData | Array | Task Data is a contain array of all task of Purchase Order. TaskData contain multidimensional array. |
TaskName |
String | Name of Task. |
Hours |
Float | Total hours of task for invoice. |
TaskRate |
Float | Rate of task. |
TimeNotes |
String | Task Notes. |
TaskID |
String | Task Identifier. |
Total |
Float | Total amount of task. |
DiscountIsPercentage |
Boolean | Discount on task is in percetage or not. If in percentage then 1 otherwise 0. |
TaskType |
String | Type of task. |
DiscountValue |
String | Dicount value on task in percentage. Like 1P, 2P etc. |
TaxID |
Array | Array of Tax ID which is apply on tax. Like ["95A1956E-E60A-4FAC-8EC4-C88EE7431280"] |
TasklineToTax |
Array | TasklineToTax contains a tax details array with the below fields. |
TasklineToTaxID |
String | TaxID of task tax. |
PercentageDec |
Float | Tax percentage of task. |
Name |
String | Name of tax. |
Request Sample
Example CREATE Purchase Order JSON Request: {
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"PurchaseOrderHeader": "Test PO entry via public",
"PurchaseOrderNumber": "13",
"ShippingCost": 15,
"ShippingMethod": "Standard Ground",
"DiscountDec": "0.00",
"PurchaseOrderTerms": "Testing Terms and Conditions 10 number Update",
"PurchaseOrderNotes": "Testing Notes 4 number",
"EntryDate": "2022-4-22 11:32:10",
"TotalAmount": "1156.90",
"SubTotal": 1141.8999999999999,
"PurchaseOrderFolder": {
"isroundoff": 0,
"rounded_amount": 0,
"Billing_Add": {
"Street1": "Near Sardar Nagar",
"Street2": "105 Alfa Heights",
"City": "Ra",
"State": "Guj",
"Country": "India",
"Zip": "360005"
},
"Secondary_Add": {
"Street1": "Near Sardar Nagar",
"Street2": "105 Alfa Heights",
"City": "Ra",
"State": "Guj",
"Country": "India",
"Zip": "360005"
},
"Percentage": 0,
"depositeAmount": "0.00"
},
"DeviceID": "1093193415.1644912014",
"ContactID": "5ACC3AEF-8EAB-4DB1-B709-279261C59E0C",
"SelectedCurrency": "en_US",
"AttachmentFile": "FILE DATA",
"AttachmentType": "4",
"ProductData": [
{
"ProductName": "Apple iPhone 11 Pro (64GB) - Silver",
"Quantity": 1,
"UnitCost": "1145.00",
"ProductNotes": "5.8-inch (14.7 cm diagonal) Super Retina XDR OLED display.",
"ProductID": "",
"Total": 1122.1,
"SubAmount": 1122.1,
"DiscountIsPercentage": "1",
"ProductType": "piece",
"DiscountValue": "2P",
"StockUpdate": 1,
"ItemlineToTaxList": [
{
"ItemlineToTaxListID": "95A1956E-E60A-4FAC-8EC4-C88EE7431280",
"PercentageDec": "10.0000",
"Name": "Default"
}
],
"TaxID": [
"95A1956E-E60A-4FAC-8EC4-C88EE7431280"
],
"orderindex": 1
}
],
"TaskData": [
{
"TaskName": "task 20",
"Hours": 2,
"TaskRate": "10.00",
"TimeNotes": "",
"TaskID": "",
"Total": 19.8,
"DiscountIsPercentage": "1",
"DiscountValue": "1P",
"TasklineToTax": [
{
"TasklineToTaxID": "95A1956E-E60A-4FAC-8EC4-C88EE7431280",
"PercentageDec": "10.0000",
"Name": "Default"
}
],
"TaxID": [
"95A1956E-E60A-4FAC-8EC4-C88EE7431280"
],
"TaskType": "",
"orderindex": 2
}
],
"UsedTax": [],
"ServiceType": "1",
"TimeZone": "Asia/Calcutta"
}
Response Sample
Result example CREATE Purchase Order JSON Response: {
"status": 200,
"message": "Purchase Order added.",
"data": {
"PurchaseOrderID": "BDBD2F7A-87EE-475C-B473-C48521BAFAED",
"Amount": "0.0000",
"AmountPaid": "0.0000",
"Discount": "A|N",
"DiscountDec": 0,
"DiscountValue": "",
"EntryDate": "2022-05-18 12:40:27",
"PurchaseOrderHeader": "Purchase Order Demo",
"PurchaseOrderStatus": "Draft",
"ArchiveStatus": 0,
"PurchaseOrderToPayment": "",
"Extra1": "",
"Extra2": "",
"Extra3": "",
"PurchaseOrderFolder": "{\"isroundoff\":{\"Zip\":\"360005\"},\"rounded_amount\":\"\",\"Billing\":\"0\",\"Billing_Add\":{\"Street1\":\"Near Sardar Nagar\",\"Street2\":\"105 Alfa Heights\",\"City\":\"Ahemdabad\",\"State\":\"Gujarat\",\"Country\":\"India\"},\"Secondary\":\"0\",\"Secondary_Add\":{\"Street1\":\"Near Sardar Nagar\",\"Street2\":\"105 Alfa Heights\",\"City\":\"Ahemdabad\",\"State\":\"Gujarat\",\"Country\":\"India\",\"Zip\":\"360005\"},\"Percentage\":\"0\",\"depositeAmount\":\"0.00\"}",
"PurchaseOrderNotes": "Purchase Order demo content",
"PurchaseOrderNumber": "16",
"PurchaseOrderPoNo": "",
"PurchaseOrderSectionRange": "",
"SelectedCurrency": "en_IN",
"ShippingCost": 5,
"ShippingMethod": "Standard Ground",
"Status": "active",
"SubTotal": 313.8,
"TaxValue": "",
"Terms": "Test",
"Total": 356.8,
"Type": 1,
"PurchaseOrderToImageInfo": "",
"PurchaseOrderToItemline": "",
"ContactID": "0B505706-B5F2-435B-B2AF-7DD81B89893C",
"PurchaseOrderToTaskLine": "",
"PurchaseOrderToUsedTax": "",
"DeviceID": "1093193415.1644912014",
"CreatedDate": "2022-06-28 06:55:09",
"SyncDate": "",
"ModificationDate": "2022-06-28 06:55:09",
"IsInvoiceDelete": 0,
"CreatedAt": "2022-06-28T06:55:09.000000Z",
"UpdatedAt": "2022-06-28T06:55:09.000000Z",
"ServiceType": "1",
"CustomerEmail": "pp@yopmail.com",
"CompanyId": "8D5D856F-E370-45CC-8128-11EB9801805D",
"EntryDateFormat": "May 18, 2022",
"ContactName": "aaa",
"ContactFirstLastname": "pp pp",
"EmailFontName": "Arial",
"EmailFontSize": 12,
"Attachment": "https://mi-doc.s3.amazonaws.com/local/9561/imageinfo/A78707DF-2C7E-4944-8950-B77145CCA77E.png?AWSAccessKeyId=AKIA43TXFBRTCBXKZYZ6&Expires=1656400511&Signature=tJEkNA9y5%2F5xZpK3igGTGKR5L2k%3D",
"Currency": {
"CurrencyLocale": "en_IN",
"Code": "INR",
"Symbol": "₹"
},
"Products": [
{
"ProductID": "182BA686-499F-4B07-9040-83E3A6B23225",
"InvoiceProductID": "0FA0E2F9-9ED4-4901-9845-6B214F4A450A",
"ProductName": "Black Shirt",
"ModificationDate": "2022-06-28 06:55:10",
"Quantity": 2,
"Total": 304,
"UnitCost": 160,
"DiscountIsPercentage": 1,
"DiscountValue": "5",
"ProductNotes": "Black Shirt update test",
"ProductImage": "",
"TaxName": "95A1956E-E60A-4FAC-8EC4-C88EE7431280"
}
],
"Tasks": [
{
"TaskID": "2908192A-85C7-49D8-A18F-502782EC2EAE",
"InvoiceTaskID": "435794E3-8C96-4020-93C6-2064AD20732B",
"taskName": "Task1",
"ModificationDate": "2022-06-28 06:55:10",
"Hours": 1,
"Total": 9.8,
"Rate": 10,
"DiscountIsPercentage": 1,
"DiscountValue": "2",
"TaskNotes": "",
"TaxName": "95A1956E-E60A-4FAC-8EC4-C88EE7431280"
}
]
}
}
Update Purchase Order
To Update Purchase Order, you need to make a PUT call to the following URL:
https://www.mooninvoice.com/api_mi/public/update_purchase_order
parameters for UPDATE Purchase Order
required fields
| Field | Type | Description |
|---|---|---|
| PurchaseOrderID | String | Purchase Order Identifier. |
| CompanyID | String | CompanyID is for create purchase order of specific Company. |
| ContactID | String | Contact Identifier of Purchase Order. |
| PurchaseOrderNumber | String | Purchase Order Number. |
| EntryDate | DateTime | Entry Date of Purchase Order. |
| ServiceType | Integer | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
optional fields
| Field | Type | Description |
|---|---|---|
| PurchaseOrderHeader | String | Title or Header of Purchase Order. |
| ShippingCost | Float | Shipping Cost of Purchase Order |
| ShippingMethod | Float | Shipping Method of Purchase Order. |
| DiscountDec | Float | Discont on Purchase Order total. |
| PurchaseOrderTerms | String | Terms of Purchase Order. |
| PurchaseOrderNotes | String | Notes/Description of Purchase Order. |
| TotalAmount | Float | Total Amount of Purchase Order. |
| SubTotal | Float | Sub Total Amount of Purchase Order. |
| DeviceID | String | DeviceID is an unique identifier of your device. |
| SelectedCurrency | String | Selected Currency is code of local currency language. Like en_IN, en_US etc. |
| AttachmentFile | File | Purchase Order Attachment File. |
| ServiceType | Integer | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
| TimeZone | String | TimeZone of contact person for Purchase Order. |
| PurchaseOrderFolder | Array | Purchase Order Folder is array and contain below fields. |
isroundoff |
Boolean | isroundoff is a contain boolean value 1 and 0. isroundoff is a rounded amount of Purchase Order. |
rounded_amount |
Float | Rounded amount of Purchase Order. |
Percentage |
Float | Discount Percentage from total amount of Purchase Order. |
depositeAmount |
Float | Deposite Amount of Purchase Order. |
Billing_Add |
Array | Billing_Add is array and contain below fields. |
Street1 |
String | Billing Address Street1. |
Street2 |
String | Billing Address Street2 |
City |
String | Billing Address City |
State |
String | Billing Address State |
Country |
String | Billing Address Country |
Zip |
String | Billing Address Zip |
Secondary_Add |
Array | Secondary_Add is array and contain below fields. |
Street1 |
String | Shipping Address Street1. |
Street2 |
String | Shipping Address Street2 |
City |
String | Shipping Address City |
State |
String | Shipping Address State |
Country |
String | Shipping Address Country |
Zip |
String | Shipping Address Zip |
| ProductData | Array | Product Data is a contain array of all product of Purchase Order. ProductData contain multidimensional array. |
ProductName |
String | Name of Product. |
Quantity |
Integer | Quantity of Product. |
UnitCost |
Float | Selling price of Product. |
ProductNotes |
String | Product Notes. |
ProductID |
String | Product Identifier. |
Total |
String | Total Amount of Product. |
SubAmount |
String | SubAmount of Product. |
DiscountIsPercentage |
Boolean | Discount on product is in percetage or not. If in percentage then 1 otherwise 0. |
ProductType |
String | Type of product like kg, piece, liter etc. |
DiscountValue |
String | Discount amount |
TaxUpdate |
Boolean | TaxUpdate is a contain boolean value. If Tax Update then 1 otherwise 0. |
StockUpdate |
Boolean | StockUpdate is a contain boolean value. If Tax Update then 1 otherwise 0. |
TaxID |
Array | Array of Tax ID which is apply on product. Like ["95A1956E-E60A-4FAC-8EC4-C88EE7431280"] |
ItemlineToTaxList |
Array | ItemlineToTaxList is multidimensional array and contain all tax data which are applied on product. |
ItemlineToTaxListID |
String | Identifier of TAX. |
PercentageDec |
Float | Tax percentage of product. |
Name |
String | Name of Tax. |
| TaskData | Array | Task Data is a contain array of all task of Purchase Order. TaskData contain multidimensional array. |
TaskName |
String | Name of Task. |
Hours |
Float | Total hours of task for invoice. |
TaskRate |
Float | Rate of task. |
TimeNotes |
String | Task Notes. |
TaskID |
String | Task Identifier. |
Total |
Float | Total amount of task. |
DiscountIsPercentage |
Boolean | Discount on task is in percetage or not. If in percentage then 1 otherwise 0. |
TaskType |
String | Type of task. |
DiscountValue |
String | Dicount value on task in percentage. Like 1P, 2P etc. |
TaxID |
Array | Array of Tax ID which is apply on tax. Like ["95A1956E-E60A-4FAC-8EC4-C88EE7431280"] |
TasklineToTax |
Array | TasklineToTax contains a tax details array with the below fields. |
TasklineToTaxID |
String | TaxID of task tax. |
PercentageDec |
Float | Tax percentage of task. |
Name |
String | Name of tax. |
Request Sample
Example UPDATE Purchase Order JSON Request: {
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"PurchaseOrderID":"C9A27BF3-EED7-47F0-8FC9-EC643543B034",
"PurchaseOrderHeader": "Test PO entry via public",
"PurchaseOrderNumber": "13",
"ShippingCost": 15,
"ShippingMethod": "Standard Ground",
"DiscountDec": "0.00",
"PurchaseOrderTerms": "Testing Terms and Conditions 10 number Update",
"PurchaseOrderNotes": "Testing Notes 4 number",
"EntryDate": "2022-4-22 11:32:10",
"TotalAmount": "1156.90",
"SubTotal": 1141.8999999999999,
"PurchaseOrderFolder": {
"isroundoff": 0,
"rounded_amount": 0,
"Billing_Add": {
"Street1": "Near Sardar Nagar",
"Street2": "105 Alfa Heights",
"City": "Ra",
"State": "Guj",
"Country": "India",
"Zip": "360005"
},
"Secondary_Add": {
"Street1": "Near Sardar Nagar",
"Street2": "105 Alfa Heights",
"City": "Ra",
"State": "Guj",
"Country": "India",
"Zip": "360005"
},
"Percentage": 0,
"depositeAmount": "0.00"
},
"DeviceID": "1093193415.1644912014",
"ContactID": "5ACC3AEF-8EAB-4DB1-B709-279261C59E0C",
"SelectedCurrency": "en_US",
"AttachmentFile": "FILE DATA",
"AttachmentType": "4",
"ProductData": [
{
"ProductName": "Apple iPhone 11 Pro (64GB) - Silver",
"Quantity": 1,
"UnitCost": "1145.00",
"ProductNotes": "5.8-inch (14.7 cm diagonal) Super Retina XDR OLED display.",
"ProductID": "",
"Total": 1122.1,
"SubAmount": 1122.1,
"DiscountIsPercentage": "1",
"ProductType": "piece",
"DiscountValue": "2P",
"StockUpdate": 1,
"ItemlineToTaxList": [
{
"ItemlineToTaxListID": "95A1956E-E60A-4FAC-8EC4-C88EE7431280",
"PercentageDec": "10.0000",
"Name": "Default"
}
],
"TaxID": [
"95A1956E-E60A-4FAC-8EC4-C88EE7431280"
],
"orderindex": 1
}
],
"TaskData": [
{
"TaskName": "task 20",
"Hours": 2,
"TaskRate": "10.00",
"TimeNotes": "",
"TaskID": "",
"Total": 19.8,
"DiscountIsPercentage": "1",
"DiscountValue": "1P",
"TasklineToTax": [
{
"TasklineToTaxID": "95A1956E-E60A-4FAC-8EC4-C88EE7431280",
"PercentageDec": "10.0000",
"Name": "Default"
}
],
"TaxID": [
"95A1956E-E60A-4FAC-8EC4-C88EE7431280"
],
"TaskType": "",
"orderindex": 2
}
],
"UsedTax": [],
"ServiceType": "1",
"TimeZone": "Asia/Calcutta"
}
Response Sample
Result example UPDATE Purchase Order JSON Response:{
"status": 200,
"message": "Purchase Order updated.",
"data": {
"PurchaseOrderID": "BDBD2F7A-87EE-475C-B473-C48521BAFAED",
"Amount": "0.0000",
"AmountPaid": "0.0000",
"Discount": "A|N",
"DiscountDec": 0,
"DiscountValue": "",
"EntryDate": "2022-05-18 12:40:27",
"PurchaseOrderHeader": "Purchase Order Demo Update",
"PurchaseOrderStatus": "Draft",
"ArchiveStatus": 0,
"PurchaseOrderToPayment": "",
"Extra1": "",
"Extra2": "",
"Extra3": "",
"PurchaseOrderFolder": "{\"isroundoff\":{\"Zip\":\"360005\"},\"rounded_amount\":\"\",\"Billing\":\"0\",\"Billing_Add\":{\"Street1\":\"Near Sardar Nagar\",\"Street2\":\"105 Alfa Heights\",\"City\":\"Rajkot\",\"State\":\"Gujarat\",\"Country\":\"India\"},\"Secondary\":\"0\",\"Secondary_Add\":{\"Street1\":\"Near Sardar Nagar\",\"Street2\":\"105 Alfa Heights\",\"City\":\"Rajkot\",\"State\":\"Gujarat\",\"Country\":\"India\",\"Zip\":\"360005\"},\"Percentage\":\"0\",\"depositeAmount\":\"0.00\"}",
"PurchaseOrderNotes": "Purchase Order demo content update",
"PurchaseOrderNumber": "16",
"PurchaseOrderPoNo": "",
"PurchaseOrderSectionRange": "",
"SelectedCurrency": "en_IN",
"ShippingCost": 5,
"ShippingMethod": "Standard Ground",
"Status": "active",
"SubTotal": 313.8,
"TaxValue": "",
"Terms": "Purchase Order demo terms update",
"Total": 356.8,
"Type": 1,
"PurchaseOrderToImageInfo": "",
"PurchaseOrderToItemline": "",
"ContactID": "0B505706-B5F2-435B-B2AF-7DD81B89893C",
"PurchaseOrderToTaskLine": "",
"PurchaseOrderToUsedTax": "",
"DeviceID": "1093193415.1644912014",
"CreatedDate": "2022-06-28 07:39:19",
"SyncDate": "",
"ModificationDate": "2022-06-28 07:39:19",
"IsInvoiceDelete": 0,
"CreatedAt": "2022-06-28T07:39:19.000000Z",
"UpdatedAt": "2022-06-28T07:39:19.000000Z",
"ServiceType": "1",
"CustomerEmail": "pp@yopmail.com",
"CompanyId": "8D5D856F-E370-45CC-8128-11EB9801805D",
"EntryDateFormat": "May 18, 2022",
"ContactName": "aaa",
"ContactFirstLastname": "pp pp",
"EmailFontName": "Arial",
"EmailFontSize": 12,
"Attachment": "https://mi-doc.s3.amazonaws.com/local/9561/imageinfo/A78707DF-2C7E-4944-8950-B77145CCA77E.png?AWSAccessKeyId=AKIA43TXFBRTCBXKZYZ6&Expires=1656403161&Signature=sE0u7Ci6PMxLit1akduG2DVZ56Q%3D",
"Currency": {
"CurrencyLocale": "en_IN",
"Code": "INR",
"Symbol": "₹"
},
"Products": [
{
"ProductID": "182BA686-499F-4B07-9040-83E3A6B23225",
"InvoiceProductID": "B11814C5-0A8F-4008-ADA5-09E2F9B54D63",
"ProductName": "Black Shirt",
"ModificationDate": "2022-06-28 07:39:19",
"Quantity": 2,
"Total": 304,
"UnitCost": 160,
"DiscountIsPercentage": 1,
"DiscountValue": "5",
"ProductNotes": "Black Shirt update test",
"ProductImage": "",
"TaxName": "95A1956E-E60A-4FAC-8EC4-C88EE7431280"
}
],
"Tasks": [
{
"TaskID": "2908192A-85C7-49D8-A18F-502782EC2EAE",
"InvoiceTaskID": "FEBCA1C6-D3BF-4662-AEA5-75E627B726E7",
"taskName": "Task1",
"ModificationDate": "2022-06-28 07:39:19",
"Hours": 1,
"Total": 9.8,
"Rate": 10,
"DiscountIsPercentage": 1,
"DiscountValue": "2",
"TaskNotes": "",
"TaxName": "95A1956E-E60A-4FAC-8EC4-C88EE7431280"
}
]
}
}
Details Purchase Order
To Get Purchase Order Details, you need to make a GET call to the following URL:
https://www.mooninvoice.com/api_mi/public/purchase_order_details
parameters for DETAILS Purchase Order
required fields
| Field | Type | Description |
|---|---|---|
| CompanyID | String | CompanyID is for details of purchase order of specific Company. |
| ServiceType | String | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
| PurchaseOrderID | String | Purchase Order Identifier. |
Request Sample
Example DETAILS Purchase Order JSON Request: {
"PurchaseOrderID": "BDBD2F7A-87EE-475C-B473-C48521BAFAED",
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"ServiceType": "1"
}
Response Sample
Result example DETAILS Estimate JSON Response: {
"status": 200,
"message": "Data received.",
"data": {
"PurchaseOrderID": "BDBD2F7A-87EE-475C-B473-C48521BAFAED",
"Amount": "0.0000",
"AmountPaid": "0.0000",
"Discount": "A|N",
"DiscountDec": 0,
"DiscountValue": "",
"EntryDate": "2022-05-18 12:40:27",
"PurchaseOrderHeader": "Purchase Order Demo Update",
"PurchaseOrderStatus": "Draft",
"ArchiveStatus": 0,
"PurchaseOrderToPayment": "",
"Extra1": "",
"Extra2": "",
"Extra3": "",
"PurchaseOrderFolder": "{\"isroundoff\":{\"Zip\":\"360005\"},\"rounded_amount\":\"\",\"Billing\":\"0\",\"Billing_Add\":{\"Street1\":\"Near Sardar Nagar\",\"Street2\":\"105 Alfa Heights\",\"City\":\"Rajkot\",\"State\":\"Gujarat\",\"Country\":\"India\"},\"Secondary\":\"0\",\"Secondary_Add\":{\"Street1\":\"Near Sardar Nagar\",\"Street2\":\"105 Alfa Heights\",\"City\":\"Rajkot\",\"State\":\"Gujarat\",\"Country\":\"India\",\"Zip\":\"360005\"},\"Percentage\":\"0\",\"depositeAmount\":\"0.00\"}",
"PurchaseOrderNotes": "Purchase Order demo content update",
"PurchaseOrderNumber": "16",
"PurchaseOrderPoNo": "",
"PurchaseOrderSectionRange": "",
"SelectedCurrency": "en_IN",
"ShippingCost": 5,
"ShippingMethod": "Standard Ground",
"Status": "active",
"SubTotal": 313.8,
"TaxValue": "",
"Terms": "Purchase Order demo terms update",
"Total": 356.8,
"Type": 1,
"PurchaseOrderToImageInfo": "",
"PurchaseOrderToItemline": "",
"ContactID": "0B505706-B5F2-435B-B2AF-7DD81B89893C",
"PurchaseOrderToTaskLine": "",
"PurchaseOrderToUsedTax": "",
"DeviceID": "1093193415.1644912014",
"CreatedDate": "2022-06-28 07:39:19",
"SyncDate": "",
"ModificationDate": "2022-06-28 07:39:19",
"IsInvoiceDelete": 0,
"CreatedAt": "2022-06-28T07:39:19.000000Z",
"UpdatedAt": "2022-06-28T07:39:19.000000Z",
"ServiceType": "1",
"CustomerEmail": "pp@yopmail.com",
"CompanyId": "8D5D856F-E370-45CC-8128-11EB9801805D",
"EntryDateFormat": "May 18, 2022",
"ContactName": "aaa",
"ContactFirstLastname": "pp pp",
"EmailFontName": "Arial",
"EmailFontSize": 12,
"Attachment": "https://mi-doc.s3.amazonaws.com/local/9561/imageinfo/A78707DF-2C7E-4944-8950-B77145CCA77E.png?AWSAccessKeyId=AKIA43TXFBRTCBXKZYZ6&Expires=1656403760&Signature=luF6SlFPiq7YHipm4NbOg7dFGm4%3D",
"Currency": {
"CurrencyLocale": "en_IN",
"Code": "INR",
"Symbol": "₹"
},
"Products": [
{
"ProductID": "182BA686-499F-4B07-9040-83E3A6B23225",
"InvoiceProductID": "B11814C5-0A8F-4008-ADA5-09E2F9B54D63",
"ProductName": "Black Shirt",
"ModificationDate": "2022-06-28 07:39:19",
"Quantity": 2,
"Total": 304,
"UnitCost": 160,
"DiscountIsPercentage": 1,
"DiscountValue": "5",
"ProductNotes": "Black Shirt update test",
"ProductImage": "",
"TaxName": "95A1956E-E60A-4FAC-8EC4-C88EE7431280"
}
],
"Tasks": [
{
"TaskID": "2908192A-85C7-49D8-A18F-502782EC2EAE",
"InvoiceTaskID": "FEBCA1C6-D3BF-4662-AEA5-75E627B726E7",
"taskName": "Task1",
"ModificationDate": "2022-06-28 07:39:19",
"Hours": 1,
"Total": 9.8,
"Rate": 10,
"DiscountIsPercentage": 1,
"DiscountValue": "2",
"TaskNotes": "",
"TaxName": "95A1956E-E60A-4FAC-8EC4-C88EE7431280"
}
]
}
}
Purchase Order Delete
To Delete Purchase Order, you need to make a DELETE call to the following URL:
https://www.mooninvoice.com/api_mi/public/purchase_order_delete
parameters for Purchase Order Delete
required fields
| Field | Type | Description |
|---|---|---|
| PurchaseOrderID | String | Purchase Order Identifier. |
| CompanyID | String | CompanyID is for delete of purchase order of specific Company. |
| DeviceID | Float | DeviceID is an unique identifier of your device. |
| ServiceType | Integer | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
Request Sample
Example Delete Purchase Order JSON Request: {
"PurchaseOrderID": "BDBD2F7A-87EE-475C-B473-C48521BAFAED",
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"DeviceID":"1093193415.1644912014",
"ServiceType": "1"
}
Response Sample
Result example Purchase Order Delete JSON Response: {
"status": 200,
"message": "1 purchase order(s) move to trash.",
"data": []
}
Get Company
To Get Company, you need to make a GET call to the following URL:
https://www.mooninvoice.com/api_mi/public/company_list
parameters for GET Company
required fields
| Field | Type | Description |
|---|---|---|
| CompanySort | String | CompanySort is for sorting record by ascending or decending order wise record. CompanySort must be contain asc or desc value. |
| ServiceType | Integer | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
Request Sample
Example GET Company JSON Request: {
"CompanySort":"asc",
"ServiceType":"1"
}
Response Sample
Result example GET Company JSON Response: {
"status": 200,
"message": "Data received.",
"data": [
{
"CompanyID": "30E8ABDE-8B09-418A-B52C-8C87B844BC66",
"Email": "democompany@yopmail.com",
"CompanyName": "Demo Company",
"CompanyIsDelete": 0,
"Country": "India",
"PhNo": "",
"CompanyLogo": "",
"CompanyLogoThumb": null,
"CompanyIsSelected": 0,
"RolesID": null,
"GroupID": null,
"RoleType": 0,
"ServiceType": "1",
"Access": "1",
"LogoThumbnail": "https://placehold.jp/25/007aff/fff/50x50.png?text=A"
},
{
"CompanyID": "71199DA2-8449-4F91-8584-D20A02D71897",
"Email": "company@yopmail.com",
"CompanyName": "Company Name",
"CompanyIsDelete": 0,
"Country": "India",
"PhNo": "",
"CompanyLogo": "",
"CompanyLogoThumb": "",
"CompanyIsSelected": 0,
"RolesID": null,
"GroupID": null,
"RoleType": 0,
"ServiceType": "1",
"Access": "1",
"LogoThumbnail": "https://placehold.jp/25/007aff/fff/50x50.png?text=A"
}
],
}
Create Company
To Create Company, you need to make a POST call to the following URL:
https://www.mooninvoice.com/api_mi/public/create_company
parameters for CREATE Company
required fields
| Field | Type | Description |
|---|---|---|
| ServiceType | Integer | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
| DeviceID | Float | DeviceID is an unique identifier of your device. |
| CompanyName | String | Name of Company/Organization. |
optional fields
| Field | Type | Description |
|---|---|---|
| City | String | City name. |
| Country | String | Company name. |
| DefaultHourRate | Float | Default rate of hours. |
| DiscountOnline | Float | Company's online discount value. |
| CurrencyLocale | String | Local Currency of Company. |
| String | Company's email. | |
| FinacialYear | Numeric | Finacial Year start month value of company. It should in range of 1 to 12 only. |
| CompanyName | String | Name of Company. |
| PaypalEmail | String | Paypal email. |
| PhNo | String | Phone No. of company. |
| State | String | State of Company. |
| Street1 | String | Street1 of address of company. |
| Street2 | String | Street2 of address of company. |
| Zip | String | Zip of address of company. |
| EmailBcc | String | Email Bcc of company. |
| EmailCc | String | Email Cc of Company. |
| VatNo | String | VatNo of company. |
| CompanyLogo | File | Logo of company. |
Request Sample
Example CREATE Company JSON Request: {
"ServiceType": "1",
"DeviceID": "1093193415.1644912014",
"City": "Ahemdabad",
"Country": "India",
"CurrentSelectedTemplate": "DefaultTemplate",
"DefaultHourRate": 0,
"DiscountOnline": 0,
"CurrencyLocale": "",
"Email": "democompany@yopmail.com",
"FinacialYear": 1,
"CompanyName": "Demo Company",
"PaypalEmail": "",
"PhNo": "9809945689",
"State": "Gujarat",
"Street1": "New Street 415",
"Street2": "Near JNV Circle 1258",
"Zip": "360005",
"EmailBcc": "",
"EmailCc": "",
"VatNo": "",
"IsDelete": 0,
"CompanyLogo": "FILE DATA"
}
Response Sample
Result example CREATE Company JSON Response: {
"status": 200,
"message": "Company created.",
"data": {
"CompanyData": {
"CompanyID": "73841C0A-D6DF-413C-8B92-026EB1AD90AF",
"DeviceID": "1093193415.1644912014",
"DicountOnLine": 0,
"FinacialYear": 0,
"IsSelected": 0,
"DefaultHourRate": "0.000",
"Address": "New Street 415 Near JNV Circle 1258 Ahemdabad Gujarat-360005",
"City": "Ahemdabad",
"Country": "India",
"CreditNotes": "",
"CurrencyLocale": "",
"CurrentSelectedTemplate": "DefaultTemplate",
"CustSign": "0",
"DateFormate": "",
"Email": "democompany@yopmail.com",
"EmailBcc": "",
"EmailCc": "",
"EstimateNotes": "",
"Extra1": "",
"Extra2": "",
"Extra3": "",
"InvoicesNotes": "",
"CompanyName": "Demo Company",
"PayPalEmail": "",
"PhNo": "9809945689",
"PoNotes": "",
"State": "Gujarat",
"Street1": "New Street 415",
"Street2": "Near JNV Circle 1258",
"VatNo": "",
"Zip": "360005",
"ArchiveStatus": 0,
"Address2": "",
"CompanyLogo": "",
"CompanyLogoThumb": "",
"Type": 0,
"CreationDate": "0000-00-00 00:00:00",
"Modificationdate": "2022-06-28 12:38:27",
"UpdatedAt": "2022-06-28 12:38:27",
"CreatedAt": "2022-06-28 12:38:27",
"SyncDate": "0000-00-00 00:00:00",
"CompanyIsDelete": 0,
"ServiceType": "1",
"TableHeight": null,
"TableWidth": null,
"TableSize": null,
"RoleType": 0,
"CountryID": 101,
"LanguageID": "en_US",
"UserAccess": [],
"CurrencyLocale_c": "",
"SelectedLineColor": "",
"SelectedFillColor": "",
"SelectedFontColor": "",
"SelectedFillTextColor": "",
"Top": "30",
"Bottom": "50",
"Left": "40",
"Right": "40",
"Currency": {
"Code": "",
"Symbol": "",
"CurrencyLocale": ""
}
}
}
}
Update Company
To Update Company, you need to make a PUT call to the following URL:
https://www.mooninvoice.com/api_mi/public/update_company
parameters for UPDATE Company
required fields
| Field | Type | Description |
|---|---|---|
| CompanyID | String | Company Identifier |
| ServiceType | Integer | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
| DeviceID | Float | DeviceID is an unique identifier of your device. |
| CompanyName | String | Name of Company/Organization. |
optional fields
| Field | Type | Description |
|---|---|---|
| City | String | City name. |
| Country | String | Company name. |
| DefaultHourRate | Float | Default rate of hours. |
| DiscountOnline | Float | Company's online discount value. |
| CurrencyLocale | String | Local Currency of Company. |
| String | Company's email. | |
| FinacialYear | Numeric | Finacial Year start month value of company. It should in range of 1 to 12 only. |
| CompanyName | String | Name of Company. |
| PaypalEmail | String | Paypal email. |
| PhNo | Double | Phone No. of company. |
| State | String | State of Company. |
| Street1 | String | Street1 of address of company. |
| Street2 | String | Street2 of address of company. |
| Zip | String | Zip of address of company. |
| EmailBcc | String | Email Bcc of company. |
| EmailCc | String | Email Cc of Company. |
| VatNo | String | VatNo of company. |
| CompanyLogo | File | Logo of company. |
Request Sample
Example UPDATE Company JSON Request: {
"CompanyID": "73841C0A-D6DF-413C-8B92-026EB1AD90AF",
"ServiceType": "1",
"DeviceID": "1093193415.1644912014",
"City": "Ahemdabad",
"Country": "India",
"CurrentSelectedTemplate": "DefaultTemplate",
"DefaultHourRate": 0,
"DiscountOnline": 0,
"CurrencyLocale": "",
"Email": "democompany@yopmail.com",
"FinacialYear": 1,
"CompanyName": "Demo Company",
"PaypalEmail": "",
"PhNo": "9809945689",
"State": "Gujarat",
"Street1": "New Street 415",
"Street2": "Near JNV Circle 1258",
"Zip": "360005",
"EmailBcc": "",
"EmailCc": "",
"VatNo": "",
"IsDelete": 0,
"CompanyLogo": "FILE DATA"
}
Response Sample
Result example UPDATE Company JSON Response: {
"status": 200,
"message": "Company updated",
"data": {
"CompanyData": {
"CompanyID": "73841C0A-D6DF-413C-8B92-026EB1AD90AF",
"DeviceID": "1093193415.1644912014",
"DicountOnLine": 0,
"FinacialYear": 0,
"IsSelected": 0,
"DefaultHourRate": "0.000",
"Address": "New Street 415 Near JNV Circle 1258 Ahemdabad Gujarat-360005",
"City": "Ahemdabad",
"Country": "India",
"CreditNotes": "",
"CurrencyLocale": "",
"CurrentSelectedTemplate": "DefaultTemplate",
"CustSign": "0",
"DateFormate": "",
"Email": "democompany@yopmail.com",
"EmailBcc": "",
"EmailCc": "",
"EstimateNotes": "",
"Extra1": "",
"Extra2": "",
"Extra3": "",
"InvoicesNotes": "",
"CompanyName": "Demo Company",
"PayPalEmail": "",
"PhNo": "9809945689",
"PoNotes": "",
"State": "Gujarat",
"Street1": "New Street 415",
"Street2": "Near JNV Circle 1258",
"VatNo": "",
"Zip": "360005",
"ArchiveStatus": 0,
"Address2": "",
"CompanyLogo": "",
"CompanyLogoThumb": "",
"Type": 0,
"CreationDate": "2022-06-28 13:04:19",
"Modificationdate": "2022-06-28 13:04:19",
"UpdatedAt": "2022-06-28 12:38:27",
"CreatedAt": "2022-06-28 12:38:27",
"SyncDate": "0000-00-00 00:00:00",
"CompanyIsDelete": 0,
"ServiceType": "1",
"TableHeight": null,
"TableWidth": null,
"TableSize": null,
"RoleType": 0,
"CountryID": 101,
"LanguageID": "en_US",
"UserAccess": [],
"CurrencyLocale_c": "",
"SelectedLineColor": "",
"SelectedFillColor": "",
"SelectedFontColor": "",
"SelectedFillTextColor": "",
"Top": "30",
"Bottom": "50",
"Left": "40",
"Right": "40",
"Currency": {
"Code": "",
"Symbol": "",
"CurrencyLocale": ""
}
}
}
}
Details Company
To Get Company Details, you need to make a GET call to the following URL:
https://www.mooninvoice.com/api_mi/public/company_details
parameters for DETAILS Company
required fields
| Field | Type | Description |
|---|---|---|
| CompanyID | String | Company Identifier |
| ServiceType | String | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
Request Sample
Example DETAILS Company JSON Request: {
"CompanyID": "73841C0A-D6DF-413C-8B92-026EB1AD90AF",
"ServiceType": "1"
}
Response Sample
Result example DETAILS Company JSON Response: {
"status": 200,
"message": "Data received.",
"data": {
"CompanyData": {
"CompanyID": "73841C0A-D6DF-413C-8B92-026EB1AD90AF",
"DeviceID": "1093193415.1644912014",
"DicountOnLine": 0,
"FinacialYear": 0,
"IsSelected": 0,
"DefaultHourRate": "0.000",
"Address": "New Street 415 Near JNV Circle 1258 Ahemdabad Gujarat-360005",
"City": "Ahemdabad",
"Country": "India",
"CreditNotes": "",
"CurrencyLocale": "",
"CurrentSelectedTemplate": "DefaultTemplate",
"CustSign": "0",
"DateFormate": "",
"Email": "democompany@yopmail.com",
"EmailBcc": "",
"EmailCc": "",
"EstimateNotes": "",
"Extra1": "",
"Extra2": "",
"Extra3": "",
"InvoicesNotes": "",
"CompanyName": "Demo Company",
"PayPalEmail": "",
"PhNo": "9809945689",
"PoNotes": "",
"State": "Gujarat",
"Street1": "New Street 415",
"Street2": "Near JNV Circle 1258",
"VatNo": "",
"Zip": "360005",
"ArchiveStatus": 0,
"Address2": "",
"CompanyLogo": "",
"CompanyLogoThumb": "",
"Type": 0,
"CreationDate": "2022-06-28 13:04:19",
"Modificationdate": "2022-06-28 13:04:19",
"UpdatedAt": "2022-06-28 12:38:27",
"CreatedAt": "2022-06-28 12:38:27",
"SyncDate": "0000-00-00 00:00:00",
"CompanyIsDelete": 0,
"ServiceType": "1",
"TableHeight": null,
"TableWidth": null,
"TableSize": null,
"RoleType": 0,
"CountryID": 101,
"LanguageID": "en_US",
"UserAccess": [],
"CurrencyLocale_c": "",
"SelectedLineColor": "",
"SelectedFillColor": "",
"SelectedFontColor": "",
"SelectedFillTextColor": "",
"Top": "30",
"Bottom": "50",
"Left": "40",
"Right": "40",
"Currency": {
"Code": "",
"Symbol": "",
"CurrencyLocale": ""
}
}
}
}
Delete Company
To Delete Company, you need to make a DELETE call to the following URL:
https://www.mooninvoice.com/api_mi/public/delete_company
parameters for DELETE Company
required fields
| Field | Type | Description |
|---|---|---|
| CompanyID | String | Company Identifier |
| ServiceType | Integer | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
| DeviceID | Float | DeviceID is an unique identifier of your device. |
Request Sample
Example DELETE Company JSON Request: {
"CompanyID": "73841C0A-D6DF-413C-8B92-026EB1AD90AF",
"ServiceType": "1",
"DeviceID":"1093193415.1644912014"
}
Response Sample
Result example DELETE Company JSON Response: {
"status": 200,
"message": "1 Company(ies) deleted.",
"data": []
}
Get Tax
To Get Tax, you need to make a GET call to the following URL:
https://www.mooninvoice.com/api_mi/public/tax_list
parameters for GET Tax
required fields
| Field | Type | Description |
|---|---|---|
| TaxSort | String | TaxSort is for sorting record by ascending or decending order wise record. TaxSort must be contain asc or desc value. |
| CompanyID | String | CompanyId is for get record by specific Company. |
| ServiceType | Integer | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
| PageSize | Integer | PageSize is for size of per page record. |
optional fields
| Field | Type | Description |
|---|---|---|
| page | Integer | Enter page no. for get page wise records. |
Request Sample
Example GET Tax JSON Request: {
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"TaxSort": "asc",
"ServiceType": "1",
"PageSize": 25,
"page": 1
}
Response Sample
Result example GET Tax JSON Response: {
"status": 200,
"message": "Data Received!",
"data": {
"current_page": 1,
"first_page_url": "https://www.mooninvoice.com/api_mi/public/tax_list?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "https://www.mooninvoice.com/api_mi/public/tax_list?page=1",
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "https://www.mooninvoice.com/api_mi/public/tax_list?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
],
"next_page_url": null,
"path": "https://www.mooninvoice.com/api_mi/public/tax_list",
"per_page": 25,
"prev_page_url": null,
"to": 2,
"total": 2,
"taxes": [
{
"PercentageDec": 10,
"TaxName": "Default",
"Percentage": "P",
"TaxID": "95A1956E-E60A-4FAC-8EC4-C88EE7431280",
"Extra": "1",
"DefaultTax": []
},
{
"PercentageDec": 18,
"TaxName": "NewGST18",
"Percentage": "P",
"TaxID": "CBC0A8DD-EDF5-47B2-B8DB-E7BA953E2C86",
"Extra": "1",
"DefaultTax": []
}
]
}
}
Get All Tax
To Get All Tax List, you need to make a GET call to the following URL:
https://www.mooninvoice.com/api_mi/public/all_tax_list
parameters for GET Tax
required fields
| Field | Type | Description |
|---|---|---|
| CompanyID | String | Company Id for get company's all tax. |
| ServiceType | Integer | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
Request Sample
Example GET Tax JSON Request: {
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"ServiceType": "1"
}
Response Sample
Result example GET Tax JSON Response: {
"status": 200,
"message": "Data Received!",
"data": [
{
"PercentageDec": "10.0000",
"TaxName": "Default",
"Percentage": "P",
"TaxID": "95A1956E-E60A-4FAC-8EC4-C88EE7431280",
"Extra": "1"
},
{
"PercentageDec": "18.0000",
"TaxName": "NewGST18",
"Percentage": "P",
"TaxID": "CBC0A8DD-EDF5-47B2-B8DB-E7BA953E2C86",
"Extra": "1"
}
]
}
Create Tax
To Create Tax, you need to make a POST call to the following URL:
https://www.mooninvoice.com/api_mi/public/add_tax
parameters for CREATE Tax
required fields
| Field | Type | Description |
|---|---|---|
| CompanyID | String | CompanyID is for create tax of specific Company. |
| ServiceType | Integer | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
| DeviceID | Float | DeviceID is an unique identifier of your device. |
| TaxName | String | Name of Tax. |
| PercentageDec | Float | Tax value in percentage. |
optional fields
| Field | Type | Description |
|---|---|---|
| DefaultType | Array | Default Type of task is for default on product or task. If is default for Product then enter P, if is default for task then enter T. DefaultType is contain Array. Like ['T', 'P'] or ['P'] or ['T'] |
Request Sample
Example CREATE Tax JSON Request: {
"TaxName": "NewGST14",
"PercentageDec": 10,
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"DefaultType": [],
"DeviceID": "1093193415.1644912014",
"ServiceType": "1"
}
Response Sample
Result example CREATE Tax JSON Response: {
"status": 200,
"message": "Tax added.",
"data": {
"PercentageDec": "11",
"TaxName": "NewGST11",
"Percentage": "P",
"TaxID": "F30DF02A-4D20-4CAF-BF7D-E4F3294A06B2",
"Extra1": "1"
}
}
Update Tax
To Update Tax, you need to make a PUT call to the following URL:
https://www.mooninvoice.com/api_mi/public/update_tax
parameters for UPDATE Tax
required fields
| Field | Type | Description |
|---|---|---|
| TaxID | String | Tax Identifier |
| CompanyID | String | CompanyID is for create tax of specific Company. |
| ServiceType | Integer | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
| DeviceID | Float | DeviceID is an unique identifier of your device. |
| TaxName | String | Name of Tax. |
| PercentageDec | Float | Tax value in percentage. |
optional fields
| Field | Type | Description |
|---|---|---|
| DefaultType | Array | Default Type of task is for default on product or task. If is default for Product then enter P, if is default for task then enter T. DefaultType is contain Array. Like ['T', 'P'] or ['P'] or ['T'] |
Request Sample
Example UPDATE Tax JSON Request: {
"TaxID":"EBD10E4E-461E-4DAC-8583-1E478C234B94",
"TaxName": "NewGST14",
"PercentageDec": 10,
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"DefaultType": [],
"DeviceID": "1093193415.1644912014",
"ServiceType": "1"
}
Response Sample
Result example UPDATE Payment JSON Response:{
"status": 200,
"message": "Tax updated.",
"data": {
"PercentageDec": "11",
"TaxName": "NewGST11 Update",
"Percentage": "P",
"TaxID": "F30DF02A-4D20-4CAF-BF7D-E4F3294A06B2",
"Extra1": "1"
}
}
Details Tax
To Get Tax Details, you need to make a GET call to the following URL:
https://www.mooninvoice.com/api_mi/public/tax_details
parameters for DETAILS Tax
required fields
| Field | Type | Description |
|---|---|---|
| CompanyID | String | CompanyID is for details of tax of specific Company. |
| ServiceType | String | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
| TaxID | String | Tax Identifier. |
| DeviceID | String | DeviceID is an unique identifier of your device. |
Request Sample
Example DETAILS Tax JSON Request: {
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"ServiceType": "1",
"TaxID": "F30DF02A-4D20-4CAF-BF7D-E4F3294A06B2",
"DeviceID": "1093193415.1644912014"
}
Response Sample
Result example DETAILS Tax JSON Response: {
"status": 200,
"message": "Data received.",
"data": {
"PercentageDec": "11",
"TaxName": "NewGST11 Update",
"Percentage": "P",
"TaxID": "F30DF02A-4D20-4CAF-BF7D-E4F3294A06B2",
"Extra1": "1"
}
}
Delete Tax
To Delete Tax, you need to make a DELETE call to the following URL:
https://www.mooninvoice.com/api_mi/public/delete_tax
parameters for DELETE Tax
required fields
| Field | Type | Description |
|---|---|---|
| CompanyID | String | CompanyID is for delete tax of specific Company. |
| ServiceType | Integer | ServiceType is describe type of Service like MI WEB or POS. For WEB enter 1 and for POS enter 0. |
| TaxID | String | Tax Identifier. |
| DeviceID | Float | DeviceID is an unique identifier of your device. |
Request Sample
Example DELETE Tax JSON Request: {
"CompanyID": "8D5D856F-E370-45CC-8128-11EB9801805D",
"ServiceType": "1",
"TaxID": "F30DF02A-4D20-4CAF-BF7D-E4F3294A06B2",
"DeviceID": "1093193415.1644912014"
}
Response Sample
Result example DELETE Tax JSON Response: {
"status": 200,
"message": "1 tax(es) deleted.",
"data": []
}
Errors
The Moon Invoice API uses the following error codes:
| Error Code | Meaning |
|---|---|
| 201 | Validation or other common error. |
| 204 | Request has been succeed but content not available or other. |
| 400 | Bad Request. |
| 401 | Unauthorized. |