Jump to

• Request
• Response

Create one charge association

post

/fscmRestApi/resources/11.13.18.05/invoiceLinesForLandedCosts/{invoiceLinesForLandedCostsUniqID}/child/chargeAssociations

Request

Path Parameters

• invoiceLinesForLandedCostsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- InvoiceId and InvoiceLineNumber ---for the Invoice Lines for Landed Costs resource and used to uniquely identify an instance of Invoice Lines for Landed Costs. The client should not generate the hash key value. Instead, the client should query on the Invoice Lines for Landed Costs collection resource with a filter on the primary key values in order to navigate to a specific instance of Invoice Lines for Landed Costs.
  
  For example: invoiceLinesForLandedCosts?q=InvoiceId=<value1>;InvoiceLineNumber=<value2>

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ActiveIndicator(required): string
  Maximum Length: 1

  Indicates the most recent record for the charge invoice association.
• AssociationModeCode(required): number
  Abbreviation that identifies the mode of the invoice association.
• AssociationStatusCode(required): 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.
• ChargeInvoiceAssociationId: integer (int64)
  Unique identifier for a charge invoice association.
• EnteredDate(required): 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.
• FunctionalCurrencyTax: number
  Nonrecoverable tax on the invoice line in the invoice functional currency.
• InvoiceAmount(required): number
  Amount on the invoice line.
• InvoiceCurrencyCode(required): string
  Maximum Length: 15

  Abbreviation that identifies the invoice currency.
• InvoiceId(required): integer (int64)
  Value that uniquely identifies the invoice.
• InvoiceLineNumber(required): integer (int64)
  Number that identifies a line on the invoice.
• InvoiceTax: number
  Nonrecoverable Tax in Invoice Currency
• Rank: integer (int64)
  Indicates the rank of the potential matches.
• TradeOperationChargeId(required): integer (int64)
  Unique identifier of the trade operation charge.
• UserComments: string
  Maximum Length: 2000

  Comments added by the user.

{
    "required":[
        "ActiveIndicator",
        "AssociationModeCode",
        "AssociationStatusCode",
        "EnteredDate",
        "InvoiceAmount",
        "InvoiceCurrencyCode",
        "InvoiceId",
        "InvoiceLineNumber",
        "TradeOperationChargeId"
    ],
    "type":"object",
    "properties":{
        "ActiveIndicator":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates the most recent record for the charge invoice association.",
            "nullable":false
        },
        "AssociationModeCode":{
            "type":"number",
            "description":"Abbreviation that identifies the mode of the invoice association.",
            "nullable":false,
            "x-hints":{
                "precision":3
            }
        },
        "AssociationStatusCode":{
            "type":"number",
            "description":"Abbreviation that uniquely identifies the status of the invoice association with the charge line. Valid values include Needs Review, Deleted, Rejected, and Associated.",
            "nullable":false,
            "x-hints":{
                "precision":3
            }
        },
        "ChargeInvoiceAssociationId":{
            "type":"integer",
            "description":"Unique identifier for a charge invoice association.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "EnteredDate":{
            "type":"string",
            "description":"Date on which the actual amount for charges are established or canceled.",
            "format":"date-time",
            "nullable":false
        },
        "ExternalSystemReference":{
            "maxLength":60,
            "type":"string",
            "description":"Identifier of the source system that owns the invoice entity.",
            "nullable":true
        },
        "FunctionalCurrencyAmount":{
            "type":"number",
            "description":"Amount on the invoice line in the functional currency of the invoice.",
            "nullable":true
        },
        "FunctionalCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Abbreviation that identifies the functional currency.",
            "nullable":true
        },
        "FunctionalCurrencyTax":{
            "type":"number",
            "description":"Nonrecoverable tax on the invoice line in the invoice functional currency.",
            "nullable":true
        },
        "InvoiceAmount":{
            "type":"number",
            "description":"Amount on the invoice line.",
            "nullable":false
        },
        "InvoiceCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Abbreviation that identifies the invoice currency.",
            "nullable":false
        },
        "InvoiceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the invoice.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "InvoiceLineNumber":{
            "type":"integer",
            "description":"Number that identifies a line on the invoice.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "InvoiceTax":{
            "type":"number",
            "description":"Nonrecoverable Tax in Invoice Currency",
            "nullable":true
        },
        "Rank":{
            "type":"integer",
            "description":"Indicates the rank of the potential matches.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TradeOperationChargeId":{
            "type":"integer",
            "description":"Unique identifier of the trade operation charge.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "UserComments":{
            "maxLength":2000,
            "type":"string",
            "description":"Comments added by the user.",
            "nullable":true
        },
        "chargeAssociationDetails":{
            "title":"Association Details with Trade Operation Charge Lines",
            "type":"array",
            "description":"Association details for matching the invoice line to the trade operation charge line.",
            "items":{
                "$ref":"#/components/schemas/invoiceLinesForLandedCosts-chargeAssociations-chargeAssociationDetails-item-post-request"
            }
        }
    }
}

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

