AvaTax for Communications RPG interface user manual

EZ Version

RPG Procedure

EZ_ADJ_DEBITJX

RPG Copy

EZADJDBTJX

Description

EZTaxAdjDebitJEx accepts transaction data and performs appropriate tax calculations required to refund or credit taxes for Debit cards. If the AFC session was started with the tax log open, appropriate tax reductions are logged and will be reflected in tax reports. BTN, origination and termination information is passed using JCodes.

Format

EZ_ADJ_DEBITJX (pHandle: pBTN_JCode: pOrig_JCode: pTerm_JCode: (Generic transaction data): (Generic returned tax info): pError: pDiscount: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType: pAdjMethod);

Return Value

pTaxCount (10I 0)

Parameters

pHandle (10I 0)

pBTN_JCode (10U 0)

pOrig_JCode (10U 0)

pTerm_JCode (10U 0)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0)

pDiscount (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

pAdjMethod (10I 0)

Remarks

None

E9 Version

RPG Procedure

E9_ADJ_DEBITJX

RPG Copy

E9ADJDBTJX

Description

EZTaxAdjDebitJEx accepts transaction data and performs appropriate tax calculations required to refund or credit taxes for Debit cards. If the AFC session was started with the tax log open, appropriate tax reductions are logged and will be reflected in tax reports. BTN, origination and termination information is passed using JCodes.

Format

E9_ADJ_DEBITJX (pSessionPtr: pBTN_JCode: pOrig_JCode: pTerm_JCode: (Generic transaction data Appendix A): (Generic returned tax info Appendix B): pError: pDiscount: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType: pAdjMethod: (Generic transaction data, Appendix A2): (Generic returned tax info, Appendix B2)

Return Value

pTaxCount (10I 0)

Parameters

pSessionPtr (*)

pBTN_JCode (10U 0)

pOrig_JCode (10U 0)

pTerm_JCode (10U 0)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0)

pDiscount (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

pAdjMethod (10I 0)

Generic transaction data2: See Appendix A2

Generic returned tax info 2: See Appendix B2

Remarks

None

EZ Option

RPG Procedure

EZ_ADJ_DEBITNX

RPG Copy

EZADJDBTNX

Description

EZTaxAdjDebitNEx accepts transaction data and performs appropriate tax calculations required to refund or credit taxes for Debit cards. If the AFC session was started with the tax log open, appropriate tax reductions are logged and will be reflected in tax reports. BTN, origination and termination information is passed using NPANXXs.

Format

EZ_ADJ_DEBITNX (pHandle: pBTN_NPAN: pOrig_NPAN: pTerm_NPAN: (Generic transaction data): (Generic returned tax info): pError: pDiscount: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline: pExemptType: pAdjMethod);

Return Value

pTaxCount (10I 0)

Parameters

pHandle (10I 0)

pBTN_NPAN (10I 0)

pOrig_NPAN (10I 0)

pTerm_NPAN (10I 0)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0)

pDiscount (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

pAdjMethod (10I 0)

Remarks

None

E9 Version

RPG Procedure

E9_ADJ_DEBITNX

RPG Copy

E9ADJDBTNX

Description

EZTaxAdjDebitNEx accepts transaction data and performs appropriate tax calculations required to refund or credit taxes for Debit cards. If the AFC session was started with the tax log open, appropriate tax reductions are logged and will be reflected in tax reports. BTN, origination and termination information is passed using NPANXXs.

Format

E9_ADJ_DEBITNX (pSessionPtr: pBTN_NPAN: pOrig_NPAN: pTerm_NPAN: (Generic transaction data Appendix A): (Generic returned tax info Appendix B): pError: pDiscount: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline: pExemptType: pAdjMethod): (Generic transaction data, Appendix A2):(Generic returned tax info, Appendix B2)

Return Value

pTaxCount (10I 0)

Parameters

pSessionPtr (*)

pBTN_NPAN (10I 0)

pOrig_NPAN (10I 0)

pTerm_NPAN (10I 0)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0)

pDiscount (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

pAdjMethod (10I 0)

Generic transaction data 2: See Appendix A2

Generic returned tax info 2: See Appendix B2

Remarks

None

EZ Version

RPG Procedure

EZ_ADJ_DEBITPX

RPG Copy

EZADJDBTPX

Description

EZTaxAdjDebitPEx accepts transaction data and performs appropriate tax calculations required to refund or credit taxes for Debit cards. If the AFC session was started with the tax log open, appropriate tax reductions are logged and will be reflected in tax reports. BTN, origination and termination information is passed using PCodes.

Format

EZ_ADJ_DEBITPX (pHandle: pBTN_PCode: pOrig_PCode: pTerm_PCode: (Generic transaction data): (Generic returned tax info): pError: pDiscount: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType: pAdjMethod);

Return Value

pTaxCount (10I 0)

Parameters

pHandle (10I 0)

pBTN_PCode (10U 0)

pOrig_PCode (10U 0)

pTerm_PCode (10U 0)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0)

pDiscount (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

pAdjMethod (10I 0)

Remarks

None

E9 Version

RPG Procedure

E9_ADJ_DEBITPX

RPG Copy

E9ADJDBTPX

Description

EZTaxAdjDebitPEx accepts transaction data and performs appropriate tax calculations required to refund or credit taxes for Debit cards. If the AFC session was started with the tax log open, appropriate tax reductions are logged and will be reflected in tax reports. BTN, origination and termination information is passed using PCodes.

Format

E9_ADJ_DEBITPX (pSessionPtr: pBTN_PCode: pOrig_PCode: pTerm_PCode: (Generic transaction data Appendix A): (Generic returned tax info Appendix B): pError: pDiscount: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType: pAdjMethod): (Generic transaction data, Appendix A2):(Generic returned tax info, Appendix B2)

Return Value

pTaxCount (10I 0)

Parameters

pSessionPtr (*)

pBTN_PCode (10U 0)

pOrig_PCode (10U 0)

pTerm_PCode (10U 0)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0)

pDiscount (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

pAdjMethod (10I 0)

Generic transaction data 2: See Appendix A2

Generic returned tax info 2: See Appendix B2

Remarks

None

EZ Version

RPG Procedure

EZ_ADJ_DEBITZX

RPG Copy

EZADJDBTZX

Description

EZTaxAdjDebitZEx accepts transaction data and performs appropriate tax calculations required to refund or credit taxes for Debit cards. If the AFC session was started with the tax log open, appropriate tax reductions are logged and will be reflected in tax reports. The tax jurisdiction is specified using address information, identical to EZTaxDebitZEx.

Format

EZ_ADJ_DEBITZX (pHandle: pZipCode: pZipPlus4: pCountry: pState: pCounty: pLocality: (Generic transaction data): (Generic returned tax info): pError: pDiscount: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType: pAdjMethod);

Return Value

pTaxCount (10I 0)

Parameters

pHandle (10I 0)

pZipCode (6A)

pZipPlus4 (5A)

pCountry (4A)

pState (3A)

pCounty (26A)

pLocality (26A)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0)

pDiscount (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

pAdjMethod (10I 0)

Remarks

None

E9 Version

RPG Procedure

E9_ADJ_DEBITZX

RPG Copy

E9ADJDBTZX

Description

EZTaxAdjDebitZEx accepts transaction data and performs appropriate tax calculations required to refund or credit taxes for Debit cards. If the AFC session was started with the tax log open, appropriate tax reductions are logged and will be reflected in tax reports. The tax jurisdiction is specified using address information, identical to EZTaxDebitZEx.

Format

E9_ADJ_DEBITZX (pSessionPtr: pZipCode: pZipPlus4: pCountry: pState: pCounty: pLocality: (Generic transaction data Appendix A): (Generic returned tax info Appendix B): pError: pDiscount: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType: pAdjMethod): (Generic transaction data, Appendix A2): (Generic returned tax info, Appendix B2)

Return Value

pTaxCount (10I 0)

Parameters

pSessionPtr (*)

pZipCode (6A)

pZipPlus4 (5A)

pCountry (4A)

pState (3A)

pCounty (26A)

pLocality (26A)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0)

pDiscount (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

pAdjMethod (10I 0)

Generic transaction data 2: See Appendix A2

Generic returned tax info 2: See Appendix B2

Remarks

None

EZ Version

RPG Procedure

EZ_ADJJCODEEX

RPG Copy

EZADJJCDEX

Description

EZTaxAdjJCodeJEx accepts transaction data and performs appropriate tax calculations required to refund or credit taxes (Debit cards use EZTaxAdjDebitJEx). If the AFC session was started with the tax log open, appropriate tax reductions are logged and will be reflected in tax reports. BTN, origination and termination information is passed using JCodes.

Format

EZ_ADJJCODEEX (pHandle: pBTN_JCode: pOrig_JCode: pTerm_JCode: (Generic transaction data): (Generic returned tax info): pError: pDiscount: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType: pAdjMethod);

Return Value

pTaxCount (10I 0)

Parameters

pHandle (10I 0)

pBTN_JCode (10U 0)

pOrig_JCode (10U 0)

pTerm_JCode (10U 0)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0)

pDiscount (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

pAdjMethod (10I 0)

Remarks

None

E9 Version

RPG Procedure

E9_ADJJCODEEX

RPG Copy

E9ADJJCDEX

Description

ETaxAdjJCodeJEx accepts transaction data and performs appropriate tax calculations required to refund or credit taxes (Debit cards use EZTaxAdjDebitJEx). If the AFC session was started with the tax log open, appropriate tax reductions are logged and will be reflected in tax reports. BTN, origination and termination information is passed using JCodes.

Format

E9_ADJJCODEEX (pSessionPtr: pBTN_JCode: pOrig_JCode: pTerm_JCode: (Generic transaction data Appendix A): (Generic returned tax info Appendix B): pError: pDiscount: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType: pAdjMethod): (Generic transaction data, Appendix A2): (Generic returned tax info, Appendix B2)

Return Value

pTaxCount (10I 0)

Parameters

pSessionPtr (*)

pBTN_JCode (10U 0)

pOrig_JCode (10U 0)

pTerm_JCode (10U 0)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0)

pDiscount (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

pAdjMethod (10I 0)

Generic transaction data 2: See Appendix A2

Generic returned tax info 2: See Appendix B2

Remarks

None

EZ Version

RPG Procedure

EZ_ADJ_NPAN_EX

RPG Copy

EZADJNPNEX

Description

EZTaxAdjNPANJEx accepts transaction data and performs appropriate tax calculations required to refund or credit taxes (for Debit cards use EZTaxAdjDebitNEx). If the AFC session was started with the tax log open, appropriate tax reductions are logged and will be reflected in tax reports. BTN, origination and termination information is passed using NPANXXs.

Format

EZ_ADJ_NPAN_EX (pHandle: pBTN_NPAN: pOrig_NPAN: pTerm_NPAN: (Generic transaction data): (Generic returned tax info): pError: pDiscount: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType: pAdjMethod);

Return Value

pTaxCount (10I 0)

Parameters

pHandle (10I 0)

pBTN_NPAN (10I 0)

pOrig_NPAN (10I 0)

pTerm_NPAN (10I 0)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0)

pDiscount (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

pAdjMethod (10I 0)

Remarks

None

E9 Version

RPG Procedure

E9_ADJ_NPAN_EX

RPG Copy

E9ADJNPNEX

Description

EZTaxAdjNPANJEx accepts transaction data and performs appropriate tax calculations required to refund or credit taxes (for Debit cards use EZTaxAdjDebitNEx). If the AFC session was started with the tax log open, appropriate tax reductions are logged and will be reflected in tax reports. BTN, origination and termination information is passed using NPANXXs.

Format

E9_ADJ_NPAN_EX (pSessionPtr: pBTN_NPAN: pOrig_NPAN: pTerm_NPAN: (Generic transaction data Appendix A): (Generic returned tax info Appendix B): pError: pDiscount: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType: pAdjMethod); (Generic transaction data, Appendix A2): (Generic returned tax info, Appendix B2)

Return Value

pTaxCount (10I 0) 

Parameters

pSessionPtr (*) 

pBTN_NPAN (10I 0) 

pOrig_NPAN (10I 0) 

pTerm_NPAN (10I 0) 

 

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0)

pDiscount (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

pAdjMethod (10I 0)

Generic transaction data 2: See Appendix A2

Generic returned tax info 2: See Appendix B2

Remarks

None

EZ9 Version

RPG Procedure

EZ_ADJPCODEEX

RPG Copy

EZADJPCDEX

Description

EZTaxAdjPCodeEx accepts transaction data and performs appropriate tax calculations required to refund or credit taxes (for Debit cards use EZTaxAdjDebitPEx). If the AFC session was started with the tax log open, appropriate tax reductions are logged and will be reflected in tax reports. BTN, origination and termination information is passed using PCodes.

Format

EZ_ADJPCODEEX (pHandle: pBTN_PCode: pOrig_PCode: pTerm_PCode: (Generic transaction data): (Generic returned tax info): pError: pDiscount: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType: pAdjMethod);

Return Value

pTaxCount (10I 0)

Parameters

pHandle (10I 0)

pBTN_PCode (10U 0)

pOrig_PCode (10U 0)

pTerm_PCode (10U 0)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0)

pDiscount (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

pAdjMethod (10I 0)

Remarks

None

E9 Version

RPG Procedure

E9_ADJPCODEEX

RPG Copy

E9ADJPCDEX

Description

EZTaxAdjPCodeEx accepts transaction data and performs appropriate tax calculations required to refund or credit taxes (for Debit cards use EZTaxAdjDebitPEx). If the AFC session was started with the tax log open, appropriate tax reductions are logged and will be reflected in tax reports. BTN, origination and termination information is passed using PCodes.

Format

E9_ADJPCODEEX (pSessionPtr: pBTN_PCode: pOrig_PCode: pTerm_PCode: (Generic transaction data Appendix A): (Generic returned tax info Appendix B): pError: pDiscount: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType: pAdjMethod); (Generic transaction data, Appendix A2): (Generic returned tax info, Appendix B2)

Return Value

pTaxCount (10I 0) 

Parameters

pSessionPtr (*) 

pBTN_PCode (10U 0) 

pOrig_PCode (10U 0) 

pTerm_PCode (10U 0) 

 

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0)

pDiscount (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

pAdjMethod (10I 0)

Generic transaction data 2: See Appendix A2

Generic returned tax info 2: See Appendix B2

Remarks

None

EZ Version

RPG Procedure

E9_ADJ_PRO_JV2

RPG Copy

EZADPRJCDX.RPGLE

Description

EZTaxAdjProRateJCode takes a J_CodeEx struct as input and calculates tax adjustments for the transaction. It pro-rates the taxes calculated by the given percentage, for partial-month rates.

Format

EZ_ADJ_PRO_JCODE (pHandle: pBTN_JCode: pOrig_JCode: pTerm_JCode: (Generic transaction data): (Generic returned tax info) :pPercent: pDiscount: pError: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType: pAdjMethod); :pAdjMethod: credit_cancel (10I 0)

Return Value

pTaxCount (10I 0)

0 : Indicates no tax data available for transaction (not taxable) or an error has occurred.

n : Indicates number of taxes stored in the struct enhanced_taxes_tbl array for this transaction

Parameters

pHandle (10I 0) 

pBTN_JCode (10U 0) 

pOrig_JCode (10U 0) 

pTerm_JCode (10U 0) 

 

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pPercent (10I 0)

pDiscount (10I 0)

pError (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

pAdjMethod (10I 0)

credit_cancel (10I 0)

Remarks

When assigning the percent field, 50% would be entered as 0.5.

E9 Version

RPG Procedure

E9_ADJ_PRO_JCODE

RPG Copy

E9ADPRJCD2.RPGLE

Description

EZTaxAdjProRateJCode takes a J_CodeEx struct as input and calculates tax adjustments for the transaction. It pro-rates the taxes calculated by the given percentage, for partial-month rates.

Format

E9_ADJ_PRO_JCODE (pSessionPtr: pBTN_JCode: pOrig_JCode: pTerm_JCode: (Generic transaction data Appendix A): (Generic returned tax info Appendix B) :pPercent: pDiscount: pError: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType: pAdjMethod); (Generic transaction data, Appendix A2): (Generic returned tax info, Appendix B2):pAdjMethod: credit_cancel (10I 0)

Return Value

pTaxCount (10I 0)

0 : Indicates no tax data available for transaction (not taxable) or an error has occurred.

n : Indicates number of taxes stored in the struct enhanced_taxes_tbl array for this transaction

Parameters

pSessionPtr (*) 

pBTN_JCode (10U 0) 

pOrig_JCode (10U 0) 

pTerm_JCode (10U 0) 

 

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pPercent (10I 0)

pDiscount (10I 0)

pError (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

pAdjMethod (10I 0)

credit_cancel (10I 0)

Generic transaction data 2: See Appendix A2

Generic returned tax info 2: See Appendix B2

Remarks

When assigning the percent field, 50% would be entered as 0.5.

EZ Version

RPG Procedure

E9_ADJ_PRO_NV2

RPG Copy

EZADPRNPNX.RPGLE

Description

EZTaxAdjProRateNPAN takes an NPANXX_codeEx struct as input and calculates tax adjustments for the transaction. It pro-rates the taxes calculated by the given percentage, for partial-month rates.

Format

EZ_ADJ_PRO_NPAN (pHandle: pBTN_NPAN: pOrig_NPAN: pTerm_NPAN: (Generic transaction data): (Generic returned tax info) :pPercent: pDiscount: pError: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType: pAdjMethod); :pAdjMethod: credit_cancel (10I 0)

Return Value

pTaxCount (10I 0)

0 : Indicates no tax data available for transaction (not taxable) or an error has occurred.

n : Indicates number of taxes stored in the struct enhanced_taxes_tbl array for this transaction

Parameters

pHandle (10I 0) 

pBTN_NPAN (10U 0) 

pOrig_NPAN (10U 0) 

pTerm_NPAN (10U 0) 

 

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pPercent (10I 0)

pDiscount (10I 0)

pError (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

pAdjMethod (10I 0)

credit_cancel (10I 0)

Remarks

When assigning the percent field, 50% would be entered as 0.5.

E9 Version

RPG Procedure

E9_ADJ_PRO_NPAN

RPG Copy

E9ADPRNPN2.RPGLE

Description

EZTaxAdjProRateNPAN takes an NPANXX_codeEx struct as input and calculates tax adjustments for the transaction. It pro-rates the taxes calculated by the given percentage, for partial-month rates.

Format

E9_ADJ_PRO_NPAN (pSessionPtr: pBTN_NPAN: pOrig_NPAN: pTerm_NPAN: (Generic transaction data Appendix A): (Generic returned tax info Appendix B) :pPercent: pDiscount: pError: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType: pAdjMethod); (Generic transaction data, Appendix A2): (Generic returned tax info, Appendix B2):pAdjMethod: credit_cancel (10I 0)

Return Value

pTaxCount (10I 0)

0 : Indicates no tax data available for transaction (not taxable) or an error has occurred.

n : Indicates number of taxes stored in the struct enhanced_taxes_tbl array for this transaction

Parameters

pSessionPtr (*) 

pBTN_NPAN (10U 0) 

pOrig_NPAN (10U 0) 

pTerm_NPAN (10U 0) 

 

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pPercent (10I 0)

pDiscount (10I 0)

pError (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

pAdjMethod (10I 0)

credit_cancel (10I 0)

Generic transaction data 2: See Appendix A2

Generic returned tax info 2: See Appendix B2

Remarks

When assigning the percent field, 50% would be entered as 0.5.

EZ Version

RPG Procedure

E9_ADJ_PRO_PV2

RPG Copy

EZADPRPCDX.RPGLE

Description

EZTaxAdjProRatePCode takes a P_CodeEx struct as input and calculates tax adjustments for the transaction. It pro-rates the taxes calculated by the given percentage, for partial-month rates.

Format

EZ_ADJ_PRO_PCODE (pHandle: pBTN_PCode: pOrig_PCode: pTerm_PCode: (Generic transaction data): (Generic returned tax info):pPercent: pDiscount: pError: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType: pAdjMethod); :pAdjMethod: credit_cancel (10I 0)

Return Value

pTaxCount (10I 0)

0 : Indicates no tax data available for transaction (not taxable) or an error has occurred.

n : Indicates number of taxes stored in the struct enhanced_taxes_tbl array for this transaction

Parameters

pHandle (10I 0) 

pBTN_PCode (10U 0) 

pOrig_PCode (10U 0) 

pTerm_PCode (10U 0) 

 

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pPercent (10I 0)

pDiscount (10I 0)

pError (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

pAdjMethod (10I 0)

credit_cancel (10I 0)

Remarks

When assigning the percent field, 50% would be entered as 0.5.

E9 Version

RPG Procedure

E9_ADJ_PRO_PCODE

RPG Copy

E9ADPRPCD2.RPGLE

Description

EZTaxAdjProRatePCode takes a P_CodeEx struct as input and calculates tax adjustments for the transaction. It pro-rates the taxes calculated by the given percentage, for partial-month rates.

Format

E9_ADJ_PRO_PCODE (pSessionPtr: pBTN_PCode: pOrig_PCode: pTerm_PCode: (Generic transaction data Appendix A): (Generic returned tax info Appendix B) :pPercent: pDiscount: pError: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType: pAdjMethod); (Generic transaction data, Appendix A2): (Generic returned tax info, Appendix B2):pAdjMethod: credit_cancel (10I 0)

Return Value

pTaxCount (10I 0)

0 : Indicates no tax data available for transaction (not taxable) or an error has occurred.

n : Indicates number of taxes stored in the struct enhanced_taxes_tbl array for this transaction

Parameters

pSessionPtr (*) 

pBTN_PCode (10U 0) 

pOrig_PCode (10U 0) 

pTerm_PCode (10U 0) 

 

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pPercent (10I 0)

pDiscount (10I 0)

pError (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

pAdjMethod (10I 0)

credit_cancel (10I 0)

Generic transaction data 2: See Appendix A2

Generic returned tax info 2: See Appendix B2

Remarks

When assigning the percent field, 50% would be entered as 0.5.

EZ Version

RPG Procedure

E9ADJTHSPROJV2

RPG Copy

EZADPRTHSJ.RPGLE

Description

EZTaxAdjProRateThisJCode takes a J-Code and fills all three JCodes into the struct as input and calculates tax adjustments for the transaction. It pro-rates the taxes calculated by the given percentage, for partial-month rates.

Format

EZ_ADJ_PRO_THIS_JCODE (pHandle: pTHS_JCode: (Generic transaction data Appenix A): (Generic returned tax info) :pPercent: pDiscount: pError: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType: pAdjMethod); :pAdjMethod: credit_cancel (10I 0)

Return Value

pTaxCount (10I 0)

0 : Indicates no tax data available for transaction (not taxable) or an error has occurred.

n : Indicates number of taxes stored in the struct enhanced_taxes_tbl array for this transaction

Parameters

pHandle (10I 0)

pTHS_JCode (10U 0)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pPercent (10I 0)

pDiscount (10I 0)

pError (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

pAdjMethod (10I 0)

credit_cancel (10I 0)

Remarks

When assigning the percent field, 50% would be entered as 0.5.

E9 Version

RPG Procedure

E9_ADJ_PRO_THIS_JCODE

RPG Copy

E9ADPRTHJ2.RPGLE

Description

EZTaxAdjProRateThisJCode takes a J-Code and fills all three JCodes into the struct as input and calculates tax adjustments for the transaction. It pro-rates the taxes calculated by the given percentage, for partial-month rates.

Format

E9_ADJ_PRO_THIS_JCODE (pSessionPtr: pTHS_JCode: (Generic transaction data Appendix A): (Generic returned tax info Appendix B):pPercent: pDiscount: pError: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType: pAdjMethod); :pAdjMethod: credit_cancel (10I 0)

Return Value

pTaxCount (10I 0)

0 : Indicates no tax data available for transaction (not taxable) or an error has occurred.

n : Indicates number of taxes stored in the struct enhanced_taxes_tbl array for this transaction

Parameters

pSessionPtr (*)

pTHS_JCode (10U 0)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pPercent (10I 0)

pDiscount (10I 0)

pError (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

pAdjMethod (10I 0)

credit_cancel (10I 0)

Generic transaction data 2: See Appendix A2

Generic returned tax info 2: See Appendix B2

Remarks

When assigning the percent field, 50% would be entered as 0.5.

EZ Version

RPG Procedure

E9ADJTHSPROPV2

RPG Copy

EZADPRTHSP.RPGLE

Description

EZTaxAdjProRateThisPCode takes a P-Code and fills all three PCodes into the struct as input and calculates tax adjustments for the transaction. It pro-rates the taxes calculated by the given percentage, for partial-month rates.

Format

EZ_ADJ_PRO_THIS_PCODE (pHandle: pTHS_PCode: (Generic transaction data): (Generic returned tax info) :pPercent: pDiscount: pError: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType: pAdjMethod); :pAdjMethod: credit_cancel (10I 0)

Return Value

pTaxCount (10I 0)

0 : Indicates no tax data available for transaction (not taxable) or an error has occurred.

n : Indicates number of taxes stored in the struct enhanced_taxes_tbl array for this transaction

Parameters

pHandle (10I 0) pTHS_PJCode (10U 0)

Generic transaction data: See Appendix A Generic returned tax info: See Appendix B pPercent (10I 0)

pDiscount (10I 0)

pError (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

pAdjMethod (10I 0)

credit_cancel (10I 0)

Remarks

When assigning the percent field, 50% would be entered as 0.5.

E9 Version

RPG Procedure

E9_ADJ_PRO_THIS_PCODE

RPG Copy

E9ADPRTHP2.RPGLE

Description

EZTaxAdjProRateThisPCode takes a P-Code and fills all three PCodes into the struct as input and calculates tax adjustments for the transaction. It pro-rates the taxes calculated by the given percentage, for partial-month rates.

Format

E9_ADJ_PRO_THIS_PCODE (pSessionPtr: pTHS_PCode: (Generic transaction data Appendix A): (Generic returned tax info Appendix B):pPercent: pDiscount: pError: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType: pAdjMethod); (Generic transaction data, Appendix A2): (Generic returned tax info, Appendix B2):pAdjMethod: credit_cancel (10I 0)

Return Value

pTaxCount (10I 0)

0 : Indicates no tax data available for transaction (not taxable) or an error has occurred.

n : Indicates number of taxes stored in the struct enhanced_taxes_tbl array for this transaction

Parameters

pSessionPtr (*)

pTHS_PCode (10U 0)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pPercent (10I 0)

pDiscount (10I 0)

pError (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

pAdjMethod (10I 0)

credit_cancel (10I 0)

Generic transaction data 2: See Appendix A2

Generic returned tax info 2: See Appendix B2

Remarks

When assigning the percent field, 50% would be entered as 0.5.

EZ Version

RPG Procedure

E9_ADJ_PRO_ZV2

RPG Copy

EZADPRZIPX.RPGLE

Description

EZTaxAdjProRateZip takes the appropriate zip code, state identifier, county, and locality (ZIP struct) as input and calculates tax adjustments for the transaction. AFC uses this information to determine the JCode used for tax calculations. It pro-rates the taxes calculated by the given percentage, for partial-month rates.

Format

EZ_ADJ_PRO_ZIP_EX (pHandle: pZipCode: pZipP4: pCountry: pState: pCounty: pLocality: (Generic transaction data): (Generic returned tax info) :pPercent: pDiscount: pError: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType: pAdjMethod); :pAdjMethod: credit_cancel (10I 0)

Return Value

pTaxCount (10I 0)

0 : Indicates no tax data available for transaction (not taxable) or an error has occurred.

n : Indicates number of taxes stored in the struct enhanced_taxes_tbl array for this transaction

Parameters

pHandle (10I 0) 

pZipCode (6A) 

pZipPlus4 (5A) 

pCountry (4A) 

pState (3A) 

pCounty (26A) 

pLocality (26A) 

 

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pPercent (10I 0)

pDiscount (10I 0)

pError (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

pAdjMethod (10I 0)

credit_cancel (10I 0)

Remarks

When assigning the percent field, 50% would be entered as 0.5.

E9 Version

RPG Procedure

E9_ADJ_PRO_ZIP

RPG Copy

E9ADPRZIP2.RPGLE

Description

EZTaxAdjProRateZip takes the appropriate zip code, state identifier, county, and locality (ZIP struct) as input and calculates tax adjustments for the transaction. AFC uses this information to determine the JCode used for tax calculations. It pro-rates the taxes calculated by the given percentage, for partial-month rates.

Format

E9_ADJ_PRO_ZIP (pSessionPtr: pZipCode: pZipP4: pCountry: pState: pCounty: pLocality: (Generic transaction data Appendix A): (Generic returned tax info Appendix B) :pPercent: pDiscount: pError: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType: pAdjMethod); (Generic transaction data, Appendix A2): (Generic returned tax info, Appendix B2) :pAdjMethod: credit_cancel (10I 0)

Return Value

pTaxCount (10I 0)

0 : Indicates no tax data available for transaction (not taxable) or an error has occurred.

n : Indicates number of taxes stored in the struct enhanced_taxes_tbl array for this transaction

Parameters

pSessionPtr (*) 

pZipCode (6A) 

pZipPlus4 (5A) 

pCountry (4A) 

pState (3A) 

pCounty (26A) 

pLocality (26A) 

 

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pPercent (10I 0)

pDiscount (10I 0)

pError (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

pAdjMethod (10I 0)

credit_cancel (10I 0)

Generic transaction data 2: See Appendix A2

Generic returned tax info 2: See Appendix B2

Remarks

When assigning the percent field, 50% would be entered as 0.5.

EZ Version

RPG Procedure

EZ_ADJREVJCODE

RPG Copy

EZADRVJCD

Description

EZTaxAdjRevJCode accepts transaction data with the gross amount adjustment given to the customer in the charge amount and performs a tax inclusive calculation to arrive at the base sales amount. The desired total (charge plus all taxes) is placed in the ‘charge’ field in the transaction, and base charge necessary to generate that total is returned in the ‘base_sale’ parameter. Taxes for the desired transaction are returned in the same manner as EZTaxJCodeEx does. If the AFC session was started with the tax log open, tax calculations are logged and will be reflected in tax reports. BTN, origination and termination information is passed using JCodes.

Format

EZ_ADJREVJCODE (pHandle: pBTN_JCode: pOrig_JCode: pTerm_JCode: (Generic transaction data): (Generic returned tax info): pError: pDiscount: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType: pAdjMethod: pBaseSale);

Return Value

pTaxCount (10I 0)

Parameters

pHandle (10I 0)

pBTN_JCode (10U 0)

pOrig_JCode (10U 0)

pTerm_JCode (10U 0)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0)

pDiscount (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

pAdjMethod (10I 0)

pBaseSale (12P 6)

Remarks

None

E9 Version

RPG Procedure

E9_ADJREVJCODE

RPG Copy

E9ADRVJCD

Description

EZTaxAdjRevJCode accepts transaction data with the gross amount adjustment given to the customer in the charge amount and performs a tax inclusive calculation to arrive at the base sales amount. The desired total (charge plus all taxes) is placed in the ‘charge’ field in the transaction, and base charge necessary to generate that total is returned in the ‘base_sale’ parameter. Taxes for the desired transaction are returned in the same manner as EZTaxJCodeEx does. If the AFC session was started with the tax log open, tax calculations are logged and will be reflected in tax reports. BTN, origination and termination information is passed using JCodes.

Note: Tax inclusive calculations only handle charges up to $10M.

Format

E9_ADJREVJCODE (pSessionPtr: pBTN_JCode: pOrig_JCode: pTerm_JCode: (Generic transaction data Appendix A): (Generic returned tax info Appendix B): pError: pDiscount: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType: pAdjMethod: pBaseSale); (Generic transaction data, Appendix A2): (Generic returned tax info, Appendix B2)

Return Value

pTaxCount (10I 0)

Parameters

pSessionPtr (*) pBTN_JCode (10U 0)

pOrig_JCode (10U 0)

pTerm_JCode (10U 0)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0)

pDiscount (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

pAdjMethod (10I 0)

pBaseSale (12P 6)

Generic transaction data 2: See Appendix A2

Generic returned tax info 2: See Appendix B2

Remarks

None

EZ Version

RPG Procedure

EZ_ADJREVNPAN

RPG Copy

EZADRVNPN

Description

EZTaxAdjRevNPAN accepts transaction data with the gross amount adjustment given to the customer in the charge amount and performs a tax inclusive calculation to arrive at the base sales amount. The desired total (charge plus all taxes) is placed in the ‘charge’ field in the transaction, and base charge necessary to generate that total is returned in the ‘base_sale’ parameter. Taxes for the desired transaction are returned in the same manner as EZTaxNPANEx does. If the AFC session was started with the tax log open, tax calculations are logged and will be reflected in tax reports. BTN, origination and termination information is passed using NPANs.

Format

EZ_ADJREVNPAN (pHandle: pBTN_NPAN: pOrig_NPAN: pTerm_NPAN: (Generic transaction data): (Generic returned tax info): pError: pDiscount: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType: pAdjMethod: pBaseSale);

Return Value

pTaxCount (10I 0)

Parameters

pHandle (10I 0)

pBTN_NPAN (10U 0)

pOrig_NPAN (10U 0)

pTerm_NPAN (10U 0)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0)

pDiscount (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

pAdjMethod (10I 0)

pBaseSale (12P 6)

Remarks

None

E9 Version

RPG Procedure

E9_ADJREVNPAN

RPG Copy

E9ADRVNPN

Description

EZTaxAdjRevNPAN accepts transaction data with the gross amount adjustment given to the customer in the charge amount and performs a tax inclusive calculation to arrive at the base sales amount. The desired total (charge plus all taxes) is placed in the ‘charge’ field in the transaction, and base charge necessary to generate that total is returned in the ‘base_sale’ parameter. Taxes for the desired transaction are returned in the same manner as EZTaxNPANEx does. If the AFC session was started with the tax log open, tax calculations are logged and will be reflected in tax reports. BTN, origination and termination information is passed using NPANs.

Note: Tax inclusive calculations only handle charges up to $10M.

Format

E9_ADJREVNPAN (pSessionPtr: pBTN_NPAN: pOrig_NPAN: pTerm_NPAN: (Generic transaction data Appendix A): (Generic returned tax info Appendix B): pError: pDiscount: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType: pAdjMethod: pBaseSale); (Generic transaction data, Appendix A2): (Generic returned tax info, Appendix B2)

Return Value

pTaxCount (10I 0) 

Parameters

pSessionPtr (*) 

pBTN_NPAN (10U 0) 

pOrig_NPAN (10U 0) 

pTerm_NPAN (10U 0) 

 

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0)

pDiscount (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

pAdjMethod (10I 0)

pBaseSale (12P 6)

Generic transaction data 2: See Appendix A2

Generic returned tax info 2: See Appendix B2

Remarks

None

EZ Version

RPG Procedure

EZ_ADJREVPCODE

RPG Copy

EZADRVPCD

Description

EZTaxAdjRevPCode accepts transaction data with the gross amount adjustment given to the customer in the charge amount and performs a tax inclusive calculation to arrive at the base sales amount. The desired total (charge plus all taxes) is placed in the ‘charge’ field in the transaction, and base charge necessary to generate that total is returned in the ‘base_sale’ parameter. Taxes for the desired transaction are returned in the same manner as EZTaxPCodeEx does. If the AFC session was started with the tax log open, tax calculations are logged and will be reflected in tax reports. BTN, origination and termination information is passed using PCodes.

Format

EZ_ADJREVPCODE (pHandle: pBTN_PCode: pOrig_PCode: pTerm_PCode: (Generic transaction data): (Generic returned tax info): pError: pDiscount: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType: pAdjMethod: pBaseSale);

Return Value

pTaxCount (10I 0)

Parameters

pHandle (10I 0)

pBTN_PCode (10U 0)

pOrig_PCode (10U 0)

pTerm_PCode (10U 0)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

 

 

pError (10I 0)

pDiscount (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

pAdjMethod (10I 0)

pBaseSale (12P 6)

Remarks

None

E9 Version

RPG Procedure

E9_ADJREVPCODE

RPG Copy

E9ADRVPCD

Description

EZTaxAdjRevPCode accepts transaction data with the gross amount adjustment given to the customer in the charge amount and performs a tax inclusive calculation to arrive at the base sales amount. The desired total (charge plus all taxes) is placed in the ‘charge’ field in the transaction, and base charge necessary to generate that total is returned in the ‘base_sale’ parameter. Taxes for the desired transaction are returned in the same manner as EZTaxPCodeEx does. If the AFC session was started with the tax log open, tax calculations are logged and will be reflected in tax reports. BTN, origination and termination information is passed using PCodes.

Note: Tax inclusive calculations only handle charges up to $10M.

Format

E9_ADJREVPCODE (pSessionPtr: pBTN_PCode: pOrig_PCode: pTerm_PCode: (Generic transaction data Appendix A): (Generic returned tax info Appendix B): pError: pDiscount: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType: pAdjMethod: pBaseSale);(Generic transaction data, Appendix A2): (Generic returned tax info, Appendix B2)

Return Value

pTaxCount (10I 0)

Parameters

pSessionPtr (*)

pBTN_PCode (10U 0)

pOrig_PCode (10U 0)

pTerm_PCode (10U 0)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0)

pDiscount (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

pAdjMethod (10I 0)

pBaseSale (12P 6)

Generic transaction data 2: See Appendix A2

Generic returned tax info 2: See Appendix B2

Remarks

None

EZ Version

RPG Procedure

EZ_ADJREVZIP

RPG Copy

EZADRVZIP

Description

EZTaxAdjRevZip accepts transaction data with the gross amount adjustment given to the customer in the charge amount and performs a tax inclusive calculation to arrive at the base sales amount. The desired total (charge plus all taxes) is placed in the ‘charge’ field in the transaction, and base charge necessary to generate that total is returned in the ‘base_sale’ parameter. Taxes for the desired transaction are returned in the same manner as EZTaxZipEx does. If the AFC session was started with the tax log open, tax calculations are logged and will be reflected in tax reports. BTN, origination and termination information is passed using Zips.

Format

EZ_ADJREVZIP (pHandle: pZip: pZipP4: pCountry: pState: pCounty: pLocality: (Generic transaction data): (Generic returned tax info): pError: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType: pBaseSale);

Return Value

pTaxCount (10I 0)

Parameters

pHandle (10I 0)

pZip (6A)

pZipP4 (5A)

pCountry (4A)

pState (3A)

pCounty (26A)

pLocality (26A)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

pBaseSale (12P 6)

Remarks

None

E9 Version

RPG Procedure

E9_ADJREVZIP

RPG Copy

E9ADRVZIP

Description

EZTaxAdjRevZip accepts transaction data with the gross amount adjustment given to the customer in the charge amount and performs a tax inclusive calculation to arrive at the base sales amount. The desired total (charge plus all taxes) is placed in the ‘charge’ field in the transaction, and base charge necessary to generate that total is returned in the ‘base_sale’ parameter. Taxes for the desired transaction are returned in the same manner as EZTaxZipEx does. If the AFC session was started with the tax log open, tax calculations are logged and will be reflected in tax reports. BTN, origination and termination information is passed using Zips.

Note: Tax inclusive calculations only handle charges up to $10M.

Format

E9_ADJREVZIP (pSessionPtr: pZip: pZipP4: pCountry: pState: pCounty: pLocality: (Generic transaction data Appendix A): (Generic returned tax info Appendix B): pError: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType: pBaseSale); (Generic transaction data, Appendix A2): (Generic returned tax info, Appendix B2)

Return Value

pTaxCount (10I 0)

Parameters

pSessionPtr (*)

pZip (6A)

pZipP4 (5A)

pCountry (4A)

pState (3A)

pCounty (26A)

pLocality (26A)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

pBaseSale (12P 6)

Generic transaction data 2: See Appendix A2

Generic returned tax info 2: See Appendix B2

Remarks

None

EZ Version

RPG Procedure

EZ_ADJTXIJCODE

RPG Copy

EZADTIJCD

Description

EZTaxAdjTxiJCode accepts transaction data with the gross amount adjustment given to the customer in the charge amount and performs a tax inclusive calculation to arrive at the base sales amount. The desired total (charge plus all taxes) is placed in the ‘charge’ field in the transaction, and base charge necessary to generate that total is returned in the ‘base_sale’ parameter. Taxes for the desired transaction are returned in the same manner as EZTaxJCodeEx does. If the AFC session was started with the tax log open, tax calculations are logged and will be reflected in tax reports. BTN, origination and termination information is passed using JCodes.

Format

EZ_ADJTXIJCODE (pHandle: pBTN_JCode: pOrig_JCode: pTerm_JCode: (Generic transaction data): (Generic returned tax info): pError: pDiscount: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType: pAdjMethod: pBaseSale);

Return Value

pTaxCount (10I 0)

Parameters

pHandle (10I 0)

pBTN_JCode (10U 0)

pOrig_JCode (10U 0)

pTerm_JCode (10U 0)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0)

pDiscount (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

pAdjMethod (10I 0)

pBaseSale (12P 6)

Remarks

None

E9 Version

RPG Procedure

E9_ADJTXIJCODE

RPG Copy

E9ADTIJCD

Description

EZTaxAdjTxiJCode accepts transaction data with the gross amount adjustment given to the customer in the charge amount and performs a tax inclusive calculation to arrive at the base sales amount. The desired total (charge plus all taxes) is placed in the ‘charge’ field in the transaction, and base charge necessary to generate that total is returned in the ‘base_sale’ parameter. Taxes for the desired transaction are returned in the same manner as EZTaxJCodeEx does. If the AFC session was started with the tax log open, tax calculations are logged and will be reflected in tax reports. BTN, origination and termination information is passed using JCodes.

Note: Tax inclusive calculations only handle charges up to $10M.

Format

E9_ADJTXIJCODE (pSessionPtr: pBTN_JCode: pOrig_JCode: pTerm_JCode: (Generic transaction data Appendix A): (Generic returned tax info Appendix B): pError: pDiscount: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType: pAdjMethod: pBaseSale); (Generic transaction data, Appendix A2): (Generic returned tax info, Appendix B2)

Return Value

pTaxCount (10I 0)

Parameters

pSessionPtr (*)

pBTN_JCode (10U 0)

pOrig_JCode (10U 0)

pTerm_JCode (10U 0)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0)

pDiscount (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

pAdjMethod (10I 0)

pBaseSale (12P 6)

Generic transaction data 2: See Appendix A2

Generic returned tax info 2: See Appendix B2

Remarks

None

EZ Version

RPG Procedure

EZ_ADJTXINPAN

RPG Copy

EZADTINPN

Description

EZTaxAdjTxiNPAN accepts transaction data with the gross amount adjustment given to the customer in the charge amount and performs a tax inclusive calculation to arrive at the base sales amount. The desired total (charge plus all taxes) is placed in the ‘charge’ field in the transaction, and base charge necessary to generate that total is returned in the ‘base_sale’ parameter. Taxes for the desired transaction are returned in the same manner as EZTaxNPANEx does. If the AFC session was started with the tax log open, tax calculations are logged and will be reflected in tax reports. BTN, origination and termination information is passed using NPANs.

Format

EZ_ADJTXINPAN (pHandle: pBTN_NPAN: pOrig_NPAN: pTerm_NPAN: (Generic transaction data): (Generic returned tax info): pError: pDiscount: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType: pAdjMethod: pBaseSale);

Return Value

pTaxCount (10I 0)

Parameters

pHandle (10I 0)

pBTN_NPAN (10U 0)

pOrig_NPAN (10U 0)

pTerm_NPAN (10U 0)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0)

pDiscount (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

pAdjMethod (10I 0)

pBaseSale (12P 6)

Remarks

None

E9 Version

RPG Procedure

E9_ADJTXINPAN

RPG Copy

E9ADTINPN

Description

EZTaxAdjTxiNPAN accepts transaction data with the gross amount adjustment given to the customer in the charge amount and performs a tax inclusive calculation to arrive at the base sales amount. The desired total (charge plus all taxes) is placed in the ‘charge’ field in the transaction, and base charge necessary to generate that total is returned in the ‘base_sale’ parameter. Taxes for the desired transaction are returned in the same manner as EZTaxNPANEx does. If the AFC session was started with the tax log open, tax calculations are logged and will be reflected in tax reports. BTN, origination and termination information is passed using NPANs.

Note: Tax inclusive calculations only handle charges up to $10M.

Format

E9_ADJTXINPAN (pSessionPtr: pBTN_NPAN: pOrig_NPAN: pTerm_NPAN: (Generic transaction data Appendix A): (Generic returned tax info Appendix B): pError: pDiscount: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType: pAdjMethod: pBaseSale); (Generic transaction data, Appendix A2): (Generic returned tax info, Appendix B2)

Return Value

pTaxCount (10I 0) 

Parameters

pSessionPtr (*) 

pBTN_NPAN (10U 0) 

pOrig_NPAN (10U 0) 

pTerm_NPAN (10U 0) 

 

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0)

pDiscount (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

pAdjMethod (10I 0)

pBaseSale (12P 6)

Generic transaction data 2: See Appendix A2

Generic returned tax info 2: See Appendix B2

Remarks

None

EZ Version

RPG Procedure

EZ_ADJTXIPCODE

RPG Copy

EZADTIPCD

Description

EZTaxAdjTxiPCode accepts transaction data with the gross amount adjustment given to the customer in the charge amount and performs a tax inclusive calculation to arrive at the base sales amount. The desired total (charge plus all taxes) is placed in the ‘charge’ field in the transaction, and base charge necessary to generate that total is returned in the ‘base_sale’ parameter. Taxes for the desired transaction are returned in the same manner as EZTaxPCodeEx does. If the AFC session was started with the tax log open, tax calculations are logged and will be reflected in tax reports. BTN, origination and termination information is passed using PCodes.

Format

EZ_ADJTXIPCODE (pHandle: pBTN_PCode: pOrig_PCode: pTerm_PCode: (Generic transaction data): (Generic returned tax info): pError: pDiscount: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType: pAdjMethod: pBaseSale);

Return Value

pTaxCount (10I 0)

Parameters

pHandle (10I 0)

pBTN_PCode (10U 0)

pOrig_PCode (10U 0)

pTerm_PCode (10U 0)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0)

pDiscount (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

pAdjMethod (10I 0)

pBaseSale (12P 6)

Remarks

None

E9 Version

RPG Procedure

E9_ADJTXIPCODE

RPG Copy

E9ADTIPCD

Description

EZTaxAdjTxiPCode accepts transaction data with the gross amount adjustment given to the customer in the charge amount and performs a tax inclusive calculation to arrive at the base sales amount. The desired total (charge plus all taxes) is placed in the ‘charge’ field in the transaction, and base charge necessary to generate that total is returned in the ‘base_sale’ parameter. Taxes for the desired transaction are returned in the same manner as EZTaxPCodeEx does. If the AFC session was started with the tax log open, tax calculations are logged and will be reflected in tax reports. BTN, origination and termination information is passed using PCodes.

Note: Tax inclusive calculations only handle charges up to $10M.

Format

E9_ADJTXIPCODE (pSessionPtr: pBTN_PCode: pOrig_PCode: pTerm_PCode: (Generic transaction data Appendix A): (Generic returned tax info Appendix B): pError: pDiscount: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType: pAdjMethod: pBaseSale);(Generic transaction data, Appendix A2): (Generic returned tax info, Appendix B2)

Return Value

pTaxCount (10I 0)

Parameters

pSessionPtr (*)

pBTN_PCode (10U 0)

pOrig_PCode (10U 0)

pTerm_PCode (10U 0)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0)

pDiscount (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

pAdjMethod (10I 0)

pBaseSale (12P 6)

Generic transaction data 2: See Appendix A2

Generic returned tax info 2: See Appendix B2

Remarks

None

EZ Version

RPG Procedure

EZ_ADJTXIZIP

RPG Copy

EZADTIZIP

Description

EZTaxAdjTxiZip accepts transaction data with the gross amount adjustment given to the customer in the charge amount and performs a tax inclusive calculation to arrive at the base sales amount. The desired total (charge plus all taxes) is placed in the ‘charge’ field in the transaction, and base charge necessary to generate that total is returned in the ‘base_sale’ parameter. Taxes for the desired transaction are returned in the same manner as EZTaxZipEx does. If the AFC session was started with the tax log open, tax calculations are logged and will be reflected in tax reports. BTN, origination and termination information is passed using Zips.

Format

EZ_ADJTXIZIP (pHandle: pZip: pZipP4: pCountry: pState: pCounty: pLocality: (Generic transaction data): (Generic returned tax info): pError: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType: pBaseSale);

Return Value

pTaxCount (10I 0)

Parameters

pHandle (10I 0)

pZip (6A)

pZipP4 (5A)

pCountry (4A)

pState (3A)

pCounty (26A)

pLocality (26A)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

pBaseSale (12P 6)

Remarks

None

E9 Version

RPG Procedure

E9_ADJTXIZIP

RPG Copy

E9ADTIZIP

Description

EZTaxAdjTxiZip accepts transaction data with the gross amount adjustment given to the customer in the charge amount and performs a tax inclusive calculation to arrive at the base sales amount. The desired total (charge plus all taxes) is placed in the ‘charge’ field in the transaction, and base charge necessary to generate that total is returned in the ‘base_sale’ parameter. Taxes for the desired transaction are returned in the same manner as EZTaxZipEx does. If the AFC session was started with the tax log open, tax calculations are logged and will be reflected in tax reports. BTN, origination and termination information is passed using Zips.

Note: Tax inclusive calculations only handle charges up to $10M.

Format

E9_ADJTXIZIP (pSessionPtr: pZip: pZipP4: pCountry: pState: pCounty: pLocality: (Generic transaction data Appendix A): (Generic returned tax info Appendix B): pError: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType: pBaseSale); (Generic transaction data, Appendix A2): (Generic returned tax info, Appendix B2)

Return Value

pTaxCount (10I 0)

Parameters

pSessionPtr (*)

pZip (6A)

pZipP4 (5A)

pCountry (4A)

pState (3A)

pCounty (26A)

pLocality (26A)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

pBaseSale (12P 6)

Generic transaction data 2: See Appendix A2

Generic returned tax info 2: See Appendix B2

Remarks

None

EZ Version

RPG Procedure

EZ_ADJ_TPP_EX

RPG Copy

EZADJTPPEX

Description

EZTaxAdjTPPEx accepts transaction data and performs appropriate tax calculations required to refund or credit taxes. If the AFC session was started with the tax log open, appropriate tax reductions are logged and will be reflected in tax reports. The user provides up to three addresses: Ship From, Ship To and Point of Acceptance. Rules will be applied against the input addresses to determine in what jurisdiction any SALES or USE taxation would be applicable. A nexus table may optionally be provided; if so it will be checked to determine if nexus exists in the state found to have taxing jurisdiction.

Format

EZ_ADJ_TPP_EX (pHandle: pFromZipCode: pFromZipPlus4: pFromCountry: pFromState: pFromCounty: pFromLocality: pToZipCode: pToZipPlus4: pToCountry: pToState: pToCounty: pToLocality: pPoaZipCode: pPoaZipPlus4: pPoaCountry: pPoaState: pPoaCounty: pPoaLocality: pNexusArray: pNexusCount: (Generic transaction data): (Generic returned tax info): pError: pDiscount: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType: pAdjMethod);

Return Value

pTaxCount (10I 0)

Parameters

pHandle (10I 0)

pFromZipCode (6A)

pFromZipPlus4 (5A)

pFromCountry (4A)

pFromState (3A)

pFromCounty (26A)

pFromLocality (26A)

pToZipCode (6A)

pToZipPlus4 (5A)

pToCountry (4A)

pToState (3A)

pToCounty (26A)

pToLocality (26A)

pPoaZipCode (6A)

pPoaZipPlus4 (5A)

pPoaCountry (4A)

pPoaState (3A)

pPoaCounty (26A)

pPoaLocality (26A)

pNexusArray (2A DIM(EZ_NXS_MAX))

pNexusCount (10I 0)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0)

pDiscount (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

pAdjMethod (10I 0)

Remarks

None

E9 Version

RPG Procedure

E9_ADJ_TPP_EX

RPG Copy

E9ADJTPPEX

Description

EZTaxAdjTPPEx accepts transaction data and performs appropriate tax calculations required to refund or credit taxes. If the AFC session was started with the tax log open, appropriate tax reductions are logged and will be reflected in tax reports. The user provides up to three addresses: Ship From, Ship To and Point of Acceptance. Rules will be applied against the input addresses to determine in what jurisdiction any SALES or USE taxation would be applicable. A nexus table may optionally be provided; if so it will be checked to determine if nexus exists in the state found to have taxing jurisdiction.

Format

E9_ADJ_TPP_EX (pSessionPtr: pFromZipCode: pFromZipPlus4: pFromCountry: pFromState: pFromCounty: pFromLocality: pToZipCode: pToZipPlus4: pToCountry: pToState: pToCounty: pToLocality: pPoaZipCode: pPoaZipPlus4: pPoaCountry: pPoaState: pPoaCounty: pPoaLocality: pNexusArray: pNexusCount: (Generic transaction data Appendix A): (Generic returned tax info Appendix B): pError: pDiscount: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType: pAdjMethod);(Generic transaction data, Appendix A2): (Generic returned tax info, Appendix B2)

Return Value

pTaxCount (10I 0)

Parameters

pSessionPtr (*)

pFromZipCode (6A)

pFromZipPlus4 (5A)

pFromCountry (4A)

pFromState (3A)

pFromCounty (26A)

pFromLocality (26A)

pToZipCode (6A)

pToZipPlus4 (5A)

pToCountry (4A)

pToState (3A)

pToCounty (26A)

pToLocality (26A)

pPoaZipCode (6A)

pPoaZipPlus4 (5A)

pPoaCountry (4A)

pPoaState (3A)

pPoaCounty (26A)

pPoaLocality (26A)

pNexusArray (2A DIM(E9_NXS_MAX))

pNexusCount (10I 0)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0)

pDiscount (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

pAdjMethod (10I 0)

Generic transaction data 2: See Appendix A2

Generic returned tax info 2: See Appendix B2

Remarks

None

EZ Version

RPG Procedure

EZ_ADJ_ZIP_EX

RPG Copy

EZADJZIPEX

Description

EZTaxAdjZipEx accepts transaction data and performs appropriate tax calculations required to refund or credit taxes (for Debit cards use EZTaxAdjDebitZEx). If the AFC session was started with the tax log open, appropriate tax reductions are logged and will be reflected in tax reports. The tax jurisdiction is specified using address information identical to EZTaxZipEx.

Format

EZ_ADJ_ZIP_EX (pHandle: pZipCode: pZipPlus4: pCountry: pState: pCounty: pLocality: (Generic transaction data): (Generic returned tax info): pError: pDiscount: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType: pAdjMethod);

Return Value

pTaxCount (10I 0)

Parameters

pHandle (10I 0)

pZipCode (6A)

pZipPlus4 (5A)

pCountry (4A)

pState (3A)

pCounty (26A)

pLocality (26A)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0)

pDiscount (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

pAdjMethod (10I 0)

Remarks

None

E9 Version

RPG Procedure

E9_ADJ_ZIP_EX

RPG Copy

E9ADJZIPEX

Description

EZTaxAdjZipEx accepts transaction data and performs appropriate tax calculations required to refund or credit taxes (for Debit cards use EZTaxAdjDebitZEx). If the AFC session was started with the tax log open, appropriate tax reductions are logged and will be reflected in tax reports. The tax jurisdiction is specified using address information identical to EZTaxZipEx.

Format

E9_ADJ_ZIP_EX (pSessionPtr: pZipCode: pZipPlus4: pCountry: pState: pCounty: pLocality: (Generic transaction data Appendix A): (Generic returned tax info Appendix B): pError: pDiscount: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType: pAdjMethod); (Generic transaction data, Appendix A2): (Generic returned tax info, Appendix B2)

Return Value

pTaxCount (10I 0)

Parameters

pSessionPtr (*)

pZipCode (6A)

pZipPlus4 (5A)

pCountry (4A)

pState (3A)

pCounty (26A)

pLocality (26A)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0)

pDiscount (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

pAdjMethod (10I 0)

Generic transaction data 2: See Appendix A2

Generic returned tax info 2: See Appendix B2

Remarks

None

EZ Version

RPG Procedure

EZ_JURISDICTN

RPG Copy

EZJURISDCT

Description

EZTaxCalcJurisdiction returns the first JCode at the lowest level. Format EZ_JURISDICTN (pHandle: pBTN_JCode: pOrig_JCode: pTerm_JCode: (Generic transaction data): pError: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType);

Return Value

pJCode (10U 0)

Parameters

pHandle (10I 0)

pBTN_JCode (10U 0)

pOrig_JCode (10U 0)

pTerm_JCode (10U 0)

Generic transaction data: See Appendix A pError (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

Remarks

pSpe_Count must be zero. The three parameters following pSpe_Count, pSpe_Tax_Type, pSpe_Tax_Level and pSpe_JCode, are omitted. The Customer Number parameter is also omitted.

E9 Version

RPG Procedure

E9_JURISDICTN

RPG Copy

E9JURISDCT

Description

EZTaxCalcJurisdiction returns the first JCode at the lowest level.

Format

E9_JURISDICTN (pSessionPtr: pBTN_JCode: pOrig_JCode: pTerm_JCode: (Generic transaction data Appendix A): pError: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType); (Generic transaction data, Appendix A2)

Return Value

pJCode (10U 0)

Parameters

pSessionPtr (*)

pBTN_JCode (10U 0)

pOrig_JCode (10U 0)

pTerm_JCode (10U 0)

Generic transaction data: See Appendix A. See Remarks pError (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

Generic transaction data 2: See Appendix A2

Remarks

pSpe_Count must be zero. The three parameters following pSpe_Count, pSpe_Tax_Type, pSpe_Tax_Level and pSpe_JCode, are omitted. The Customer Number parameter is also omitted.

EZ Version

RPG Procedure

EZ_CLR_EXCL

RPG Copy

EZCLREXCL

Description

EZTaxClearExclusion is used to remove all exclusions that have been set. Format EZ_CLR_EXCL (pHandle)

Return Value

pAnswer (10I 0)

TRUE (1) – Success

FALSE (0) – Failure

Parameters

pHandle (10I 0)

Remarks

None

E9 Version

RPG Procedure

E9_CLR_EXCL

RPG Copy

E9CLREXCL

Description

EZTaxClearExclusion is used to remove all exclusions that have been set. Format E9_CLR_EXCL (guZSessionPtr)

Return Value

pAnswer (10I 0)

TRUE (1) – Success

FALSE (0) – Failure

Parameters

guZSessionPtr (*)

Remarks

None

E9 Version

RPG Procedure

E9_CLEAR_TSR

RPG Copy

E9CLEARTSR

Description

EZTaxClearTSR dellocates memory used to store data created by EZTaxGetTSR. This deallocation prevents memory leaks during operation.

Format

E9_CLEAR_TSR (pSessionPtr: pAryStructPtr)

Return Value

None

Parameters

pSessionPtr (* VALUE) .

pAryStructPtr (* VALUE)

Remarks

None

E9 Version

RPG Procedure

E9_ CLRSAFHBR

RPG Copy

E9CLRSFHBR

Description

Clear the EZTax Safe Harbor TAM override set via E9_SETSAFHBR. The API clears the override flag and the engine will return to using the default safe harbor percentages for the chosen TAMTypeID (celluar type, VoIP type or paging type).

Format

E9_CLEAR_TSR (pSessionPtr: pSafeHbrType: pError)

Return Value

pAnswer (10I 0)

TRUE (1) – Success

FALSE (0) – Failure

Parameters

pSessionPtr (* VALUE) 

pSafeHbrType (5I 0 VALUE) 

pError (10I 0) 

Remarks

None 

EZ Version

RPG Procedure

EZ_DEBITJ_X

RPG Copy

EZDBTJEX

Description

EZTaxDebitJEx accepts transaction data and performs appropriate tax calculations. If the AFC session was started with the tax log open, appropriate tax reductions are logged and will be reflected in tax reports. BTN, origination and termination information is passed using JCodes.

Format

EZ_DEBITJ_X (pHandle: pBTN_JCode: pOrig_JCode: pTerm_JCode: (Generic transaction data): (Generic returned tax info): pError: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType);

Return Value

pAnswer (10I 0) - Tax Count

Parameters

pHandle (10I 0)

pBTN_JCode (10U 0)

pOrig_JCode (10U 0)

pTerm_JCode (10U 0)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

Remarks

None

E9 Version

RPG Procedure

E9_DEBITJ_X

RPG Copy

E9DBTJEX

Description

EZTaxDebitJEx accepts transaction data and performs appropriate tax calculations. If the AFC session was started with the tax log open, appropriate tax reductions are logged and will be reflected in tax reports. BTN, origination and termination information is passed using JCodes.

Format

E9_DEBITJ_X (pSessionPtr: pBTN_JCode: pOrig_JCode: pTerm_JCode: (Generic transaction data Appendix A): (Generic returned tax info Appendix B): pError: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType);(Generic transaction data, Appendix A2): (Generic returned tax info, Appendix B2)

Return Value

pAnswer (10I 0) - Tax Count 

Parameters

pSessionPtr (*) 

pBTN_JCode (10U 0) 

pOrig_JCode (10U 0) 

pTerm_JCode (10U 0) 

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0)

 

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

Generic transaction data 2: See Appendix A2

Generic returned tax info 2: See Appendix B2

Remarks

None

EZ Version

RPG Procedure

EZ_DEBITN_EX

RPG Copy

EZDBTNEX

Description

EZTaxDebitNEx accepts transaction data and performs appropriate tax calculations. If the AFC session was started with the tax log open, appropriate tax reductions are logged and will be reflected in tax reports. BTN, origination and termination information is passed using NPANXXs.

Format

EZ_DEBITN_EX (pHandle: pBTN_NPAN: pOrig_NPAN: pTerm_NPAN: (Generic transaction data): (Generic returned tax info): pError: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType);

Return Value

pTaxCount (10I 0)

Parameters

pHandle (10I 0)

pBTN_NPAN (10I 0)

pOrig_NPAN (10I 0)

pTerm_NPAN (10I 0)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B pError (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

Remarks

None

E9 Version

RPG Procedure

E9_DEBITN_EX

RPG Copy

E9DBTNEX

Description

EZTaxDebitNEx accepts transaction data and performs appropriate tax calculations. If the AFC session was started with the tax log open, appropriate tax reductions are logged and will be reflected in tax reports. BTN, origination and termination information is passed using NPANXXs.

Format

E9_DEBITN_EX (pSessionPtr: pBTN_NPAN: pOrig_NPAN: pTerm_NPAN: (Generic transaction data Appendix A): (Generic returned tax info Appendix B): pError: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType); (Generic transaction data, Appendix A2): (Generic returned tax info, Appendix B2)

Return Value

pTaxCount (10I 0)

Parameters

pSessionPtr (*)

pBTN_NPAN (10I 0)

pOrig_NPAN (10I 0)

pTerm_NPAN (10I 0)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

Generic transaction data 2: See Appendix A2

Generic returned tax info 2: See Appendix B2

Remarks

None

EZ Version

RPG Procedure

EZ_DEBITP_EX

RPG Copy

EZDBTPEX

Description

EZTaxDebitPEx accepts transaction data and performs appropriate tax calculations. If the AFC session was started with the tax log open, appropriate tax reductions are logged and will be reflected in tax reports. BTN, origination and termination information is passed using PCodes.

Format

EZ_DEBITP_EX (pHandle: pBTN_PCode: pOrig_PCode: pTerm_PCode: (Generic transaction data): (Generic returned tax info): pError: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType);

Return Value

pTaxCount (10I 0)

Parameters

pHandle (10I 0)

pBTN_PCode (10U 0)

pOrig_PCode (10U 0)

pTerm_PCode (10U 0)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

Remarks

None

E9 Version

RPG Procedure

E9_DEBITP_EX

RPG Copy

E9DBTPEX

Description

EZTaxDebitPEx accepts transaction data and performs appropriate tax calculations. If the AFC session was started with the tax log open, appropriate tax reductions are logged and will be reflected in tax reports. BTN, origination and termination information is passed using PCodes.

Format

E9_DEBITP_EX (pSessionPtr: pBTN_PCode: pOrig_PCode: pTerm_PCode: (Generic transaction data Appendix A): (Generic returned tax info Appendix B): pError: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType); (Generic transaction data, Appendix A2): (Generic returned tax info, Appendix B2)

Return Value

pTaxCount (10I 0) 

Parameters

pSessionPtr (*) 

pBTN_PCode (10U 0) 

pOrig_PCode (10U 0) 

pTerm_PCode (10U 0) 

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0)

 

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

Generic transaction data 2: See Appendix A2

Generic returned tax info 2: See Appendix B2

Remarks

None

EZ Version

RPG Procedure

EZ_DEBITZ_EX

RPG Copy

EZDBTZEX

Description

EZTaxDebitZEx accepts transaction data and performs appropriate tax calculations. If the AFC session was started with the tax log open, appropriate tax reductions are logged and will be reflected in tax reports. The taxing jurisidiction is passed by address information.

Format

EZ_DEBITZ_EX (pHandle: pZipCode: pZipPlus4: pCountry: pState: pCounty: pLocality: (Generic transaction data Appendix A): (Generic returned tax info Appendix B): pError: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType); (Generic transaction data, Appendix A2): (Generic returned tax info, Appendix B2)

Return Value

pTaxCount (10I 0) 

Parameters

pHandle (10I 0) 

pZipCode (6A) 

pZipPlus4 (5A) 

pCountry (4A) 

pState (3A) 

pCounty (26A) 

pLocality (26A) 

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0)

 

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

Remarks

None

E9 Version

RPG Procedure

E9_DEBITZ_EX

RPG Copy

E9DBTZEX

Description

EZTaxDebitZEx accepts transaction data and performs appropriate tax calculations. If the AFC session was started with the tax log open, appropriate tax reductions are logged and will be reflected in tax reports. The taxing jurisidiction is passed by address information.

Format

E9_DEBITZ_EX (pSessionPtr: pZipCode: pZipPlus4: pCountry: pState: pCounty: pLocality: (Generic transaction data Appendix A): (Generic returned tax info Appendix B): pError: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType); (Generic transaction data, Appendix A2): (Generic returned tax info, Appendix B2)

Return Value

pTaxCount (10I 0) 

Parameters

pSessionPtr (*) 

pZipCode (6A) 

pZipPlus4 (5A) 

pCountry (4A) 

pState (3A) 

pCounty (26A) 

pLocality (26A) 

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0)

 

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

Generic transaction data 2: See Appendix A2

Generic returned tax info 2: See Appendix B2

Remarks

None

EZ Version

RPG Procedure

EZ_EXITSS_EX

RPG Copy

EZEXITSSEX

Description

EZTaxExitSessionEx will terminate a session specified by a valid session handle. EZTaxExitSessionEx writes the current internal tax log buffers to the tax log disk file, de-allocates cached database memory, closes all AFC database files, and performs other clean-up duties which free up resources utilized for the specified session.

Format

EZ_EXITSS_EX (pHandle);

Return Value

pAnswer (10I 0)

TRUE (1) – Session exited successfully.

FALSE (0) – An error has occurred.

Parameters

pHandle (10I 0)

Remarks

None

E9 Version

RPG Procedure

E9_EXITSS_EX

RPG Copy

E9EXITSSEX

Description

EZTaxExitSessionEx will terminate a session specified by a valid session handle. EZTaxExitSessionEx writes the current internal tax log buffers to the tax log disk file, de-allocates cached database memory, closes all AFC database files, and performs other clean-up duties which free up resources utilized for the specified session.

Format

E9_EXITSS_EX (pSessionPtr);

Return Value

pAnswer (10I 0)

TRUE (1) – Session exited successfully.

FALSE (0) – An error has occurred.

Parameters

pSessionPtr (*)

Remarks

None

EZ Version

RPG Procedure

EZ_FLUSHLOG_EX

RPG Copy

EZFLUSHLOG

Description

EZTax FlushToLog writes the current internal tax log buffers to the tax log disk file. The internal tax log buffers are normally written to when they are filled to capacity or EZTaxExit is called. This function can be called to force a write to tax log disk file.

Format

EZ_FLUSHLOG_EX (pHandle);

Return Value

pAnswer (10I 0) – Zero

Parameters

pHandle (10I 0) Input

Remarks

None

E9 Version

RPG Procedure

E9_FLUSHLOG_EX

RPG Copy

E9FLUSHLOG

Description

EZTax FlushToLog writes the current internal tax log buffers to the tax log disk file. The internal tax log buffers are normally written to when they are filled to capacity or EZTaxExit is called. This function can be called to force a write to tax log disk file.

Format

E9_FLUSHLOG_EX (pSessionPtr);

Return Value

pAnswer (10I 0) – Zero

Parameters

pSessionPtr (*) Input

Remarks

None

EZ Version

RPG Procedure

EZ_FTOP_EX

RPG Copy

EZFTOPEX

Description

EZTaxFtoPCodeEx returns a PCode that cross-referenced to the specified Fips Code. Zero is returned if not found.

Format

EZ_FTOP_EX (pHandle: pFIPS: pError);

Return Value

pPCode(10U 0)

Parameters

pHandle (10I 0)

pFIPS (11A)

pError (10I 0)

Remarks

None

E9 Version

RPG Procedure

E9_FTOP_EX

RPG Copy

E9FTOPEX

Description

EZTaxFtoPCodeEx returns a PCode that cross-referenced to the specified Fips Code. Zero is returned if not found.

Format

EZ_FTOP_EX (pSessionPtr: pFIPS: pError);

Return Value

pPCode(10U 0)

Parameters

pSessionPtr (*)

pFIPS (11A)

pError (10I 0)

Remarks

None

EZ Version

RPG Procedure

EZ_GET_ADDR_EX

RPG Copy

EZGTADDREX

Description

EZTaxGetAddressEx accepts a JCode as input to retrieve the location address data for the jurisdiction specified by the JCode.

Format

EZ_GET_ADDR_EX (pHandle: pJCode: pRJLevel: pRLocality: pRCounty: pRState: pRCountry: pRZipBegin: pRZipBeginP4: pRZipEnd: pRZipEndP4: pError);

Return Value

pAnswer (10U 0)

NOT_FOUND - Failed due to invalid JCode or an error has occurred.

FOUND - Successfully retrieved address.

MORE - Successfully retrieved address and other valid addresses exist for this jurisdiction. Other address can be obtained by calling EZTaxNextAddressEx.

Parameters

pHandle (10I 0)

pJCode (10U 0)

pJLevel (10I 0)

pRLocality (26A)

pRCounty (26A)

pRState (3A)

pRCountry (4A)

pRZipBegin (6A)

pRZipBeginP4 (5A)

pRZipEnd (6A)

pRZipEndP4 (5A)

pError (10I 0)

Remarks

None

E9 Version

RPG Procedure

E9_GET_ADDR_EX

RPG Copy

E9GTADDREX

Description

EZTaxGetAddressEx accepts a JCode as input to retrieve the location address data for the jurisdiction specified by the JCode.

Format

E9_GET_ADDR_EX (pSessionPtr: pJCode: pRJLevel: pRLocality: pRCounty: pRState: pRCountry: pRZipBegin: pRZipBeginP4: pRZipEnd: pRZipEndP4: pError);

Return Value

pAnswer (10U 0)

NOT_FOUND - Failed due to invalid JCode or an error has occurred. FOUND - Successfully retrieved address.

MORE - Successfully retrieved address and other valid addresses exist for this jurisdiction. Other address can be obtained by calling EZTaxNextAddressEx.

Parameters

pSessionPtr (*)

pJCode (10U 0)

pJLevel (10I 0)

pRLocality (26A)

pRCounty (26A)

pRState (3A)

pRCountry (4A)

pRZipBegin (6A)

pRZipBeginP4 (5A)

pRZipEnd (6A)

pRZipEndP4 (5A)

pError (10I 0)

Remarks

None

EZ Version

RPG Procedure

EZ_GTCSTLOG_EX

RPG Copy

EZGTCSTLOG

Description

EZTaxGetCustomLog is a routine that returns a pointer to a log structure, which is used for customized logging. The data is returned in structures that the customer can access just like the other tax transactions. The RPG Interface returns the log records from the log structure.

Format

wrt_answer = EZ_GTCSTLOG_EX(pEZHandle: COUNT: gcP_CODE: gcTAX_TYPE: gcTAX_LEVEL: gcRATE: gcTAX_AMOUNT: gTAXABLE_MEASU: gEXEMPT_SLS_AM: gRFND_UNCOLLCT: gcMINUTES: gcINV_NO: gcSER_LVL_NO: gcOPTIONAL: gcLINES: gcLOCATIONS: gcCALC_TYPE: gcbillable: gccomplianc: gcCUST_NO: gcadj_method: gcexempt_type: gcSurchg: gcLOG_COUNTR: gcCOMPANY_ID: gcOPT_ALPHA_1: gcopt_4: gcopt_5: gcopt_6: gcopt_7:gcopt_8: gcopt_9: gcopt_10);

Return Value

FALSE – (0) - Failed to retrieve the custom log data.

TRUE - (1) - Successfully retrieved the log information.

Parameters

pHandle (10I 0)

D gcCOUNT S 10I 0 

D gcP_CODE S 10U 0 DIM(LGZ_ARY_MAX) 

D gcTAX_TYPE S 10I 0 DIM(LGZ_ARY_MAX) 

D gcTAX_LEVEL S 10I 0 DIM(LGZ_ARY_MAX) 

D gcRATE S 12P 6 DIM(LGZ_ARY_MAX) 

D gcTAX_AMOUNT S 12P 6 DIM(LGZ_ARY_MAX) 

D gTAXABLE_MEASU S 12P 6 DIM(LGZ_ARY_MAX) 

d gEXEMPT_SLS_AM S 12P 6 DIM(LGZ_ARY_MAX) 

d gRFND_UNCOLLCT S 12P 6 DIM(LGZ_ARY_MAX) 

D gcMINUTES S 25P 4 DIM(LGZ_ARY_MAX) 

D gcINV_NO S 10I 0 DIM(LGZ_ARY_MAX) 

D gcSER_LVL_NO S 10I 0 DIM(LGZ_ARY_MAX) 

D gcOPTIONAL S 10I 0 DIM(LGZ_ARY_MAX) 

D gcLINES S 10I 0 DIM(LGZ_ARY_MAX) 

D gcLOCATIONS S 10I 0 DIM(LGZ_ARY_MAX) 

D gcCALC_TYPE S 10I 0 DIM(LGZ_ARY_MAX) 

D gcbillable S 10i 0 DIM(LGZ_ARY_MAX) 

D gccomplianc S 10i 0 DIM(LGZ_ARY_MAX) 

D gcCUST_NO S 20 DIM(LGZ_ARY_MAX) 

d gcadj_method S 10I 0 DIM(LGZ_ARY_MAX) 

d gcexempt_type S 10I 0 DIM(LGZ_ARY_MAX) 

D gcSurchg S 10i 0 DIM(LGZ_ARY_MAX) 

D gcLOG_COUNTR S 10U 0 DIM(LGZ_ARY_MAX) 

D gcCOMPANY_ID S 20 DIM(LGZ_ARY_MAX) 

 

D gcOPT_ALPHA_1 S 20 DIM(LGZ_ARY_MAX) 

d gcopt_4 S 10I 0 DIM(LGZ_ARY_MAX) 

d gcopt_5 S 10I 0 DIM(LGZ_ARY_MAX) 

d gcopt_6 S 10I 0 DIM(LGZ_ARY_MAX) 

d gcopt_7 S 10I 0 DIM(LGZ_ARY_MAX) 

d gcopt_8 S 10I 0 DIM(LGZ_ARY_MAX) 

d gcopt_9 S 10I 0 DIM(LGZ_ARY_MAX) 

d gcopt_10 S 10I 0 DIM(LGZ_ARY_MAX) 

Remarks

EZ_GTCSTLOG_EX, when used to read records created using the EZ_XXX APIs, will, in many cases, read random data located in the gcopt_x fields. This random data may, very occasionally, result in invalid records due to erroneous end-of-line markers which are part of the random data. The random data results from the EZ_XXX APIs not supporting the gcopt_x fields. This potential problem can be avoided by using the E9_XXX version of the APIs. The E9_XXX APIs, that create EZTax.log records, support the gcopt_x fields.

EZ_SETUPCSTLOG must be called prior to EZ_GTCSTLOG_EX.  EZ_SETUPCSTLOG is used after a call to initialize the AFC session and before any taxes are calculated. The data returned by E9_GTCSTLOG_EX can be used to call EZTaxWriteToLogEx to output the information to the AFC log.

EZTaxGetCustomLogCount can be used to get the record count in the log table.

When a transaction has been processed, the custom log structure will contain the tax information generated by that transaction.

gcCOUNT: This input value specified the number of records to return from the log structure. The example code uses tax calculation API return values for the count. These return counts represent then number of records written to the AFC Log file and are dependent on configuration settings. Alternatly, the new API call, E9_GET_CST_CNT, return count may be used. Using the E9_GET_CST_CNT return count returns all available records from the log structure.

The value in eztax_logEx.p_code (gcP_CODE) is the jcode representation of the jurisdiction.

EZ Version

RPG Procedure

EZ_SETUPCSTLOG

RPG Copy

EZGTCSTLOG

Format

wrt_answer = EZ_ SETUPCSTLOG pEZHandle);

Return Value

FALSE – (0) - Failed to retrieve the custom log data.

TRUE - (1) - Successfully retrieved the log information.

Parameter

pHandle (10I 0)

Remarks

This function is used after a call to initialize the AFC session and before any taxes are calculated. See the EZ_GTCSTLOG_EX Remarks section for additional information.

E9 Version

RPG Procedure

E9_GTCSTLOG_EX

RPG Copy

E9GTCSTLOG

Description

EZTaxGetCustomLog is a routine that returns a pointer to a log structure, which is used for customized logging. The data is returned in structures that the customer can access just like the other tax transactions. The RPG Interface returns the log records from the log structure.

Format

wrt_answer = E9_GTCSTLOG_EX(pSessionPtr: COUNT: gcP_CODE: gcTAX_TYPE: gcTAX_LEVEL: gcRATE: gcTAX_AMOUNT: gTAXABLE_MEASU: gEXEMPT_SLS_AM: gRFND_UNCOLLCT: gcMINUTES: gcINV_NO: gcSER_LVL_NO: gcOPTIONAL: gcLINES: gcLOCATIONS: gcCALC_TYPE: gcbillable: gccomplianc: gcCUST_NO: gcadj_method: gcexempt_type: gcSurchg: gcLOG_COUNTR: gcCOMPANY_ID: gcOPT_ALPHA_1: gcopt_4: gcopt_5: gcopt_6: gcopt_7: gcopt_8: gcopt_9: gcopt_10);

Return Value

FALSE – (0) - Failed to retrieve the custom log data.

TRUE - (1) - Successfully retrieved the log information.

Parameters

pSessionPtr (*)

D gcCOUNT S 10I 0 

D gcP_CODE S 10U 0 DIM(LGZ_ARY_MAX) 

D gcTAX_TYPE S 10I 0 DIM(LGZ_ARY_MAX) 

D gcTAX_LEVEL S 10I 0 DIM(LGZ_ARY_MAX) 

D gcRATE S 12P 6 DIM(LGZ_ARY_MAX) 

D gcTAX_AMOUNT S 8F DIM(LGZ_ARY_MAX) 

D gTAXABLE_MEASU S 8F DIM(LGZ_ARY_MAX) 

d gEXEMPT_SLS_AM S 8F DIM(LGZ_ARY_MAX) 

d gRFND_UNCOLLCT S 12P 6 DIM(LGZ_ARY_MAX) 

D gcMINUTES S 25P 4 DIM(LGZ_ARY_MAX) 

D gcINV_NO S 10U 0 DIM(LGZ_ARY_MAX) 

D gcSER_LVL_NO S 10U 0 DIM(LGZ_ARY_MAX) 

D gcOPTIONAL S 10U 0 DIM(LGZ_ARY_MAX) 

D gcLINES S 10I 0 DIM(LGZ_ARY_MAX) 

D gcLOCATIONS S 10I 0 DIM(LGZ_ARY_MAX) 

D gcCALC_TYPE S 10I 0 DIM(LGZ_ARY_MAX) 

D gcbillable S 10I 0 DIM(LGZ_ARY_MAX) 

D gccomplianc S 10I 0 DIM(LGZ_ARY_MAX) 

D gcCUST_NO S 20 DIM(LGZ_ARY_MAX) 

d gcadj_method S 10I 0 DIM(LGZ_ARY_MAX) 

d gcexempt_type S 10I 0 DIM(LGZ_ARY_MAX) 

D gcSurchg S 10I 0 DIM(LGZ_ARY_MAX) 

D gcLOG_COUNTR S 10U 0 DIM(LGZ_ARY_MAX) 

D gcCOMPANY_ID S 20 DIM(LGZ_ARY_MAX) 

D gcOPT_ALPHA_1 S 20 DIM(LGZ_ARY_MAX) 

D gcopt_4 S 10U 0 DIM(LGZ_ARY_MAX) 

D gcopt_5 S 10U 0 DIM(LGZ_ARY_MAX) 

D gcopt_6 S 10U 0 DIM(LGZ_ARY_MAX) 

D gcopt_7 S 10U 0 DIM(LGZ_ARY_MAX) 

D gcopt_8 S 10U 0 DIM(LGZ_ARY_MAX) 

D gcopt_9 S 10U 0 DIM(LGZ_ARY_MAX) 

D gcopt_10 S 10U 0 DIM(LGZ_ARY_MAX) 

Remarks

E9_SETUPCSTLOG must be called prior to E9_GTCSTLOG_EX.  E9_SETUPCSTLOG is used after a call to initialize the AFC session and before any taxes are calculated. The data returned by E9_GTCSTLOG_EX can be used to call EZTaxWriteToLogEx (E9_WRT_TO_LOG) to output the information to the AFC log. EZTaxGetCustomLogCount can be used to get the record count in the log table.

When a transaction has been processed, the custom log structure will contain the tax information generated by that transaction.

gcCOUNT: This input value specifies the number of records to return from the log structure. The example code in COPYSRC uses tax calculation API return values for the count. These return counts represent then number of records written to the AFC Log file and are dependent on configuration settings. Alternatly, the new API call, E9_GET_CST_CNT, return count may be used. The E9_GET_CST_CNT return count includes all available records from the log structure.

The value in eztax_logEx.p_code (gcP_CODE) is the jcode representation of the jurisdiction.

E9 Version

RPG Procedure

E9_SETUPCSTLOG

RPG Copy

E9GTCSTLOG

Format

wrt_answer = EZ_ SETUPCSTLOG (pSessionPtr);

Return Value

FALSE – (0) - Failed to retrieve the custom log data.

TRUE - (1) - Successfully retrieved the log information.

Parameter

pSessionPtr (*)

Remarks

This function is used after a call to initialize the AFC session and before any taxes are calculated. See the E9_GTCSTLOG_EX Remarks for additional information.

E9 Version

RPG Procedure

E9_GET_CST_CNT

RPG Copy

E9GTCSTCNT

Description

EZTaxGetCustomLogCount returns the number of records in the current custom log table. See the Remarks section regarding the returned count.

Format

guZCount = E9_GET_CST_CNT (pE9Session@);

Return Value

Returns the number of records in the current custom log table. Zero See Zero indicates that no records exist. See the Remarks section for additional information

Parameters

pE9Session@ *

Remarks

GetCustomLogCount returns the number of taxes contained in the EZTaxGetCustomLog structure. The log count includes no summarization. The log count always includes the non-billable tax count.

EZ Version

RPG Procedure

EZ_GTJURIS_EX

RPG Copy

EZGTJURSEX

Description

EZTaxGetJurisdiction retrieves the jurisdiction where the transaction is determined to be taxed at. Current use is in the batch executables that report tax revenue group by state.

Format

j_code = EZ_GTJURIS_EX(pHandle: pBTN_JCode: pOrig_JCode: pTerm_JCode: (Generic transaction data): (Generic returned tax info): pError: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType);

Return Value

j_code (10U 0)

0 - Failed due to invalid JCode or an error has occurred.

j_code - Successfully retrieved jurisdiction that the tax was calculated at.

Parameters

pHandle (10I 0) 

pBTN_JCode (10U 0) 

pOrig_JCode (10U 0) 

pTerm_JCode (10U 0) 

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0)

 

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

Remarks

None

E9 Version

RPG Procedure

EZ_GTJURIS_EX

RPG Copy

EZGTJURSEX

Description

EZTaxGetJurisdiction retrieves the jurisdiction where the transaction is determined to be taxed at. Current use is in the batch executables that report tax revenue group by state.

Format

j_code = EZ_GTJURIS_EX(pHandle: pBTN_JCode: pOrig_JCode: pTerm_JCode: (Generic transaction data): (Generic returned tax info): pError: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType);

Return Value

j_code (10U 0)

0 - Failed due to invalid JCode or an error has occurred.

j_code - Successfully retrieved jurisdiction that the tax was calculated at.

Parameters

pHandle (10I 0) 

pBTN_JCode (10U 0) 

pOrig_JCode (10U 0) 

pTerm_JCode (10U 0) 

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0) 

pBusClass (10I 0) 

pSrvClass (10I 0) 

pFacilities (10I 0) 

pFranchise (10I 0) 

pLifeLine (10I 0) 

pExemptType (10I 0) 

Remarks

None 

EZ Version

RPG Procedure

EZ_GET_LOG_NAME

RPG Copy

EZGTLGNAME

Description

EZTaxGetLogName retrieves the log filename when it is specified using the filelocs.txt. Current use is in the batch executables that open the log file and must know the filename.

Format

EZ_GET_LOG_NAME (pHandle: pRLogName);

Return Value

pAnswer (10U 0)

SESSION_NOT_INIT: Handle is invalid.

TRUE: Otherwise

Parameters

pHandle (10I 0) 

pRLogName (150A) 

Remarks

None 

E9 Version

RPG Procedure

E9_GET_LOG_NAME

RPG Copy

E9GTLGNAME

Description

EZTaxGetLogName retrieves the log filename when it is specified using the filelocs.txt. Current use is in the batch executables that open the log file and must know the filename.

Format

E9_GET_LOG_NAME (pSessionPtr: pRLogName);

Return Value

pAnswer (10U 0)

SESSION_NOT_INIT: Handle is invalid.

TRUE: Otherwise

Parameters

pHandle (10I 0) 

pRLogName (150A) 

Remarks

None 

E9 Version

RPG Procedure

E9_GET914LOG

RPG Copy

E9GET914LG

Description

EZTaxGetLogV914 is a routine that returns a pointer to a log structure, which is used for customized logging. The data is returned in structures that the customer can access just like the other tax transactions. The RPG Interface returns the log records from the log structure.

Format

wrt_answer = E9_GET914LOG (pSessionPtr: COUNT: gcP_CODE: gcTAX_TYPE: gcTAX_LEVEL: gcRATE: gcTAX_AMOUNT: gTAXABLE_MEASU: gEXEMPT_SLS_AM: gRFND_UNCOLLCT: gcMINUTES: gcINV_NO: gcSER_LVL_NO: gcOPTIONAL: gcLINES: gcLOCATIONS: gcCALC_TYPE: gcbillable: gccomplianc: gcCUST_NO: gcadj_method: gcexempt_type: gcSurchg: gcLOG_COUNTR: gcCOMPANY_ID: gcOPT_ALPHA_1: gcopt_4: gcopt_5: gcopt_6: gcopt_7: gcopt_8: gcopt_9: gcopt_10 : gcTranType: gcSrvType: gcTransCharge: gcTaxDesc: gcTaxCatId: gcTaxCatDesc);

Return Value

FALSE – (0) - Failed to retrieve the custom log data.

TRUE - (1) - Successfully retrieved the log information.

Parameters

pSessionPtr (*)

D gcCOUNT S 10I 0 DIM(LGZ_ARY_MAX) 

D gcP_CODE S 10U 0 DIM(LGZ_ARY_MAX) 

D gcTAX_TYPE S 10I 0 DIM(LGZ_ARY_MAX) 

D gcTAX_LEVEL S 10I 0 DIM(LGZ_ARY_MAX) 

D gcRATE S 12P 6 DIM(LGZ_ARY_MAX) 

D gcTAX_AMOUNT S 8F DIM(LGZ_ARY_MAX) 

D gTAXABLE_MEASU S 8F DIM(LGZ_ARY_MAX) 

d gEXEMPT_SLS_AM S 8F DIM(LGZ_ARY_MAX) 

d gRFND_UNCOLLCT S 12P 6 DIM(LGZ_ARY_MAX) 

D gcMINUTES S 25P 4 DIM(LGZ_ARY_MAX) 

D gcINV_NO S 10U 0 DIM(LGZ_ARY_MAX) 

D gcSER_LVL_NO S 10U 0 DIM(LGZ_ARY_MAX) 

D gcOPTIONAL S 10U 0 DIM(LGZ_ARY_MAX) 

D gcLINES S 10I 0 DIM(LGZ_ARY_MAX) 

D gcLOCATIONS S 10I 0 DIM(LGZ_ARY_MAX) 

D gcCALC_TYPE S 10I 0 DIM(LGZ_ARY_MAX) 

D gcbillable S 10I 0 DIM(LGZ_ARY_MAX) 

D gccomplianc S 10I 0 DIM(LGZ_ARY_MAX) 

D gcCUST_NO S 20 DIM(LGZ_ARY_MAX) 

d gcadj_method S 10I 0 DIM(LGZ_ARY_MAX) 

d gcexempt_type S 10I 0 DIM(LGZ_ARY_MAX) 

D gcSurchg S 10I 0 DIM(LGZ_ARY_MAX) 

D gcLOG_COUNTR S 10U 0 DIM(LGZ_ARY_MAX) 

D gcCOMPANY_ID S 20 DIM(LGZ_ARY_MAX) 

D gcOPT_ALPHA_1 S 20 DIM(LGZ_ARY_MAX) 

D gcopt_4 S 10U 0 DIM(LGZ_ARY_MAX) 

D gcopt_5 S 10U 0 DIM(LGZ_ARY_MAX) 

D gcopt_6 S 10U 0 DIM(LGZ_ARY_MAX) 

D gcopt_7 S 10U 0 DIM(LGZ_ARY_MAX) 

D gcopt_8 S 10U 0 DIM(LGZ_ARY_MAX) 

D gcopt_9 S 10U 0 DIM(LGZ_ARY_MAX) 

D gcopt_10 S 10U 0 DIM(LGZ_ARY_MAX) 

D gcTrans_Type S 10I 0 DIM(LGZ_ARY_MAX) 

D gcSrv_Type S 10I 0 DIM(LGZ_ARY_MAX) 

 

D gcTrans_Charge S 8F DIM(LGZ_ARY_MAX)

D gcTax_Desc S 100 DIM(LGZ_ARY_MAX)

D gcTax_Cat_Id S 10I 0 DIM(LGZ_ARY_MAX)

D gcTax_Cat_Desc S 100 DIM(LGZ_ARY_MAX)

Remarks

E9_SETUP914LOG must be called prior to E9_GET914LOG. The data returned by E9_GET914LOG can be used to call EZTaxWriteToLogV914 (E9_WRT_914_LOG) to output the information to the AFC log. EZTaxGetLogV914Count (E9_GET_914_CNT) can be used to get the record count in the log table.

When a transaction has been processed, the V914 tax log structure will contain the tax information generated by that transaction. In addition it will contain the charge and t/s pair used in the tax calculation. This can be valuable when processing bundled transactions, as the t/s pair will be the bundled product and the charge the % allocated to this t/s pair.

gcCOUNT: This input value specified the number of records to return from the log structure. The example code uses tax calculation API return values for the count. These return counts represent then number of records written to the AFC Log file and are dependent on configuration settings. Alternatly, the new API call, E9_GET_CST_CNT, return count may be used. Using the E9_GET_CST_CNT return count returns all available records from the log structure.

The value in eztax_log_v914.p_code (gcP_CODE) is the jcode representation of the jurisdiction.

E9 Version

RPG Procedure

E9_SETUP914LOG

RPG Copy

E9SET914LG

Format

wrt_answer = E9_SETUP914LOG (pSessionPtr);

Return Value

FALSE – (0) - Failed to retrieve the custom log data.

TRUE - (1) - Successfully retrieved the log information.

Parameter

pSessionPtr (*)

Remarks

This function is used after a call to initialize the AFC session and before any taxes are calculated. See the E9_GET914LOG Remarks for additional information.

E9 Version

RPG Procedure

E9_GET_914_CNT

RPG Copy

E9GT914CNT

Description

EZTaxGetLogV914 Count returns the number of records in the current V914 log table. See the Remarks section regarding the returned count.

Format

guZCount = E9_GET_914_CNT (pE9Session@);

Return Value

Returns the number of records in the current V914 log table.  Zero indicates that no records exist. See the Remarks section for additional information

Parameters

pE9Session@ *

Remarks

Get LogV914Count returns the number of taxes contained inthe EZTaxGetLogV914 structure. The log count includes no summarization. The log count always includes the non-billable tax count.

EZ Version

RPG Procedure

EZGET_NOTAX

RPG Copy

EZGTNOTAXT

Description

EZTaxGetNoTaxTrans retrieves the tax transaction data that was passed into the previously called procedure. There will be data in the structure only if the previously call procedure (like EZ_PCODE_EX) returns no tax data in the tax table. In other words, if there are no taxes to be returned for a specific jurisdiction for the transaction / service type, then the fields in the NoTaxTransaction Table will be populated.

Format

EZGET_NOTAX (pHandle: pNTp_CODE: pNTTRANS_TYPE: pNTSRV_TYPE: pNTATTR: pNTCHARGE: pNTCOMPANY_ID: pNTCUST_NO);

Return Value

pAnswer (10U 0) – Zero

Parameters

pHandle (10I 0) Input

pNTp_CODE (10U 0) Output pNTTRANS_TYPE (10I 0) Output

pNTSRV_TYPE (10I 0) Output

pNTATTR (10I 0) Output

pNTCHARGE (10P 4) Output pNTCOMPANY_ID (20A) Output

pNTCUST_NO (20A) Output

Remarks

The pNTATTR and pNTCOMPANY_ID are only currently available on Sales and Use transactions that return no taxes, since they are specific to this interface.

E9 Version

RPG Procedure

E9GET_NOTAX

RPG Copy

E9GTNOTAXT

Description

EZTaxGetNoTaxTrans retrieves the tax transaction data that was passed into the previously called procedure. There will be data in the structure only if the previously call procedure (like E9_PCODE_EX) returns no tax data in the tax table. In other words, if there are no taxes to be returned for a specific jurisdiction for the transaction / service type, then the fields in the NoTaxTransaction Table will be populated.

Format

EZGET_NOTAX (pSessionPtr: pNTp_CODE: pNTTRANS_TYPE: pNTSRV_TYPE: pNTATTR: pNTCHARGE: pNTCOMPANY_ID: pNTCUST_NO);

Return Value

pAnswer (10U 0) – Zero

Parameters

pHandle (10I 0) Input

pNTp_CODE (10U 0) Output pNTTRANS_TYPE (10I 0) Output

pNTSRV_TYPE (10I 0) Output

pNTATTR (10I 0) Output

pNTCHARGE (8F) Output

pNTCOMPANY_ID (20A) Output

pNTCUST_NO (20A) Output

Remarks

The pNTATTR and pNTCOMPANY_ID are only currently available on Sales and Use transactions that return no taxes, since they are specific to this interface.

EZ Version

RPG Procedure

EZ_GETRATES_EX

RPG Copy

EZGETRATES

Description

EZTaxGetRates utilizes a P-Code as input to produce the table of all taxes for that jurisdiction. It is suggested that the programmer should define the results tables as arrays of 200. This size should be passed into the API to assure there is no overflow of the storage area. If the number of taxes exceeds the passed in number, the program will return a code (-200) and the tables will contain the first database records up to the defined limit.

Format

EZ_GETRATES_EX (pHandle: pP_CODE: pARRY_SIZE: rSCOPE: rTAX_TYPE: rTAX_LEVEL: rOVR_DATE: rLVL_EXEMPT: rTAX_RATE: rMAX_BASE: rREPL_ST: rST_OVRD_TAX: rREPL_CO: rCO_OVRD_TAX: pERROR);

Return Value

pAnswer (10U 0) – Number of entries returned in the table if successful.

Otherwise, returns -1.

pError (10I 0) -- -200 -- pARRY_SIZE not large enough to contain all taxes or error returned from EZTaxGetRates.

Parameters 

pHandle (10I 0) Input 

pP_CODE (10U 0) Input 

pARRY_SIZE (10I 0) Input 

rSCOPE (10I 0) [pARRY_SIZE] Output 

rTAX_TYPE (10I 0) [pARRY_SIZE] Output 

rTAX_LEVEL (10I 0) [pARRY_SIZE] Output 

rOVR_DATE (10I 0) [pARRY_SIZE] Output 

rLVL_EXMPT (10I 0) [pARRY_SIZE] Output 

rTAX_RATE (11P 6) [pARRY_SIZE] Output 

rMAX_BASE (11P 0) [pARRY_SIZE] Output 

rREPL_ST (10I 0) [pARRY_SIZE] Output 

rST_OVRDTX (11P 6) [pARRY_SIZE] Output 

rREPL_CO (10I 0) [pARRY_SIZE] Output 

rCO_OVRDTX (11P 6) [pARRY_SIZE] Output 

pERROR (10U 0) Output 

Remarks

Much of the returned data will be repeated because of different override dates, etc.

E9 Version

RPG Procedure

E9_GETRATES_EX

RPG Copy

E9GETRATES

Description

EZTaxGetRates utilizes a P-Code as input to produce the table of all taxes for that jurisdiction. It is suggested that the programmer should define the results tables as arrays of 200. This size should be passed into the API to assure there is no overflow of the storage area. If the number of taxes exceeds the passed in number, the program will return a code (-200) and the tables will contain the first database records up to the defined limit.

Format

E9_GETRATES_EX (pSessionPtr: pP_CODE: pARRY_SIZE: rSCOPE: rTAX_TYPE: rTAX_LEVEL: rOVR_DATE: rLVL_EXEMPT: rTAX_RATE: rMAX_BASE: rREPL_ST: rST_OVRD_TAX: rREPL_CO: rCO_OVRD_TAX: pERROR);

Return Value

pAnswer (10U 0) – Number of entries returned in the table if successful.

Otherwise, returns -1.

pError (10I 0) -- -200 -- pARRY_SIZE not large enough to contain all taxes or error returned from EZTaxGetRates.

Parameters

pSessionPtr (*) Input 

pP_CODE (10U 0) Input 

pARRY_SIZE (10I 0) Input 

rSCOPE (10I 0) [pARRY_SIZE] Output 

rTAX_TYPE (10I 0) [pARRY_SIZE] Output 

rTAX_LEVEL (10I 0) [pARRY_SIZE] Output 

rOVR_DATE (10I 0) [pARRY_SIZE] Output 

rLVL_EXMPT (10I 0) [pARRY_SIZE] Output 

rTAX_RATE (11P 6) [pARRY_SIZE] Output 

rMAX_BASE (11P 0) [pARRY_SIZE] Output 

rREPL_ST (10I 0) [pARRY_SIZE] Output 

rST_OVRDTX (11P 6) [pARRY_SIZE] Output 

rREPL_CO (10I 0) [pARRY_SIZE] Output 

rCO_OVRDTX (11P 6) [pARRY_SIZE] Output 

pERROR (10U 0) Output 

Remarks

Much of the returned data will be repeated because of different override dates, etc.

EZ Version

RPG Procedure

EZ_GET_TAX_DESC

RPG Copy

EZGTTAXDSC

Description

EZTaxGetTaxDescription retrieves the tax description for a specified tax code. Current use is in utilities reporting from the log, but users can also use this feature.

Format

EZ_GET_TAX_DESC (pHandle: pTaxCode: pRDesc);

Return Value

pAnswer (10U 0) – Zero

Parameters

pHandle (10I 0)

pTaxCode (10I 0)

pRDesc (50A)

Remarks

None

E9 Version

RPG Procedure

E9_GET_TAX_DESC

RPG Copy

E9GTTAXDSC

Description

EZTaxGetTaxDescription retrieves the tax description for a specified tax code. Current use is in utilities reporting from the log, but users can also use this feature.

Format

E9_GET_TAX_DESC (pSessionPtr: pTaxCode: pRDesc);

Return Value

pAnswer (10U 0) – Zero

Parameters

pSessionPtr (*)

pTaxCode (10I 0)

pRDesc (50A)

Remarks

None

E9Version

RPG Procedure

E9_GET_TSR

RPG Copy

E9GETTSR

Description

EZTaxGetTSR retrieves an array of Transaction Service Report (TSR) records. These records contain Transaction Service Report data which is a superset of the data written to the Transaction Service Log.

Format

tsrZData@ = E9_GET_TSR(pE9Session@:nTsrAryCnt:bRtnTsrAry);

Return Value

If successful and bRtnTsrAry is set to TRUE (1), pointer to the allocated data structures. Otherwise, *NULL.

Parameters    

pE9Session@ *

D nTsrAryCnt S 10I 0 inz(0)

D bRtnTsrAry S 10I 0 inz(1)

Remarks

EZTaxGetTSR returns a pointer to an array of allocated data structures. nTsrAryCnt returns the number of data structures with valid data.  The data structures are deallocated using EZTaxClearTSR. Using EZTaxGetTSR without calling EZTaxClearTSR can lead to memory leaks.

If bRtnTsrAry is FALSE (0), the function flushes the TSR data to the TSR log file and clears the data from memory.

Note: The above declaration initializes this parameter to TRUE.

If bRtnTsrAry is TRUE (1), the function returns the TSR data as an array of data structures and does not clear the data. Once the returned data is processed and no longer needed, call application EZTaxClearTSR() to deallocate the data sturctures.

See the rtrZStruct data structure decloration in the E9_STRUCTS member of the COPYSRC file for the format of the returned data structures.

Report ID: The first field returned in the data structure is the Report Identifier. The values are as follows:

Report Invalid Region -1 

Report US And Territories 0 

Report Canada 1 

Report Foreign 2 

Report Unknown 3 

Report States And Territories 4 

Report Provinces And Territories 5

EZVersion

RPG Procedure

EZ_GRP_RSLTS

RPG Copy

EZGRPRSLT

Description

EZTaxGroupResults sets the mode that AFC uses to group the returned taxes by. After calling this function, the results in the tax return table will be grouped as specified by the groupMode parameter.

Format

EZ_GRP_RSLTS (pHandle: pMode);

Return Value

pAnswer (10I 0)

TRUE (1) – Successful

FALSE (0) - Failed

Parameters

pHandle (10I 0)

pMode (10I 0)

Remarks

pMode: Value indicating how tax calculation results should be returned.  The options to group taxes by tax level are as following:

EZ_GP_SAME_LVL: Indicates that taxes at thesame level should be grouped together.

EZ_GP_CO_LCL: When using this option, AFC will group all state taxes into a single record, and county and local taxes will be grouped together into a separate record.

EZ_GP_STCO_LCL: State, county and local taxes will be grouped together.

The options to group sales taxes separately may be appended to a tax level option by using the bitwise OR operator (|). These options are:

EZ_GP_SALES: Sales taxes (tax type 1) and Use Taxes (tax type 49) will be grouped separately from other taxes.

EZ_GP_SALE_CAT: All taxes in the sales tax category will be grouped into a single record.

The DEFAULT, EZ_GP_DEFAULT, option may be used to disable tax grouping. These options are included in the EZtaxDefine.h header file.

Example: EZ_GRP_RSLTS (pHandle: %BitOr(EZ_GP_STCO_LCL: EZ_GP_SALES));

E9 Version

RPG Procedure

E9_GRP_RSLTS

RPG Copy

E9GRPRSLT

Description

EZTaxGroupResults sets the mode that AFC uses to group the returned taxes by. After calling this function, the results in the tax return table will be grouped as specified by the groupMode parameter.

Format

E9_GRP_RSLTS (pSessionPtr: pMode);

Return Value

pAnswer (10I 0)

TRUE (1)– Successful

FALSE (0) - Failed

Parameters

pSessionPtr (*)

pMode (10I 0)

Remarks

pMode: Value indicating how tax calculation results should be returned.  The options to group taxes by tax level are as following:

E9_GP_SAME_LVL: Indicates that taxes at thesame level should be grouped together.

E9_GP_CO_LCL: When using this option, AFC will group all state taxes into a single record, and county and local taxes will be grouped together into a separate record.

E9_GP_STCO_LCL: State, county and local taxes will be grouped together.

The options to group sales taxes separately may be appended to a tax level option by using the bitwise OR operator (|). These options are:

E9_GP_SALES: Sales taxes (tax type 1) and Use Taxes (tax type 49) will be grouped separately from other taxes.

E9_GP_SALE_CAT: All taxes in the sales tax category will be grouped into a single record.

The DEFAULT, E9_GP_DEFAULT, option may be used to disable tax grouping. These options are included in the EZtaxDefine.h header file.

Example: E9_GRP_RSLTS (pSessionPtr: %BitOr(E9_GP_STCO_LCL: E9_GP_SALES));

EZ Version

RPG Procedure

EZ_JCODE_EX

RPG Copy

EZJCODEEX

Description

EZTaxJCodeEx accepts transaction data and performs appropriate tax calculations. If the AFC session was started with the tax log open, appropriate tax reductions are logged and will be reflected in tax reports. BTN, origination and termination information is passed using JCodes.

Format

EZ_JCODE_EX (pHandle: pBTN_JCode: pOrig_JCode: pTerm_JCode: (Generic transaction data): (Generic returned tax info): pError: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType);

Return Value

pTaxCount (10I 0)

Parameters

pHandle (10I 0)

pBTN_JCode (10U 0)

pOrig_JCode (10U 0)

pTerm_JCode (10U 0)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

Remarks

None

E9 Version

RPG Procedure

E9_JCODE_EX

RPG Copy

E9JCODEEX

Description

EZTaxJCodeEx accepts transaction data and performs appropriate tax calculations. If the AFC session was started with the tax log open, appropriate tax reductions are logged and will be reflected in tax reports. BTN, origination and termination information is passed using JCodes.

Format

E9_JCODE_EX (pSessionPtr: pBTN_JCode: pOrig_JCode: pTerm_JCode: (Generic transaction data Appendix A): (Generic returned tax info Appendix B): pError: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType);

Return Value

pTaxCount (10I 0)

Parameters

pSession (*)

pBTN_JCode (10U 0)

pOrig_JCode (10U 0)

pTerm_JCode (10U 0)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

Generic transaction data 2: See Appendix A2

Generic returned tax info 2: See Appendix B2

Remarks

None

EZ Version

RPG Procedure

EZ_JTOP_EX

RPG Copy

EZJTOPEX

Description

EZTaxJtoPCodeEx returns a PCode that is cross-referenced to the specified JCode.

Format

EZ_JTOP_EX (pHandle: pJCode: pError);

Return Value

pPCode (10U 0)

Parameters

pHandle (10I 0)

pJCode (10U 0)

pError (10I 0)

Remarks

None

E9 Version

RPG Procedure

E9_JTOP_EX

RPG Copy

E9JTOPEX

Description

EZTaxJtoPCodeEx returns a PCode that is cross-referenced to the specified JCode.

Format

E9_JTOP_EX (pSessionPtr: pJCode: pError);

Return Value

pPCode(10U 0)

Parameters

pSessionPtr (*)

pJCode (10U 0)

pError (10I 0)

Remarks

None

E9 Version

RPG Procedure

E9_JTTYPEEX

RPG Copy

E9JTTYPEEX

Description

E9_JTTYPEEX Returns transaction type for a given pair of jurisdiction codes indicating whether the call is interstate or intrastate. Both jurisdictions must be within the same country. The first jurisdiction is the origination and the second is the termination. Returns 9_INV_XACTION when countries differ or an error occurs.

Format

E9_JTTYPEEX (pSessionPtr: JCode1: JCode2: Error);

Return Value

TransType (5U 0)

Parameters

pSessionPtr (* VALUE)

OrigJCode (10U 0 VALUE)

TermJCode (10U 0 VALUE)

Error (10I 0)

Remarks

There are three constants defined for use with E9_JTTYPEEX

D E9_INV_XACTION C -1

D E9_INTERSTATE C 1

D E9_INTRASTATE C 2 

EZ Version

RPG Procedure

EZ_NPAN_EX

RPG Copy

EZNPANEX

Description

EZTaxNPANEx accepts transaction data and performs appropriate tax calculations. If the AFC session was started with the tax log open, appropriate tax reductions are logged and will be reflected in tax reports. BTN, origination and termination information is passed using NPANXXs.

Format

EZ_NPAN_EX (pHandle: pBTN_NPAN: pOrig_NPAN: pTerm_NPAN: (Generic transaction data): (Generic returned tax info): pError: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType);

Return Value

pTaxCount (10I 0)

Parameters

pHandle (10I 0)

pBTN_NPAN (10U 0)

pOrig_NPAN (10U 0)

pTerm_NPAN (10U 0)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

Remarks

None

E9 Version

RPG Procedure

E9_NPAN_EX

RPG Copy

E9NPANEX

Description

EZTaxNPANEx accepts transaction data and performs appropriate tax calculations. If the AFC session was started with the tax log open, appropriate tax reductions are logged and will be reflected in tax reports. BTN, origination and termination information is passed using NPANXXs.

Format

E9_NPAN_EX (pSessionPtr: pBTN_NPAN: pOrig_NPAN: pTerm_NPAN: (Generic transaction data Appendix A): (Generic returned tax info Appendix B): pError: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType); (Generic transaction data, Appendix A2): (Generic returned tax info, Appendix B2)

Return Value

pTaxCount (10I 0)

Parameters

pSessionPtr (*)

pBTN_NPAN (10U 0)

pOrig_NPAN (10U 0)

pTerm_NPAN (10U 0)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

Generic transaction data 2: See Appendix A2

Generic returned tax info 2: See Appendix B2

Remarks

None

EZ Version

RPG Procedure

EZ_NXTADDR_EX

RPG Copy

EZNXTADDRX

Description

EZTaxNextAddressEx returns the next sequential record containing alternative address information for the specified JCode. This function can be used to obtain additional addresses for a specified jurisdiction when EZTaxGetAddressEx returns MORE, indication additional information is available. The majority of jurisdictions have more than one set of address/zip code data associated with them.

Format

EZ_NXTADDR_EX (pHandle: pJLevel: pLocality: pCounty: pState: pCountry: pZipBegin: pZipBeginP4: pZipEnd: pZipEndP4: pError);

Return Value

pAnswer (10U 0)

FOUND – If Last address found.

MORE – If found and more available.

NOT_FOUND

Parameters

pHandle (10I 0)

pJLevel (10I 0)

pLocality (26A)

pCounty (26A)

pState (3A)

pCountry (4A)

pZipBegin (6A)

pZipBeginP4 (5A)

pZipEnd(6A)

pZipEndP4 (5A)

pError (10I 0)

Remarks

None

E9 Version

RPG Procedure

E9_NXTADDR_EX

RPG Copy

E9NXTADDRX

Description

EZTaxNextAddressEx returns the next sequential record containing alternative address information for the specified JCode. This function can be used to obtain additional addresses for a specified jurisdiction when EZTaxGetAddressEx returns MORE, indication additional information is available. The majority of jurisdictions have more than one set of address/zip code data associated with them.

Format

E9_NXTADDR_EX (pSessionPtr: pJLevel: pLocality: pCounty: pState: pCountry: pZipBegin: pZipBeginP4: pZipEnd: pZipEndP4: pError);

Return Value

pAnswer (10U 0)

FOUND – If Last address found.

MORE – If found and more available.

NOT_FOUND

Parameters

pSessionPtr (*)

pJLevel (10I 0)

pLocality (26A)

pCounty (26A)

pState (3A)

pCountry (4A)

pZipBegin (6A)

pZipBeginP4 (5A)

pZipEnd(6A)

pZipEndP4 (5A)

pError (10I 0)

Remarks

None

EZ Version

RPG Procedure

EZ_NXTCUST_EX

RPG Copy

EZNXTCUSTX

Description

EZTaxNextCustomerEx puts the summarized taxes calculated in the customer table into a customer tax table that the client can reference AND clears out the table for the next Customer. This API is only needed in Invoice Mode.

Format

EZ_NXT_CUST_EX (pHandle: pRCJ_CODE: pRCTAX_TYPE: pRCTAX_LEVEL: pRCCALC_TYPE: pRCRATE: pRCTAX_AMOUNT: pRCTAX_DESC: pRCTV_SURCHARGE: pRCLINES: pRCLOCATIONS: pRCMAX_BASE: pRCEXCESS_TAX: pRCTOTAL_CHARGE: pRCEXEMPT_SALE: pRCMINUTES);

Return Value

pTaxCount (10I 0)

POSITIVE – All taxes have been returned.

-1 - Error occurred.

-100 - More taxes are waiting to be retrieved and arrays are full.

Parameters

pHANDLE * VALUE

pRCJ_CODE 10U 0 DIM(PCZ_ARY_MAX) 

pRCTAX_TYPE 10I 0 DIM(PCZ_ARY_MAX) 

pRCTAX_LEVEL 10I 0 DIM(PCZ_ARY_MAX) 

pRCCALC_TYPE 10I 0 DIM(PCZ_ARY_MAX) 

pRCRATE 11P 6 DIM(PCZ_ARY_MAX) 

pRCTAX_AMOUNT 8F DIM(PCZ_ARY_MAX) 

pRCTAX_DESC 100 DIM(PCZ_ARY_MAX) 

pRCTV_SURCHARGE 10I 0 DIM(PCZ_ARY_MAX) 

pRCLINES 10I 0 DIM(PCZ_ARY_MAX) 

pRCLOCATIONS 10I 0 DIM(PCZ_ARY_MAX) 

pRCMAX_BASE 16P 6 DIM(PCZ_ARY_MAX) 

pRCEXCESS_TAX 18P 6 DIM(PCZ_ARY_MAX) 

pRCTOTAL_CHARGE 8F DIM(PCZ_ARY_MAX) 

pRCEXEMPT_SALE 8F DIM(PCZ_ARY_MAX) 

pRCMINUTES 25P 4 DIM(PCZ_ARY_MAX) 

Remarks

None

E9 Version

RPG Procedure

E9_NXTCUST_EX

RPG Copy

E9NXTCUSTX

Description

EZTaxNextCustomerEx puts the summarized taxes calculated in the customer table into a customer tax table that the client can reference AND clears out the table for the next Customer. This API is only needed in Invoice Mode.

Format

E9_NXT_CUST_EX (pSESSIONPTR: pRCJ_CODE: pRCTAX_TYPE: pRCTAX_LEVEL: pRCCALC_TYPE: pRCRATE: pRCTAX_AMOUNT: pRCTAX_DESC: pRCTV_SURCHARGE: pRCLINES: pRCLOCATIONS: pRCMAX_BASE: pRCEXCESS_TAX: pRCTOTAL_CHARGE: pRCEXEMPT_SALE: pRCMINUTES: pRCBILLABLE: pRCCOMPLIANCE: pRCSURCHG_FLAG: pRMIN_BASE: pRTAX_CAT_ID: pRTAX_CAT_DESC);

Return Value

pTaxCount (10I 0)

POSITIVE – All taxes have been returned.

-1 - Error occurred.

-100 - More taxes are waiting to be retrieved and arrays are full.

Parameters

pSESSIONPTR * VALUE

pRCJ_CODE 10U 0 DIM(PCZ_ARY_MAX)

pRCTAX_TYPE 10I 0 DIM(PCZ_ARY_MAX)

pRCTAX_LEVEL 10I 0 DIM(PCZ_ARY_MAX)

pRCCALC_TYPE 10I 0 DIM(PCZ_ARY_MAX)

pRCRATE 11P 6 DIM(PCZ_ARY_MAX)

pRCTAX_AMOUNT 8F DIM(PCZ_ARY_MAX)

pRCTAX_DESC 100 DIM(PCZ_ARY_MAX)

pRCTV_SURCHARGE 10I 0 DIM(PCZ_ARY_MAX)

pRCLINES 10I 0 DIM(PCZ_ARY_MAX)

pRCLOCATIONS 10I 0 DIM(PCZ_ARY_MAX)

pRCMAX_BASE 16P 6 DIM(PCZ_ARY_MAX)

pRCEXCESS_TAX 18P 6 DIM(PCZ_ARY_MAX)

pRCTOTAL_CHARGE 8F DIM(PCZ_ARY_MAX)

pRCEXEMPT_SALE 8F DIM(PCZ_ARY_MAX)

pRCMINUTES 25P 4 DIM(PCZ_ARY_MAX)

pRCBILLABLE 10I 0 DIM(PCZ_ARY_MAX)

pRCCOMPLIANCE 10I 0 DIM(PCZ_ARY_MAX)

pRCSURCHG_FLAG 10I 0 DIM(PCZ_ARY_MAX)

pRMIN_BASE 8F DIM(PCZ_ARY_MAX)

pRTAX_CAT_ID 10I 0 DIM(PCZ_ARY_MAX)

pRTAX_CAT_DESC 100 DIM(PCZ_ARY_MAX)

Remarks

None

E9 Version

RPG Procedure

E9_NTTYPEEX

RPG Copy

E9NTTYPEEX

Description

E9_PTTYPEEX returns transaction type for a given pair of jurisdiction codes indicating whether the call is interstate or intrastate. Both jurisdictions must be within the same country. The first jurisdiction is the origination and the second is the termination. Returns 9_INV_XACTION when countries differ or an error occurs.

Format

E9_NTTYPEEX (pSessionPtr: JCode1: JCode2: Error);

Return Value

TransType (5U 0)

Parameters

pSessionPtr (* VALUE)

OrigJCode (10U 0 VALUE)

TermJCode (10U 0 VALUE)

Error (10I 0)

Remarks

There are three constants defined for use with E9_JTTYPEEX

D E9_INV_XACTION C -1

D E9_INTERSTATE C 1

D E9_INTRASTATE C 2

EZ Version

RPG Procedure

EZ_NTOJ_EX

RPG Copy

EZNTOJEX

Description

EZTaxNtoJCodeEx returns a JCode that is cross-referenced to the specified NPANXX.

Format

EZ_NTOJ_EX (pHandle: pNPANXX: pError);

Return Value

pJCode (10U 0)

Parameters

pHandle (10I 0)

pNPANXX (10U 0)

pError (10I 0)

Remarks

None

E9 Version

RPG Procedure

E9_NTOJ_EX

RPG Copy

E9NTOJEX

Description

EZTaxNtoJCodeEx returns a JCode that is cross-referenced to the specified NPANXX.

Format

E9_NTOJ_EX (pSessionPtr: pNPANXX: pError);

Return Value

pJCode (10U 0)

Parameters

pSessionPtr (*)

pNPANXX (10U 0)

pError (10I 0)

Remarks

None

EZ Version

RPG Procedure

EZ_OLDOVRJ_EX

RPG Copy

EZOLDOVRJ

Description

EZTaxOldOvrJCodeEx specifies an override for a specific tax, accepting the old override format. Tax Jurisdiction information is passed via jurisdiction code. It takes a J_Code and an override structure as input and inserts a tax override into the AFC db system.

Format

pAnswer = EZTaxOldOvrJCodeEx(hdl, j_code, scope, type, level,level_exempt, limit, date, tax, prev_tax, max_base, excess_tax, st_ovrd_tax, co_ovrd_tax, repl_st, repl_co)

Return Value

pAnswer (10U 0) –

1 = True = Override worked

0 = False = Override failed

pError (10I 0) --

-200 -- pARRY_SIZE not large enough to contain all taxes.

-201 --OVERRIDE_TAXES_TABLE_CNT_NOT_ONE_OR_MORE

-202 -- OVERRIDE_INPUT_LARGER_THAN_DEFLT_ARRY_SIZE

-203 -- OVERRIDE_CONTAINS_DUPLICATE_BRACKET_IN_RATES

-204 -- MORE_THAN_ONE_TAX_STRUCT_PASSED_TO_OVERRIDE

Parameters

pHandle (10I 0) Input 

pJ_CODE (10U 0) Input 

ooSCOPE (10U 0) Input

ooTAX_TYPE (10U 0) Input

ooTAX_LEVEL (10U 0) Input

ooLVL_EXMPT (10U 0) Input 

ooLIMIT (10U 0) Input 

ooOVR_DATE (10U 0) Input 

ooTAX_RATE (11P 6) Input 

ooPREV_TAX (11P 6) Input 

ooMAX_BASE (12P 0) Input 

ooEXCESS_TAX (11P 6) Input 

ooST_OVRDTX (11P 6) Input 

ooCO_OVRDTX (11P 6) Input 

ooREPL_ST (10U 0) Input

ooREPL_CO (10U 0) Input 

Remarks

**Please Note** The Tax Old Override will override the specific Tax_Type, Tax_Level, and date entered on the transaction.

E9 Version

RPG Procedure

E9_OLDOVRJ_EX

RPG Copy

E9OLDOVRJ

Description

EZTaxOldOvrJCodeEx specifies an override for a specific tax, accepting the old override format. Tax Jurisdiction information is passed via jurisdiction code. It takes a J_Code and an override structure as input and inserts a tax override into the EZtax db system.

Format

pAnswer = E9_OLDOVRJ_EX (pSessionPtr, pJCode, pScope, pTaxType, pTaxLevel,pLevelExempt, pLimit, pOverrideDate, pTaxRage, pPreviousTax, pMaxBase, pExcessTax, pStateOverrideTax, pCountyOverrideTax, pReplStateFlag, pReplCountyFlag)

Return Value

pAnswer (10U 0) –

1 = True = Override worked

0 = False = Override failed

pError (10I 0) --

-200 -- pARRY_SIZE not large enough to contain all taxes.

-201 --OVERRIDE_TAXES_TABLE_CNT_NOT_ONE_OR_MORE

-202 -- OVERRIDE_INPUT_LARGER_THAN_DEFLT_ARRY_SIZE

-203 --OVERRIDE_CONTAINS_DUPLICATE_BRACKET_IN_RATES

-204 -MORE_THAN_ONE_TAX_STRUCT_PASSED_TO_OVERRIDE

Parameters

pSessionPtr (*) Input 

pJ_CODE (10U 0) Input 

ooSCOPE (10U 0) Input 

ooTAX_TYPE (10U 0) Input 

ooTAX_LEVEL (10U 0) Input 

ooLVL_EXMPT (10U 0) Input 

ooLIMIT (10U 0) Input 

ooOVR_DATE (10U 0) Input 

ooTAX_RATE (11P 6) Input 

ooPREV_TAX (11P 6) Input 

ooMAX_BASE (12P 0) Input 

ooEXCESS_TAX (11P 6) Input 

ooST_OVRDTX (11P 6) Input 

ooCO_OVRDTX (11P 6) Input 

ooREPL_ST (10U 0) Input 

ooREPL_CO (10U 0) Input 

Remarks

**Please Note** The Tax Old Override will override the specific Tax_Type, Tax_Level, and date entered on the transaction.

EZ Version

RPG Procedure

EZ_OVRJCODE_EX

RPG Copy

EZOVRJCODE

Description

EZTaxOvrJCodeEx specifies an override for a specific tax. Tax Jurisdiction information is passed via jurisdiction code. It takes a J_Code and an override structure as input and inserts a tax override into the AFC db system.

Format

pAnswer = EZ_OVRJCode_EX(pHandle: JCode: taxesCnt: r_scope[200]: r_type[200]: r_level[200]: r_overrideDate[200]: r_levelExempt[200]: r_tax[200]: r_max_base[200]: r_repl_st[200]: r_st_ovrd_tax[200]: r_repl_co[200]: r_co_ovrd_tax[200]: pError);

Return Value

pAnswer (10U 0) –

1 = True = Override worked

0 = False = Override failed

pError (10I 0) --

-200 -- pARRY_SIZE not large enough to contain all taxes.

-201 --OVERRIDE_TAXES_TABLE_CNT_NOT_ONE_OR_MORE

-202 -- OVERRIDE_INPUT_LARGER_THAN_DEFLT_ARRY_SIZE

-203 -- OVERRIDE_CONTAINS_DUPLICATE_BRACKET_IN_RATES

-204 -- MORE_THAN_ONE_TAX_STRUCT_PASSED_TO_OVERRIDE

Parameters

pHandle (10I 0) Input 

pJ_CODE (10U 0) Input 

pARRY_SIZE (10I 0) Input 

rSCOPE (10I 0) [pARRY_SIZE] Input 

rTAX_TYPE (10I 0) [pARRY_SIZE] Input 

rTAX_LEVEL (10I 0) [pARRY_SIZE] Input 

rOVR_DATE (10I 0) [pARRY_SIZE] Input 

rLVL_EXMPT (10I 0) [pARRY_SIZE] Input 

rTAX_RATE (11P 6) [pARRY_SIZE] Input 

rMAX_BASE (11P 0) [pARRY_SIZE] Input 

rREPL_ST (10I 0) [pARRY_SIZE] Input 

rST_OVRDTX (11P 6) [pARRY_SIZE] Input 

rREPL_CO (10I 0) [pARRY_SIZE] Input 

rCO_OVRDTX (11P 6) [pARRY_SIZE] Input 

pERROR (10I 0) Output 

Remarks

**Please Note** The Tax Override functions in EZtax only accept one tax scope, tax level, tax type combination at a time. The net result will be the override of ONLY the first tax.

E9 Version

RPG Procedure

E9_OVRJCODE_EX

RPG Copy

E9OVRJCODE

Description

EZTaxOvrJCodeEx specifies an override for a specific tax. Tax Jurisdiction information is passed via jurisdiction code. It takes a J_Code and an override structure as input and inserts a tax override into the AFC db system.

Format

pAnswer = E9_OVRJCode_EX(pSessionPtr: JCode: taxesCnt: r_scope[200]: r_type[200]: r_level[200]: r_overrideDate[200]: r_levelExempt[200]: r_tax[200]: r_max_base[200]: r_repl_st[200]: r_st_ovrd_tax[200]: r_repl_co[200]: r_co_ovrd_tax[200]: pError);

Return Value

pAnswer (10U 0) –

1 = True = Override worked

0 = False = Override failed

pError (10I 0) --

-200 -- pARRY_SIZE not large enough to contain all taxes.

-201 --OVERRIDE_TAXES_TABLE_CNT_NOT_ONE_OR_MORE

-202 -- OVERRIDE_INPUT_LARGER_THAN_DEFLT_ARRY_SIZE

-203 -- OVERRIDE_CONTAINS_DUPLICATE_BRACKET_IN_RATES

-204 -- MORE_THAN_ONE_TAX_STRUCT_PASSED_TO_OVERRIDE

Parameters

pSessionPtr (*) Input

pJ_CODE (10U 0) Input

pARRY_SIZE (10I 0) Input

rSCOPE (10I 0) [pARRY_SIZE] Input

rTAX_TYPE (10I 0) [pARRY_SIZE] Input

rTAX_LEVEL (10I 0) [pARRY_SIZE] Input

rOVR_DATE (10I/U 0)[pARRY_SIZE] Input

rLVL_EXMPT (10I 0) [pARRY_SIZE] Input

rTAX_RATE (11P 6) [pARRY_SIZE] Input

rMAX_BASE (11P 0) [pARRY_SIZE] Input

rREPL_ST (10I 0) [pARRY_SIZE] Input

rST_OVRDTX (11P 6) [pARRY_SIZE] Input

rREPL_CO (10I 0) [pARRY_SIZE] Input

rCO_OVRDTX (11P 6) [pARRY_SIZE] Input

pERROR (10I 0) Output

Remarks

**Please Note** The Tax Override functions in AFC only accept one tax scope, tax level, tax type combination at a time. The net result will be the override of ONLY the first tax.

EZ Version

RPG Procedure

EZ_OVRNPAN_EX

RPG Copy

EZOVRNPNEX

Description

EZ_OVRNPAN_Ex specifies an override for a specific tax(One scope,tax_level,tax_type combination) for the specified NPANXX. It takes a NPANXX and a set of arrays matching the override structure as input and inserts a tax override into the AFC temporary db for that session.

Format

pAnswer = EZ_OVRNPAN_EX(pHandle: pNPANXX: taxesCnt: r_scope[200]: r_type[200]: r_level[200]: r_overrideDate[200]: r_levelExempt[200]: r_tax[200]: r_max_base[200]: r_repl_st[200]: r_st_ovrd_tax[200]: r_repl_co[200]: r_co_ovrd_tax[200]: pError);

Return Value

pAnswer (10U 0) –

1 = True = Override worked

0 = False = Override failed

pError (10I 0) --

-200 -- pARRY_SIZE not large enough to contain all taxes.

-201 --OVERRIDE_TAXES_TABLE_CNT_NOT_ONE_OR_MORE

-202 -- OVERRIDE_INPUT_LARGER_THAN_DEFLT_ARRY_SIZE

-203 -- OVERRIDE_CONTAINS_DUPLICATE_BRACKET_IN_RATES

-204 -- MORE_THAN_ONE_TAX_STRUCT_PASSED_TO_OVERRIDE

Parameters

pHandle (10I 0) Input 

pNPANXX (10U 0) Input 

pARRY_SIZE (10I 0) Input 

rSCOPE (10I 0) [pARRY_SIZE] Input 

rTAX_TYPE (10I 0) [pARRY_SIZE] Input 

rTAX_LEVEL (10I 0) [pARRY_SIZE] Input 

rOVR_DATE (10I 0) [pARRY_SIZE] Input 

rLVL_EXMPT (10I 0) [pARRY_SIZE] Input 

rTAX_RATE (11P 6) [pARRY_SIZE] Input 

rMAX_BASE (11P 0) [pARRY_SIZE] Input 

rREPL_ST (10I 0) [pARRY_SIZE] Input 

rST_OVRDTX (11P 6) [pARRY_SIZE] Input 

rREPL_CO (10I 0) [pARRY_SIZE] Input 

rCO_OVRDTX (11P 6) [pARRY_SIZE] Input 

pERROR (10I 0) Output 

Remarks

**Please Note** The Tax Override functions in AFC only accept one tax scope, tax level, tax type combination at a time. The net result will be the override of ONLY the first tax.

E9 Version

RPG Procedure

E9_OVRNPAN_EX

RPG Copy

E9OVRNPNEX

Description

EZTaxOvrNPANEx specifies an override for a specific tax(One scope,tax_level,tax_type combination) for the specified NPANXX. It takes a NPANXX and a set of arrays matching the override structure as input and inserts a tax override into the AFC temporary db for that session.

Format

pAnswer = E9_OVRNPAN_EX(pSessionPtr: pNPANXX: taxesCnt: r_scope[200]: r_type[200]: r_level[200]: r_overrideDate[200]: r_levelExempt[200]: r_tax[200]: r_max_base[200]: r_repl_st[200]: r_st_ovrd_tax[200]: r_repl_co[200]: r_co_ovrd_tax[200]: pError);

Return Value

pAnswer (10U 0) –

1 = True = Override worked

0 = False = Override failed

pError (10I 0) --

-200 -- pARRY_SIZE not large enough to contain all taxes.

-201 --OVERRIDE_TAXES_TABLE_CNT_NOT_ONE_OR_MORE

-202 -- OVERRIDE_INPUT_LARGER_THAN_DEFLT_ARRY_SIZE

-203 -- OVERRIDE_CONTAINS_DUPLICATE_BRACKET_IN_RATES

-204 -- MORE_THAN_ONE_TAX_STRUCT_PASSED_TO_OVERRIDE

Parameters

pSessionPtr (*) Input 

pNPANXX (10U 0) Input 

pARRY_SIZE (10I 0) Input 

rSCOPE (10I 0) [pARRY_SIZE] Input 

rTAX_TYPE (10I 0) [pARRY_SIZE] Input 

rTAX_LEVEL (10I 0) [pARRY_SIZE] Input 

rOVR_DATE (10I/U 0)[pARRY_SIZE] Input 

rLVL_EXMPT (10I 0) [pARRY_SIZE] Input 

rTAX_RATE (11P 6) [pARRY_SIZE] Input 

rMAX_BASE (11P 0) [pARRY_SIZE] Input 

rREPL_ST (10I 0) [pARRY_SIZE] Input 

rST_OVRDTX (11P 6) [pARRY_SIZE] Input 

rREPL_CO (10I 0) [pARRY_SIZE] Input 

rCO_OVRDTX (11P 6) [pARRY_SIZE] Input 

pERROR (10I 0) Output 

Remarks

**Please Note** The Tax Override functions in AFC only accept one tax scope, tax level, tax type combination at a time. The net result will be the override of ONLY the first tax.

EZ Version

RPG Procedure

EZ_OVRPCODE_EX

RPG Copy

EZOVRPCODE

Description

EZTaxOvrPCodeEx specifies an override for a specific tax. Tax Jurisdiction information is passed via jurisdiction code. It takes a J_Code and an override structure as input and inserts a tax override into the AFC db system.

Format

pAnswer = EZ_OVRPCode_EX(pHandle: PCode: taxesCnt: r_scope[200]: r_type[200]: r_level[200]: r_overrideDate[200]: r_levelExempt[200]: r_tax[200]: r_max_base[200]: r_repl_st[200]: r_st_ovrd_tax[200]: r_repl_co[200]: r_co_ovrd_tax[200]: pError);

Return Value

pAnswer (10U 0) –

1 = True = Override worked

0 = False = Override failed

pError (10I 0) --

-200 -- pARRY_SIZE not large enough to contain all taxes.

-201 --OVERRIDE_TAXES_TABLE_CNT_NOT_ONE_OR_MORE

-202 -- OVERRIDE_INPUT_LARGER_THAN_DEFLT_ARRY_SIZE

-203 -- OVERRIDE_CONTAINS_DUPLICATE_BRACKET_IN_RATES

-204 -- MORE_THAN_ONE_TAX_STRUCT_PASSED_TO_OVERRIDE

Parameters

pHandle (10I 0) Input 

pP_CODE (10U 0) Input 

pARRY_SIZE (10I 0) Input 

rSCOPE (10I 0) [pARRY_SIZE] Input 

rTAX_TYPE (10I 0) [pARRY_SIZE] Input 

rTAX_LEVEL (10I 0) [pARRY_SIZE] Input 

rOVR_DATE (10I 0) [pARRY_SIZE] Input 

rLVL_EXMPT (10I 0) [pARRY_SIZE] Input 

rTAX_RATE (11P 6) [pARRY_SIZE] Input 

rMAX_BASE (11P 0) [pARRY_SIZE] Input 

rREPL_ST (10I 0) [pARRY_SIZE] Input 

rST_OVRDTX (11P 6) [pARRY_SIZE] Input 

rREPL_CO (10I 0) [pARRY_SIZE] Input 

rCO_OVRDTX (11P 6) [pARRY_SIZE] Input 

pERROR (10I 0) Output 

Remarks

**Please Note** The Tax Override functions in AFC only accept one tax scope, tax level, tax type combination at a time. The net result will be the override of ONLY the first tax.

E9 Version

RPG Procedure

E9_OVRPCODE_EX

RPG Copy

E9OVRPCODE

Description

EZTaxOvrPCodeEx specifies an override for a specific tax. Tax Jurisdiction information is passed via jurisdiction code. It takes a J_Code and an override structure as input and inserts a tax override into the AFC db system.

Format

pAnswer = E9_OVRPCode_EX(pSessionPtr: PCode: taxesCnt: r_scope[200]: r_type[200]: r_level[200]: r_overrideDate[200]: r_levelExempt[200]: r_tax[200]: r_max_base[200]: r_repl_st[200]: r_st_ovrd_tax[200]: r_repl_co[200]: r_co_ovrd_tax[200]: pError);

Return Value

pAnswer (10U 0) –

1 = True = Override worked

0 = False = Override failed

pError (10I 0) --

-200 -- pARRY_SIZE not large enough to contain all taxes.

-201 --OVERRIDE_TAXES_TABLE_CNT_NOT_ONE_OR_MORE

-202 -- OVERRIDE_INPUT_LARGER_THAN_DEFLT_ARRY_SIZE

-203 -- OVERRIDE_CONTAINS_DUPLICATE_BRACKET_IN_RATES

-204 -- MORE_THAN_ONE_TAX_STRUCT_PASSED_TO_OVERRIDE

Parameters

pSessionPtr (*) Input 

pP_CODE (10U 0) Input 

pARRY_SIZE (10I 0) Input 

rSCOPE (10I 0) [pARRY_SIZE] Input 

rTAX_TYPE (10I 0) [pARRY_SIZE] Input 

rTAX_LEVEL (10I 0) [pARRY_SIZE] Input 

rOVR_DATE (10I/U 0)[pARRY_SIZE] Input 

rLVL_EXMPT (10I 0) [pARRY_SIZE] Input 

rTAX_RATE (11P 6) [pARRY_SIZE] Input 

rMAX_BASE (11P 0) [pARRY_SIZE] Input 

rREPL_ST (10I 0) [pARRY_SIZE] Input 

rST_OVRDTX (11P 6) [pARRY_SIZE] Input 

rREPL_CO (10I 0) [pARRY_SIZE] Input 

rCO_OVRDTX (11P 6) [pARRY_SIZE] Input 

pERROR (10I 0) Output 

Remarks

**Please Note** The Tax Override functions in AFC only accept one tax scope, tax level, tax type combination at a time. The net result will be the override of ONLY the first tax.

EZ Version

RPG Procedure

EZ_OVRZIP_EX

RPG Copy

EZOVRZIPEX

Description

EZ_OVRZIP_EX specifies an override for a specific tax. Tax jurisdiction information is passed via zip code and address. It takes zip code plus 4 and address information, and a set of arrays matching the override structure as input and inserts a tax override into the AFC temporary db for that session.

Format

pAnswer = EZ_OVRZIP_EX (pHandle: pEZFromZip:pEZFromZipP4: pEZFromCountry: pEZFromState: pEZFromCounty: pEZFromLocal: taxesCnt: r_scope[200]: r_type[200]: r_level[200]: r_overrideDate[200]: r_levelExempt[200]: r_tax[200]: r_max_base[200]: r_repl_st[200]: r_st_ovrd_tax[200]: r_repl_co[200]: r_co_ovrd_tax[200]: pError);

Return Value

pAnswer (10U 0) –

1 = True = Override worked

0 = False = Override failed

pError (10I 0) --

-200 -- pARRY_SIZE not large enough to contain all taxes.

-201 --OVERRIDE_TAXES_TABLE_CNT_NOT_ONE_OR_MORE

-202 -- OVERRIDE_INPUT_LARGER_THAN_DEFLT_ARRY_SIZE

-203 -- OVERRIDE_CONTAINS_DUPLICATE_BRACKET_IN_RATES

-204 -- MORE_THAN_ONE_TAX_STRUCT_PASSED_TO_OVERRIDE

Parameters

pHandle (10I 0) Input 

pzip_code (6A) Input 

pzip_p4 (5A) Input 

pcountry_ISO (4A) Input 

pstate_abv (3A) Input 

pcounty (25A) Input 

plocality (26A) Input 

pARRY_SIZE (10I 0) Input 

rSCOPE (10I 0) [pARRY_SIZE] Input 

rTAX_TYPE (10I 0) [pARRY_SIZE] Input 

rTAX_LEVEL (10I 0) [pARRY_SIZE] Input 

rOVR_DATE (10I 0) [pARRY_SIZE] Input 

rLVL_EXMPT (10I 0) [pARRY_SIZE] Input 

rTAX_RATE (11P 6) [pARRY_SIZE] Input 

rMAX_BASE (11P 0) [pARRY_SIZE] Input 

rREPL_ST (10I 0) [pARRY_SIZE] Input 

rST_OVRDTX (11P 6) [pARRY_SIZE] Input 

rREPL_CO (10I 0) [pARRY_SIZE] Input 

rCO_OVRDTX (11P 6) [pARRY_SIZE] Input 

 

pERROR (10I 0) Output

Remarks

**Please Note** The Tax Override functions in AFC only accept one tax scope, tax level, tax type combination at a time. The net result will be the override of ONLY the first tax.

E9 Version

RPG Procedure

E9_OVRZIP_EX

RPG Copy

E9OVRZIPEX

Description

E9_OVRZIP_EX specifies an override for a specific tax. Tax jurisdiction information is passed via zip code and address. It takes zip code plus 4 and address information, and a set of arrays matching the override structure as input and inserts a tax override into the AFC temporary db for that session.

Format

pAnswer = E9_OVRZIP_EX (pSessionPtr: pEZFromZip:pEZFromZipP4: pEZFromCountry: pEZFromState: pEZFromCounty: pEZFromLocal: taxesCnt: r_scope[200]: r_type[200]: r_level[200]: r_overrideDate[200]: r_levelExempt[200]: r_tax[200]: r_max_base[200]: r_repl_st[200]: r_st_ovrd_tax[200]: r_repl_co[200]: r_co_ovrd_tax[200]: pError);

Return Value

pAnswer (10U 0) –

1 = True = Override worked

0 = False = Override failed

pError (10I 0) --

-200 -- pARRY_SIZE not large enough to contain all taxes.

-201 --OVERRIDE_TAXES_TABLE_CNT_NOT_ONE_OR_MORE

-202 -- OVERRIDE_INPUT_LARGER_THAN_DEFLT_ARRY_SIZE

-203 -- OVERRIDE_CONTAINS_DUPLICATE_BRACKET_IN_RATES

-204 -- MORE_THAN_ONE_TAX_STRUCT_PASSED_TO_OVERRIDE

Parameters

pSessionPtr (*) Input 

pzip_code (6A) Input 

pzip_p4 (5A) Input 

pcountry_ISO (4A) Input 

pstate_abv (3A) Input 

pcounty (25A) Input 

plocality (26A) Input 

pARRY_SIZE (10I 0) Input 

rSCOPE (10I 0) [pARRY_SIZE] Input 

rTAX_TYPE (10I 0) [pARRY_SIZE] Input 

rTAX_LEVEL (10I 0) [pARRY_SIZE] Input 

rOVR_DATE (10I/U 0)[pARRY_SIZE] Input 

rLVL_EXMPT (10I 0) [pARRY_SIZE] Input 

rTAX_RATE (11P 6) [pARRY_SIZE] Input 

rMAX_BASE (11P 0) [pARRY_SIZE] Input 

rREPL_ST (10I 0) [pARRY_SIZE] Input 

rST_OVRDTX (11P 6) [pARRY_SIZE] Input 

rREPL_CO (10I 0) [pARRY_SIZE] Input 

rCO_OVRDTX (11P 6) [pARRY_SIZE] Input 

pERROR (10I 0) Output 

Remarks

**Please Note** The Tax Override functions in AFC only accept one tax scope, tax level, tax type combination at a time. The net result will be the override of ONLY the first tax.

EZ Version

RPG Procedure

EZ_PCODE_EX

RPG Copy

EZPCODEEX

Description

EZTaxPCodeEx accepts transaction data and performs appropriate tax calculations. If the AFC session was started with the tax log open, appropriate tax reductions are logged and will be reflected in tax reports. BTN, origination and termination information is passed using PCodes.

Format

EZ_PCODE_EX (pHandle: pBTN_PCode: pOrig_PCode: pTerm_PCode: (Generic transaction data): (Generic returned tax info): pError: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType);

Return Value

pTaxCount (10I 0)

Parameters

pHandle (10I 0)

pBTN_PCode (10U 0)

pOrig_PCode (10U 0)

pTerm_PCode (10U 0)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

Remarks

None

E9 Version

RPG Procedure

E9_PCODE_EX

RPG Copy

E9PCODEEX

Description

EZTaxPCodeEx accepts transaction data and performs appropriate tax calculations. If the AFC session was started with the tax log open, appropriate tax reductions are logged and will be reflected in tax reports. BTN, origination and termination information is passed using PCodes.

Format

E9_PCODE_EX (pSessionPtr: pBTN_PCode: pOrig_PCode: pTerm_PCode: (Generic transaction data Appendix A): (Generic returned tax info Appendix B): pError: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType); (Generic transaction data, Appendix A2): (Generic returned tax info, Appendix B2)

Return Value

pTaxCount (10I 0)

Parameters

pSessionPtr (*)

pBTN_PCode (10U 0)

pOrig_PCode (10U 0)

pTerm_PCode (10U 0)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

Generic transaction data 2: See Appendix A2

Generic returned tax info 2: See Appendix B2

Remarks

None

EZ Version

RPG Procedure

EZ_PRVLINE_EX

RPG Copy

EZPRVLINE

Description

EZTaxPrivateLine accepts a transaction in the same manner as EZ_PCODE_EX except that it accepts PointA and PointZ as pcodes and a split percentage. It performs the taxation based on the percentage to apply to each jurisdiction and returns the appropriate tax calculations. If the AFC session was started with the tax log open, tax calculations are logged and will be reflected in tax reports.

Format

EZ_ PRVLINE_EX

(pHandle: pBTN_PCode: pPointA_PCode: pPointZ_PCode: (Generic transaction data): (Generic returned tax info): pError: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline: pExemptType);

Return Value

pTaxCount (10I 0)

Parameters

pHandle (10I 0)

pPointA_PCode (10U 0)

pPointZ_PCode (10U 0)

pSplit (10P 6)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

Remarks

When both return and error code are 0, no taxes were found and there is no error.

E9 Version

RPG Procedure

E9_ PRVLINE_EX

RPG Copy

E9PRVLINE

Description

EZTaxPrivateLine accepts a transaction in the same manner as EZ_PCODE_EX except that it accepts PointA and PointZ as pcodes and a split percentage. It performs the taxation based on the percentage to apply to each jurisdiction and returns the appropriate tax calculations. If the AFC session was started with the tax log open, tax calculations are logged and will be reflected in tax reports.

Format

E9_ PRVLINE_EX (pSessionPtr: pPointA_PCode: pPointZ_PCode: pSplit: (Generic transaction data Appendix A): (Generic returned tax info Appendix B): pError: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType); (Generic transaction data, Appendix A2): (Generic returned tax info, Appendix B2)

Return Value

pTaxCount (10I 0) 

Parameters

pSessionPtr (*) 

pPointA_PCode (10U 0) 

pPointZ_PCode (10U 0) 

pSplit (10P 6) 

 

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

Generic transaction data 2: See Appendix A2

Generic returned tax info 2: See Appendix B2

Remarks

When both return and error code are 0, no taxes were found and there is no error.

EZ Version

RPG Procedure

EZ_PRO_JCODE_EX

RPG Copy

EZPRRTJCDX

Description

EZTaxProRateJCodeEx accepts transaction data and performs appropriate tax calculations with a prorated percent. If the AFC session was started with the tax log open, appropriate tax reductions are logged and will be reflected in tax reports. BTN, origination and termination information is passed using JCodes.

Format

EZ_PRO_JCODE_EX (pHandle: pBTN_JCode: pOrig_JCode: pTerm_JCode: (Generic transaction data): (Generic returned tax info): pPercent: pError: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType);

Return Value

pTaxCount (10I 0)

Parameters

pHandle (10I 0)

pBTN_JCode (10U 0)

pOrig_JCode (10U 0)

pTerm_JCode (10U 0)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pPercent (12P 6)

pError (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

Remarks

None

E9 Version

RPG Procedure

E9_PRO_JCODE_EX

RPG Copy

E9PRRTJCDX

Description

EZTaxProRateJCodeEx accepts transaction data and performs appropriate tax calculations with a prorated percent. If the AFC session was started with the tax log open, appropriate tax reductions are logged and will be reflected in tax reports. BTN, origination and termination information is passed using JCodes.

Format

E9_PRO_JCODE_EX (pSessionPtr: pBTN_JCode: pOrig_JCode: pTerm_JCode: (Generic transaction data Appendix A): (Generic returned tax info Appendix B): pPercent: pError: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType); (Generic transaction data, Appendix A2): (Generic returned tax info, Appendix B2)

Return Value

pTaxCount (10I 0) 

Parameters

pSessionPtr (*) 

pBTN_JCode (10U 0) 

pOrig_JCode (10U 0) 

pTerm_JCode (10U 0) 

 

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pPercent (12P 6)

pError (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

Generic transaction data 2: See Appendix A2

Generic returned tax info 2: See Appendix B2

Remarks

None

EZ Version

RPG Procedure

EZ_PRO_NPAN

RPG Copy

EZPRRTNPNX

Description

EZTaxProRateNPANEx accepts transaction data and performs appropriate tax calculations with a prorated percent. If the AFC session was started with the tax log open, appropriate tax reductions are logged and will be reflected in tax reports. BTN, origination and termination information is passed using NPANXXs.

Format

EZ_PRO_NPAN (pHandle: pBTN_NPAN: pOrig_NPAN: pTerm_NPAN: (Generic transaction data): (Generic returned tax info): pPercent: pError: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType);

Return Value

pTaxCount (10I 0)

Parameters

pHandle (10I 0)

pBTN_NPAN (10U 0)

pOrig_NPAN (10U 0)

pTerm_NPAN (10U 0)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pPercent (12P 6)

pError (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

Remarks

None

E9 Version

RPG Procedure

E9_PRO_NPAN

RPG Copy

E9PRRTNPNX

Description

EZTaxProRateNPANEx accepts transaction data and performs appropriate tax calculations with a prorated percent. If the AFC session was started with the tax log open, appropriate tax reductions are logged and will be reflected in tax reports. BTN, origination and termination information is passed using NPANXXs.

Format

E9_PRO_NPAN (pSessionPtr: pBTN_NPAN: pOrig_NPAN: pTerm_NPAN: (Generic transaction data Appendix A): (Generic returned tax info Appendix B): pPercent: pError: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType);

Return Value

pTaxCount (10I 0)

Parameters

pSessionPtr (*)

pBTN_NPAN (10U 0)

pOrig_NPAN (10U 0)

pTerm_NPAN (10U 0)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pPercent (12P 6)

pError (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

Generic transaction data 2: See Appendix A2

Generic returned tax info 2: See Appendix B2

Remarks

None

EZ Version

RPG Procedure

EZ_PRO_PCODE

RPG Copy

EZPRRTPCDX

Description

EZTaxProRatePCodeEx accepts transaction data and performs appropriate tax calculations with a prorated percent. If the AFC session was started with the tax log open, appropriate tax reductions are logged and will be reflected in tax reports. BTN, origination and termination information is passed using PCodes.

Format

EZ_PRO_PCODE (pHandle: pBTN_PCode: pOrig_PCode: pTerm_PCode: (Generic transaction data): (Generic returned tax info): pPercent: pError: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType);

Return Value

pTaxCount (10I 0)

Parameters

pHandle (10I 0)

pBTN_PCode (10U 0)

pOrig_PCode (10U 0)

pTerm_PCode (10U 0)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pPercent (12P 6)

pError (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

Remarks

None

E9 Version

RPG Procedure

E9_PRO_PCODE

RPG Copy

E9PRRTPCDX

Description

EZTaxProRatePCodeEx accepts transaction data and performs appropriate tax calculations with a prorated percent. If the AFC session was started with the tax log open, appropriate tax reductions are logged and will be reflected in tax reports. BTN, origination and termination information is passed using PCodes.

Format

E9_PRO_PCODE (pSessionPtr: pBTN_PCode: pOrig_PCode: pTerm_PCode: (Generic transaction data Appendix A): (Generic returned tax info Appendix B): pPercent: pError: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType); (Generic transaction data, Appendix A2): (Generic returned tax info, Appendix B2)

Return Value

pTaxCount (10I 0) 

Parameters

pSessionPtr (*) 

pBTN_PCode (10U 0) 

pOrig_PCode (10U 0) 

pTerm_PCode (10U 0) 

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pPercent (12P 6)

 

pError (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

Generic transaction data 2: See Appendix A2

Generic returned tax info 2: See Appendix B2

Remarks

None

EZ Version

RPG Procedure

EZ_PRO_THS_J

RPG Copy

EZPRTTJCDX

Description

EZTaxProRateThisJCodeEx accepts transaction data and performs appropriate tax calculations using a prorated percent. If the AFC session was started with the tax log open, appropriate tax reductions are logged and will be reflected in tax reports using the specified JCode.

Format

EZ_PRO_THS_J (pHandle: pJCode: (Generic transaction data): (Generic returned tax info): pPercent: pError: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType);

Return Value

pTaxCount (10I 0)

Parameters

pHandle (10I 0)

pJCode (10U 0)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pPercent (12P 6)

pError (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

Remarks

None

E9 Version

RPG Procedure

E9_PRO_THS_J

RPG Copy

E9PRTTJCDX

Description

EZTaxProRateThisJCodeEx accepts transaction data and performs appropriate tax calculations using a prorated percent. If the AFC session was started with the tax log open, appropriate tax reductions are logged and will be reflected in tax reports using the specified JCode.

Format

E9_PRO_THS_J (pSessionPtr: pJCode: (Generic transaction data Appendix A): (Generic returned tax info Appendix B): pPercent: pError: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType); (Generic transaction data, Appendix A2): (Generic returned tax info, Appendix B2)

Return Value

pTaxCount (10I 0)

Parameters

pSessionPtr (*)

pJCode (10U 0)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pPercent (12P 6)

pError (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

Generic transaction data 2: See Appendix A2

Generic returned tax info 2: See Appendix B2

Remarks

None

EZ Version

RPG Procedure

EZ_PRO_THS_P

RPG Copy

EZPRTTPCDX

Description

EZTaxProRateThisPCodeEx accepts transaction data and performs appropriate tax calculations with a prorated percent. If the AFC session was started with the tax log open, appropriate tax reductions are logged and will be reflected in tax reports using the specified PCode.

Format

EZ_PRO_THS_P (pHandle: pPCode: (Generic transaction data): (Generic returned tax info): pPercent: pError: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType);

Return Value

pTaxCount (10I 0)

Parameters

pHandle (10I 0)

pPCode (10U 0)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pPercent (12P 6)

pError (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

Remarks

None

E9 Version

RPG Procedure

E9_PRO_THS_P

RPG Copy

E9PRTTPCDX

Description

EZTaxProRateThisPCodeEx accepts transaction data and performs appropriate tax calculations with a prorated percent. If the AFC session was started with the tax log open, appropriate tax reductions are logged and will be reflected in tax reports using the specified PCode.

Format

E9_PRO_THS_P (pSessionPtr: pPCode: (Generic transaction data Appendix A): (Generic returned tax info Appendix B): pPercent: pError: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType); (Generic transaction data, Appendix A2): (Generic returned tax info, Appendix B2)

Return Value

pTaxCount (10I 0)

Parameters

pSessionPtr (*)

pPCode (10U 0)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pPercent (12P 6)

pError (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

Generic transaction data 2: See Appendix A2

Generic returned tax info 2: See Appendix B2

Remarks

None

EZ Version

RPG Procedure

EZ_PRO_ZIP

RPG Copy

EZPRRTZIPX

Description

EZTaxProRateZipEx accepts transaction data and performs appropriate tax calculations using a prorated percent. If the AFC session was started with the tax log open, appropriate tax reductions are logged and will be reflected in tax reports. The tax jurisdiction is specified using address information identical to EZTaxZipEx.

Format

EZ_PRO_ZIP (pHandle: pZipCode: pZipP4: pCountry: pState: pCounty: pLocality: (Generic transaction data): (Generic returned tax info): pPercent: pError: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType);

Return Value

pTaxCount (10I 0)

Parameters

pHandle (10I 0)

pZipCode (6A)

pZipP4 (5A)

pCountry (4A)

pState (3A)

pCounty (26A)

pLocality (26A)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pPercent (12P 6)

pError (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

Remarks

None

E9 Version

RPG Procedure

E9_PRO_ZIP

RPG Copy

E9PRRTZIPX

Description

EZTaxProRateZipEx accepts transaction data and performs appropriate tax calculations using a prorated percent. If the AFC session was started with the tax log open, appropriate tax reductions are logged and will be reflected in tax reports. The tax jurisdiction is specified using address information identical to EZTaxZipEx.

Format

E9_PRO_ZIP (pSessionPtr: pZipCode: pZipP4: pCountry: pState: pCounty: pLocality: (Generic transaction data Appendix A): (Generic returned tax info Appendix B): pPercent: pError: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType); (Generic transaction data, Appendix A2): (Generic returned tax info, Appendix B2)

Return Value

pTaxCount (10I 0)

Parameters

pSessionPtr (*)

pZipCode (6A)

pZipP4 (5A)

pCountry (4A)

pState (3A)

pCounty (26A)

pLocality (26A)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pPercent (12P 6)

pError (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

Generic transaction data 2: See Appendix A2

Generic returned tax info 2: See Appendix B2

Remarks

None

EZ Version

RPG Procedure

EZ_PTOF_EX

RPG Copy

EZPTOFEX

Description

EZTaxPtoFipsEx returns a FIPS code that is cross-referenced to the specified PCode.

Format

EZ_PTOF_EX (pHandle: pPCode: pError);

Return Value

pFips (11A)

Parameters

pHandle (10I 0)

pPCode (10U 0)

pError (10I 0)

Remarks

None

E9 Version

RPG Procedure

E9_PTOF_EX

RPG Copy

E9PTOFEX

Description

EZTaxPtoFipsEx returns a FIPS code that is cross-referenced to the specified PCode.

Format

E9_PTOF_EX (pSessionPtr: pPCode: pError);

Return Value

pFips (11A)

Parameters

pSessionPtr (*)

pPCode (10U 0)

pError (10I 0)

Remarks

None

EZ Version

RPG Procedure

EZ_PTOJ_EX

RPG Copy

EZPTOJEX

Description

EZTaxPtoJCodeEx returns a JCode that is cross-referenced to the specified PCode.

Format

EZ_PTOJ_EX (pHandle: pPCode: pError);

Return Value

pJCode (10U 0)

Parameters

pHandle (10I 0)

pPCode (10U 0)

pError (10I 0)

Remarks

None

E9 Version

RPG Procedure

E9_PTOJ_EX

RPG Copy

E9PTOJEX

Description

EZTaxPtoJCodeEx returns a JCode that is cross-referenced to the specified PCode.

Format

E9_PTOJ_EX (pSessionPtr: pPCode: pError);

Return Value

pJCode (10U 0)

Parameters

pSessionPtr (*)

pPCode (10U 0)

pError (10I 0)

Remarks

None

E9 Version

RPG Procedure

E9_PTTYPEEX

RPG Copy

E9PTTYPEEX

Description

E9_PTTYPEEX returns transaction type for a given pair of jurisdiction codes indicating whether the call is interstate or intrastate. Both jurisdictions must be within the same country. The first jurisdiction is the origination and the second is the termination. Returns 9_INV_XACTION when countries differ or an error occurs.

Format

E9_PTTYPEEX (pSessionPtr: PCode1: PCode2: Error);

Return Value

TransType (5U 0)

Parameters

pSessionPtr (* VALUE)

OrigPCode (10U 0 VALUE)

TermPCode (10U 0 VALUE)

Error (10I 0)

Remarks

There are three constants defined for use with E9_JTTYPEEX

D E9_INV_XACTION C -1

D E9_INTERSTATE C 1

D E9_INTRASTATE C 2

EZ Version

RPG Procedure

EZ_REVJCODE

RPG Copy

EZREVJCODE

Description

EZTaxRevJCode accepts transaction data with the gross amount charged the customer in the charge amount and performs a tax inclusive calculation to arrive at the base sales amount. The desired total (charge plus all taxes) is placed in the ‘charge’ field in the transaction, and base charge necessary to generate that total is returned in the ‘base_sale’ parameter. Taxes for the desired transaction are returned in the same manner as EZTaxJCodeEx does. If the AFC session was started with the tax log open, tax calculations are logged and will be reflected in tax reports. BTN, origination and termination information is passed using JCodes.

Format

EZ_REVJCODE (pHandle: pBTN_JCode: pOrig_JCode: pTerm_JCode: (Generic transaction data): (Generic returned tax info): pError: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType: pBaseSale);

Return Value

pTaxCount (10I 0)

Parameters

pHandle (10I 0)

pBTN_JCode (10U 0)

pOrig_JCode (10U 0)

pTerm_JCode (10U 0)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

pBaseSale (12P 6)

Remarks

None

E9 Version

RPG Procedure

E9_REVJCODE

RPG Copy

E9REVJCODE

Description

EZTaxRevJCode accepts transaction data with the gross amount charged the customer in the charge amount and performs a tax inclusive calculation to arrive at the base sales amount. The desired total (charge plus all taxes) is placed in the ‘charge’ field in the transaction, and base charge necessary to generate that total is returned in the ‘base_sale’ parameter. Taxes for the desired transaction are returned in the same manner as EZTaxJCodeEx does. If the AFC session was started with the tax log open, tax calculations are logged and will be reflected in tax reports. BTN, origination and termination information is passed using JCodes.

Note: Tax inclusive calculations only handle charges up to $10M.

Format

E9_REVJCODE (pSessionPtr: pBTN_JCode: pOrig_JCode: pTerm_JCode: (Generic transaction data Appendix A): (Generic returned tax info Appendix B): pError: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType: pBaseSale); (Generic transaction data, Appendix A2): (Generic returned tax info, Appendix B2)

Return Value

pTaxCount (10I 0)

Parameters

pSessionPtr (*)

pBTN_JCode (10U 0)

pOrig_JCode (10U 0)

pTerm_JCode (10U 0)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

pBaseSale (12P 6)

Generic transaction data 2: See Appendix A2

Generic returned tax info 2: See Appendix B2

Remarks

None

EZ Version

RPG Procedure

EZ_REVNPAN

RPG Copy

EZREVNPAN

Description

EZTaxRevNPAN accepts transaction data with the gross amount charged the customer in the charge amount and performs a tax inclusive calculation to arrive at the base sales amount. The desired total (charge plus all taxes) is placed in the ‘charge’ field in the transaction, and base charge necessary to generate that total is returned in the ‘base_sale’ parameter. Taxes for the desired transaction are returned in the same manner as EZTaxNPANEx does. If the AFC session was started with the tax log open, tax calculations are logged and will be reflected in tax reports. BTN, origination and termination information is passed using NPANs.

Format

EZ_REVNPAN (pHandle: pBTN_NPAN: pOrig_NPAN: pTerm_NPAN: (Generic transaction data): (Generic returned tax info): pError: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType: pBaseSale);

Return Value

pTaxCount (10I 0)

Parameters

pHandle (10I 0)

pBTN_NPAN (10U 0)

pOrig_NPAN (10U 0)

pTerm_NPAN (10U 0)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

pBaseSale (12P 6)

Remarks

None

E9 Version

RPG Procedure

E9_REVNPAN

RPG Copy E9REVNPAN

Description

EZTaxRevNPAN accepts transaction data with the gross amount charged the customer in the charge amount and performs a tax inclusive calculation to arrive at the base sales amount. The desired total (charge plus all taxes) is placed in the ‘charge’ field in the transaction, and base charge necessary to generate that total is returned in the ‘base_sale’ parameter. Taxes for the desired transaction are returned in the same manner as EZTaxNPANEx does. If the AFC session was started with the tax log open, tax calculations are logged and will be reflected in tax reports. BTN, origination and termination information is passed using NPANs.

Note: Tax inclusive calculations only handle charges up to $10M.

Format

E9_REVNPAN (pSessionPtr: pBTN_NPAN: pOrig_NPAN: pTerm_NPAN: (Generic transaction data Appendix A): (Generic returned tax info Appendix B): pError: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType: pBaseSale); (Generic transaction data, Appendix A2): (Generic returned tax info, Appendix B2)

Return Value

pTaxCount (10I 0)

Parameters

pSessionPtr (*)

pBTN_NPAN (10U 0)

pOrig_NPAN (10U 0)

pTerm_NPAN (10U 0)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

pBaseSale (12P 6)

Generic transaction data 2: See Appendix A2

Generic returned tax info 2: See Appendix B2

Remarks

None

EZ Version

RPG Procedure

EZ_REVPCODE

RPG Copy

EZREVPCODE

Description

EZTaxRevPCODE accepts transaction data with the gross amount charged the customer in the charge amount and performs a tax inclusive calculation to arrive at the base sales amount. The desired total (charge plus all taxes) is placed in the ‘charge’ field in the transaction, and base charge necessary to generate that total is returned in the ‘base_sale’ parameter. Taxes for the desired transaction are returned in the same manner as EZTaxPCODEEx does. If the AFC session was started with the tax log open, tax calculations are logged and will be reflected in tax reports. BTN, origination and termination information is passed using PCODEs.

Format

EZ_ REVPCODE (pHandle: pBTN_PCODE: pOrig_PCODE: pTerm_PCODE: (Generic transaction data): (Generic returned tax info): pError: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType: pBaseSale);

Return Value

pTaxCount (10I 0)

Parameters

pHandle (10I 0)

pBTN_PCODE (10U 0)

pOrig_PCODE (10U 0)

pTerm_PCODE (10U 0)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

pBaseSale (12P 6)

Remarks

None

E9 Version

RPG Procedure

E9_REVPCODE

RPG Copy

E9REVPCODE

Description

EZTaxRevPCODE accepts transaction data with the gross amount charged the customer in the charge amount and performs a tax inclusive calculation to arrive at the base sales amount. The desired total (charge plus all taxes) is placed in the ‘charge’ field in the transaction, and base charge necessary to generate that total is returned in the ‘base_sale’ parameter. Taxes for the desired transaction are returned in the same manner as EZTaxPCODEEx does. If the AFC session was started with the tax log open, tax calculations are logged and will be reflected in tax reports. BTN, origination and termination information is passed using PCODEs.

Note: Tax inclusive calculations only handle charges up to $10M.

Format

E9_ REVPCODE (pSessionPtr: pBTN_PCODE: pOrig_PCODE: pTerm_PCODE: (Generic transaction data Appendix A): (Generic returned tax info Appendix B): pError: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType: pBaseSale); (Generic transaction data, Appendix A2): (Generic returned tax info, Appendix B2)

Return Value

pTaxCount (10I 0)

Parameters

pSessionPtr (*)

pBTN_PCODE (10U 0)

pOrig_PCODE (10U 0)

pTerm_PCODE (10U 0)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

pBaseSale (12P 6)

Generic transaction data 2: See Appendix A2

Generic returned tax info 2: See Appendix B2

Remarks

None

EZ Version

RPG Procedure

EZ_REVZIP

RPG Copy

EZREVZIP

Description

EZTaxRevZIP accepts transaction data with the gross amount charged the customer in the charge amount and performs a tax inclusive calculation to arrive at the base sales amount. The desired total (charge plus all taxes) is placed in the ‘charge’ field in the transaction, and base charge necessary to generate that total is returned in the ‘base_sale’ parameter. Taxes for the desired transaction are returned in the same manner as EZTaxZIPEx does. If the AFC session was started with the tax log open, tax calculations are logged and will be reflected in tax reports. BTN, origination and termination information is passed using ZIPs.

Format

EZ_REVZIP (pHandle: pZip: pZipP4: pCountry: pState: pCounty: pLocality: (Generic transaction data): (Generic returned tax info): pError: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType: pBaseSale);

Return Value

pTaxCount (10I 0)

Parameters

pHandle (10I 0)

pZip (6A)

pZipP4 (5A)

pCountry (4A)

pState (3A)

pCounty (26A)

pLocality (26A)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

pBaseSale (12P 6)

Remarks

None

E9 Version

RPG Procedure

E9_REVZIP

RPG Copy

E9REVZIP

Description

EZTaxRevZIP accepts transaction data with the gross amount charged the customer in the charge amount and performs a tax inclusive calculation to arrive at the base sales amount. The desired total (charge plus all taxes) is placed in the ‘charge’ field in the transaction, and base charge necessary to generate that total is returned in the ‘base_sale’ parameter. Taxes for the desired transaction are returned in the same manner as EZTaxZIPEx does. If the AFC session was started with the tax log open, tax calculations are logged and will be reflected in tax reports. BTN, origination and termination information is passed using ZIPs.

Note: Tax inclusive calculations only handle charges up to $10M.

Format

E9_REVZIP (pSessionPtr: pZip: pZipP4: pCountry: pState: pCounty: pLocality: (Generic transaction data Appendix A): (Generic returned tax info Appendix B): pError: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType: pBaseSale); (Generic transaction data, Appendix A2): (Generic returned tax info, Appendix B2)

Return Value

pTaxCount (10I 0)

Parameters

pSessionPtr (*)

pZip (6A)

pZipP4 (5A)

pCountry (4A)

pState (3A)

pCounty (26A)

pLocality (26A)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

pBaseSale (12P 6)

Generic transaction data 2: See Appendix A2

Generic returned tax info 2: See Appendix B2

Remarks

None

EZ Version

RPG Procedure

EZRESTOREX

RPG Copy

EZRESTOREX.RPGLE

Description

EZTaxRestorex removes all overrides that have been inserted by the user, into the AFC databases. This action occurs automatically on EZTaxExit. This function provides the user with the ability to remove prior overrides without terminating an AFC session.

Format

EZ_RESTORE_EX (pHandle);

Return Value

pAnswer (10I 0)–

TRUE – Successful

FALSE - Failure

Parameters

pHandle (10I 0)

Remarks

None

E9 Version

RPG Procedure

E9RESTOREX

RPG Copy

E9RESTOREX

Description

EZTaxRestorex removes all overrides that have been inserted by the user, into the AFC databases. This action occurs automatically on EZTaxExit. This function provides the user with the ability to remove prior overrides without terminating an AFC session.

Format

E9_RESTORE_EX (pSessionPtr);

Return Value

pAnswer (10I 0)–

TRUE – Successful

FALSE - Failure

Parameters

pSessionPtr (*)

Remarks

None

EZ Version

RPG Procedure

EZ_TXIJCODE

RPG Copy

EZTXIJCODE

Description

EZTaxTxiJCode accepts transaction data with the gross amount charged the customer in the charge amount and performs a tax inclusive calculation to arrive at the base sales amount. The desired total (charge plus all taxes) is placed in the ‘charge’ field in the transaction, and base charge necessary to generate that total is returned in the ‘base_sale’ parameter. Taxes for the desired transaction are returned in the same manner as EZTaxJCodeEx does. If the AFC session was started with the tax log open, tax calculations are logged and will be reflected in tax reports. BTN, origination and termination information is passed using JCodes.

Format

EZ_TXIJCODE (pHandle: pBTN_JCode: pOrig_JCode: pTerm_JCode: (Generic transaction data): (Generic returned tax info): pError: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType: pBaseSale);

Return Value

pTaxCount (10I 0)

Parameters

pHandle (10I 0)

pBTN_JCode (10U 0)

pOrig_JCode (10U 0)

pTerm_JCode (10U 0)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

pBaseSale (12P 6)

Remarks

None

E9 Version

RPG Procedure

E9_TXIJCODE

RPG Copy

E9TXIJCODE

Description

EZTaxTxiJCode accepts transaction data with the gross amount charged the customer in the charge amount and performs a tax inclusive calculation to arrive at the base sales amount. The desired total (charge plus all taxes) is placed in the ‘charge’ field in the transaction, and base charge necessary to generate that total is returned in the ‘base_sale’ parameter. Taxes for the desired transaction are returned in the same manner as EZTaxJCodeEx does. If the AFC session was started with the tax log open, tax calculations are logged and will be reflected in tax reports. BTN, origination and termination information is passed using JCodes.

Note: Tax inclusive calculations only handle charges up to $10M.

Format

E9_TXIJCODE (pSessionPtr: pBTN_JCode: pOrig_JCode: pTerm_JCode: (Generic transaction data Appendix A): (Generic returned tax info Appendix B): pError: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType: pBaseSale); (Generic transaction data, Appendix A2): (Generic returned tax info, Appendix B2)

Return Value

pTaxCount (10I 0)

Parameters

pSessionPtr (*)

pBTN_JCode (10U 0)

pOrig_JCode (10U 0)

pTerm_JCode (10U 0)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

pBaseSale (12P 6)

Generic transaction data 2: See Appendix A2

Generic returned tax info 2: See Appendix B2

Remarks

None

EZ Version

RPG Procedure

EZ_TXINPAN

RPG Copy

EZTXINPAN

Description

EZTaxTxiNPAN accepts transaction data with the gross amount charged the customer in the charge amount and performs a tax inclusive calculation to arrive at the base sales amount. The desired total (charge plus all taxes) is placed in the ‘charge’ field in the transaction, and base charge necessary to generate that total is returned in the ‘base_sale’ parameter. Taxes for the desired transaction are returned in the same manner as EZTaxNPANEx does. If the AFC session was started with the tax log open, tax calculations are logged and will be reflected in tax reports. BTN, origination and termination information is passed using NPANs.

Format

EZ_TXINPAN (pHandle: pBTN_NPAN: pOrig_NPAN: pTerm_NPAN: (Generic transaction data): (Generic returned tax info): pError: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType: pBaseSale);

Return Value

pTaxCount (10I 0)

Parameters

pHandle (10I 0)

pBTN_NPAN (10U 0)

pOrig_NPAN (10U 0)

pTerm_NPAN (10U 0)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

pBaseSale (12P 6)

Remarks

None

E9 Version

RPG Procedure

E9_TXINPAN

RPG Copy

E9TXINPAN

Description

EZTaxTxiNPAN accepts transaction data with the gross amount charged the customer in the charge amount and performs a tax inclusive calculation to arrive at the base sales amount. The desired total (charge plus all taxes) is placed in the ‘charge’ field in the transaction, and base charge necessary to generate that total is returned in the ‘base_sale’ parameter. Taxes for the desired transaction are returned in the same manner as EZTaxNPANEx does. If the AFC session was started with the tax log open, tax calculations are logged and will be reflected in tax reports. BTN, origination and termination information is passed using NPANs.

Note: Tax inclusive calculations only handle charges up to $10M.

Format

E9_TXINPAN (pSessionPtr: pBTN_NPAN: pOrig_NPAN: pTerm_NPAN: (Generic transaction data Appendix A): (Generic returned tax info Appendix B): pError: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType: pBaseSale); (Generic transaction data, Appendix A2): (Generic returned tax info, Appendix B2)

Return Value

pTaxCount (10I 0)

Parameters

pSessionPtr (*)

pBTN_NPAN (10U 0)

pOrig_NPAN (10U 0)

pTerm_NPAN (10U 0)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

pBaseSale (12P 6)

Generic transaction data 2: See Appendix A2

Generic returned tax info 2: See Appendix B2

Remarks

None

EZ Version

RPG Procedure

EZ_TXIPCODE

RPG Copy

EZTXIPCODE

Description

EZTaxTxiPCODE accepts transaction data with the gross amount charged the customer in the charge amount and performs a tax inclusive calculation to arrive at the base sales amount. The desired total (charge plus all taxes) is placed in the ‘charge’ field in the transaction, and base charge necessary to generate that total is returned in the ‘base_sale’ parameter. Taxes for the desired transaction are returned in the same manner as EZTaxPCODEEx does. If the AFC session was started with the tax log open, tax calculations are logged and will be reflected in tax reports. BTN, origination and termination information is passed using PCODEs.

Format

EZ_ TXIPCODE (pHandle: pBTN_PCODE: pOrig_PCODE: pTerm_PCODE: (Generic transaction data): (Generic returned tax info): pError: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType: pBaseSale);

Return Value

pTaxCount (10I 0)

Parameters

pHandle (10I 0)

pBTN_PCODE (10U 0)

pOrig_PCODE (10U 0)

pTerm_PCODE (10U 0)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

pBaseSale (12P 6)

Remarks

None

E9 Version

RPG Procedure

E9_TXIPCODE

RPG Copy

E9TXIPCODE

Description

EZTaxTxiPCODE accepts transaction data with the gross amount charged the customer in the charge amount and performs a tax inclusive calculation to arrive at the base sales amount. The desired total (charge plus all taxes) is placed in the ‘charge’ field in the transaction, and base charge necessary to generate that total is returned in the ‘base_sale’ parameter. Taxes for the desired transaction are returned in the same manner as EZTaxPCODEEx does. If the AFC session was started with the tax log open, tax calculations are logged and will be reflected in tax reports. BTN, origination and termination information is passed using PCODEs.

Note: Tax inclusive calculations only handle charges up to $10M.

Format

E9_ TXIPCODE (pSessionPtr: pBTN_PCODE: pOrig_PCODE: pTerm_PCODE: (Generic transaction data Appendix A): (Generic returned tax info Appendix B): pError: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType: pBaseSale); (Generic transaction data, Appendix A2): (Generic returned tax info, Appendix B2)

Return Value

pTaxCount (10I 0)

Parameters

pSessionPtr (*)

pBTN_PCODE (10U 0)

pOrig_PCODE (10U 0)

pTerm_PCODE (10U 0)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

pBaseSale (12P 6)

Generic transaction data 2: See Appendix A2

Generic returned tax info 2: See Appendix B2

Remarks

None

EZ Version

RPG Procedure

EZ_TXIZIP

RPG Copy

EZTXIZIP

Description

EZTaxTxiZIP accepts transaction data with the gross amount charged the customer in the charge amount and performs a tax inclusive calculation to arrive at the base sales amount. The desired total (charge plus all taxes) is placed in the ‘charge’ field in the transaction, and base charge necessary to generate that total is returned in the ‘base_sale’ parameter. Taxes for the desired transaction are returned in the same manner as EZTaxZIPEx does. If the AFC session was started with the tax log open, tax calculations are logged and will be reflected in tax reports. BTN, origination and termination information is passed using ZIPs.

Format

EZ_TXIZIP (pHandle: pZip: pZipP4: pCountry: pState: pCounty: pLocality: (Generic transaction data): (Generic returned tax info): pError: pBusClass: pSrvClass: pFacilities: pFranchise: pLifeline pExemptType: pBaseSale);

Return Value

pTaxCount (10I 0)

Parameters

pHandle (10I 0)

pZip (6A)

pZipP4 (5A)

pCountry (4A)

pState (3A)

pCounty (26A)

pLocality (26A)

Generic transaction data: See Appendix A

Generic returned tax info: See Appendix B

pError (10I 0)

pBusClass (10I 0)

pSrvClass (10I 0)

pFacilities (10I 0)

pFranchise (10I 0)

pLifeLine (10I 0)

pExemptType (10I 0)

pBaseSale (12P 6)

Remarks

None