Jump to

• Request
• Response

Create a bill management user

post

/fscmRestApi/resources/11.13.18.05/billManagementUsers

Request

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AccountNumber: string
  Title: Account Number

  The account number of the customer account that the bill management user represents.
• BillManagementUserRegistrationId: integer (int64)
  Title: Bill Management User Registration ID

  The unique identifier of the bill management user registration.
• CustomerName: string
  Title: Customer Name

  Maximum Length: 360

  The name of the customer that the bill management user represents.
• EmailAddress: string
  Title: Email Address

  The email address of the person who is a bill management user or who is trying to register as a bill management user.
• Name: string
  Title: Name

  Maximum Length: 360

  The name of the person who is a bill management user or who is trying to register as a bill management user.
• RegistrationStatus: string
  Title: Registration Status

  Maximum Length: 80

  The registration status of the bill management user profile record. Possible values are Error, Processing, Registered, and Unregistered.

{
    "type":"object",
    "properties":{
        "BillManagementUserRegistrationId":{
            "title":"Bill Management User Registration ID",
            "type":"integer",
            "description":"The unique identifier of the bill management user registration.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "RegistrationStatus":{
            "title":"Registration Status",
            "maxLength":80,
            "type":"string",
            "description":"The registration status of the bill management user profile record. Possible values are Error, Processing, Registered, and Unregistered.",
            "nullable":true
        },
        "CustomerName":{
            "title":"Customer Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the customer that the bill management user represents.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PartyId"
                ]
            }
        },
        "EmailAddress":{
            "title":"Email Address",
            "type":"string",
            "description":"The email address of the person who is a bill management user or who is trying to register as a bill management user.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "RegUserProfileId"
                ]
            }
        },
        "Name":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the person who is a bill management user or who is trying to register as a bill management user.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PartyId1"
                ]
            }
        },
        "AccountNumber":{
            "title":"Account Number",
            "type":"string",
            "description":"The account number of the customer account that the bill management user represents.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "CustAccountId"
                ]
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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 : billManagementUsers-item-response

Type: object

Show Source

• AccountNumber: string
  Title: Account Number

  The account number of the customer account that the bill management user represents.
• BillManagementUserRegistrationId: integer (int64)
  Title: Bill Management User Registration ID

  The unique identifier of the bill management user registration.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• CustomerName: string
  Title: Customer Name

  Maximum Length: 360

  The name of the customer that the bill management user represents.
• EmailAddress: string
  Title: Email Address

  The email address of the person who is a bill management user or who is trying to register as a bill management user.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Title: Name

  Maximum Length: 360

  The name of the person who is a bill management user or who is trying to register as a bill management user.
• RegistrationStatus: string
  Title: Registration Status

  Maximum Length: 80

  The registration status of the bill management user profile record. Possible values are Error, Processing, Registered, and Unregistered.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "BillManagementUserRegistrationId":{
            "title":"Bill Management User Registration ID",
            "type":"integer",
            "description":"The unique identifier of the bill management user registration.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "RegistrationStatus":{
            "title":"Registration Status",
            "maxLength":80,
            "type":"string",
            "description":"The registration status of the bill management user profile record. Possible values are Error, Processing, Registered, and Unregistered.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CustomerName":{
            "title":"Customer Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the customer that the bill management user represents.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PartyId"
                ]
            }
        },
        "EmailAddress":{
            "title":"Email Address",
            "type":"string",
            "description":"The email address of the person who is a bill management user or who is trying to register as a bill management user.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "RegUserProfileId"
                ]
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Name":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the person who is a bill management user or who is trying to register as a bill management user.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PartyId1"
                ]
            }
        },
        "AccountNumber":{
            "title":"Account Number",
            "type":"string",
            "description":"The account number of the customer account that the bill management user represents.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "CustAccountId"
                ]
            }
        }
    }
}

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