Get one invoice line
get
/fscmRestApi/resources/11.13.18.05/invoiceLinesForLandedCosts/{invoiceLinesForLandedCostsUniqID}
Request
Path Parameters
-
invoiceLinesForLandedCostsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- InvoiceId and InvoiceLineNumber ---for the Invoice Lines for Landed Costs resource and used to uniquely identify an instance of Invoice Lines for Landed Costs. The client should not generate the hash key value. Instead, the client should query on the Invoice Lines for Landed Costs collection resource with a filter on the primary key values in order to navigate to a specific instance of Invoice Lines for Landed Costs.
For example: invoiceLinesForLandedCosts?q=InvoiceId=<value1>;InvoiceLineNumber=<value2>
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.
There's no request body for this operation.
Back to TopResponse
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 : invoiceLinesForLandedCosts-item-response
Type:
Show Source
object-
AssociationMode: string
Read Only:
trueMaximum Length:255Value that identifies the mode of invoice association. -
AssociationStatus: string
Title:
MeaningRead Only:trueMaximum Length:80Identifies the status of the invoice association with the charge line. -
AssociationStatusCode: string
Read Only:
trueMaximum Length:3Abbreviation that uniquely identifies the status of the invoice association with the charge line. Valid values include Needs Review, Deleted, Rejected, and Associated. -
chargeAssociations: array
Linked Trade Operation Charge Lines
Title:
Linked Trade Operation Charge LinesTrade operation charges linked to the landed cost invoice line. -
ChargeId: integer
(int64)
Read Only:
trueUnique identifier for the charge in the invoice line. -
ChargeName: string
Read Only:
trueMaximum Length:80Name of the charge given on the invoice line. -
CMLAssociationRequestId: number
Read Only:
trueUnique identifier for the run control process of the association. -
CurrencyCode: string
Read Only:
trueMaximum Length:15Abbreviation that identifies the invoice currency. -
FunctionalCurrencyCode: string
Read Only:
trueMaximum Length:15Abbreviation that identifies the functional currency. -
FunctionalInvoiceAmount: number
Read Only:
trueAmount on the invoice line in the functional currency of the invoice. -
FunctionalTaxAmount: number
Read Only:
trueNonrecoverable tax on the invoice line in the invoice functional currency. -
FunctionalTotal: number
Read Only:
trueTotal amount on the invoice line in the functional currency of the invoice. -
InvoiceAmount: number
Read Only:
trueAmount on the invoice line. -
InvoiceCreationDate: string
(date-time)
Read Only:
trueDate when the supplier raised the invoice. -
InvoiceId: integer
(int64)
Read Only:
trueValue that uniquely identifies the invoice. -
InvoiceLineNumber: string
Read Only:
trueMaximum Length:40Number that identifies a line on the invoice. -
InvoiceLineType: string
Read Only:
trueMaximum Length:30Value that identifies the type of invoice line, including categories such as Item, Freight, Tax, and Miscellaneous. -
InvoiceNumber: string
Read Only:
trueMaximum Length:50Number that identifies the invoice. -
InvoiceTotal: integer
(int64)
Read Only:
trueTotal amount on the invoice line. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MissingChargeTypeFlag: boolean
Read Only:
trueMaximum Length:255Contains one of the following values: true or false. If true, then the invoice line doesn't contain the charge details. If false, then the invoice lines contains the charge details. This attribute doesn't have a default value. -
MissingReferenceTypesFlag: boolean
Read Only:
trueMaximum Length:255Contains one of the following values: true or false. If true, then invoice lines are missing charge references. If false, then invoice lines contain charge references. The default value is null. -
PartyId: integer
Read Only:
trueValue that identifies the third-party supplier. -
PartyName: string
Title:
NameRead Only:trueMaximum Length:360Value that indicates the supplier on the invoice. -
Precision: integer
(int32)
Title:
PrecisionRead Only:trueDefault Value:2Value that identifies the currency precision. -
ProcurementBusinessUnitId: integer
(int64)
Read Only:
trueValue that uniquely identifies the procurement business unit. -
ProcurementBusinessUnitName: string
Title:
Business UnitRead Only:trueMaximum Length:240Value that indicates the procurement business unit on the invoice line. -
TaxAmount: number
Read Only:
trueNonrecoverable tax on the invoice line. -
VendorId: integer
(int64)
Read Only:
trueValue that uniquely identifies the supplier rendering the service. -
VendorSiteCode: string
Title:
SiteRead Only:trueMaximum Length:240Name of the supplier site on the invoice. -
VendorSiteId: integer
(int64)
Read Only:
trueValue that uniquely identifies the supplier site rendering the service.
Nested Schema : Linked Trade Operation Charge Lines
Type:
arrayTitle:
Linked Trade Operation Charge LinesTrade operation charges linked to the landed cost invoice line.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : invoiceLinesForLandedCosts-chargeAssociations-item-response
Type:
Show Source
object-
ActiveIndicator: string
Maximum Length:
1Indicates the most recent record for the charge invoice association. -
AssociationDetails: string
Read Only:
trueMaximum Length:255Defines the results of the association process. -
AssociationMode: string
Read Only:
trueMaximum Length:255Value that identifies the mode of invoice association. -
AssociationModeCode: number
Abbreviation that identifies the mode of the invoice association.
-
AssociationStatus: string
Read Only:
trueMaximum Length:255Identifies the status of the association of the invoice with the charge line. -
AssociationStatusCode: number
Abbreviation that uniquely identifies the status of the invoice association with the charge line. Valid values include Needs Review, Deleted, Rejected, and Associated.
-
chargeAssociationDetails: array
Association Details with Trade Operation Charge Lines
Title:
Association Details with Trade Operation Charge LinesAssociation details for matching the invoice line to the trade operation charge line. -
ChargeCurrencyEnteredAmount: number
Read Only:
trueEntered amount in the charge currency. -
ChargeCurrencyTotal: number
Read Only:
trueTotal amount in the charge currency. -
ChargeFunctionalCurrencyTotal: number
Read Only:
trueAmount on the charge line in the functional currency of the invoice. -
ChargeId: integer
(int64)
Read Only:
trueUnique identifier for the charge in the invoice line. -
ChargeInvoiceAssociationId: integer
(int64)
Unique identifier for a charge invoice association.
-
ChargeLineNumber: integer
(int32)
Read Only:
trueNumber that identifies the charge line. -
ChargeLineStatusCode: string
Read Only:
trueMaximum Length:30Abbreviation that identifies the status of the charge line. -
ChargeName: string
Read Only:
trueMaximum Length:80Name of the charge given on the invoice line. -
ChargeRequistionBUCurrencyConversionRate: number
Read Only:
trueCurrency conversion rate for the requisition BU. -
EnteredCurrencyCode: string
Read Only:
trueMaximum Length:15Abbreviation that identifies the entered currency. -
EnteredCurrencyPrecision: integer
(int32)
Title:
PrecisionRead Only:trueDefault Value:2Value that identifies the currency precision. -
EnteredDate: string
(date-time)
Date on which the actual amount for charges are established or canceled.
-
ExternalSystemReference: string
Maximum Length:
60Identifier of the source system that owns the invoice entity. -
FunctionalCurrencyAmount: number
Amount on the invoice line in the functional currency of the invoice.
-
FunctionalCurrencyCode: string
Maximum Length:
15Abbreviation that identifies the functional currency. -
FunctionalCurrencyEstimatedAmount: number
Read Only:
trueEstimated Amount in Functional Currency -
FunctionalCurrencyEstimatedTax: number
Read Only:
trueEstimated Nonrecoverable Tax in Functional Currency -
FunctionalCurrencyTax: number
Nonrecoverable tax on the invoice line in the invoice functional currency.
-
InvoiceAmount: number
Amount on the invoice line.
-
InvoiceCurrencyCode: string
Maximum Length:
15Abbreviation that identifies the invoice currency. -
InvoiceId: integer
(int64)
Value that uniquely identifies the invoice.
-
InvoiceLineNumber: integer
(int64)
Number that identifies a line on the invoice.
-
InvoiceTax: number
Nonrecoverable Tax in Invoice Currency
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
NonrecoverableTax: number
Read Only:
trueNonrecoverable tax on the invoice line. -
PartyId: integer
Read Only:
trueValue that identifies the third-party supplier. -
PartyName: string
Title:
NameRead Only:trueMaximum Length:360Value that indicates the supplier on the invoice. -
Rank: integer
(int64)
Indicates the rank of the potential matches.
-
RequisitionBUCurrencyCode: string
Read Only:
trueMaximum Length:15Currency code of the requisition BU. -
RequisitionBUCurrencyPrecision: integer
(int32)
Title:
PrecisionRead Only:trueDefault Value:2Currency precision of the requisition BU. -
TradeoperationChargeEstimateId: integer
(int64)
Read Only:
trueUnique identifier of the trade operation charge estimate. -
TradeOperationChargeId: integer
(int64)
Unique identifier of the trade operation charge.
-
TradeOperationId: integer
(int64)
Read Only:
trueUnique identifier of the trade operation. -
TradeOperationName: string
Read Only:
trueMaximum Length:80Name of the trade operation associated with the charge invoice. -
TradeOperationNumber: string
Read Only:
trueMaximum Length:40Number that indicates the trade operation associated with the charge invoice. -
TradeOperationStatusCode: string
Read Only:
trueMaximum Length:30Abbreviation that identifies the status of the trade operation. -
UserComments: string
Maximum Length:
2000Comments added by the user. -
VendorId: integer
(int64)
Read Only:
trueValue that uniquely identifies the supplier rendering the service. -
VendorSiteCode: string
Title:
SiteRead Only:trueMaximum Length:240Name of the supplier site on the invoice. -
VendorSiteId: integer
(int64)
Read Only:
trueValue that uniquely identifies the supplier site rendering the service.
Nested Schema : Association Details with Trade Operation Charge Lines
Type:
arrayTitle:
Association Details with Trade Operation Charge LinesAssociation details for matching the invoice line to the trade operation charge line.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : invoiceLinesForLandedCosts-chargeAssociations-chargeAssociationDetails-item-response
Type:
Show Source
object-
AssociationAttribute: string
Read Only:
trueMaximum Length:255Attribute used for associating invoices and charge lines. -
AssociationAttributeType: number
Association Attributes
-
ChargeInvoiceAssociationDetailsId: integer
(int64)
Unique identifier of a charge invoice association detail.
-
ChargeInvoiceAssociationId: integer
(int64)
Unique identifier of a charge invoice association.
-
ChargeLineChargeId: integer
(int64)
Unique identifier of the charge associated with charge line.
-
ChargeLineChargeName: string
Read Only:
trueMaximum Length:80Name of the charge associated with charge line. -
ChargeLinePartyId: integer
Read Only:
trueValue that uniquely identifies the third-party supplier associated with charge line. -
ChargeLinePartyName: string
Title:
NameRead Only:trueMaximum Length:360Third-party supplier name associated with the charge line. -
ChargeLineReferenceValueNumber: number
Number type reference value associated with the charge line.
-
ChargeLineReferenceValueString: string
Maximum Length:
64String type reference value associated with the charge line. -
ChargeLineReferenceValueTimestamp: string
(date-time)
Date type reference value associated with the charge line.
-
ChargeLineSupplierId: integer
(int64)
Unique identifier of the supplier associated with the charge line.
-
ChargeLineSupplierSiteId: integer
(int64)
Value that uniquely identifies the supplier site associated with the charge line.
-
ChargeLineVendorId: integer
(int64)
Read Only:
trueUnique identifier of the supplier associated with the charge line. -
ChargeLineVendorSiteCode: string
Title:
SiteRead Only:trueMaximum Length:240Name of the supplier site associated with charge line. -
ChargeLineVendorSiteId: integer
(int64)
Read Only:
trueValue that uniquely identifies the supplier site associated with the charge line. -
ChargeReferenceTypeId: integer
(int64)
Read Only:
trueValue that uniquely identifies the reference type associated with the charge line. -
ChargeReferenceTypeName: string
Read Only:
trueMaximum Length:100Name of the reference type associated with the charge line. -
ChargeReferenceValueDataType: string
Read Only:
trueMaximum Length:30Reference data type associated with the charge line. -
DisplayAttributeType: string
Read Only:
trueMaximum Length:255Value that indicates the attribute type for the association details. -
InvoiceLineChargeId: integer
(int64)
Unique identifier of the charge associated with the charge line.
-
InvoiceLineChargeName: string
Read Only:
trueMaximum Length:80Name of the charge associated with the invoice line. -
InvoiceLinePartyId: integer
Read Only:
trueValue that uniquely identifies the third-party supplier associated with the invoice line. -
InvoiceLinePartyName: string
Title:
NameRead Only:trueMaximum Length:360Third-party supplier name associated with the invoice line. -
InvoiceLineReferenceValueNumber: number
Number type reference value associated with the invoice line.
-
InvoiceLineReferenceValueString: string
Maximum Length:
64String type reference value associated with the invoice line. -
InvoiceLineReferenceValueTimestamp: string
(date-time)
Date type reference value associated with the invoice line.
-
InvoiceLineSupplierId: integer
(int64)
Unique identifier of the supplier associated with the invoice line.
-
InvoiceLineSupplierSiteId: integer
(int64)
Value that uniquely identifies the supplier site associated with the invoice line.
-
InvoiceLineVendorId: integer
(int64)
Read Only:
trueUnique identifier of the supplier associated with the invoice line. -
InvoiceLineVendorSiteCode: string
Title:
SiteRead Only:trueMaximum Length:240Name of the supplier site associated with the invoice line. -
InvoiceLineVendorSiteId: integer
(int64)
Read Only:
trueValue that uniquely identifies the supplier site associated with the invoice line. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MatchStatus: string
Read Only:
trueMaximum Length:255Match Status -
MatchStatusCode: number
Abbreviation that defines whether the status of the association is matched or unmatched.
-
ReferenceTypeId: integer
(int64)
Trade Operation Charge Reference Type ID
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- associateChargeLines
-
Parameters:
- invoiceLinesForLandedCostsUniqID:
$request.path.invoiceLinesForLandedCostsUniqID
Associates the trade operation charge line to an invoice line. - invoiceLinesForLandedCostsUniqID:
- chargeAssociations
-
Parameters:
- invoiceLinesForLandedCostsUniqID:
$request.path.invoiceLinesForLandedCostsUniqID
Trade operation charges linked to the landed cost invoice line. - invoiceLinesForLandedCostsUniqID:
- updateChargeId
-
Parameters:
- invoiceLinesForLandedCostsUniqID:
$request.path.invoiceLinesForLandedCostsUniqID
Updates the charge for an invoice and adds default charge references. - invoiceLinesForLandedCostsUniqID: