get_payment_terms_m
Summary
| API Name | get_payment_terms_m |
|---|---|
| Class | administration_services_m |
| Update Version | 6.38 |
Description
List of payment terms defined for the client is returned.
Inputs
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| client_no | long | 12 | Yes |
Aria-assigned unique identifier indicating the Aria client providing service to this account. |
| auth_key | string | 32 | Yes |
Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor. |
Outputs
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| error_code | long | No |
Aria-assigned error identifier. 0 indicates no error |
|
| error_msg | string | No |
Textual description of any error that occurred. "OK" if there was no error. |
|
| Start of all_payment_terms object | ||||
| all_payment_terms | object | No |
The all_payment_terms associated with this method. |
|
| Name | Type | Length | Required | Description |
| ▶payment_terms_no | long | Yes |
Aria generated id for the payment terms. |
|
| ▶terms_name_internal | string | Yes |
Client defined payment terms name (internal). |
|
| ▶terms_name_external | string | Yes |
Client defined payment terms description shown on external facing document. |
|
| ▶days_until_due | long | Yes |
Number of days before invoice becomes past due. |
|
| ▶discount_percent | long | Yes |
Percent discount for prompt payment. |
|
| ▶discount_period | long | Yes |
Validity period of discount in days. |
|
| ▶functional_acct_group | string | Yes |
Functional account group assigned to the payment terms. |
|
| ▶created_by | string | Yes |
User that created record. |
|
| ▶created_date | string | Yes |
Date and time the record was created. |
|
| ▶pmt_terms_type | string | 1 | No |
Payment Terms Type from Payment Terms configuration. |
| ▶days_until_due_method | string | 32 | No |
Days until due method from Payment Terms configuration. |
| ▶bill_lag_days | int | 3 | No |
Bill Lag Days from Payment Terms configuration. This value can be overridden at Master Plan Instance level. |
| ▶surcharge_applicable | boolean | 5 | No |
Surcharge applicable value from Payment Terms configuration. |
| ▶surcharge_no | long | 32 | No |
Surcharge Number from Payment Terms configuration. |
| ▶auto_bill_orders | boolean | 5 | No |
Auto Bill Orders value from Payment Terms configuration. |
| ▶pmt_reminder | boolean | 5 | No |
Payment Reminder value from Payment Terms configuration. |
| ▶pmt_reminder_active_accts_only | boolean | 5 | No |
Payment Reminder Active Accounts Only value from Payment Terms configuration. |
| Start of pmt_reminder_row object | ||||
| ▶pmt_reminder_row | object | No |
Array(s) of Payment Reminders including templates from Payment Terms configuration. |
|
| Name | Type | Length | Required | Description |
| ▶▶pmt_reminder_tmplt_class | long | 32 | No |
Payment Reminder Template Class from Payment Terms configuration. |
| ▶▶pmt_reminder_days_until_notifcation | long | 32 | No |
Payment Reminder Days Until Notification from Payment Terms configuration. |
| ▶▶default_pmt_reminder_template | long | 32 | No |
Default Payment Reminder Template from Payment Terms configuration. |
| ▶▶pmt_reminder_notification_list | long | 32 | No | |
| End of pmt_reminder_row object | ||||
| End of all_payment_terms object | ||||