Search the Aria Knowledgebase for
User Documentation, APIs, SDKs, and more!

 

Home > apidocs > Aria Crescendo core api > manage pending invoice m

manage pending invoice m

Approves, discards, or regenerates a pending invoice. A pending invoice can be retrieved based on the invoice number or master plan instance id. After a pending invoice is approved, this call can also collect a payment and send a statement. If the collection fails, the pending invoice will automatically be voided provided the system setting "Auto Void Pending Invoice on Collection Failure" is set to True.

Input Arguments

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.
invoice_no long 22 The unique identifer of a given invoice.
  OR      
  acct_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
  OR      
  client_acct_id string   This is the client-assigned identifier for the account.
  master_plan_instance_no long 22 The Master Subscription plan instance number.
  OR      
  client_master_plan_instance_id string 100 Client-defined Master plan Subscription plan instance ID.
  action_directive long 8 Identifies which action to take on the pending invoice. If null, defaults to "approve pending invoice".   Allowable Values
  bill_seq long 22 The unique identifier of the bill sequence number.
  alt_pay_method long 8 If you wish to use the account's current form of payment, leave this value empty. If you wish to use an alternate credit card, enter '1' for this value.
  cc_number string 24 Credit card number.
  cc_expire_mm long 2 Expiration month for the credit card payment instrument.
  cc_expire_yyyy long 4 Expiration year for the credit card payment instrument.
  bank_routing_num string 9 The ABA routing number for the bank holding 'bank_acct_num'
  bank_acct_num string 19 The bank account number.
  bill_company_name string 100 Company name of the billing contact
  bill_first_name string 3 First name of the billing contact
  bill_middle_initial string 1 Middle Initial of the billing contact
  bill_last_name string 32 Last name of the billing contact
  bill_address1 string 100 First address line of the billing contact
  bill_address2 string 100 Second address line of the billing contact
  bill_city string 32 City of the billing contact
  bill_locality string 32 Locality of the billing contact
  bill_state_prov string 2 State or Province of the billing contact. The official postal-service codes for all United States, Australia and Canada states, provinces, and territories. This field does not support states, provinces or territories from other countries. Use the locality field for other countries.
  bill_zip string 14 Zip Code of the billing contact
  bill_country string   ISO-compliant 2-country code abbreviation for the billing address country in uppercase.
  bill_email string 500 Email of the billing contact
  bill_phone string 40 Phone of the billing contact
  bill_phone_extension string 10 Phone extension of the billing contact
  bill_cell_phone string 40 Cell phone of the billing contact
  bill_work_phone string 40 Work phone of the billing contact
  bill_work_phone_extension string 10 Work phone extenstion of the billing contact
  cvv string 6 Card Verification Value, used to help verify a transaction is being requested by the card holder since this value is physically printed on the credit card.
  alt_collect_on_approve string   If value is non-null, overrides the client setting regarding whether or not to automatically collect after approving the invoice. Leave this value null to use the client setting.   Allowable Values
  alt_send_statement_on_approve string   If value is non-null, overrides the client setting regarding whether or not to automatically send a statement after approving the invoice. Leave this value null to use the client setting.   Allowable Values
  cancel_orders_on_discard string   If true then orders will be canceled if the action directive is set to discard pending invoices.   Allowable Values
  bank_acct_type string 32 The type of bank account being used.   Allowable Values
  bill_address3 string   The third line of the billing address
  track_data1 string   Raw "track 1" data from a swiped credit card used in a card-present transaction to initiate this request
  track_data2 string   Raw "track 2" data from a swiped credit card used in a card-present transaction to initiate this request
  client_receipt_id string 50 Client-defined unique identifier used to track related system actions.
  iban string 50 International Bank Account Number(IBAN). Used for the Direct Debit payment method. It consists of 16 to 34 alphanumeric characters. Only hyphen and space are allowed to format the IBAN.
  bank_check_digit long 2 Bank check digits enable a sanity check of the bank account number to confirm its integrity before submitting a transaction. Used for the Direct Debit payment method.
  bank_swift_cd string 15 SWIFT code is a standard format of Bank Identifier Codes (BIC). Used for the Direct Debit payment method. It consists of 8 or 11 alphanumeric characters. Only hyphen and space are allowed to format the SWIFT code. It is required for IBAN.
  bank_country_cd string 2 Country of the bank. The ISO-compliant 2-character country code abbreviation in uppercase. Used for the Direct Debit payment method. It is required for IBAN and BBAN.
  mandate_id string 35 Used for the Direct Debit payment method. A mandate is signed by the debtor to authorise the creditor to collect a payment and to instruct the bank of the debtor to pay those collections.
  bank_id_cd string 10 Up to 10 digit numeric bank identifier code. Used for the Direct Debit payment method. Used in Europe. Only hyphen and space are allowed to format the bank ID code. It is required for BBAN.
  bank_branch_cd string 10 Up to 10 digit numeric bank branch code. Used for the Direct Debit payment method. Used in Europe. Only hyphen and space are allowed to format the bank branch code.
  custom_status_label string 100 Client-specific custom invoice status that can be edited at the invoice or pending invoice level
  client_notes string 1000 Client-specific custom invoice notes that can be edited at the invoice or pending invoice level
  alt_caller_id string 100  
  optional_transaction_qualifiers array    
  qualifier_name string 100  
  qualifier_value string 100  

Output Arguments

Field Name Field Type Description
new_invoice_no long The new invoice number generated.
out_acct_no long Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
out_client_acct_id string This is the client-assigned identifier for the account.
out_billing_group_no long Billing group number
out_client_billing_group_id string Client-defined unique identifier for billing group
collection_error_code long If a collection is attempted, returns the error code associated with the collection.
collection_error_msg string The error message associated with collection_error_code.
statement_error_code long Error code for statement generation failure.
statement_error_msg string The text message associated with 'statement_error_code'
proc_cvv_response string The processor return code from CVV validation.
proc_avs_response string Processor return code from address validation
proc_cavv_response string The processors return code for security validation.
proc_status_code string The processor status code
proc_status_text string The processors status description
proc_payment_id string The processor payment ID
proc_auth_code string Authorization code provided by the issuing bank
proc_merch_comments string Additional information passed to payment processor
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.

Input Parameters

Fill out the required input parameter to execute API Live. A Live call will be made against the URL you specify to give you actual results formatted.

You must to post a comment.
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.