PUT Customer/PutCustomer

Edit a Customer

Request Information

URI Parameters

Body Parameters

ClsCustomerEdit
NameDescriptionTypeAdditional Information
CustomerID

Agvance Customer ID (also referred to as Grower ID)

 string

Max length: 6
CustomerGUID

Globally Unique Identifier of the Customer - if provided, will be used in place of CustomerID to identify the customer to be updated

 globally unique identifier
FirstName

First name of the customer

 string

Max length: 20
LastName

Last name of the customer

 string

Max length: 50
Address1

Address line 1

 string

Max length: 50
Address2

Address line 2

 string

Max length: 50
Address3

Address line 3

 string

Max length: 50
City

City

 string

Max length: 25
State

State

 string

Max length: 2
ZipCode

Zip Code

 string

Max length: 10
Phone1

Phone Number 1

 string

Max length: 15
Phone2

Phone Number 2

 string

Max length: 15
Notes

Notes from customer profile

 string
Salesperson

Salesperson assigned to the customer

 string

Max length: 15
EmailAddress

Email address of this contact - FirstName and LastName or the LastName is required to update the email address

 string

Max length: 50
LocationID

ID of the location assigned to the customer

 string

Max length: 6
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
CredLim

Credit limit

 decimal number
FinChrgPer

Finance charge %

 decimal number
CredStatus

Credit status, default available options are 'Excellent', 'Fair', 'Good', 'Hold', 'Poor'

 string

Max length: 20
DefaultPaymentTerms

The ID of the payment terms related to this customer

 string

Max length: 15
GrowerYN

True if the customer is a grower, False otherwise

 boolean
Active

Active/Inactive flag. A=Active, I=Inactive

 string

Max length: 1
County

The name of the county

 string

Max length: 60
Country

The name of the country

 string

Max length: 60
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
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
Gln

The Global Location Number assigned to the customer, must be 13 digits

 string

Max length: 13
PrintStatement

Print Statement. Valid options are Y (Yes), N (No), or F (If 30 Days Past Due)

 string

Max length: 1
SsnTaxIdNum

Social Security Number/Tax ID

 string

Max length: 20
CreditActive

Whether or not this customer has a credit line

 boolean
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
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
ReasonExpDate

This customer's tax exemption expiration date

 string

Data type: DateTime

Format must be MM/dd/yyyy
AchAcctNum

ACH bank account number

 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
AchNameOnAccount

ACH name on account at the bank

 string

Max length: 100
PrintBbStatement

Whether or not to print the budget billing statement (energy)

 boolean

Must be 0, 1, True, or False
FederalPermitList

List of federal permits for the customer

 Collection of ClsCustFedPermEdit
CustomerContactList

List of customer contacts for the customer

 Collection of ClsCustContactsEdit
CustClassificationsEdit

Classifications this customer belongs to. IF any values are provided, the customer's existing Classifications will be fully replaced.

 Collection of ClsCustClassEdit
CustAttributesEdit

Attributes related to this customer

 Collection of ClsCustAttributesEdit
CustBankAccountsEdit

Account types, routing numbers, and account numbers for bank accounts related to this customer

 Collection of ClsCustBankAccountsEdit
ExtraChargesCust

Extra Charges related to this customer

 Collection of ClsExtraChargesCustomerAdd
CustNotify

Document specific rules detailing the document type, how they should be sent, and the email address they should be sent to

 Collection of ClsCustNotifyEdit

Request Formats

application/json, text/json

