Trendsic Platform Service

<back to all web services

AgreementCreditsRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/serviceagreement/credits
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 CreditLedger() = 
        member val CreditLedgerID:Int32 = new Int32() with get,set
        member val TenantId:Guid = new Guid() with get,set
        member val BranchId:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val AgreementID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val ProjectID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val AgreementJobID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Amount:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val Reason:String = null with get,set
        member val Status:String = null with get,set
        member val CreatedBy:String = null with get,set
        member val CreatedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val AppliedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val AgreementName:String = null with get,set
        member val ProjectName:String = null with get,set

    [<AllowNullLiteral>]
    type AgreementCreditsResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Credits:ResizeArray<CreditLedger> = new ResizeArray<CreditLedger>() with get,set

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

F# 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
		}
	]
}