GET Account (Full Service)

Get Started. It's Free
or sign up with your email address
Rocket clouds
GET Account (Full Service) by Mind Map: GET Account (Full Service)

1. Validation

1.1. All Dates are in UTC

1.1.1. DateTime format yyyy-mm-ddThh:mm:ss.sssZ

1.2. All amount are in 2 decimal place

1.3. accountID

1.3.1. account.Adfitno

1.3.2. all caps

1.4. accountExternalId

1.4.1. account.clubno

1.5. customerId

1.5.1. client.ClientNumber

1.6. businessAccountId

1.6.1. facilityaccount.contractpref

1.7. TermType

1.7.1. Months

1.7.1.1. Term = account.Term

1.7.2. Payments

1.7.2.1. Term = account.Pmts

1.8. AccountCode

1.8.1. Account.AccountCode

1.9. fixedTerm

1.9.1. True

1.9.1.1. account.IsTerm = 1

1.9.2. False

1.9.2.1. account.IsTerm = 0

1.10. NextBillingDate

1.10.1. Account.BillNext

1.11. LastBillingDateTime

1.11.1. Account.BillLast

1.12. OverdueStatus

1.12.1. Account.ODStatus

1.13. OverdueAmountPayment

1.13.1. account.ODAmount –OverdueAmountFee AND P.Transcode IN ('PY','AT','OP','CF','SU','PD')

1.14. OverdueAmountFee

1.14.1. account.ODAmount - sum of (PY+AT+OP+CF+SU+PD Should Have Paid – PY+AT+OP+CF+SU+PD Paid)

1.15. LastReversalReason

1.15.1. Account.LastRevReason

1.16. CancelReason

1.16.1. Account.CancelReason

1.17. Suspended

1.17.1. True

1.17.1.1. account.suspended = 1

1.17.2. False

1.17.2.1. account.suspended = 0

1.18. PaymentStopped

1.18.1. True

1.18.1.1. account.DDStop= 1

1.18.2. False

1.18.2.1. account.DDStop = 0

1.19. PaymentStopEndDate

1.19.1. Account.DDStopUntil

1.20. Account.CatchUP

1.20.1. CatchUpAmount

1.20.1.1. Account.ForceCatchUp IS NULL

1.20.1.2. Account.Overdue is NOT NULL

1.20.2. PaymentInAdvanceAmount

1.20.2.1. Account.ForceCatchUp is NOT null

1.20.2.2. Account.Overdue is NULL or less than 0

1.21. Account.CatchUPUntil

1.21.1. CatchUpEndDate

1.21.1.1. Account.ForceCatchUp IS NULL

1.21.1.2. Account.Overdue is NOT NULL

1.21.2. PaymentInAdvanceAmountEndDate

1.21.2.1. Account.ForceCatchUp is NOT null

1.21.2.2. Account.Overdue is NULL or less than 0

1.22. AccountStartDate

1.22.1. Account.StartDate

1.23. AccountCloseDate

1.23.1. Account.FinishDate

1.24. AccountLoadedDateTime

1.24.1. Account.LoadDate

1.25. LastUpdatedDateTime

1.25.1. Account.LastUpdate

1.26. AccruedContractAmount

1.26.1. Account.MinTermAmount

1.27. OriginalContractAmount

1.27.1. Account.MinSubAmount

1.28. OutstandingRecurringAmount

1.28.1. Processing TBL Outstanding Amount = Total - Paid (where Transcode = PY)

1.29. OutstandingOneOffAmount

1.29.1. Processing TBL Outstanding Amount = Total - Paid (where Transcode = OP)

1.30. OutstandingFeeAmount

1.30.1. Processing TBL Outstanding Amount = Total - Paid (where Transcode <> PY, AT, OP, CF, SU, PD)

1.31. ProjectedFinishDate

1.31.1. Account.ProjectedFinishDate

2. Common Error Codes

2.1. If token not provided or expired 401 Error code

2.1.1. "message": "Authorization has been denied for this request."

2.2. If sending more requests than is allowed then 429: Too many requests

2.2.1. Configuration. To be confirmed with Dev

2.2.2. "message": "You have exceeded the maximum limit of request allowed. Please try your request again in a moment."

2.3. If client does not have permission to business provided then 403: Forbidden

2.3.1. { "errorCode":"access_denied", "message":"Unable to process this request as you do not have access to the customer associated to this request." }

2.4. 500: Internal Server Error Lock database to test

2.4.1. { "message": "Something went wrong while processing your request. We’re sorry for the trouble. We’ve been notified of the error and will correct it as soon as possible. Please try your request again in a moment." }

2.5. 503: Service Unavailable Turn off CustomerServices in Application Pool to Test

2.5.1. { "message": "The API is currently unavailable due to a scheduled outage – please try again soon." }

3. GET Account (Full Service)

3.1. 200 OK

3.1.1. Valid Adfitno provided