Sample: 
{
  "CustomerID": "sample string 4",
  "CustomerGUID": "d940e377-1cd1-4d14-81dc-64612ce28715",
  "FirstName": "sample string 5",
  "LastName": "sample string 6",
  "Address1": "sample string 7",
  "Address2": "sample string 8",
  "Address3": "sample string 9",
  "City": "sample string 10",
  "State": "sample string 11",
  "ZipCode": "sample string 12",
  "Phone1": "sample string 13",
  "Phone2": "sample string 14",
  "Notes": "sample string 15",
  "Salesperson": "sample string 16",
  "EmailAddress": "sample string 17",
  "LocationID": "sample string 18",
  "CrossRef1": "sample string 19",
  "CrossRef2": "sample string 20",
  "CrossRef3": "sample string 21",
  "CrossRef4": "sample string 22",
  "CredLim": 1.1,
  "FinChrgPer": 1.1,
  "CredStatus": "sample string 23",
  "DefaultPaymentTerms": "sample string 24",
  "GrowerYN": true,
  "Active": "sample string 25",
  "County": "sample string 26",
  "Country": "sample string 27",
  "AddrLat": 1,
  "AddrLon": 1,
  "StTaxCode": "sample string 28",
  "AdjTaxCode": "sample string 29",
  "HealthId": "sample string 30",
  "AgrianCustId": "sample string 31",
  "AgrianStatePermitGrowerId": "sample string 32",
  "Gln": "sample string 33",
  "PrintStatement": "sample string 34",
  "SsnTaxIdNum": "sample string 35",
  "CreditActive": true,
  "AcctNum": "sample string 36",
  "AcctType": "sample string 37",
  "AbaRouteNum": "sample string 38",
  "TaxId": "sample string 39",
  "Taxable": true,
  "Reason": "sample string 40",
  "ReasonExpDate": "sample string 41",
  "AchAcctNum": "sample string 42",
  "AchAcctType": "sample string 43",
  "AchAbaRouteNum": "sample string 44",
  "AchNameOnAccount": "sample string 46",
  "PrintBbStatement": true,
  "FederalPermitList": [
    {
      "Permit": "sample string 1",
      "ExpDate": "sample string 2"
    },
    {
      "Permit": "sample string 1",
      "ExpDate": "sample string 2"
    }
  ],
  "CustomerContactList": [
    {
      "ContactName": "sample string 1",
      "EmailAddress": "sample string 2",
      "PhoneNumber": "sample string 3",
      "LineItem": 4
    },
    {
      "ContactName": "sample string 1",
      "EmailAddress": "sample string 2",
      "PhoneNumber": "sample string 3",
      "LineItem": 4
    }
  ],
  "CustClassificationsEdit": [
    {
      "ClassName": "sample string 1"
    },
    {
      "ClassName": "sample string 1"
    }
  ],
  "CustAttributesEdit": [
    {
      "AttributeValue": "sample string 1",
      "CrossRef": "sample string 2"
    },
    {
      "AttributeValue": "sample string 1",
      "CrossRef": "sample string 2"
    }
  ],
  "CustBankAccountsEdit": [
    {
      "AccountType": "sample string 1",
      "RoutingNumber": "sample string 2",
      "BankAccountNumber": "sample string 3",
      "LineItem": 4,
      "DeleteMe": true
    },
    {
      "AccountType": "sample string 1",
      "RoutingNumber": "sample string 2",
      "BankAccountNumber": "sample string 3",
      "LineItem": 4,
      "DeleteMe": true
    }
  ],
  "ExtraChargesCust": [
    {
      "ExtraChargeId": "sample string 1"
    },
    {
      "ExtraChargeId": "sample string 1"
    }
  ],
  "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
    }
  ]
}

application/xml, text/xml

