POST v1/Payment/PostAdjustment

Post a Billing Adjustment to a given Billing Item

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
UserId	User Id	integer	None.
PolicyNumber	Policy Number or Underlying Policy Number	string	String length: inclusive between 0 and 30
Amount	Amount	decimal number	None.
Source	Source (Optional)	string	String length: inclusive between 0 and 500
AmendmentId	Amendment Id (504 = AdjustBalance, 542 = CashAdjustment)	integer	None.
ItemNumber	Item Number being adjusted	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "UserId": 1,
  "PolicyNumber": "sample string 2",
  "Amount": 3.0,
  "Source": "sample string 4",
  "AmendmentId": 1,
  "ItemNumber": 1
}

application/xml, text/xml

Sample:

<AdjustmentInboundDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models.Inbound">
  <AmendmentId>1</AmendmentId>
  <Amount>3</Amount>
  <ItemNumber>1</ItemNumber>
  <PolicyNumber>sample string 2</PolicyNumber>
  <Source>sample string 4</Source>
  <UserId>1</UserId>
</AdjustmentInboundDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Post a Billing Adjustment to a given Billing Item

AdjustmentOutboundDTO

Name	Description	Type	Additional information
BillingTransactionId		integer	None.
Id	Primary Id	integer	None.
WarningMessages	List of warning messages encountered while servicing request	Collection of string	None.

Response Formats

application/json, text/json

Sample:

{
  "BillingTransactionId": 1,
  "Id": 1
}

application/xml, text/xml

Sample:

<AdjustmentOutboundDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models.Outbound">
  <Id>1</Id>
  <BillingTransactionId>1</BillingTransactionId>
</AdjustmentOutboundDTO>