Jump to

• Request
• Response

Update a linked account details

patch

/fscmRestApi/resources/11.13.18.05/hedCustomerAccounts/{PartyId}/child/linkedAccountDetails/{AccountId}

Request

Path Parameters

• AccountId(required): integer
  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=
• PartyId(required): integer
  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: 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

• CustomerClassCode: string
  Title: Customer Class Code

  The unique identifier of the customer class assigned to the customer account.
• CustomerProfileClassId: integer
  Title: Customer Profile Class ID

  Code indicating the account's customer profile class. Customer profile classes organize customer accounts into categories that reflect the needs of the deploying company.
• DefaultFlag: boolean
  Title: Default Indicator

  Indicates whether a customer account is the default account for a person. If true, Student Management automated processes will use the account when creating transactions. When false, the account can be viewed in Student Management but by default won't be used by automated processes.
• Description: string
  Title: Description

  Description of the customer account.
• PaymentTermId: integer
  Title: Payment Term ID

  The unique identifier of the payment term assigned to the customer account. Payment terms are used to calculate transaction due dates.
• StatusCode: string
  Title: Status Code

  The code that represents the status of a Receivables customer account. Valid values are A for Active or I for Inactive.
• StatusMeaning: string
  Title: Status Meaning

  The meaning of the status code. Valid values are Active and Inactive.
• TerminationDate: string (date)
  Title: Termination Date

  The date when a customer account is no longer available for use.

