Update one fiscal flow
patch
/fscmRestApi/resources/11.13.18.05/inboundFiscalDocumentFlows/{FiscalFlowId}
Request
Path Parameters
-
FiscalFlowId(required): integer(int64)
Value that uniquely identifies a fiscal flow.
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
ActiveFlag(required): 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(required): string
Title:
Description
Maximum Length:240
Description of the 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.
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 : schema
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.
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.
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. -
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
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:
- 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: