Jump to

• Request
• Response

Update a deposit account fund data

patch

/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountFunds/{DepositFundKey}

Request

Path Parameters

• DepositFundKey(required): integer(int64)
  The unique record key assigned to the deposit account fund record.

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

• AssetAccountCombination: integer (int64)
  The cash general ledger account code combination to be populated on the external transaction.
• BusinessUnitName: string
  Maximum Length: 360

  The business unit associated with the bank account.
• DepositBankAccountName: string
  Title: Deposit Bank Account Name

  Maximum Length: 360

  The name of the bank account in which the funds associated with the deposit account are held.
• LetterOfCreditAmount: number
  Title: Amount

  The amount on the letter of credit.
• LetterOfCreditCurrency: string
  Title: Currency

  Maximum Length: 3

  The currency of the amount on the letter of credit.
• LetterOfCreditExpirationDate: string (date)
  Title: Expiration Date

  The date on which the letter of credit expires.
• LetterOfCreditIssuerAddress: string
  Title: Issuer Address

  Maximum Length: 240

  The address of the organization who issued the letter of credit.
• LetterOfCreditIssuerName: string
  Title: Issuer Name

  Maximum Length: 100

  The name of the organization who issued the letter of credit.
• LetterOfCreditNumber: string
  Title: Number

  Maximum Length: 50

  The number assigned to the letter of credit.
• LetterOfCreditRenewFlag: boolean
  Title: Renewable

  Maximum Length: 1

  Indicates whether a letter of credit is renewable upon expiration.
• LetterOfCreditStartDate: string (date)
  Title: Start Date

  The date from which the letter of credit is effective.
• OffsetAccountCombination: integer (int64)
  The offset general ledger account code combination to be populated on the external transaction.
• SecurityType: string
  Title: Funding Type

  Maximum Length: 30

  Indicates the type of funding provided for the deposit account.

