get_invoice_information_m Guide
- Last updated
-
-
Save as PDF
Gets invoice details for all accounts matching specified query.
Additional Guidance
Querystring Keys
| Key Name |
Description |
| invoice_no |
The Aria assigned ID of the invoice. The API returns data when you pass a real invoice_no. But when you pass a pending invoice_no, API does not return data. |
| 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 |
| amount |
Amount charged on an invoice |
| bill_date |
The date on which the account was billed for the invoice. Use the format yyyy-mm-dd. |
| due_date |
Date on which payment for an invoice was due |
| paid_date |
Date on which the invoice was paid |
| balance_forward |
Previous balance on an account that was carried over to the next billing period |
| total_due |
Total balance due on the invoice |
| last_updated |
Most recent date on which the invoice was updated |
| aria_statement_no |
The unique, Aria-assigned statement number with which an invoice is associated |
| acct_statement_seq_str |
Client-defined invoice identifier. This may be a combination of elements such as the customer's ISO country code and the statement number, depending on your client configuration. Please contact Aria Customer Support for information and setup related to client-defined invoice numbering. |
| second_acct_statement_seq_str |
Additional client-defined invoice identifier. This may be a combination of elements such as the customer's bank account number and the statement number, depending on your client configuration. Please contact Aria Customer Support for information and setup related to client-defined invoice numbering. |
| custom_status_label |
Value allowed for Client specific custom invoice status that can be edited at the invoice or pending invoice level |
| client_notes |
Client specific custom invoice notes that can be edited at the invoice or pending invoice level |
| invoice_type_cd |
This field identifies the type of the invoice generated: 'C' - Combined Invoice, 'F' - Anniversary Period Invoice, 'H' - Hybrid Invoice, 'O' - Order-based Invoice, 'P' - Non-anniversary Subscription Invoice, and 'R' - Rebill Invoice |
| 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 |
Identifier for a transaction that applies to an invoice line item |
| po_num |
Purchase order number assigned to the invoice. |
Output Fields
| Field Name |
Notes |
| <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 (Deprecated) |
Out-of-band Electronic Credit |
| -7 (Deprecated) |
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) |
|
| <second_acct_statement_seq_str> |
A Modulus 11 calculation method is used to generate the ‘check digit’ during statement generation. The ‘check digit’ can be configured from Configuration > Notifications > Statement Sending > Check Digit.
|
