Jump to

• Request
• Response

Create a bank account use for a bank account

post

/fscmRestApi/resources/11.13.18.05/cashBankAccounts/{BankAccountId}/child/bankAccountUses

Request

Path Parameters

• BankAccountId(required): integer(int64)
  The unique identifier of the bank account.

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• bankAccountPaymentDocumentCategories: array Bank Account Payment Document Categories
  Title: Bank Account Payment Document Categories

  The bank account payment document categories resource manages the payment method and payment document category associated to the business unit.
• BankAccountUseId: integer (int64)
  The unique identifier of the bank account use.
• BankChargesAccountCombination: string
  The accounting flexfield combination for the bank charges account.
• BusinessUnitName: string
  Maximum Length: 255

  The name of the business unit. At least one business unit name must be provided by the user if the bank account is used for payables or receivables.
• CashAccountCombination: string
  The accounting flexfield combination for the cash account.
• CashClearingAccountCombination: string
  The accounting flexfield combination for the cash clearing account.
• EndDate: string (date)
  Title: End Date

  The last date when the record is active.
• ForeignExchangeGainAccountCombination: string
  The accounting flexfield combination for the account that posts the realized exchange rate gains.
• ForeignExchangeLossAccountCombination: string
  The accounting flexfield combination for the account that posts the realized exchange rate losses.
• GlBankAccountUseId(required): integer (int64)
  The unique identifier of the bank account use.

