Interface IAdjustmentService
Service to CRUD commission payment adjustments
Namespace: DirectScale.Disco.Extension.Services
Assembly: DirectScale.Disco.Extension.Abstractions.dll
Syntax
public interface IAdjustmentServiceMethods
DeleteAdjustment(Int32)
Deletes the specified adjustment.
Declaration
Task DeleteAdjustment(int adjustmentID)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | adjustmentID | The AdjustmentId to delete. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task |
Exceptions
| Type | Condition |
|---|---|
| System.Exception | Adjustment not found, or cannot be modified. |
GetAdjustment(Int32)
Gets the specified adjustment.
Declaration
Task<Adjustment> GetAdjustment(int adjustmentID)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | adjustmentID | The requested AdjustmentId. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Adjustment> | Adjustment or null if not found. |
MarkAdjustmentsPaidByExternalMerchant(Int32[])
Set the status of the adjustmentIds to paid and create a completed payment batch showing these paid adjustments.
Declaration
Task MarkAdjustmentsPaidByExternalMerchant(int[] adjustmentIds)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32[] | adjustmentIds | The adjustmentId for the existing adjustments to be marks as paid by external means. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task |
Remarks
Calls
MarkAdjustmentsPaidByMerchant(Int32[], Int32)
Set the status of the adjustmentIds to paid and create a completed payment batch showing these paid adjustments.
Declaration
Task MarkAdjustmentsPaidByMerchant(int[] adjustmentIds, int merchantId)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32[] | adjustmentIds | The adjustmentId for the existing adjustments to be marks as paid by external means. |
| System.Int32 | merchantId | The merchant to indicate paid this adjustment. It will be visible on the pay history check after "Memo: Paid Via ..." |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task |
SaveAdjustment(Adjustment)
Create or update a commission adjustment.
Declaration
Task<int> SaveAdjustment(Adjustment adjustment)Parameters
| Type | Name | Description |
|---|---|---|
| Adjustment | adjustment |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Int32> | The AdjustmentId saved. |
Exceptions
| Type | Condition |
|---|---|
| System.Exception | If any required fields are empty. Or it is too late to modify |