Jump to

• Request
• Response
• Examples

Update a federal treasury confirmation schedule

patch

/fscmRestApi/resources/11.13.18.05/fedTreasuryConfirmationSchedules/{TreasuryConfirmationId}

Request

Path Parameters

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

• ConfirmationDate: string (date)
  Title: Confirmation Date

  Date when payment completion is communicated for the federal treasury confirmation schedule resource.
• ControlNumber: string
  Title: Control Number

  Maximum Length: 7

  Control number of the treasury confirmation schedule.
• fedTreasuryCheckRanges: array Federal Treasury Check Ranges
  Title: Federal Treasury Check Ranges

  The federal treasury check ranges resource is used to query treasury check ranges.
• FromRange: integer (int64)
  Title: From Range

  The beginning payment document number of the federal treasury confirmation schedule.
• RangeType: string
  Title: Range Type

  Maximum Length: 255

  Range type of the federal treasury confirmation schedule.
• RevisionNumber: integer (int64)
  Title: Revision Number

  Revision number of the federal treasury confirmation schedule.
• Status: string
  Title: Status

  Maximum Length: 255

  Status of the federal treasury confirmation schedule.
• ToRange: integer (int64)
  Title: To Range

  The ending payment document number of the federal treasury confirmation schedule.
• TreasuryAccounted: string
  Title: Treasury Accounted

  Maximum Length: 255

  Indicates whether a federal treasury confirmation schedule is accounted for or not.
• TreasuryEventId: integer (int64)
  Title: Treasury Event ID

  The unique identifier of the treasury event associated with the federal treasury confirmation schedule.

{
    "type":"object",
    "properties":{
        "Status":{
            "title":"Status",
            "maxLength":"255",
            "type":"string",
            "description":"Status of the federal treasury confirmation schedule.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show",
                "dependencies":[
                    "LookupCode1",
                    "LookupType1",
                    "Meaning1"
                ]
            }
        },
        "fedTreasuryCheckRanges":{
            "title":"Federal Treasury Check Ranges",
            "type":"array",
            "description":"The federal treasury check ranges resource is used to query treasury check ranges.",
            "items":{
                "$ref":"#/components/schemas/fedTreasuryConfirmationSchedules-fedTreasuryCheckRanges-item-patch-request"
            }
        },
        "RangeType":{
            "title":"Range Type",
            "maxLength":"255",
            "type":"string",
            "description":"Range type of the federal treasury confirmation schedule.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show",
                "dependencies":[
                    "LookupCode",
                    "LookupType",
                    "Meaning"
                ]
            }
        },
        "FromRange":{
            "title":"From Range",
            "type":"integer",
            "description":"The beginning payment document number of the federal treasury confirmation schedule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show",
                "dependencies":[
                    "RangeType"
                ]
            }
        },
        "ToRange":{
            "title":"To Range",
            "type":"integer",
            "description":"The ending payment document number of the federal treasury confirmation schedule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show",
                "dependencies":[
                    "RangeType"
                ]
            }
        },
        "TreasuryEventId":{
            "title":"Treasury Event ID",
            "type":"integer",
            "description":"The unique identifier of the treasury event associated with the federal treasury confirmation schedule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            }
        },
        "ConfirmationDate":{
            "title":"Confirmation Date",
            "type":"string",
            "description":"Date when payment completion is communicated for the federal treasury confirmation schedule resource.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "TreasuryAccounted":{
            "title":"Treasury Accounted",
            "maxLength":"255",
            "type":"string",
            "description":"Indicates whether a federal treasury confirmation schedule is accounted for or not.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show",
                "dependencies":[
                    "LookupCode2",
                    "LookupType2",
                    "Meaning2"
                ]
            }
        },
        "RevisionNumber":{
            "title":"Revision Number",
            "type":"integer",
            "description":"Revision number of the federal treasury confirmation schedule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            }
        },
        "ControlNumber":{
            "title":"Control Number",
            "maxLength":"7",
            "type":"string",
            "description":"Control number of the treasury confirmation schedule.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        }
    }
}

Nested Schema : Federal Treasury Check Ranges

Type: array

Title: Federal Treasury Check Ranges

The federal treasury check ranges resource is used to query treasury check ranges.

Show Source

• Array of: object fedTreasuryConfirmationSchedules-fedTreasuryCheckRanges-item-patch-request

