Jump to

• Request
• Response

Update a billing adjustment event

patch

/crmRestApi/resources/11.13.18.05/billingAdjustments/{BillAdjustmentRequestsNumber}/child/billingAdjustmentEvents/{BillAdjustmentRequestEventsNumber}

Request

Path Parameters

• BillAdjustmentRequestEventsNumber(required): string
  The event number of the adjustment.
• BillAdjustmentRequestsNumber(required): string
  The unique identifier of the bill adjustment request record.

Header Parameters

• Metadata-Context: string
  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: string
  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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "ExternalBillEventId":{
            "title":"External Bill Event ID",
            "maxLength":300,
            "type":"string",
            "description":"The unique identifier of the external bill event.",
            "nullable":true
        },
        "ExternalBillEventNumber":{
            "title":"External Bill Event Number",
            "maxLength":300,
            "type":"string",
            "description":"The public unique identifier of the external bill event.",
            "nullable":true
        }
    }
}

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-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":{
        "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
        },
        "BillAdjustmentRequestEventsNumber":{
            "title":"Adjustment Event Number",
            "maxLength":30,
            "type":"string",
            "description":"The event number of the adjustment.",
            "nullable":false,
            "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
        },
        "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
        },
        "DeleteFlag":{
            "title":"Delete Indicator",
            "type":"boolean",
            "description":"Indicates whether the user can delete the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ExternalBillEventId":{
            "title":"External Bill Event ID",
            "maxLength":300,
            "type":"string",
            "description":"The unique identifier of the external bill event.",
            "nullable":true,
            "x-queryable":true
        },
        "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
        },
        "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
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the row.",
            "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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