Jump to

• Request
• Response

Update an alternate name mapping rule

patch

/fscmRestApi/resources/11.13.18.05/alternateNameMappingRules/{AlternateNameId}

Request

Path Parameters

• AlternateNameId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

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

• Active: string
  Maximum Length: 1

  Indicates whether the alternate name mapping rule is active.
• AlternatePayerName: string
  Maximum Length: 320

  Alternate payer name of the paying customer.
• BillToSite: string
  Maximum Length: 150

  Bill-to site of the paying customer.
• CustomerAccountNumber: string
  Customer account number of the paying customer.
• RemittanceBankBranchNumber: string
  Maximum Length: 30

  Bank branch number of the remittance bank that issues the virtual account number for the customer account or site.
• RemittanceBankNumber: string
  Maximum Length: 30

  Bank number of the remittance bank that issues the virtual account number for the customer account or site.
• VirtualAccountNumber: string
  Maximum Length: 30

  Virtual account number assigned to the customer account or site.
• ZenginCustomerBankBranchName: string
  Maximum Length: 360

  Customer bank branch name from the Zengin format file.
• ZenginCustomerBankName: string
  Maximum Length: 360

  Customer bank name from the Zengin format file.

{
    "type":"object",
    "properties":{
        "RemittanceBankBranchNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Bank branch number of the remittance bank that issues the virtual account number for the customer account or site.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "RemittanceBankNumber"
                ]
            }
        },
        "BillToSite":{
            "maxLength":"150",
            "type":"string",
            "description":"Bill-to site of the paying customer.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "CustomerAccountNumber"
                ]
            }
        },
        "Active":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the alternate name mapping rule is active.",
            "nullable":true
        },
        "ZenginCustomerBankName":{
            "maxLength":"360",
            "type":"string",
            "description":"Customer bank name from the Zengin format file.",
            "nullable":true
        },
        "RemittanceBankNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Bank number of the remittance bank that issues the virtual account number for the customer account or site.",
            "nullable":true
        },
        "AlternatePayerName":{
            "maxLength":"320",
            "type":"string",
            "description":"Alternate payer name of the paying customer.",
            "nullable":false
        },
        "ZenginCustomerBankBranchName":{
            "maxLength":"360",
            "type":"string",
            "description":"Customer bank branch name from the Zengin format file.",
            "nullable":true
        },
        "CustomerAccountNumber":{
            "type":"string",
            "description":"Customer account number of the paying customer.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "VirtualAccountNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Virtual account number assigned to the customer account or 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:
  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 : alternateNameMappingRules-item-response

Type: object

Show Source

• Active: string
  Maximum Length: 1

  Indicates whether the alternate name mapping rule is active.
• AlternateNameId: integer (int64)
  Unique identifier of the alternate name mapping rule.
• AlternatePayerName: string
  Maximum Length: 320

  Alternate payer name of the paying customer.
• BillToSite: string
  Maximum Length: 150

  Bill-to site of the paying customer.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the alternate name mapping rule.
• CreationDate: string (date-time)
  Read Only: true

  The date when the alternate name mapping rule was created.
• CustomerAccountNumber: string
  Customer account number of the paying customer.
• CustomerName: string
  Title: Name

  Read Only: true

  Maximum Length: 360

  Name of the paying customer.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the alternate name mapping rule was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the alternate name mapping rule.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The user login that last updated the alternate name mapping rule.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  Object version number for the alternate name mapping rule.
• RemittanceBankBranchNumber: string
  Maximum Length: 30

  Bank branch number of the remittance bank that issues the virtual account number for the customer account or site.
• RemittanceBankName: string
  Read Only: true

  Maximum Length: 255

  Bank branch name of the remittance bank that issues the virtual account number for the customer account or site.
• RemittanceBankNumber: string
  Maximum Length: 30

  Bank number of the remittance bank that issues the virtual account number for the customer account or site.
• VirtualAccountNumber: string
  Maximum Length: 30

  Virtual account number assigned to the customer account or site.
• ZenginCustomerBankBranchName: string
  Maximum Length: 360

  Customer bank branch name from the Zengin format file.
• ZenginCustomerBankName: string
  Maximum Length: 360

  Customer bank name from the Zengin format file.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the alternate name mapping rule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the alternate name mapping rule was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the alternate name mapping rule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AlternatePayerName":{
            "maxLength":"320",
            "type":"string",
            "description":"Alternate payer name of the paying customer.",
            "nullable":false,
            "x-queryable":true
        },
        "ZenginCustomerBankBranchName":{
            "maxLength":"360",
            "type":"string",
            "description":"Customer bank branch name from the Zengin format file.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerAccountNumber":{
            "type":"string",
            "description":"Customer account number of the paying customer.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "VirtualAccountNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Virtual account number assigned to the customer account or site.",
            "nullable":true,
            "x-queryable":true
        },
        "RemittanceBankBranchNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Bank branch number of the remittance bank that issues the virtual account number for the customer account or site.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "RemittanceBankNumber"
                ]
            },
            "x-queryable":true
        },
        "AlternateNameId":{
            "type":"integer",
            "description":"Unique identifier of the alternate name mapping rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "BillToSite":{
            "maxLength":"150",
            "type":"string",
            "description":"Bill-to site of the paying customer.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "CustomerAccountNumber"
                ]
            }
        },
        "Active":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the alternate name mapping rule is active.",
            "nullable":true,
            "x-queryable":true
        },
        "ZenginCustomerBankName":{
            "maxLength":"360",
            "type":"string",
            "description":"Customer bank name from the Zengin format file.",
            "nullable":true,
            "x-queryable":true
        },
        "RemittanceBankNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Bank number of the remittance bank that issues the virtual account number for the customer account or site.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Object version number for the alternate name mapping rule.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CustomerName":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"Name of the paying customer.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RemittanceBankName":{
            "maxLength":"255",
            "type":"string",
            "description":"Bank branch name of the remittance bank that issues the virtual account number for the customer account or site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the alternate name mapping rule was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The user login that last updated the alternate name mapping rule.",
            "nullable":true,
            "readOnly":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