Class PaymentProcessingService

Inheritance
System.Object
PaymentProcessingService
Namespace: DirectScale.Disco.Extension.Services
Assembly: DirectScale.Disco.Extension.Abstractions.dll
Syntax
public class PaymentProcessingService : Object, IPaymentProcessingService

Constructors

PaymentProcessingService(IApiService)

Declaration
public PaymentProcessingService(IApiService apiService)
Parameters
Type Name Description
IApiService apiService

Methods

FindPaidPayments(DateTime, DateTime, String)

Gets all Paid payments between begin and end dates.

Declaration
public Task<CommissionPayment[]> FindPaidPayments(DateTime begin, DateTime end, string search)
Parameters
Type Name Description
System.DateTime begin

Get paid payments after this date.
System.DateTime end

Get paid payments before this date.
System.String search

Optionally filter by specific AssociateId, BackOfficeId, or Name. Example values: "2", "15F92", "Space", "Sam Space".
Returns
Type Description
System.Threading.Tasks.Task<CommissionPayment[]>

Paid payments found or an empty array.

GetPaidPaymentByCheckNumber(Int32)

Gets a Paid payment with specified checkNumber.

Declaration
public Task<CommissionPayment> GetPaidPaymentByCheckNumber(int checkNumber)
Parameters
Type Name Description
System.Int32 checkNumber

Check number to look up.
Returns
Type Description
System.Threading.Tasks.Task<CommissionPayment>

Specified payment.
Exceptions
Type Condition
System.Exception

No record found, or multiple records found.

GetPaidPaymentByTransactionNumber(String)

Gets a Paid payment with specified transactionNumber.

Declaration
public Task<CommissionPayment> GetPaidPaymentByTransactionNumber(string transactionNumber)
Parameters
Type Name Description
System.String transactionNumber

Transaction number to look up.
Returns
Type Description
System.Threading.Tasks.Task<CommissionPayment>

Specified payment.
Exceptions
Type Condition
System.Exception

No record found, or multiple records found.

GetPaidPayments(Int32)

Get all Paid payments to associateId.

Declaration
public Task<CommissionPayment[]> GetPaidPayments(int associateId)
Parameters
Type Name Description
System.Int32 associateId

Associate with payments.
Returns
Type Description
System.Threading.Tasks.Task<CommissionPayment[]>

All payments paid to associate, or an empty array.

GetPayments(Int32, String)

Get all commission payments in batchId.

Declaration
public Task<CommissionPayment[]> GetPayments(int batchId, string paymentUniqueIdFilter = null)
Parameters
Type Name Description
System.Int32 batchId

The batch to get payments for.
System.String paymentUniqueIdFilter

Optional to get a specific payment out of the batch. PaymentUniqueId
Returns
Type Description
System.Threading.Tasks.Task<CommissionPayment[]>

Commission payments in batch or an empty array.

Implements