void_invoice_m
Summary
| API Name | void_invoice_m |
|---|---|
| Class | transaction_services_m |
| Update Version | 6.35 |
Description
Voids a given invoice object and all its associated transactions. Voiding an invoice is permanent and cannot be undone.
Inputs
| Name | Type | Length | Required | Description | ||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| client_no | long | 22 | Yes |
Aria-assigned unique identifier indicating the Aria client providing service to this account. |
||||||||||||||||||||||||||
| auth_key | string | 32 | No |
Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call. |
||||||||||||||||||||||||||
| acct_no | long | 22 | Yes |
Aria-assigned account identifier. This value is unique across all Aria-managed accounts. Alternative required field: client_acct_id |
||||||||||||||||||||||||||
| client_acct_id | string | 50 | Yes |
Client-defined account identifier. Alternative required field: acct_no |
||||||||||||||||||||||||||
| client_receipt_id | string | 50 | No |
Client-defined unique identifier used to track related system actions |
||||||||||||||||||||||||||
| invoice_no | long | Yes |
The Aria-assigned unique identifier of a given invoice. |
|||||||||||||||||||||||||||
| reason_code | long | 8 | Yes |
The reason this invoice is voided Allowed values:
|
||||||||||||||||||||||||||
| comments | string | 500 | No |
Additional explanatory text relating to this API call. |
Outputs
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| error_code | long | No |
Aria-assigned error identifier. 0 indicates no error. |
|
| error_msg | string | No |
Description of any error that occurred. "OK" if there was no error. |
|
| void_transactions | object | No |
Array of voided transactions. |
void_transactions fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| invoice_transaction_id | long | 22 | No |
Aria generated ID for the invoice transaction |
| void_transaction_id | long | 22 | No |
When the invoice transaction is voided, this new void transaction is created. |