Documentation

  2. Home
  4. Docs
  6. Documentation
  8. Item catalogue APIs
  10. API: List Price list items

API: List Price list items

The purpose of this API is to list price list items.

Request

URL https://your_account.modulus.biz/api/itm/PublicItem?token=YOUR_TOKEN
API Name PublicListItem
Method GET
Source Third Party Server
Recipient modulus® Server
Content Type application/json

Query String Parameters

Parameter Required Type Description
token Yes Text Your authentication token.
price_list_id  Yes Number The ID of the price list
include_disabled No Boolean Defaults to false. If true, disabled items are also returned
page_size No Number Defaults to 100. Number of returned items.
page_number No Number Defaults to 1. Page number from which the price list items will be returned.

Responses

HTTP Status result title message object
Success Responses        
200 OK true Success Price list items
retrieved successfully.		 
{"meta_data": {
            "page_number": 1,
            "page_size": "1",
            "page_count": 80,
            "record_count": 80
        },
        "data": [
            {
                "intID": "2",
                "decPrice": 300,
                "intTaxTypeID": "3",
                "strAlias": "",
                "intUnitID": "2",
                "intPriceListID": "1",
                "boolIsDisabled": false,
                "boolIsUsed": true,
                "objItem": [
                    {
                        "intID": "2",
                        "intBaseUnitID": "2",
                        "intDisplayUnitID": "2",
                        "intBkRevenueAccountID": -1,
                        "intBkDiscountAccountID": -1,
                        "intBkReturnAccountID": -1,
                        "intBkExpenseAccountID": -1,
                        "decDisplayUnitRatio": "1.00",
                        "strName": "X- Ray extra posision at the same visit",
                        "strAlias": "",
                        "strCode": "2",
                        "boolIsDisabled": "0",
                        "strDescription": "",
                        "strNotes": "",
                        "strCustomAttributes": "",
                        "strType": "service",
                        "boolIsAsset": false,
                        "boolIsProduction": false,
                        "boolIsPurchasing": false,
                        "boolIsSelling": true,
                        "arrCustomAttribute": [],
                        "objBaseUnit": {
                            "intID": "2",
                            "strUnit": "service",
                            "strCode": "C62",
                            "strItemType": "service",
                            "boolIsUsed": ""
                        },
                        "objDisplayUnit": {
                            "intID": "2",
                            "strUnit": "service",
                            "strCode": "C62",
                            "strItemType": "service",
                            "boolIsUsed": ""
                        },
                        "arrUnit": [
                            {
                                "intItemID": "2",
                                "intUnitID": "2",
                                "decRatioToBaseUnit": "1.00",
                                "intReferenceUnitID": "2",
                                "decRatioToReferenceUnit": "1.00",
                                "objUnit": {
                                    "intID": "2",
                                    "strUnit": "service",
                                    "strCode": "C62",
                                    "strItemType": "service",
                                    "boolIsUsed": ""
                                },
                                "objReferenceUnit": {
                                    "intID": "2",
                                    "strUnit": "service",
                                    "strCode": "C62",
                                    "strItemType": "service",
                                    "boolIsUsed": ""
                                }
                            }
                        ]
                    }
                ],
                "objPriceList": {
                    "intID": 1,
                    "intCurrencyID": 1,
                    "strName": "MEDI GO Home",
                    "strType": "Sales",
                    "strDescription": null,
                    "dmCreatedOn": null,
                    "intCreatedByUserID": -1,
                    "boolIsUsed": true
                },
                "objUnit": {
                    "intID": "2",
                    "strUnit": "service",
                    "strCode": "C62",
                    "strItemType": "service",
                    "boolIsUsed": ""
                },
                "objTaxType": {
                    "intID": 3,
                    "strCode": "V003",
                    "strTaxType": "VAT Exempted",
                    "strType": "LNG_ENUM_PERCENT",
                    "strNature": "LNG_ENUM_NATURE_ADDITION",
                    "intValue": 0,
                    "intSuperTypeID": 2,
                    "boolIsUsed": true,
                    "objSuperTaxType": {
                        "intID": 2,
                        "strCode": "T1",
                        "strTaxType": "Value added tax",
                        "strType": "LNG_ENUM_PERCENT",
                        "strNature": "LNG_ENUM_NATURE_ADDITION",
                        "intValue": 14,
                        "intSuperTypeID": -1,
                        "boolIsUsed": true
                    }
                }
            }
        ]
}
Failure Responses        
500 Internal Server Error false Error Error message describe the problem.  

