Get one calendar type
get
/fscmRestApi/resources/11.13.18.05/payablesCalendarTypes/{payablesCalendarTypesUniqID}
Request
Path Parameters
-
payablesCalendarTypesUniqID(required): string
This is the hash key of the attributes which make up the composite key--- calendarName and calendarType ---for the Payables Calendar Types resource and used to uniquely identify an instance of Payables Calendar Types. The client should not generate the hash key value. Instead, the client should query on the Payables Calendar Types collection resource with a filter on the primary key values in order to navigate to a specific instance of Payables Calendar Types.
For example: payablesCalendarTypes?q=calendarName=<value1>;calendarType=<value2>
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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 TopResponse
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.
Root Schema : payablesCalendarTypes-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
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
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : payablesCalendarTypes-payablesCalendarPeriods-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- payablesCalendarPeriods
-
Parameters:
- payablesCalendarTypesUniqID:
$request.path.payablesCalendarTypesUniqID
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. - payablesCalendarTypesUniqID: