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. | ||||||
![]() |
acct_no | long | 22 | Aria-assigned account identifier. This value is unique across all Aria-managed accounts. | ||||||
force_pending | string | 5 | Determines whether to create the invoice as a pending invoice (if client is not already configured to do so). Note: if client is configured for pending invoices, passing "false" here will NOT override the client setting.
Allowable values for force_pending:
|
|||||||
client_receipt_id | string | 50 | Client-defined unique identifier used to track related system actions | |||||||
alt_bill_day | long | 14 | Alternate bill day. If this is the account's first invoice generation, you may enter an Alternate Bill Day for the account. An Alternate Bill Day allows you to specify a new anniversary date for an account. | |||||||
invoice_mode | long | 1 | For use of generating advance invoices, 0 current cycle and 1 advance cycle. You can only generate an advance invoice if one is not currently generated. | |||||||
alt_caller_id | string | 30 | Person or process that submitted the API call. This can be someone's user ID, or the name of an application. | |||||||
optional_transaction_qualifiers | array | Array of additional values you can associate with this API call. | ||||||||
![]() |
string | 100 | Name of the field you want to associate with this API call. | |||||||
![]() |
string | 100 | Corresponding value of the field you want to associate with this API call. | |||||||
application_id | string | 300 | The application identifier in which the API is being used in. (Example: “Sales Force”) | |||||||
application_date | string | 300 | The application date/timestamp, ie. 01/01/2014 10:00:00 to track when the application called the API. |
Field Name | Field Type | Description |
---|---|---|
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. |
invoice_no | long | The unique identifier of a given invoice. |
third_party_errors | hash | Errors from third-party systems like taxation engines are returned here. Aria-generated error codes are returned in the error_code and error_msg fields at the root level of the API return. |
![]() |
string | Type of error code being represented, such as taxation |
![]() |
string | Aria-assigned error identifier. 0 indicates no error. |
![]() |
string | Description of any error that occurred. "OK" if there was no error. |