Jump to

• Request
• Response

Get all charge lines for one invoice association

get

/fscmRestApi/resources/11.13.18.05/chargeLinesForInvoiceAssociations

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 with the specified primary key the trade operation charge lines for the invoice association.
    Finder Variables
    • TradeOperationChargeId; integer; Value that uniquely identifies the trade operation charge line.
    • TradeOperationId; integer; Value that uniquely identifies the trade operation.
• 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:
  

  • ChargeCreationDate; string; Date when the charge was raised.
  • ChargeCurrencyTotal; number; Total amount in the charge currency.
  • ChargeDate; string; Date when the charge line was created.
  • ChargeFunctionalCurrencyTotal; number; Amount on the charge line in the functional currency of the invoice.
  • ChargeId; integer; Unique identifier of the charge in the invoice line.
  • ChargeLineNumber; integer; Number that identifies the charge line.
  • ChargeName; string; Name of the charge given on the invoice line.
  • ChargeRequisitionBUCurrencyConversionRate; number; Currency conversion rate for the requisition BU.
  • EnteredAmount; number; Charge amount on the trade operation charge line.
  • EnteredCurrencyCode; string; Abbreviation that identifies the invoice currency.
  • EnteredCurrencyPrecision; integer; Value that identifies the currency precision.
  • FunctionalCurrencyEstimatedAmount; number; Estimated Amount in Functional Currency
  • FunctionalCurrencyEstimatedTax; number; Estimated Nonrecoverable Tax in Functional Currency
  • MissingInvoiceFlag; boolean; Defines whether the charge line has associated invoice lines.
  • Name; string; Name of the trade operation associated with the charge invoice.
  • NonrecoverableTax; number; Nonrecoverable tax on the invoice line.
  • ProcurementBUId; integer; Value that uniquely identifies the procurement business unit.
  • ReferenceValue; string; Charge reference type and the value stored on the trade operation charge line.
  • RequisitionBUCurrencyCode; string; Currency code of the requisitioning business unit.
  • RequisitionBUCurrencyPrecision; integer; Currency precision of the requisitioning business unit.
  • RouteId; integer; Unique identifier of the route for the charge line.
  • RouteName; string; Name of the route for the charge line.
  • Status; string; Value that identifies the status of the charge line.
  • StatusCode; string; Abbreviation that identifies the status of the charge line.
  • Supplier; string; Value that indicates the supplier on the invoice.
  • TradeOperationChargeEstimateId; integer; Unique identifier of the trade operation charge estimate.
  • TradeOperationChargeId; integer; Unique identifier of the trade operation charge.
  • TradeOperationId; integer; Unique identifier of the trade operation.
  • TradeOperationNumber; string; Number that indicates the trade operation associated with the charge invoice.
  • 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 Top

Response

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.

Body ()

