POST v1/Locations/{locationID}/Finance/PaymentInformation

Update the Payment information

Request Information

URI Parameters

NameDescriptionTypeAdditional information
locationID

Id of the location

string

Required

Body Parameters

Payment information

LocationPaymentInformationDTO
NameDescriptionTypeAdditional information
LocationPaymentInformationID

Id of the location payment information

integer

None.

RemitBy

Remit by

integer

None.

LocationID

Id of the location

integer

None.

PaymentPayableToType

Payment payable to type

string

None.

Request Formats

application/json, text/json

Sample:
{
  "LocationPaymentInformationID": 1,
  "RemitBy": 2,
  "LocationID": 3,
  "PaymentPayableToType": "sample string 4"
}

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

application/xml, text/xml

Sample:
<LocationPaymentInformationDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Locations">
  <LocationID>3</LocationID>
  <LocationPaymentInformationID>1</LocationPaymentInformationID>
  <PaymentPayableToType>sample string 4</PaymentPayableToType>
  <RemitBy>2</RemitBy>
</LocationPaymentInformationDTO>

Response Information

Resource Description

Updated location payment information

ActionResultDTOOfLocationPaymentInformationDTO
NameDescriptionTypeAdditional information
Result

LocationPaymentInformationDTO

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": {
    "LocationPaymentInformationID": 1,
    "RemitBy": 2,
    "LocationID": 3,
    "PaymentPayableToType": "sample string 4"
  },
  "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:
<ActionResultOfLocationPaymentInformationDTO 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.Locations">
    <d2p1:LocationID>3</d2p1:LocationID>
    <d2p1:LocationPaymentInformationID>1</d2p1:LocationPaymentInformationID>
    <d2p1:PaymentPayableToType>sample string 4</d2p1:PaymentPayableToType>
    <d2p1:RemitBy>2</d2p1:RemitBy>
  </Result>
  <RowSource>sample string 3</RowSource>
</ActionResultOfLocationPaymentInformationDTO>