Sample: 
<CustomerEdit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SKY.Core.Customer">
  <AbaRouteNum>sample string 38</AbaRouteNum>
  <AcctNum>sample string 36</AcctNum>
  <AcctType>sample string 37</AcctType>
  <AchAbaRouteNum>sample string 44</AchAbaRouteNum>
  <AchAcctNum>sample string 42</AchAcctNum>
  <AchAcctType>sample string 43</AchAcctType>
  <AchNameOnAccount>sample string 46</AchNameOnAccount>
  <Active>sample string 25</Active>
  <AddrLat>1</AddrLat>
  <AddrLon>1</AddrLon>
  <Address1>sample string 7</Address1>
  <Address2>sample string 8</Address2>
  <Address3>sample string 9</Address3>
  <AdjTaxCode>sample string 29</AdjTaxCode>
  <AgrianCustId>sample string 31</AgrianCustId>
  <AgrianStatePermitGrowerId>sample string 32</AgrianStatePermitGrowerId>
  <City>sample string 10</City>
  <Country>sample string 27</Country>
  <County>sample string 26</County>
  <CredLim>1.1</CredLim>
  <CredStatus>sample string 23</CredStatus>
  <CreditActive>true</CreditActive>
  <CrossRef1>sample string 19</CrossRef1>
  <CrossRef2>sample string 20</CrossRef2>
  <CrossRef3>sample string 21</CrossRef3>
  <CrossRef4>sample string 22</CrossRef4>
  <CustAttributesEdit>
    <ClsCustomer.ClsCustomerEdit.ClsCustAttributesEdit>
      <AttributeValue>sample string 1</AttributeValue>
      <CrossRef>sample string 2</CrossRef>
    </ClsCustomer.ClsCustomerEdit.ClsCustAttributesEdit>
    <ClsCustomer.ClsCustomerEdit.ClsCustAttributesEdit>
      <AttributeValue>sample string 1</AttributeValue>
      <CrossRef>sample string 2</CrossRef>
    </ClsCustomer.ClsCustomerEdit.ClsCustAttributesEdit>
  </CustAttributesEdit>
  <CustBankAccountsEdit>
    <ClsCustomer.ClsCustomerEdit.ClsCustBankAccountsEdit>
      <AccountType>sample string 1</AccountType>
      <BankAccountNumber>sample string 3</BankAccountNumber>
      <DeleteMe>true</DeleteMe>
      <LineItem>4</LineItem>
      <RoutingNumber>sample string 2</RoutingNumber>
    </ClsCustomer.ClsCustomerEdit.ClsCustBankAccountsEdit>
    <ClsCustomer.ClsCustomerEdit.ClsCustBankAccountsEdit>
      <AccountType>sample string 1</AccountType>
      <BankAccountNumber>sample string 3</BankAccountNumber>
      <DeleteMe>true</DeleteMe>
      <LineItem>4</LineItem>
      <RoutingNumber>sample string 2</RoutingNumber>
    </ClsCustomer.ClsCustomerEdit.ClsCustBankAccountsEdit>
  </CustBankAccountsEdit>
  <CustClassificationsEdit>
    <ClsCustomer.ClsCustomerEdit.ClsCustClassEdit>
      <ClassName>sample string 1</ClassName>
    </ClsCustomer.ClsCustomerEdit.ClsCustClassEdit>
    <ClsCustomer.ClsCustomerEdit.ClsCustClassEdit>
      <ClassName>sample string 1</ClassName>
    </ClsCustomer.ClsCustomerEdit.ClsCustClassEdit>
  </CustClassificationsEdit>
  <CustNotify>
    <ClsCustomer.ClsCustomerEdit.ClsCustNotifyEdit>
      <DeliverTo>sample string 2</DeliverTo>
      <DocumentType>sample string 1</DocumentType>
      <EmailAddress>sample string 3</EmailAddress>
      <IncludeDocumentAsAttachment>true</IncludeDocumentAsAttachment>
    </ClsCustomer.ClsCustomerEdit.ClsCustNotifyEdit>
    <ClsCustomer.ClsCustomerEdit.ClsCustNotifyEdit>
      <DeliverTo>sample string 2</DeliverTo>
      <DocumentType>sample string 1</DocumentType>
      <EmailAddress>sample string 3</EmailAddress>
      <IncludeDocumentAsAttachment>true</IncludeDocumentAsAttachment>
    </ClsCustomer.ClsCustomerEdit.ClsCustNotifyEdit>
  </CustNotify>
  <CustomerContactList>
    <ClsCustomer.ClsCustomerEdit.ClsCustContactsEdit>
      <ContactName>sample string 1</ContactName>
      <EmailAddress>sample string 2</EmailAddress>
      <LineItem>4</LineItem>
      <PhoneNumber>sample string 3</PhoneNumber>
    </ClsCustomer.ClsCustomerEdit.ClsCustContactsEdit>
    <ClsCustomer.ClsCustomerEdit.ClsCustContactsEdit>
      <ContactName>sample string 1</ContactName>
      <EmailAddress>sample string 2</EmailAddress>
      <LineItem>4</LineItem>
      <PhoneNumber>sample string 3</PhoneNumber>
    </ClsCustomer.ClsCustomerEdit.ClsCustContactsEdit>
  </CustomerContactList>
  <CustomerGUID>d940e377-1cd1-4d14-81dc-64612ce28715</CustomerGUID>
  <CustomerID>sample string 4</CustomerID>
  <DefaultPaymentTerms>sample string 24</DefaultPaymentTerms>
  <EmailAddress>sample string 17</EmailAddress>
  <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.ClsCustomerEdit.ClsCustFedPermEdit>
      <ExpDate>sample string 2</ExpDate>
      <Permit>sample string 1</Permit>
    </ClsCustomer.ClsCustomerEdit.ClsCustFedPermEdit>
    <ClsCustomer.ClsCustomerEdit.ClsCustFedPermEdit>
      <ExpDate>sample string 2</ExpDate>
      <Permit>sample string 1</Permit>
    </ClsCustomer.ClsCustomerEdit.ClsCustFedPermEdit>
  </FederalPermitList>
  <FinChrgPer>1.1</FinChrgPer>
  <FirstName>sample string 5</FirstName>
  <Gln>sample string 33</Gln>
  <GrowerYN>true</GrowerYN>
  <HealthId>sample string 30</HealthId>
  <LastName>sample string 6</LastName>
  <LocationID>sample string 18</LocationID>
  <Notes>sample string 15</Notes>
  <Phone1>sample string 13</Phone1>
  <Phone2>sample string 14</Phone2>
  <PrintBbStatement>true</PrintBbStatement>
  <PrintStatement>sample string 34</PrintStatement>
  <Reason>sample string 40</Reason>
  <ReasonExpDate>sample string 41</ReasonExpDate>
  <Salesperson>sample string 16</Salesperson>
  <SsnTaxIdNum>sample string 35</SsnTaxIdNum>
  <StTaxCode>sample string 28</StTaxCode>
  <State>sample string 11</State>
  <TaxId>sample string 39</TaxId>
  <Taxable>true</Taxable>
  <ZipCode>sample string 12</ZipCode>
</CustomerEdit>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ClsCustomerEdit'.

Response Information

Resource Description

Edit a Customer

AgvCustomer
NameDescriptionTypeAdditional 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

Sample: 
{
  "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

Sample: 
<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>