Get one charge invoice association
get
/fscmRestApi/resources/11.13.18.05/tradeOperations/{TradeOperationId}/child/charges/{TradeOperationChargeId}/child/chargeInvoiceAssociations/{ChargeInvoiceAssociationId}
Request
Path Parameters
-
ChargeInvoiceAssociationId(required): integer(int64)
Value that uniquely identifies the invoice line to the landed cost charge.
-
TradeOperationChargeId(required): integer(int64)
Value that uniquely identifies the trade operation charge.
-
TradeOperationId(required): integer(int64)
Value that uniquely identifies the trade operation.
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:
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 TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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 : tradeOperations-charges-chargeInvoiceAssociations-item-response
Type:
Show Source
object
-
AssociationMode: string
Title:
Association Mode
Maximum Length:255
Value that indicates whether the invoice line is automatic or manual associated. -
ChargeInvoiceAssociationId: integer
(int64)
Title:
Charge Invoice Association ID
Value that uniquely identifies the invoice line to the landed cost charge. -
FunctionalCurrencyAmount: number
Title:
Allocated Actual Amount in Functional Currency
Actual amount on the charge line in functional currency. -
FunctionalCurrencyCode: string
Title:
Functional Currency Code
Maximum Length:15
Value that indicates the functional currency. -
FunctionalCurrencyTax: number
Title:
Allocated Actual NonRecoverable Tax in Functional Currency
Actual non-recoverable tax on the invoice in functional currency. -
FunctionalCurrencyTotal: number
Title:
Allocated Actual Total in Functional Currency
Read Only:true
Allocated total amount on the invoice charge line in functional currency. -
InvoiceAmount: number
Title:
Allocated Actual Amount in Invoice Currency
Actual amount on the charge line in invoice currency. -
InvoiceCurrencyCode: string
Title:
Invoice Currency Code
Maximum Length:15
Value that identifies the invoice currency. -
InvoiceId: integer
(int64)
Title:
Invoice ID
Value that uniquely identifies the invoice associated with the trade operation charge line. -
InvoiceLineNumber: integer
(int64)
Title:
Invoice Line Number
Number that identifies the invoice line associated with the trade operation charge line. -
InvoiceNumber: string
Title:
Invoice Number
Read Only:true
Maximum Length:50
Number that indicates the invoice associated with the trade operation charge line. -
InvoiceTax: number
Title:
Allocated Actual Nonrecoverable Tax in Invoice Currency
Actual non-recoverable tax on the invoice in invoice currency. -
InvoiceTotal: number
Title:
Allocated Actual Total in Invoice Currency
Read Only:true
Allocated total amount on the invoice charge line in invoice currency. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Supplier: string
Title:
Supplier
Read Only:true
Maximum Length:360
Name of the supplier on the charge line. -
SupplierId: integer
(int64)
Title:
Supplier ID
Read Only:true
Value that identifies the supplier on the charge line. -
SupplierSite: string
Title:
Supplier Site
Read Only:true
Maximum Length:240
Value that identifies the supplier site on the charge line. -
SupplierSiteId: integer
(int64)
Title:
Supplier Site ID
Read Only:true
Value that identifies the supplier site on the charge line. -
TradeOperationCurrencyAmount: number
Title:
Allocated Actual Amount in Trade Operation Currency
Read Only:true
Actual amount on the charge line in trade operation currency. -
TradeOperationCurrencyCode: string
Title:
Document Currency
Read Only:true
Maximum Length:15
Value that identifies the trade operation currency. -
TradeOperationCurrencyTax: number
Title:
Allocated Actual NonRecoverable Tax in Trade Operation Currency
Read Only:true
Actual non-recoverable tax on the invoice in trade operation currency. -
TradeOperationCurrencyTotal: number
Title:
Allocated Actual Total in Trade Operation Currency
Read Only:true
Allocated total amount on the invoice charge line in the trade operation currency.
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.