Get all documentation and accounting rules
get
/fscmRestApi/resources/11.13.18.05/financialOrchestrationDocumentationAndAccountingRules
Request
Query Parameters
-
effectiveDate: string
This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
-
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 a documentation and accounting rule based on the primary key.
Finder Variables- EffectiveEndDate; string; Unique identifier based on the effective end date of the documentation and accounting rule set.
- EffectiveStartDate; string; Unique identifier based on the effective start date of the documentation and accounting rule set.
- TaRuleSetId; integer; Unique rule set identifier of the documentation and accounting rule.
- PrimaryKey Finds a documentation and accounting rule based on the primary key.
-
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:- ConversionType; string; Value that identifies the conversion type for the documentation and accounting rule.
- CurrencyOption; string; Value that identifies the currency option code for the documentation and accounting rule.
- Description; string; Value that identifies the description of the documentation and accounting rule.
- EffectiveEndDate; string; Value that identifies the effective end date of the documentation and accounting rule.
- EffectiveStartDate; string; Value that identifies the effective start date of the documentation and accounting rule.
- ForwardFlowOwnershipChangeEvent; string; Value that identifies the forward flow ownership change event for internal transfers.
- InterCompanyInvoice; string; Value that indicates the intercompany invoice is selected by the user in the documentation and accounting rule.
- Operation; string; Indicates that the user has performed the selected action as part of the transaction.
- ReturnFlowOwnershipChangeEvent; string; Value that identifies the return flow ownership change event for internal transfers.
- StandardCurrency; string; Value that identifies the standard currency selected by the user in the documentation and accounting rule.
- TaRuleSetId; integer; Value that uniquely identifies the rule set of the documentation and accounting rule.
- TaRuleSetName; string; Indicates the rule set name of the documentation and accounting rule.
- TrackProfitsFlag; boolean; Value that indicates the track profits value is selected by the user in the documentation and accounting rule.
- TradeDistributions; string; Value that identifies trade distributions is selected by the user in the documentation and accounting rule.
-
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
-
Effective-Of:
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
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 : financialOrchestrationDocumentationAndAccountingRules
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : financialOrchestrationDocumentationAndAccountingRules-item-response
Type:
Show Source
object
-
ConversionType: string
Title:
Conversion Type
Maximum Length:30
Value that identifies the conversion type for the documentation and accounting rule. -
CurrencyOption: string
Title:
Currency Option
Maximum Length:30
Value that identifies the currency option code for the documentation and accounting rule. -
Description: string
Title:
Description
Maximum Length:240
Value that identifies the description of the documentation and accounting rule. -
EffectiveEndDate: string
(date)
Title:
Effective End Date
Value that identifies the effective end date of the documentation and accounting rule. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Value that identifies the effective start date of the documentation and accounting rule. -
financialOrchestrationDocumentationAndAccountingRuleSets: array
Documentation and Accounting Rule Sets
Title:
Documentation and Accounting Rule Sets
The details of the documentation and accounting rule set. -
ForwardFlowOwnershipChangeEvent: string
Maximum Length:
255
Value that identifies the forward flow ownership change event for internal transfers. -
InterCompanyInvoice: string
Maximum Length:
255
Value that indicates the intercompany invoice is selected by the user in the documentation and accounting rule. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Operation: string
Maximum Length:
255
Indicates that the user has performed the selected action as part of the transaction. -
ReturnFlowOwnershipChangeEvent: string
Maximum Length:
255
Value that identifies the return flow ownership change event for internal transfers. -
StandardCurrency: string
Maximum Length:
15
Value that identifies the standard currency selected by the user in the documentation and accounting rule. -
TaRuleSetId: integer
(int64)
Value that uniquely identifies the rule set of the documentation and accounting rule.
-
TaRuleSetName: string
Title:
Name
Maximum Length:100
Indicates the rule set name of the documentation and accounting rule. -
TrackProfitsFlag: boolean
Title:
Track profits in inventory
Maximum Length:1
Default Value:false
Value that indicates the track profits value is selected by the user in the documentation and accounting rule. -
TradeDistributions: string
Maximum Length:
255
Value that identifies trade distributions is selected by the user in the documentation and accounting rule.
Nested Schema : Documentation and Accounting Rule Sets
Type:
array
Title:
Documentation and Accounting Rule Sets
The details of the documentation and accounting rule set.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : financialOrchestrationDocumentationAndAccountingRules-financialOrchestrationDocumentationAndAccountingRuleSets-item-response
Type:
Show Source
object
-
EffectiveEndDate: string
(date)
Value that identifies the effective end date of the documentation and accounting rule set.
-
EffectiveStartDate: string
(date)
Value that identifies the effective start date of the documentation and accounting rule set.
-
EnabledFlag: boolean
Maximum Length:
1
Default Value:false
Value that identifies the tasks enabled for the documentation and accounting rule set. -
FlowType: string
Maximum Length:
30
Value that identifies the flow type in the documentation and accounting rule set. -
ImtEventDefId: integer
(int64)
Title:
Internal Transfer
Value that uniquely identifies the internal transfer event definition. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Value that uniquely identifies the object version number.
-
Operation: string
Maximum Length:
255
Indicates that the user has performed the selected action as part of the transaction. -
OwnershipChangeFlag: boolean
Maximum Length:
1
Default Value:false
Value that identifies the ownership change value in the documentation and accounting rule set. -
ProcurementEventDefId: integer
(int64)
Title:
Procurement
Value that uniquely identifies the procurement event definition. -
ServiceSalesEventDefId: integer
(int64)
Value that uniquely identifies the service sales event definition.
-
ShipmentEventDefId: integer
(int64)
Title:
Shipment
Value that uniquely identifies the shipment event definition. -
TaDocumentId: integer
(int64)
Value that uniquely identifies the document identifier of the documentation and accounting rule set.
-
TaRuleSetId: integer
(int64)
Value that uniquely identifies the rule set identifier of the documentation and accounting rule set.
-
TaskSequence: integer
(int32)
Value that identifies the task sequence in the documentation and accounting rule set.
-
TaskType: string
Maximum Length:
100
Value that identifies the task type in the documentation and accounting rule set. -
TransactionType: string
Maximum Length:
30
Value that identifies the transaction type in the documentation and accounting rule set.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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.