Example

Request 
curl --request GET 'https://your_account.modulus.biz/api/itm/PriceListItem?token=YOUR_TOKEN&price_list_id=PRICE_LIST_ID' \ --header 'Content-Type: application/json'
200 OK 
Request
curl --request GET 'https://your_account.modulus.biz/api/itm/PriceListItem?token=YOUR_TOKEN&price_list_id=PRICE_LIST_ID' \ --header 'Content-Type: application/json'
200 OK
{
"result": true,
"title": "Success",
"message": "Price list items retrieved successfully.",
"object": {
"meta_data": {
"page_number": 1,
"page_size": "1",
"page_count": 80,
"record_count": 80
},
"data": [
{
"intID": "2",
"decPrice": 300,
"intTaxTypeID": "3",
"strAlias": "",
"intUnitID": "2",
"intPriceListID": "1",
"boolIsDisabled": false,
"boolIsUsed": true,
"objItem": [
{
"intID": "2",
"intBaseUnitID": "2",
"intDisplayUnitID": "2",
"intBkRevenueAccountID": -1,
"intBkDiscountAccountID": -1,
"intBkReturnAccountID": -1,
"intBkExpenseAccountID": -1,
"decDisplayUnitRatio": "1.00",
"strName": "X- Ray extra posision at the same visit",
"strAlias": "",
"strCode": "2",
"boolIsDisabled": "0",
"strDescription": "",
"strNotes": "",
"strCustomAttributes": "",
"strType": "service",
"boolIsAsset": false,
"boolIsProduction": false,
"boolIsPurchasing": false,
"boolIsSelling": true,
"arrCustomAttribute": [],
"objBaseUnit": {
"intID": "2",
"strUnit": "service",
"strCode": "C62",
"strItemType": "service",
"boolIsUsed": ""
},
"objDisplayUnit": {
"intID": "2",
"strUnit": "service",
"strCode": "C62",
"strItemType": "service",
"boolIsUsed": ""
},
"arrUnit": [
{
"intItemID": "2",
"intUnitID": "2",
"decRatioToBaseUnit": "1.00",
"intReferenceUnitID": "2",
"decRatioToReferenceUnit": "1.00",
"objUnit": {
"intID": "2",
"strUnit": "service",
"strCode": "C62",
"strItemType": "service",
"boolIsUsed": ""
},
"objReferenceUnit": {
"intID": "2",
"strUnit": "service",
"strCode": "C62",
"strItemType": "service",
"boolIsUsed": ""
}
}
]
}
],
"objPriceList": {
"intID": 1,
"intCurrencyID": 1,
"strName": "MEDI GO Home",
"strType": "Sales",
"strDescription": null,
"dmCreatedOn": null,
"intCreatedByUserID": -1,
"boolIsUsed": true
},
"objUnit": {
"intID": "2",
"strUnit": "service",
"strCode": "C62",
"strItemType": "service",
"boolIsUsed": ""
},
"objTaxType": {
"intID": 3,
"strCode": "V003",
"strTaxType": "VAT Exempted",
"strType": "LNG_ENUM_PERCENT",
"strNature": "LNG_ENUM_NATURE_ADDITION",
"intValue": 0,
"intSuperTypeID": 2,
"boolIsUsed": true,
"objSuperTaxType": {
"intID": 2,
"strCode": "T1",
"strTaxType": "Value added tax",
"strType": "LNG_ENUM_PERCENT",
"strNature": "LNG_ENUM_NATURE_ADDITION",
"intValue": 14,
"intSuperTypeID": -1,
"boolIsUsed": true
}
}
}
]
}
}