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 .xml suffix or ?format=xml

HTTP + XML

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/xml

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

<SearchHeldSalaryPackagesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.SalaryPackages">
  <Metadata xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Interfaces" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations">
    <d2p1:Filter>
      <d2p1:Fields xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:Fields>
      <d2p1:Search>String</d2p1:Search>
    </d2p1:Filter>
    <d2p1:Limit>0</d2p1:Limit>
    <d2p1:Offset>0</d2p1:Offset>
    <d2p1:Sort>
      <d2p1:By>String</d2p1:By>
      <d2p1:Direction>Ascending</d2p1:Direction>
    </d2p1:Sort>
    <d2p1:Total>0</d2p1:Total>
  </Metadata>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <SalaryPackages xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Interfaces.Resources">
    <d2p1:SalaryPackageSummary>
      <d2p1:CurrentBalance>0</d2p1:CurrentBalance>
      <d2p1:CustomerFirstName>String</d2p1:CustomerFirstName>
      <d2p1:CustomerId>String</d2p1:CustomerId>
      <d2p1:CustomerLastName>String</d2p1:CustomerLastName>
      <d2p1:EmployerId>String</d2p1:EmployerId>
      <d2p1:EmployerName>String</d2p1:EmployerName>
      <d2p1:Id>String</d2p1:Id>
      <d2p1:LeaseTerm>0</d2p1:LeaseTerm>
      <d2p1:PostTaxDeduction>0</d2p1:PostTaxDeduction>
      <d2p1:PreTaxDeduction>0</d2p1:PreTaxDeduction>
      <d2p1:SalarySacrificeAmount>0</d2p1:SalarySacrificeAmount>
      <d2p1:Status>String</d2p1:Status>
      <d2p1:VehicleLicensePlate>String</d2p1:VehicleLicensePlate>
    </d2p1:SalaryPackageSummary>
  </SalaryPackages>
</SearchHeldSalaryPackagesResponse>