Billiecart API

SearchHeldSalaryPackagesRequest

**Requires Authentication**
Requires the role:	holder

The following routes are available for this service:
GET	/packages/held

import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


open class SearchHeldSalaryPackagesRequest : SearchOperationTenanted<SearchHeldSalaryPackagesResponse>()
{
}

open class SearchOperationTenanted<TResponse> : SearchOperationUnTenanted<TResponse>(), ITenantedRequest
{
    var organisationId:String? = null
}

open class SearchOperationUnTenanted<TResponse> : GetOperationUnTenanted<TResponse>(), IHasSearchOptions
{
    var distinct:String? = null
    var limit:Int? = null
    var offset:Int? = null
    var sort:String? = null
    var filter:String? = null
    var search:String? = null
}

open class GetOperationUnTenanted<TResponse> : IHasGetOptions, IGet
{
    var embed:String? = null
}

open class SearchHeldSalaryPackagesResponse : SearchOperationResponse()
{
    var responseStatus:ResponseStatus? = null
    var salaryPackages:ArrayList<SalaryPackageSummary> = ArrayList<SalaryPackageSummary>()
}

open class SearchOperationResponse
{
    var metadata:SearchMetadata? = null
}

open class SearchMetadata
{
    var total:Int? = null
    var limit:Int? = null
    var offset:Int? = null
    var sort:Sorting? = null
    var filter:Filtering? = null
}

open class Sorting
{
    @SerializedName("by") var By:String? = null
    var direction:SortDirection? = null
}

enum class SortDirection
{
    Ascending,
    Descending,
}

open class Filtering
{
    var fields:ArrayList<String> = ArrayList<String>()
    var search:String? = null
}

open class SalaryPackageSummary : IIdentifiableResource
{
    var customerId:String? = null
    var customerFirstName:String? = null
    var customerLastName:String? = null
    var employerName:String? = null
    var vehicleLicensePlate:String? = null
    var salarySacrificeAmount:BigDecimal? = null
    var currentBalance:BigDecimal? = null
    var preTaxDeduction:BigDecimal? = null
    var postTaxDeduction:BigDecimal? = null
    var leaseTerm:Int? = null
    var employerId:String? = null
    var status:String? = null
    var id:String? = null
}

Kotlin SearchHeldSalaryPackagesRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /packages/held HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"salaryPackages":[{"customerId":"String","customerFirstName":"String","customerLastName":"String","employerName":"String","vehicleLicensePlate":"String","salarySacrificeAmount":0,"currentBalance":0,"preTaxDeduction":0,"postTaxDeduction":0,"leaseTerm":0,"employerId":"String","status":"String","id":"String"}],"metadata":{"total":0,"limit":0,"offset":0,"sort":{"by":"String","direction":"Ascending"},"filter":{"fields":["String"],"search":"String"}}}