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. |
OR | ||||
client_acct_id | string | 50 | Client-defined account identifier. | |
![]() |
payment_transaction_id | long | The payment transaction by which to search for invoices | |
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. |
reversible_inv_trans | hash | |
![]() |
long | The Aria-assigned account ID which was invoiced |
![]() |
long | The Aria-assigned unique identifier of a given invoice. |
![]() |
long | The number of this particular line on the invoice |
![]() |
long | The Aria-assigned financial transaction ID corresponding to the invoice upon which this usage record was billed to the account holder. |
![]() |
string | The date of the invoice |
![]() |
string | The description of this invoice line |
![]() |
double | The amount of this invoice |
![]() |
double | If any reversals have been previously booked, this is the total of those reversals |
![]() |
double | The remaining invoice balance which could be reversed |
![]() |
long | Specifies whether or not this service is a recurring service. |
![]() |
string | Specifies the start date of the recurring service. |