Jump to

• Request
• Response

Get all calendar types

get

/fscmRestApi/resources/11.13.18.05/payablesCalendarTypes

Request

Query Parameters

• expand: string
  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).
• fields: string
  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
• finder: string
  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:
  
  

  • PrimaryKey: Finds the calendar types with the specified primary key.
    Finder Variables:
    • calendarName; string; The unique name of the calendar.
    • calendarType; string; The unique calendar type.
• limit: integer
  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.
• links: string
  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
  
• offset: integer
  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.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  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
• q: string
  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:
  

  • calendarName; string; The name given to a calendar that is used in the Payables application.
  • calendarType; string; The type of calendar, such as General or Payment Terms.
  • createdBy; string; The user who created the record.
  • creationDate; string; The date when the record was created.
  • description; string; The information that describes the calendar.
  • fromDate; string; The effective from date of the calendar.
  • lastUpdateDate; string; The date when the record was last updated.
  • lastUpdateLogin; string; The session login associated with the user who last updated the record.
  • lastUpdatedBy; string; The user who last updated the record.
  • periodFrequency; string; The frequency of the calendar, such as monthly, weekly, or quarterly.
  • periodNameFormat; string; Specifies the format of the period name.
  • periodsPERYear; integer; The number of periods included in a period grouping on a payables calendar.
  • startDate; string; The date when a task, event, or business process begins.
  • toDate; string; The effective to date of the calendar.
• totalResults: boolean
  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

• 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.

There's no request body for this operation.

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 : payablesCalendarTypes

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/payablesCalendarTypes-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object payablesCalendarTypes-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/payablesCalendarTypes-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 : payablesCalendarTypes-item-response

Type: object

Show Source

• calendarName: string
  Title: Calendar

  Maximum Length: 15

  The name given to a calendar that is used in the Payables application.
• calendarType: string
  Title: Calendar Type

  Maximum Length: 30

  The type of calendar, such as General or Payment Terms.
• createdBy: string
  Read Only: true

  Maximum Length: 64

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

  The date when the record was created.
• description: string
  Title: Description

  Maximum Length: 240

  The information that describes the calendar.
• fromDate: string (date)
  Title: From Date

  The effective from date of the calendar.
• lastUpdateDate: string (date-time)
  Read Only: true

  The date 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 with the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• payablesCalendarPeriods: array Payables Calendar Periods
  Title: Payables Calendar Periods

  The payables calendar periods resource is used to manage details about calendar periods defined for a calendar and other important information like the number of periods, the start date, and the end date.
• periodFrequency: string
  Title: Period Frequency

  Maximum Length: 15

  The frequency of the calendar, such as monthly, weekly, or quarterly.
• periodNameFormat: string
  Title: Period Name Format

  Maximum Length: 15

  Specifies the format of the period name.
• periodsPERYear: integer
  Title: Number of Periods

  The number of periods included in a period grouping on a payables calendar.
• startDate: string (date)
  Title: Start Date

  The date when a task, event, or business process begins.
• toDate: string (date)
  Title: To Date

  The effective to date of the calendar.

