Skip to main content
Knowledge Central
Aria Knowledge Central

create_payment_terms_m

  1. Last updated
  2. Save as PDF

Creates a new PaymentTerms

 
Req Field Name Field Type Max Length Description
required-icon.png client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
required-icon.png auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
required-icon.png pmt_terms_name string 50 The name of the payment terms.
required-icon.png pmt_terms_description string 50 The description of the payment terms presented on external correspondence such as the invoice.
required-icon.png days_until_due long 3 Number of days before the invoice is considered past due.
  client_pmt_term_id string 100 Client-defined identifier for the billing group's payment term. If no value is present, default to pmt_terms_name value.
  days_until_due_method string 32 This allows the user to choose whether or not the Days Until Due will be based on the Invoice Date plus nn days or based on the end of the current month plus nn days. If the account is invoiced monthly, the Days Until Due = 10, and the current date is March 15th, the following behavior would happen. If the “Based on Invoice Date + nn days” is selected, the Due Date would be March 25th. If the “Based on end of current month + nn days” is selected, the Due Date would be April 10th. Note that any day in March with “Based on end of current month + nn days” selected would all bill on April 10th. The default if no value is provided is “Based on Invoice Date + nn days”.

Allowable values for days_until_due_method:

 
Values Description
Invoice Days Until Due will be based on the Invoice Date plus nn days.
Current Month Days Until Due will be based on the end of the current month plus nn day.
  discount_percent long 2 Prompt payment discount percent. If a value is populated then discount period must be populated.
  discount_period long 3 Number of days after invoicing in which payment must be received in order to qualify for discount. The discount period must be less than the days until due. Value should be null if discount percent is null. If discount percent is populated this field is required.
  functional_acct_group_no long 100 Functional account group assignment.
  pmt_terms_type int 1 This defines whether or not the Payment Terms are “Net Terms”(default) or “EAN/GLN” which is a standard for location based services/barcodes that require additional fields to be captured.

Allowable values for pmt_terms_type:

 
Values Description
0 Net Terms
1 EAN/GLN
  bill_lag_days int 3 The number of days prior to (negative) or after (positive) a Master Plan Instance’s billing date at which an invoice should be generated. The Bill Lag Days setting for a given account’s Master Plan Instance will override all other Bill Lag Days settings. The Bill Lag Days setting in the Collections Group level will override the Bill Lag Days setting at the Payment Method/Payment Terms level, and the Bill Lag Days setting at the Payment Method/Payment Terms level will override the Bill Lag Days setting in the Billing Recurring Interval level.
  surcharge_applicable boolean 5 Identifier to determine if a surcharge is applicable or not.

Allowable values for surcharge_applicable:

 
Values Description
true Surcharge is applicable.
false Surcharge is not applicable.
  surcharge_no long 32 Surcharge Number that is applicable to a surcharge mapped to Payment Terms only. This value is ignored if “surcharge_applicable” is set to false.
  auto_bill_orders boolean 5 Governs whether or not orders are immediately billed upon generation. This can be overridden by the order creation process.

Allowable values for auto_bill_orders:

 
Values Description
true Orders are immediately billed upon generation
false Orders aren't immediately billed upon generation
  pmt_reminder boolean 5 Governs whether or not to send a payment reminder notification to the account holder when their invoice goes unpaid longer than the number of days specified in the “”. Payment reminder emails can be set in the Email Templates section of the UI, and can be overridden at the Functional Account Group and individual account level.

Allowable values for pmt_reminder:

 
Values Description
true Send a payment reminder notification to the account.
false Do not send a payment reminder notification to the account.
  pmt_reminder_active_accts_only boolean 5 If pmt_reminder set to True and this value is set to False, the system will send the payment reminders after the specified number of days have elapsed without payment, regardless of account status. If pmt_reminder set to True and this value is set to True, the system will send payment reminders only when the account status indicates that the account is active, billable, and not currently within the dunning process. This will prevent the system from sending payment reminders to accounts which are suspended or in dunning.

Allowable values for pmt_reminder_active_accts_only:

 
Values Description
true The system will send payment reminders only when the account status indicates that the account is active, billable, and not currently within the dunning process.
false The system will send the payment reminders after the specified number of days have elapsed without payment, regardless of account status
Start of pmt_reminder_row array
  pmt_reminder_row array    
  Field Name Field Type Max Length Description
  brd_arrow.gifpmt_reminder_tmplt_class long 32 The Payment Reminder Template Class that is associated to the Payment Reminder Class of emails in the UI.
  brd_arrow.gifpmt_reminder_days_until_notifcation long 32 The number of days the system will wait after the account’s bill date before sending the payment reminder email to the account holder. It is recommended that this value be less than the “Days Until Due” value set in the days_until_due field, as these emails are never sent while the account/master plan instance is in the dunning process.
  brd_arrow.gifdefault_pmt_reminder_template long 32 The payment reminder email template that will be the default for this payment term. This template can be overridden on the Notification Template Group associated with a Functional Account Group, or at the individual account level under ‘Notification Method’ in the Account Overview.
  brd_arrow.gifpmt_reminder_notification_list long 32 The payment reminder email template that will be the default for this payment term. This template can be overridden on the Notification Template Group associated with a Functional Account Group, or at the individual account level under ‘Notification Method’ in the Account Overview.

Allowable values for pmt_reminder_notification_list:

 
Values Description
Default Sends notification to the account’s default contact option.
Administrative Sends notification to the account’s administrative contact.
Statement Sends notification to the statement contact.
Administrative Sends notification to the administrative and statement contacts.
End of pmt_reminder_row array
 

Output Arguments

 
Field Name Field Type Description
error_code long Aria-assigned unique identifier indicating the Aria client providing service to this account. 0 means no error.
error_msg string Description of any error that occurred. “OK” if there was no error.
payment_terms_no long Aria generated id for the payment terms.
  1. Back to top
  • Was this article helpful?

Recommended articles

  1. Page type
    Topic
  2. Tags
    1. API Specification