| GET | /api/ContractFullDetails |
|---|
import Foundation
import ServiceStack
/**
* ContractFullDetailsRequires active-e Contracts Service.
*/
// @DataContract
public class ContractFullDetailsRequest : BaseSecureRequest
{
// @DataMember
public var acct:Int?
// @DataMember
public var sub:Int?
// @DataMember
public var changedDate:Date?
// @DataMember
public var serialNumber:String
/**
* If sent, additional calculated fields will be returned using this date
*/
// @DataMember
// @ApiMember(DataType="string", Description="If sent, additional calculated fields will be returned using this date", Format="date", Name="CalculationsDate", ParameterType="query")
public var calculationsDate:Date?
/**
* The Starting Offset
*/
// @DataMember
// @ApiMember(DataType="integer", Description="The Starting Offset", Format="int64", Name="StartOffset")
public var startOffset:Int?
/**
* The # of records to be returned
*/
// @DataMember
// @ApiMember(DataType="integer", Description="The # of records to be returned", Format="int64", Name="RecordCount")
public var recordCount:Int?
/**
* The Contract Ref# to be looked up. If sent, do not send WebRef, Acct, Sub, ChangedDate, SerialNumber, StartOffset, or Recordcount
*/
// @DataMember
// @ApiMember(DataType="string", Description="The Contract Ref# to be looked up. If sent, do not send WebRef, Acct, Sub, ChangedDate, SerialNumber, StartOffset, or Recordcount", Name="AIMRef")
public var aimRef:String
/**
* The WebRef to be looked up. If sent, do not send AIMRef, Acct, Sub, ChangedDate, SerialNumber, StartOffset, or Recordcount
*/
// @DataMember
// @ApiMember(DataType="string", Description="The WebRef to be looked up. If sent, do not send AIMRef, Acct, Sub, ChangedDate, SerialNumber, StartOffset, or Recordcount", Name="WebRef")
public var webRef:String
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case acct
case sub
case changedDate
case serialNumber
case calculationsDate
case startOffset
case recordCount
case aimRef
case webRef
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
acct = try container.decodeIfPresent(Int.self, forKey: .acct)
sub = try container.decodeIfPresent(Int.self, forKey: .sub)
changedDate = try container.decodeIfPresent(Date.self, forKey: .changedDate)
serialNumber = try container.decodeIfPresent(String.self, forKey: .serialNumber)
calculationsDate = try container.decodeIfPresent(Date.self, forKey: .calculationsDate)
startOffset = try container.decodeIfPresent(Int.self, forKey: .startOffset)
recordCount = try container.decodeIfPresent(Int.self, forKey: .recordCount)
aimRef = try container.decodeIfPresent(String.self, forKey: .aimRef)
webRef = try container.decodeIfPresent(String.self, forKey: .webRef)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if acct != nil { try container.encode(acct, forKey: .acct) }
if sub != nil { try container.encode(sub, forKey: .sub) }
if changedDate != nil { try container.encode(changedDate, forKey: .changedDate) }
if serialNumber != nil { try container.encode(serialNumber, forKey: .serialNumber) }
if calculationsDate != nil { try container.encode(calculationsDate, forKey: .calculationsDate) }
if startOffset != nil { try container.encode(startOffset, forKey: .startOffset) }
if recordCount != nil { try container.encode(recordCount, forKey: .recordCount) }
if aimRef != nil { try container.encode(aimRef, forKey: .aimRef) }
if webRef != nil { try container.encode(webRef, forKey: .webRef) }
}
}
// @DataContract
public class BaseSecureRequest : BaseRequest
{
/**
*
*/
// @DataMember
// @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
public var token:String
/**
*
*/
// @DataMember
// @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
public var deviceId:String
/**
*
*/
// @DataMember
// @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
public var appId:String
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case token
case deviceId
case appId
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
token = try container.decodeIfPresent(String.self, forKey: .token)
deviceId = try container.decodeIfPresent(String.self, forKey: .deviceId)
appId = try container.decodeIfPresent(String.self, forKey: .appId)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if token != nil { try container.encode(token, forKey: .token) }
if deviceId != nil { try container.encode(deviceId, forKey: .deviceId) }
if appId != nil { try container.encode(appId, forKey: .appId) }
}
}
// @DataContract
public class BaseRequest : Codable
{
/**
* This is your AIM API Key provided by Tri-Tech
*/
// @DataMember
// @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")
public var apiKey:String
// @DataMember
// @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
public var oAuthToken:String
required public init(){}
}
// @DataContract
public class ContractFullDetailsResponse : BaseResponse
{
// @DataMember
public var contracts:[ContractInfo] = []
// @DataMember
public var remainingRecords:Int
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case contracts
case remainingRecords
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
contracts = try container.decodeIfPresent([ContractInfo].self, forKey: .contracts) ?? []
remainingRecords = try container.decodeIfPresent(Int.self, forKey: .remainingRecords)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if contracts.count > 0 { try container.encode(contracts, forKey: .contracts) }
if remainingRecords != nil { try container.encode(remainingRecords, forKey: .remainingRecords) }
}
}
// @DataContract
public class BaseResponse : Codable
{
/**
*
*/
// @DataMember
// @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
public var status:BaseResponseResult
required public init(){}
}
// @DataContract
public class BaseResponseResult : Codable
{
/**
*
*/
// @DataMember
// @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
public var statusCode:String
/**
*
*/
// @DataMember
// @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
public var login:String
/**
*
*/
// @DataMember
// @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
public var errorCode:String
/**
*
*/
// @DataMember
// @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
public var errorDisplayText:String
/**
*
*/
// @DataMember
// @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
public var errorMessage:String
/**
*
*/
// @DataMember
// @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
public var domainName:String
/**
*
*/
// @DataMember
// @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
public var ipAddress:String
required public init(){}
}
// @DataContract
public class ContractInfo : Codable
{
// @DataMember
public var rnt_afee:Double
// @DataMember
public var rnt_alatedbt:Bool
// @DataMember
public var rnt_amtfin:Double
// @DataMember
public var rnt_aofinchg:Double
// @DataMember
public var rnt_apaydbt:Bool
// @DataMember
public var rnt_apaytyp:String
// @DataMember
public var rnt_atcode:Int16
// @DataMember
public var rnt_autopayhold:Date
// @DataMember
public var rnt_avgbal:Double
// @DataMember
public var rnt_balance:Double
// @DataMember
public var rnt_billdays:Int16
// @DataMember
public var rnt_cdate:Date
// @DataMember
public var rnt_colagency:String
// @DataMember
public var rnt_colamt:Double
// @DataMember
public var rnt_coupdate:Date
// @DataMember
public var rnt_cramt:Double
// @DataMember
public var rnt_crmo:Int16
// @DataMember
public var rnt_currafee:Double
// @DataMember
public var rnt_currbal:Double
// @DataMember
public var rnt_currfc:Double
// @DataMember
public var rnt_currfeetax1:Double
// @DataMember
public var rnt_currfeetax2:Double
// @DataMember
public var rnt_currlte:Double
// @DataMember
public var rnt_currma:Double
// @DataMember
public var rnt_curroth:Double
// @DataMember
public var rnt_currprn:Double
// @DataMember
public var rnt_currtax1:Double
// @DataMember
public var rnt_currtax2:Double
// @DataMember
public var rnt_dayslate:Int16
// @DataMember
public var rnt_daystlst:Int16
// @DataMember
public var rnt_deprcode:String
// @DataMember
public var rnt_discount:Double
// @DataMember
public var rnt_downpay:Double
// @DataMember
public var rnt_dunn:String
// @DataMember
public var rnt_edate:Date
// @DataMember
public var rnt_fdate:Date
// @DataMember
public var rnt_fee:Double
// @DataMember
public var rnt_finalpay:Double
// @DataMember
public var rnt_finchg:Double
// @DataMember
public var rnt_freemos:Int16
// @DataMember
public var rnt_intdate:Date
// @DataMember
public var rnt_intrate:Double
// @DataMember
public var rnt_irregular:Bool
// @DataMember
public var rnt_itcode:Int16
// @DataMember
public var rnt_lastpaid:Double
// @DataMember
public var rnt_latefee:Double
// @DataMember
public var rnt_lateowed:Double
// @DataMember
public var rnt_ldate:Date
// @DataMember
public var rnt_ltcode:Int16
// @DataMember
public var rnt_monma:Double
// @DataMember
public var rnt_mopayreq:Bool
// @DataMember
public var rnt_mtcode:Int16
// @DataMember
public var rnt_ndate:Date
// @DataMember
public var rnt_nextpayamt:Double
// @DataMember
public var rnt_nextpaynum:Int16
// @DataMember
public var rnt_notedate:Date
// @DataMember
public var rnt_notes:String
// @DataMember
public var rnt_exchnotes:String
// @DataMember
public var rnt_otherowed:Double
// @DataMember
public var rnt_payfreq:Int16
// @DataMember
public var rnt_latefreq:Int16
// @DataMember
public var rnt_payfreqtype:Int16
// @DataMember
public var rnt_payment:Double
// @DataMember
public var rnt_paystrm:Int16
// @DataMember
public var rnt_pk:Int
// @DataMember
public var rnt_prevamt:Double
// @DataMember
public var rnt_prevmo:Int16
// @DataMember
public var rnt_price:Double
// @DataMember
public var rnt_rdate:Date
// @DataMember
public var rnt_sdate:Date
// @DataMember
public var rnt_student:String
// @DataMember
public var rnt_sub:Int
// @DataMember
public var rnt_tax:Double
// @DataMember
public var rnt_taxrate1:Double
// @DataMember
public var rnt_taxrate2:Double
// @DataMember
public var rnt_taxrateorig1:Double
// @DataMember
public var rnt_taxrateorig2:Double
// @DataMember
public var rnt_tcode:Int16
// @DataMember
public var rnt_term:Int16
// @DataMember
public var rnt_tmaint:Double
// @DataMember
public var rnt_tradein:Double
// @DataMember
public var rnt_typer:String
// @DataMember
public var rnt_timestamp:Date
// @DataMember
public var acct:Int
// @DataMember
public var taxLocation:String
// @DataMember
public var defaultDesc:String
// @DataMember
public var payoffDesc:String
// @DataMember
public var school:String
// @DataMember
public var district:String
// @DataMember
public var ref:String
// @DataMember
public var autoPayDeclined:Bool
// @DataMember
public var inventory:[ContractInventoryInfo] = []
// @DataMember
public var cardInfo:CcInfo
// @DataMember
public var contractCalculatedFields:ContractCalculatedFields
// @DataMember
public var payments:[PaymentGeneric] = []
// @DataMember
public var rnt_avacodeprin:String
// @DataMember
public var rnt_avacodemaint:String
// @DataMember
public var rnt_avacodelate:String
// @DataMember
public var rnt_avacodelease:String
// @DataMember
public var rnt_avacodefin:String
// @DataMember
public var rnt_scheduledreturndate:Date
// @DataMember
public var rnt_scheduledreturnoption:String
// @DataMember
public var rnt_scheduledreturnnotes:String
// @DataMember
public var rnt_scheduledreturnstatus:String
required public init(){}
}
// @DataContract
public class ContractInventoryInfo : Codable
{
// @DataMember
public var id:Int
// @DataMember
public var beginDate:Date
// @DataMember
public var cat:Int
// @DataMember
public var cost:Double?
// @DataMember
public var Description:String
// @DataMember
public var discount:Double
// @DataMember
public var dunn:String
// @DataMember
public var endDate:Date
// @DataMember
public var invType:String
// @DataMember
public var notes:String
// @DataMember
public var ourPrice:Double
// @DataMember
public var qty:Double
// @DataMember
public var receiptNotes:String
// @DataMember
public var serial:String
// @DataMember
public var sub:Int
// @DataMember
public var total:Double
// @DataMember
public var sku:String
// @DataMember
public var mfg:String
required public init(){}
}
// @DataContract(Name="CCInfo")
public class CcInfo : Codable
{
/**
* Token returned from processor
*/
// @DataMember
// @ApiMember(DataType="string", Description="Token returned from processor", IsRequired=true, Name="TokenStr", ParameterType="query")
public var tokenStr:String
/**
* Card Type (VISA, MCARD, AMEX, DSCVR)
*/
// @DataMember
// @ApiMember(DataType="string", Description="Card Type (VISA, MCARD, AMEX, DSCVR)", IsRequired=true, Name="CardType", ParameterType="query")
public var cardType:String
/**
* Last four of the card
*/
// @DataMember
// @ApiMember(DataType="string", Description="Last four of the card", IsRequired=true, Name="LastFour", ParameterType="query")
public var lastFour:String
/**
* Expiration Date of the Card. (MM/YY)
*/
// @DataMember
// @ApiMember(DataType="string", Description="Expiration Date of the Card. (MM/YY)", Name="Expiration", ParameterType="query")
public var expiration:String
/**
* Reason the card is on file.
*/
// @DataMember
// @ApiMember(DataType="string", Description="Reason the card is on file.", Name="ReasonOnFile", ParameterType="query")
public var reasonOnFile:String
/**
* ID of the existing Token Record in AIM, if applicable
*/
// @DataMember
// @ApiMember(DataType="integer", Description="ID of the existing Token Record in AIM, if applicable", Format="int64", Name="TokenPk", ParameterType="query")
public var tokenPk:Int?
/**
* Is this the customer's primary card? Defaults to false.
*/
// @DataMember
// @ApiMember(DataType="boolean", Description="Is this the customer's primary card? Defaults to false.", Name="Primary", ParameterType="query")
public var primary:Bool?
required public init(){}
}
// @DataContract
public class ContractCalculatedFields : Codable
{
// @DataMember
public var terms:Int
// @DataMember
public var payStream:Int
// @DataMember
public var finalPay:Double
// @DataMember
public var amountDue:Double
// @DataMember
public var payoff:Double
// @DataMember
public var discountedPayoff:Double
// @DataMember
public var rebateFc:Double
// @DataMember
public var totalLate:Double
// @DataMember
public var paymentsLate:Double
// @DataMember
public var paymentsAhead:Int
// @DataMember
public var totalMaintOwed:Double
// @DataMember
public var currentPlusNext:Double
// @DataMember
public var payoffDate:Date
// @DataMember
public var creditAmount:Double
// @DataMember
public var prinLessTax:Double
// @DataMember
public var maintLessTax:Double
// @DataMember
public var aFeeLessTax:Double
// @DataMember
public var paymentTax:Double
// @DataMember
public var rentDueInfo:[ContractValuesObject] = []
// @DataMember
public var payoffInfo:[ContractValuesObject] = []
// @DataMember
public var notice:String
// @DataMember
public var notice2:String
required public init(){}
}
// @DataContract
public class ContractValuesObject : Codable
{
// @DataMember
public var position:Int
// @DataMember
public var display:String
// @DataMember
public var value:Double
required public init(){}
}
// @DataContract
public class PaymentGeneric : Codable
{
// @DataMember
public var date:Date
// @DataMember
public var amount:Double
// @DataMember
public var ref:String
required public init(){}
}
Swift ContractFullDetailsRequest DTOs
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/ContractFullDetails HTTP/1.1 Host: active-ewebservice.biz Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"Contracts":[{"Rnt_afee":0,"Rnt_alatedbt":false,"Rnt_amtfin":0,"Rnt_aofinchg":0,"Rnt_apaydbt":false,"Rnt_apaytyp":"String","Rnt_atcode":0,"Rnt_avgbal":0,"Rnt_balance":0,"Rnt_billdays":0,"Rnt_colagency":"String","Rnt_colamt":0,"Rnt_cramt":0,"Rnt_crmo":0,"Rnt_currafee":0,"Rnt_currbal":0,"Rnt_currfc":0,"Rnt_currfeetax1":0,"Rnt_currfeetax2":0,"Rnt_currlte":0,"Rnt_currma":0,"Rnt_curroth":0,"Rnt_currprn":0,"Rnt_currtax1":0,"Rnt_currtax2":0,"Rnt_dayslate":0,"Rnt_daystlst":0,"Rnt_deprcode":"String","Rnt_discount":0,"Rnt_downpay":0,"Rnt_dunn":"String","Rnt_fee":0,"Rnt_finalpay":0,"Rnt_finchg":0,"Rnt_freemos":0,"Rnt_intrate":0,"Rnt_irregular":false,"Rnt_itcode":0,"Rnt_lastpaid":0,"Rnt_latefee":0,"Rnt_lateowed":0,"Rnt_ltcode":0,"Rnt_monma":0,"Rnt_mopayreq":false,"Rnt_mtcode":0,"Rnt_nextpayamt":0,"Rnt_nextpaynum":0,"Rnt_notes":"String","Rnt_exchnotes":"String","Rnt_otherowed":0,"Rnt_payfreq":0,"Rnt_latefreq":0,"Rnt_payfreqtype":0,"Rnt_payment":0,"Rnt_paystrm":0,"Rnt_pk":0,"Rnt_prevamt":0,"Rnt_prevmo":0,"Rnt_price":0,"Rnt_student":"String","Rnt_sub":0,"Rnt_tax":0,"Rnt_taxrate1":0,"Rnt_taxrate2":0,"Rnt_taxrateorig1":0,"Rnt_taxrateorig2":0,"Rnt_tcode":0,"Rnt_term":0,"Rnt_tmaint":0,"Rnt_tradein":0,"Rnt_typer":"String","Acct":0,"TaxLocation":"String","DefaultDesc":"String","PayoffDesc":"String","School":"String","District":"String","Ref":"String","AutoPayDeclined":false,"Inventory":[{"Id":0,"Cat":0,"Cost":0,"Description":"String","Discount":0,"Dunn":"String","InvType":"String","Notes":"String","OurPrice":0,"Qty":0,"ReceiptNotes":"String","Serial":"String","Sub":0,"Total":0,"Sku":"String","Mfg":"String"}],"CardInfo":{"TokenStr":"String","CardType":"String","LastFour":"String","Expiration":"String","ReasonOnFile":"String","TokenPk":0,"Primary":false},"ContractCalculatedFields":{"Terms":0,"PayStream":0,"FinalPay":0,"AmountDue":0,"Payoff":0,"DiscountedPayoff":0,"RebateFc":0,"TotalLate":0,"PaymentsLate":0,"PaymentsAhead":0,"TotalMaintOwed":0,"CurrentPlusNext":0,"CreditAmount":0,"PrinLessTax":0,"MaintLessTax":0,"AFeeLessTax":0,"PaymentTax":0,"RentDueInfo":[{"Position":0,"Display":"String","Value":0}],"PayoffInfo":[{"Position":0,"Display":"String","Value":0}],"Notice":"String","Notice2":"String"},"Payments":[{"Amount":0,"Ref":"String"}],"Rnt_avacodeprin":"String","Rnt_avacodemaint":"String","Rnt_avacodelate":"String","Rnt_avacodelease":"String","Rnt_avacodefin":"String","Rnt_scheduledreturnoption":"String","Rnt_scheduledreturnnotes":"String","Rnt_scheduledreturnstatus":"String"}],"RemainingRecords":0,"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}