Jump to

• Request
• Response

Get all source document lines

get

/fscmRestApi/resources/11.13.18.05/sourceDocumentLines

Request

Query Parameters

• 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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • PrimaryKey Finds a source document line with the specified primary key.
    Finder Variables
    • DocumentLineId; integer; The identifier of the source document line.
  • sourceDocLinesFinderByDocNumber Finds the source document lines that match the specified source document number.
    Finder Variables
    • BusinessUnit; string; The business unit associated with the source document.
    • Currency; string; The three-letter ISO code associated with a currency of the source document.
    • CustomerPurchaseOrderNumber; string; The customer purchase order number of the source document.
    • HeaderSourceDocumentTypeCode; string; The source document type code of the source document.
    • HeaderSourceDocumentTypeId; integer; The source document type identifier of the source document.
    • ItemNumber; string; The item or service associated with the source document line.
    • LegalEntity; string; The legal entity associated with the source document.
    • LineNumber; string; The line number of the source document line.
    • PlanEndDate; string; The end date of the performance satisfaction plan of the source document line.
    • PlanStartDate; string; The start date of the performance satisfaction plan of the source document line.
    • PricePeriodicity; string; The price periodicity of the service or subscription on the source document line.
    • SatisfactionMeasurementModel; string; The satisfaction measurement model of the source document line.
    • SourceDocumentNumber; string; The source document number of the source document line.
    • UnitOfMeasure; string; Unit of measure of the item or service associated with the source document line.
  • sourceDocLinesFinderByIdentifiers Finds a source document line that match the specified source document identifiers.
    Finder Variables
    • SourceDocumentLineUniqueIdentifierCharacterFive; string; The fifth character column of the composite key that uniquely identifies a source document line.
    • SourceDocumentLineUniqueIdentifierCharacterFour; string; The fourth character column of the composite key that uniquely identifies a source document line.
    • SourceDocumentLineUniqueIdentifierCharacterOne; string; The first character column of the composite key that uniquely identifies a source document line.
    • SourceDocumentLineUniqueIdentifierCharacterThree; string; The third character column of the composite key that uniquely identifies a source document line.
    • SourceDocumentLineUniqueIdentifierCharacterTwo; string; 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.
    • SourceDocumentTypeId; integer; The source document type of the source document line.
    • SourceSystem; string; The source system of the source document line.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• 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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • ActionCodeForAddingNewLineToExistingContract; string; Indicates if the source document line should be added to the existing performance obligation or create a new performance obligation.
  • AddToExistingContract; string; 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; The business unit associated with the source document.
  • ContractModificationDate; string; The date when the contract is modified.
  • Currency; string; The three-letter ISO code associated with a currency of the source document.
  • CustomerPurchaseOrderNumber; string; The customer purchase order number of the source document.
  • DataTransformationStatus; string; The processing status of the source document line.
  • DocumentLineId; integer; The identifier of the source document line.
  • DocumentTypeCodeOfTheParentLine; string; The source document type code of the parent line from which the source data is imported.
  • DocumentTypeIdOfTheParentLine; integer; The source document type identifier of the parent line from which the source data is imported.
  • HeaderSourceDocumentTypeCode; string; The source document type code of the source document.
  • HeaderSourceDocumentTypeId; integer; The source document type identifier of the source document.
  • ImmaterialChangeType; string; The immaterial change type of the source document line.
  • ItemNumber; string; The item or service associated with the source document line.
  • LegalEntity; string; The legal entity associated with the source document.
  • LineAmount; number; The extended line amount of the source document line.
  • LineNumber; string; The line number of the source document line.
  • ParentLineSourceSystem; string; The source system of the parent source document line.
  • ParentSourceDocumentLineUniqueIdentifierCharacterFive; string; 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; 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; 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; 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; 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; The end date of the performance satisfaction plan of the source document line.
  • PlanStartDate; string; The start date of the performance satisfaction plan of the source document line.
  • PricePeriodicity; string; 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; The satisfaction measurement model of the source document line.
  • ServiceDuration; number; Duration of the service or subscription in terms of price periodicity.
  • SourceDocumentLineUniqueIdentifierCharacterFive; string; The fifth character column of the composite key that uniquely identifies a source document line.
  • SourceDocumentLineUniqueIdentifierCharacterFour; string; The fourth character column of the composite key that uniquely identifies a source document line.
  • SourceDocumentLineUniqueIdentifierCharacterOne; string; The first character column of the composite key that uniquely identifies a source document line.
  • SourceDocumentLineUniqueIdentifierCharacterThree; string; The third character column of the composite key that uniquely identifies a source document line.
  • SourceDocumentLineUniqueIdentifierCharacterTwo; string; 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; The source document number of the source document line.
  • SourceDocumentTypeCode; string; The code representing the source document type associated with the source document line.
  • SourceDocumentTypeId; integer; The identifier of the source document type associated with the source document line.
  • SourceSystem; string; The source system of the source document line.
  • TerminationDate; string; The date when the service or subscription is terminated.
  • UnitOfMeasure; string; 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; The version number of the source document line.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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.

