Commission Plan EConnect Node Ref18

Download as pdf or txt
Download as pdf or txt
You are on page 1of 10

Commission Plan eConnect

Node Reference
For Dynamics GP
Contents
<ETI_CP_taSopHdrIntegrationDelete> ......................................................................................................... 1
Usage Example .......................................................................................................................................... 1
XML ....................................................................................................................................................... 1
SQL ........................................................................................................................................................ 1
<ETI_CP_taSopHdrIntegrationInsert> ........................................................................................................... 2
Usage Example .......................................................................................................................................... 3
XML ....................................................................................................................................................... 3
SQL ........................................................................................................................................................ 3
<ETI_CP_taSopLineIntegrationDelete> ......................................................................................................... 4
Usage Example .......................................................................................................................................... 4
XML ....................................................................................................................................................... 4
SQL ........................................................................................................................................................ 4
<ETI_CP_taSopLineIntegrationInsert> .......................................................................................................... 5
Usage Example .......................................................................................................................................... 7
XML ....................................................................................................................................................... 7
SQL ........................................................................................................................................................ 7
Error Code Descriptions ................................................................................................................................ 8
SQL ............................................................................................................................................................ 8

i
<ETI_CP_taSopHdrIntegrationDelete>
Deletes an integration header record and all associated integration line records. When used in
conjunction with Dynamics GP eConnect nodes to delete a sales document, we recommend that you call
this node after node <taSopDeleteDocument>. When used in conjunction with Dynamics GP eConnect
nodes to void a sales document, EthoTech recommends that you call this node after node
<taSopVoidDocument>.

Element name Data type Length Required Default Description


SOPTYPE i4 2 Y Not 1=Quote;
applicable 2=Order;
3=Invoice;
4=Return;
5=Back order;
6=Fulfillment orders
SOPNUMBE string 21 Y Not Invoice number
applicable
SLPRSNID string 15 Y Not Salesperson ID
applicable

Usage Example
Delete an integration header record for sales invoice number STDINV2263, salesperson ERIN J.

XML
<ETI_CP_taSopHdrIntegrationDelete>
<SOPTYPE>3</SOPTYPE>
<SOPNUMBE>STDINV2263</SOPNUMBE>
<SLPRSNID>ERIN J.</SLPRSNID>
</ETI_CP_taSopHdrIntegrationDelete>

SQL
DECLARE @ErrState INT, @ErrString VARCHAR(255)

EXEC ETI_CP_taSopHdrIntegrationDelete 3, 'STDINV2263', 'ERIN J.', @ErrState OUTPUT, @ErrString


OUTPUT

SELECT 'Return Status' = @ErrState, 'Errors' = @ErrString

1
<ETI_CP_taSopHdrIntegrationInsert>
Inserts an integration header record. Set the CommAllSopLines element to 1 if the salesperson should
receive commission for all sales document lines and no commission line values need to be overridden.
When used in conjunction with Dynamics GP eConnect nodes to integrate a sales document, EthoTech
recommends that you call this node after node <taSopHdrIvcInsert>.

Element name Data type Length Required Default Description


SOPTYPE i4 2 Y Not 1=Quote;
applicable 2=Order;
3=Invoice;
4=Return;
5=Back order;
6=Fulfillment orders
SOPNUMBE string 21 Y Not Invoice number
applicable
SLPRSNID string 15 Y Not Salesperson ID
applicable
VerifySopHdr i1 1 N 0 Flag to insert commission integration
header only if associated sop header
record exists in table SOP10100 or
SOP30200:
0=do not verify;
1=verify
CommAllSopLines i1 1 N 0 Flag to autocreate commissions for each
sop line for this sop header and
salesperson:
0=Manual;
1=Automatic—use if not calling node
<ETI_CP_taSopLineIntegrationInsert>
Split i2 2 N 10000 Reduction / increase percentage of the
normally calculated commission:
10000=100%;
5555=55.55%;
0=0%, resulting in a zero dollar
commission
RolldownSplit i1 1 N 0 Determines whether the Split affects the
commission header or each commission
line:
0 = Split affects the commission header—
use if calling node
<ETI_CP_taSopLineIntegrationInsert> with
different line item splits;
1=Split % affects each commission line
OverrideSalesPlan i1 1 N 0 Flag to override the Salesperson Plan
determined by Commission Plan:
0=do not override;
1=override

