Billiecart API

SearchHeldSalaryPackagesRequest

**Requires Authentication**
Requires the role:	holder

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


export class GetOperationUnTenanted<TResponse> implements IHasGetOptions, IGet
{
    public embed?: string;

    public constructor(init?: Partial<GetOperationUnTenanted<TResponse>>) { (Object as any).assign(this, init); }
}

export class SearchOperationUnTenanted<TResponse> extends GetOperationUnTenanted<TResponse> implements IHasSearchOptions
{
    public distinct?: string;
    public limit?: number;
    public offset?: number;
    public sort?: string;
    public filter?: string;
    public search?: string;

    public constructor(init?: Partial<SearchOperationUnTenanted<TResponse>>) { super(init); (Object as any).assign(this, init); }
}

export class SearchOperationTenanted<TResponse> extends SearchOperationUnTenanted<TResponse> implements ITenantedRequest
{
    public organisationId?: string;

    public constructor(init?: Partial<SearchOperationTenanted<TResponse>>) { super(init); (Object as any).assign(this, init); }
}

export enum SortDirection
{
    Ascending = 'Ascending',
    Descending = 'Descending',
}

export class Sorting
{
    public by?: string;
    public direction: SortDirection;

    public constructor(init?: Partial<Sorting>) { (Object as any).assign(this, init); }
}

export class Filtering
{
    public fields?: string[];
    public search?: string;

    public constructor(init?: Partial<Filtering>) { (Object as any).assign(this, init); }
}

export class SearchMetadata
{
    public total: number;
    public limit: number;
    public offset: number;
    public sort?: Sorting;
    public filter?: Filtering;

    public constructor(init?: Partial<SearchMetadata>) { (Object as any).assign(this, init); }
}

export class SearchOperationResponse
{
    public metadata?: SearchMetadata;

    public constructor(init?: Partial<SearchOperationResponse>) { (Object as any).assign(this, init); }
}

export class SalaryPackageSummary implements IIdentifiableResource
{
    public customerId?: string;
    public customerFirstName?: string;
    public customerLastName?: string;
    public employerName?: string;
    public vehicleLicensePlate?: string;
    public salarySacrificeAmount: number;
    public currentBalance: number;
    public preTaxDeduction?: number;
    public postTaxDeduction?: number;
    public leaseTerm?: number;
    public employerId?: string;
    public status?: string;
    public id?: string;

    public constructor(init?: Partial<SalaryPackageSummary>) { (Object as any).assign(this, init); }
}

export class SearchHeldSalaryPackagesResponse extends SearchOperationResponse
{
    public responseStatus?: ResponseStatus;
    public salaryPackages?: SalaryPackageSummary[];

    public constructor(init?: Partial<SearchHeldSalaryPackagesResponse>) { super(init); (Object as any).assign(this, init); }
}

export class SearchHeldSalaryPackagesRequest extends SearchOperationTenanted<SearchHeldSalaryPackagesResponse>
{

    public constructor(init?: Partial<SearchHeldSalaryPackagesRequest>) { super(init); (Object as any).assign(this, init); }
}

TypeScript 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"}}}