Jump to

• Request
• Response

Update one customer details for an order

patch

/fscmRestApi/resources/11.13.18.05/salesOrdersForOrderHubRequests/{OrderKey}/child/billToCustomer/{billToCustomerUniqID}

Request

Path Parameters

• OrderKey(required): string
  Value that uniquely identifies the sales order. This value is derived by concatenating the value of SourceOrderSystem, a colon, and the value of SourceOrderId. For orders created through the Oracle Order Management Cloud work area, the SourceOrderId is same as the HeaderId. For example, if SourceOrderSystem is LEG and SourceOrderId is R13_Sample_Order, the value of this attribute is LEG:R13_Sample_Order.
• billToCustomerUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Bill-to Customers resource and used to uniquely identify an instance of Bill-to Customers. The client should not generate the hash key value. Instead, the client should query on the Bill-to Customers collection resource in order to navigate to a specific instance of Bill-to Customers to get the hash key.

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
  Maximum Length: 30

  Number of the customer account who is legally responsible for payment. This account exists when a selling relationship exists between the deploying company and the party.
• Address1: string
  Maximum Length: 240

  First line of the bill-to customer address.
• Address2: string
  Maximum Length: 240

  Second line of the bill-to customer address.
• Address3: string
  Maximum Length: 240

  Third line of the bill-to customer address.
• Address4: string
  Maximum Length: 240

  Fourth line of the bill-to customer address.
• AddressOrigSystemReference: string
  Maximum Length: 255

  Value that uniquely identifies the bill-to customer address in the source application that captures the transaction.
• City: string
  Maximum Length: 60

  City of the bill-to customer address.
• ContactFirstName: string
  Maximum Length: 150

  First name of the person to contact at the bill-to customer site.
• ContactId: integer (int64)
  Value that uniquely identifies the contact for the billing account.
• ContactLastName: string
  Maximum Length: 150

  Last name of the person to contact at the bill-to customer site.
• ContactMiddleName: string
  Maximum Length: 60

  Middle name of the person to contact at the bill-to customer site.
• ContactName: string
  Maximum Length: 360

  Name of the person to contact at the bill-to customer site.
• ContactNameSuffix: string
  Maximum Length: 30

  Name suffix of the person to contact at the bill-to customer site.
• ContactNumber: string
  Maximum Length: 30

  Telephone number of the person to contact at the bill-to customer site.
• ContactOrigSystemReference: string
  Maximum Length: 255

  Value that uniquely identifies the bill-to customer contact in the source application that captures the transaction.
• ContactTitle: string
  Maximum Length: 60

  Title of the person to contact at the bill-to customer site.
• Country: string
  Maximum Length: 60

  Country of the bill-to customer address.
• County: string
  Maximum Length: 60

  County of the bill-to customer address.
• CustomerAccountId: integer (int64)
  Value that uniquely identifies the account that is legally responsible for payment. This account exists when a selling relationship exists between the deploying company and the party.
• PartyContactEmail: string
  Maximum Length: 320

  Email address of the primary contact who is legally responsible for payment.
• PartyName: string
  Maximum Length: 360

  Name of the party who is legally responsible for payment.
• PartyOrganizationEmail: string
  Maximum Length: 320

  Email address of the organization who is legally responsible for payment.
• PartyPersonEmail: string
  Maximum Length: 320

  Email address of the person who is legally responsible for payment.
• PartyType: string
  Maximum Length: 30

  Type of the bill-to party. Acceptable values are PERSON or ORGANIZATION.
• PersonFirstName: string
  Maximum Length: 150

  If a person is legally responsible for payment, then this attribute contains the first name of the person.
• PersonLastName: string
  Maximum Length: 150

  If a person is legally responsible for payment, then this attribute contains the last name of the person.
• PersonMiddleName: string
  Maximum Length: 60

  If a person is legally responsible for payment, then this attribute contains the middle name of the person.
• PersonNameSuffix: string
  Maximum Length: 30

  If a person is legally responsible for payment, then this attribute contains the name suffix of the person.
