POST api/quickbook/UpdateCustomer
Update Customer
Request Information
URI Parameters
None.
Body Parameters
CustomerRequestDataModelName | Description | Type | Additional information |
---|---|---|---|
RequestModel | QboCommonRequestModel |
None. |
|
Id | string |
None. |
|
CustomerID | integer |
None. |
|
CustomerCode | string |
None. |
|
Title | string |
None. |
|
GivenName | string |
None. |
|
MiddleName | string |
None. |
|
Currency | string |
None. |
|
CurrencyID | string |
None. |
|
FamilyName | string |
None. |
|
string |
None. |
||
PhoneCode | string |
None. |
|
Phone | string |
None. |
|
WAPhoneCode | string |
None. |
|
WAPhone | string |
None. |
|
Address | CustomerAddressRequestModel |
None. |
|
IsPartialUpdate | boolean |
None. |
Request Formats
application/json, text/json, text/plain, text/html
Sample:
{ "requestModel": { "userId": 1, "apiKey": "sample string 2" }, "id": "sample string 1", "customerID": 1, "customerCode": "sample string 2", "title": "sample string 3", "givenName": "sample string 4", "middleName": "sample string 5", "currency": "sample string 6", "currencyID": "sample string 7", "familyName": "sample string 8", "email": "sample string 9", "phoneCode": "sample string 10", "phone": "sample string 11", "waPhoneCode": "sample string 12", "waPhone": "sample string 13", "address": { "addressL1": "sample string 1", "addressL2": "sample string 2", "country": "sample string 3", "state": "sample string 4", "city": "sample string 5", "zip": "sample string 6" }, "isPartialUpdate": true }
application/xml, text/xml
Sample:
<CustomerRequestDataModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CMMS_V2.Core.RequestModel"> <Address> <AddressL1>sample string 1</AddressL1> <AddressL2>sample string 2</AddressL2> <City>sample string 5</City> <Country>sample string 3</Country> <State>sample string 4</State> <Zip>sample string 6</Zip> </Address> <Currency>sample string 6</Currency> <CurrencyID>sample string 7</CurrencyID> <CustomerCode>sample string 2</CustomerCode> <CustomerID>1</CustomerID> <Email>sample string 9</Email> <FamilyName>sample string 8</FamilyName> <GivenName>sample string 4</GivenName> <Id>sample string 1</Id> <IsPartialUpdate>true</IsPartialUpdate> <MiddleName>sample string 5</MiddleName> <Phone>sample string 11</Phone> <PhoneCode>sample string 10</PhoneCode> <RequestModel> <APIKey>sample string 2</APIKey> <UserId>1</UserId> </RequestModel> <Title>sample string 3</Title> <WAPhone>sample string 13</WAPhone> <WAPhoneCode>sample string 12</WAPhoneCode> </CustomerRequestDataModel>
multipart/form-data
Sample:
<CustomerRequestDataModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CMMS_V2.Core.RequestModel"><Address><AddressL1>sample string 1</AddressL1><AddressL2>sample string 2</AddressL2><City>sample string 5</City><Country>sample string 3</Country><State>sample string 4</State><Zip>sample string 6</Zip></Address><Currency>sample string 6</Currency><CurrencyID>sample string 7</CurrencyID><CustomerCode>sample string 2</CustomerCode><CustomerID>1</CustomerID><Email>sample string 9</Email><FamilyName>sample string 8</FamilyName><GivenName>sample string 4</GivenName><Id>sample string 1</Id><IsPartialUpdate>true</IsPartialUpdate><MiddleName>sample string 5</MiddleName><Phone>sample string 11</Phone><PhoneCode>sample string 10</PhoneCode><RequestModel><APIKey>sample string 2</APIKey><UserId>1</UserId></RequestModel><Title>sample string 3</Title><WAPhone>sample string 13</WAPhone><WAPhoneCode>sample string 12</WAPhoneCode></CustomerRequestDataModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Action Status
CommonResponseDataModelName | Description | Type | Additional information |
---|---|---|---|
ReturnID | integer |
Required |
|
Message | string |
Required |
|
Successful | boolean |
Required |
|
Code | integer |
None. |
|
TotalRecord | integer |
None. |
Response Formats
application/json, text/json, text/plain, text/html
Sample:
{ "returnID": 1, "message": "sample string 2", "successful": true, "code": 4, "totalRecord": 5 }
application/xml, text/xml
Sample:
<CommonResponseDataModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel"> <Code>4</Code> <Message>sample string 2</Message> <ReturnID>1</ReturnID> <Successful>true</Successful> <TotalRecord>5</TotalRecord> </CommonResponseDataModel>
multipart/form-data
Sample:
<CommonResponseDataModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel"><Code>4</Code><Message>sample string 2</Message><ReturnID>1</ReturnID><Successful>true</Successful><TotalRecord>5</TotalRecord></CommonResponseDataModel>