Jump to

• Request
• Response

Get all invoice associations

get

/fscmRestApi/resources/11.13.18.05/tradeOperations/{TradeOperationId}/child/charges/{TradeOperationChargeId}/child/chargeInvoiceAssociations

Request

Path Parameters

• 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
• 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 charge invoice associations related to a trade operation charge according to the trade operation charge invoice association identifier as the primary key.
    Finder Variables:
    • ChargeInvoiceAssociationId; integer; Value that uniquely identifies the trade operation charge invoice association.
  • findChargeInvoiceAssociations: Finds charge associations to a charge line according to the specified attributes.
    Finder Variables:
    • bindInvoiceAmount; number; Invoice amount in the charge invoice association.
    • bindInvoiceLineNumber; integer; Number that identifies the invoice line in the charge invoice association.
    • bindInvoiceNumber; string; Number that identifies the invoice in the charge invoice association.
    • bindPartyName; string; Name of the supplier in the charge invoice association.
• 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 indicates whether the invoice line is automatic or manual associated.
  • ChargeInvoiceAssociationId; integer; Value that uniquely identifies the invoice line to the landed cost charge.
  • FunctionalCurrencyAmount; number; Actual amount on the charge line in functional currency.
  • FunctionalCurrencyCode; string; Value that indicates the functional currency.
  • FunctionalCurrencyTax; number; Actual non-recoverable tax on the invoice in functional currency.
  • FunctionalCurrencyTotal; number; Allocated total amount on the invoice charge line in functional currency.
  • InvoiceAmount; number; Actual amount on the charge line in invoice currency.
  • InvoiceCurrencyCode; string; Value that identifies the invoice currency.
  • InvoiceId; integer; Value that uniquely identifies the invoice associated with the trade operation charge line.
  • InvoiceLineNumber; integer; Number that identifies the invoice line associated with the trade operation charge line.
  • InvoiceNumber; string; Number that indicates the invoice associated with the trade operation charge line.
  • InvoiceTax; number; Actual non-recoverable tax on the invoice in invoice currency.
  • InvoiceTotal; number; Allocated total amount on the invoice charge line in invoice currency.
  • Supplier; string; Name of the supplier on the charge line.
  • SupplierId; integer; Value that identifies the supplier on the charge line.
  • SupplierSite; string; Value that identifies the supplier site on the charge line.
  • SupplierSiteId; integer; Value that identifies the supplier site on the charge line.
  • TradeOperationCurrencyAmount; number; Actual amount on the charge line in trade operation currency.
  • TradeOperationCurrencyCode; string; Value that identifies the trade operation currency.
  • TradeOperationCurrencyTax; number; Actual non-recoverable tax on the invoice in trade operation currency.
  • TradeOperationCurrencyTotal; number; Allocated total amount on the invoice charge line in the trade operation currency.
• 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(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.

Body ()

Root Schema : tradeOperations-charges-chargeInvoiceAssociations

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/tradeOperations-charges-chargeInvoiceAssociations-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object tradeOperations-charges-chargeInvoiceAssociations-item-response

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

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "FunctionalCurrencyTotal":{
            "title":"Allocated Actual Total in Functional Currency",
            "type":"number",
            "description":"Allocated total amount on the invoice charge line in functional currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InvoiceLineNumber":{
            "title":"Invoice Line Number",
            "type":"integer",
            "description":"Number that identifies the invoice line associated with the trade operation charge line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChargeInvoiceAssociationId":{
            "title":"Charge Invoice Association ID",
            "type":"integer",
            "description":"Value that uniquely identifies the invoice line to the landed cost charge.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "FunctionalCurrencyAmount":{
            "title":"Allocated Actual Amount in Functional Currency",
            "type":"number",
            "description":"Actual amount on the charge line in functional currency.",
            "nullable":true,
            "x-queryable":true
        },
        "AssociationMode":{
            "title":"Association Mode",
            "maxLength":255,
            "type":"string",
            "description":"Value that indicates whether the invoice line is automatic or manual associated.",
            "nullable":true,
            "x-queryable":true
        },
        "FunctionalCurrencyTax":{
            "title":"Allocated Actual NonRecoverable Tax in Functional Currency",
            "type":"number",
            "description":"Actual non-recoverable tax on the invoice in functional currency.",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceAmount":{
            "title":"Allocated Actual Amount in Invoice Currency",
            "type":"number",
            "description":"Actual amount on the charge line in invoice currency.",
            "nullable":false,
            "x-queryable":true
        },
        "InvoiceId":{
            "title":"Invoice ID",
            "type":"integer",
            "description":"Value that uniquely identifies the invoice associated with the trade operation charge line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TradeOperationCurrencyAmount":{
            "title":"Allocated Actual Amount in Trade Operation Currency",
            "type":"number",
            "description":"Actual amount on the charge line in trade operation currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierId":{
            "title":"Supplier ID",
            "type":"integer",
            "description":"Value that identifies the supplier on the charge line.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FunctionalCurrencyCode":{
            "title":"Functional Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"Value that indicates the functional currency.",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceTotal":{
            "title":"Allocated Actual Total in Invoice Currency",
            "type":"number",
            "description":"Allocated total amount on the invoice charge line in invoice currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierSiteId":{
            "title":"Supplier Site ID",
            "type":"integer",
            "description":"Value that identifies the supplier site on the charge line.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TradeOperationCurrencyTotal":{
            "title":"Allocated Actual Total in Trade Operation Currency",
            "type":"number",
            "description":"Allocated total amount on the invoice charge line in the trade operation currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierSite":{
            "title":"Supplier Site",
            "maxLength":240,
            "type":"string",
            "description":"Value that identifies the supplier site on the charge line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TradeOperationCurrencyCode":{
            "title":"Document Currency",
            "maxLength":15,
            "type":"string",
            "description":"Value that identifies the trade operation currency.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InvoiceTax":{
            "title":"Allocated Actual Nonrecoverable Tax in Invoice Currency",
            "type":"number",
            "description":"Actual non-recoverable tax on the invoice in invoice currency.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Supplier":{
            "title":"Supplier",
            "maxLength":360,
            "type":"string",
            "description":"Name of the supplier on the charge line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InvoiceNumber":{
            "title":"Invoice Number",
            "maxLength":50,
            "type":"string",
            "description":"Number that indicates the invoice associated with the trade operation charge line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TradeOperationCurrencyTax":{
            "title":"Allocated Actual NonRecoverable Tax in Trade Operation Currency",
            "type":"number",
            "description":"Actual non-recoverable tax on the invoice in trade operation currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InvoiceCurrencyCode":{
            "title":"Invoice Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"Value that identifies the invoice currency.",
            "nullable":false,
            "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