Req | Field Name | Field Type | Max Length | Description |
---|---|---|---|---|
![]() | client_no | long | 22 | Aria-assigned unique identifier indicating the Aria client providing service to this account. |
![]() | auth_key | string | 32 | Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor. |
![]() | acct_no | long | 22 | Aria-assigned account identifier. This value is unique across all Aria-managed accounts. |
filter_credit_no | long | 22 | The recurring credit number to use in order to filter results. | |
alt_caller_id | string | 30 | Person or process that submitted the API call. This can be someone's user ID, or the name of an application. | |
optional_transaction_qualifiers | array | Array of additional values you can associate with this API call. | ||
![]() | string | 100 | Name of the field you want to associate with this API call. | |
![]() | string | 100 | Corresponding value of the field you want to associate with this API call. |
Field Name | Field Type | Description |
---|---|---|
error_code | long | Aria-assigned error identifier. 0 indicates no error. |
error_msg | string | Description of any error that occurred. "OK" if there was no error. |
recurring_credit_info | hash | |
![]() | long | The identifier for the recurring credit. |
![]() | string | The date the recurring credit record was created. |
![]() | string | The user who created the recurring credit record. |
![]() | string | The date the recurring credit record was last updated. |
![]() | string | The user who last updated the recurring credit record |
![]() | string | The first date that recurring credit was applied to the account. |
![]() | string | The last date that recurring credit will be applied to the account. |
![]() | string | The next date that a recurring credit will be applied to the account (assuming the last_credit_date has not passed) |
![]() | double | The monetary amount of the credit to be applied for each iteration of the recurring credit sequence. |
![]() | string | The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method. |
![]() | long | The number of credits that have been applied to the account |
![]() | long | The number of remaining credits to apply to the account |
![]() | long | The interval (in months) between credits to the account |
![]() | long | The plan number that is eligible to apply recurring credit. |
![]() | string | The name of the eligible plan number. |
![]() | long | The service number eligible for recurring credit |
![]() | string | The name of the eligible service. |
![]() | long | The service number to apply the recurring credit to. |
![]() | string | The name of the service to apply the recurring credit to. |
![]() | long | The status code for the recurring credit. |
![]() | string | The label for the recurring credit status code. |
![]() | long | The reason code for the application of credit toward the account specified Allowable Values |
![]() | string | The text description of the credit reason code. |
![]() | string | Free-form comments for the credit applied to the specified account. |
![]() | string | The date the credit was cancelled (if any) |
![]() | string | The user who cancelled the credit. |
![]() | string | Comments from the user who cancelled the credit |
![]() | string | The client-defined plan ID that is eligible to apply recurring credit. |
![]() | string | The client-defined service ID eligible for recurring credit |
![]() | string | The client-defined service ID to apply the recurring credit to. |
![]() | hash | A list of eligible service types |
![]() | string | Service type code for which the credit is applicable. Allowable Values |
![]() | hash | |
![]() | long | The plan numbers that is eligible to apply recurring credit. |
![]() | string | The name of the eligible plan number. |
![]() | long | The service numbers eligible for recurring credit |
![]() | string | The name of the eligible service. |
![]() | string | The client-defined plan IDs that is eligible to apply recurring credit. |
![]() | string | The client-defined service ids eligible for recurring credit |