| Requires any of the roles: | Agent, Administrator |
| GET | /v1/AdjustmentReport/{ParamStartDate}/{ParamEndDate} |
|---|
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 Adjustment:
id: int = 0
adjustment_date: datetime.datetime = datetime.datetime(1, 1, 1)
agent: Optional[str] = None
reason: Optional[str] = None
amount: Decimal = decimal.Decimal(0)
approved: Optional[str] = None
adj_type: Optional[str] = None
income: Optional[str] = None
paid: Optional[str] = None
balance_forward: Optional[str] = None
balance_date: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AdjustmentReportResponse:
response_status: Optional[ResponseStatus] = None
report_data: List[Adjustment] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AdjustmentReportRequest:
param_start_date: datetime.datetime = datetime.datetime(1, 1, 1)
param_end_date: datetime.datetime = datetime.datetime(1, 1, 1)
Python AdjustmentReportRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /v1/AdjustmentReport/{ParamStartDate}/{ParamEndDate} HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<AdjustmentReportResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<ReportData>
<Adjustment>
<AdjType>String</AdjType>
<AdjustmentDate>0001-01-01T00:00:00</AdjustmentDate>
<Agent>String</Agent>
<Amount>0</Amount>
<Approved>String</Approved>
<BalanceDate>String</BalanceDate>
<BalanceForward>String</BalanceForward>
<ID>0</ID>
<Income>String</Income>
<Paid>String</Paid>
<Reason>String</Reason>
</Adjustment>
</ReportData>
<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>
</AdjustmentReportResponse>