Root Schema : chargeLinesForInvoiceAssociations

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":{
        "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."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/chargeLinesForInvoiceAssociations-item-response"
            }
        },
        "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"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    },
    "x-hints":{
        "subgroup":"InventoryManagement",
        "usage":"BusinessObject",
        "group":"SCM"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object chargeLinesForInvoiceAssociations-item-response

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

Type: object

Show Source

• ChargeCreationDate: string (date)
  Read Only: true

  Date when the charge was raised.
• ChargeCurrencyTotal: number
  Read Only: true

  Total amount in the charge currency.
• ChargeDate: string (date-time)
  Read Only: true

  Date when the charge line was created.
• 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 of the charge in the invoice line.
• ChargeLineNumber: integer (int32)
  Read Only: true

  Number that identifies the charge line.
• ChargeName: string
  Read Only: true

  Maximum Length: 80

  Name of the charge given on the invoice line.
• ChargeRequisitionBUCurrencyConversionRate: number
  Read Only: true

  Currency conversion rate for the requisition BU.
• EnteredAmount: number
  Read Only: true

  Charge amount on the trade operation charge line.
• EnteredCurrencyCode: string
  Read Only: true

  Maximum Length: 15

  Abbreviation that identifies the invoice currency.
• EnteredCurrencyPrecision: integer (int32)
  Read Only: true

  Value that identifies the currency precision.
• FunctionalCurrencyEstimatedAmount: number
  Read Only: true

  Estimated Amount in Functional Currency
• FunctionalCurrencyEstimatedTax: number
  Read Only: true

  Estimated Nonrecoverable Tax in Functional Currency
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MissingInvoiceFlag: boolean
  Read Only: true

  Maximum Length: 1

  Defines whether the charge line has associated invoice lines.
• Name: string
  Read Only: true

  Maximum Length: 255

  Name of the trade operation associated with the charge invoice.
• NonrecoverableTax: number
  Read Only: true

  Nonrecoverable tax on the invoice line.
• ProcurementBUId: integer (int64)
  Read Only: true

  Value that uniquely identifies the procurement business unit.
• ReferenceValue: string
  Read Only: true

  Maximum Length: 64

  Charge reference type and the value stored on the trade operation charge line.
• RequisitionBUCurrencyCode: string
  Read Only: true

  Maximum Length: 15

  Currency code of the requisitioning business unit.
• RequisitionBUCurrencyPrecision: integer (int32)
  Read Only: true

  Currency precision of the requisitioning business unit.
• RouteId: integer (int64)
  Read Only: true

  Unique identifier of the route for the charge line.
• RouteName: string
  Read Only: true

  Maximum Length: 80

  Name of the route for the charge line.
• Status: string
  Read Only: true

  Maximum Length: 80

  Value that identifies the status of the charge line.
• StatusCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the status of the charge line.
• Supplier: string
  Read Only: true

  Maximum Length: 360

  Value that indicates the supplier on the invoice.
• TradeOperationChargeEstimateId: integer (int64)
  Read Only: true

  Unique identifier of the trade operation charge estimate.
• TradeOperationChargeId: integer (int64)
  Read Only: true

  Unique identifier of the trade operation charge.
• TradeOperationId: integer (int64)
  Read Only: true

  Unique identifier of the trade operation.
• TradeOperationNumber: string
  Read Only: true

  Maximum Length: 40

  Number that indicates the trade operation associated with the charge invoice.
• VendorId: integer (int64)
  Read Only: true

  Value that uniquely identifies the supplier rendering the service.
• VendorSiteCode: string
  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.

{
    "type":"object",
    "properties":{
        "ChargeCreationDate":{
            "type":"string",
            "description":"Date when the charge was raised.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeCurrencyTotal":{
            "type":"number",
            "description":"Total amount in the charge currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeDate":{
            "type":"string",
            "description":"Date when the charge line was created.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeFunctionalCurrencyTotal":{
            "type":"number",
            "description":"Amount on the charge line in the functional currency of the invoice.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeId":{
            "type":"integer",
            "description":"Unique identifier of the charge in the invoice line.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChargeLineNumber":{
            "type":"integer",
            "description":"Number that identifies the charge line.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ChargeName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the charge given on the invoice line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeRequisitionBUCurrencyConversionRate":{
            "type":"number",
            "description":"Currency conversion rate for the requisition BU.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EnteredAmount":{
            "type":"number",
            "description":"Charge amount on the trade operation charge line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EnteredCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Abbreviation that identifies the invoice currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EnteredCurrencyPrecision":{
            "type":"integer",
            "description":"Value that identifies the currency precision.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "FunctionalCurrencyEstimatedAmount":{
            "type":"number",
            "description":"Estimated Amount in Functional Currency",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FunctionalCurrencyEstimatedTax":{
            "type":"number",
            "description":"Estimated Nonrecoverable Tax in Functional Currency",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MissingInvoiceFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Defines whether the charge line has associated invoice lines.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the trade operation associated with the charge invoice.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NonrecoverableTax":{
            "type":"number",
            "description":"Nonrecoverable tax on the invoice line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcurementBUId":{
            "type":"integer",
            "description":"Value that uniquely identifies the procurement business unit.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ReferenceValue":{
            "maxLength":64,
            "type":"string",
            "description":"Charge reference type and the value stored on the trade operation charge line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequisitionBUCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Currency code of the requisitioning business unit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequisitionBUCurrencyPrecision":{
            "type":"integer",
            "description":"Currency precision of the requisitioning business unit.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "RouteId":{
            "type":"integer",
            "description":"Unique identifier of the route for the charge line.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RouteName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the route for the charge line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "maxLength":80,
            "type":"string",
            "description":"Value that identifies the status of the charge line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the status of the charge line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Supplier":{
            "maxLength":360,
            "type":"string",
            "description":"Value that indicates the supplier on the invoice.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TradeOperationChargeEstimateId":{
            "type":"integer",
            "description":"Unique identifier of the trade operation charge estimate.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TradeOperationChargeId":{
            "type":"integer",
            "description":"Unique identifier of the trade operation charge.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TradeOperationId":{
            "type":"integer",
            "description":"Unique identifier of the trade operation.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TradeOperationNumber":{
            "maxLength":40,
            "type":"string",
            "description":"Number that indicates the trade operation associated with the charge invoice.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "VendorId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier rendering the service.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "VendorSiteCode":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the supplier site on the invoice.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "VendorSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site rendering the service.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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