Update a source document line
patch
/fscmRestApi/resources/11.13.18.05/sourceDocumentLines/{DocumentLineId}
Request
Path Parameters
-
DocumentLineId(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:
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
-
ActionCodeForAddingNewLineToExistingContract: string
Maximum Length:
30
Indicates if the source document line should be added to the existing performance obligation or create a new performance obligation. -
AddToExistingContract: string
Maximum Length:
1
Indicates if the source document line can be added to an existing customer contract after the contract is frozen. Valid values are Y and N. -
ContractModificationDate: string
(date)
The date when the contract is modified.
-
DataTransformationStatus: string
Maximum Length:
30
The processing status of the source document line. -
DocumentTypeCodeOfTheParentLine: string
Maximum Length:
30
The source document type code of the parent line from which the source data is imported. -
DocumentTypeIdOfTheParentLine: integer
(int64)
The source document type identifier of the parent line from which the source data is imported.
-
ImmaterialChangeType: string
Maximum Length:
30
The immaterial change type of the source document line. -
ParentLineSourceSystem: string
Maximum Length:
120
The source system of the parent source document line. -
ParentSourceDocumentLineUniqueIdentifierCharacterFive: string
Maximum Length:
30
The fifth character column of the composite key that uniquely identifies the parent document line for a new line received from the source system. -
ParentSourceDocumentLineUniqueIdentifierCharacterFour: string
Maximum Length:
30
The fourth character column of the composite key that uniquely identifies the parent document line for a new line received from the source system. -
ParentSourceDocumentLineUniqueIdentifierCharacterOne: string
Maximum Length:
30
The first character column of the composite key that uniquely identifies the parent document line for a new line received from the source system. -
ParentSourceDocumentLineUniqueIdentifierCharacterThree: string
Maximum Length:
30
The third character column of the composite key that uniquely identifies the parent document line for a new line received from the source system. -
ParentSourceDocumentLineUniqueIdentifierCharacterTwo: string
Maximum Length:
30
The second character column of the composite key that uniquely identifies the parent document line for a new line received from the source system. -
ParentSourceDocumentLineUniqueIdentifierNumberFive: number
The fifth numeric column of the composite key that uniquely identifies the parent document line for a new line received from the source system.
-
ParentSourceDocumentLineUniqueIdentifierNumberFour: number
The fourth numeric column of the composite key that uniquely identifies the parent document line for a new line received from the source system.
-
ParentSourceDocumentLineUniqueIdentifierNumberOne: number
The first numeric column of the composite key that uniquely identifies the parent document line for a new line received from the source system.
-
ParentSourceDocumentLineUniqueIdentifierNumberThree: number
The third numeric column of the composite key that uniquely identifies the parent document line for a new line received from the source system.
-
ParentSourceDocumentLineUniqueIdentifierNumberTwo: number
The second numeric column of the composite key that uniquely identifies the parent document line for a new line received from the source system.
-
TerminationDate: string
(date)
The date when the service or subscription is terminated.
-
UnitSSP: number
Unit standalone selling price of the item or service associated with the source document line.
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 : sourceDocumentLines-item-response
Type:
Show Source
object
-
ActionCodeForAddingNewLineToExistingContract: string
Maximum Length:
30
Indicates if the source document line should be added to the existing performance obligation or create a new performance obligation. -
AddToExistingContract: string
Maximum Length:
1
Indicates if the source document line can be added to an existing customer contract after the contract is frozen. Valid values are Y and N. -
BusinessUnit: string
Read Only:
true
Maximum Length:240
The business unit associated with the source document. -
ContractModificationDate: string
(date)
The date when the contract is modified.
-
Currency: string
Read Only:
true
Maximum Length:15
The three-letter ISO code associated with a currency of the source document. -
CustomerPurchaseOrderNumber: string
Read Only:
true
Maximum Length:50
The customer purchase order number of the source document. -
DataTransformationStatus: string
Maximum Length:
30
The processing status of the source document line. -
DocumentLineId: integer
(int64)
The identifier of the source document line.
-
DocumentTypeCodeOfTheParentLine: string
Maximum Length:
30
The source document type code of the parent line from which the source data is imported. -
DocumentTypeIdOfTheParentLine: integer
(int64)
The source document type identifier of the parent line from which the source data is imported.
-
HeaderSourceDocumentTypeCode: string
Read Only:
true
Maximum Length:30
The source document type code of the source document. -
HeaderSourceDocumentTypeId: integer
(int64)
Read Only:
true
The source document type identifier of the source document. -
ImmaterialChangeType: string
Maximum Length:
30
The immaterial change type of the source document line. -
ItemNumber: string
Maximum Length:
300
The item or service associated with the source document line. -
LegalEntity: string
Read Only:
true
Maximum Length:240
The legal entity associated with the source document. -
LineAmount: number
The extended line amount of the source document line.
-
LineNumber: string
Maximum Length:
30
The line number of the source document line. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ParentLineSourceSystem: string
Maximum Length:
120
The source system of the parent source document line. -
ParentSourceDocumentLineUniqueIdentifierCharacterFive: string
Maximum Length:
30
The fifth character column of the composite key that uniquely identifies the parent document line for a new line received from the source system. -
ParentSourceDocumentLineUniqueIdentifierCharacterFour: string
Maximum Length:
30
The fourth character column of the composite key that uniquely identifies the parent document line for a new line received from the source system. -
ParentSourceDocumentLineUniqueIdentifierCharacterOne: string
Maximum Length:
30
The first character column of the composite key that uniquely identifies the parent document line for a new line received from the source system. -
ParentSourceDocumentLineUniqueIdentifierCharacterThree: string
Maximum Length:
30
The third character column of the composite key that uniquely identifies the parent document line for a new line received from the source system. -
ParentSourceDocumentLineUniqueIdentifierCharacterTwo: string
Maximum Length:
30
The second character column of the composite key that uniquely identifies the parent document line for a new line received from the source system. -
ParentSourceDocumentLineUniqueIdentifierNumberFive: number
The fifth numeric column of the composite key that uniquely identifies the parent document line for a new line received from the source system.
-
ParentSourceDocumentLineUniqueIdentifierNumberFour: number
The fourth numeric column of the composite key that uniquely identifies the parent document line for a new line received from the source system.
-
ParentSourceDocumentLineUniqueIdentifierNumberOne: number
The first numeric column of the composite key that uniquely identifies the parent document line for a new line received from the source system.
-
ParentSourceDocumentLineUniqueIdentifierNumberThree: number
The third numeric column of the composite key that uniquely identifies the parent document line for a new line received from the source system.
-
ParentSourceDocumentLineUniqueIdentifierNumberTwo: number
The second numeric column of the composite key that uniquely identifies the parent document line for a new line received from the source system.
-
PlanEndDate: string
(date)
The end date of the performance satisfaction plan of the source document line.
-
PlanStartDate: string
(date)
The start date of the performance satisfaction plan of the source document line.
-
PricePeriodicity: string
Maximum Length:
200
The price periodicity of the service or subscription on the source document line. -
Quantity: number
The quantity of the item or service on the source document line.
-
SatisfactionMeasurementModel: string
Maximum Length:
30
The satisfaction measurement model of the source document line. -
ServiceDuration: number
Duration of the service or subscription in terms of price periodicity.
-
SourceDocumentLineUniqueIdentifierCharacterFive: string
Maximum Length:
30
The fifth character column of the composite key that uniquely identifies a source document line. -
SourceDocumentLineUniqueIdentifierCharacterFour: string
Maximum Length:
30
The fourth character column of the composite key that uniquely identifies a source document line. -
SourceDocumentLineUniqueIdentifierCharacterOne: string
Maximum Length:
30
The first character column of the composite key that uniquely identifies a source document line. -
SourceDocumentLineUniqueIdentifierCharacterThree: string
Maximum Length:
30
The third character column of the composite key that uniquely identifies a source document line. -
SourceDocumentLineUniqueIdentifierCharacterTwo: string
Maximum Length:
30
The second character column of the composite key that uniquely identifies a source document line. -
SourceDocumentLineUniqueIdentifierNumberFive: number
The fifth numeric column of the composite key that uniquely identifies a source document line.
-
SourceDocumentLineUniqueIdentifierNumberFour: number
The fourth numeric column of the composite key that uniquely identifies a source document line.
-
SourceDocumentLineUniqueIdentifierNumberOne: number
The first numeric column of the composite key that uniquely identifies a source document line.
-
SourceDocumentLineUniqueIdentifierNumberThree: number
The third numeric column of the composite key that uniquely identifies a source document line.
-
SourceDocumentLineUniqueIdentifierNumberTwo: number
The second numeric column of the composite key that uniquely identifies a source document line.
-
SourceDocumentNumber: string
Read Only:
true
Maximum Length:300
The source document number of the source document line. -
SourceDocumentTypeCode: string
Maximum Length:
30
The code representing the source document type associated with the source document line. -
SourceDocumentTypeId: integer
(int64)
The identifier of the source document type associated with the source document line.
-
SourceSystem: string
Maximum Length:
120
The source system of the source document line. -
TerminationDate: string
(date)
The date when the service or subscription is terminated.
-
UnitOfMeasure: string
Maximum Length:
200
Unit of measure of the item or service associated with the source document line. -
UnitSSP: number
Unit standalone selling price of the item or service associated with the source document line.
-
VersionOfSourceProductLine: integer
(int32)
The version number of the source document line.
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.