Allowances

Allowances_Delete

Input

  • ID As Integer – the ID of the service allowance to be deleted. Required.

📘

Note:

Only allowances where the Balance equals Quantity (i.e., unapplied allowances) can be deleted.

Allowances_Search

Required Input
At least one of the optional inputs is required.

Optional Input

  • ID As List (Of Integer) – One or more Rev.io Allowance IDs. Returns allowances for these specific IDs only.
  • CustomerID As List (Of Integer) – One or more Rev.io Customer IDs. Returns allowances for these specific customers only.
  • LineID As List (Of Integer) – One or more Rev.io Service IDs. Returns allowances for these specific services only.
  • PINClaimID As List (Of Integer) – One or more Rev.io PIN Claim IDs. Returns allowances for these specific PIN claims only.
  • ProductID As List (Of Integer) – One or more Rev.io Product IDs. Returns allowances for these specific products only.
  • TopUpID As List (Of Integer) – One or more Rev.io Top Up IDs. Returns allowances for these specific top-ups only.
  • CustomerProductID As List (Of Integer) – One or more Rev.io Customer Product IDs. Returns allowances for these specific customer products only.

Output
A list of allowances matching the search criteria containing the following fields:

  • ID As Integer – Rev.io Allowance ID.
  • CustomerID As Integer – Rev.io Customer ID.
  • LineID As Integer – Rev.io Service ID.
  • PINClaimID As Integer – Rev.io Pin Claim ID that triggered the allowance to be created.
  • ProductID As Integer – Rev.io Product ID that the allowance is based off of.
  • TopUpID As Integer – Rev.io Top Up ID that triggered the allowance to be created.
  • CustomerProductID As Integer – Rev.io Customer Product ID associated with the allowance (if an MRC allowance).
  • StartDate As Date – Start date that the allowance is effective.
  • StopDate As Date – Stop date that the allowance is effective.

Allowances_Update

Input

  • ID As Integer – The ID of the allowance to be updated. Required.
  • StopDate As Date – The "Stop Date" of the allowance to be updated. Can be used to expire or extend an allowance.

Output
None