Trendsic Platform Service

<back to all web services

PayrollBatchRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/PayrollBatch
"use strict";
export class CommissionBatch {
    /** @param {{CommissionBatchId?:number,DateCreated?:string,CreatedBy?:string,CommissionTitle?:string,CommissionStartDate?:string,CommissionEndDate?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    CommissionBatchId;
    /** @type {string} */
    DateCreated;
    /** @type {string} */
    CreatedBy;
    /** @type {string} */
    CommissionTitle;
    /** @type {string} */
    CommissionStartDate;
    /** @type {string} */
    CommissionEndDate;
}
export class PayrollBatchResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Payroll?:CommissionBatch[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {CommissionBatch[]} */
    Payroll = [];
}
export class PayrollBatchRequest {
    constructor(init) { Object.assign(this, init) }
}

JavaScript PayrollBatchRequest DTOs

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

HTTP + CSV

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

GET /v1/PayrollBatch HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Payroll":[{"CommissionBatchId":0,"DateCreated":"0001-01-01T00:00:00.0000000","CreatedBy":"String","CommissionTitle":"String","CommissionStartDate":"0001-01-01T00:00:00.0000000","CommissionEndDate":"0001-01-01T00:00:00.0000000"}]}