{
    "type":"object",
    "properties":{
        "OffsetAccountCombination":{
            "type":"integer",
            "description":"The offset general ledger account code combination to be populated on the external transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "SecurityType":{
            "title":"Funding Type",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the type of funding provided for the deposit account.",
            "nullable":false
        },
        "LetterOfCreditIssuerName":{
            "title":"Issuer Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the organization who issued the letter of credit.",
            "nullable":true
        },
        "LetterOfCreditIssuerAddress":{
            "title":"Issuer Address",
            "maxLength":"240",
            "type":"string",
            "description":"The address of the organization who issued the letter of credit.",
            "nullable":true
        },
        "LetterOfCreditNumber":{
            "title":"Number",
            "maxLength":"50",
            "type":"string",
            "description":"The number assigned to the letter of credit.",
            "nullable":true
        },
        "AssetAccountCombination":{
            "type":"integer",
            "description":"The cash general ledger account code combination to be populated on the external transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "LetterOfCreditExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The date on which the letter of credit expires.",
            "format":"date",
            "nullable":true
        },
        "LetterOfCreditRenewFlag":{
            "title":"Renewable",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a letter of credit is renewable upon expiration.",
            "nullable":true
        },
        "LetterOfCreditStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date from which the letter of credit is effective.",
            "format":"date",
            "nullable":true
        },
        "DepositBankAccountName":{
            "title":"Deposit Bank Account Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the bank account in which the funds associated with the deposit account are held.",
            "nullable":true
        },
        "LetterOfCreditCurrency":{
            "title":"Currency",
            "maxLength":"3",
            "type":"string",
            "description":"The currency of the amount on the letter of credit.",
            "nullable":true
        },
        "LetterOfCreditAmount":{
            "title":"Amount",
            "type":"number",
            "description":"The amount on the letter of credit.",
            "nullable":true
        },
        "BusinessUnitName":{
            "maxLength":"360",
            "type":"string",
            "description":"The business unit associated with the bank account.",
            "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 : publicSectorDepositAccountFunds-item-response

Type: object

Show Source

• AssetAccountCombination: integer (int64)
  The cash general ledger account code combination to be populated on the external transaction.
• BusinessUnitName: string
  Maximum Length: 360

  The business unit associated with the bank account.
• DepositAccountKey: integer (int64)
  The unique system generated numeric identifier of the deposit account.
• DepositAccountNumber: string
  Maximum Length: 30

  The unique agency-defined alphanumeric identifier of the deposit account.
• DepositBankAccountName: string
  Title: Deposit Bank Account Name

  Maximum Length: 360

  The name of the bank account in which the funds associated with the deposit account are held.
• DepositFundKey: integer (int64)
  Title: Deposit Account Fund Key

  The unique record key assigned to the deposit account fund record.
• LetterOfCreditAmount: number
  Title: Amount

  The amount on the letter of credit.
• LetterOfCreditCurrency: string
  Title: Currency

  Maximum Length: 3

  The currency of the amount on the letter of credit.
• LetterOfCreditExpirationDate: string (date)
  Title: Expiration Date

  The date on which the letter of credit expires.
• LetterOfCreditIssuerAddress: string
  Title: Issuer Address

  Maximum Length: 240

  The address of the organization who issued the letter of credit.
• LetterOfCreditIssuerName: string
  Title: Issuer Name

  Maximum Length: 100

  The name of the organization who issued the letter of credit.
• LetterOfCreditNumber: string
  Title: Number

  Maximum Length: 50

  The number assigned to the letter of credit.
• LetterOfCreditRenewFlag: boolean
  Title: Renewable

  Maximum Length: 1

  Indicates whether a letter of credit is renewable upon expiration.
• LetterOfCreditStartDate: string (date)
  Title: Start Date

  The date from which the letter of credit is effective.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OffsetAccountCombination: integer (int64)
  The offset general ledger account code combination to be populated on the external transaction.
• SecurityType: string
  Title: Funding Type

  Maximum Length: 30

  Indicates the type of funding provided for the deposit account.
• SecurityTypeDesc: string
  Read Only: true

  Maximum Length: 80

  Describes the type of funding provided for the deposit account.

{
    "type":"object",
    "properties":{
        "OffsetAccountCombination":{
            "type":"integer",
            "description":"The offset general ledger account code combination to be populated on the external transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SecurityType":{
            "title":"Funding Type",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the type of funding provided for the deposit account.",
            "nullable":false,
            "x-queryable":true
        },
        "SecurityTypeDesc":{
            "maxLength":"80",
            "type":"string",
            "description":"Describes the type of funding provided for the deposit account.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LetterOfCreditIssuerName":{
            "title":"Issuer Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the organization who issued the letter of credit.",
            "nullable":true,
            "x-queryable":true
        },
        "LetterOfCreditIssuerAddress":{
            "title":"Issuer Address",
            "maxLength":"240",
            "type":"string",
            "description":"The address of the organization who issued the letter of credit.",
            "nullable":true,
            "x-queryable":true
        },
        "LetterOfCreditNumber":{
            "title":"Number",
            "maxLength":"50",
            "type":"string",
            "description":"The number assigned to the letter of credit.",
            "nullable":true,
            "x-queryable":true
        },
        "AssetAccountCombination":{
            "type":"integer",
            "description":"The cash general ledger account code combination to be populated on the external transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DepositAccountKey":{
            "type":"integer",
            "description":"The unique system generated numeric identifier of the deposit account.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LetterOfCreditExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The date on which the letter of credit expires.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LetterOfCreditRenewFlag":{
            "title":"Renewable",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a letter of credit is renewable upon expiration.",
            "nullable":true,
            "x-queryable":true
        },
        "LetterOfCreditStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date from which the letter of credit is effective.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "DepositFundKey":{
            "title":"Deposit Account Fund Key",
            "type":"integer",
            "description":"The unique record key assigned to the deposit account fund record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DepositAccountNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique agency-defined alphanumeric identifier of the deposit account.",
            "nullable":true,
            "x-queryable":true
        },
        "DepositBankAccountName":{
            "title":"Deposit Bank Account Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the bank account in which the funds associated with the deposit account are held.",
            "nullable":true,
            "x-queryable":true
        },
        "LetterOfCreditCurrency":{
            "title":"Currency",
            "maxLength":"3",
            "type":"string",
            "description":"The currency of the amount on the letter of credit.",
            "nullable":true,
            "x-queryable":true
        },
        "LetterOfCreditAmount":{
            "title":"Amount",
            "type":"number",
            "description":"The amount on the letter of credit.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BusinessUnitName":{
            "maxLength":"360",
            "type":"string",
            "description":"The business unit associated with the bank account.",
            "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