{
    "title":"Federal Treasury Check Ranges",
    "type":"array",
    "description":"The federal treasury check ranges resource is used to query treasury check ranges.",
    "items":{
        "$ref":"#/components/schemas/fedTreasuryConfirmationSchedules-fedTreasuryCheckRanges-item-patch-request"
    }
}

Nested Schema : fedTreasuryConfirmationSchedules-fedTreasuryCheckRanges-item-patch-request

Type: object

Show Source

• FromRange: integer (int64)
  Title: From Range

  The beginning payment document number of the federal treasury check range.
• ToRange: integer (int64)
  Title: To Range

  The ending payment document number of the federal treasury check range.

{
    "type":"object",
    "properties":{
        "ToRange":{
            "title":"To Range",
            "type":"integer",
            "description":"The ending payment document number of the federal treasury check range.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            }
        },
        "FromRange":{
            "title":"From Range",
            "type":"integer",
            "description":"The beginning payment document number of the federal treasury check range.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            }
        }
    }
}

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

Type: object

Show Source

• AgencyLocationCode: string
  Title: Agency Location Code

  Read Only: true

  Maximum Length: 30

  Agency location code associated with the treasury confirmation schedule.
• Amount: number
  Title: Amount

  Amount paid for the federal treasury confirmation schedule.
• BusinessUnit: string
  Title: Business Unit Name

  Maximum Length: 80

  Business unit associated with the treasury confirmation schedule.
• ConfirmationDate: string (date)
  Title: Confirmation Date

  Date when payment completion is communicated for the federal treasury confirmation schedule resource.
• ControlNumber: string
  Title: Control Number

  Maximum Length: 7

  Control number of the treasury confirmation schedule.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  User who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date when the record was created.
• FederalPaymentTypeCode: string
  Title: Federal Payment Type

  Read Only: true

  Maximum Length: 30

  Federal payment type code associated with the treasury confirmation schedule.
• fedTreasuryCheckRanges: array Federal Treasury Check Ranges
  Title: Federal Treasury Check Ranges

  The federal treasury check ranges resource is used to query treasury check ranges.
• FromRange: integer (int64)
  Title: From Range

  The beginning payment document number of the federal treasury confirmation schedule.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  User who last updated the record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The last user login that was used to update the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NumberOfPayments: integer (int64)
  Title: Number of Payments

  Number of payments of the federal treasury confirmation schedule.
• PaymentDate: string (date)
  Title: Payment Date

  Payment date of the federal treasury confirmation schedule.
• PaymentGroup: string
  Title: Pay Group

  Read Only: true

  Payment group of the treasury confirmation schedule.
• PaymentInstructionId: integer (int64)
  Title: Payment Instruction ID

  The unique identifier of the payment instruction associated with the federal treasury confirmation schedule.
• PaymentMethod: string
  Title: Payment Method

  Read Only: true

  Payment method of the treasury confirmation schedule.
• PaymentProcessRequest: string
  Title: Payment Process Request

  Maximum Length: 255

  Payment process request of the federal treasury confirmation schedule.
• RangeType: string
  Title: Range Type

  Maximum Length: 255

  Range type of the federal treasury confirmation schedule.
• RevisionNumber: integer (int64)
  Title: Revision Number

  Revision number of the federal treasury confirmation schedule.
• ScheduleDate: string (date)
  Title: Schedule Date

  Schedule date of the federal treasury confirmation schedule.
• Status: string
  Title: Status

  Maximum Length: 255

  Status of the federal treasury confirmation schedule.
• ToRange: integer (int64)
  Title: To Range

  The ending payment document number of the federal treasury confirmation schedule.
• TreasuryAccounted: string
  Title: Treasury Accounted

  Maximum Length: 255

  Indicates whether a federal treasury confirmation schedule is accounted for or not.
• TreasuryConfirmationId: integer (int64)
  Title: Treasury Confirmation ID

  The unique identifier of the treasury confirmation associated with the federal treasury confirmation schedule.
• TreasuryEventId: integer (int64)
  Title: Treasury Event ID

  The unique identifier of the treasury event associated with the federal treasury confirmation schedule.

