get_all_invoice_information_m Guide
- Last updated
-
-
Save as PDF
The get_all_invoice_information_m API returns both real and pending invoice details for all accounts matching specified query.
Additional Guidance
Querystring Keys
| Field Name |
Notes |
| <invoice_type> |
Allowable values
| Values |
Description |
| R |
Real invoice |
| P |
Pending invoice |
|
| <invoice_no> |
The Aria assigned ID of the invoice |
| <acct_no> |
The Aria assigned ID of the account |
| <user_id> |
The client defined user_id for the account |
| <client_acct_id> |
Client-specified account identifier |
| <bill_company_name> |
The company name of the billing contact for the invoice |
| <pay_method_type> |
Allowable values:
| Values |
Description |
| -1 |
External Payment |
| 1 |
Credit card |
| 2 |
Electronic Check (ACH) |
| 3 |
Pre-paid |
| 8 |
Click&Buy |
| 10 |
PayByCash |
| 11 |
PayPal Express Checkout |
| 13 |
Tokenized Credit Card |
| 14 |
Purchase Power |
| 20 |
NETS |
| 26 |
Direct Debit |
| 37 |
Tokenized Direct Debit |
| 48 |
Tokenized ACH |
|
| <pay_method_name> |
See Description column above for <pay_method_type>. |
| <client_notes> |
Client specific custom invoice notes that can be edited at the invoice or pending invoice level |
| <master_plan_instance_id> |
Aria generated unique identifier for the master plan instance |
| <client_master_plan_instance_id> |
Client defined unique identifier for the master plan instance |
| <invoice_transaction_id> |
|
| <po_num> |
Purchase order number assigned to the invoice. |
| <plan_instance_no> |
Aria-assigned unique identifier of the plan instance directly associated with this invoice line item. Note that this parameter may be a master plan instance or a supplemental plan instance. |
| <client_plan_instance_id> |
Client-defined unique identifier of the plan instance directly associated with this invoice line item. Note that this parameter may be a master plan instance or a supplemental plan instance. |
Output Fields
| Field Name |
Notes |
| <invoice_type> |
Allowable values
| Values |
Description |
| R |
Real invoice |
| P |
Pending invoice |
|
| <invoice_line_items> |
Allowable values
| Values |
Description |
| true |
Line items are available for the invoice. |
| false |
No line items are available for the invoice. |
|
| <transaction_type> |
Allowable values
| Values |
Description |
| 1 |
Invoice |
| -1 |
Voided Invoice |
| 2 |
check |
| -2 |
Voided Check |
| 3 |
Electronic Payment |
| -3 |
Voided Electronic Payment |
| 4 |
Balance Transfer To Account |
| -4 |
Voided Balance Transfer To Account |
| 5 |
Balance Transfer From Account |
| -5 |
Voided Balance Transfer From Account |
| 6 |
Write-Off |
| -6 |
Voided Write-Off |
| 7 |
Out-of-band Electronic Credit |
| -7 |
Voided Out-of-band Electronic Credit |
| 8 |
Refund Request |
| -8 |
Voided Refund Request |
| 9 |
Balance Forward |
| -9 |
Voided Balance Forward |
| 10 |
Cash Credit |
| -10 |
Voided Cash Credit |
| 11 |
Credit From Overpayment |
| -11 |
Voided Credit From Overpayment |
| 12 |
Electronic Refund Disbursement |
| -12 |
Voided Electronic Refund Disbursement |
| 13 |
Check Refund Disbursementt |
| -13 |
Voided Check Refund Disbursement |
| 14 |
External charge |
| -14 |
Voided External Charge |
| 15 |
Dunning Charge |
| -15 |
Voided Dunning Charge |
| 16 |
reinstated Charge transaction |
| -16 |
voided reinstated Charge transaction |
| 17 |
reinstated Payment transaction |
| -17 |
voided reinstated payment transaction |
| 18 |
Negative Balance Forward |
| -18 |
Voided Negative Balance Forward |
| 19 |
3rd party payment |
| -19 |
voided 3rd party payment |
| 20 |
3rd party payment refund |
| -20 |
voided 3rd party payment refund |
| 21 |
Invoice charge line item |
| -21 |
Voided Invoice charge line item |
| 22 |
Invoice credit line item |
| -22 |
Voided Invoice credit line item |
| 24 |
Credit memo line |
| -24 |
Voided credit memo line |
|
| <is_excluded> |
Allowable values
| Values |
Description |
| 0 |
The invoice line item is taxable (included) |
| 1 |
The invoice line item is not taxable (excluded) |
|
| <line_type> |
Allowable values
| Values |
Description |
| 1 |
Recurring charge |
| 2 |
Tax charge |
| 3 |
Service credit |
| 4 |
Coupon Credit |
| 5 |
Activation Charge |
| 6 |
Usage Charge |
| 7 |
Recurring arrears charge |
| 8 |
Order charge |
| 9 |
Surcharge |
|
| <tax_inclusive_ind> |
Allowable values
| Values |
Description |
| 0 |
The service is tax-exclusive. |
| 1 |
The service is tax-inclusive. |
|
