Jump to

• Request
• Response

Get all billing adjustments

get

/crmRestApi/resources/11.13.18.05/billingAdjustments

Request

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey: Finds a bill adjustment with the specified primary key.
    Finder Variables:
    • BillAdjustmentRequestsId; integer; The unique identifier of the billing adjustment.
  • RowFinder: Finds a bill adjustment with the specified alternate primary key.
    Finder Variables:
    • BillAdjustmentRequestsNumber; string; The alternate unique identifier of the billing adjustment.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AdditionalComments; string; The additional approval or rejection comments for this adjustment.
  • AdjustmentReason; string; The reason for the bill adjustment.
  • AdjustmentType; string; The type of the adjustment request, such as bill, item or event level adjustment.
  • AdjustmentUnitOfMeasure; string; The unit of measure for the bill adjustment.
  • AmountDue; number; The actual due amount.
  • ApproveAmount; number; The amount for which adjustment is approved.
  • ApprovePercent; number; The percentage of amount for which adjustment is approved.
  • ApprovedByPartyId; integer; The unique identifier of the user who approved the adjustment request.
  • ApprovedByPartyName; string; The name of the user who approved the adjustment request.
  • ApprovedByPartyNumber; string; The public unique identifier of the user who approved the adjustment request.
  • AssigneePersonName; string; The name of the assignee.
  • AssigneeResourceId; integer; The unique identifier of the resource assigned to the service request.
  • AssigneeResourceNumber; string; The public unique identifier of the assignee.
  • BillAdjustmentRequestsId; integer; The unique identifier of the bill adjustment request.
  • BillAdjustmentRequestsNumber; string; The unique identifier of the bill adjustment request record.
  • CategoryId; integer; The service request category associated with the bill adjustment.
  • CategoryName; string; The service request category name associated with the bill adjustment.
  • CategoryShortName; string; The service request category short name.
  • Comments; string; The comments for this adjustment.
  • CorpCurrencyCode; string; The corporate currency code of the bill adjustment request.
  • CreatedBy; string; The user who created the row.
  • CreationDate; string; The date and time of the row creation.
  • CurcyConvRateType; string; The rate type of currency conversion.
  • CurrencyCode; string; The currency code of the bill adjustment request.
  • ExternalAdjustmentId; string; The adjustment ID from the external billing system.
  • ExternalAdjustmentNumber; string; The public unique identifier of adjustment from the external billing system.
  • ExternalBalanceGroupId; string; The unique identifier of balance group of noncurrency from the external billing system.
  • ExternalBalanceGroupNumber; string; The public unique identifier of balance group of noncurrency from the external billing system.
  • ExternalBillId; string; The bill ID from the external billing system.
  • ExternalBillItemId; string; The bill item ID from the external billing system.
  • ExternalBillItemNumber; string; The public unique identifier of the bill item from the external billing system.
  • ExternalBillNumber; string; The public unique identifier of the bill from the external billing system.
  • ExternalBillUnitId; string; The unique identifier of the bill unit for the adjustment request.
  • ExternalBillUnitNumber; string; The public unique identifier of the bill unit for the adjustment request.
  • ExternalServiceId; string; The service ID from the external billing system.
  • ExternalServiceNumber; string; The public unique identifier of the service from the external billing system.
  • ExternalServiceType; string; The type of the adjusted resource for a noncurrency adjustment request.
  • LastUpdateDate; string; The date and time of the last update made to the row.
  • LastUpdateLogin; string; The session login associated to the user who last updated the row.
  • LastUpdatedBy; string; The user who last updated the row.
  • NonCurrencyAdjustmentFlag; boolean; Indicates if the adjustment request is for a currency value or non-currency usage.
  • NonCurrencyAdjustmentType; string; The type of the adjustment request, such as bill unit or event level for a non-currency adjustment.
  • NonCurrencyUsageAmount; number; The actual non currency usage before adjustment.
  • PartyName; string; The name of the resource assigned to the service request.
  • PrimaryContactPartyId; integer; The unique identifier of the user who initially reported the adjustment request.
  • PrimaryContactPartyName; string; The name of the adjustment request primary contact.
  • PrimaryContactPartyNumber; string; The public unique identifier of the primary contact associated.
  • QueueId; integer; The unique identifier of the queue assigned to the service request.
  • QueueName; string; Indicates the service request queue.
  • QueueNumber; string; The alternative key for the queue identifier.
  • RejectReason; string; The reason for rejecting the adjustment.
  • RejectedByPartyId; integer; The unique identifier of the user who rejected the adjustment request.
  • RejectedByPartyName; string; The name of the user who rejected the adjustment request.
  • RejectedByPartyNumber; string; The public unique identifier of the user who rejected the adjustment request.
  • ReportedByPartyName; string; The person who reported the adjustment request.
  • RequestAmount; number; The amount for which adjustment is requested.
  • RequestPercent; number; The percentage of amount for which adjustment is requested.
  • SrId; integer; The unique identifier of a service request record.
  • SrNumber; string; The service request reference number that is associated with the bill adjustment.
  • StatusCode; string; The status of the adjustment request.
  • SubmittedByPartyId; integer; The unique ID of the user who submitted the adjustment request.
  • SubmittedByPartyName; string; The user who submitted the adjustment request.
  • SubmittedByPartyNumber; string; The public unique identifier of the user who submitted the adjustment request.
  • TaxTreatment; string; Indicates whether the tax is included in the bill adjustment.
  • Title; string; The title of a service request.
  • ValidFrom; string; The date when the validity for non-currency adjustment starts.
  • ValidTo; string; The date when the validity for non-currency adjustment ends.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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.

