POST v1/Locations/Finance/PaymentPayableAddress

Update a Payment Payable To address

Request Information

URI Parameters

None.

Body Parameters

Payment Payable To address

Name	Description	Type	Additional information
AddressID	Id of the address	integer	None.
EntityID	Id of the entity	integer	None.
AddressTypeID	Address type id	string	None.
AddressType	Address type	AddressTypeDTO	None.
Line1	Line 1	string	None.
Line2	Line 2	string	None.
City	City	string	None.
State	State	string	None.
County	Country	string	None.
CountryCode	Country code	string	None.
Province	Province	string	None.
Zip	ZIP code	string	None.
Latitude	Latitude	decimal number	None.
Longitude	Longitude	decimal number	None.
Notes	Notes	string	None.
RowSource	Row source	string	None.
isPreferred	Signifies whether the address is preferred	boolean	None.
AddressString	Address as string	string	None.

Request Formats

application/json, text/json

Sample:

{
  "AddressID": 1,
  "EntityID": 2,
  "AddressTypeID": "sample string 3",
  "AddressType": {
    "AddressTypeID": "A",
    "Name": "sample string 2"
  },
  "Line1": "sample string 4",
  "Line2": "sample string 5",
  "City": "sample string 6",
  "State": "sample string 7",
  "County": "sample string 8",
  "CountryCode": "sample string 9",
  "Province": "sample string 10",
  "Zip": "sample string 11",
  "Latitude": 1.1,
  "Longitude": 1.1,
  "Notes": "sample string 12",
  "RowSource": "sample string 13",
  "isPreferred": true,
  "AddressString": "sample string 14"
}

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 'AddressDTO'.

application/xml, text/xml

Sample:

<AddressDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Contacts">
  <AddressID>1</AddressID>
  <AddressString>sample string 14</AddressString>
  <AddressType>
    <AddressTypeID>65</AddressTypeID>
    <Name>sample string 2</Name>
  </AddressType>
  <AddressTypeID>sample string 3</AddressTypeID>
  <City>sample string 6</City>
  <CountryCode>sample string 9</CountryCode>
  <County>sample string 8</County>
  <EntityID>2</EntityID>
  <Latitude>1.1</Latitude>
  <Line1>sample string 4</Line1>
  <Line2>sample string 5</Line2>
  <Longitude>1.1</Longitude>
  <Notes>sample string 12</Notes>
  <Province>sample string 10</Province>
  <RowSource>sample string 13</RowSource>
  <State>sample string 7</State>
  <Zip>sample string 11</Zip>
  <isPreferred>true</isPreferred>
</AddressDTO>

Response Information

Resource Description

Updated Payment Payable To address

ActionResultDTOOfAddressDTO

Name	Description	Type	Additional information
Result		AddressDTO	None.
CreatedBy		string	None.
EntityID		integer	None.
RowSource		string	None.
PolicyID		integer	None.
IsSuccess	Signifies whether action is successful	boolean	None.
ErrorCode	Error code	string	None.
ErrorMessage	Error message	string	None.
InfoMessage	Information message	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Result": {
    "AddressID": 1,
    "EntityID": 2,
    "AddressTypeID": "sample string 3",
    "AddressType": {
      "AddressTypeID": "A",
      "Name": "sample string 2"
    },
    "Line1": "sample string 4",
    "Line2": "sample string 5",
    "City": "sample string 6",
    "State": "sample string 7",
    "County": "sample string 8",
    "CountryCode": "sample string 9",
    "Province": "sample string 10",
    "Zip": "sample string 11",
    "Latitude": 1.1,
    "Longitude": 1.1,
    "Notes": "sample string 12",
    "RowSource": "sample string 13",
    "isPreferred": true,
    "AddressString": "sample string 14"
  },
  "CreatedBy": "sample string 1",
  "EntityID": 2,
  "RowSource": "sample string 3",
  "PolicyID": 4,
  "IsSuccess": true,
  "ErrorCode": "sample string 6",
  "ErrorMessage": "sample string 7",
  "InfoMessage": "sample string 8"
}

application/xml, text/xml

Sample:

<ActionResultOfAddressDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects">
  <ErrorCode>sample string 6</ErrorCode>
  <ErrorMessage>sample string 7</ErrorMessage>
  <InfoMessage>sample string 8</InfoMessage>
  <IsSuccess>true</IsSuccess>
  <CreatedBy>sample string 1</CreatedBy>
  <EntityID>2</EntityID>
  <PolicyID>4</PolicyID>
  <Result xmlns:d2p1="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Contacts">
    <d2p1:AddressID>1</d2p1:AddressID>
    <d2p1:AddressString>sample string 14</d2p1:AddressString>
    <d2p1:AddressType>
      <d2p1:AddressTypeID>65</d2p1:AddressTypeID>
      <d2p1:Name>sample string 2</d2p1:Name>
    </d2p1:AddressType>
    <d2p1:AddressTypeID>sample string 3</d2p1:AddressTypeID>
    <d2p1:City>sample string 6</d2p1:City>
    <d2p1:CountryCode>sample string 9</d2p1:CountryCode>
    <d2p1:County>sample string 8</d2p1:County>
    <d2p1:EntityID>2</d2p1:EntityID>
    <d2p1:Latitude>1.1</d2p1:Latitude>
    <d2p1:Line1>sample string 4</d2p1:Line1>
    <d2p1:Line2>sample string 5</d2p1:Line2>
    <d2p1:Longitude>1.1</d2p1:Longitude>
    <d2p1:Notes>sample string 12</d2p1:Notes>
    <d2p1:Province>sample string 10</d2p1:Province>
    <d2p1:RowSource>sample string 13</d2p1:RowSource>
    <d2p1:State>sample string 7</d2p1:State>
    <d2p1:Zip>sample string 11</d2p1:Zip>
    <d2p1:isPreferred>true</d2p1:isPreferred>
  </Result>
  <RowSource>sample string 3</RowSource>
</ActionResultOfAddressDTO>