Jump to

• Request
• Response

Get all documentation and accounting rules

get

/fscmRestApi/resources/11.13.18.05/financialOrchestrationDocumentationAndAccountingRules

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 unique identifier of the documentation and accounting rule.
    Finder Variables
    • EffectiveEndDate; string; Documentation and accounting rules that are effective based on the effective end date.
    • EffectiveStartDate; string; Documentation and accounting rules that are effective based on the effective start date.
    • TaRuleSetId; integer; Documentation and accounting rule based on the rule set identifier.
  • findByEffectiveAsOfDate Finds all the documentation and accounting rule that's effective based on the AsofDate.
    Finder Variables
    • bindSysEffectiveDate; string; Documentation and accounting rule that's effective based on the AsofDate.
• 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 code for the documentation and accounting rule.
  • CurrencyOption; string; Value that identifies the currency option code for the documentation and accounting rule.
  • CurrencyOptionMeaning; string; Value that identifies the currency option name selected by the user 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.
  • EffectiveEndDateDisplay; string; Indicates the display value of 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.
  • 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 are selected by the user in the documentation and accounting rule.
  • UserConversionType; string; Value that identifies the conversion type name is selected by the user for 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

• 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 : financialOrchestrationDocumentationAndAccountingRules

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/financialOrchestrationDocumentationAndAccountingRules-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"InventoryManagement",
        "usage":"BusinessObject",
        "group":"SCM"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object financialOrchestrationDocumentationAndAccountingRules-item-response

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

Type: object

Show Source

• ConversionType: string
  Title: Conversion Type

  Maximum Length: 30

  Value that identifies the conversion type code 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.
• CurrencyOptionMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Value that identifies the currency option name selected by the user 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.
• EffectiveEndDateDisplay: string (date)
  Indicates the display value of 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 Set
  Title: Documentation and Accounting Rule Set

  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.
• 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 are selected by the user in the documentation and accounting rule.
• UserConversionType: string
  Title: Conversion Rate Type

  Read Only: true

  Maximum Length: 30

  Value that identifies the conversion type name is selected by the user for the documentation and accounting rule .

{
    "type":"object",
    "properties":{
        "StandardCurrency":{
            "maxLength":"15",
            "type":"string",
            "description":"Value that identifies the standard currency selected by the user in the documentation and accounting rule.",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"Value that identifies the description of the documentation and accounting rule.",
            "nullable":true,
            "x-queryable":true
        },
        "EffectiveEndDate":{
            "title":"Effective End Date",
            "type":"string",
            "description":"Value that identifies the effective end date of the documentation and accounting rule.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "financialOrchestrationDocumentationAndAccountingRuleSets":{
            "title":"Documentation and Accounting Rule Set",
            "type":"array",
            "description":"The details of the documentation and accounting rule set.",
            "items":{
                "$ref":"#/components/schemas/financialOrchestrationDocumentationAndAccountingRules-financialOrchestrationDocumentationAndAccountingRuleSets-item-response"
            }
        },
        "ReturnFlowOwnershipChangeEvent":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that identifies the return flow ownership change event for internal transfers.",
            "nullable":true,
            "x-queryable":true
        },
        "InterCompanyInvoice":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that indicates the intercompany invoice is selected by the user in the documentation and accounting rule.",
            "nullable":true,
            "x-queryable":true
        },
        "EffectiveEndDateDisplay":{
            "type":"string",
            "description":"Indicates the display value of the effective end date of the documentation and accounting rule.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ForwardFlowOwnershipChangeEvent":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that identifies the forward flow ownership change event for internal transfers.",
            "nullable":true,
            "x-queryable":true
        },
        "ConversionType":{
            "title":"Conversion Type",
            "maxLength":"30",
            "type":"string",
            "description":"Value that identifies the conversion type code for the documentation and accounting rule.",
            "nullable":true,
            "x-queryable":true
        },
        "TradeDistributions":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that identifies trade distributions are selected by the user in the documentation and accounting rule.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyOptionMeaning":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Value that identifies the currency option name selected by the user for the documentation and accounting rule.",
            "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"
            }
        },
        "TaRuleSetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the rule set of the documentation and accounting rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "title":"Effective Start Date",
            "type":"string",
            "description":"Value that identifies the effective start date of the documentation and accounting rule.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "TrackProfitsFlag":{
            "title":"Track profits in inventory",
            "maxLength":"1",
            "type":"boolean",
            "description":"Value that indicates the track profits value is selected by the user in the documentation and accounting rule.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "CurrencyOption":{
            "title":"Currency Option",
            "maxLength":"30",
            "type":"string",
            "description":"Value that identifies the currency option code for the documentation and accounting rule.",
            "nullable":false,
            "x-queryable":true
        },
        "UserConversionType":{
            "title":"Conversion Rate Type",
            "maxLength":"30",
            "type":"string",
            "description":"Value that identifies the conversion type name is selected by the user for the documentation and accounting rule .",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TaRuleSetName":{
            "title":"Name",
            "maxLength":"100",
            "type":"string",
            "description":"Indicates the rule set name of the documentation and accounting rule.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Documentation and Accounting Rule Set

Type: array

Title: Documentation and Accounting Rule Set

The details of the documentation and accounting rule set.

Show Source

• Array of: object financialOrchestrationDocumentationAndAccountingRules-financialOrchestrationDocumentationAndAccountingRuleSets-item-response

{
    "title":"Documentation and Accounting Rule Set",
    "type":"array",
    "description":"The details of the documentation and accounting rule set.",
    "items":{
        "$ref":"#/components/schemas/financialOrchestrationDocumentationAndAccountingRules-financialOrchestrationDocumentationAndAccountingRuleSets-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 : financialOrchestrationDocumentationAndAccountingRules-financialOrchestrationDocumentationAndAccountingRuleSets-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "TransactionType":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that identifies the transaction type in the documentation and accounting rule set.",
            "nullable":false,
            "x-queryable":true
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"Value that identifies the effective end date of the documentation and accounting rule set.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "OwnershipChangeFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Value that identifies the ownership change value in the documentation and accounting rule set.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "ImtEventDefId":{
            "title":"Internal Transfer",
            "type":"integer",
            "description":"Value that uniquely identifies the internal transfer event definition.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ShipmentEventDefId":{
            "title":"Shipment",
            "type":"integer",
            "description":"Value that uniquely identifies the shipment event definition.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TaDocumentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the document identifier of the documentation and accounting rule set.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "TaskSequence":{
            "type":"integer",
            "description":"Value that identifies the task sequence in the documentation and accounting rule set.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"5"
            },
            "x-queryable":true
        },
        "ProcurementEventDefId":{
            "title":"Procurement",
            "type":"integer",
            "description":"Value that uniquely identifies the procurement event definition.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TaskType":{
            "maxLength":"100",
            "type":"string",
            "description":"Value that identifies the task type in the documentation and accounting rule set.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FlowType":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that identifies the flow type in the documentation and accounting rule set.",
            "nullable":false,
            "x-queryable":true
        },
        "TaRuleSetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the rule set identifier of the documentation and accounting rule set.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EnabledFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Value that identifies the tasks enabled for the documentation and accounting rule set.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"Value that identifies the effective start date of the documentation and accounting rule set.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "ServiceSalesEventDefId":{
            "type":"integer",
            "description":"Value that uniquely identifies the service sales event definition.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "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."
        }
    }
}

Back to Top