• Array of: object invoiceLinesForLandedCosts-chargeAssociations-chargeAssociationDetails-item-post-request

{
    "title":"Association Details with Trade Operation Charge Lines",
    "type":"array",
    "description":"Association details for matching the invoice line to the trade operation charge line.",
    "items":{
        "$ref":"#/components/schemas/invoiceLinesForLandedCosts-chargeAssociations-chargeAssociationDetails-item-post-request"
    }
}

Nested Schema : invoiceLinesForLandedCosts-chargeAssociations-chargeAssociationDetails-item-post-request

Type: object

Show Source

• 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.
• 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.
• InvoiceLineChargeId: integer (int64)
  Unique identifier of the charge associated with the charge 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.
• MatchStatusCode: number
  Abbreviation that defines whether the status of the association is matched or unmatched.
• ReferenceTypeId: integer (int64)
  Trade Operation Charge Reference Type ID

{
    "type":"object",
    "properties":{
        "AssociationAttributeType":{
            "type":"number",
            "description":"Association Attributes",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":3
            }
        },
        "ChargeInvoiceAssociationDetailsId":{
            "type":"integer",
            "description":"Unique identifier of a charge invoice association detail.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ChargeInvoiceAssociationId":{
            "type":"integer",
            "description":"Unique identifier of a charge invoice association.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ChargeLineChargeId":{
            "type":"integer",
            "description":"Unique identifier of the charge associated with charge line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ChargeLineReferenceValueNumber":{
            "type":"number",
            "description":"Number type reference value associated with the charge line.",
            "nullable":true
        },
        "ChargeLineReferenceValueString":{
            "maxLength":64,
            "type":"string",
            "description":"String type reference value associated with the charge line.",
            "nullable":true
        },
        "ChargeLineReferenceValueTimestamp":{
            "type":"string",
            "description":"Date type reference value associated with the charge line.",
            "format":"date-time",
            "nullable":true
        },
        "ChargeLineSupplierId":{
            "type":"integer",
            "description":"Unique identifier of the supplier associated with the charge line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ChargeLineSupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site associated with the charge line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "InvoiceLineChargeId":{
            "type":"integer",
            "description":"Unique identifier of the charge associated with the charge line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "InvoiceLineReferenceValueNumber":{
            "type":"number",
            "description":"Number type reference value associated with the invoice line.",
            "nullable":true
        },
        "InvoiceLineReferenceValueString":{
            "maxLength":64,
            "type":"string",
            "description":"String type reference value associated with the invoice line.",
            "nullable":true
        },
        "InvoiceLineReferenceValueTimestamp":{
            "type":"string",
            "description":"Date type reference value associated with the invoice line.",
            "format":"date-time",
            "nullable":true
        },
        "InvoiceLineSupplierId":{
            "type":"integer",
            "description":"Unique identifier of the supplier associated with the invoice line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "InvoiceLineSupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site associated with the invoice line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "MatchStatusCode":{
            "type":"number",
            "description":"Abbreviation that defines whether the status of the association is matched or unmatched.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":3
            }
        },
        "ReferenceTypeId":{
            "type":"integer",
            "description":"Trade Operation Charge Reference Type ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        }
    }
}

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 : invoiceLinesForLandedCosts-chargeAssociations-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "ActiveIndicator":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates the most recent record for the charge invoice association.",
            "nullable":false,
            "x-queryable":true
        },
        "AssociationDetails":{
            "maxLength":255,
            "type":"string",
            "description":"Defines the results of the association process.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssociationMode":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the mode of invoice association.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssociationModeCode":{
            "type":"number",
            "description":"Abbreviation that identifies the mode of the invoice association.",
            "nullable":false,
            "x-hints":{
                "precision":3
            },
            "x-queryable":true
        },
        "AssociationStatus":{
            "maxLength":255,
            "type":"string",
            "description":"Identifies the status of the association of the invoice with the charge line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssociationStatusCode":{
            "type":"number",
            "description":"Abbreviation that uniquely identifies the status of the invoice association with the charge line. Valid values include Needs Review, Deleted, Rejected, and Associated.",
            "nullable":false,
            "x-hints":{
                "precision":3
            },
            "x-queryable":true
        },
        "ChargeCurrencyEnteredAmount":{
            "type":"number",
            "description":"Entered amount in the charge currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeCurrencyTotal":{
            "type":"number",
            "description":"Total amount in the charge currency.",
            "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 for the charge in the invoice line.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChargeInvoiceAssociationId":{
            "type":"integer",
            "description":"Unique identifier for a charge invoice association.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ChargeLineNumber":{
            "type":"integer",
            "description":"Number that identifies the charge line.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ChargeLineStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the status of the charge line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the charge given on the invoice line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeRequistionBUCurrencyConversionRate":{
            "type":"number",
            "description":"Currency conversion rate for the requisition BU.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EnteredCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Abbreviation that identifies the entered currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EnteredCurrencyPrecision":{
            "title":"Precision",
            "type":"integer",
            "description":"Value that identifies the currency precision.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "default":2,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "EnteredDate":{
            "type":"string",
            "description":"Date on which the actual amount for charges are established or canceled.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "ExternalSystemReference":{
            "maxLength":60,
            "type":"string",
            "description":"Identifier of the source system that owns the invoice entity.",
            "nullable":true,
            "x-queryable":true
        },
        "FunctionalCurrencyAmount":{
            "type":"number",
            "description":"Amount on the invoice line in the functional currency of the invoice.",
            "nullable":true,
            "x-queryable":true
        },
        "FunctionalCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Abbreviation that identifies the functional currency.",
            "nullable":true,
            "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
        },
        "FunctionalCurrencyTax":{
            "type":"number",
            "description":"Nonrecoverable tax on the invoice line in the invoice functional currency.",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceAmount":{
            "type":"number",
            "description":"Amount on the invoice line.",
            "nullable":false,
            "x-queryable":true
        },
        "InvoiceCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Abbreviation that identifies the invoice currency.",
            "nullable":false,
            "x-queryable":true
        },
        "InvoiceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the invoice.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InvoiceLineNumber":{
            "type":"integer",
            "description":"Number that identifies a line on the invoice.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InvoiceTax":{
            "type":"number",
            "description":"Nonrecoverable Tax in Invoice Currency",
            "nullable":true,
            "x-queryable":true
        },
        "NonrecoverableTax":{
            "type":"number",
            "description":"Nonrecoverable tax on the invoice line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"Value that identifies the third-party supplier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyName":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"Value that indicates the supplier on the invoice.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Rank":{
            "type":"integer",
            "description":"Indicates the rank of the potential matches.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RequisitionBUCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Currency code of the requisition BU.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequisitionBUCurrencyPrecision":{
            "title":"Precision",
            "type":"integer",
            "description":"Currency precision of the requisition BU.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "default":2,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "TradeOperationChargeId":{
            "type":"integer",
            "description":"Unique identifier of the trade operation charge.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TradeOperationId":{
            "type":"integer",
            "description":"Unique identifier of the trade operation.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TradeOperationName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the trade operation associated with the charge invoice.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TradeOperationNumber":{
            "maxLength":40,
            "type":"string",
            "description":"Number that indicates the trade operation associated with the charge invoice.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TradeOperationStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the status of the trade operation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TradeoperationChargeEstimateId":{
            "type":"integer",
            "description":"Unique identifier of the trade operation charge estimate.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UserComments":{
            "maxLength":2000,
            "type":"string",
            "description":"Comments added by the user.",
            "nullable":true,
            "x-queryable":true
        },
        "VendorId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier rendering the service.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "VendorSiteCode":{
            "title":"Site",
            "maxLength":240,
            "type":"string",
            "description":"Name of the supplier site on the invoice.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "VendorSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site rendering the service.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "chargeAssociationDetails":{
            "title":"Association Details with Trade Operation Charge Lines",
            "type":"array",
            "description":"Association details for matching the invoice line to the trade operation charge line.",
            "items":{
                "$ref":"#/components/schemas/invoiceLinesForLandedCosts-chargeAssociations-chargeAssociationDetails-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

• Array of: object invoiceLinesForLandedCosts-chargeAssociations-chargeAssociationDetails-item-response

{
    "title":"Association Details with Trade Operation Charge Lines",
    "type":"array",
    "description":"Association details for matching the invoice line to the trade operation charge line.",
    "items":{
        "$ref":"#/components/schemas/invoiceLinesForLandedCosts-chargeAssociations-chargeAssociationDetails-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 : invoiceLinesForLandedCosts-chargeAssociations-chargeAssociationDetails-item-response

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "AssociationAttribute":{
            "maxLength":255,
            "type":"string",
            "description":"Attribute used for associating invoices and charge lines.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssociationAttributeType":{
            "type":"number",
            "description":"Association Attributes",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":3
            },
            "x-queryable":true
        },
        "ChargeInvoiceAssociationDetailsId":{
            "type":"integer",
            "description":"Unique identifier of a charge invoice association detail.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChargeInvoiceAssociationId":{
            "type":"integer",
            "description":"Unique identifier of a charge invoice association.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChargeLineChargeId":{
            "type":"integer",
            "description":"Unique identifier of the charge associated with charge line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChargeLineChargeName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the charge associated with charge line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeLinePartyId":{
            "type":"integer",
            "description":"Value that uniquely identifies the third-party supplier associated with charge line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeLinePartyName":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"Third-party supplier name associated with the charge line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeLineReferenceValueNumber":{
            "type":"number",
            "description":"Number type reference value associated with the charge line.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeLineReferenceValueString":{
            "maxLength":64,
            "type":"string",
            "description":"String type reference value associated with the charge line.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeLineReferenceValueTimestamp":{
            "type":"string",
            "description":"Date type reference value associated with the charge line.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeLineSupplierId":{
            "type":"integer",
            "description":"Unique identifier of the supplier associated with the charge line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChargeLineSupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site associated with the charge line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChargeLineVendorId":{
            "type":"integer",
            "description":"Unique identifier of the supplier associated with the charge line.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChargeLineVendorSiteCode":{
            "title":"Site",
            "maxLength":240,
            "type":"string",
            "description":"Name of the supplier site associated with charge line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeLineVendorSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site associated with the charge line.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChargeReferenceTypeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the reference type associated with the charge line.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChargeReferenceTypeName":{
            "maxLength":100,
            "type":"string",
            "description":"Name of the reference type associated with the charge line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeReferenceValueDataType":{
            "maxLength":30,
            "type":"string",
            "description":"Reference data type associated with the charge line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplayAttributeType":{
            "maxLength":255,
            "type":"string",
            "description":"Value that indicates the attribute type for the association details.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InvoiceLineChargeId":{
            "type":"integer",
            "description":"Unique identifier of the charge associated with the charge line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InvoiceLineChargeName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the charge associated with the invoice line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InvoiceLinePartyId":{
            "type":"integer",
            "description":"Value that uniquely identifies the third-party supplier associated with the invoice line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InvoiceLinePartyName":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"Third-party supplier name associated with the invoice line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InvoiceLineReferenceValueNumber":{
            "type":"number",
            "description":"Number type reference value associated with the invoice line.",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceLineReferenceValueString":{
            "maxLength":64,
            "type":"string",
            "description":"String type reference value associated with the invoice line.",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceLineReferenceValueTimestamp":{
            "type":"string",
            "description":"Date type reference value associated with the invoice line.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceLineSupplierId":{
            "type":"integer",
            "description":"Unique identifier of the supplier associated with the invoice line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InvoiceLineSupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site associated with the invoice line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InvoiceLineVendorId":{
            "type":"integer",
            "description":"Unique identifier of the supplier associated with the invoice line.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InvoiceLineVendorSiteCode":{
            "title":"Site",
            "maxLength":240,
            "type":"string",
            "description":"Name of the supplier site associated with the invoice line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InvoiceLineVendorSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site associated with the invoice line.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MatchStatus":{
            "maxLength":255,
            "type":"string",
            "description":"Match Status",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "MatchStatusCode":{
            "type":"number",
            "description":"Abbreviation that defines whether the status of the association is matched or unmatched.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":3
            },
            "x-queryable":true
        },
        "ReferenceTypeId":{
            "type":"integer",
            "description":"Trade Operation Charge Reference Type ID",
            "format":"int64",
            "nullable":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."
        }
    }
}

Links

chargeAssociationDetails

Operation: /fscmRestApi/resources/11.13.18.05/invoiceLinesForLandedCosts/{invoiceLinesForLandedCostsUniqID}/child/chargeAssociations/{ChargeInvoiceAssociationId}/child/chargeAssociationDetails

Parameters:

• ChargeInvoiceAssociationId: $request.path.ChargeInvoiceAssociationId
• invoiceLinesForLandedCostsUniqID: $request.path.invoiceLinesForLandedCostsUniqID

Association details for matching the invoice line to the trade operation charge line.

confirmAssociation

Operation: /fscmRestApi/resources/11.13.18.05/invoiceLinesForLandedCosts/{invoiceLinesForLandedCostsUniqID}/child/chargeAssociations/{ChargeInvoiceAssociationId}/action/confirmAssociation

Parameters:

• ChargeInvoiceAssociationId: $request.path.ChargeInvoiceAssociationId
• invoiceLinesForLandedCostsUniqID: $request.path.invoiceLinesForLandedCostsUniqID

Changes the status of the trade operation charge line to confirmed.

deleteAssociation

Operation: /fscmRestApi/resources/11.13.18.05/invoiceLinesForLandedCosts/{invoiceLinesForLandedCostsUniqID}/child/chargeAssociations/{ChargeInvoiceAssociationId}/action/deleteAssociation

Parameters:

• ChargeInvoiceAssociationId: $request.path.ChargeInvoiceAssociationId
• invoiceLinesForLandedCostsUniqID: $request.path.invoiceLinesForLandedCostsUniqID

Changes the status of the trade operation charge line to deleted.

Back to Top