Difference between revisions of "Sales.AssignTaxAuthorities Callwrapper"

From GAB Help
Jump to: navigation, search
(Created documentation page for callwrapper)
 
(Minor corrections and formatting changes.)
Line 50: Line 50:
 
'''Required.''' Flag denoting if taxes are assigned from index.
 
'''Required.''' Flag denoting if taxes are assigned from index.
  
===*ShippingState(String)==
+
===*ShippingState(String)===
 
'''Required.''' Ship to state.
 
'''Required.''' Ship to state.
  
Line 83: Line 83:
  
 
===*SalesOrderNumber(Integer)===
 
===*SalesOrderNumber(Integer)===
'''Required for all data sources except Prospect, Customer, Customer Shipt To, and Origin Location.''' Sales order number.
+
'''Required for all data sources except Prospect, Customer, Customer Ship To, and Origin Location.''' Sales order number.
  
 
===*OrderType(Enum)===
 
===*OrderType(Enum)===
'''Required for all data sources except Prospect, Customer, Customer Shipt To, and Origin Location.''' Sales order types:
+
'''Required for all data sources except Prospect, Customer, Customer Ship To, and Origin Location.''' Sales order types:
 
* <code>0</code> - Regular
 
* <code>0</code> - Regular
 
* <code>1</code> - CycleBilling
 
* <code>1</code> - CycleBilling
Line 96: Line 96:
  
 
===*OriginAddressTaxCode(Integer)===
 
===*OriginAddressTaxCode(Integer)===
'''Required for all data sources except Prospect, Customer, Customer Shipt To, and Origin Location.''' Tax code of the origin address.
+
'''Required for all data sources except Prospect, Customer, Customer Ship To, and Origin Location.''' Tax code of the origin address.
  
 
===*PreviousShippingState(String)===
 
===*PreviousShippingState(String)===
Line 185: Line 185:
  
 
===ReturnIsChanged(Boolean)===
 
===ReturnIsChanged(Boolean)===
Will be true if tax values have been updated by the module. Denotes that taxes were updated.
+
Denotes that taxes were updated. Will be true if tax values have been updated by the module.  
  
 
===Status(Enum)===
 
===Status(Enum)===

Revision as of 16:57, 20 March 2020

The call wrapper uses passed information to call the ProcessTax module to assign tax authorities. Tax data after assignment will be returned along with a status. Note that tax values may or may not change. This callwrapper uses SysParameterList instead of linkage.

Version Requirements

Minimum version: 2020.1

Maximum version: N/A

Passed Properties

*CompanyCode(String)

Required. Company code.

Mode(Integer)

Hard coded to 21 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
  • 3 - Shipment
  • 4 - OpenInvoice
  • 5 - InvoiceBatch

*TaxAssignEvent(Enum)

Required. The tax assign event describes the activity or reason that causes tax authorities to be reassigned. When creating a new entity where taxes are not defaulted from another entity (like customer), use the assign event. When creating a new entity where taxes default from another entity (like order), use the reassign event after the entity defaults to apply any current changes. When the ship to state is manually changed on an entity, use StateChange to reassign taxes for the new state. When the ship to zip code is manually changed but the ship to state is not, use ZipOnlyChange to reassign taxes for the new zip code. Tax assign events:

  • 0 - Assign(default)
  • 1 - Reassign
  • 2 - StateChange(not applicable to lines)
  • 3 - ZipCodeOnlyChange(not applicable to lines)

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 denoting 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 source types except Origin Location. Vat exempt types:

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

*VatRuleID(Integer)

Required for all data source types except Origin Location. VAT rule ID.

*CustomerNumber(String)

Required for all data source types except Origin Location. Customer number.

*TaxSource(Enum)

Required for all data source types 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 sources except Prospect, Customer, and Origin Location. Customer to ship to.

*SalesOrderNumber(Integer)

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

*OrderType(Enum)

Required for all data sources 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 sources except Prospect, Customer, Customer Ship To, and Origin Location. Tax code of the origin address.

*PreviousShippingState(String)

Required for StateChg or ZipOnlyChg tax assignment events. Should contain the value of the ship to state prior to the recent change.

*PreviousShippingZipCode(String)

Required for StateChg or ZipOnlyChg tax assignment events. Should contain the value of the ship to zip code prior to the recent change.

SuppressTaxMessage(Boolean)

Optional for StateChg or ZipOnlyChg tax assignment events. When true, it will suppresses the message asking whether to refresh taxes when the tax state/zip code does not match the previous ship to state/zip code.

*PartNumber(String)

Required when data source is at line level such as order lines. Part number on the line.

*PartNumberRevision(String)

Required when data source is at line level such as order lines. Part number revision on the line.

*PartLocationCode(String)

Required when data source is at line level such as order lines. Part number location on the line.

*DiscountCompanyPrice(Double)

Required when data source is at line level such as order lines. Discounted price in company currency on the line.

*DiscountCustomerPrice(Double)

Required when data source is at line level such as order lines. Discounted price in customer currency on the line.

*LineType(Integer)

Required when data source is at line level such as order lines. The line type.

*TaxAssignSource(Enum)

Required when data source is at line level such as order lines. Tax assign source types:

  • 0 - Standard
  • 1 - Buyout
  • 2 - Consignment
  • 3 - DropShip
  • 4 - Freight
  • 5 - ProgressBill

*ShipmentSequence(Integer)

Required for Shipment, Open Invoice, Invoice Batch, and Invoice History data sources. Shipment sequence.

*InvoiceNumber(String)

Required for Invoice History data source. Invoice 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 AppliedTaxAuthorityInformation)

Takes list ReturnTaxAuthorityZones(Strings), ReturnTaxAuthorityCodes(Strings), ReturnApplyTaxes(Booleans), and ReturnAuthorityTypeTaxes(Integers) 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 number

ReturnAssignSourceTax(Integer)

Provided when data source is at line level such as order lines. Denotes method used to assign.

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.AssignTaxAuthorities