| GET | /api/History360 |
|---|
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 BaseRequest:
# @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")
api_key: Optional[str] = None
"""
This is your AIM API Key provided by Tri-Tech
"""
# @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
o_auth_token: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseSecureRequest(BaseRequest):
# @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
token: Optional[str] = None
"""
"""
# @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
device_id: Optional[str] = None
"""
"""
# @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
app_id: Optional[str] = None
"""
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseResponseResult:
# @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
status_code: Optional[str] = None
"""
"""
# @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
login: Optional[str] = None
"""
"""
# @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
error_code: Optional[str] = None
"""
"""
# @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
error_display_text: Optional[str] = None
"""
"""
# @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
error_message: Optional[str] = None
"""
"""
# @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
domain_name: Optional[str] = None
"""
"""
# @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
ip_address: Optional[str] = None
"""
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseResponse:
# @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
status: Optional[BaseResponseResult] = None
"""
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Item360:
pslr_id: Optional[int] = None
quantity: Decimal = decimal.Decimal(0)
price: Decimal = decimal.Decimal(0)
total_discount_amount: Decimal = decimal.Decimal(0)
serial_number: Optional[str] = None
condition: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Invoice360:
id: Optional[str] = None
due_date: Optional[datetime.datetime] = None
total: Decimal = decimal.Decimal(0)
status: Optional[str] = None
amount_paid: Decimal = decimal.Decimal(0)
late_fee_amount: Decimal = decimal.Decimal(0)
purchase_date: datetime.datetime = datetime.datetime(1, 1, 1)
store_location_id: Optional[int] = None
items: Optional[List[Item360]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Order360:
id: int = 0
date: datetime.datetime = datetime.datetime(1, 1, 1)
discount: Decimal = decimal.Decimal(0)
payment_type: Optional[str] = None
sub_total: Decimal = decimal.Decimal(0)
tax: Decimal = decimal.Decimal(0)
shipping_amount: Decimal = decimal.Decimal(0)
total: Decimal = decimal.Decimal(0)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Job360:
item_id: Optional[str] = None
item_type: Optional[str] = None
title: Optional[str] = None
quantity: Decimal = decimal.Decimal(0)
price: Decimal = decimal.Decimal(0)
total_discount_amount: Decimal = decimal.Decimal(0)
serial_number: Optional[str] = None
condition: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WorkOrder360:
id: Optional[str] = None
status: Optional[str] = None
deposit: Decimal = decimal.Decimal(0)
store_location_id: Optional[int] = None
creation_date: datetime.datetime = datetime.datetime(1, 1, 1)
completed_date: Optional[datetime.datetime] = None
price: Decimal = decimal.Decimal(0)
jobs: Optional[List[Job360]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Contract360:
id: Optional[str] = None
payment_date: datetime.datetime = datetime.datetime(1, 1, 1)
store_location_id: Optional[int] = None
amount_due: Decimal = decimal.Decimal(0)
late_fee: Decimal = decimal.Decimal(0)
contract_status: Optional[str] = None
amount: Decimal = decimal.Decimal(0)
contract_items: Optional[List[Item360]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class History360Response(BaseResponse):
invoices: Optional[List[Invoice360]] = None
orders: Optional[List[Order360]] = None
work_orders: Optional[List[WorkOrder360]] = None
contracts: Optional[List[Contract360]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class History360Request(BaseSecureRequest):
"""
History360Requires active-e Customer Service.
"""
customer_account: int = 0
include_invoices: bool = False
include_orders: bool = False
include_work_orders: bool = False
include_contracts: bool = False
include_closed: bool = False
closed_start_date: Optional[datetime.datetime] = None
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /api/History360 HTTP/1.1 Host: active-ewebservice.biz Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"Invoices":[{"Id":"String","DueDate":"0001-01-01T00:00:00.0000000","Total":0,"Status":"String","AmountPaid":0,"LateFeeAmount":0,"StoreLocationId":0,"Items":[{"PslrId":0,"Quantity":0,"Price":0,"TotalDiscountAmount":0,"SerialNumber":"String","Condition":"String"}]}],"Orders":[{"Id":0,"Discount":0,"PaymentType":"String","SubTotal":0,"Tax":0,"ShippingAmount":0,"Total":0}],"WorkOrders":[{"Id":"String","Status":"String","Deposit":0,"StoreLocationId":0,"CompletedDate":"0001-01-01T00:00:00.0000000","Price":0,"Jobs":[{"ItemId":"String","ItemType":"String","Title":"String","Quantity":0,"Price":0,"TotalDiscountAmount":0,"SerialNumber":"String","Condition":"String"}]}],"Contracts":[{"Id":"String","StoreLocationId":0,"AmountDue":0,"LateFee":0,"ContractStatus":"String","Amount":0,"ContractItems":[{"PslrId":0,"Quantity":0,"Price":0,"TotalDiscountAmount":0,"SerialNumber":"String","Condition":"String"}]}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}