{
    "required":[
        "GlBankAccountUseId"
    ],
    "type":"object",
    "properties":{
        "bankAccountPaymentDocumentCategories":{
            "title":"Bank Account Payment Document Categories",
            "type":"array",
            "description":"The bank account payment document categories resource manages the payment method and payment document category associated to the business unit.",
            "items":{
                "$ref":"#/components/schemas/cashBankAccounts-bankAccountUses-bankAccountPaymentDocumentCategories-item-post-request"
            }
        },
        "ForeignExchangeGainAccountCombination":{
            "type":"string",
            "description":"The accounting flexfield combination for the account that posts the realized exchange rate gains.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "CashClearingAccountCombination":{
            "type":"string",
            "description":"The accounting flexfield combination for the cash clearing account.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "BankAccountUseId":{
            "type":"integer",
            "description":"The unique identifier of the bank account use.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "BankChargesAccountCombination":{
            "type":"string",
            "description":"The accounting flexfield combination for the bank charges account.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "BusinessUnitName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the business unit. At least one business unit name must be provided by the user if the bank account is used for payables or receivables.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "BUName"
                ]
            }
        },
        "CashAccountCombination":{
            "type":"string",
            "description":"The accounting flexfield combination for the cash account.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The last date when the record is active.",
            "format":"date",
            "nullable":true
        },
        "ForeignExchangeLossAccountCombination":{
            "type":"string",
            "description":"The accounting flexfield combination for the account that posts the realized exchange rate losses.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "GlBankAccountUseId":{
            "type":"integer",
            "description":"The unique identifier of the bank account use.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

Nested Schema : Bank Account Payment Document Categories

Type: array

Title: Bank Account Payment Document Categories

The bank account payment document categories resource manages the payment method and payment document category associated to the business unit.

Show Source

• Array of: object cashBankAccounts-bankAccountUses-bankAccountPaymentDocumentCategories-item-post-request

{
    "title":"Bank Account Payment Document Categories",
    "type":"array",
    "description":"The bank account payment document categories resource manages the payment method and payment document category associated to the business unit.",
    "items":{
        "$ref":"#/components/schemas/cashBankAccounts-bankAccountUses-bankAccountPaymentDocumentCategories-item-post-request"
    }
}

Nested Schema : cashBankAccounts-bankAccountUses-bankAccountPaymentDocumentCategories-item-post-request

Type: object

Show Source

• ApPmDocumentCategoryId: integer (int64)
  The unique identifier of the payment document category for the business unit.
• PaymentDocumentCategory: string
  Title: Payment Document Category

  The payment document category for the business unit.
• PaymentMethod: string
  Title: Payment Method

  The payment method of the payment document category for the business unit.

{
    "type":"object",
    "properties":{
        "PaymentMethod":{
            "title":"Payment Method",
            "type":"string",
            "description":"The payment method of the payment document category for the business unit.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "PaymentMethodName1"
                ]
            }
        },
        "PaymentDocumentCategory":{
            "title":"Payment Document Category",
            "type":"string",
            "description":"The payment document category for the business unit.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "PaymentDocumentCategoryName"
                ]
            }
        },
        "ApPmDocumentCategoryId":{
            "type":"integer",
            "description":"The unique identifier of the payment document category for the business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"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 : cashBankAccounts-bankAccountUses-item-response

Type: object

Show Source

• bankAccountPaymentDocumentCategories: array Bank Account Payment Document Categories
  Title: Bank Account Payment Document Categories

  The bank account payment document categories resource manages the payment method and payment document category associated to the business unit.
• BankAccountUseId: integer (int64)
  The unique identifier of the bank account use.
• BankChargesAccountCombination: string
  The accounting flexfield combination for the bank charges account.
• BusinessUnitName: string
  Maximum Length: 255

  The name of the business unit. At least one business unit name must be provided by the user if the bank account is used for payables or receivables.
• CashAccountCombination: string
  The accounting flexfield combination for the cash account.
• CashClearingAccountCombination: string
  The accounting flexfield combination for the cash clearing account.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the record was created.
• EndDate: string (date)
  Title: End Date

  The last date when the record is active.
• ForeignExchangeGainAccountCombination: string
  The accounting flexfield combination for the account that posts the realized exchange rate gains.
• ForeignExchangeLossAccountCombination: string
  The accounting flexfield combination for the account that posts the realized exchange rate losses.
• GlBankAccountUseId: integer (int64)
  The unique identifier of the bank account use.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The session login associated to the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CashClearingAccountCombination":{
            "type":"string",
            "description":"The accounting flexfield combination for the cash clearing account.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "BankAccountUseId":{
            "type":"integer",
            "description":"The unique identifier of the bank account use.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "BankChargesAccountCombination":{
            "type":"string",
            "description":"The accounting flexfield combination for the bank charges account.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The last date when the record is active.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "GlBankAccountUseId":{
            "type":"integer",
            "description":"The unique identifier of the bank account use.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "bankAccountPaymentDocumentCategories":{
            "title":"Bank Account Payment Document Categories",
            "type":"array",
            "description":"The bank account payment document categories resource manages the payment method and payment document category associated to the business unit.",
            "items":{
                "$ref":"#/components/schemas/cashBankAccounts-bankAccountUses-bankAccountPaymentDocumentCategories-item-response"
            }
        },
        "ForeignExchangeGainAccountCombination":{
            "type":"string",
            "description":"The accounting flexfield combination for the account that posts the realized exchange rate gains.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BusinessUnitName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the business unit. At least one business unit name must be provided by the user if the bank account is used for payables or receivables.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "BUName"
                ]
            },
            "x-queryable":true
        },
        "CashAccountCombination":{
            "type":"string",
            "description":"The accounting flexfield combination for the cash account.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "ForeignExchangeLossAccountCombination":{
            "type":"string",
            "description":"The accounting flexfield combination for the account that posts the realized exchange rate losses.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The session login associated to the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Bank Account Payment Document Categories

Type: array

Title: Bank Account Payment Document Categories

The bank account payment document categories resource manages the payment method and payment document category associated to the business unit.

Show Source

• Array of: object cashBankAccounts-bankAccountUses-bankAccountPaymentDocumentCategories-item-response

{
    "title":"Bank Account Payment Document Categories",
    "type":"array",
    "description":"The bank account payment document categories resource manages the payment method and payment document category associated to the business unit.",
    "items":{
        "$ref":"#/components/schemas/cashBankAccounts-bankAccountUses-bankAccountPaymentDocumentCategories-item-response"
    }
}

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 : cashBankAccounts-bankAccountUses-bankAccountPaymentDocumentCategories-item-response

Type: object

Show Source

• ApPmDocumentCategoryId: integer (int64)
  The unique identifier of the payment document category for the business unit.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the record was created.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The session login associated to the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PaymentDocumentCategory: string
  Title: Payment Document Category

  The payment document category for the business unit.
• PaymentMethod: string
  Title: Payment Method

  The payment method of the payment document category for the business unit.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ApPmDocumentCategoryId":{
            "type":"integer",
            "description":"The unique identifier of the payment document category for the business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PaymentMethod":{
            "title":"Payment Method",
            "type":"string",
            "description":"The payment method of the payment document category for the business unit.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "PaymentMethodName1"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PaymentDocumentCategory":{
            "title":"Payment Document Category",
            "type":"string",
            "description":"The payment document category for the business unit.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "PaymentDocumentCategoryName"
                ]
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The session login associated to the user who last updated the record.",
            "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."
        }
    }
}

Links

bankAccountPaymentDocumentCategories

Operation: /fscmRestApi/resources/11.13.18.05/cashBankAccounts/{BankAccountId}/child/bankAccountUses/{bankAccountUsesUniqID}/child/bankAccountPaymentDocumentCategories

Parameters:

• BankAccountId: $request.path.BankAccountId
• bankAccountUsesUniqID: $request.path.bankAccountUsesUniqID

The bank account payment document categories resource manages the payment method and payment document category associated to the business unit.

Back to Top