Get all federal treasury confirmation schedules

get

/fscmRestApi/resources/11.13.18.05/fedTreasuryConfirmationSchedules

Request

Query Parameters
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables

    • PaymentInstructionAltKey Finds the treasury confirmation schedule based on the payment instruction.
      Finder Variables
      • PaymentInstructionId; integer; The unique identifier of the payment instruction of the federal treasury confirmation schedule.
    • PrimaryKey Finds the federal treasury confirmation schedule that matches the primary key criteria specified.
      Finder Variables
      • TreasuryConfirmationId; integer; The unique identifier of the federal treasury confirmation schedule.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • AgencyLocationCode; string; Agency location code associated with the treasury confirmation schedule.
    • Amount; number; Amount paid for the federal treasury confirmation schedule.
    • BusinessUnit; string; Business unit associated with the treasury confirmation schedule.
    • ConfirmationDate; string; Date when payment completion is communicated for the federal treasury confirmation schedule resource.
    • ControlNumber; string; Control number of the treasury confirmation schedule.
    • CreatedBy; string; User who created the record.
    • CreationDate; string; Date when the record was created.
    • FederalPaymentTypeCode; string; Federal payment type code associated with the treasury confirmation schedule.
    • FromRange; integer; The beginning payment document number of the federal treasury confirmation schedule.
    • LastUpdateDate; string; Date when the record was last updated.
    • LastUpdateLogin; string; The last user login that was used to update the record.
    • LastUpdatedBy; string; User who last updated the record.
    • NumberOfPayments; integer; Number of payments of the federal treasury confirmation schedule.
    • PaymentDate; string; Payment date of the federal treasury confirmation schedule.
    • PaymentGroup; string; Payment group of the treasury confirmation schedule.
    • PaymentInstructionId; integer; The unique identifier of the payment instruction associated with the federal treasury confirmation schedule.
    • PaymentMethod; string; Payment method of the treasury confirmation schedule.
    • PaymentProcessRequest; string; Payment process request of the federal treasury confirmation schedule.
    • RangeType; string; Range type of the federal treasury confirmation schedule.
    • RevisionNumber; integer; Revision number of the federal treasury confirmation schedule.
    • ScheduleDate; string; Schedule date of the federal treasury confirmation schedule.
    • Status; string; Status of the federal treasury confirmation schedule.
    • ToRange; integer; The ending payment document number of the federal treasury confirmation schedule.
    • TreasuryAccounted; string; Indicates whether a federal treasury confirmation schedule is accounted for or not.
    • TreasuryConfirmationId; integer; The unique identifier of the treasury confirmation associated with the federal treasury confirmation schedule.
    • TreasuryEventId; integer; The unique identifier of the treasury event associated with the federal treasury confirmation schedule.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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".
  • 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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : fedTreasuryConfirmationSchedules-item-response
Type: object
Show Source
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
Nested Schema : fedTreasuryConfirmationSchedules-fedTreasuryCheckRanges-item-response
Type: object
Show Source
Back to Top

Examples

You can use the GET action in the Federal Treasury Confirmation Schedules REST API to retrieve all federal treasury confirmation schedules and their detailed information.

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

Example Response Body

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

{
    "items": [
        {
            "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": null,
            "PaymentGroup": "Vendor Vendor CCD",
            "PaymentMethod": "Electronic",
            "CreatedBy": "username",
            "CreationDate": "2024-04-24T08:59:16+00:00",
            "LastUpdateDate": "2024-04-24T08:59:16+00:00",
            "LastUpdatedBy": "username",
            "LastUpdateLogin": "16D39B5A4AACD551E063426315AC5E84",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedTreasuryConfirmationSchedules/100105428422964",
                    "name": "fedTreasuryConfirmationSchedules",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "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"
                }
            ]
        },
        {
            "TreasuryConfirmationId": 100105428613938,
            "PaymentInstructionId": 348085,
            "PaymentProcessRequest": "PPR-002",
            "BusinessUnit": "FederalBusinessUnit",
            "RevisionNumber": 0,
            "ScheduleDate": "2024-04-24",
            "PaymentDate": "2018-07-01",
            "ConfirmationDate": null,
            "NumberOfPayments": 5,
            "RangeType": "Single",
            "FromRange": null,
            "ToRange": null,
            "Amount": 5000,
            "Status": "Not Submitted",
            "TreasuryEventId": null,
            "TreasuryAccounted": "No",
            "AgencyLocationCode": "99990055",
            "FederalPaymentTypeCode": "PAM",
            "ControlNumber": null,
            "PaymentGroup": "Vendor Vendor CCD",
            "PaymentMethod": "Electronic",
            "CreatedBy": "username",
            "CreationDate": "2024-04-24T09:02:59+00:00",
            "LastUpdateDate": "2024-04-24T09:02:59+00:00",
            "LastUpdatedBy": "username",
            "LastUpdateLogin": "16D39B5973EB825AE0635F6215AC2CBD",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedTreasuryConfirmationSchedules/100105428613938",
                    "name": "fedTreasuryConfirmationSchedules",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedTreasuryConfirmationSchedules/100105428613938",
                    "name": "fedTreasuryConfirmationSchedules",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedTreasuryConfirmationSchedules/100105428613938/child/fedTreasuryCheckRanges",
                    "name": "fedTreasuryCheckRanges",
                    "kind": "collection"
                }
            ]
        }
    ],
    "count": 2,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedTreasuryConfirmationSchedules",
            "name": "fedTreasuryConfirmationSchedules",
            "kind": "collection"
        },
        {
            "rel": "action",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedTreasuryConfirmationSchedules/action/confirm",
            "name": "confirm",
            "kind": "other"
        },
        {
            "rel": "action",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedTreasuryConfirmationSchedules/action/backOut",
            "name": "backOut",
            "kind": "other"
        }
    ]
}
Back to Top