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: string
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: string
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 : inboundFiscalDocumentFlows-item-response
Type:
Show Source
object
-
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. -
AssociationCode: string
Title:
Association Code
Read Only:true
Maximum Length:30
Code that identifies fiscal flow. -
ChargeAllocationIndicator: string
Read Only:
true
Maximum Length:1
Value that indicates the charge allocation for the fiscal document. -
ChargesAllowed: string
Read Only:
true
Maximum Length:1
Value that indicates whether the fiscal document is allowed to have charges. -
ComplementaryIndicator: string
Title:
Active
Read Only:true
Maximum Length:1
Contains one of the following values : Y or N , if Y, then the flow is complementary .If N, then it's not complementary. -
ComplementaryLineType: string
Read Only:
true
Maximum Length:30
Value that indicates which types of complementary lines are allowed. -
ComplementaryTypeManualQuantityEntry: string
Read Only:
true
Maximum Length:80
Value that indicates the complementary types requiring manual entry of physical receipt quantity. -
CopyReferenceFiscalDcoumentTaxDeterminants: string
Read Only:
true
Maximum Length:1
Value that indicates whether the tax determinants are to be copied. -
CostingInterfaceIndicator: string
Read Only:
true
Maximum Length:1
Value that indicates whether the costing interface is required. -
CountryCode: string
Title:
Country Code
Read Only:true
Maximum Length:30
Code that identifies the country. -
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. -
ElectronicModel: string
Title:
Model
Read Only:true
Maximum Length:2000
Value that identifies the model of fiscal document. -
FiscalDocumentHeaderLineRelationship: string
Read Only:
true
Maximum Length:10
Value that indicates how many lines can be mapped to a fiscal document header. -
FiscalDocumentUsage: string
Title:
Model
Read Only:true
Maximum Length:30
Value that identifies the usage of issuing the fiscal document. -
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. -
FiscalProcessOptionId: integer
(int64)
Title:
Fiscal Flow ID
Read Only:true
Value that uniquely identifies a process of fiscal flow. -
FiscalReferenceOptionsId: integer
(int64)
Read Only:
true
Value that uniquely identifies the reference options. -
IssuerType: string
Title:
Operation Type
Read Only:true
Maximum Length:30
Value that identifies the type of the issuer. -
LineSourceDocumentTypeCode: string
Title:
Source Document Type
Read Only:true
Maximum Length:30
Code that identifies the possible value for the fiscal document line source document type. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ManualQuantityEntryIndicator: string
Title:
Physical Received Quantity
Read Only:true
Maximum Length:1
Value that identifies if the physical receipt quantity has to be manually entered or not. -
Name: string
Title:
Name
Read Only:true
Maximum Length:80
Name of the fiscal flow. -
OperationType: string
Title:
Operation Type
Read Only:true
Maximum Length:1
Value that identifies the operation type of the fiscal document. -
PayablesInterfaceIndicator: string
Read Only:
true
Maximum Length:1
Value that indicates whether the payables interface is required. -
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. -
ProcessOptionCode: string
Title:
Process
Read Only:true
Maximum Length:50
Code that identifies process of fiscal flow. -
ReceiverType: string
Title:
Operation Type
Read Only:true
Maximum Length:30
Value that identifies the type of the receiver. -
ReceivingInterfaceIndicator: string
Read Only:
true
Maximum Length:1
Value that indicates whether the receiving interface is required. -
ReferenceAllowedIndicator: string
Read Only:
true
Maximum Length:1
Value that indicates whether the reference document is allowed. -
ReferencedEligibleStatus: string
Read Only:
true
Maximum Length:100
Value that indicates the eligible statuses of the referenced fiscal document. -
ReferenceEligibleStatus: string
Read Only:
true
Maximum Length:100
Value that indicates the eligible statuses of the referenced fiscal document. -
ReferenceFiscalDocumentIssuerType: string
Read Only:
true
Maximum Length:100
Value that indicates whether the referenced fiscal documents belong to the same issuer or a different third party. -
ReferenceFiscalDocumentProduct: string
Read Only:
true
Maximum Length:30
Value that indicates the product owner of the referenced fiscal document. -
ReferenceProcessOptionCodes: string
Read Only:
true
Maximum Length:500
Value that indicates the codes of the referenced process options. -
ReferenceRelationship: string
Read Only:
true
Maximum Length:100
Value that indicates the relationship cardinality between the referenced and referencing fiscal documents. -
ReferenceRequired: string
Read Only:
true
Maximum Length:1
Value that indicates whether the reference is mandatory or if at least one of the references must exist. -
SeriesRequired: string
Read Only:
true
Maximum Length:30
Value that indicates whether the series is required. -
ShipFromType: string
Title:
Operation Type
Read Only:true
Maximum Length:30
Value that identifies the ship from type. -
ShipToType: string
Title:
Operation Type
Read Only:true
Maximum Length:30
Value that identifies the ship to type. -
SourceDocumentType: string
Title:
Source Document Type
Read Only:true
Maximum Length:80
Value that identifies the source document type of the fiscal document. -
SourceDocumentTypeCode: string
Title:
Source Document Type Code
Read Only:true
Maximum Length:30
Code that identifies the source document type of the fiscal document. -
Status: string
Title:
Status
Read Only:true
Maximum Length:80
Value that identifies if the fiscal flow is active or inactive -
SubSeriesRequired: string
Read Only:
true
Maximum Length:30
Value that indicates whether the sub-series is required. -
UpdateReferencePhysicalReceipt: string
Read Only:
true
Maximum Length:1
Value that indicates whether the quantity on the referenced fiscal document has been updated.
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
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : inboundFiscalDocumentFlows-fiscalOperationTypes-item-response
Type:
Show Source
object
-
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
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.
Links
- ActiveFlagVA
-
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
- finder:
- DocumentTypeVA
-
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
- finder:
- ProcessCodeVA
-
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
- finder:
- SourceDocumentTypeCodeVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_CMF_SOURCE_DOC_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: SourceDocumentTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- 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. - FiscalFlowId: