POST Customer/PostCustomer
Add a Customer.
Request Information
URI Parameters
Body Parameters
Customer object to use for the creation of a customer.
ClsCustomerAddName | Description | Type | Additional Information |
---|---|---|---|
LocationID |
Agvance location assigned to customer |
string |
Required Max length: 6 |
CustomerGUID |
The Globally Unique Identifier of the customer. If not filled out, the GUID will be automatically generated |
string |
Max length: 36 |
CustomerID |
The Agvance Customer Identifier, also commonly called Grower ID, this is used to reference the customer throughout Agvance and the API |
string |
Required Max length: 6 |
GrowerYN |
True if the customer is a grower, False otherwise |
boolean | |
FirstName |
The customer's first name, can be blank |
string |
Max length: 20 |
LastName |
The customer's last name. Can also be the company's name if the customer is a business or co-op or other entity |
string |
Required Max length: 50 |
AddressLine1 |
Attention To, Care Of, or company name |
string |
Max length: 50 |
AddressLine2 |
Street address or P.O. box |
string |
Max length: 50 |
AddressLine3 |
Any other address specifics, Apartment #, Floor, etc. |
string |
Max length: 50 |
City |
The city the customer lives in |
string |
Max length: 25 |
State |
The state the customer lives in |
string |
Max length: 2 |
Zip |
The zip code for the customer's address |
string |
Max length: 10 |
PhoneNumber |
The customer's primary phone number |
string |
Max length: 15 |
PhoneNumber2 |
The customer's alternate phone number |
string |
Max length: 15 |
Notes |
Notes from customer profile |
string | |
Salesman |
Salesperson assigned to customer |
string |
Max length: 15 |
Group |
Optional information to help categorize customers |
string |
Max length: 8 |
CrossRef1 |
Cross reference 1 |
string |
Max length: 40 |
CrossRef2 |
Cross reference 2 |
string |
Max length: 40 |
CrossRef3 |
Cross reference 3 |
string |
Max length: 40 |
CrossRef4 |
Cross reference 4 |
string |
Max length: 40 |
Pricing |
The default price level for this customer |
integer | |
TempCust |
True if the customer is a placeholder, false otherwise |
boolean | |
Active |
Active/Inactive flag. A=Active, I=Inactive |
string |
Max length: 1 |
Territory |
The name of the territory for Canadian customers |
string |
Max length: 15 |
County |
The name of the county |
string |
Max length: 60 |
Country |
The name of the country |
string |
Max length: 60 |
SalesTaxRate |
The tax rate this customer is to receive if using one other than the location's default rate |
decimal number | |
OracleId |
Oracle ID |
string |
Max length: 15 |
OracleAddrId |
Oracle Bill to/Ship to address |
string |
Max length: 15 |
AddrLat |
Address latitude |
integer |
Range: inclusive between -90000000 and 90000000 |
AddrLon |
Address longitude |
integer |
Range: inclusive between -180000000 and 180000000 |
StTaxCode |
State tax code |
string |
Max length: 15 |
AdjTaxCode |
Adjustment tax code |
string |
Max length: 15 |
HealthId |
The Health Industry Number for animal health customers |
string |
Max length: 20 |
ProspectYesNo |
Prospect status |
boolean | |
AgrianCustId |
If customers are linked between Agrian and Agvance, this is the customer's Agrian ID |
string |
Max length: 60 |
AgrianStatePermitGrowerId |
Agrian state permit grower ID |
string |
Max length: 20 |
CompanyName1099 |
If the name to print on the 1099 is different than the customer’s name, enter it in this area |
string |
Max length: 50 |
Gln |
The Global Location Number assigned to the customer, must be 13 digits |
string |
Max length: 13 |
PrintDollarsPerAcreOnInvoice |
Print Dollars Per Acre on Invoice |
boolean | |
BegYear |
Beginning year balance |
decimal number | |
BegMth |
Beginning month balance |
decimal number | |
CurBal |
Current balance |
decimal number | |
UaCash |
Unapplied cash balance |
decimal number | |
BegYearPp |
Beginning year prepay balance |
decimal number | |
CurbalPp |
Current prepay balance |
decimal number | |
CredLim |
Credit limit |
decimal number | |
FinChrgPer |
Finance charge % |
decimal number | |
Opened |
Date credit opened |
string |
Data type: DateTime Format must be MM/dd/yyyy |
LastStatement |
Date of last financial statement |
string |
Data type: DateTime Format must be MM/dd/yyyy |
LastReviewed |
Date of last credit review |
string |
Data type: DateTime Format must be MM/dd/yyyy |
CredStatus |
Credit status, default available options are 'Excellent', 'Fair', 'Good', 'Hold', 'Poor' |
string |
Max length: 20 |
OverLimThis |
Months over credit limit this year, Agvance will automatically set this to zero at year end |
integer | |
OverLimLast |
Months over credit limit last year, Agvance will automatically set this at year end |
decimal number | |
HighBalThis |
High end of month balance this year, this is set automatically when a month ends |
decimal number | |
HighBalLast |
High end of month balance last year, this is set automatically when a year ends |
decimal number | |
PrintStatement |
Print Statement. Valid options are Y (Yes), N (No), or F (If 30 Days Past Due) |
string |
Max length: 1 |
CredNotes |
Notes related to this customer's credit |
string | |
Wip |
Work in progress balance |
decimal number | |
PoRequiredYesNo |
Whether or not a Purchase Order is required for this customer |
boolean | |
AvailableCredit |
The customer's Available Credit, this amount will be calculated after each transaction |
decimal number | |
SsnTaxIdNum |
Social Security Number/Tax ID (encrypted) |
string |
Max length: 80 |
CreditActive |
Whether or not this customer has a credit line |
boolean | |
CreditLineName |
The name of this customer's credit line |
string |
Max length: 50 |
CreditLineAmt |
The maximum amount of this customer's credit line |
decimal number | |
Budget |
This customer's budget (energy) balance |
decimal number | |
CreditNeverSend |
Whether or not to never send a credit letter |
boolean | |
Type1099 |
1099 type related to this customer. Valid values are: 'None' or 'Interest' |
string |
Max length: 20 |
Paid1099 |
This customer's interest on deferred payment contracts |
decimal number | |
BegYearBb |
This customer's beginning year budget (energy) balance |
decimal number | |
AcctNum |
This customer's patronage account number |
string |
Max length: 17 |
AcctType |
This customer's patronage ACH account type. Valid type are: 'C' (Checking) or 'S' (Savings) |
string |
Max length: 1 |
AbaRouteNum |
This customer's patronage ACH routing number |
string |
Max length: 9 |
PrintBbStatement |
Whether or not to print the budget billing statement (energy). Valid values are: 'Y' or 'N' |
string |
Max length: 1 |
Month1 |
Regular balance end of fiscal month 1 |
decimal number | |
Month2 |
Regular balance end of fiscal month 2 |
decimal number | |
Month3 |
Regular balance end of fiscal month 3 |
decimal number | |
Month4 |
Regular balance end of fiscal month 4 |
decimal number | |
Month5 |
Regular balance end of fiscal month 5 |
decimal number | |
Month6 |
Regular balance end of fiscal month 6 |
decimal number | |
Month7 |
Regular balance end of fiscal month 7 |
decimal number | |
Month8 |
Regular balance end of fiscal month 8 |
decimal number | |
Month9 |
Regular balance end of fiscal month 9 |
decimal number | |
Month10 |
Regular balance end of fiscal month 10 |
decimal number | |
Month11 |
Regular balance end of fiscal month 11 |
decimal number | |
Month12 |
Regular balance end of fiscal month 12 |
decimal number | |
Month1Pp |
Prepay Balance end of fiscal month 1 |
decimal number | |
Month2Pp |
Prepay Balance end of fiscal month 2 |
decimal number | |
Month3Pp |
Prepay Balance end of fiscal month 3 |
decimal number | |
Month4Pp |
Prepay Balance end of fiscal month 4 |
decimal number | |
Month5Pp |
Prepay Balance end of fiscal month 5 |
decimal number | |
Month6Pp |
Prepay Balance end of fiscal month 6 |
decimal number | |
Month7Pp |
Prepay Balance end of fiscal month 7 |
decimal number | |
Month8Pp |
Prepay Balance end of fiscal month 8 |
decimal number | |
Month9Pp |
Prepay Balance end of fiscal month 9 |
decimal number | |
Month10Pp |
Prepay Balance end of fiscal month 10 |
decimal number | |
Month11Pp |
Prepay Balance end of fiscal month 11 |
decimal number | |
Month12Pp |
Prepay Balance end of fiscal month 12 |
decimal number | |
Month1Bb |
Budget (energy) balance end of fiscal month 1 |
decimal number | |
Month2Bb |
Budget (energy) balance end of fiscal month 2 |
decimal number | |
Month3Bb |
Budget (energy) balance end of fiscal month 3 |
decimal number | |
Month4Bb |
Budget (energy) balance end of fiscal month 4 |
decimal number | |
Month5Bb |
Budget (energy) balance end of fiscal month 5 |
decimal number | |
Month6Bb |
Budget (energy) balance end of fiscal month 6 |
decimal number | |
Month7Bb |
Budget (energy) balance end of fiscal month 7 |
decimal number | |
Month8Bb |
Budget (energy) balance end of fiscal month 8 |
decimal number | |
Month9Bb |
Budget (energy) balance end of fiscal month 9 |
decimal number | |
Month10Bb |
Budget (energy) balance end of fiscal month 10 |
decimal number | |
Month11Bb |
Budget (energy) balance end of fiscal month 11 |
decimal number | |
Month12Bb |
Budget (energy) balance end of fiscal month 12 |
decimal number | |
CustPatBDay |
Birth date of this customer in MM/dd/yyyy format |
string |
Data type: DateTime Format must be MM/dd/yyyy |
CustPatActiveMember |
Whether or not this customer is an active patron |
boolean | |
CustPatCorporation |
Whether or not this customer is a corporation |
boolean | |
TaxId |
The tax exempt ID related to this customer |
string |
Max length: 15 |
Taxable |
Whether or not this customer is sales taxable |
boolean | |
Reason |
The ID of the tax exempt reason for this customer |
string |
Max length: 50 |
DefaultPaymentTerms |
The ID of the payment terms related to this customer |
string |
Max length: 15 |
GrainTaxExempt |
Whether or not this customer is grain tax exempt |
boolean | |
ReasonExpDate |
This customer's tax exemption expiration date |
string |
Data type: DateTime Format must be MM/dd/yyyy |
AchAcctNum |
ACH bank account number (encrypted) |
string |
Max length: 17 |
AchAcctType |
ACH account type, "C" for checking and "S" for savings. |
string |
Max length: 1 |
AchAbaRouteNum |
ACH bank routing number |
string |
Max length: 9 |
CondoGrowerId |
The customer ID of a condo storage owner that has granted this customer permission to store in his or her condo space |
string |
Max length: 6 |
MnLienholderId |
This customer's Minnesota lienholder ID if applicable |
string |
Max length: 9 |
FederalPermitList |
Federal permit numbers along with permit expiration date related to this customer |
Collection of ClsCustFedPermAdd | |
CustDeptPriceDefs |
Price level defaults related to this customer based on inventory deparments |
Collection of ClsCustDeptPriceDefAdd | |
CustJDCAccounts |
JDF Multi-Use Account integration, such as credit plan numbers, descriptive billing codes, terminal numbers, and preferences |
Collection of ClsCustJdcAccountsAdd | |
CustContacts |
Addresses and email information for various people associated with the customer. Authorized Agents for the customer account and relations to the account may also be established here |
Collection of ClsCustContactsAdd | |
CustClassifications |
Classifications this customer belongs to |
Collection of ClsCustClassAdd | |
ExtraChargesCust |
Extra charges related to this customer |
Collection of ClsExtraChargesCustomerAdd | |
CustAttributes |
Attributes related to this customer |
Collection of ClsCustAttributesAdd | |
CustRelationship |
Family members and work relationships related to this customer |
Collection of ClsCustRelationshipAdd | |
CustDate |
Significant dates and descriptions of those dates. These could be important customer dates such as anniversaries, birthdays, etc. |
Collection of ClsCustDateAdd | |
CustDetail |
Types of work the customer is involved in and to what extent |
Collection of ClsCustDetailAdd | |
CustNotify |
Document specific rules detailing the document type, how they should be sent, and the email address they should be sent to |
Collection of ClsCustNotifyAdd | |
GRCustGBPool |
The list of Agvance customers who are authorized to use this customer's grain bank account |
Collection of ClsGrCustGbPoolAdd | |
CustBankAccounts |
Account types, routing numbers, and account numbers for bank accounts related to this customer |
Collection of ClsCustBankAccountsAdd |
Request Formats
application/json, text/json
{ "LocationID": "sample string 1", "CustomerGUID": "sample string 2", "CustomerID": "sample string 3", "GrowerYN": true, "FirstName": "sample string 5", "LastName": "sample string 6", "AddressLine1": "sample string 7", "AddressLine2": "sample string 8", "AddressLine3": "sample string 9", "City": "sample string 11", "State": "sample string 12", "Zip": "sample string 13", "PhoneNumber": "sample string 14", "PhoneNumber2": "sample string 15", "Notes": "sample string 18", "Salesman": "sample string 19", "Group": "sample string 20", "CrossRef1": "sample string 27", "CrossRef2": "sample string 28", "CrossRef3": "sample string 29", "CrossRef4": "sample string 30", "Pricing": 31, "TempCust": true, "Active": "sample string 34", "Territory": "sample string 35", "County": "sample string 36", "Country": "sample string 37", "SalesTaxRate": 38.1, "OracleId": "sample string 39", "OracleAddrId": "sample string 40", "AddrLat": 41, "AddrLon": 42, "StTaxCode": "sample string 44", "AdjTaxCode": "sample string 45", "HealthId": "sample string 46", "ProspectYesNo": true, "AgrianCustId": "sample string 48", "AgrianStatePermitGrowerId": "sample string 49", "CompanyName1099": "sample string 50", "Gln": "sample string 51", "PrintDollarsPerAcreOnInvoice": true, "BegYear": 53.1, "BegMth": 54.1, "CurBal": 55.1, "UaCash": 56.1, "BegYearPp": 57.1, "CurbalPp": 58.1, "CredLim": 59.1, "FinChrgPer": 60.1, "Opened": "sample string 61", "LastStatement": "sample string 62", "LastReviewed": "sample string 63", "CredStatus": "sample string 64", "OverLimThis": 65, "OverLimLast": 66.1, "HighBalThis": 67.1, "HighBalLast": 68.1, "PrintStatement": "sample string 69", "CredNotes": "sample string 70", "Wip": 71.1, "PoRequiredYesNo": true, "AvailableCredit": 74.1, "SsnTaxIdNum": "sample string 75", "CreditActive": true, "CreditLineName": "sample string 77", "CreditLineAmt": 78.1, "Budget": 79.1, "CreditNeverSend": true, "Type1099": "sample string 81", "Paid1099": 82.1, "BegYearBb": 83.1, "AcctNum": "sample string 88", "AcctType": "sample string 89", "AbaRouteNum": "sample string 90", "PrintBbStatement": "sample string 91", "Month1": 92.1, "Month2": 93.1, "Month3": 94.1, "Month4": 95.1, "Month5": 96.1, "Month6": 97.1, "Month7": 98.1, "Month8": 99.1, "Month9": 100.1, "Month10": 101.1, "Month11": 102.1, "Month12": 103.1, "Month1Pp": 104.1, "Month2Pp": 105.1, "Month3Pp": 106.1, "Month4Pp": 107.1, "Month5Pp": 108.1, "Month6Pp": 109.1, "Month7Pp": 110.1, "Month8Pp": 111.1, "Month9Pp": 112.1, "Month10Pp": 113.1, "Month11Pp": 114.1, "Month12Pp": 115.1, "Month1Bb": 116.1, "Month2Bb": 117.1, "Month3Bb": 118.1, "Month4Bb": 119.1, "Month5Bb": 120.1, "Month6Bb": 121.1, "Month7Bb": 122.1, "Month8Bb": 123.1, "Month9Bb": 124.1, "Month10Bb": 125.1, "Month11Bb": 126.1, "Month12Bb": 127.1, "CustPatBDay": "sample string 128", "CustPatActiveMember": true, "CustPatCorporation": true, "TaxId": "sample string 131", "Taxable": true, "Reason": "sample string 133", "DefaultPaymentTerms": "sample string 134", "GrainTaxExempt": true, "ReasonExpDate": "sample string 138", "AchAcctNum": "sample string 139", "AchAcctType": "sample string 140", "AchAbaRouteNum": "sample string 141", "CondoGrowerId": "sample string 143", "MnLienholderId": "sample string 144", "FederalPermitList": [ { "Permit": "sample string 1", "ExpDate": "sample string 2" }, { "Permit": "sample string 1", "ExpDate": "sample string 2" } ], "CustDeptPriceDefs": [ { "DeptId": "sample string 1", "PriceLevel": 2 }, { "DeptId": "sample string 1", "PriceLevel": 2 } ], "CustJDCAccounts": [ { "JdcAccountType": "sample string 1", "JdcAccountNumber": "sample string 2", "PostalCode": "sample string 3" }, { "JdcAccountType": "sample string 1", "JdcAccountNumber": "sample string 2", "PostalCode": "sample string 3" } ], "CustContacts": [ { "ContactType": "sample string 1", "ContactName": "sample string 2", "EmailAddress": "sample string 3", "PhoneNumber": "sample string 4", "Relationship": "sample string 5", "AddressLine1": "sample string 6", "AddressLine2": "sample string 7", "City": "sample string 8", "State": "sample string 9", "Zip": "sample string 10" }, { "ContactType": "sample string 1", "ContactName": "sample string 2", "EmailAddress": "sample string 3", "PhoneNumber": "sample string 4", "Relationship": "sample string 5", "AddressLine1": "sample string 6", "AddressLine2": "sample string 7", "City": "sample string 8", "State": "sample string 9", "Zip": "sample string 10" } ], "CustClassifications": [ { "ClassName": "sample string 1" }, { "ClassName": "sample string 1" } ], "ExtraChargesCust": [ { "ExtraChargeId": "sample string 1" }, { "ExtraChargeId": "sample string 1" } ], "CustAttributes": [ { "AttributeValue": "sample string 1", "CrossRef": "sample string 2" }, { "AttributeValue": "sample string 1", "CrossRef": "sample string 2" } ], "CustRelationship": [ { "FirstName": "sample string 1", "LastName": "sample string 2", "Relation": "sample string 3", "BirthDate": "sample string 4", "Notes": "sample string 5" }, { "FirstName": "sample string 1", "LastName": "sample string 2", "Relation": "sample string 3", "BirthDate": "sample string 4", "Notes": "sample string 5" } ], "CustDate": [ { "SignificantDate": "sample string 1", "Description": "sample string 2" }, { "SignificantDate": "sample string 1", "Description": "sample string 2" } ], "CustDetail": [ { "Description": "sample string 1", "Value": 2.1, "Category": "sample string 3", "SubCategory": "sample string 4" }, { "Description": "sample string 1", "Value": 2.1, "Category": "sample string 3", "SubCategory": "sample string 4" } ], "CustNotify": [ { "DocumentType": "sample string 1", "DeliverTo": "sample string 2", "EmailAddress": "sample string 3", "IncludeDocumentAsAttachment": true }, { "DocumentType": "sample string 1", "DeliverTo": "sample string 2", "EmailAddress": "sample string 3", "IncludeDocumentAsAttachment": true } ], "GRCustGBPool": [ { "CustomerID": "sample string 1" }, { "CustomerID": "sample string 1" } ], "CustBankAccounts": [ { "AccountType": "sample string 1", "RoutingNumber": "sample string 2", "BankAccountNumber": "sample string 3" }, { "AccountType": "sample string 1", "RoutingNumber": "sample string 2", "BankAccountNumber": "sample string 3" } ] }
application/xml, text/xml
<CustomerAdd xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SKY.Core.Customer"> <AbaRouteNum>sample string 90</AbaRouteNum> <AcctNum>sample string 88</AcctNum> <AcctType>sample string 89</AcctType> <AchAbaRouteNum>sample string 141</AchAbaRouteNum> <AchAcctNum>sample string 139</AchAcctNum> <AchAcctType>sample string 140</AchAcctType> <Active>sample string 34</Active> <AddrLat>41</AddrLat> <AddrLon>42</AddrLon> <AddressLine1>sample string 7</AddressLine1> <AddressLine2>sample string 8</AddressLine2> <AddressLine3>sample string 9</AddressLine3> <AdjTaxCode>sample string 45</AdjTaxCode> <AgrianCustId>sample string 48</AgrianCustId> <AgrianStatePermitGrowerId>sample string 49</AgrianStatePermitGrowerId> <AvailableCredit>74.1</AvailableCredit> <BegMth>54.1</BegMth> <BegYear>53.1</BegYear> <BegYearBb>83.1</BegYearBb> <BegYearPp>57.1</BegYearPp> <Budget>79.1</Budget> <City>sample string 11</City> <CompanyName1099>sample string 50</CompanyName1099> <CondoGrowerId>sample string 143</CondoGrowerId> <Country>sample string 37</Country> <County>sample string 36</County> <CredLim>59.1</CredLim> <CredNotes>sample string 70</CredNotes> <CredStatus>sample string 64</CredStatus> <CreditActive>true</CreditActive> <CreditLineAmt>78.1</CreditLineAmt> <CreditLineName>sample string 77</CreditLineName> <CreditNeverSend>true</CreditNeverSend> <CrossRef1>sample string 27</CrossRef1> <CrossRef2>sample string 28</CrossRef2> <CrossRef3>sample string 29</CrossRef3> <CrossRef4>sample string 30</CrossRef4> <CurBal>55.1</CurBal> <CurbalPp>58.1</CurbalPp> <CustAttributes> <ClsCustomer.ClsCustomerAdd.ClsCustAttributesAdd> <AttributeValue>sample string 1</AttributeValue> <CrossRef>sample string 2</CrossRef> </ClsCustomer.ClsCustomerAdd.ClsCustAttributesAdd> <ClsCustomer.ClsCustomerAdd.ClsCustAttributesAdd> <AttributeValue>sample string 1</AttributeValue> <CrossRef>sample string 2</CrossRef> </ClsCustomer.ClsCustomerAdd.ClsCustAttributesAdd> </CustAttributes> <CustBankAccounts> <ClsCustomer.ClsCustomerAdd.ClsCustBankAccountsAdd> <AccountType>sample string 1</AccountType> <BankAccountNumber>sample string 3</BankAccountNumber> <RoutingNumber>sample string 2</RoutingNumber> </ClsCustomer.ClsCustomerAdd.ClsCustBankAccountsAdd> <ClsCustomer.ClsCustomerAdd.ClsCustBankAccountsAdd> <AccountType>sample string 1</AccountType> <BankAccountNumber>sample string 3</BankAccountNumber> <RoutingNumber>sample string 2</RoutingNumber> </ClsCustomer.ClsCustomerAdd.ClsCustBankAccountsAdd> </CustBankAccounts> <CustClassifications> <ClsCustomer.ClsCustomerAdd.ClsCustClassAdd> <ClassName>sample string 1</ClassName> </ClsCustomer.ClsCustomerAdd.ClsCustClassAdd> <ClsCustomer.ClsCustomerAdd.ClsCustClassAdd> <ClassName>sample string 1</ClassName> </ClsCustomer.ClsCustomerAdd.ClsCustClassAdd> </CustClassifications> <CustContacts> <ClsCustomer.ClsCustomerAdd.ClsCustContactsAdd> <AddressLine1>sample string 6</AddressLine1> <AddressLine2>sample string 7</AddressLine2> <City>sample string 8</City> <ContactName>sample string 2</ContactName> <ContactType>sample string 1</ContactType> <EmailAddress>sample string 3</EmailAddress> <PhoneNumber>sample string 4</PhoneNumber> <Relationship>sample string 5</Relationship> <State>sample string 9</State> <Zip>sample string 10</Zip> </ClsCustomer.ClsCustomerAdd.ClsCustContactsAdd> <ClsCustomer.ClsCustomerAdd.ClsCustContactsAdd> <AddressLine1>sample string 6</AddressLine1> <AddressLine2>sample string 7</AddressLine2> <City>sample string 8</City> <ContactName>sample string 2</ContactName> <ContactType>sample string 1</ContactType> <EmailAddress>sample string 3</EmailAddress> <PhoneNumber>sample string 4</PhoneNumber> <Relationship>sample string 5</Relationship> <State>sample string 9</State> <Zip>sample string 10</Zip> </ClsCustomer.ClsCustomerAdd.ClsCustContactsAdd> </CustContacts> <CustDate> <ClsCustomer.ClsCustomerAdd.ClsCustDateAdd> <Description>sample string 2</Description> <SignificantDate>sample string 1</SignificantDate> </ClsCustomer.ClsCustomerAdd.ClsCustDateAdd> <ClsCustomer.ClsCustomerAdd.ClsCustDateAdd> <Description>sample string 2</Description> <SignificantDate>sample string 1</SignificantDate> </ClsCustomer.ClsCustomerAdd.ClsCustDateAdd> </CustDate> <CustDeptPriceDefs> <ClsCustomer.ClsCustomerAdd.ClsCustDeptPriceDefAdd> <DeptId>sample string 1</DeptId> <PriceLevel>2</PriceLevel> </ClsCustomer.ClsCustomerAdd.ClsCustDeptPriceDefAdd> <ClsCustomer.ClsCustomerAdd.ClsCustDeptPriceDefAdd> <DeptId>sample string 1</DeptId> <PriceLevel>2</PriceLevel> </ClsCustomer.ClsCustomerAdd.ClsCustDeptPriceDefAdd> </CustDeptPriceDefs> <CustDetail> <ClsCustomer.ClsCustomerAdd.ClsCustDetailAdd> <Category>sample string 3</Category> <Description>sample string 1</Description> <SubCategory>sample string 4</SubCategory> <Value>2.1</Value> </ClsCustomer.ClsCustomerAdd.ClsCustDetailAdd> <ClsCustomer.ClsCustomerAdd.ClsCustDetailAdd> <Category>sample string 3</Category> <Description>sample string 1</Description> <SubCategory>sample string 4</SubCategory> <Value>2.1</Value> </ClsCustomer.ClsCustomerAdd.ClsCustDetailAdd> </CustDetail> <CustJDCAccounts> <CustJDCAccounts> <JdcAccountNumber>sample string 2</JdcAccountNumber> <JdcAccountType>sample string 1</JdcAccountType> <PostalCode>sample string 3</PostalCode> </CustJDCAccounts> <CustJDCAccounts> <JdcAccountNumber>sample string 2</JdcAccountNumber> <JdcAccountType>sample string 1</JdcAccountType> <PostalCode>sample string 3</PostalCode> </CustJDCAccounts> </CustJDCAccounts> <CustNotify> <ClsCustomer.ClsCustomerAdd.ClsCustNotifyAdd> <DeliverTo>sample string 2</DeliverTo> <DocumentType>sample string 1</DocumentType> <EmailAddress>sample string 3</EmailAddress> <IncludeDocumentAsAttachment>true</IncludeDocumentAsAttachment> </ClsCustomer.ClsCustomerAdd.ClsCustNotifyAdd> <ClsCustomer.ClsCustomerAdd.ClsCustNotifyAdd> <DeliverTo>sample string 2</DeliverTo> <DocumentType>sample string 1</DocumentType> <EmailAddress>sample string 3</EmailAddress> <IncludeDocumentAsAttachment>true</IncludeDocumentAsAttachment> </ClsCustomer.ClsCustomerAdd.ClsCustNotifyAdd> </CustNotify> <CustPatActiveMember>true</CustPatActiveMember> <CustPatBDay>sample string 128</CustPatBDay> <CustPatCorporation>true</CustPatCorporation> <CustRelationship> <ClsCustomer.ClsCustomerAdd.ClsCustRelationshipAdd> <BirthDate>sample string 4</BirthDate> <FirstName>sample string 1</FirstName> <LastName>sample string 2</LastName> <Notes>sample string 5</Notes> <Relation>sample string 3</Relation> </ClsCustomer.ClsCustomerAdd.ClsCustRelationshipAdd> <ClsCustomer.ClsCustomerAdd.ClsCustRelationshipAdd> <BirthDate>sample string 4</BirthDate> <FirstName>sample string 1</FirstName> <LastName>sample string 2</LastName> <Notes>sample string 5</Notes> <Relation>sample string 3</Relation> </ClsCustomer.ClsCustomerAdd.ClsCustRelationshipAdd> </CustRelationship> <CustomerGUID>sample string 2</CustomerGUID> <CustomerID>sample string 3</CustomerID> <DefaultPaymentTerms>sample string 134</DefaultPaymentTerms> <ExtraChargesCust> <ClsCustomer.ClsCustomerAdd.ClsExtraChargesCustomerAdd> <ExtraChargeId>sample string 1</ExtraChargeId> </ClsCustomer.ClsCustomerAdd.ClsExtraChargesCustomerAdd> <ClsCustomer.ClsCustomerAdd.ClsExtraChargesCustomerAdd> <ExtraChargeId>sample string 1</ExtraChargeId> </ClsCustomer.ClsCustomerAdd.ClsExtraChargesCustomerAdd> </ExtraChargesCust> <FederalPermitList> <ClsCustomer.ClsCustomerAdd.ClsCustFedPermAdd> <ExpDate>sample string 2</ExpDate> <Permit>sample string 1</Permit> </ClsCustomer.ClsCustomerAdd.ClsCustFedPermAdd> <ClsCustomer.ClsCustomerAdd.ClsCustFedPermAdd> <ExpDate>sample string 2</ExpDate> <Permit>sample string 1</Permit> </ClsCustomer.ClsCustomerAdd.ClsCustFedPermAdd> </FederalPermitList> <FinChrgPer>60.1</FinChrgPer> <FirstName>sample string 5</FirstName> <GRCustGBPool> <ClsCustomer.ClsCustomerAdd.ClsGrCustGbPoolAdd> <CustomerID>sample string 1</CustomerID> </ClsCustomer.ClsCustomerAdd.ClsGrCustGbPoolAdd> <ClsCustomer.ClsCustomerAdd.ClsGrCustGbPoolAdd> <CustomerID>sample string 1</CustomerID> </ClsCustomer.ClsCustomerAdd.ClsGrCustGbPoolAdd> </GRCustGBPool> <Gln>sample string 51</Gln> <GrainTaxExempt>true</GrainTaxExempt> <Group>sample string 20</Group> <GrowerYN>true</GrowerYN> <HealthId>sample string 46</HealthId> <HighBalLast>68.1</HighBalLast> <HighBalThis>67.1</HighBalThis> <LastName>sample string 6</LastName> <LastReviewed>sample string 63</LastReviewed> <LastStatement>sample string 62</LastStatement> <LocationID>sample string 1</LocationID> <MnLienholderId>sample string 144</MnLienholderId> <Month1>92.1</Month1> <Month10>101.1</Month10> <Month10Bb>125.1</Month10Bb> <Month10Pp>113.1</Month10Pp> <Month11>102.1</Month11> <Month11Bb>126.1</Month11Bb> <Month11Pp>114.1</Month11Pp> <Month12>103.1</Month12> <Month12Bb>127.1</Month12Bb> <Month12Pp>115.1</Month12Pp> <Month1Bb>116.1</Month1Bb> <Month1Pp>104.1</Month1Pp> <Month2>93.1</Month2> <Month2Bb>117.1</Month2Bb> <Month2Pp>105.1</Month2Pp> <Month3>94.1</Month3> <Month3Bb>118.1</Month3Bb> <Month3Pp>106.1</Month3Pp> <Month4>95.1</Month4> <Month4Bb>119.1</Month4Bb> <Month4Pp>107.1</Month4Pp> <Month5>96.1</Month5> <Month5Bb>120.1</Month5Bb> <Month5Pp>108.1</Month5Pp> <Month6>97.1</Month6> <Month6Bb>121.1</Month6Bb> <Month6Pp>109.1</Month6Pp> <Month7>98.1</Month7> <Month7Bb>122.1</Month7Bb> <Month7Pp>110.1</Month7Pp> <Month8>99.1</Month8> <Month8Bb>123.1</Month8Bb> <Month8Pp>111.1</Month8Pp> <Month9>100.1</Month9> <Month9Bb>124.1</Month9Bb> <Month9Pp>112.1</Month9Pp> <Notes>sample string 18</Notes> <Opened>sample string 61</Opened> <OracleAddrId>sample string 40</OracleAddrId> <OracleId>sample string 39</OracleId> <OverLimLast>66.1</OverLimLast> <OverLimThis>65</OverLimThis> <Paid1099>82.1</Paid1099> <PhoneNumber>sample string 14</PhoneNumber> <PhoneNumber2>sample string 15</PhoneNumber2> <PoRequiredYesNo>true</PoRequiredYesNo> <Pricing>31</Pricing> <PrintBbStatement>sample string 91</PrintBbStatement> <PrintDollarsPerAcreOnInvoice>true</PrintDollarsPerAcreOnInvoice> <PrintStatement>sample string 69</PrintStatement> <ProspectYesNo>true</ProspectYesNo> <Reason>sample string 133</Reason> <ReasonExpDate>sample string 138</ReasonExpDate> <SalesTaxRate>38.1</SalesTaxRate> <Salesman>sample string 19</Salesman> <SsnTaxIdNum>sample string 75</SsnTaxIdNum> <StTaxCode>sample string 44</StTaxCode> <State>sample string 12</State> <TaxId>sample string 131</TaxId> <Taxable>true</Taxable> <TempCust>true</TempCust> <Territory>sample string 35</Territory> <Type1099>sample string 81</Type1099> <UaCash>56.1</UaCash> <Wip>71.1</Wip> <Zip>sample string 13</Zip> </CustomerAdd>
application/x-www-form-urlencoded
Response Information
Resource Description
Add a Customer.
AgvCustomerName | Description | Type | Additional Information |
---|---|---|---|
Status |
0 = Success; 1 = An error occurred; 2 = An error occurred; 3 = Descriptive message; process was successful |
string | |
Message |
Informational message that corresponds to the Status returned; 0 - Message will be "OK"; 1 - Detailed message returned to give user an indication of what went wrong; 2 - Less Detailed message returned that may not mean anything to the user but that the application might use to take a corrective action; 3 - Not an error but something the user might need to know |
string | |
Count |
Number of customers returned |
string | |
Customers |
A List of Properties and Values returned for each customer |
Collection of clsAPICustomer |
Response Formats
application/json, text/json
{ "Status": "sample string 1", "Message": "sample string 2", "Count": "sample string 3", "Customers": [ { "ID": "sample string 1", "Name": "sample string 2", "Address1": "sample string 3", "Address2": "sample string 4", "Address3": "sample string 5", "City": "sample string 6", "State": "sample string 7", "ZipCode": "sample string 8", "County": "sample string 9", "Phone1": "sample string 10", "Phone2": "sample string 11", "Salesperson": "sample string 12", "Notes": "sample string 13", "Location": "sample string 14", "CustomerGUID": "sample string 15", "AlternateCustomerIdPrintout": "sample string 16", "AlternateCustomerIdSelecting": "sample string 17", "FederalPermitList": [ { "CustID": "sample string 1", "LineItem": 2, "Permit": "sample string 3", "ExpDate": "sample string 4" }, { "CustID": "sample string 1", "LineItem": 2, "Permit": "sample string 3", "ExpDate": "sample string 4" } ] }, { "ID": "sample string 1", "Name": "sample string 2", "Address1": "sample string 3", "Address2": "sample string 4", "Address3": "sample string 5", "City": "sample string 6", "State": "sample string 7", "ZipCode": "sample string 8", "County": "sample string 9", "Phone1": "sample string 10", "Phone2": "sample string 11", "Salesperson": "sample string 12", "Notes": "sample string 13", "Location": "sample string 14", "CustomerGUID": "sample string 15", "AlternateCustomerIdPrintout": "sample string 16", "AlternateCustomerIdSelecting": "sample string 17", "FederalPermitList": [ { "CustID": "sample string 1", "LineItem": 2, "Permit": "sample string 3", "ExpDate": "sample string 4" }, { "CustID": "sample string 1", "LineItem": 2, "Permit": "sample string 3", "ExpDate": "sample string 4" } ] } ] }
application/xml, text/xml
<AgvCustomer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.Customer"> <Count>sample string 3</Count> <Customers xmlns:d2p1="http://schemas.datacontract.org/2004/07/SSI.API"> <d2p1:clsAPICustomer> <d2p1:Address1>sample string 3</d2p1:Address1> <d2p1:Address2>sample string 4</d2p1:Address2> <d2p1:Address3>sample string 5</d2p1:Address3> <d2p1:AlternateCustomerIdPrintout>sample string 16</d2p1:AlternateCustomerIdPrintout> <d2p1:AlternateCustomerIdSelecting>sample string 17</d2p1:AlternateCustomerIdSelecting> <d2p1:City>sample string 6</d2p1:City> <d2p1:County>sample string 9</d2p1:County> <d2p1:CustomerGUID>sample string 15</d2p1:CustomerGUID> <d2p1:FederalPermitList xmlns:d4p1="http://schemas.datacontract.org/2004/07/SKY.Core.Customer"> <d4p1:ClsCustomer.ClsCustFedPerm> <d4p1:CustID>sample string 1</d4p1:CustID> <d4p1:ExpDate>sample string 4</d4p1:ExpDate> <d4p1:LineItem>2</d4p1:LineItem> <d4p1:Permit>sample string 3</d4p1:Permit> </d4p1:ClsCustomer.ClsCustFedPerm> <d4p1:ClsCustomer.ClsCustFedPerm> <d4p1:CustID>sample string 1</d4p1:CustID> <d4p1:ExpDate>sample string 4</d4p1:ExpDate> <d4p1:LineItem>2</d4p1:LineItem> <d4p1:Permit>sample string 3</d4p1:Permit> </d4p1:ClsCustomer.ClsCustFedPerm> </d2p1:FederalPermitList> <d2p1:ID>sample string 1</d2p1:ID> <d2p1:Location>sample string 14</d2p1:Location> <d2p1:Name>sample string 2</d2p1:Name> <d2p1:Notes>sample string 13</d2p1:Notes> <d2p1:Phone1>sample string 10</d2p1:Phone1> <d2p1:Phone2>sample string 11</d2p1:Phone2> <d2p1:Salesperson>sample string 12</d2p1:Salesperson> <d2p1:State>sample string 7</d2p1:State> <d2p1:ZipCode>sample string 8</d2p1:ZipCode> </d2p1:clsAPICustomer> <d2p1:clsAPICustomer> <d2p1:Address1>sample string 3</d2p1:Address1> <d2p1:Address2>sample string 4</d2p1:Address2> <d2p1:Address3>sample string 5</d2p1:Address3> <d2p1:AlternateCustomerIdPrintout>sample string 16</d2p1:AlternateCustomerIdPrintout> <d2p1:AlternateCustomerIdSelecting>sample string 17</d2p1:AlternateCustomerIdSelecting> <d2p1:City>sample string 6</d2p1:City> <d2p1:County>sample string 9</d2p1:County> <d2p1:CustomerGUID>sample string 15</d2p1:CustomerGUID> <d2p1:FederalPermitList xmlns:d4p1="http://schemas.datacontract.org/2004/07/SKY.Core.Customer"> <d4p1:ClsCustomer.ClsCustFedPerm> <d4p1:CustID>sample string 1</d4p1:CustID> <d4p1:ExpDate>sample string 4</d4p1:ExpDate> <d4p1:LineItem>2</d4p1:LineItem> <d4p1:Permit>sample string 3</d4p1:Permit> </d4p1:ClsCustomer.ClsCustFedPerm> <d4p1:ClsCustomer.ClsCustFedPerm> <d4p1:CustID>sample string 1</d4p1:CustID> <d4p1:ExpDate>sample string 4</d4p1:ExpDate> <d4p1:LineItem>2</d4p1:LineItem> <d4p1:Permit>sample string 3</d4p1:Permit> </d4p1:ClsCustomer.ClsCustFedPerm> </d2p1:FederalPermitList> <d2p1:ID>sample string 1</d2p1:ID> <d2p1:Location>sample string 14</d2p1:Location> <d2p1:Name>sample string 2</d2p1:Name> <d2p1:Notes>sample string 13</d2p1:Notes> <d2p1:Phone1>sample string 10</d2p1:Phone1> <d2p1:Phone2>sample string 11</d2p1:Phone2> <d2p1:Salesperson>sample string 12</d2p1:Salesperson> <d2p1:State>sample string 7</d2p1:State> <d2p1:ZipCode>sample string 8</d2p1:ZipCode> </d2p1:clsAPICustomer> </Customers> <Message>sample string 2</Message> <Status>sample string 1</Status> </AgvCustomer>