Get one invoice
get
/fscmRestApi/resources/11.13.18.05/invoicesForLandedCostCharges/{invoicesForLandedCostChargesUniqID}
Request
Path Parameters
-
invoicesForLandedCostChargesUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Invoices for Landed Cost Charges resource and used to uniquely identify an instance of Invoices for Landed Cost Charges. The client should not generate the hash key value. Instead, the client should query on the Invoices for Landed Cost Charges collection resource in order to navigate to a specific instance of Invoices for Landed Cost Charges to get the hash key.
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 : invoicesForLandedCostCharges-item-response
Type:
Show Source
object-
AssociationMode: string
Title:
Association ModeRead Only:trueMaximum Length:255 -
AssociationModeCode: number
Title:
Association Mode CodeRead Only:true -
AssociationStatus: string
Title:
Association StatusRead Only:trueMaximum Length:80 -
ChargeBU: string
Title:
Charge BURead Only:trueMaximum Length:240 -
ChargeBUId: integer
(int64)
Title:
Charge Business Unit ID -
ChargeCode: string
Title:
Charge CodeRead Only:trueMaximum Length:30 -
ChargeId: integer
(int64)
Title:
Charge ID -
ChargeName: string
Title:
Charge NameRead Only:trueMaximum Length:80 -
InvoiceAmount: number
Title:
AmountRead Only:true -
InvoiceCreationDate: string
(date-time)
Title:
Invoice DateRead Only:true -
InvoiceCurrency: string
Title:
Currency NameRead Only:trueMaximum Length:80 -
InvoiceCurrencyCode: string
Title:
Currency CodeRead Only:trueMaximum Length:15 -
InvoiceId: integer
(int64)
Title:
Invoice IDRead Only:true -
InvoiceLineNumber: string
Title:
Invoice Line NumberRead Only:trueMaximum Length:40 -
InvoiceLineType: string
Title:
Line TypeRead Only:trueMaximum Length:30 -
InvoiceNonrecoverableTaxAmount: number
Title:
Nonrecoverable TaxRead Only:true -
InvoiceNumber: string
Title:
Invoice NumberRead Only:trueMaximum Length:50 -
landedCostChargeReferencesForInvoiceLines: array
Charge References
Title:
Charge ReferencesThe Charge References resource manages the charge references on the charge used for an invoice association. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MissingChargeReferences: string
Title:
Show Only Invoices Missing Reference TypesRead Only:trueMaximum Length:255 -
ProcurementBU: string
Title:
Procurement BURead Only:trueMaximum Length:240 -
ProcurementBUId: integer
(int64)
Title:
Procurement Business Unit IDRead Only:true -
Supplier: string
Title:
SupplierRead Only:trueMaximum Length:360 -
SupplierId: integer
(int64)
Title:
Supplier IDRead Only:true -
SupplierSite: string
Title:
Supplier SiteRead Only:trueMaximum Length:240 -
SupplierSiteId: integer
(int64)
Title:
Supplier Site IDRead Only:true -
TradeOperationName: string
Title:
Trade Operation NameRead Only:trueMaximum Length:80 -
TradeOperationNumber: string
Title:
Trade Operation NumberRead Only:trueMaximum Length:40
Nested Schema : Charge References
Type:
arrayTitle:
Charge ReferencesThe Charge References resource manages the charge references on the charge used for an invoice association.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : invoicesForLandedCostCharges-landedCostChargeReferencesForInvoiceLines-item-response
Type:
Show Source
object-
ChargeReferenceDataType: string
Title:
Reference Data TypeValue that defines the type of input data for charge reference. -
ChargeReferenceName: string
Title:
Charge Reference NameName of the charge reference type. -
ChargeReferencePredefined: string
Title:
PredefinedRead Only:trueMaximum Length:255Contains one of the following values: true or false. If true, then the reference type is predefined in the default charge references setup. If false, then the reference type isn't predefined. The default value is false. -
ChargeReferenceTypeId: integer
(int64)
Title:
Charge Reference Type IDValue that uniquely identifies the type of charge reference. -
ChargeReferenceValueDataType: string
Title:
Reference Data TypeRead Only:trueMaximum Length:80Value that identifies the type of input data for charge references. -
InvoiceChargeReferenceId: integer
(int64)
Title:
Invoice Charge Reference IDValue that uniquely identifies the invoice charge reference. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ProcurementBU: string
Title:
Procurement BURead Only:trueMaximum Length:240Value that indicates the procurement business unit on the charge reference. -
ProcurementBUId: integer
(int64)
Title:
Procurement Business Unit IDValue that uniquely identifies the procurement business unit for a charge reference. -
ReferenceValueDate: string
(date-time)
Title:
Date ReferenceDate value of the charge reference. -
ReferenceValueNumber: number
Title:
Numeric ReferenceNumber that identifies the charge reference. -
ReferenceValueText: string
Title:
Alphanumeric ReferenceMaximum Length:64Text of the charge reference. -
UserComment: string
Title:
CommentsMaximum Length:240Comments added by the user for the charge reference.
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
- landedCostChargeReferencesForInvoiceLines
-
Parameters:
- invoicesForLandedCostChargesUniqID:
$request.path.invoicesForLandedCostChargesUniqID
- invoicesForLandedCostChargesUniqID:
Examples
This example describes how to get one invoice.
Example cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/invoicesForLandedCostCharges/invoicesForLandedCostChargesUniqID"
For example, the following command gets one invoice:
curl -u username:password "https://servername/fscmRestApi/resources/version/invoicesForLandedCostCharges/00040000000EACED00057708000110F07F41616600000001310000000EACED00057708000110F07F4161660000000EACED000577080000000000000001"
Example Response Body
The following shows an example of the response body in JSON format.
{
"items":[
{
"AssociationMode": null,
"AssociationModeCode": null,
"AssociationStatus": "New",
"ChargeName": "SS_Freight",
"ChargeCode": "SS_Freight",
"ChargeID": 300100071793249,
"ChargeBU": "Vision Operations",
"ChargeBUID": 204,
"MissingChargeReferences": "false",
"InvoiceNumber": "SS004",
"InvoiceID": 300100071634157,
"InvoiceLineNumber": "1",
"InvoiceLineType": "ITEM",
"InvoiceAmount": 250,
"InvoiceNonrecoverableTaxAmount": 0,
"InvoiceCurrency": "US Dollar",
"InvoiceCurrencyCode": "USD",
"InvoiceCreationDate": "12/03/15",
"ProcurementBU": "Vision Operations",
"ProcurementBUID": 204,
"Supplier": "PennyPack Systems",
"SupplierID": 21,
"SupplierSite": "FRESNO",
"SupplierSiteID": 1969,
"TradeOperationName": null,
"TradeOperationNumber": null,
"links":[
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/invoicesForLandedCostCharges/00040000000EACED00057708000110F07E2AB4ED00000001310000000EACED00057708000110F07E2AB4ED0000000EACED000577080000000000000001",
"name": "invoicesForLandedCostCharges",
"kind": "item",
},
{"rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/invoicesForLandedCostCharges/00040000000EACED00057708000110F07E2AB4ED00000001310000000EACED00057708000110F07E2AB4ED0000000EACED000577080000000000000001",...},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/invoicesForLandedCostCharges/00040000000EACED00057708000110F07E2AB4ED00000001310000000EACED00057708000110F07E2AB4ED0000000EACED000577080000000000000001/child/landedCostChargeReferencesForInvoiceLines",
"name": "landedCostChargeReferencesForInvoiceLines",
"kind": "collection"
}
]
}
],
"count": 1,
"hasMore": false,
"limit": 25,
"offset": 0,
}