2
SalesPlan String 15 N <blank> Salesperson Plan—enter a value if
OverrideSalesPlan=1
OverrideCustPlan i1 1 N 0 Flag to override the Customer Plan
determined by Commission Plan:
0=do not override;
1=override
CustPlan String 15 N <blank> Customer Plan—enter a value if
OverrideCustPlan=1
UpdateIfExists i2 2 N 0 Used to modify integration header:
0=New integration header;
1=Update header—used to update after
integration header record exists

Usage Example
Insert a new integration header record for sales invoice number STDINV2263, salesperson ERIN J.,
commissioning all sop lines, with a split of 50.25% rolled down to each commission lines, using the
salesperson & customer plans determined by Commission Plan.

XML
<ETI_CP_taSopHdrIntegrationInsert>
<SOPTYPE>3</SOPTYPE>
<SOPNUMBE>STDINV2263</SOPNUMBE>
<SLPRSNID>ERIN J.</SLPRSNID>
<CommAllSopLines>1</CommAllSopLines>
<Split>5025</Split>
<RolldownSplit>1</RolldownSplit>
</ETI_CP_taSopHdrIntegrationInsert>

SQL
DECLARE @ErrState INT, @ErrString VARCHAR(255)

EXEC ETI_CP_taSopHdrIntegrationInsert 3, 'STDINV2263', 'ERIN J.', DEFAULT, 1, 5025, 1, DEFAULT,


DEFAULT, DEFAULT, DEFAULT, DEFAULT, @ErrState OUTPUT, @ErrString OUTPUT

SELECT 'Return Status' = @ErrState, 'Errors' = @ErrString

3
<ETI_CP_taSopLineIntegrationDelete>
Deletes an integration line record. When used in conjunction with Dynamics GP eConnect nodes to
delete a sales document line, EthoTech recommends that you call this node after node
<taSopLineDelete>.

Element name Data type Length Required Default Description


SOPTYPE i4 2 Y Not 1=Quote;
applicable 2=Order;
3=Invoice;
4=Return;
5=Back order;
6=Fulfillment orders
SOPNUMBE string 21 Y Not Invoice number
applicable
SLPRSNID string 15 Y Not Salesperson ID
applicable
LNITMSEQ i4 4 Y Not Line Sequence
applicable

Usage Example
Delete an integration header record for sales invoice number STDINV2263, salesperson ERIN J., line
sequence 16384.

XML
<ETI_CP_taSopLineIntegrationDelete>
<SOPTYPE>3</SOPTYPE>
<SOPNUMBE>STDINV2263</SOPNUMBE>
<SLPRSNID>ERIN J.</SLPRSNID>
<LNITMSEQ>16384</LNITMSEQ>
</ETI_CP_taSopLineIntegrationDelete>

SQL
DECLARE @ErrState INT, @ErrString VARCHAR(255)

EXEC ETI_CP_taSopLineIntegrationDelete 3, 'STDINV2263', 'ERIN J.', 16384, @ErrState OUTPUT,


@ErrString OUTPUT

SELECT 'Return Status' = @ErrState, 'Errors' = @ErrString

4
<ETI_CP_taSopLineIntegrationInsert>
Inserts an integration header record. This node does not need to be called if node
<ETI_CP_taSopHdrIntegrationInsert> is called with the CommAllSopLines element set to 1. When used in
conjunction with Dynamics GP eConnect nodes to integrate a sales document, EthoTech recommends
that you call this node after node <taSopLineIvcInsert>.

Element name Data type Length Required Default Description


SOPTYPE i4 2 Y Not 1=Quote;
applicable 2=Order;
3=Invoice;
4=Return;
5=Back order;
6=Fulfillment orders
SOPNUMBE string 21 Y Not Invoice number
applicable
SLPRSNID string 15 Y Not Salesperson ID
applicable
LNITMSEQ i4 4 Y Not Line Sequence—must match associated
applicable sop line sequence
VerifySopLine i1 1 N 0 Flag to insert commission integration
header only if associated sop line record
exists in table SOP10200 or SOP30300:
0=do not verify;
1=verify
VerifyIntegrationHdr i1 1 N 0 Flag to insert commission integration
header only if associated integration
header record exists in table ETI28305:
0=do not verify;
1=verify
CreateCommLine i1 1 N 1 Flag to create commission for this sop line
and salesperson:
0=not commissionable;
1=commissionable
Split i1 2 N 10000 Reduction / increase percentage of the
normally calculated commission:
10000=100%;
5555=55.55%;
0=0%, resulting in a zero dollar
commission
Note: this value will be overridden by the
Split value from node
<ETI_CP_taSopHdrIntegrationInsert>
if that node’s RolldownSplit=1
OverrideCommSaleAmt i1 1 N 0 Flag to override the Commissionable Sale
Amount determined by Commission Plan:
0=do not override;
1=override

5
CommSaleAmt number 21 N 0 Sop line unit commissionable sale
amount—enter a value if
OverrideCommSaleAmt=1
OverrideCommCostAmt i1 1 N 0 Flag to override the Commissionable Cost
Amount determined by Commission Plan:
0=do not override;
1=override
CommCostAmt number 21 N 0 Sop line unit commissionable cost
amount—enter a value if
OverrideCommCostAmt=1
OverrideCommRate i1 1 N 0 Flag to override the Commission Type and
Rate determined by Commission Plan:
0=do not override;
1=override
CommType i2 2 N 0 Commission Type—enter a value if
OverrideCommRate=1:
1=no commission
2=% of margin amount
3= % of sale amount
4=flat amount
5=amount per selling unit of measure
6=amount per base unit of measure
CommRatePct i2 2 N 0 Commission Rate %—enter a value if
OverrideCommRate=1 and CommType =2
or 3:
10000=100%;
5555=55.55%;
0=0%
CommRateAmt number 21 N 0 Commission Rate Amount—enter a value
if OverrideCommRate=1 and CommType
=4, 5, or 6
OverrideSalesPlan i1 1 N 0 Flag to override the Salesperson Plan
determined by Commission Plan:
0=do not override;
1=override
SalesPlan String 15 N <blank> Salesperson Plan—enter a value if
OverrideSalesPlan=1
OverrideItemPlan i1 1 N 0 Flag to override the Item Plan determined
by Commission Plan:
0=do not override;
1=override
ItemPlan String 15 N <blank> Item Plan—enter a value if
OverrideItemPlan=1
UpdateIfExists i2 1 N 0 Used to modify integration line:
0=New integration line;
1=Update line—used to update after
integration line record exists

6
Usage Example
Insert a new integration line record for sales invoice number STDINV2263, salesperson ERIN J., line
sequence 16384, with a split of 75.75%, using the commissionable sale & cost amounts, commission
type & rate, and salesperson & customer plans determined by Commission Plan.

XML
<ETI_CP_taSopLineIntegrationInsert>
<SOPTYPE>3</SOPTYPE>
<SOPNUMBE>STDINV2263</SOPNUMBE>
<SLPRSNID>ERIN J.</SLPRSNID>
<LNITMSEQ>16384</LNITMSEQ>
<Split>7575</Split>
</ETI_CP_taSopLineIntegrationInsert>

SQL
DECLARE @ErrState INT, @ErrString VARCHAR(255)

EXEC ETI_CP_taSopLineIntegrationInsert 3, 'STDINV2263', 'ERIN J.', 16384, DEFAULT, DEFAULT, DEFAULT,


7575, DEFAULT, DEFAULT, DEFAULT, DEFAULT, DEFAULT, DEFAULT, DEFAULT, DEFAULT, DEFAULT,
DEFAULT, DEFAULT, DEFAULT, DEFAULT, @ErrState OUTPUT, @ErrString OUTPUT

SELECT 'Return Status' = @ErrState, 'Errors' = @ErrString

7
Error Code Descriptions
The error code descriptions for each Commission Plan EConnect node can be found in table taErrorCode
in the Dynamics GP system database.

SQL
SELECT * FROM taErrorCode WHERE SourceProc LIKE 'ETI_CP_ta%' ORDER BY SourceProc, ErrorCode

You might also like