{
    "type":"object",
    "properties":{
        "lastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "calendarType":{
            "title":"Calendar Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of calendar, such as General or Payment Terms.",
            "nullable":false,
            "x-queryable":true
        },
        "lastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "toDate":{
            "title":"To Date",
            "type":"string",
            "description":"The effective to date of the calendar.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "lastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The session login associated with the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "description":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"The information that describes the calendar.",
            "nullable":true,
            "x-queryable":true
        },
        "periodNameFormat":{
            "title":"Period Name Format",
            "maxLength":"15",
            "type":"string",
            "description":"Specifies the format of the period name.",
            "nullable":true,
            "x-queryable":true
        },
        "creationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "payablesCalendarPeriods":{
            "title":"Payables Calendar Periods",
            "type":"array",
            "description":"The payables calendar periods resource is used to manage details about calendar periods defined for a calendar and other important information like the number of periods, the start date, and the end date.",
            "items":{
                "$ref":"#/components/schemas/payablesCalendarTypes-payablesCalendarPeriods-item-response"
            }
        },
        "periodFrequency":{
            "title":"Period Frequency",
            "maxLength":"15",
            "type":"string",
            "description":"The frequency of the calendar, such as monthly, weekly, or quarterly.",
            "nullable":false,
            "x-queryable":true
        },
        "fromDate":{
            "title":"From Date",
            "type":"string",
            "description":"The effective from date of the calendar.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "calendarName":{
            "title":"Calendar",
            "maxLength":"15",
            "type":"string",
            "description":"The name given to a calendar that is used in the Payables application.",
            "nullable":false,
            "x-queryable":true
        },
        "periodsPERYear":{
            "title":"Number of Periods",
            "type":"integer",
            "description":"The number of periods included in a period grouping on a payables calendar.",
            "nullable":false,
            "x-queryable":true
        },
        "createdBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "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"
            }
        },
        "startDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when a task, event, or business process begins.",
            "format":"date",
            "nullable":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 : Payables Calendar Periods

Type: array

Title: Payables Calendar Periods

The payables calendar periods resource is used to manage details about calendar periods defined for a calendar and other important information like the number of periods, the start date, and the end date.

Show Source

• Array of: object payablesCalendarTypes-payablesCalendarPeriods-item-response

{
    "title":"Payables Calendar Periods",
    "type":"array",
    "description":"The payables calendar periods resource is used to manage details about calendar periods defined for a calendar and other important information like the number of periods, the start date, and the end date.",
    "items":{
        "$ref":"#/components/schemas/payablesCalendarTypes-payablesCalendarPeriods-item-response"
    }
}

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."
        }
    }
}

Nested Schema : payablesCalendarTypes-payablesCalendarPeriods-item-response

Type: object

Show Source

• createdBy: string
  Read Only: true

  Maximum Length: 64

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

  The date when the record was created.
• dueDate: string (date)
  Title: Due Date

  The date associated with a payables calendar period that indicates when an invoice payment is due. This is only applicable to payables calendars with a type of payment terms.
• endDate: string (date)
  Title: To Date

  The date when a record is unavailable for transacting.
• enteredPeriodName: string
  Title: Period

  Maximum Length: 15

  The name of a period, for example, Month.
• lastUpdateDate: string (date-time)
  Read Only: true

  The date 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 with the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• periodName: string
  Title: Period

  Maximum Length: 15

  The period used for withholding tax calculation or payment terms.
• periodYear: integer (int64)
  Title: Year

  The calendar year in which the periods occur.
• sequence: integer (int64)
  Title: Sequence

  The order of the periods within a payables calendar.
• startDate: string (date)
  Title: From Date

  The date when a record is available for transacting.

{
    "type":"object",
    "properties":{
        "lastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "endDate":{
            "title":"To Date",
            "type":"string",
            "description":"The date when a record is unavailable for transacting.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "lastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "dueDate":{
            "title":"Due Date",
            "type":"string",
            "description":"The date associated with a payables calendar period that indicates when an invoice payment is due. This is only applicable to payables calendars with a type of payment terms.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "lastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The session login associated with the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "periodName":{
            "title":"Period",
            "maxLength":"15",
            "type":"string",
            "description":"The period used for withholding tax calculation or payment terms.",
            "nullable":false,
            "x-queryable":true
        },
        "creationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "sequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The order of the periods within a payables calendar.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "periodYear":{
            "title":"Year",
            "type":"integer",
            "description":"The calendar year in which the periods occur.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "createdBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "enteredPeriodName":{
            "title":"Period",
            "maxLength":"15",
            "type":"string",
            "description":"The name of a period, for example, Month.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "startDate":{
            "title":"From Date",
            "type":"string",
            "description":"The date when a record is available for transacting.",
            "format":"date",
            "nullable":false,
            "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"
    }
}

Back to Top