TAG LINE
SMALL TITLE

Deep Search - Related Objects

Last Updated: May 12, 2021

Some of the objects in LogiSense Billing allow for deep searches for objects contained as children of the parent as an addition to the standard Search capability. This allows pull back multiple levels of information each with its own searchable fields.

The current available objects for deep search are:

  • “/Invoice/Search”

  • “/RatePlan/Search”

  • “/Account/Package/Search”

By default children are not included in the response until specifically requested. The syntax for requesting a child with no overrides is the key followed by an empty object: (e.g. “rates”: { } ).

Example:

POST to v4/RatePlan/Search

{
    "query": {
        "top": 10000,
        "orderBy": [
            {
                "name": "identity",
                "direction": "asc"
            }
        ],
        "usageRateGroups": {
            "top": 3,
            "fields": [
                "name",
                "priority",
                "currencyId"
            ],
            "orderBy": [
                {
                    "name": "priority",
                    "direction": "desc"
                }
            ],
            "rates": {}
        }
    }
}

Example:

POST to v4/Invoice/Search

{
    "query": {
        "top": 2,
        "fields": [
            "name"
        ]
        "search": [
            {
                "name": "invoiceStatusTypeId",
                "operator": "eq",
                "value": 5
            }
        ],
        "orderBy": [
            {
                "name": "identity",
                "direction": "desc"
            }
        ],
        "taxSummary": {
            "fields": [
                "taxRateName",
                "invoiceAmount"
            ]
        },
        "invoiceHistory": {},
        "invoiceItems": {
            "top": 100,
            "fields": [
                "invoiceAmount",
                "periodStart",
                "periodEnd"
            ],
            "search": [
                {
                    "name": "invoiceItemTypeId",
                    "operator": "eq",
                    "value": 4
                }
            ],
            "orderBy": [
                {
                    "name": "invoiceAmount",
                    "direction": "desc"
                }
            ],
        }
    }
}