{
    "type":"object",
    "properties":{
        "StatusMeaning":{
            "title":"Status Meaning",
            "type":"string",
            "description":"The meaning of the status code. Valid values are Active and Inactive.",
            "nullable":true
        },
        "PaymentTermId":{
            "title":"Payment Term ID",
            "type":"integer",
            "description":"The unique identifier of the payment term assigned to the customer account. Payment terms are used to calculate transaction due dates.",
            "nullable":true
        },
        "Description":{
            "title":"Description",
            "type":"string",
            "description":"Description of the customer account.",
            "nullable":true
        },
        "TerminationDate":{
            "title":"Termination Date",
            "type":"string",
            "description":"The date when a customer account is no longer available for use.",
            "format":"date",
            "nullable":true
        },
        "DefaultFlag":{
            "title":"Default Indicator",
            "type":"boolean",
            "description":"Indicates whether a customer account is the default account for a person. If true, Student Management automated processes will use the account when creating transactions. When false, the account can be viewed in Student Management but by default won't be used by automated processes.",
            "nullable":true
        },
        "CustomerProfileClassId":{
            "title":"Customer Profile Class ID",
            "type":"integer",
            "description":"Code indicating the account's customer profile class. Customer profile classes organize customer accounts into categories that reflect the needs of the deploying company.",
            "nullable":true
        },
        "StatusCode":{
            "title":"Status Code",
            "type":"string",
            "description":"The code that represents the status of a Receivables customer account. Valid values are A for Active or I for Inactive.",
            "nullable":true
        },
        "CustomerClassCode":{
            "title":"Customer Class Code",
            "type":"string",
            "description":"The unique identifier of the customer class assigned to the customer account.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

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 : hedCustomerAccounts-linkedAccountDetails-item-response

Type: object

Show Source

• AccountId: integer
  Title: Account ID

  Read Only: true

  The unique identifier for a Receivables customer account.
• AccountNumber: string
  Title: Account Number

  Read Only: true

  The number that identifies a customer account.
• AccountTypeCode: string
  Title: Account Type Code

  Read Only: true

  Code indicating the type of customer account.
• AccountTypeMeaning: string
  Title: Account Type Meaning

  Read Only: true

  Maximum Length: 255

  Meaning of the customer account type code.
• CustomerClassCode: string
  Title: Customer Class Code

  The unique identifier of the customer class assigned to the customer account.
• CustomerClassMeaning: string
  Title: Customer Class Meaning

  Read Only: true

  Maximum Length: 255

  The meaning of the customer class assigned to the customer account.
• CustomerProfileClassId: integer
  Title: Customer Profile Class ID

  Code indicating the account's customer profile class. Customer profile classes organize customer accounts into categories that reflect the needs of the deploying company.
• CustomerProfileClassName: string
  Title: Customer Profile Class Name

  Read Only: true

  Maximum Length: 255

  The name of the account's customer profile class. Customer profile classes organize customer accounts into categories that reflect the needs of the deploying company.
• DefaultFlag: boolean
  Title: Default Indicator

  Indicates whether a customer account is the default account for a person. If true, Student Management automated processes will use the account when creating transactions. When false, the account can be viewed in Student Management but by default won't be used by automated processes.
• DeletableFlag: boolean
  Title: Deletable Indicator

  Read Only: true

  Indicates whether a customer account can be deleted using Student Management.
• Description: string
  Title: Description

  Description of the customer account.
• EstablishmentDate: string (date)
  Title: Establishment Date

  Read Only: true

  The date when a customer account is set up or becomes valid.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PaymentTermId: integer
  Title: Payment Term ID

  The unique identifier of the payment term assigned to the customer account. Payment terms are used to calculate transaction due dates.
• PaymentTermName: string
  Title: Payment Term Name

  Read Only: true

  Maximum Length: 255

  The name of the payment term assigned to the customer account. Payment terms are used to calculate transaction due dates.
• StatusCode: string
  Title: Status Code

  The code that represents the status of a Receivables customer account. Valid values are A for Active or I for Inactive.
• StatusMeaning: string
  Title: Status Meaning

  The meaning of the status code. Valid values are Active and Inactive.
• TerminationDate: string (date)
  Title: Termination Date

  The date when a customer account is no longer available for use.

{
    "type":"object",
    "properties":{
        "EstablishmentDate":{
            "title":"Establishment Date",
            "type":"string",
            "description":"The date when a customer account is set up or becomes valid.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PaymentTermName":{
            "title":"Payment Term Name",
            "maxLength":255,
            "type":"string",
            "description":"The name of the payment term assigned to the customer account. Payment terms are used to calculate transaction due dates.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PaymentTermId":{
            "title":"Payment Term ID",
            "type":"integer",
            "description":"The unique identifier of the payment term assigned to the customer account. Payment terms are used to calculate transaction due dates.",
            "nullable":true,
            "x-queryable":true
        },
        "AccountId":{
            "title":"Account ID",
            "type":"integer",
            "description":"The unique identifier for a Receivables customer account.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "type":"string",
            "description":"Description of the customer account.",
            "nullable":true,
            "x-queryable":true
        },
        "TerminationDate":{
            "title":"Termination Date",
            "type":"string",
            "description":"The date when a customer account is no longer available for use.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AccountTypeMeaning":{
            "title":"Account Type Meaning",
            "maxLength":255,
            "type":"string",
            "description":"Meaning of the customer account type code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerProfileClassId":{
            "title":"Customer Profile Class ID",
            "type":"integer",
            "description":"Code indicating the account's customer profile class. Customer profile classes organize customer accounts into categories that reflect the needs of the deploying company.",
            "nullable":true,
            "x-queryable":true
        },
        "DeletableFlag":{
            "title":"Deletable Indicator",
            "type":"boolean",
            "description":"Indicates whether a customer account can be deleted using Student Management.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status Code",
            "type":"string",
            "description":"The code that represents the status of a Receivables customer account. Valid values are A for Active or I for Inactive.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerProfileClassName":{
            "title":"Customer Profile Class Name",
            "maxLength":255,
            "type":"string",
            "description":"The name of the account's customer profile class. Customer profile classes organize customer accounts into categories that reflect the needs of the deploying company.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AccountNumber":{
            "title":"Account Number",
            "type":"string",
            "description":"The number that identifies a customer account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerClassCode":{
            "title":"Customer Class Code",
            "type":"string",
            "description":"The unique identifier of the customer class assigned to the customer account.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StatusMeaning":{
            "title":"Status Meaning",
            "type":"string",
            "description":"The meaning of the status code. Valid values are Active and Inactive.",
            "nullable":true,
            "x-queryable":true
        },
        "AccountTypeCode":{
            "title":"Account Type Code",
            "type":"string",
            "description":"Code indicating the type of customer account.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CustomerClassMeaning":{
            "title":"Customer Class Meaning",
            "maxLength":255,
            "type":"string",
            "description":"The meaning of the customer class assigned to the customer account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DefaultFlag":{
            "title":"Default Indicator",
            "type":"boolean",
            "description":"Indicates whether a customer account is the default account for a person. If true, Student Management automated processes will use the account when creating transactions. When false, the account can be viewed in Student Management but by default won't be used by automated processes.",
            "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."
        }
    }
}

Links

accountTypesLOV

Operation: /fscmRestApi/resources/11.13.18.05/genericLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DCUSTOMER_TYPE

The following properties are defined on the LOV link relation:

• Source Attribute: AccountTypeCode; Target Attribute: LookupCode
• Display Attribute: Meaning

customerClassesLOV

Operation: /fscmRestApi/resources/11.13.18.05/genericLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DCUSTOMER%20CLASS

The following properties are defined on the LOV link relation:

• Source Attribute: CustomerClassCode; Target Attribute: LookupCode
• Display Attribute: Meaning

customerProfileClassesLOV

Operation: /fscmRestApi/resources/11.13.18.05/customerProfileClassesLOV

The following properties are defined on the LOV link relation:

• Source Attribute: CustomerProfileClassName; Target Attribute: ProfileName
• Display Attribute: ProfileName

paymentTermsLOV

Operation: /fscmRestApi/resources/11.13.18.05/paymentTermsLOV

The following properties are defined on the LOV link relation:

• Source Attribute: PaymentTermName; Target Attribute: PaymentTermName
• Display Attribute: PaymentTermName

Back to Top