Customer

Customer Object

The Customer is a primary record type in Order Time.  

End Point

/customer

GET, POST, PUT, DELETE

GET and DELETE requests expect parameter id of type Int32.

Merging two Customers via API (comming soon)

POST:   E.g  /customer/Merge?customerIdToMerge=3&targetCustomerId=5&mergeAddresses-true.  

  • The paramater customerIdToMerge is the Id of the Customer (Int32) that you want to delete.
  •  targetCustomerId s the Id of the Customer (Int32) that you want to keep
  • mergeAddresses is a boolean.  True means you want to keep the addresses of the customer that will be deleted. 

Properties

PropertyCaptionData TypeRequired
AccountNumberAccount #String (99)False
CompanyNameCompanyString (50)False
NameNameString (50)True
ParentSub ofString (50)False
TaxRegistrationNumberTax Reg. No.String (50)False
WebsiteWebsiteString (50)False
CreditCardAddressCredit Card AddressString (41)False
CreditCardNameName on CardString (41)False
NoteNoteString (4000)False
ShippingInstructionsShipping InstructionsString (4000)False
CreditCardNoCredit Card No.String (200)False
SalesTaxCertificateResell NumberString (15)False
CreditCardZipCredit Card Zip/PostalString (13)False
InvoiceSendMethodInvoice Send MethodSendMethodEnumFalse
PrimaryContactPrimary ContactPersonFalse
IdIdInt32False
ExpMonthExpire MonthInt16False
ExpYearExpYearInt16False
ARAccountRefA/R AccountEntityRefFalse
ClassRefClassEntityRefFalse
CurrencyRefCurrencyEntityRefFalse
DiscountRefDiscountEntityRefFalse
FOBRefFOBEntityRefFalse
ItemSalesTaxRefTax ItemEntityRefFalse
PaymentMethodRefPayment MethodEntityRefFalse
PriceLevelRefPrice LevelEntityRefFalse
ProxyRefProxyEntityRefFalse
SalesRepRefSales RepEntityRefFalse
SalesTaxCodeRefTax CodeEntityRefFalse
ShipMethodRefShip MethodEntityRefFalse
TermRefTermsEntityRefFalse
TypeRefTypeEntityRefFalse
CreditLimitCredit LimitDecimalFalse
IsActiveActiveBooleanFalse
OnCreditHoldHold OrdersBooleanFalse
AllowShipPartialAllow Ship PartialAllowShipPartialEnumFalse
BillAddressBill AddressAddressFalse
PrimaryShipAddressPrimary Ship AddressAddressFalse
CustomFieldsCustom FieldsArray of CustomFieldDataFalse

CreditCardNo will not be returned on any GET requests.

Json Sample

{
    Id: 1947,
    Name: "Peter Pan LLC",
    IsActive: true,
    CompanyName: "Peter Pan LLC",
    PrimaryContact: {
        Salutation:"Mr." ,
        FirstName: "Aaron",
        MiddleName:"H" ,
        LastName: "Rogers"
    },
    BillAddress: {           
        Name: "Default",
        Addr1: "Peter Pan LLC",
        Addr2: "45 Hart St",
        Addr3: "Suite 5",
        Addr4:"" ,
        City: "NY",
        State: "NY",
        Zip: "00250",
        Email: "aaron@greenbay.com",    
    },
    PrimaryShipAddress: {           
        Name: "Default",
        Addr1: "Peter Pan LLC",
        Addr2: "45 Hart St",
        Addr3: "Suite 5",       
        City: "NY",
        State: "NY",
        Zip: "00250",      
        Email: "aaron@greenbay.com"    
    },
    SalesTaxCodeRef: {
        Id: 3,
        Name: "Non"
    },   
    CustomFields: [
      {       
        Name: "CustomerCust1", 
        Value: 8798,
      },
      {    
        Name: "CustomerCust2", 
        Value: true,
      }
     ]
}