| API Name |
Trans Type(s) |
API INPUTS (Examples) |
API OUTPUTS (Examples) |
|
record_external_ payment_m
|
Check (2) |
Some input fields omitted for brevity.
<lit:record_external_payment_m>
<lit:acct_no>34379680</lit:acct_no> <lit:reference_code>7858585</lit:reference_code> <lit:payment_amount>21.62</lit:payment_amount></lit:record_external_payment_m>
<lit:get_transaction_information_m>
<lit:query_string>aria_event_no=547717539</lit:query_string> </lit:get_transaction_information_m>
|
Some output fields omitted for brevity.
<ns1:record_external_payment_m>
<ns1:transaction_id>547717539</ns1:transaction_id> <ns1:record_external_payment_m>
Related Transaction Detail
<ns1:get_transaction_information_m>
<ns1:total_records>1</ns1:total_records> <ns1:transaction_information> <ns1:aria_event_no>547717539</ns1:aria_event_no> <ns1:transaction_date>2024-12-30 18:39:59</ns1:transaction_date> <ns1:transaction_type>Check</ns1:transaction_type> <ns1:transaction_type_no>2</ns1:transaction_type_no> <ns1:is_charge_type>0</ns1:is_charge_type> <ns1:type_specific_id>218396988</ns1:type_specific_id> <ns1:acct_no>34379680</ns1:acct_no> <ns1:amount>21.62</ns1:amount> <ns1:total_amount_applied>21.62</ns1:total_amount_applied> <ns1:update_date>2024-12-30 18:39:59</ns1:update_date> <ns1:related_transaction> <ns1:aria_event_no>547717531</ns1:aria_event_no> <ns1:transaction_date>2024-12-30 18:31:43</ns1:transaction_date> <ns1:transaction_type>Invoice charge line item</ns1:transaction_type> <ns1:transaction_type_no>21</ns1:transaction_type_no> <ns1:is_charge_type>1</ns1:is_charge_type> <ns1:type_specific_id>118517110</ns1:type_specific_id> <ns1:acct_no>34379680</ns1:acct_no> <ns1:amount>20</ns1:amount> <ns1:aria_statement_no>2194080087</ns1:aria_statement_no> <ns1:total_amount_applied>20</ns1:total_amount_applied> <ns1:related_amount_applied>20</ns1:related_amount_applied> <ns1:update_date>2024-12-30 18:39:59</ns1:update_date> <ns1:void_date xsi:nil="true"/> <ns1:fully_applied_date>2024-12-30 18:39:59</ns1:fully_applied_date> <ns1:master_plan_instance_no>4375010</ns1:master_plan_instance_no> <ns1:related_amount>20</ns1:related_amount> </ns1:related_transaction> <ns1:related_transaction> <ns1:aria_event_no>547717532</ns1:aria_event_no> <ns1:transaction_date>2024-12-30 18:31:43</ns1:transaction_date> <ns1:transaction_type>Invoice charge line item</ns1:transaction_type> <ns1:transaction_type_no>21</ns1:transaction_type_no> <ns1:is_charge_type>1</ns1:is_charge_type> <ns1:type_specific_id>118517111</ns1:type_specific_id> <ns1:acct_no>34379680</ns1:acct_no> <ns1:amount>0.4</ns1:amount> <ns1:aria_statement_no>2194080087</ns1:aria_statement_no> <ns1:total_amount_applied>0.4</ns1:total_amount_applied> <ns1:related_amount_applied>0.4</ns1:related_amount_applied> <ns1:update_date>2024-12-30 18:39:59</ns1:update_date> <ns1:fully_applied_date>2024-12-30 18:39:59</ns1:fully_applied_date> <ns1:master_plan_instance_no>4375010</ns1:master_plan_instance_no> <ns1:related_amount>0.4</ns1:related_amount> </ns1:related_transaction> <ns1:related_transaction> <ns1:aria_event_no>547717533</ns1:aria_event_no> <ns1:transaction_date>2024-12-30 18:31:43</ns1:transaction_date> <ns1:transaction_type>Invoice charge line item</ns1:transaction_type> <ns1:transaction_type_no>21</ns1:transaction_type_no> <ns1:is_charge_type>1</ns1:is_charge_type> <ns1:type_specific_id>118517112</ns1:type_specific_id> <ns1:acct_no>34379680</ns1:acct_no> <ns1:amount>1.22</ns1:amount> <ns1:aria_statement_no>2194080087</ns1:aria_statement_no> <ns1:total_amount_applied>1.22</ns1:total_amount_applied> <ns1:related_amount_applied>1.22</ns1:related_amount_applied> <ns1:update_date>2024-12-30 18:39:59</ns1:update_date> <ns1:void_date xsi:nil="true"/> <ns1:fully_applied_date>2024-12-30 18:39:59</ns1:fully_applied_date> <ns1:master_plan_instance_no>4375010</ns1:master_plan_instance_no> <ns1:related_amount>1.22</ns1:related_amount> </ns1:related_transaction> </ns1:transaction_information> </ns1:get_transaction_information_m>
|
Note: The client parameter "Allow Payments Prior to First Invoice and Prior to Previous External Payments" (Configuration > Payments > Payment Settings), when set to "true," allows you to record external payments on accounts that have not yet invoiced or where the payment date predates prior billing or external payments. This enables use cases such as accepting commitment payments on newly created, non-billable or inactive accounts and having those funds available to allocate to future invoices as they are generated.
External Payment (Type 2)

