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
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type CommissionBatch() = 
        member val CommissionBatchId:Int32 = new Int32() with get,set
        member val DateCreated:DateTime = new DateTime() with get,set
        member val CreatedBy:String = null with get,set
        member val CommissionTitle:String = null with get,set
        member val CommissionStartDate:DateTime = new DateTime() with get,set
        member val CommissionEndDate:DateTime = new DateTime() with get,set

    [<AllowNullLiteral>]
    type PayrollBatchResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Payroll:ResizeArray<CommissionBatch> = new ResizeArray<CommissionBatch>() with get,set

    [<AllowNullLiteral>]
    type PayrollBatchRequest() = 
        class end

F# PayrollBatchRequest DTOs

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

HTTP + JSV

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/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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-01,
			CreatedBy: String,
			CommissionTitle: String,
			CommissionStartDate: 0001-01-01,
			CommissionEndDate: 0001-01-01
		}
	]
}