Jump to

• Request
• Response

Period

patch

/fscmRestApi/resources/11.13.18.05/receiptAccountingPeriodEndValidations/{receiptAccountingPeriodEndValidationsUniqID}

Request

Path Parameters

• receiptAccountingPeriodEndValidationsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- BusinessUnitId, ValidationType, LookupCode and LookupType ---for the Receipt Accounting Process Exceptions resource and used to uniquely identify an instance of Receipt Accounting Process Exceptions. The client should not generate the hash key value. Instead, the client should query on the Receipt Accounting Process Exceptions collection resource with a filter on the primary key values in order to navigate to a specific instance of Receipt Accounting Process Exceptions.
  
  For example: receiptAccountingPeriodEndValidations?q=BusinessUnitId=<value1>;ValidationType=<value2>;LookupCode=<value3>;LookupType=<value4>

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

• PeriodCloseFlag: boolean
  Title: Period Close

  Maximum Length: 1

  Period
• PeriodFinalCloseFlag: boolean
  Title: Final Period Close

  Maximum Length: 1

  Period
• ValidationActionCode: string
  Title: Action

  Maximum Length: 30

  Period

{
    "type":"object",
    "properties":{
        "PeriodCloseFlag":{
            "title":"Period Close",
            "maxLength":1,
            "type":"boolean",
            "description":"Period",
            "nullable":false
        },
        "PeriodFinalCloseFlag":{
            "title":"Final Period Close",
            "maxLength":1,
            "type":"boolean",
            "description":"Period",
            "nullable":false
        },
        "ValidationActionCode":{
            "title":"Action",
            "maxLength":30,
            "type":"string",
            "description":"Period",
            "nullable":false
        }
    }
}

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 : receiptAccountingPeriodEndValidations-item-response

Type: object

Show Source

• BusinessUnitId: integer (int64)
  Title: Business Unit

  Read Only: true

  Period
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Period
• CreationDate: string (date-time)
  Read Only: true

  Period
• LastUpdateDate: string (date-time)
  Read Only: true

  Period
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Period
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Period
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LookupCode: string
  Title: Lookup Code

  Read Only: true

  Maximum Length: 30

  Period
• LookupType: string
  Title: Lookup Type

  Read Only: true

  Maximum Length: 30

  Period
• Meaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Period
• PeriodCloseFlag: boolean
  Title: Period Close

  Maximum Length: 1

  Period
• PeriodFinalCloseFlag: boolean
  Title: Final Period Close

  Maximum Length: 1

  Period
• ValidationActionCode: string
  Title: Action

  Maximum Length: 30

  Period
• ValidationType: string
  Title: Validation Type

  Read Only: true

  Maximum Length: 30

  Period

{
    "type":"object",
    "properties":{
        "BusinessUnitId":{
            "title":"Business Unit",
            "type":"integer",
            "description":"Period",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Period",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Period",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Period",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Period",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Period",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LookupCode":{
            "title":"Lookup Code",
            "maxLength":30,
            "type":"string",
            "description":"Period",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LookupType":{
            "title":"Lookup Type",
            "maxLength":30,
            "type":"string",
            "description":"Period",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Meaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Period",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodCloseFlag":{
            "title":"Period Close",
            "maxLength":1,
            "type":"boolean",
            "description":"Period",
            "nullable":false,
            "x-queryable":true
        },
        "PeriodFinalCloseFlag":{
            "title":"Final Period Close",
            "maxLength":1,
            "type":"boolean",
            "description":"Period",
            "nullable":false,
            "x-queryable":true
        },
        "ValidationActionCode":{
            "title":"Action",
            "maxLength":30,
            "type":"string",
            "description":"Period",
            "nullable":false,
            "x-queryable":true
        },
        "ValidationType":{
            "title":"Validation Type",
            "maxLength":30,
            "type":"string",
            "description":"Period",
            "nullable":false,
            "readOnly":true,
            "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."
        }
    }
}

Back to Top