Update a billing adjustment
patch
/crmRestApi/resources/11.13.18.05/billingAdjustments/{BillAdjustmentRequestsNumber}
Request
Path Parameters
-
BillAdjustmentRequestsNumber(required): string
The unique identifier of the bill adjustment request record.
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AdditionalComments: string
Title:
Additional Comments
Maximum Length:255
The additional approval or rejection comments for this adjustment. -
AdjustmentReason: string
Title:
Adjustment Reason
Maximum Length:30
The reason for the bill adjustment. -
AdjustmentType: string
Title:
Adjustment Type
Maximum Length:20
The type of the adjustment request, such as bill, item or event level adjustment. -
AdjustmentUnitOfMeasure: string
Title:
Unit of Measure
Maximum Length:100
The unit of measure for the bill adjustment. -
AmountDue: number
Title:
Amount Due
The actual due amount. -
ApproveAmount: number
Title:
Approved Amount
The amount for which adjustment is approved. -
ApprovedByPartyId: integer
(int64)
Title:
Approved by Party ID
The unique identifier of the user who approved the adjustment request. -
ApprovePercent: number
Title:
Approved Percentage
The percentage of amount for which adjustment is approved. -
AssigneeResourceId: integer
(int64)
Title:
Assigned to Resource ID
The unique identifier of the resource assigned to the service request. -
billingAdjustmentEvents: array
Billing Adjustment Events
Title:
Billing Adjustment Events
The billing adjustment event resource is used to view, create, update, and delete a billing adjustment events. -
Comments: string
Title:
Comments
Maximum Length:255
The comments for this adjustment. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The corporate currency code of the bill adjustment request. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
The rate type of currency conversion. -
CurrencyCode: string
Title:
Currency Code
Maximum Length:15
The currency code of the bill adjustment request. -
ExternalAdjustmentId: string
Title:
External Adjustment ID
Maximum Length:300
The adjustment ID from the external billing system. -
ExternalAdjustmentNumber: string
Title:
External Adjustment Number
Maximum Length:300
The public unique identifier of adjustment from the external billing system. -
ExternalBalanceGroupId: string
Title:
External Balance Group ID
Maximum Length:300
The unique identifier of balance group of noncurrency from the external billing system. -
ExternalBalanceGroupNumber: string
Title:
External Balance Group Number
Maximum Length:300
The public unique identifier of balance group of noncurrency from the external billing system. -
ExternalBillId: string
Title:
External Bill ID
Maximum Length:300
The bill ID from the external billing system. -
ExternalBillItemId: string
Title:
External Bill Item ID
Maximum Length:300
The bill item ID from the external billing system. -
ExternalBillItemNumber: string
Title:
External Bill Item Number
Maximum Length:300
The public unique identifier of the bill item from the external billing system. -
ExternalBillNumber: string
Title:
External Bill Number
Maximum Length:300
The public unique identifier of the bill from the external billing system. -
ExternalBillUnitId: string
Title:
External Bill Unit ID
Maximum Length:300
The unique identifier of the bill unit for the adjustment request. -
ExternalBillUnitNumber: string
Title:
External Bill Unit Number
Maximum Length:300
The public unique identifier of the bill unit for the adjustment request. -
ExternalServiceId: string
Title:
External Service ID
Maximum Length:300
The service ID from the external billing system. -
ExternalServiceNumber: string
Title:
External Service Number
Maximum Length:300
The public unique identifier of the service from the external billing system. -
ExternalServiceType: string
Title:
External Service Type
Maximum Length:300
The type of the adjusted resource for a noncurrency adjustment request. -
NonCurrencyAdjustmentFlag: boolean
Title:
Noncurrency Adjustment
Maximum Length:1
Default Value:false
Indicates if the adjustment request is for a currency value or non-currency usage. -
NonCurrencyAdjustmentType: string
Title:
Noncurrency Adjustment Type
Maximum Length:30
The type of the adjustment request, such as bill unit or event level for a non-currency adjustment. -
NonCurrencyUsageAmount: number
Title:
Noncurrency Usage
The actual non currency usage before adjustment. -
PrimaryContactPartyId: integer
(int64)
Title:
Primary Contact ID
The unique identifier of the user who initially reported the adjustment request. -
QueueId: integer
(int64)
Title:
Assigned Queue ID
The unique identifier of the queue assigned to the service request. -
RejectedByPartyId: integer
(int64)
Title:
Rejected by Party ID
The unique identifier of the user who rejected the adjustment request. -
RejectReason: string
Title:
Rejection Reason
Maximum Length:255
The reason for rejecting the adjustment. -
RequestAmount: number
Title:
Requested Amount
The amount for which adjustment is requested. -
RequestPercent: number
Title:
Requested Percentage
The percentage of amount for which adjustment is requested. -
StatusCode: string
Title:
Status
Maximum Length:30
The status of the adjustment request. -
SubmittedByPartyId: integer
(int64)
Title:
Submitted by Party ID
The unique ID of the user who submitted the adjustment request. -
TaxTreatment: string
Title:
Tax Treatment
Maximum Length:30
Indicates whether the tax is included in the bill adjustment. -
ValidFrom: string
(date)
Title:
Valid From
The date when the validity for non-currency adjustment starts. -
ValidTo: string
(date)
Title:
Valid To
The date when the validity for non-currency adjustment ends.
Nested Schema : Billing Adjustment Events
Type:
array
Title:
Billing Adjustment Events
The billing adjustment event resource is used to view, create, update, and delete a billing adjustment events.
Show Source
Nested Schema : billingAdjustments-billingAdjustmentEvents-item-patch-request
Type:
Show Source
object
-
ExternalBillEventId: string
Title:
External Bill Event ID
Maximum Length:300
The unique identifier of the external bill event. -
ExternalBillEventNumber: string
Title:
External Bill Event Number
Maximum Length:300
The public unique identifier of the external bill event.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : billingAdjustments-item-response
Type:
Show Source
object
-
AdditionalComments: string
Title:
Additional Comments
Maximum Length:255
The additional approval or rejection comments for this adjustment. -
AdjustmentReason: string
Title:
Adjustment Reason
Maximum Length:30
The reason for the bill adjustment. -
AdjustmentType: string
Title:
Adjustment Type
Maximum Length:20
The type of the adjustment request, such as bill, item or event level adjustment. -
AdjustmentUnitOfMeasure: string
Title:
Unit of Measure
Maximum Length:100
The unit of measure for the bill adjustment. -
AmountDue: number
Title:
Amount Due
The actual due amount. -
ApproveAmount: number
Title:
Approved Amount
The amount for which adjustment is approved. -
ApprovedByPartyId: integer
(int64)
Title:
Approved by Party ID
The unique identifier of the user who approved the adjustment request. -
ApprovedByPartyName: string
Title:
Approved By
Read Only:true
Maximum Length:360
The name of the user who approved the adjustment request. -
ApprovedByPartyNumber: string
Title:
Approved by Party Number
Read Only:true
Maximum Length:30
The public unique identifier of the user who approved the adjustment request. -
ApprovePercent: number
Title:
Approved Percentage
The percentage of amount for which adjustment is approved. -
AssigneePersonName: string
Title:
Assigned To
Read Only:true
Maximum Length:360
The name of the assignee. -
AssigneeResourceId: integer
(int64)
Title:
Assigned to Resource ID
The unique identifier of the resource assigned to the service request. -
AssigneeResourceNumber: string
Title:
Assigned to Resource Number
Read Only:true
Maximum Length:30
The public unique identifier of the assignee. -
BillAdjustmentRequestsId: integer
(int64)
Title:
Bill Adjustment Request ID
Read Only:true
The unique identifier of the bill adjustment request. -
BillAdjustmentRequestsNumber: string
Title:
Bill Adjustment Request Number
Maximum Length:30
The unique identifier of the bill adjustment request record. -
billingAdjustmentEvents: array
Billing Adjustment Events
Title:
Billing Adjustment Events
The billing adjustment event resource is used to view, create, update, and delete a billing adjustment events. -
CategoryId: integer
(int64)
Title:
Category
Read Only:true
The service request category associated with the bill adjustment. -
CategoryName: string
Title:
Category Name
Read Only:true
Maximum Length:400
The service request category name associated with the bill adjustment. -
CategoryShortName: string
Title:
Category Short Name
Read Only:true
Maximum Length:240
The service request category short name. -
Comments: string
Title:
Comments
Maximum Length:255
The comments for this adjustment. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The corporate currency code of the bill adjustment request. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the row. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time of the row creation. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
The rate type of currency conversion. -
CurrencyCode: string
Title:
Currency Code
Maximum Length:15
The currency code of the bill adjustment request. -
DeleteFlag: boolean
Title:
Delete Indicator
Read Only:true
Indicates whether the user can delete the record. -
ExternalAdjustmentId: string
Title:
External Adjustment ID
Maximum Length:300
The adjustment ID from the external billing system. -
ExternalAdjustmentNumber: string
Title:
External Adjustment Number
Maximum Length:300
The public unique identifier of adjustment from the external billing system. -
ExternalBalanceGroupId: string
Title:
External Balance Group ID
Maximum Length:300
The unique identifier of balance group of noncurrency from the external billing system. -
ExternalBalanceGroupNumber: string
Title:
External Balance Group Number
Maximum Length:300
The public unique identifier of balance group of noncurrency from the external billing system. -
ExternalBillId: string
Title:
External Bill ID
Maximum Length:300
The bill ID from the external billing system. -
ExternalBillItemId: string
Title:
External Bill Item ID
Maximum Length:300
The bill item ID from the external billing system. -
ExternalBillItemNumber: string
Title:
External Bill Item Number
Maximum Length:300
The public unique identifier of the bill item from the external billing system. -
ExternalBillNumber: string
Title:
External Bill Number
Maximum Length:300
The public unique identifier of the bill from the external billing system. -
ExternalBillUnitId: string
Title:
External Bill Unit ID
Maximum Length:300
The unique identifier of the bill unit for the adjustment request. -
ExternalBillUnitNumber: string
Title:
External Bill Unit Number
Maximum Length:300
The public unique identifier of the bill unit for the adjustment request. -
ExternalServiceId: string
Title:
External Service ID
Maximum Length:300
The service ID from the external billing system. -
ExternalServiceNumber: string
Title:
External Service Number
Maximum Length:300
The public unique identifier of the service from the external billing system. -
ExternalServiceType: string
Title:
External Service Type
Maximum Length:300
The type of the adjusted resource for a noncurrency adjustment request. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date and time of the last update made to the row. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the row. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The session login associated to the user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NonCurrencyAdjustmentFlag: boolean
Title:
Noncurrency Adjustment
Maximum Length:1
Default Value:false
Indicates if the adjustment request is for a currency value or non-currency usage. -
NonCurrencyAdjustmentType: string
Title:
Noncurrency Adjustment Type
Maximum Length:30
The type of the adjustment request, such as bill unit or event level for a non-currency adjustment. -
NonCurrencyUsageAmount: number
Title:
Noncurrency Usage
The actual non currency usage before adjustment. -
PartyName: string
Title:
Assigned To
Read Only:true
Maximum Length:360
The name of the resource assigned to the service request. -
PrimaryContactPartyId: integer
(int64)
Title:
Primary Contact ID
The unique identifier of the user who initially reported the adjustment request. -
PrimaryContactPartyName: string
Title:
Primary Contact
Read Only:true
Maximum Length:360
The name of the adjustment request primary contact. -
PrimaryContactPartyNumber: string
Title:
Primary Contact Number
Read Only:true
Maximum Length:30
The public unique identifier of the primary contact associated. -
QueueId: integer
(int64)
Title:
Assigned Queue ID
The unique identifier of the queue assigned to the service request. -
QueueName: string
Title:
Queue
Read Only:true
Maximum Length:400
Indicates the service request queue. -
QueueNumber: string
Title:
Queue Number
Read Only:true
Maximum Length:30
The alternative key for the queue identifier. -
RejectedByPartyId: integer
(int64)
Title:
Rejected by Party ID
The unique identifier of the user who rejected the adjustment request. -
RejectedByPartyName: string
Title:
Rejected By
Read Only:true
Maximum Length:360
The name of the user who rejected the adjustment request. -
RejectedByPartyNumber: string
Title:
Rejected by Party Number
Read Only:true
Maximum Length:30
The public unique identifier of the user who rejected the adjustment request. -
RejectReason: string
Title:
Rejection Reason
Maximum Length:255
The reason for rejecting the adjustment. -
ReportedByPartyName: string
Title:
Reported By
Read Only:true
Maximum Length:360
The person who reported the adjustment request. -
RequestAmount: number
Title:
Requested Amount
The amount for which adjustment is requested. -
RequestPercent: number
Title:
Requested Percentage
The percentage of amount for which adjustment is requested. -
SrId: integer
(int64)
Title:
Service Request ID
The unique identifier of a service request record. -
SrNumber: string
Title:
Reference Number
Maximum Length:30
The service request reference number that is associated with the bill adjustment. -
StatusCode: string
Title:
Status
Maximum Length:30
The status of the adjustment request. -
SubmittedByPartyId: integer
(int64)
Title:
Submitted by Party ID
The unique ID of the user who submitted the adjustment request. -
SubmittedByPartyName: string
Title:
Submitted By
Read Only:true
Maximum Length:360
The user who submitted the adjustment request. -
SubmittedByPartyNumber: string
Title:
Submitted by Party ID
Read Only:true
Maximum Length:30
The public unique identifier of the user who submitted the adjustment request. -
TaxTreatment: string
Title:
Tax Treatment
Maximum Length:30
Indicates whether the tax is included in the bill adjustment. -
Title: string
Title:
Title
Read Only:true
Maximum Length:400
The title of a service request. -
UpdateFlag: boolean
Title:
Update Indicator
Read Only:true
Indicates whether the user can update the record. -
ValidFrom: string
(date)
Title:
Valid From
The date when the validity for non-currency adjustment starts. -
ValidTo: string
(date)
Title:
Valid To
The date when the validity for non-currency adjustment ends.
Nested Schema : Billing Adjustment Events
Type:
array
Title:
Billing Adjustment Events
The billing adjustment event resource is used to view, create, update, and delete a billing adjustment events.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : billingAdjustments-billingAdjustmentEvents-item-response
Type:
Show Source
object
-
BillAdjustmentRequestEventsId: integer
(int64)
Title:
Adjustment Event ID
Read Only:true
The unique identifier of the adjustment event. -
BillAdjustmentRequestEventsNumber: string
Title:
Adjustment Event Number
Maximum Length:30
The event number of the adjustment. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the row. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time of the row creation. -
DeleteFlag: boolean
Title:
Delete Indicator
Read Only:true
Indicates whether the user can delete the record. -
ExternalBillEventId: string
Title:
External Bill Event ID
Maximum Length:300
The unique identifier of the external bill event. -
ExternalBillEventNumber: string
Title:
External Bill Event Number
Maximum Length:300
The public unique identifier of the external bill event. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date and time of the last update made to the row. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the row. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The session login associated to the user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
UpdateFlag: boolean
Title:
Update Indicator
Read Only:true
Indicates whether the user can update the record.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- NonCurrencyTypeVA
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_ATC_NON_CURR_ADJ_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: NonCurrencyAdjustmentType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- RatedCurrenciesVA
-
The following properties are defined on the LOV link relation:
- Source Attribute: CurrencyCode; Target Attribute: CurrencyCode
- Display Attribute: Name
- ReasonVA
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_ATC_BILL_ADJ_REQ_REASON
The following properties are defined on the LOV link relation:- Source Attribute: AdjustmentReason; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- StatusVA
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_ATC_BILL_ADJ_REQ_STATUS
The following properties are defined on the LOV link relation:- Source Attribute: StatusCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- TaxTreatmentVA
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_ATC_BILLAJ_REQ_TAX_TMNTS
The following properties are defined on the LOV link relation:- Source Attribute: TaxTreatment; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- TypeVA
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_ATC_BIL_ADJ_REQ_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: AdjustmentType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- billingAdjustmentEvents
-
Parameters:
- BillAdjustmentRequestsNumber:
$request.path.BillAdjustmentRequestsNumber
The billing adjustment event resource is used to view, create, update, and delete a billing adjustment events. - BillAdjustmentRequestsNumber: