Update a document sequence derivation record
patch
/fscmRestApi/resources/11.13.18.05/localizationDocumentSequenceDerivations/{DocumentSequenceDerivationId}
Request
Path Parameters
-
DocumentSequenceDerivationId(required): integer(int64)
The third segment of the document sequence number that is gapless and eight digits long. Values must not be provided for context derivation codes such as WSH_CONTEXT_VALUES and WSH_DOCUMENT_NUMBERING.
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
-
BusinessUnitName: string
Name of the selling business unit.
-
DocumentSequenceContext1: string
Maximum Length:
240
Code that identifies the ship-from organization. -
EffectiveEndDate: string
(date)
The date when the document sequence derivations record becomes ineffective. If the context derivation code is WSH_DOCUMENT_NUMBERING, it stores the date when the Electronic Fiscal Authorization Code becomes ineffective.
-
PrefixSuffixValue1: string
Maximum Length:
30
The first character of the document sequence number. If the context derivation code is WSH_DOCUMENT_NUMBERING, valid values are R and X.
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 : localizationDocumentSequenceDerivations-item-response
Type:
Show Source
object
-
BusinessUnitId: integer
(int64)
Value that uniquely identifies the selling business unit.
-
BusinessUnitName: string
Name of the selling business unit.
-
ContextDerivationCode: string
Maximum Length:
30
Indicates if the record is a configuration record or a document sequence determining record for financials and shipping products. Valid values include CONTEXT_VALUES, DOCUMENT_NUMBERING, WSH_CONTEXT_VALUES, and WSH_DOCUMENT_NUMBERING. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the document sequence derivation record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the document sequence derivation record was created. -
DocumentSequenceContext1: string
Maximum Length:
240
Code that identifies the ship-from organization. -
DocumentSequenceContext10: string
Maximum Length:
240
An undefined context attribute for a document sequence. -
DocumentSequenceContext2: string
Maximum Length:
240
Type of order source line, such as sales order or return material authorization. -
DocumentSequenceContext3: string
Maximum Length:
240
The Printed Fiscal Authorization Code that is a combination of organization and order type. -
DocumentSequenceContext4: string
Maximum Length:
240
An undefined context attribute for a document sequence. -
DocumentSequenceContext5: string
Maximum Length:
240
An attribute used to distinguish records. The value of the attribute is set to ARGENTINA SHIPMENT REMITO. -
DocumentSequenceContext6: string
Maximum Length:
240
An undefined context attribute for a document sequence. -
DocumentSequenceContext7: string
Maximum Length:
240
An undefined context attribute for a document sequence. -
DocumentSequenceContext8: string
Maximum Length:
240
An undefined context attribute for a document sequence. -
DocumentSequenceContext9: string
Maximum Length:
240
An undefined context attribute for a document sequence. -
DocumentSequenceDerivationId: integer
(int64)
The third segment of the document sequence number that is gapless and eight digits long. Values must not be provided for context derivation codes such as WSH_CONTEXT_VALUES and WSH_DOCUMENT_NUMBERING.
-
DocumentSequenceName: string
Maximum Length:
240
Name of the document sequence setup for the specified context values. -
EffectiveEndDate: string
(date)
The date when the document sequence derivations record becomes ineffective. If the context derivation code is WSH_DOCUMENT_NUMBERING, it stores the date when the Electronic Fiscal Authorization Code becomes ineffective.
-
EffectiveStartDate: string
(date)
The date when the document sequence derivations record becomes effective. If the context derivation code is WSH_DOCUMENT_NUMBERING, it stores the date when the Electronic Fiscal Authorization Code becomes effective.
-
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the document sequence derivation record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who last updated the document sequence derivation record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Session login associated with the user who last updated the document sequence derivation record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
Version number of the document sequence derivation record. -
PrefixSuffixValue1: string
Maximum Length:
30
The first character of the document sequence number. If the context derivation code is WSH_DOCUMENT_NUMBERING, valid values are R and X. -
PrefixSuffixValue2: string
Maximum Length:
30
The second segment of the document sequence number that is four digits long. If the context derivation code is WSH_DOCUMENT_NUMBERING, the valid value is the four digit branch code. -
PrefixSuffixValue3: string
Maximum Length:
30
An undefined context attribute for a document sequence. -
PrefixSuffixValue4: string
Maximum Length:
30
An undefined context attribute for a document sequence. -
PrefixSuffixValue5: string
Maximum Length:
30
An undefined context attribute for a document sequence.
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.
Examples
The following example shows how to update a document sequence derivation record by submitting a PATCH request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X PATCH -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/localizationDocumentSequenceDerivations/300100171758641
Example Request Payload
The following example shows the contents of the request body in JSON format:
{ "EffectiveEndDate": "2019-10-02" }
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "DocumentSequenceDerivationId": 300100171758641, "BusinessUnitName": "Vision India - BU02", "BusinessUnitId": 300100095963189, "DocumentSequenceContext1": "ORA_JA_IN_TAX_INVOICE", "DocumentSequenceContext2": "222", "DocumentSequenceContext3": "INV", "DocumentSequenceContext4": null, "DocumentSequenceContext5": null, "DocumentSequenceContext6": "TSAABAA9007H3ZR", "DocumentSequenceContext7": "Vision India - BU02", "DocumentSequenceContext8": null, "DocumentSequenceContext9": null, "DocumentSequenceContext10": null, "DocumentSequenceName": "JA_TS_INV", "PrefixSuffixValue1": "B2INV", "PrefixSuffixValue2": null, "PrefixSuffixValue3": null, "PrefixSuffixValue4": null, "PrefixSuffixValue5": null, "EffectiveStartDate": "2018-04-01", "EffectiveEndDate": "2019-10-02", "CreatedBy": "APP_IMPL_CONSULTANT", "CreationDate": "2018-10-15T13:50:36.189+00:00", "LastUpdatedBy": "FIN_USER1", "LastUpdateDate": "2019-09-27T06:25:11.090+00:00", "LastUpdateLogin": "915D7DF431930A7CE053820AF10A0927", "ObjectVersionNumber": 5, "ContextDerivationCode": "DOCUMENT_NUMBERING", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/localizationDocumentSequenceDerivations/300100171758641", "name": "localizationDocumentSequenceDerivations", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000578" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/localizationDocumentSequenceDerivations/300100171758641", "name": "localizationDocumentSequenceDerivations", "kind": "item" } ] }