• PersonTitle: string
  Maximum Length: 60

  If a person is legally responsible for payment, then this attribute contains the title of the person.
• PostalCode: string
  Maximum Length: 60

  Postal code of the bill-to customer address.
• PreferredContactPointId: integer (int64)
  Value that uniquely identifies the email for the preferred contact point for the contact at the account who is responsible for payment.
• PreferredContactPointOrigSystemReference: string
  Maximum Length: 240

  Value that uniquely identifies the preferred contact point of the bill-to party in the source application that captures the transaction.
• Province: string
  Maximum Length: 60

  Province of the bill-to customer address.
• SiteUseId: integer (int64)
  Value that uniquely identifies the account site that is legally responsible for payment.
• State: string
  Maximum Length: 60

  State of the bill-to customer address.

{
    "type":"object",
    "properties":{
        "SiteUseId":{
            "type":"integer",
            "description":"Value that uniquely identifies the account site that is legally responsible for payment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PartyContactEmail":{
            "maxLength":320,
            "type":"string",
            "description":"Email address of the primary contact who is legally responsible for payment.",
            "nullable":true
        },
        "PersonNameSuffix":{
            "maxLength":30,
            "type":"string",
            "description":"If a person is legally responsible for payment, then this attribute contains the name suffix of the person.",
            "nullable":true
        },
        "PartyOrganizationEmail":{
            "maxLength":320,
            "type":"string",
            "description":"Email address of the organization who is legally responsible for payment.",
            "nullable":true
        },
        "PostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"Postal code of the bill-to customer address.",
            "nullable":true
        },
        "PartyName":{
            "maxLength":360,
            "type":"string",
            "description":"Name of the party who is legally responsible for payment.",
            "nullable":true
        },
        "ContactId":{
            "type":"integer",
            "description":"Value that uniquely identifies the contact for the billing account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PersonMiddleName":{
            "maxLength":60,
            "type":"string",
            "description":"If a person is legally responsible for payment, then this attribute contains the middle name of the person.",
            "nullable":true
        },
        "County":{
            "maxLength":60,
            "type":"string",
            "description":"County of the bill-to customer address.",
            "nullable":true
        },
        "PartyPersonEmail":{
            "maxLength":320,
            "type":"string",
            "description":"Email address of the person who is legally responsible for payment.",
            "nullable":true
        },
        "PersonTitle":{
            "maxLength":60,
            "type":"string",
            "description":"If a person is legally responsible for payment, then this attribute contains the title of the person.",
            "nullable":true
        },
        "Address4":{
            "maxLength":240,
            "type":"string",
            "description":"Fourth line of the bill-to customer address.",
            "nullable":true
        },
        "AddressOrigSystemReference":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the bill-to customer address in the source application that captures the transaction.",
            "nullable":true
        },
        "CustomerAccountId":{
            "type":"integer",
            "description":"Value that uniquely identifies the account that is legally responsible for payment. This account exists when a selling relationship exists between the deploying company and the party.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ContactNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Telephone number of the person to contact at the bill-to customer site.",
            "nullable":true
        },
        "ContactFirstName":{
            "maxLength":150,
            "type":"string",
            "description":"First name of the person to contact at the bill-to customer site.",
            "nullable":true
        },
        "ContactOrigSystemReference":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the bill-to customer contact in the source application that captures the transaction.",
            "nullable":true
        },
        "PartyType":{
            "maxLength":30,
            "type":"string",
            "description":"Type of the bill-to party. Acceptable values are PERSON or ORGANIZATION.",
            "nullable":true
        },
        "ContactMiddleName":{
            "maxLength":60,
            "type":"string",
            "description":"Middle name of the person to contact at the bill-to customer site.",
            "nullable":true
        },
        "PersonLastName":{
            "maxLength":150,
            "type":"string",
            "description":"If a person is legally responsible for payment, then this attribute contains the last name of the person.",
            "nullable":true
        },
        "ContactNameSuffix":{
            "maxLength":30,
            "type":"string",
            "description":"Name suffix of the person to contact at the bill-to customer site.",
            "nullable":true
        },
        "Address2":{
            "maxLength":240,
            "type":"string",
            "description":"Second line of the bill-to customer address.",
            "nullable":true
        },
        "Address3":{
            "maxLength":240,
            "type":"string",
            "description":"Third line of the bill-to customer address.",
            "nullable":true
        },
        "Address1":{
            "maxLength":240,
            "type":"string",
            "description":"First line of the bill-to customer address.",
            "nullable":true
        },
        "City":{
            "maxLength":60,
            "type":"string",
            "description":"City of the bill-to customer address.",
            "nullable":true
        },
        "PersonFirstName":{
            "maxLength":150,
            "type":"string",
            "description":"If a person is legally responsible for payment, then this attribute contains the first name of the person.",
            "nullable":true
        },
        "ContactTitle":{
            "maxLength":60,
            "type":"string",
            "description":"Title of the person to contact at the bill-to customer site.",
            "nullable":true
        },
        "Province":{
            "maxLength":60,
            "type":"string",
            "description":"Province of the bill-to customer address.",
            "nullable":true
        },
        "ContactLastName":{
            "maxLength":150,
            "type":"string",
            "description":"Last name of the person to contact at the bill-to customer site.",
            "nullable":true
        },
        "AccountNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Number of the customer account who is legally responsible for payment. This account exists when a selling relationship exists between the deploying company and the party.",
            "nullable":true
        },
        "PreferredContactPointOrigSystemReference":{
            "maxLength":240,
            "type":"string",
            "description":"Value that uniquely identifies the preferred contact point of the bill-to party in the source application that captures the transaction.",
            "nullable":true
        },
        "State":{
            "maxLength":60,
            "type":"string",
            "description":"State of the bill-to customer address.",
            "nullable":true
        },
        "PreferredContactPointId":{
            "type":"integer",
            "description":"Value that uniquely identifies the email for the preferred contact point for the contact at the account who is responsible for payment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "Country":{
            "maxLength":60,
            "type":"string",
            "description":"Country of the bill-to customer address.",
            "nullable":true
        },
        "ContactName":{
            "maxLength":360,
            "type":"string",
            "description":"Name of the person to contact at the bill-to customer site.",
            "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(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 : salesOrdersForOrderHubRequests-billToCustomer-item-response

Type: object

Show Source

• AccountNumber: string
  Maximum Length: 30

  Number of the customer account who is legally responsible for payment. This account exists when a selling relationship exists between the deploying company and the party.
• Address1: string
  Maximum Length: 240

  First line of the bill-to customer address.
• Address2: string
  Maximum Length: 240

  Second line of the bill-to customer address.
• Address3: string
  Maximum Length: 240

  Third line of the bill-to customer address.
• Address4: string
  Maximum Length: 240

  Fourth line of the bill-to customer address.
• AddressOrigSystemReference: string
  Maximum Length: 255

  Value that uniquely identifies the bill-to customer address in the source application that captures the transaction.
• AddressUseType: string
  Maximum Length: 30

  Type of address. Valid value is BILL_TO.
• City: string
  Maximum Length: 60

  City of the bill-to customer address.
• ContactFirstName: string
  Maximum Length: 150

  First name of the person to contact at the bill-to customer site.
• ContactId: integer (int64)
  Value that uniquely identifies the contact for the billing account.
• ContactLastName: string
  Maximum Length: 150

  Last name of the person to contact at the bill-to customer site.
• ContactMiddleName: string
  Maximum Length: 60

  Middle name of the person to contact at the bill-to customer site.
• ContactName: string
  Maximum Length: 360

  Name of the person to contact at the bill-to customer site.
• ContactNameSuffix: string
  Maximum Length: 30

  Name suffix of the person to contact at the bill-to customer site.
• ContactNumber: string
  Maximum Length: 30

  Telephone number of the person to contact at the bill-to customer site.
• ContactOrigSystemReference: string
  Maximum Length: 255

  Value that uniquely identifies the bill-to customer contact in the source application that captures the transaction.
• ContactTitle: string
  Maximum Length: 60

  Title of the person to contact at the bill-to customer site.
• Country: string
  Maximum Length: 60

  Country of the bill-to customer address.
• County: string
  Maximum Length: 60

  County of the bill-to customer address.
• CustomerAccountId: integer (int64)
  Value that uniquely identifies the account that is legally responsible for payment. This account exists when a selling relationship exists between the deploying company and the party.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PartyContactEmail: string
  Maximum Length: 320

  Email address of the primary contact who is legally responsible for payment.
• PartyName: string
  Maximum Length: 360

  Name of the party who is legally responsible for payment.
• PartyOrganizationEmail: string
  Maximum Length: 320

  Email address of the organization who is legally responsible for payment.
• PartyPersonEmail: string
  Maximum Length: 320

  Email address of the person who is legally responsible for payment.
• PartyType: string
  Maximum Length: 30

  Type of the bill-to party. Acceptable values are PERSON or ORGANIZATION.
• PersonFirstName: string
  Maximum Length: 150

  If a person is legally responsible for payment, then this attribute contains the first name of the person.
• PersonLastName: string
  Maximum Length: 150

  If a person is legally responsible for payment, then this attribute contains the last name of the person.
• PersonMiddleName: string
  Maximum Length: 60

  If a person is legally responsible for payment, then this attribute contains the middle name of the person.
• PersonNameSuffix: string
  Maximum Length: 30

  If a person is legally responsible for payment, then this attribute contains the name suffix of the person.
• PersonTitle: string
  Maximum Length: 60

  If a person is legally responsible for payment, then this attribute contains the title of the person.
• PostalCode: string
  Maximum Length: 60

  Postal code of the bill-to customer address.
• PreferredContactPointId: integer (int64)
  Value that uniquely identifies the email for the preferred contact point for the contact at the account who is responsible for payment.
• PreferredContactPointOrigSystemReference: string
  Maximum Length: 240

  Value that uniquely identifies the preferred contact point of the bill-to party in the source application that captures the transaction.
• Province: string
  Maximum Length: 60

  Province of the bill-to customer address.
• SiteUseId: integer (int64)
  Value that uniquely identifies the account site that is legally responsible for payment.
• SourceTransactionId: string
  Maximum Length: 50

  Value that uniquely identifies the transaction in the source application.
• SourceTransactionLineId: string
  Maximum Length: 50

  Value that uniquely identifies the transaction line from the source application.
• SourceTransactionScheduleId: string
  Maximum Length: 50

  Value that uniquely identifies the schedule, shipment, or subline. The source application assigns this value.
• SourceTransactionSystem: string
  Maximum Length: 30

  Source application that created the order. Review and update the value for this attribute using the Manage Trading Community Source Systems, Manage Upstream and Fulfillment Source Systems tasks.
• State: string
  Maximum Length: 60

  State of the bill-to customer address.

{
    "type":"object",
    "properties":{
        "SiteUseId":{
            "type":"integer",
            "description":"Value that uniquely identifies the account site that is legally responsible for payment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartyContactEmail":{
            "maxLength":320,
            "type":"string",
            "description":"Email address of the primary contact who is legally responsible for payment.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonNameSuffix":{
            "maxLength":30,
            "type":"string",
            "description":"If a person is legally responsible for payment, then this attribute contains the name suffix of the person.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyOrganizationEmail":{
            "maxLength":320,
            "type":"string",
            "description":"Email address of the organization who is legally responsible for payment.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"Postal code of the bill-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyName":{
            "maxLength":360,
            "type":"string",
            "description":"Name of the party who is legally responsible for payment.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactId":{
            "type":"integer",
            "description":"Value that uniquely identifies the contact for the billing account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PersonMiddleName":{
            "maxLength":60,
            "type":"string",
            "description":"If a person is legally responsible for payment, then this attribute contains the middle name of the person.",
            "nullable":true,
            "x-queryable":true
        },
        "County":{
            "maxLength":60,
            "type":"string",
            "description":"County of the bill-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyPersonEmail":{
            "maxLength":320,
            "type":"string",
            "description":"Email address of the person who is legally responsible for payment.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonTitle":{
            "maxLength":60,
            "type":"string",
            "description":"If a person is legally responsible for payment, then this attribute contains the title of the person.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressUseType":{
            "maxLength":30,
            "type":"string",
            "description":"Type of address. Valid value is BILL_TO.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "SourceTransactionSystem":{
            "maxLength":30,
            "type":"string",
            "description":"Source application that created the order. Review and update the value for this attribute using the Manage Trading Community Source Systems, Manage Upstream and Fulfillment Source Systems tasks.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Address4":{
            "maxLength":240,
            "type":"string",
            "description":"Fourth line of the bill-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressOrigSystemReference":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the bill-to customer address in the source application that captures the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerAccountId":{
            "type":"integer",
            "description":"Value that uniquely identifies the account that is legally responsible for payment. This account exists when a selling relationship exists between the deploying company and the party.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceTransactionId":{
            "maxLength":50,
            "type":"string",
            "description":"Value that uniquely identifies the transaction in the source application.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ContactNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Telephone number of the person to contact at the bill-to customer site.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SourceTransactionScheduleId":{
            "maxLength":50,
            "type":"string",
            "description":"Value that uniquely identifies the schedule, shipment, or subline. The source application assigns this value.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ContactFirstName":{
            "maxLength":150,
            "type":"string",
            "description":"First name of the person to contact at the bill-to customer site.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactOrigSystemReference":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the bill-to customer contact in the source application that captures the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyType":{
            "maxLength":30,
            "type":"string",
            "description":"Type of the bill-to party. Acceptable values are PERSON or ORGANIZATION.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactMiddleName":{
            "maxLength":60,
            "type":"string",
            "description":"Middle name of the person to contact at the bill-to customer site.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonLastName":{
            "maxLength":150,
            "type":"string",
            "description":"If a person is legally responsible for payment, then this attribute contains the last name of the person.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactNameSuffix":{
            "maxLength":30,
            "type":"string",
            "description":"Name suffix of the person to contact at the bill-to customer site.",
            "nullable":true,
            "x-queryable":true
        },
        "Address2":{
            "maxLength":240,
            "type":"string",
            "description":"Second line of the bill-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "Address3":{
            "maxLength":240,
            "type":"string",
            "description":"Third line of the bill-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "Address1":{
            "maxLength":240,
            "type":"string",
            "description":"First line of the bill-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "City":{
            "maxLength":60,
            "type":"string",
            "description":"City of the bill-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonFirstName":{
            "maxLength":150,
            "type":"string",
            "description":"If a person is legally responsible for payment, then this attribute contains the first name of the person.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactTitle":{
            "maxLength":60,
            "type":"string",
            "description":"Title of the person to contact at the bill-to customer site.",
            "nullable":true,
            "x-queryable":true
        },
        "Province":{
            "maxLength":60,
            "type":"string",
            "description":"Province of the bill-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactLastName":{
            "maxLength":150,
            "type":"string",
            "description":"Last name of the person to contact at the bill-to customer site.",
            "nullable":true,
            "x-queryable":true
        },
        "AccountNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Number of the customer account who is legally responsible for payment. This account exists when a selling relationship exists between the deploying company and the party.",
            "nullable":true,
            "x-queryable":true
        },
        "PreferredContactPointOrigSystemReference":{
            "maxLength":240,
            "type":"string",
            "description":"Value that uniquely identifies the preferred contact point of the bill-to party in the source application that captures the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "State":{
            "maxLength":60,
            "type":"string",
            "description":"State of the bill-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "PreferredContactPointId":{
            "type":"integer",
            "description":"Value that uniquely identifies the email for the preferred contact point for the contact at the account who is responsible for payment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Country":{
            "maxLength":60,
            "type":"string",
            "description":"Country of the bill-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceTransactionLineId":{
            "maxLength":50,
            "type":"string",
            "description":"Value that uniquely identifies the transaction line from the source application.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ContactName":{
            "maxLength":360,
            "type":"string",
            "description":"Name of the person to contact at the bill-to customer site.",
            "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