Difference between revisions of "Sales.EditTaxAuthorities Callwrapper"

From GAB Help
Jump to: navigation, search
(Created callwrapper documentation page)
 
(Added "in development" statement to description)
 
Line 1: Line 1:
The call wrapper will use passed information to call the ProcessTax module to retrieve tax code data, display the information on the tax screen, and allow full data update including selection of tax source.  Tax data after update will be returned along with a status.  Note that tax values may or may not change.
+
'''(This callwrapper is still in development and has not been released yet.)''' The call wrapper will use passed information to call the ProcessTax module to retrieve tax code data, display the information on the tax screen, and allow full data update including selection of tax source.  Tax data after update will be returned along with a status.  Note that tax values may or may not change.
  
 
==Version Requirements==
 
==Version Requirements==

Latest revision as of 12:20, 23 March 2020

(This callwrapper is still in development and has not been released yet.) The call wrapper will use passed information to call the ProcessTax module to retrieve tax code data, display the information on the tax screen, and allow full data update including selection of tax source. Tax data after update will be returned along with a status. Note that tax values may or may not change.

Version Requirements

Minimum version: 2020.1

Maximum version: N/A

Passed Properties

*CompanyCode(String)

Required. Company code

Mode(Integer)

Hard coded to 1 for this callwrapper.

*SourceDataType(Enum)

Required. The data source is used to apply specific rules and criteria within the tax module. The value is normally based on the object used to populate the properties passed to the tax module. A data source may be applicable to more than one object. For instance, a data source of Order would be used both for the order ship to and order line. Also, a data source may be specific to the status of data in the object. For example, data sources of shipment, open invoice, and invoice batch are all shipments is a different step in the invoice cycle. Source data types:

  • 1 - Order
  • 5 - InvoiceBatch

Username(String)

Current user ID. User name will be defaulted from the current process if not provided by the calling module.

*TaxState(String)

Required. Tax state.

*TaxZipCode(String)

Required. Tax zip code.

*TaxImport(Enum)

Required. Tax import types:

  • 0 - None
  • 1 - Used
  • 2 - NotUsed

===*TaxAuthorities(List Of AppliedTaxAuthority) Required. Takes TaxAuthorities list and splits it into lists TaxAuthorityZones(Strings), TaxAuthorityCodes(Strings), and ApplyTaxes(Booleans).

*UsedAuthorityIndex(Boolean)

Required. Flag for if taxes are assigned from index.

*ShippingState(String)

Required. Ship to state.

*ShippingZipCode(String)

Required. Ship to zip code.

VatExemptType(Enum)

Required for all data sources except Origin Location. Vat exempt types:

  • 0 - None
  • 1 - Import
  • 2 - Export
  • 3 - Product
  • 4 - Company

*VatRuleID(Integer)

Required for all data sources except Origin Location. VAT rule ID.

*CustomerNumber(String)

Required for all data sources except Origin Location. Customer number.

*TaxSource(Enum)

Required for all data sources except Origin Location. Tax source types.

  • 0 - None
  • 1 - Manual
  • 2 - ShipTo
  • 3 - Order
  • 4 - Location(no longer used but still present in some legacy modules)
  • 4 - Origin

*CustomerShipToNumber(String)

Required for all data source except Prospect, Customer, Customer Ship To, and Origin Location. Customer ship to.

*SalesOrderNumber(Integer)

Required for all data source except Prospect, Customer, Customer Ship To, and Origin Location. Sales order number.

*OrderType(Enum)

Required for all data source except Prospect, Customer, Customer Ship To, and Origin Location. Sales order types:

  • 0 - Regular
  • 1 - CycleBilling
  • 2 - DetailBilling
  • 3 - Repair
  • 4 - InvoiceOnly
  • 5 - Blanket
  • 6 - Transfer

*OriginAddressTaxCode(Integer)

Required for all data source except Prospect, Customer, Customer Ship To, and Origin Location. Origin address tax code.

*SalesExemptNumber(String)

Only required for Prospect, Customer, and Customer Ship To data sources. Sales tax exempt number.

Returned Properties

ReturnTaxSource(Enum)

Tax source types:

  • 0 - None
  • 1 - Manual
  • 2 - ShipTo
  • 3 - Order
  • 4 - Location(no longer used but still present in some legacy modules)
  • 4 - Origin

*ReturnTaxState(String)

Tax state.

*ReturnTaxZipCode(String)

Tax zip code.

ReturnTaxAuthorities(List Of AppliedTaxAuthority)

Takes list ReturnTaxAuthorityZones(Strings), ReturnTaxAuthorityCodes(Strings), and ReturnApplyTaxes(Booleans) and combines them into ReturnTaxAuthorities.

ReturnTaxImport(Enum)

Tax import types:

  • 0 - None
  • 1 - Used
  • 2 - NotUsed

ReturnUsedAuthorityIndex(Boolean)

Flag for if taxes were assigned from the index.

ReturnOriginAddressTaxCode(Integer)

Origin address tax code.

ReturnSalesExemptNumber(String)

Only for Prospect, Customer, and Customer Ship To data sources.

ReturnAuthorityCount(Integer)

The number of tax authorities.

ReturnAuthoritySalesCount(Integer)

The number of sales tax authorities.

ReturnAuthorityVatCount(Integer)

The number of VAT tax authorities.

ReturnIsChanged(Boolean)

Denotes that taxes were updated. Will be true if tax values have been updated by the module.

Status(Enum)

Returned statuses:

  • 0 - Successful
  • 1 - InvalidParameter
  • 2 - Failed
  • 3 - Cancel

Technical Information

  • Core program: ProcessTax
  • Full name: GSSEO.Callwrappers.Sales.EditTaxAuthorities