There's no request body for this operation.

Back to Top

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.

Body ()

Root Schema : billingAdjustments

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/billingAdjustments-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"OEC"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object billingAdjustments-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/billingAdjustments-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : billingAdjustments-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time of the row creation.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AdjustmentUnitOfMeasure":{
            "title":"Unit of Measure",
            "maxLength":"100",
            "type":"string",
            "description":"The unit of measure for the bill adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyName":{
            "title":"Assigned To",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the resource assigned to the service request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "title":"Currency Conversion Rate Type",
            "maxLength":"30",
            "type":"string",
            "description":"The rate type of currency conversion.",
            "nullable":true,
            "x-queryable":true
        },
        "RequestAmount":{
            "title":"Requested Amount",
            "type":"number",
            "description":"The amount for which adjustment is requested.",
            "nullable":true,
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the adjustment request.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code of the bill adjustment request.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ExternalBillItemNumber":{
            "title":"External Bill Item Number",
            "maxLength":"300",
            "type":"string",
            "description":"The public unique identifier of the bill item from the external billing system.",
            "nullable":true,
            "x-queryable":true
        },
        "ExternalBillUnitId":{
            "title":"External Bill Unit ID",
            "maxLength":"300",
            "type":"string",
            "description":"The unique identifier of the bill unit for the adjustment request.",
            "nullable":true,
            "x-queryable":true
        },
        "ValidFrom":{
            "title":"Valid From",
            "type":"string",
            "description":"The date when the validity for non-currency adjustment starts.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PrimaryContactPartyId":{
            "title":"Primary Contact ID",
            "type":"integer",
            "description":"The unique identifier of the user who initially reported the adjustment request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"The corporate currency code of the bill adjustment request.",
            "nullable":true,
            "x-queryable":true
        },
        "SubmittedByPartyName":{
            "title":"Submitted By",
            "maxLength":"360",
            "type":"string",
            "description":"The user who submitted the adjustment request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RejectedByPartyId":{
            "title":"Rejected by Party ID",
            "type":"integer",
            "description":"The unique identifier of the user who rejected the adjustment request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AmountDue":{
            "title":"Amount Due",
            "type":"number",
            "description":"The actual due amount.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReportedByPartyName":{
            "title":"Reported By",
            "maxLength":"360",
            "type":"string",
            "description":"The person who reported the adjustment request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SubmittedByPartyNumber":{
            "title":"Submitted by Party ID",
            "maxLength":"30",
            "type":"string",
            "description":"The public unique identifier of the user who submitted the adjustment request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TaxTreatment":{
            "title":"Tax Treatment",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates whether the tax is included in the bill adjustment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CategoryShortName":{
            "title":"Category Short Name",
            "maxLength":"240",
            "type":"string",
            "description":"The service request category short name.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "CategoryName"
                ]
            },
            "x-queryable":true
        },
        "QueueId":{
            "title":"Assigned Queue ID",
            "type":"integer",
            "description":"The unique identifier of the queue assigned to the service request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ExternalBalanceGroupNumber":{
            "title":"External Balance Group Number",
            "maxLength":"300",
            "type":"string",
            "description":"The public unique identifier of balance group of noncurrency from the external billing system.",
            "nullable":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Delete Indicator",
            "type":"boolean",
            "description":"Indicates whether the user can delete the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ExternalBillNumber":{
            "title":"External Bill Number",
            "maxLength":"300",
            "type":"string",
            "description":"The public unique identifier of the bill from the external billing system.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryContactPartyNumber":{
            "title":"Primary Contact Number",
            "maxLength":"30",
            "type":"string",
            "description":"The public unique identifier of the primary contact associated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssigneePersonName":{
            "title":"Assigned To",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the assignee.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssigneeResourceNumber":{
            "title":"Assigned to Resource Number",
            "maxLength":"30",
            "type":"string",
            "description":"The public unique identifier of the assignee.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ApprovedByPartyNumber":{
            "title":"Approved by Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The public unique identifier of the user who approved the adjustment request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BillAdjustmentRequestsNumber":{
            "title":"Bill Adjustment Request Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the bill adjustment request record.",
            "nullable":false,
            "x-queryable":true
        },
        "billingAdjustmentEvents":{
            "title":"Billing Adjustment Events",
            "type":"array",
            "description":"The billing adjustment event resource is used to view, create, update, and delete a billing adjustment events.",
            "items":{
                "$ref":"#/components/schemas/billingAdjustments-billingAdjustmentEvents-item-response"
            }
        },
        "ExternalBillUnitNumber":{
            "title":"External Bill Unit Number",
            "maxLength":"300",
            "type":"string",
            "description":"The public unique identifier of the bill unit for the adjustment request.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The session login associated to the user who last updated the row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CategoryId":{
            "title":"Category",
            "type":"integer",
            "description":"The service request category associated with the bill adjustment.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ExternalServiceType":{
            "title":"External Service Type",
            "maxLength":"300",
            "type":"string",
            "description":"The type of the adjusted resource for a noncurrency adjustment request.",
            "nullable":true,
            "x-queryable":true
        },
        "ExternalServiceId":{
            "title":"External Service ID",
            "maxLength":"300",
            "type":"string",
            "description":"The service ID from the external billing system.",
            "nullable":true,
            "x-queryable":true
        },
        "AssigneeResourceId":{
            "title":"Assigned to Resource ID",
            "type":"integer",
            "description":"The unique identifier of the resource assigned to the service request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ApproveAmount":{
            "title":"Approved Amount",
            "type":"number",
            "description":"The amount for which adjustment is approved.",
            "nullable":true,
            "x-queryable":true
        },
        "NonCurrencyAdjustmentFlag":{
            "title":"Noncurrency Adjustment",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the adjustment request is for a currency value or non-currency usage.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "AdditionalComments":{
            "title":"Additional Comments",
            "maxLength":"255",
            "type":"string",
            "description":"The additional approval or rejection comments for this adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Update Indicator",
            "type":"boolean",
            "description":"Indicates whether the user can update the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PrimaryContactPartyName":{
            "title":"Primary Contact",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the adjustment request primary contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ApprovedByPartyName":{
            "title":"Approved By",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the user who approved the adjustment request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SubmittedByPartyId":{
            "title":"Submitted by Party ID",
            "type":"integer",
            "description":"The unique ID of the user who submitted the adjustment request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ExternalBillId":{
            "title":"External Bill ID",
            "maxLength":"300",
            "type":"string",
            "description":"The bill ID from the external billing system.",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentReason":{
            "title":"Adjustment Reason",
            "maxLength":"30",
            "type":"string",
            "description":"The reason for the bill adjustment.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ExternalBalanceGroupId":{
            "title":"External Balance Group ID",
            "maxLength":"300",
            "type":"string",
            "description":"The unique identifier of balance group of noncurrency from the external billing system.",
            "nullable":true,
            "x-queryable":true
        },
        "QueueName":{
            "title":"Queue",
            "maxLength":"400",
            "type":"string",
            "description":"Indicates the service request queue.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SrId":{
            "title":"Service Request ID",
            "type":"integer",
            "description":"The unique identifier of a service request record.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BillAdjustmentRequestsId":{
            "title":"Bill Adjustment Request ID",
            "type":"integer",
            "description":"The unique identifier of the bill adjustment request.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"255",
            "type":"string",
            "description":"The comments for this adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "RejectedByPartyName":{
            "title":"Rejected By",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the user who rejected the adjustment request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExternalServiceNumber":{
            "title":"External Service Number",
            "maxLength":"300",
            "type":"string",
            "description":"The public unique identifier of the service from the external billing system.",
            "nullable":true,
            "x-queryable":true
        },
        "Title":{
            "title":"Title",
            "maxLength":"400",
            "type":"string",
            "description":"The title of a service request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ApprovedByPartyId":{
            "title":"Approved by Party ID",
            "type":"integer",
            "description":"The unique identifier of the user who approved the adjustment request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SrNumber":{
            "title":"Reference Number",
            "maxLength":"30",
            "type":"string",
            "description":"The service request reference number that is associated with the bill adjustment.",
            "nullable":false,
            "x-queryable":true
        },
        "AdjustmentType":{
            "title":"Adjustment Type",
            "maxLength":"20",
            "type":"string",
            "description":"The type of the adjustment request, such as bill, item or event level adjustment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ExternalAdjustmentNumber":{
            "title":"External Adjustment Number",
            "maxLength":"300",
            "type":"string",
            "description":"The public unique identifier of adjustment from the external billing system.",
            "nullable":true,
            "x-queryable":true
        },
        "QueueNumber":{
            "title":"Queue Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternative key for the queue identifier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ApprovePercent":{
            "title":"Approved Percentage",
            "type":"number",
            "description":"The percentage of amount for which adjustment is approved.",
            "nullable":true,
            "x-queryable":true
        },
        "RejectedByPartyNumber":{
            "title":"Rejected by Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The public unique identifier of the user who rejected the adjustment request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExternalAdjustmentId":{
            "title":"External Adjustment ID",
            "maxLength":"300",
            "type":"string",
            "description":"The adjustment ID from the external billing system.",
            "nullable":true,
            "x-queryable":true
        },
        "ValidTo":{
            "title":"Valid To",
            "type":"string",
            "description":"The date when the validity for non-currency adjustment ends.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "RejectReason":{
            "title":"Rejection Reason",
            "maxLength":"255",
            "type":"string",
            "description":"The reason for rejecting the adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "CategoryName":{
            "title":"Category Name",
            "maxLength":"400",
            "type":"string",
            "description":"The service request category name associated with the bill adjustment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NonCurrencyUsageAmount":{
            "title":"Noncurrency Usage",
            "type":"number",
            "description":"The actual non currency usage before adjustment.",
            "nullable":true,
            "x-queryable":true
        },
        "RequestPercent":{
            "title":"Requested Percentage",
            "type":"number",
            "description":"The percentage of amount for which adjustment is requested.",
            "nullable":true,
            "x-queryable":true
        },
        "NonCurrencyAdjustmentType":{
            "title":"Noncurrency Adjustment Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the adjustment request, such as bill unit or event level for a non-currency adjustment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ExternalBillItemId":{
            "title":"External Bill Item ID",
            "maxLength":"300",
            "type":"string",
            "description":"The bill item ID from the external billing system.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date and time of the last update made to the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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

• Array of: object billingAdjustments-billingAdjustmentEvents-item-response

{
    "title":"Billing Adjustment Events",
    "type":"array",
    "description":"The billing adjustment event resource is used to view, create, update, and delete a billing adjustment events.",
    "items":{
        "$ref":"#/components/schemas/billingAdjustments-billingAdjustmentEvents-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : billingAdjustments-billingAdjustmentEvents-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time of the row creation.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Update Indicator",
            "type":"boolean",
            "description":"Indicates whether the user can update the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BillAdjustmentRequestEventsNumber":{
            "title":"Adjustment Event Number",
            "maxLength":"30",
            "type":"string",
            "description":"The event number of the adjustment.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ExternalBillEventNumber":{
            "title":"External Bill Event Number",
            "maxLength":"300",
            "type":"string",
            "description":"The public unique identifier of the external bill event.",
            "nullable":true,
            "x-queryable":true
        },
        "BillAdjustmentRequestEventsId":{
            "title":"Adjustment Event ID",
            "type":"integer",
            "description":"The unique identifier of the adjustment event.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Delete Indicator",
            "type":"boolean",
            "description":"Indicates whether the user can delete the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date and time of the last update made to the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The session login associated to the user who last updated the row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExternalBillEventId":{
            "title":"External Bill Event ID",
            "maxLength":"300",
            "type":"string",
            "description":"The unique identifier of the external bill event.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top