Element name |
Data type |
Length |
Required |
Default |
Description |
---|---|---|---|---|---|
SOPTYPE |
i4 |
2 |
Y |
Not applicable |
1=Quote; 2=Order; 3=Invoice; 4=Return; 5=Back order; 6=Fulfillment orders |
DOCID |
string |
15 |
Y |
Not applicable |
Document ID |
SOPNUMBE |
string |
21 |
Y |
Not applicable |
Invoice number |
ORIGNUMB |
string |
20 |
N |
<blank> |
Order number |
ORIGTYPE |
i4 |
2 |
N |
0 |
Document type of the originating SOP number |
TAXSCHID |
string |
15 |
N |
<blank> |
Tax schedule |
FRTSCHID |
string |
15 |
N |
<blank> |
Freight tax schedule |
MSCSCHID |
string |
15 |
N |
<blank> |
Miscellaneous tax schedule |
SHIPMTHD |
string |
15 |
N |
Default from setup |
Shipping method |
TAXAMNT |
number |
21 |
N |
0 |
Tax amount |
LOCNCODE |
string |
10 |
N |
<blank> |
Location code |
DOCDATE |
datetime |
16 |
Y |
Not applicable |
Document date |
FREIGHT |
number |
21 |
N |
0 |
Freight amount |
MISCAMNT |
number |
21 |
N |
0 |
Miscellaneous amount |
TRDISAMT |
number |
21 |
N |
Default from setup |
Trade discount amount |
TRADEPCT |
number |
21 |
N |
Default from setup |
Trade discount percentage |
DISTKNAM |
number |
21 |
N |
0 |
Discount taken amount—cannot be larger then discount available amount |
MRKDNAMT |
number |
21 |
N |
0 |
Markdown amount |
CUSTNMBR |
string |
15 |
Y |
Not applicable |
Customer number |
CUSTNAME |
string |
64 |
N |
<blank> |
Customer name |
CSTPONBR |
string |
20 |
N |
<blank> |
Customer purchase order number |
ShipToName |
string |
64 |
N |
<blank> |
Ship to name |
ADDRESS1 |
string |
60 |
N |
<blank> |
Customer address one |
ADDRESS2 |
string |
60 |
N |
<blank> |
Customer address two |
ADDRESS3 |
string |
60 |
N |
<blank> |
Customer address three |
CNTCPRSN |
string |
60 |
N |
<blank> |
Contact person |
FAXNUMBR |
string |
21 |
N |
<blank> |
Fax number |
CITY |
string |
35 |
N |
<blank> |
Customer city |
STATE |
string |
29 |
N |
<blank> |
Customer state |
ZIPCODE |
string |
10 |
N |
<blank> |
Customer ZIP Code |
COUNTRY |
string |
60 |
N |
<blank> |
Customer country |
PHNUMBR1 |
string |
21 |
N |
<blank> |
Phone one |
PHNUMBR2 |
string |
21 |
N |
<blank> |
Phone two |
PHNUMBR3 |
string |
21 |
N |
<blank> |
Phone three |
SUBTOTAL |
number |
21 |
N |
0 |
Subtotal=Total before taxes |
DOCAMNT |
number |
21 |
N |
0 |
Document amount/total |
PYMTRCVD |
number |
21 |
N |
0 |
Total of all payments and deposits |
SALSTERR |
string |
15 |
N |
<blank> |
Sales territory |
SLPRSNID |
string |
15 |
N |
<blank> |
Salesperson ID |
UPSZONE |
string |
3 |
N |
Default from setup |
UPS zone |
USER2ENT |
string |
15 |
N |
<blank> |
User who entered |
BACHNUMB |
string |
15 |
Y |
Not applicable |
Batch number |
PRBTADCD |
string |
15 |
N |
<blank> |
Primary bill to address code |
PRSTADCD |
string |
15 |
N |
Default from setup |
Primary ship to address code |
FRTTXAMT |
number |
21 |
N |
0 |
Freight tax amount |
MSCTXAMT |
number |
21 |
N |
0 |
Miscellaneous tax amount |
ORDRDATE |
datetime |
16 |
N |
<blank> |
Order date |
MSTRNUMB |
i4 |
4 |
N |
0 |
Master Number—default is next number if 0 |
PYMTRMID |
string |
20 |
N |
Default from setup |
Payment terms ID—default is from customer if not passed in |
DUEDATE |
datetime |
16 |
N |
<blank> |
Due date |
DISCDATE |
datetime |
16 |
N |
<blank> |
Discount date |
REFRENCE |
string |
30 |
N |
<blank> |
GL reference |
USINGHEADERLEVELTAXES |
i4 |
4 |
N |
0 |
Header level taxes |
BatchCHEKBKID |
string |
15 |
N |
<blank> |
Checkbook ID for the batch |
CREATECOMM |
i4 |
2 |
N |
0 |
Flag to autocreate commissions: 0=Manual; 1=Automatic—use if not calling <taSopCommissions> node |
COMMAMNT |
number |
21 |
N |
0 |
Total amount of commissions for this document—used only with manual commissions |
COMPRCNT |
number |
21 |
N |
0 |
Used for all salespeople if passed in and CREATECOMM=1; leave blank to use default percentages |
CREATEDIST |
i4 |
2 |
N |
1 |
Flag to autocreate distributions: 0=Manual; 1=Automatic—use if not calling <taSopDistribution> node |
CREATETAXES |
i4 |
2 |
N |
0 |
Flag to autocreate taxes with tax engine; leave at 0 if integrating your own |
DEFTAXSCHDS |
i4 |
2 |
N |
0 |
Flag to default tax schedules based on setup if incoming tax schedules empty |
CURNCYID |
string |
15 |
N |
<blank> |
Currency ID |
XCHGRATE |
number |
21 |
N |
0 |
Exchange rate |
RATETPID |
string |
15 |
N |
<blank> |
Rate type ID |
EXPNDATE |
datetime |
16 |
N |
<blank> |
Expiration date |
EXCHDATE |
datetime |
16 |
N |
<blank> |
Exchange date |
EXGTBDSC |
string |
30 |
N |
<blank> |
Exchange ID description |
EXTBLSRC |
string |
50 |
N |
<blank> |
Exchange rate source |
RATEEXPR |
i4 |
2 |
N |
Default from setup |
Rate expiration: 0=None 1=Daily; 2=Weekly; 3=Biweekly; 4=Semimonthly; 5=Monthly; 6=Quarterly; 7=Annually; 8=Miscellaneous; 9=None; |
DYSTINCR |
i4 |
2 |
N |
Default from setup |
Days to increment—used only when RATEEXPR=8 |
RATEVARC |
number |
21 |
N |
0 |
Rate variance |
TRXDTDEF |
i4 |
2 |
N |
Default from setup |
Transaction date default: 0=Exact date; 1=Next date; 2=Previous date |
RTCLCMTD |
i4 |
2 |
N |
Default from setup |
Rate calculation method: 0=Multiply; 1=Divide |
PRVDSLMT |
i4 |
2 |
N |
0 |
Previous day's limits |
DATELMTS |
i4 |
2 |
N |
0 |
Date limits: 0=Unlimited; 1=Limited |
TIME1 |
datetime |
16 |
N |
<blank> |
MC exchange time=Time 1 |
DISAVAMT |
number |
21 |
N |
Default from setup |
Discount available amount; cannot be larger than document amount |
DSCDLRAM |
number |
21 |
N |
Default from setup |
Discount dollar amount |
DSCPCTAM |
number |
21 |
N |
Default from setup |
Discount percent amount |
FREIGTBLE |
i4 |
4 |
N |
0 |
Freight taxable: 0=Default from SOP setup; 1=Taxable; 2=Nontaxable; 3=Base on customers |
MISCTBLE |
i4 |
4 |
N |
0 |
Miscellaneous amount taxable: 0=Default from SOP setup; 1=Taxable; 2=Nontaxable; 3=Base on customers |
COMMNTID |
string |
15 |
N |
Default from setup |
Comment ID |
COMMENT_1 |
string |
50 |
N |
<blank> |
Comment 1 |
COMMENT_2 |
string |
50 |
N |
<blank> |
Comment 2 |
COMMENT_3 |
string |
50 |
N |
<blank> |
Comment 3 |
COMMENT_4 |
string |
50 |
N |
<blank> |
Comment 4 |
GPSFOINTEGRATIONID |
string |
30 |
N |
<blank> |
Front office integration ID |
INTEGRATIONSOURCE |
i4 |
2 |
N |
0 |
Integration source |
INTEGRATIONID |
string |
30 |
N |
<blank> |
Integration ID |
ReqShipDate |
datetime |
16 |
N |
<blank> |
Requested ship date |
RequesterTrx |
i4 |
2 |
N |
0 |
Requester transaction: 0=False; 1=True (if True, it populates requester shadow table) |
CKCreditLimit |
i4 |
1 |
N |
0 |
Flag to allow check on credit limits before transaction is processed: 0=Does not check credit limit; 1=Checks credit limit |
CKHOLD |
i4 |
1 |
N |
0 |
Flag to allow check on hold status: 0=Does not check hold status; 1=Checks hold status |
UpdateExisting |
i4 |
1 |
N |
0 |
Used to modify header: 0=New transaction; 1=Update header—used to update after transaction exists |
QUOEXPDA |
datetime |
16 |
N |
<blank> |
Quote expiration date; defaults based on setup if not filled in |
QUOTEDAT |
datetime |
16 |
N |
<blank> |
Quote date; used for SOPTYPE <> 1; if SOPTYPE=1, DOCDATE is used |
INVODATE |
datetime |
16 |
N |
<blank> |
Invoice date; used for SOPTYPE <> 3; if SOPTYPE=3, DOCDATE is used |
BACKDATE |
datetime |
16 |
N |
<blank> |
Back order date; used for SOPTYPE <> 4; if SOPTYPE=4, DOCDATE is used |
RETUDATE |
datetime |
16 |
N |
<blank> |
Return date; used for SOPTYPE <> 5; if SOPTYPE=5, DOCDATE is used |
CMMTTEXT |
string |
500 |
N |
<blank> |
Comment text; used only if not using COMMENT_1 through COMMENT_4 |
PRCLEVEL |
string |
10 |
N |
<blank> |
Price level |
DEFPRICING |
i4 |
1 |
N |
0 |
1=Subtotal will be calculated from SOP line or lines |
TAXEXMT1 |
string |
25 |
N |
Default from setup |
Tax exempt 1; default is from customer if not supplied |
TAXEXMT2 |
string |
25 |
N |
Default from setup |
Tax exempt 2; default is from customer if not supplied |
TXRGNNUM |
string |
25 |
N |
Default from setup |
Tax registration number; default is from customer if not supplied |
REPTING |
i4 |
1 |
N |
0 |
Repeating: 0=False; 1=True Only valid for SOPTYPE=1 or 2 |
TRXFREQU |
i4 |
2 |
N |
0 |
Frequency: 1=Weekly; 2=Biweekly; 3=Semimonthly; 4=Monthly; 5=Bi-Monthly; 6=Quarterly; 7=Misc. Only valid for SOPTYPE=1 or 2 |
TIMETREP |
i4 |
2 |
N |
0 |
Times Repeating; Only valid for SOPTYPE=1 or 2 |
QUOTEDYSTINCR |
|
2 |
N |
0 |
Days to Increment; Only valid for SOPTYPE=1 or 2 |
NOTETEXT |
string |
8000 |
N |
Default from setup |
Notes field |
USRDEFND1 |
string |
50 |
N |
<blank> |
User-defined field—developer use only |
USRDEFND2 |
string |
50 |
N |
<blank> |
User-defined field—developer use only |
USRDEFND3 |
string |
50 |
N |
<blank> |
User-defined field—developer use only |
USRDEFND4 |
string |
8000 |
N |
<blank> |
User-defined field—developer use only |
USRDEFND5 |
string |
8000 |
N |
<blank> |
User-defined field—developer use only |
* The <taSopHdrIvcInsert> node uses document exchange to provide update functionality.