There's no request body for this operation.

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 : sourceDocumentLines

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/sourceDocumentLines-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object sourceDocumentLines-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/sourceDocumentLines-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 : sourceDocumentLines-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LegalEntity":{
            "maxLength":"240",
            "type":"string",
            "description":"The legal entity associated with the source document.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentSourceDocumentLineUniqueIdentifierCharacterOne":{
            "maxLength":"30",
            "type":"string",
            "description":"The first character column of the composite key that uniquely identifies the parent document line for a new line received from the source system.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceDocumentLineUniqueIdentifierCharacterFour":{
            "maxLength":"30",
            "type":"string",
            "description":"The fourth character column of the composite key that uniquely identifies a source document line.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentSourceDocumentLineUniqueIdentifierNumberFour":{
            "type":"number",
            "description":"The fourth numeric column of the composite key that uniquely identifies the parent document line for a new line received from the source system.",
            "nullable":true,
            "x-queryable":true
        },
        "HeaderSourceDocumentTypeId":{
            "type":"integer",
            "description":"The source document type identifier of the source document.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SourceDocumentLineUniqueIdentifierNumberFive":{
            "type":"number",
            "description":"The fifth numeric column of the composite key that uniquely identifies a source document line.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceDocumentLineUniqueIdentifierCharacterFive":{
            "maxLength":"30",
            "type":"string",
            "description":"The fifth character column of the composite key that uniquely identifies a source document line.",
            "nullable":true,
            "x-queryable":true
        },
        "Currency":{
            "maxLength":"15",
            "type":"string",
            "description":"The three-letter ISO code associated with a currency of the source document.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentSourceDocumentLineUniqueIdentifierNumberThree":{
            "type":"number",
            "description":"The third numeric column of the composite key that uniquely identifies the parent document line for a new line received from the source system.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceDocumentLineUniqueIdentifierNumberFour":{
            "type":"number",
            "description":"The fourth numeric column of the composite key that uniquely identifies a source document line.",
            "nullable":true,
            "x-queryable":true
        },
        "DataTransformationStatus":{
            "maxLength":"30",
            "type":"string",
            "description":"The processing status of the source document line.",
            "nullable":true,
            "x-queryable":true
        },
        "LineAmount":{
            "type":"number",
            "description":"The extended line amount of the source document line.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CustomerPurchaseOrderNumber":{
            "maxLength":"50",
            "type":"string",
            "description":"The customer purchase order number of the source document.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentLineSourceSystem":{
            "maxLength":"120",
            "type":"string",
            "description":"The source system of the parent source document line.",
            "nullable":true,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "maxLength":"200",
            "type":"string",
            "description":"Unit of measure of the item or service associated with the source document line.",
            "nullable":false,
            "x-queryable":true
        },
        "PlanEndDate":{
            "type":"string",
            "description":"The end date of the performance satisfaction plan of the source document line.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "SourceDocumentTypeId":{
            "type":"integer",
            "description":"The identifier of the source document type associated with the source document line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AddToExistingContract":{
            "maxLength":"1",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ActionCodeForAddingNewLineToExistingContract":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates if the source document line should be added to the existing performance obligation or create a new performance obligation.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentSourceDocumentLineUniqueIdentifierCharacterFive":{
            "maxLength":"30",
            "type":"string",
            "description":"The fifth character column of the composite key that uniquely identifies the parent document line for a new line received from the source system.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceDocumentTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The code representing the source document type associated with the source document line.",
            "nullable":true,
            "x-queryable":true
        },
        "ContractModificationDate":{
            "type":"string",
            "description":"The date when the contract is modified.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ImmaterialChangeType":{
            "maxLength":"30",
            "type":"string",
            "description":"The immaterial change type of the source document line.",
            "nullable":true,
            "x-queryable":true
        },
        "BusinessUnit":{
            "maxLength":"240",
            "type":"string",
            "description":"The business unit associated with the source document.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentLineId":{
            "type":"integer",
            "description":"The identifier of the source document line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ParentSourceDocumentLineUniqueIdentifierCharacterTwo":{
            "maxLength":"30",
            "type":"string",
            "description":"The second character column of the composite key that uniquely identifies the parent document line for a new line received from the source system.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentSourceDocumentLineUniqueIdentifierCharacterFour":{
            "maxLength":"30",
            "type":"string",
            "description":"The fourth character column of the composite key that uniquely identifies the parent document line for a new line received from the source system.",
            "nullable":true,
            "x-queryable":true
        },
        "SatisfactionMeasurementModel":{
            "maxLength":"30",
            "type":"string",
            "description":"The satisfaction measurement model of the source document line.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceDocumentLineUniqueIdentifierNumberThree":{
            "type":"number",
            "description":"The third numeric column of the composite key that uniquely identifies a source document line.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentSourceDocumentLineUniqueIdentifierNumberOne":{
            "type":"number",
            "description":"The first numeric column of the composite key that uniquely identifies the parent document line for a new line received from the source system.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentTypeIdOfTheParentLine":{
            "type":"integer",
            "description":"The source document type identifier of the parent line from which the source data is imported.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LineNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"The line number of the source document line.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceDocumentLineUniqueIdentifierCharacterTwo":{
            "maxLength":"30",
            "type":"string",
            "description":"The second character column of the composite key that uniquely identifies a source document line.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":"300",
            "type":"string",
            "description":"The item or service associated with the source document line.",
            "nullable":true,
            "x-queryable":true
        },
        "HeaderSourceDocumentTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The source document type code of the source document.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceDocumentLineUniqueIdentifierCharacterThree":{
            "maxLength":"30",
            "type":"string",
            "description":"The third character column of the composite key that uniquely identifies a source document line.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentSourceDocumentLineUniqueIdentifierCharacterThree":{
            "maxLength":"30",
            "type":"string",
            "description":"The third character column of the composite key that uniquely identifies the parent document line for a new line received from the source system.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceDocumentLineUniqueIdentifierNumberOne":{
            "type":"number",
            "description":"The first numeric column of the composite key that uniquely identifies a source document line.",
            "nullable":true,
            "x-queryable":true
        },
        "TerminationDate":{
            "type":"string",
            "description":"The date when the service or subscription is terminated.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "UnitSSP":{
            "type":"number",
            "description":"Unit standalone selling price of the item or service associated with the source document line.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceDocumentLineUniqueIdentifierCharacterOne":{
            "maxLength":"30",
            "type":"string",
            "description":"The first character column of the composite key that uniquely identifies a source document line.",
            "nullable":true,
            "x-queryable":true
        },
        "VersionOfSourceProductLine":{
            "type":"integer",
            "description":"The version number of the source document line.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "Quantity":{
            "type":"number",
            "description":"The quantity of the item or service on the source document line.",
            "nullable":false,
            "x-queryable":true
        },
        "PricePeriodicity":{
            "maxLength":"200",
            "type":"string",
            "description":"The price periodicity of the service or subscription on the source document line.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceDocumentNumber":{
            "maxLength":"300",
            "type":"string",
            "description":"The source document number of the source document line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ServiceDuration":{
            "type":"number",
            "description":"Duration of the service or subscription in terms of price periodicity.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentSourceDocumentLineUniqueIdentifierNumberTwo":{
            "type":"number",
            "description":"The second numeric column of the composite key that uniquely identifies the parent document line for a new line received from the source system.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceDocumentLineUniqueIdentifierNumberTwo":{
            "type":"number",
            "description":"The second numeric column of the composite key that uniquely identifies a source document line.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentTypeCodeOfTheParentLine":{
            "maxLength":"30",
            "type":"string",
            "description":"The source document type code of the parent line from which the source data is imported.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanStartDate":{
            "type":"string",
            "description":"The start date of the performance satisfaction plan of the source document line.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "SourceSystem":{
            "maxLength":"120",
            "type":"string",
            "description":"The source system of the source document line.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentSourceDocumentLineUniqueIdentifierNumberFive":{
            "type":"number",
            "description":"The fifth numeric column of the composite key that uniquely identifies the parent document line for a new line received from the source system.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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."
        }
    }
}

Back to Top