Jump to

• Request
• Response

Update one fiscal flow

patch

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

Request

Path Parameters

• FiscalFlowId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ActiveFlag(required): boolean
  Title: Active

  Maximum Length: 1
• Description(required): string
  Title: Description

  Maximum Length: 240
• fiscalOperationTypes: array fiscalOperationTypes

{
    "required":[
        "ActiveFlag",
        "Description"
    ],
    "type":"object",
    "properties":{
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "nullable":false
        },
        "fiscalOperationTypes":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/inboundFiscalDocumentFlows-fiscalOperationTypes-item-patch-request"
            }
        }
    }
}

Nested Schema : fiscalOperationTypes

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/inboundFiscalDocumentFlows-fiscalOperationTypes-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• ActiveFlag: boolean
  Title: CFOP Active

  Maximum Length: 1

{
    "type":"object",
    "properties":{
        "ActiveFlag":{
            "title":"CFOP Active",
            "maxLength":1,
            "type":"boolean",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

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
• AssociationCode: string
  Title: Association Code

  Read Only: true

  Maximum Length: 30
• ChargeAllocationIndicator: string
  Read Only: true

  Maximum Length: 1
• ChargesAllowed: string
  Read Only: true

  Maximum Length: 1
• ComplementaryIndicator: string
  Title: Active

  Read Only: true

  Maximum Length: 1
• ComplementaryLineType: string
  Read Only: true

  Maximum Length: 30
• ComplementaryTypeManualQuantityEntry: string
  Read Only: true

  Maximum Length: 80
• CopyReferenceFiscalDcoumentTaxDeterminants: string
  Read Only: true

  Maximum Length: 1
• CostingInterfaceIndicator: string
  Read Only: true

  Maximum Length: 1
• CountryCode: string
  Title: Country Code

  Read Only: true

  Maximum Length: 30
• Description: string
  Title: Description

  Maximum Length: 240
• DocumentType: string
  Title: Document Type

  Read Only: true

  Maximum Length: 80
• DocumentTypeCode: string
  Title: Document Type Code

  Read Only: true

  Maximum Length: 30
• ElectronicModel: string
  Title: Model

  Read Only: true

  Maximum Length: 2000
• FiscalDocumentHeaderLineRelationship: string
  Read Only: true

  Maximum Length: 10
• FiscalDocumentUsage: string
  Title: Model

  Read Only: true

  Maximum Length: 30
• FiscalFlowId: integer (int64)
  Title: Fiscal Flow ID

  Read Only: true
• fiscalOperationTypes: array fiscalOperationTypes
• FiscalProcessOptionId: integer (int64)
  Title: Fiscal Flow ID

  Read Only: true
• FiscalReferenceOptionsId: integer (int64)
  Read Only: true
• IssuerType: string
  Title: Operation Type

  Read Only: true

  Maximum Length: 30
• LineSourceDocumentTypeCode: string
  Title: Source Document Type

  Read Only: true

  Maximum Length: 30
• 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
• Name: string
  Title: Name

  Read Only: true

  Maximum Length: 80
• OperationType: string
  Title: Operation Type

  Read Only: true

  Maximum Length: 1
• PayablesInterfaceIndicator: string
  Read Only: true

  Maximum Length: 1
• Process: string
  Title: Process

  Read Only: true

  Maximum Length: 80
• ProcessCode: string
  Title: Process Code

  Read Only: true

  Maximum Length: 30
• ProcessOptionCode: string
  Title: Process

  Read Only: true

  Maximum Length: 50
• ReceiverType: string
  Title: Operation Type

  Read Only: true

  Maximum Length: 30
• ReceivingInterfaceIndicator: string
  Read Only: true

  Maximum Length: 1
• ReferenceAllowedIndicator: string
  Read Only: true

  Maximum Length: 1
• ReferencedEligibleStatus: string
  Read Only: true

  Maximum Length: 100
• ReferenceEligibleStatus: string
  Read Only: true

  Maximum Length: 100
• ReferenceFiscalDocumentIssuerType: string
  Read Only: true

  Maximum Length: 100
• ReferenceFiscalDocumentProduct: string
  Read Only: true

  Maximum Length: 30
• ReferenceProcessOptionCodes: string
  Read Only: true

  Maximum Length: 500
• ReferenceRelationship: string
  Read Only: true

  Maximum Length: 100
• ReferenceRequired: string
  Read Only: true

  Maximum Length: 1
• SeriesRequired: string
  Read Only: true

  Maximum Length: 30
• ShipFromType: string
  Title: Operation Type

  Read Only: true

  Maximum Length: 30
• ShipToType: string
  Title: Operation Type

  Read Only: true

  Maximum Length: 30
• SourceDocumentType: string
  Title: Source Document Type

  Read Only: true

  Maximum Length: 80
• SourceDocumentTypeCode: string
  Title: Source Document Type Code

  Read Only: true

  Maximum Length: 30
• Status: string
  Title: Status

  Read Only: true

  Maximum Length: 80
• SubSeriesRequired: string
  Read Only: true

  Maximum Length: 30
• UpdateReferencePhysicalReceipt: string
  Read Only: true

  Maximum Length: 1

{
    "type":"object",
    "properties":{
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AssociationCode":{
            "title":"Association Code",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeAllocationIndicator":{
            "maxLength":1,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargesAllowed":{
            "maxLength":1,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ComplementaryIndicator":{
            "title":"Active",
            "maxLength":1,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ComplementaryLineType":{
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ComplementaryTypeManualQuantityEntry":{
            "maxLength":80,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CopyReferenceFiscalDcoumentTaxDeterminants":{
            "maxLength":1,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CostingInterfaceIndicator":{
            "maxLength":1,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CountryCode":{
            "title":"Country Code",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "DocumentType":{
            "title":"Document Type",
            "maxLength":80,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentTypeCode":{
            "title":"Document Type Code",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ElectronicModel":{
            "title":"Model",
            "maxLength":2000,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FiscalDocumentHeaderLineRelationship":{
            "maxLength":10,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FiscalDocumentUsage":{
            "title":"Model",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FiscalFlowId":{
            "title":"Fiscal Flow ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "FiscalProcessOptionId":{
            "title":"Fiscal Flow ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "FiscalReferenceOptionsId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "IssuerType":{
            "title":"Operation Type",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LineSourceDocumentTypeCode":{
            "title":"Source Document Type",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ManualQuantityEntryIndicator":{
            "title":"Physical Received Quantity",
            "maxLength":1,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":80,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OperationType":{
            "title":"Operation Type",
            "maxLength":1,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PayablesInterfaceIndicator":{
            "maxLength":1,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Process":{
            "title":"Process",
            "maxLength":80,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessCode":{
            "title":"Process Code",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ProcessOptionCode":{
            "title":"Process",
            "maxLength":50,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReceiverType":{
            "title":"Operation Type",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReceivingInterfaceIndicator":{
            "maxLength":1,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReferenceAllowedIndicator":{
            "maxLength":1,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReferenceEligibleStatus":{
            "maxLength":100,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReferenceFiscalDocumentIssuerType":{
            "maxLength":100,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReferenceFiscalDocumentProduct":{
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReferenceProcessOptionCodes":{
            "maxLength":500,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReferenceRelationship":{
            "maxLength":100,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReferenceRequired":{
            "maxLength":1,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReferencedEligibleStatus":{
            "maxLength":100,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SeriesRequired":{
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipFromType":{
            "title":"Operation Type",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipToType":{
            "title":"Operation Type",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceDocumentType":{
            "title":"Source Document Type",
            "maxLength":80,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceDocumentTypeCode":{
            "title":"Source Document Type Code",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":80,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SubSeriesRequired":{
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UpdateReferencePhysicalReceipt":{
            "maxLength":1,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "fiscalOperationTypes":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/inboundFiscalDocumentFlows-fiscalOperationTypes-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : fiscalOperationTypes

Type: array

Show Source

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

{
    "type":"array",
    "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
• DefaultPayment: string
  Title: Default Payment

  Read Only: true

  Maximum Length: 80
• Description: string
  Title: Description

  Read Only: true

  Maximum Length: 1996
• FiscalFlowId: integer (int64)
  Title: Fiscal Flow ID

  Read Only: true
• FiscalOperationCode: string
  Title: CFOP Code

  Read Only: true

  Maximum Length: 30
• FiscalOperationTypeId: integer (int64)
  Title: Fiscal Operation Type ID

  Read Only: true
• 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
• Status: string
  Title: Status

  Read Only: true

  Maximum Length: 80

{
    "type":"object",
    "properties":{
        "ActiveFlag":{
            "title":"CFOP Active",
            "maxLength":1,
            "type":"boolean",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DefaultPayment":{
            "title":"Default Payment",
            "maxLength":80,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":1996,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FiscalFlowId":{
            "title":"Fiscal Flow ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FiscalOperationCode":{
            "title":"CFOP Code",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FiscalOperationTypeId":{
            "title":"Fiscal Operation Type ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PaymentFlag":{
            "title":"Default Payment Option",
            "maxLength":1,
            "type":"boolean",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":80,
            "type":"string",
            "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"
            }
        }
    }
}

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

SourceDocumentTypeCodeVA

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

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

fiscalOperationTypes

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

Parameters:

• FiscalFlowId: $request.path.FiscalFlowId

Back to Top