Trendsic Platform Service

<back to all web services

AgreementCreditsRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/serviceagreement/credits
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreditLedger:
    credit_ledger_i_d: int = 0
    tenant_id: Optional[str] = None
    branch_id: Optional[str] = None
    agreement_i_d: Optional[int] = None
    project_i_d: Optional[int] = None
    agreement_job_i_d: Optional[int] = None
    amount: Optional[Decimal] = None
    reason: Optional[str] = None
    status: Optional[str] = None
    created_by: Optional[str] = None
    created_at: Optional[datetime.datetime] = None
    applied_at: Optional[datetime.datetime] = None
    agreement_name: Optional[str] = None
    project_name: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AgreementCreditsResponse:
    response_status: Optional[ResponseStatus] = None
    credits: List[CreditLedger] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AgreementCreditsRequest:
    pass

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