3.1.1.1. SUCCESSFUL RESPONSE { "accountId":" AILL056H6", "accountExternalId":"ABC12345", "customerId":"4R4R5T6Y-6Y7U-8765-2345-TYHGB56789IU", "businessAccountId":"DSFit1", "termType":"months", "term":24, "accountCode":"DSFit Account Code 1", "fixedTerm":true, "nextBillingDate":"2019-11-31", "lastBillingDateTime":"2019-10-31T01:59.590Z", "overdueStatus":0, "overdueAmountPayment":"999.90", "overdueAmountFee":"99.90", "lastReversalReason":"", "cancelReason":"", "suspended":false, "paymentStopped":true, "paymentStopEndDate":"2019-11-30", "catchUpAmount":"111.10", "catchUpEndDate":"2019-12-31", "paymentInAdvanceAmount":"", "paymentInAdvanceEnddate":"", "accountStartDate":"2018-12-31", "accountLoadedDateTime":"2018-10-31T01:59.059Z", "AccountCloseDate":"", "lastUpdatedDateTime":"2019-10-31T12:59.099Z", "accruedContractAmount":999.90, "originalContractAmount":999.90, "outstandingRecurringAmount":99.90, "outandingOneOffAmount":25.00, "outstandingFeeAmount":9.90, "projectedFinishDate":"2020-12-31" }

3.2. 403: Forbidden

3.2.1. Invalid Adfitno

3.2.1.1. { "errorCode":"access_denied", "message":"Unable to process this request as you do not have access to the customer associated to this request." }

3.3. 404: Not Found

3.3.1. Adfitno doesn't exist

3.3.1.1. "message":"The requested resource could not be found."

4. GET Accounts (Full Service)

4.1. customerID DSElk.dbo.Client.ClientNumber

4.1.1. supplied

4.1.1.1. List of all Full Service Accounts associated to the Customer returned

4.1.2. not supplied

4.1.2.1. List of all Full Service Accounts associated to the Client returned

4.2. accountStatus

4.2.1. closed DSElk.dbo.Account.CancelReason

4.2.1.1. true

4.2.1.1.1. Cancelled accounts returned except Prep for Debt and Pending Write Off (CancelReasonLookup.PendingCancellation = 0)

4.2.1.1.2. nexBillingDate populated according to DB

4.2.1.1.3. cancelReason will be populated

4.2.1.1.4. accountCloseDate will be populated

4.2.1.2. false

4.2.1.2.1. Active accounts returned

4.2.1.2.2. cancelReason will be empty

4.2.1.2.3. accountCloseDate will be empty

4.2.1.2.4. accountCloseDate not null and cancelReason either Prep for Debt Collection or Pending Write Off

4.2.2. suspended DSElk.dbo.Account.Suspended

4.2.2.1. true

4.2.2.1.1. suspended accounts will be returned

4.2.2.1.2. suspended will be true

4.2.2.2. false

4.2.2.2.1. active accounts will be returned

4.2.2.2.2. suspended will be false

4.2.3. paymentsStopped DSElk.dbo.Account.DDStop

4.2.3.1. true

4.2.3.1.1. paymentStopped = true

4.2.3.1.2. paymentStopEndDate populated if DDStopUntil has value

4.2.3.2. false

4.2.3.2.1. paymentStopped = false

4.2.3.2.2. paymentStopEndDate = empty

4.2.4. active (default behaviour) DSElk.dbo.Account.CancelReason

4.2.4.1. true

4.2.4.1.1. Active accounts returned including Suspended and DD stop accounts

4.2.4.1.2. cancelReason will not be populated

4.2.4.1.3. accountCloseDate will be null

4.2.4.1.4. Active Accounts returned including Account.FinishDate = Null & CancelReason having PendingCancellation = 1

4.3. fromDatetime YYYY-MM-DDThh:mm:ss.sssZ

4.3.1. supplied

4.3.1.1. accounts based on dateType supplied will be returned

4.3.1.2. Check whether accounts returned are to the second, for example 11:00:01 supplied then accounts with time before 11:00:01 will not be returned

4.3.2. not supplied

4.3.2.1. all accounts returned

4.4. toDatetime YYYY-MM-DDThh:mm:ss.sssZ

4.4.1. supplied

4.4.1.1. accounts based on dateType supplied will be returned

4.4.1.2. Check whether accounts returned are to the second, for example 11:00:01 supplied then accounts with time after 11:00:01 will not be returned

4.4.2. not supplied

4.4.2.1. all accounts returned

4.5. dateType

4.5.1. StartDate LoadDate LastUpdatedDate CloseDate

4.5.1.1. Must be provided when startDateTime and endDateTime query parameters are provided

4.6. businessAccountID DSElk.dbo.FacilityAccount.ContractPrefix

4.6.1. supplied

4.6.1.1. a list of all Full Service Accounts associated to the Facility Account returned

4.6.2. not supplied

4.6.2.1. a list of all Full Service Accounts associated to the Client returned

4.7. nextCursor

4.7.1. Default to retrieve from first record if nextCursor is not supplied

4.7.1.1. If NextCursor is supplied then records beginning from that place will be returned

4.8. limit

4.8.1. Default maximum limit value for returned records is 50

4.8.1.1. If limit of 51 is supplied then return 50

4.8.2. If more than 50 records, maximum value to be returned is 50