Home > Aria6 User Documentation > Aria6 core api > pre_calc_invoice

pre_calc_invoice

Calculates a hypothetical invoice based on geographic data and hypothetical invoice line items and returns the taxes that would appear on that hypothetical invoice based on the taxation configuration rules currently set up for the client within Aria.

Input Arguments

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.
  log_id string 100 When using a client's custom tax server, this value will identify the Aria log entry for the tax server request.
  first_name string 32 Contact first name
  mi string 1 The Middle Initial of the contact.
  last_name string 32 Contact last name
  address1 string 100 First address line of the contact
  address2 string 100 Second address line of the contact. If you want to delete existing data in this field, leaving it blank, you must enter a '~' in this field.
  city string 32 City of the contact
  state_prov_code string 2

State or province of the contact. The official postal-service code for any state, province, or territory in the United States, Australia, or Canada. This field does not support states, provinces, or territories in other countries.

This field is ignored for all addresses outside the United States, Australia, and Canada.
  zip_code string 14 Postal/Zip code for the contact address.
  country_code string 2 Country of the contact
  currency_code string 2 The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method.
  pre_calc_plan array    
  brd_arrow.gif plan_item_service_no long 22 Service number for the item on this plan
  OR      
  brd_arrow.gif client_plan_item_service_id string 100 Client-defined service ID for the item on this plan
  brd_arrow.gif plan_item_plan_no long 22 Plan number the item appears on
  OR      
  brd_arrow.gif client_plan_item_plan_id string 100 Client-defined plan ID the item appears on
  brd_arrow.gif plan_item_units double 12 Number of units for the item on this plan
  brd_arrow.gif plan_item_unit_amount double 12 The per unit amount for the item on this plan
  pre_calc_sku array    
  brd_arrow.gif sku string 100 Client-defined SKU identifier
  brd_arrow.gif sku_plan_no long 22 Plan number for the client SKU
  OR      
  brd_arrow.gif client_sku_plan_id string 100 Client-defined plan ID for the client SKU
  brd_arrow.gif sku_units double 12 Number of SKU units for this item.
  brd_arrow.gif sku_unit_amount double 12 The per unit amount for this SKU item
  tax_exempt_cd long 22 Tax exemption status (this is not part of the above arrays). For Aria taxes, 0=not exempt, 1=exempt from state taxes, 2=exempt from country taxes, 3=exempt from state and country taxes. Values may be different for client's custom tax servers.  
Values Description
0 Not exempt
1 Exempt from state taxes
2 exempt from country taxes
3 exempt from state and country taxes
  address3 string 300 The third line of the address
  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.
  brd_arrow.gif qualifier_name string 100 Name of the field you want to associate with this API call.
  brd_arrow.gif qualifier_value string 100 Corresponding value of the field you want to associate with this API call.
 

Output Arguments

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.
inv_calc_out hash  
brd_arrow.gif tax_item_code long Tax Item Code
brd_arrow.gif tax_item_desc string Description of the Tax Item
brd_arrow.gif tax_item_amount double Calculated amount of the Tax item
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.
brd_arrow.gif error_class string Type of error code being represented, such as taxation
brd_arrow.gif error_code string Aria-assigned error identifier. 0 indicates no error.
brd_arrow.gif error_msg string Description of any error that occurred. "OK" if there was no error.
 
 
 
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.
Powered by CXone Expert ®