Jump to

• Request
• Response

Get one fiscal flow

get

/fscmRestApi/resources/11.13.18.05/inboundFiscalDocumentFlows/{FiscalFlowId}

Request

Path Parameters

• FiscalFlowId(required): integer(int64)
  Value that uniquely identifies a fiscal flow.

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 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 : inboundFiscalDocumentFlows-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Contains one of the following values: Y or N. If Y, then the fiscal flow is active. If N, then it's inactive.
• Description: string
  Title: Description

  Maximum Length: 240

  Description of the fiscal flow.
• DocumentType: string
  Title: Document Type

  Read Only: true

  Maximum Length: 80

  Value that identifies the document type of a fiscal flow.
• DocumentTypeCode: string
  Title: Document Type Code

  Read Only: true

  Maximum Length: 30

  Code that uniquely identifies the document type of a fiscal flow.
• FiscalFlowId: integer (int64)
  Title: Fiscal Flow ID

  Read Only: true

  Value that uniquely identifies a fiscal flow.
• fiscalOperationTypes: array Fiscal Operation Types
  Title: Fiscal Operation Types

  An operation type that gets the Brazilian operations fiscal codes (CFOP) that are available for a fiscal flow. You can set it as active or inactive.
• links: array Links
  Title: Links

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

  Read Only: true

  Maximum Length: 80

  Name of the fiscal flow.
• Process: string
  Title: Process

  Read Only: true

  Maximum Length: 80

  Value that identifies the process of a fiscal flow.
• ProcessCode: string
  Title: Process Code

  Read Only: true

  Maximum Length: 30

  Code that uniquely identifies the process of a fiscal flow.
• Status: string
  Title: Status

  Read Only: true

  Maximum Length: 80

  Value that identifies if the fiscal flow is active or inactive

