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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AgreementCreditsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Credits>
    <CreditLedger>
      <AgreementID>0</AgreementID>
      <AgreementJobID>0</AgreementJobID>
      <AgreementName>String</AgreementName>
      <Amount>0</Amount>
      <AppliedAt>0001-01-01T00:00:00</AppliedAt>
      <BranchId>00000000-0000-0000-0000-000000000000</BranchId>
      <CreatedAt>0001-01-01T00:00:00</CreatedAt>
      <CreatedBy>String</CreatedBy>
      <CreditLedgerID>0</CreditLedgerID>
      <ProjectID>0</ProjectID>
      <ProjectName>String</ProjectName>
      <Reason>String</Reason>
      <Status>String</Status>
      <TenantId>00000000-0000-0000-0000-000000000000</TenantId>
    </CreditLedger>
  </Credits>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</AgreementCreditsResponse>