Jump to

• Request
• Response

Update a fiscal document hold

patch

/fscmRestApi/resources/11.13.18.05/inboundFiscalDocumentHolds/{FiscalDocumentHoldId}

Request

Path Parameters

• FiscalDocumentHoldId(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: 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

• ReleaseDate: string (date-time)
  Indicates the date when the fiscal document hold was released.
• ReleasedBy: string
  Maximum Length: 64

  Indicates the user who released the hold on fiscal document.
• ReleaseReasonCode: string
  Maximum Length: 30

  Indicates the reason code for removing the fiscal document hold.
• ReleaseTypeCode: string
  Maximum Length: 30

  Indicates the reason type code used for releasing the hold.

{
    "type":"object",
    "properties":{
        "ReleaseDate":{
            "type":"string",
            "description":"Indicates the date when the fiscal document hold was released.",
            "format":"date-time",
            "nullable":true
        },
        "ReleaseReasonCode":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the reason code for removing the fiscal document hold.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ReleaseTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the reason type code used for releasing the hold.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ReleasedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Indicates the user who released the hold on fiscal document.",
            "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 : inboundFiscalDocumentHolds-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the hold.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the hold is created.
• DocumentHeaderId: integer (int64)
  Unique identifier of the fiscal document for which a hold exists.
• DocumentLineId: integer (int64)
  Read Only: true

  Unique identifier of the fiscal document line for which a hold exists.
• DocumentScheduleId: integer (int64)
  Read Only: true

  Unique identifier of the fiscal document line schedule for which a hold exists.
• ExceptionType: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Indicates the meaning of the exception hold created on a fiscal document.
• ExceptionTypeCode: string
  Maximum Length: 30

  Default Value: ORA_CMF_ET_MANUAL_HOLD

  Indicates the code of the exception hold created on a fiscal document.
• FiscalDocumentHoldId: integer (int64)
  Unique identifier of the fiscal document hold.
• HeaderItemLineAmount: number
  Read Only: true

  Indicates the reason code for removing the fiscal document hold.
• HeldBy: string
  Maximum Length: 64

  Indicates the user who placed the hold on the fiscal document.
• Hold: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Indicates the reason for the hold created on the fiscal document.
• HoldCode: string
  Maximum Length: 30

  Indicates the code for the hold created on the fiscal document.
• HoldDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 240

  Indicates the description for the hold created on the fiscal document.
• ItemId: integer (int64)
  Title: Item

  Read Only: true

  Indicates the reason code for removing the fiscal document hold.
• ItemNumber: string
  Read Only: true

  Maximum Length: 255

  Indicates the reason code for removing the fiscal document hold.
• LastUpdateDate: string (date-time)
  Read Only: true

  Indicates the date and time of the last update of the record.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Indicates the user who last updated the record.
• LineNumber: number
  Read Only: true

  Indicates the reason code for removing the fiscal document hold.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ReleaseDate: string (date-time)
  Indicates the date when the fiscal document hold was released.
• ReleasedBy: string
  Maximum Length: 64

  Indicates the user who released the hold on fiscal document.
• ReleaseReason: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Indicates the detailed reason for removing the fiscal document hold.
• ReleaseReasonCode: string
  Maximum Length: 30

  Indicates the reason code for removing the fiscal document hold.
• ReleaseType: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Indicates meaning of the hold release type.
• ReleaseTypeCode: string
  Maximum Length: 30

  Indicates the reason type code used for releasing the hold.
• ScheduleAllocatedQuantityinLinesUOM: number
  Read Only: true

  Indicates the reason code for removing the fiscal document hold.
• ScheduleAmountOnHold: number
  Read Only: true

  Indicates the reason code for removing the fiscal document hold.
• ScheduleNumber: integer
  Read Only: true

  Indicates the reason code for removing the fiscal document hold.
• ToleranceRuleId: integer (int64)
  Read Only: true

  Identifies the fiscal document tolerance rule used for placing the fiscal document hold.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the hold.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the hold is created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "DocumentHeaderId":{
            "type":"integer",
            "description":"Unique identifier of the fiscal document for which a hold exists.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DocumentLineId":{
            "type":"integer",
            "description":"Unique identifier of the fiscal document line for which a hold exists.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DocumentScheduleId":{
            "type":"integer",
            "description":"Unique identifier of the fiscal document line schedule for which a hold exists.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ExceptionType":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Indicates the meaning of the exception hold created on a fiscal document.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExceptionTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the code of the exception hold created on a fiscal document.",
            "nullable":false,
            "default":"ORA_CMF_ET_MANUAL_HOLD",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "FiscalDocumentHoldId":{
            "type":"integer",
            "description":"Unique identifier of the fiscal document hold.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "HeaderItemLineAmount":{
            "type":"number",
            "description":"Indicates the reason code for removing the fiscal document hold.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HeldBy":{
            "maxLength":64,
            "type":"string",
            "description":"Indicates the user who placed the hold on the fiscal document.",
            "nullable":true,
            "x-queryable":true
        },
        "Hold":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Indicates the reason for the hold created on the fiscal document.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "HoldCode":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the code for the hold created on the fiscal document.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "HoldDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Indicates the description for the hold created on the fiscal document.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemId":{
            "title":"Item",
            "type":"integer",
            "description":"Indicates the reason code for removing the fiscal document hold.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates the reason code for removing the fiscal document hold.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Indicates the date and time of the last update of the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Indicates the user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LineNumber":{
            "type":"number",
            "description":"Indicates the reason code for removing the fiscal document hold.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReleaseDate":{
            "type":"string",
            "description":"Indicates the date when the fiscal document hold was released.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ReleaseReason":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Indicates the detailed reason for removing the fiscal document hold.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReleaseReasonCode":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the reason code for removing the fiscal document hold.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ReleaseType":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Indicates meaning of the hold release type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReleaseTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the reason type code used for releasing the hold.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ReleasedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Indicates the user who released the hold on fiscal document.",
            "nullable":true,
            "x-queryable":true
        },
        "ScheduleAllocatedQuantityinLinesUOM":{
            "type":"number",
            "description":"Indicates the reason code for removing the fiscal document hold.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduleAmountOnHold":{
            "type":"number",
            "description":"Indicates the reason code for removing the fiscal document hold.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduleNumber":{
            "type":"integer",
            "description":"Indicates the reason code for removing the fiscal document hold.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ToleranceRuleId":{
            "type":"integer",
            "description":"Identifies the fiscal document tolerance rule used for placing the fiscal document hold.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

HoldCodeLookupVA

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_CMF_ET_MANUAL_HOLD%2CActiveDate%3D2025-08-22

The following properties are defined on the LOV link relation:

• Source Attribute: HoldCode; Target Attribute: LookupCode
• Display Attribute: LookupCode

ReleaseReasonCodeLookupVA

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_CMF_MANUAL_RELEASE

The following properties are defined on the LOV link relation:

• Source Attribute: ReleaseReasonCode; Target Attribute: LookupCode
• Display Attribute: LookupCode

ReleaseTypeLookupVA

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_CMF_RELEASE_ACTION

The following properties are defined on the LOV link relation:

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

StandardLookupTypesExceptionVA

Operation: /fscmRestApi/resources/11.13.18.05/standardLookups

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_CMF_ET_MANUAL_HOLD

The following properties are defined on the LOV link relation:

• Source Attribute: ExceptionTypeCode; Target Attribute: LookupType
• Display Attribute: Meaning

Back to Top