{
    "type":"object",
    "properties":{
        "fedTreasuryCheckRanges":{
            "title":"Federal Treasury Check Ranges",
            "type":"array",
            "description":"The federal treasury check ranges resource is used to query treasury check ranges.",
            "items":{
                "$ref":"#/components/schemas/fedTreasuryConfirmationSchedules-fedTreasuryCheckRanges-item-response"
            }
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "FederalPaymentTypeCode":{
            "title":"Federal Payment Type",
            "maxLength":"30",
            "type":"string",
            "description":"Federal payment type code associated with the treasury confirmation schedule.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ToRange":{
            "title":"To Range",
            "type":"integer",
            "description":"The ending payment document number of the federal treasury confirmation schedule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show",
                "dependencies":[
                    "RangeType"
                ]
            },
            "x-queryable":true
        },
        "ScheduleDate":{
            "title":"Schedule Date",
            "type":"string",
            "description":"Schedule date of the federal treasury confirmation schedule.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "PaymentProcessRequest":{
            "title":"Payment Process Request",
            "maxLength":"255",
            "type":"string",
            "description":"Payment process request of the federal treasury confirmation schedule.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "PaymentInstructionId":{
            "title":"Payment Instruction ID",
            "type":"integer",
            "description":"The unique identifier of the payment instruction associated with the federal treasury confirmation schedule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "RangeType":{
            "title":"Range Type",
            "maxLength":"255",
            "type":"string",
            "description":"Range type of the federal treasury confirmation schedule.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show",
                "dependencies":[
                    "LookupCode",
                    "LookupType",
                    "Meaning"
                ]
            },
            "x-queryable":true
        },
        "FromRange":{
            "title":"From Range",
            "type":"integer",
            "description":"The beginning payment document number of the federal treasury confirmation schedule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show",
                "dependencies":[
                    "RangeType"
                ]
            },
            "x-queryable":true
        },
        "TreasuryEventId":{
            "title":"Treasury Event ID",
            "type":"integer",
            "description":"The unique identifier of the treasury event associated with the federal treasury confirmation schedule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TreasuryAccounted":{
            "title":"Treasury Accounted",
            "maxLength":"255",
            "type":"string",
            "description":"Indicates whether a federal treasury confirmation schedule is accounted for or not.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show",
                "dependencies":[
                    "LookupCode2",
                    "LookupType2",
                    "Meaning2"
                ]
            },
            "x-queryable":true
        },
        "TreasuryConfirmationId":{
            "title":"Treasury Confirmation ID",
            "type":"integer",
            "description":"The unique identifier of the treasury confirmation associated with the federal treasury confirmation schedule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "NumberOfPayments":{
            "title":"Number of Payments",
            "type":"integer",
            "description":"Number of payments of the federal treasury confirmation schedule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "PaymentGroup":{
            "title":"Pay Group",
            "type":"string",
            "description":"Payment group of the treasury confirmation schedule.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show",
                "dependencies":[
                    "LookupCode4",
                    "LookupType4",
                    "Meaning4",
                    "ViewApplicationId1"
                ]
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"User who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":"255",
            "type":"string",
            "description":"Status of the federal treasury confirmation schedule.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show",
                "dependencies":[
                    "LookupCode1",
                    "LookupType1",
                    "Meaning1"
                ]
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "PaymentDate":{
            "title":"Payment Date",
            "type":"string",
            "description":"Payment date of the federal treasury confirmation schedule.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "Amount":{
            "title":"Amount",
            "type":"number",
            "description":"Amount paid for the federal treasury confirmation schedule.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ConfirmationDate":{
            "title":"Confirmation Date",
            "type":"string",
            "description":"Date when payment completion is communicated for the federal treasury confirmation schedule resource.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "RevisionNumber":{
            "title":"Revision Number",
            "type":"integer",
            "description":"Revision number of the federal treasury confirmation schedule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "AgencyLocationCode":{
            "title":"Agency Location Code",
            "maxLength":"30",
            "type":"string",
            "description":"Agency location code associated with the treasury confirmation schedule.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "BusinessUnit":{
            "title":"Business Unit Name",
            "maxLength":"80",
            "type":"string",
            "description":"Business unit associated with the treasury confirmation schedule.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show",
                "dependencies":[
                    "BusinessUnitId1",
                    "Name"
                ]
            },
            "x-queryable":true
        },
        "PaymentMethod":{
            "title":"Payment Method",
            "type":"string",
            "description":"Payment method of the treasury confirmation schedule.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show",
                "dependencies":[
                    "LookupCode3",
                    "LookupType3",
                    "Meaning3",
                    "ViewApplicationId"
                ]
            },
            "x-queryable":true
        },
        "ControlNumber":{
            "title":"Control Number",
            "maxLength":"7",
            "type":"string",
            "description":"Control number of the treasury confirmation schedule.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The last user login that was used to update the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Federal Treasury Check Ranges

Type: array

Title: Federal Treasury Check Ranges

The federal treasury check ranges resource is used to query treasury check ranges.

Show Source

• Array of: object fedTreasuryConfirmationSchedules-fedTreasuryCheckRanges-item-response

{
    "title":"Federal Treasury Check Ranges",
    "type":"array",
    "description":"The federal treasury check ranges resource is used to query treasury check ranges.",
    "items":{
        "$ref":"#/components/schemas/fedTreasuryConfirmationSchedules-fedTreasuryCheckRanges-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 : fedTreasuryConfirmationSchedules-fedTreasuryCheckRanges-item-response

Type: object

Show Source

• CheckRangeId: integer (int64)
  Title: Check Range ID

  The unique identifier of the federal treasury check range associated with the federal treasury confirmation schedule.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  User who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date when the record was created.
• FromRange: integer (int64)
  Title: From Range

  The beginning payment document number of the federal treasury check range.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  User who last updated the record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The last user login that was used to update the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ToRange: integer (int64)
  Title: To Range

  The ending payment document number of the federal treasury check range.
• TreasuryConfirmationId: integer (int64)
  Title: Treasury Confirmation ID

  The unique identifier of the treasury confirmation associated with the check range.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"User who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "FromRange":{
            "title":"From Range",
            "type":"integer",
            "description":"The beginning payment document number of the federal treasury check range.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ToRange":{
            "title":"To Range",
            "type":"integer",
            "description":"The ending payment document number of the federal treasury check range.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CheckRangeId":{
            "title":"Check Range ID",
            "type":"integer",
            "description":"The unique identifier of the federal treasury check range associated with the federal treasury confirmation schedule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TreasuryConfirmationId":{
            "title":"Treasury Confirmation ID",
            "type":"integer",
            "description":"The unique identifier of the treasury confirmation associated with the check range.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The last user login that was used to update the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "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

fedTreasuryCheckRanges

Operation: /fscmRestApi/resources/11.13.18.05/fedTreasuryConfirmationSchedules/{TreasuryConfirmationId}/child/fedTreasuryCheckRanges

Parameters:

• TreasuryConfirmationId: $request.path.TreasuryConfirmationId

The federal treasury check ranges resource is used to query treasury check ranges.

Back to Top

Examples

The following example shows how to update a federal treasury confirmation schedule by submitting a PATCH request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload>
https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedTreasuryConfirmationSchedules/{TreasuryConfirmationId}

Example Request Body

The following example shows the contents of the request body in JSON format:

{
    "ControlNumber": "S108108"
}

Example Response Body

The following example shows the contents of the response body in JSON format:

{
    "TreasuryConfirmationId": 100105428422964,
    "PaymentInstructionId": 347085,
    "PaymentProcessRequest": "PPR-001",
    "BusinessUnit": "FederalBusinessUnit",
    "RevisionNumber": 0,
    "ScheduleDate": "2024-04-24",
    "PaymentDate": "2018-07-01",
    "ConfirmationDate": null,
    "NumberOfPayments": 3,
    "RangeType": "Single",
    "FromRange": null,
    "ToRange": null,
    "Amount": 3000,
    "Status": "Not Submitted",
    "TreasuryEventId": null,
    "TreasuryAccounted": "No",
    "AgencyLocationCode": "99990055",
    "FederalPaymentTypeCode": "PAM",
    "ControlNumber": "S108108",
    "PaymentGroup": "Vendor Vendor CCD",
    "PaymentMethod": "Electronic",
    "CreatedBy": "username",
    "CreationDate": "2024-04-24T08:59:16+00:00",
    "LastUpdateDate": "2024-04-24T09:21:36+00:00",
    "LastUpdatedBy": "username",
    "LastUpdateLogin": "1620FB171186EBB6E0635F6215AC73BE",
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedTreasuryConfirmationSchedules/100105428422964",
            "name": "fedTreasuryConfirmationSchedules",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedTreasuryConfirmationSchedules/100105428422964",
            "name": "fedTreasuryConfirmationSchedules",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedTreasuryConfirmationSchedules/100105428422964/child/fedTreasuryCheckRanges",
            "name": "fedTreasuryCheckRanges",
            "kind": "collection"
        }
    ]
}

Back to Top