Trendsic Platform Service

<back to all web services

AgreementCreditsRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/serviceagreement/credits
"use strict";
export class CreditLedger {
    /** @param {{CreditLedgerID?:number,TenantId?:string,BranchId?:string,AgreementID?:number,ProjectID?:number,AgreementJobID?:number,Amount?:number,Reason?:string,Status?:string,CreatedBy?:string,CreatedAt?:string,AppliedAt?:string,AgreementName?:string,ProjectName?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    CreditLedgerID;
    /** @type {string} */
    TenantId;
    /** @type {?string} */
    BranchId;
    /** @type {?number} */
    AgreementID;
    /** @type {?number} */
    ProjectID;
    /** @type {?number} */
    AgreementJobID;
    /** @type {?number} */
    Amount;
    /** @type {string} */
    Reason;
    /** @type {string} */
    Status;
    /** @type {string} */
    CreatedBy;
    /** @type {?string} */
    CreatedAt;
    /** @type {?string} */
    AppliedAt;
    /** @type {string} */
    AgreementName;
    /** @type {string} */
    ProjectName;
}
export class AgreementCreditsResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Credits?:CreditLedger[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {CreditLedger[]} */
    Credits = [];
}
export class AgreementCreditsRequest {
    constructor(init) { Object.assign(this, init) }
}

JavaScript AgreementCreditsRequest 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/serviceagreement/credits 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
		}
	},
	Credits: 
	[
		{
			CreditLedgerID: 0,
			TenantId: 00000000000000000000000000000000,
			BranchId: 00000000000000000000000000000000,
			AgreementID: 0,
			ProjectID: 0,
			AgreementJobID: 0,
			Amount: 0,
			Reason: String,
			Status: String,
			CreatedBy: String,
			CreatedAt: 0001-01-01,
			AppliedAt: 0001-01-01,
			AgreementName: String,
			ProjectName: String
		}
	]
}