{
    "type":"object",
    "properties":{
        "Status":{
            "title":"Status",
            "maxLength":"80",
            "type":"string",
            "description":"Value that identifies if the fiscal flow is active or inactive",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "fiscalOperationTypes":{
            "title":"Fiscal Operation Types",
            "type":"array",
            "description":"An operation type that gets the Brazilian operations fiscal codes (CFOP) that are available for a fiscal flow. You can set it as active or inactive.",
            "items":{
                "$ref":"#/components/schemas/inboundFiscalDocumentFlows-fiscalOperationTypes-item-response"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the fiscal flow.",
            "nullable":false,
            "x-queryable":true
        },
        "FiscalFlowId":{
            "title":"Fiscal Flow ID",
            "type":"integer",
            "description":"Value that uniquely identifies a fiscal flow.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DocumentTypeCode":{
            "title":"Document Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code that uniquely identifies the document type of a fiscal flow.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ProcessCode":{
            "title":"Process Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code that uniquely identifies the process of a fiscal flow.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DocumentType":{
            "title":"Document Type",
            "maxLength":"80",
            "type":"string",
            "description":"Value that identifies the document type of a fiscal flow.",
            "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"
            }
        },
        "Process":{
            "title":"Process",
            "maxLength":"80",
            "type":"string",
            "description":"Value that identifies the process of a fiscal flow.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: Y or N. If Y, then the fiscal flow is active. If N, then it's inactive.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the fiscal flow.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Fiscal Operation Types

Type: array

Title: Fiscal Operation Types

An operation type that gets the Brazilian operations fiscal codes (CFOP) that are available for a fiscal flow. You can set it as active or inactive.

Show Source

• Array of: object inboundFiscalDocumentFlows-fiscalOperationTypes-item-response

{
    "title":"Fiscal Operation Types",
    "type":"array",
    "description":"An operation type that gets the Brazilian operations fiscal codes (CFOP) that are available for a fiscal flow. You can set it as active or inactive.",
    "items":{
        "$ref":"#/components/schemas/inboundFiscalDocumentFlows-fiscalOperationTypes-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 : inboundFiscalDocumentFlows-fiscalOperationTypes-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Title: CFOP Active

  Maximum Length: 1

  Contains one of the following values: Y or N. If Y, then the Brazilian operations fiscal code (CFOP) is active. If N, then it's inactive.
• DefaultPayment: string
  Title: Default Payment

  Read Only: true

  Maximum Length: 80

  Value that identifies if the Brazilian operations fiscal code (CFOP) is enabled for creating a payables invoice or not
• Description: string
  Title: Description

  Read Only: true

  Maximum Length: 1996

  Description of the fiscal operation code.
• FiscalFlowId: integer (int64)
  Title: Fiscal Flow ID

  Read Only: true

  Value that uniquely identifies a fiscal flow.
• FiscalOperationCode: string
  Title: CFOP Code

  Read Only: true

  Maximum Length: 30

  Value that identifies the Brazilian operations fiscal code (CFOP).
• FiscalOperationTypeId: integer (int64)
  Title: Fiscal Operation Type ID

  Read Only: true

  Value that uniquely identifies a fiscal operation code.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PaymentFlag: boolean
  Title: Default Payment Option

  Read Only: true

  Maximum Length: 1

  Contains one of the following values: Y or N. If Y, then the document with the Brazilian operations fiscal code (CFOP) is enabled for creating a payables invoice. If N, then it isn't. You can't update the value.
• Status: string
  Title: Status

  Read Only: true

  Maximum Length: 80

  Value that identifies if the Brazilian operations fiscal code (CFOP) is active or inactive

{
    "type":"object",
    "properties":{
        "PaymentFlag":{
            "title":"Default Payment Option",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: Y or N. If Y, then the document with the Brazilian operations fiscal code (CFOP) is enabled for creating a payables invoice. If N, then it isn't. You can't update the value.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":"80",
            "type":"string",
            "description":"Value that identifies if the Brazilian operations fiscal code (CFOP) is active or inactive",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FiscalOperationTypeId":{
            "title":"Fiscal Operation Type ID",
            "type":"integer",
            "description":"Value that uniquely identifies a fiscal operation code.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DefaultPayment":{
            "title":"Default Payment",
            "maxLength":"80",
            "type":"string",
            "description":"Value that identifies if the Brazilian operations fiscal code (CFOP) is enabled for creating a payables invoice or not",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"1996",
            "type":"string",
            "description":"Description of the fiscal operation code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FiscalFlowId":{
            "title":"Fiscal Flow ID",
            "type":"integer",
            "description":"Value that uniquely identifies a fiscal flow.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FiscalOperationCode":{
            "title":"CFOP Code",
            "maxLength":"30",
            "type":"string",
            "description":"Value that identifies the Brazilian operations fiscal code (CFOP).",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"CFOP Active",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: Y or N. If Y, then the Brazilian operations fiscal code (CFOP) is active. If N, then it's inactive.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "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."
        }
    }
}

Links

ActiveFlagVA

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_CMF_ACT_STATUS

The following properties are defined on the LOV link relation:

• Source Attribute: ActiveFlag; Target Attribute: LookupCode
• Display Attribute: Meaning

DocumentTypeVA

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_CMF_DOC_TYPE

The following properties are defined on the LOV link relation:

• Source Attribute: DocumentTypeCode; Target Attribute: LookupCode
• Display Attribute: Meaning

ProcessCodeVA

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_CMF_DOC_PROCESS

The following properties are defined on the LOV link relation:

• Source Attribute: ProcessCode; Target Attribute: LookupCode
• Display Attribute: Meaning

fiscalOperationTypes

Operation: /fscmRestApi/resources/11.13.18.05/inboundFiscalDocumentFlows/{FiscalFlowId}/child/fiscalOperationTypes

Parameters:

• FiscalFlowId: $request.path.FiscalFlowId

An operation type that gets the Brazilian operations fiscal codes (CFOP) that are available for a fiscal flow. You can set it as active or inactive.

Back to Top