Get all invoice lines
get
/fscmRestApi/resources/11.13.18.05/invoiceLinesForLandedCosts
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 the invoice line with the specified primary key.
Finder Variables- InvoiceId; integer; Value that identifies the invoice line.
- InvoiceLineNumber; string; Identifier for line number of invoice line.
- PrimaryKey Finds the invoice line with the specified primary key.
-
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:- AssociationMode; string; Value that identifies the mode of invoice association.
- AssociationStatus; string; Identifies the status of the invoice association with the charge line.
- AssociationStatusCode; string; Abbreviation that uniquely identifies the status of the invoice association with the charge line. Valid values include Needs Review, Deleted, Rejected, and Associated.
- CMLAssociationRequestId; number; Unique identifier for the run control process of the association.
- ChargeId; integer; Unique identifier for the charge in the invoice line.
- ChargeName; string; Name of the charge given on the invoice line.
- InvoiceCreationDate; string; Date when the supplier raised the invoice.
- InvoiceId; integer; Value that uniquely identifies the invoice.
- InvoiceLineNumber; string; Number that identifies a line on the invoice.
- InvoiceLineType; string; Value that identifies the type of invoice line, including categories such as Item, Freight, Tax, and Miscellaneous.
- InvoiceNumber; string; Number that identifies the invoice.
- MissingChargeTypeFlag; boolean; Contains 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; Contains 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; Value that identifies the third-party supplier.
- PartyName; string; Value that indicates the supplier on the invoice.
- ProcurementBusinessUnitId; integer; Value that uniquely identifies the procurement business unit.
- ProcurementBusinessUnitName; string; Value that indicates the procurement business unit on the invoice line.
- VendorId; integer; Value that uniquely identifies the supplier rendering the service.
- VendorSiteCode; string; Name of the supplier site on the invoice.
- VendorSiteId; integer; Value that uniquely identifies the supplier site rendering the service.
-
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: 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
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : invoiceLinesForLandedCosts-item-response
Type:
Show Source
object
-
AssociationMode: string
Read Only:
true
Maximum Length:255
Value that identifies the mode of invoice association. -
AssociationStatus: string
Title:
Meaning
Read Only:true
Maximum Length:80
Identifies the status of the invoice association with the charge line. -
AssociationStatusCode: string
Read Only:
true
Maximum Length:3
Abbreviation 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 Lines
Trade operation charges linked to the landed cost invoice line. -
ChargeId: integer
(int64)
Read Only:
true
Unique identifier for the charge in the invoice line. -
ChargeName: string
Read Only:
true
Maximum Length:80
Name of the charge given on the invoice line. -
CMLAssociationRequestId: number
Read Only:
true
Unique identifier for the run control process of the association. -
CurrencyCode: string
Read Only:
true
Maximum Length:15
Abbreviation that identifies the invoice currency. -
FunctionalCurrencyCode: string
Read Only:
true
Maximum Length:15
Abbreviation that identifies the functional currency. -
FunctionalInvoiceAmount: number
Read Only:
true
Amount on the invoice line in the functional currency of the invoice. -
FunctionalTaxAmount: number
Read Only:
true
Nonrecoverable tax on the invoice line in the invoice functional currency. -
FunctionalTotal: number
Read Only:
true
Total amount on the invoice line in the functional currency of the invoice. -
InvoiceAmount: number
Read Only:
true
Amount on the invoice line. -
InvoiceCreationDate: string
(date-time)
Read Only:
true
Date when the supplier raised the invoice. -
InvoiceId: integer
(int64)
Read Only:
true
Value that uniquely identifies the invoice. -
InvoiceLineNumber: string
Read Only:
true
Maximum Length:40
Number that identifies a line on the invoice. -
InvoiceLineType: string
Read Only:
true
Maximum Length:30
Value that identifies the type of invoice line, including categories such as Item, Freight, Tax, and Miscellaneous. -
InvoiceNumber: string
Read Only:
true
Maximum Length:50
Number that identifies the invoice. -
InvoiceTotal: integer
(int64)
Read Only:
true
Total amount on the invoice line. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MissingChargeTypeFlag: boolean
Read Only:
true
Maximum Length:255
Contains 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:
true
Maximum Length:255
Contains 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:
true
Value that identifies the third-party supplier. -
PartyName: string
Title:
Name
Read Only:true
Maximum Length:360
Value that indicates the supplier on the invoice. -
Precision: integer
(int32)
Title:
Precision
Read Only:true
Default Value:2
Value that identifies the currency precision. -
ProcurementBusinessUnitId: integer
(int64)
Read Only:
true
Value that uniquely identifies the procurement business unit. -
ProcurementBusinessUnitName: string
Title:
Business Unit
Read Only:true
Maximum Length:240
Value that indicates the procurement business unit on the invoice line. -
TaxAmount: number
Read Only:
true
Nonrecoverable tax on the invoice line. -
VendorId: integer
(int64)
Read Only:
true
Value that uniquely identifies the supplier rendering the service. -
VendorSiteCode: string
Title:
Site
Read Only:true
Maximum Length:240
Name of the supplier site on the invoice. -
VendorSiteId: integer
(int64)
Read Only:
true
Value that uniquely identifies the supplier site rendering the service.
Nested Schema : Linked Trade Operation Charge Lines
Type:
array
Title:
Linked Trade Operation Charge Lines
Trade operation charges linked to the landed cost invoice line.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : invoiceLinesForLandedCosts-chargeAssociations-item-response
Type:
Show Source
object
-
ActiveIndicator: string
Maximum Length:
1
Indicates the most recent record for the charge invoice association. -
AssociationDetails: string
Read Only:
true
Maximum Length:255
Defines the results of the association process. -
AssociationMode: string
Read Only:
true
Maximum Length:255
Value that identifies the mode of invoice association. -
AssociationModeCode: number
Abbreviation that identifies the mode of the invoice association.
-
AssociationStatus: string
Read Only:
true
Maximum Length:255
Identifies 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 Lines
Association details for matching the invoice line to the trade operation charge line. -
ChargeCurrencyEnteredAmount: number
Read Only:
true
Entered amount in the charge currency. -
ChargeCurrencyTotal: number
Read Only:
true
Total amount in the charge currency. -
ChargeFunctionalCurrencyTotal: number
Read Only:
true
Amount on the charge line in the functional currency of the invoice. -
ChargeId: integer
(int64)
Read Only:
true
Unique identifier for the charge in the invoice line. -
ChargeInvoiceAssociationId: integer
(int64)
Unique identifier for a charge invoice association.
-
ChargeLineNumber: integer
(int32)
Read Only:
true
Number that identifies the charge line. -
ChargeLineStatusCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the status of the charge line. -
ChargeName: string
Read Only:
true
Maximum Length:80
Name of the charge given on the invoice line. -
ChargeRequistionBUCurrencyConversionRate: number
Read Only:
true
Currency conversion rate for the requisition BU. -
EnteredCurrencyCode: string
Read Only:
true
Maximum Length:15
Abbreviation that identifies the entered currency. -
EnteredCurrencyPrecision: integer
(int32)
Title:
Precision
Read Only:true
Default Value:2
Value 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:
60
Identifier 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:
15
Abbreviation that identifies the functional currency. -
FunctionalCurrencyEstimatedAmount: number
Read Only:
true
Estimated Amount in Functional Currency -
FunctionalCurrencyEstimatedTax: number
Read Only:
true
Estimated 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:
15
Abbreviation 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:
Links
The link relations associated with the resource instance. -
NonrecoverableTax: number
Read Only:
true
Nonrecoverable tax on the invoice line. -
PartyId: integer
Read Only:
true
Value that identifies the third-party supplier. -
PartyName: string
Title:
Name
Read Only:true
Maximum Length:360
Value that indicates the supplier on the invoice. -
Rank: integer
(int64)
Indicates the rank of the potential matches.
-
RequisitionBUCurrencyCode: string
Read Only:
true
Maximum Length:15
Currency code of the requisition BU. -
RequisitionBUCurrencyPrecision: integer
(int32)
Title:
Precision
Read Only:true
Default Value:2
Currency precision of the requisition BU. -
TradeoperationChargeEstimateId: integer
(int64)
Read Only:
true
Unique identifier of the trade operation charge estimate. -
TradeOperationChargeId: integer
(int64)
Unique identifier of the trade operation charge.
-
TradeOperationId: integer
(int64)
Read Only:
true
Unique identifier of the trade operation. -
TradeOperationName: string
Read Only:
true
Maximum Length:80
Name of the trade operation associated with the charge invoice. -
TradeOperationNumber: string
Read Only:
true
Maximum Length:40
Number that indicates the trade operation associated with the charge invoice. -
TradeOperationStatusCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the status of the trade operation. -
UserComments: string
Maximum Length:
2000
Comments added by the user. -
VendorId: integer
(int64)
Read Only:
true
Value that uniquely identifies the supplier rendering the service. -
VendorSiteCode: string
Title:
Site
Read Only:true
Maximum Length:240
Name of the supplier site on the invoice. -
VendorSiteId: integer
(int64)
Read Only:
true
Value that uniquely identifies the supplier site rendering the service.
Nested Schema : Association Details with Trade Operation Charge Lines
Type:
array
Title:
Association Details with Trade Operation Charge Lines
Association details for matching the invoice line to the trade operation charge line.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : invoiceLinesForLandedCosts-chargeAssociations-chargeAssociationDetails-item-response
Type:
Show Source
object
-
AssociationAttribute: string
Read Only:
true
Maximum Length:255
Attribute 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:
true
Maximum Length:80
Name of the charge associated with charge line. -
ChargeLinePartyId: integer
Read Only:
true
Value that uniquely identifies the third-party supplier associated with charge line. -
ChargeLinePartyName: string
Title:
Name
Read Only:true
Maximum Length:360
Third-party supplier name associated with the charge line. -
ChargeLineReferenceValueNumber: number
Number type reference value associated with the charge line.
-
ChargeLineReferenceValueString: string
Maximum Length:
64
String 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:
true
Unique identifier of the supplier associated with the charge line. -
ChargeLineVendorSiteCode: string
Title:
Site
Read Only:true
Maximum Length:240
Name of the supplier site associated with charge line. -
ChargeLineVendorSiteId: integer
(int64)
Read Only:
true
Value that uniquely identifies the supplier site associated with the charge line. -
ChargeReferenceTypeId: integer
(int64)
Read Only:
true
Value that uniquely identifies the reference type associated with the charge line. -
ChargeReferenceTypeName: string
Read Only:
true
Maximum Length:100
Name of the reference type associated with the charge line. -
ChargeReferenceValueDataType: string
Read Only:
true
Maximum Length:30
Reference data type associated with the charge line. -
DisplayAttributeType: string
Read Only:
true
Maximum Length:255
Value 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:
true
Maximum Length:80
Name of the charge associated with the invoice line. -
InvoiceLinePartyId: integer
Read Only:
true
Value that uniquely identifies the third-party supplier associated with the invoice line. -
InvoiceLinePartyName: string
Title:
Name
Read Only:true
Maximum Length:360
Third-party supplier name associated with the invoice line. -
InvoiceLineReferenceValueNumber: number
Number type reference value associated with the invoice line.
-
InvoiceLineReferenceValueString: string
Maximum Length:
64
String 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:
true
Unique identifier of the supplier associated with the invoice line. -
InvoiceLineVendorSiteCode: string
Title:
Site
Read Only:true
Maximum Length:240
Name of the supplier site associated with the invoice line. -
InvoiceLineVendorSiteId: integer
(int64)
Read Only:
true
Value that uniquely identifies the supplier site associated with the invoice line. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MatchStatus: string
Read Only:
true
Maximum Length:255
Match 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:
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.