Jump to

• Request
• Response

Get all invoices

get

/fscmRestApi/resources/11.13.18.05/invoicesForLandedCostChargeRequests

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 Find invoices for landed cost charges according to the primary key.
    Finder Variables
    • InvoiceId; integer; Value that uniquely identifies an invoice. This values is a composite key.
    • InvoiceLineNumber; string; Number that uniquely identifies an invoice. This values is a composite key.
  • findInvoicesForCharges Finds invoice for landed cost charges according to the specified attributes.
    Finder Variables
    • bindAssociationMode; string; Mode of association of invoice to a trade operation charge.
    • bindAssociationStatus; string; Status of the invoice association to the charge.
    • bindChargeBU; string; Business unit of charge associated with an invoice.
    • bindChargeName; string; Name of the charge associated with an invoice.
    • bindChargeReferenceName; string; Name of the charge reference type.
    • bindChargeReferencePredefined; string; Value that indicates whether a charge has a predefined charge reference or not.
    • bindInvoiceAmount; number; Amount incurred on the invoice.
    • bindInvoiceCreationDate; string; Date when the invoice was created.
    • bindInvoiceCurrency; string; Currency on the invoice amount.
    • bindInvoiceLineNumber; string; Number that identifies a line on the invoice.
    • bindInvoiceNrTaxAmount; number; Amount of nonrecoverable tax incurred on the invoice.
    • bindInvoiceNumber; string; Number that identifies the invoice.
    • bindMissingChargeNames; string; Value that indicates the missing charge names on the invoice.
    • bindMissingChargeReferences; string; Value to show missing charge references on the invoice.
    • bindProcurementBU; string; Name of the procurement business unit on the invoice.
    • bindReferenceValueDate; string; Date value of the charge reference.
    • bindReferenceValueNumber; number; Number that identifies the charge reference.
    • bindReferenceValueText; string; Text of the charge reference.
    • bindSupplier; string; Name of the supplier on the invoice.
    • bindSupplierSite; string; Name of the supplier site on the invoice.
    • bindTradeOperationName; string; Name of the trade operation.
    • bindTradeOperationNumber; string; Number that identifies the trade operation within a procurement business unit.
• 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; Mode by which the invoice line is associated with the charge line. Valid values include Automatic and Manual.
  • AssociationModeCode; number; Value that identifies the mode of invoice association.
  • AssociationStatus; string; Abbreviation that uniquely identifies the status of the invoice association with the charge line. Valid values include Needs Review, Deleted, Rejected, and Associated.
  • ChargeBU; string; Value that indicates the requisitioning business unit that incurs the charge.
  • ChargeBUId; integer; Value that uniquely identifies the business unit associated with the trade operation charge.
  • ChargeCode; string; Abbreviation that identifies the landed cost charge.
  • ChargeId; integer; Value that uniquely identifies the trade operation charge.
  • ChargeName; string; Name of the charge given on the invoice line.
  • InvoiceAmount; number; Amount on the invoice distribution.
  • InvoiceCreationDate; string; Date when the supplier raised the invoice.
  • InvoiceCurrency; string; Currency on the invoice.
  • InvoiceCurrencyCode; string; Abbreviation that identifies the invoice currency.
  • InvoiceId; integer; Value that uniquely identifies the invoice.
  • InvoiceLineNumber; string; Number that identifies a line on the invoice.
  • InvoiceLineType; string; Value that identifies the type of invoice line, including categories such as Item, Freight, Tax, and Miscellaneous.
  • InvoiceNonrecoverableTaxAmount; number; Amount of nonrecoverable tax on the invoice distribution.
  • InvoiceNumber; string; Number that identifies the invoice.
  • MissingChargeReferences; string; Contains one of the following values: true or false. If true, then invoice lines are missing charge references. If false, then invoice lines contain charge references. The default value is null.
  • ProcurementBU; string; Value that indicates the procurement business unit on the invoice line.
  • ProcurementBUId; integer; Value that uniquely identifies the procurement business unit.
  • Supplier; string; Value that indicates the supplier on the invoice.
  • SupplierId; integer; Value that uniquely identifies the supplier rendering the service.
  • SupplierSite; string; Value that indicates the supplier site on the charge line.
  • SupplierSiteId; integer; Value that uniquely identifies the supplier site rendering the service.
  • TradeOperationName; string; Name of the trade operation associated with the charge invoice.
  • TradeOperationNumber; string; Number that indicates the trade operation associated with the charge invoice.
• 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:
  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 : invoicesForLandedCostChargeRequests

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/invoicesForLandedCostChargeRequests-item-response"
            }
        }
    },
    "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 invoicesForLandedCostChargeRequests-item-response

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

Type: object

Show Source

• AssociationMode: string
  Title: Association Mode

  Read Only: true

  Maximum Length: 255

  Mode by which the invoice line is associated with the charge line. Valid values include Automatic and Manual.
• AssociationModeCode: number
  Title: Association Mode Code

  Read Only: true

  Value that identifies the mode of invoice association.
• AssociationStatus: string
  Title: Association Status

  Read Only: true

  Maximum Length: 80

  Abbreviation that uniquely identifies the status of the invoice association with the charge line. Valid values include Needs Review, Deleted, Rejected, and Associated.
• ChargeBU: string
  Title: Charge BU

  Read Only: true

  Maximum Length: 240

  Value that indicates the requisitioning business unit that incurs the charge.
• ChargeBUId: integer (int64)
  Title: Charge Business Unit ID

  Value that uniquely identifies the business unit associated with the trade operation charge.
• ChargeCode: string
  Title: Charge Code

  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the landed cost charge.
• ChargeId: integer (int64)
  Title: Charge ID

  Value that uniquely identifies the trade operation charge.
• ChargeName: string
  Title: Charge Name

  Read Only: true

  Maximum Length: 80

  Name of the charge given on the invoice line.
• InvoiceAmount: number
  Title: Amount

  Read Only: true

  Amount on the invoice distribution.
• InvoiceCreationDate: string (date-time)
  Title: Invoice Date

  Read Only: true

  Date when the supplier raised the invoice.
• InvoiceCurrency: string
  Title: Currency Name

  Read Only: true

  Maximum Length: 80

  Currency on the invoice.
• InvoiceCurrencyCode: string
  Title: Currency Code

  Read Only: true

  Maximum Length: 15

  Abbreviation that identifies the invoice currency.
• InvoiceId: integer (int64)
  Title: Invoice ID

  Read Only: true

  Value that uniquely identifies the invoice.
• InvoiceLineNumber: string
  Title: Invoice Line Number

  Read Only: true

  Maximum Length: 40

  Number that identifies a line on the invoice.
• InvoiceLineType: string
  Title: Line Type

  Read Only: true

  Maximum Length: 30

  Value that identifies the type of invoice line, including categories such as Item, Freight, Tax, and Miscellaneous.
• InvoiceNonrecoverableTaxAmount: number
  Title: Nonrecoverable Tax

  Read Only: true

  Amount of nonrecoverable tax on the invoice distribution.
• InvoiceNumber: string
  Title: Invoice Number

  Read Only: true

  Maximum Length: 50

  Number that identifies the invoice.
• landedCostChargeReferencesForInvoiceLinesV2: array Charge References
  Title: Charge References

  The Charge References resource manages the charge references on the charge used for an invoice association.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MissingChargeReferences: string
  Title: Show Only Invoices Missing Reference Types

  Read Only: true

  Maximum Length: 255

  Contains one of the following values: true or false. If true, then invoice lines are missing charge references. If false, then invoice lines contain charge references. The default value is null.
• ProcurementBU: string
  Title: Procurement BU

  Read Only: true

  Maximum Length: 240

  Value that indicates the procurement business unit on the invoice line.
• ProcurementBUId: integer (int64)
  Title: Procurement Business Unit ID

  Read Only: true

  Value that uniquely identifies the procurement business unit.
• Supplier: string
  Title: Supplier

  Read Only: true

  Maximum Length: 360

  Value that indicates the supplier on the invoice.
• SupplierId: integer (int64)
  Title: Supplier ID

  Read Only: true

  Value that uniquely identifies the supplier rendering the service.
• SupplierSite: string
  Title: Supplier Site

  Read Only: true

  Maximum Length: 240

  Value that indicates the supplier site on the charge line.
• SupplierSiteId: integer (int64)
  Title: Supplier Site ID

  Read Only: true

  Value that uniquely identifies the supplier site rendering the service.
• TradeOperationName: string
  Title: Trade Operation Name

  Read Only: true

  Maximum Length: 80

  Name of the trade operation associated with the charge invoice.
• TradeOperationNumber: string
  Title: Trade Operation Number

  Read Only: true

  Maximum Length: 40

  Number that indicates the trade operation associated with the charge invoice.

{
    "type":"object",
    "properties":{
        "InvoiceLineNumber":{
            "title":"Invoice Line Number",
            "maxLength":"40",
            "type":"string",
            "description":"Number that identifies a line on the invoice.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "landedCostChargeReferencesForInvoiceLinesV2":{
            "title":"Charge References",
            "type":"array",
            "description":"The Charge References resource manages the charge references on the charge used for an invoice association.",
            "items":{
                "$ref":"#/components/schemas/invoicesForLandedCostChargeRequests-landedCostChargeReferencesForInvoiceLinesV2-item-response"
            }
        },
        "InvoiceCreationDate":{
            "title":"Invoice Date",
            "type":"string",
            "description":"Date when the supplier raised the invoice.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InvoiceLineType":{
            "title":"Line Type",
            "maxLength":"30",
            "type":"string",
            "description":"Value that identifies the type of invoice line, including categories such as Item, Freight, Tax, and Miscellaneous.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InvoiceAmount":{
            "title":"Amount",
            "type":"number",
            "description":"Amount on the invoice distribution.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InvoiceId":{
            "title":"Invoice ID",
            "type":"integer",
            "description":"Value that uniquely identifies the invoice.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AssociationModeCode":{
            "title":"Association Mode Code",
            "type":"number",
            "description":"Value that identifies the mode of invoice association.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"3"
            },
            "x-queryable":true
        },
        "ChargeBU":{
            "title":"Charge BU",
            "maxLength":"240",
            "type":"string",
            "description":"Value that indicates the requisitioning business unit that incurs the charge.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierSiteId":{
            "title":"Supplier Site ID",
            "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"
            }
        },
        "Supplier":{
            "title":"Supplier",
            "maxLength":"360",
            "type":"string",
            "description":"Value that indicates the supplier on the invoice.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InvoiceNumber":{
            "title":"Invoice Number",
            "maxLength":"50",
            "type":"string",
            "description":"Number that identifies the invoice.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssociationStatus":{
            "title":"Association Status",
            "maxLength":"80",
            "type":"string",
            "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,
            "readOnly":true,
            "x-queryable":true
        },
        "InvoiceCurrency":{
            "title":"Currency Name",
            "maxLength":"80",
            "type":"string",
            "description":"Currency on the invoice.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MissingChargeReferences":{
            "title":"Show Only Invoices Missing Reference Types",
            "maxLength":"255",
            "type":"string",
            "description":"Contains one of the following values: true or false. If true, then invoice lines are missing charge references. If false, then invoice lines contain charge references. The default value is null.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcurementBU":{
            "title":"Procurement BU",
            "maxLength":"240",
            "type":"string",
            "description":"Value that indicates the procurement business unit on the invoice line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcurementBUId":{
            "title":"Procurement Business Unit ID",
            "type":"integer",
            "description":"Value that uniquely identifies the procurement business unit.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AssociationMode":{
            "title":"Association Mode",
            "maxLength":"255",
            "type":"string",
            "description":"Mode by which the invoice line is associated with the charge line. Valid values include Automatic and Manual.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeName":{
            "title":"Charge Name",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the charge given on the invoice line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TradeOperationNumber":{
            "title":"Trade Operation Number",
            "maxLength":"40",
            "type":"string",
            "description":"Number that indicates the trade operation associated with the charge invoice.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeBUId":{
            "title":"Charge Business Unit ID",
            "type":"integer",
            "description":"Value that uniquely identifies the business unit associated with the trade operation charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "fnd:APPLCORE_SETID_DETERMINANT_TYPE":"BU"
            },
            "x-queryable":true
        },
        "InvoiceNonrecoverableTaxAmount":{
            "title":"Nonrecoverable Tax",
            "type":"number",
            "description":"Amount of nonrecoverable tax on the invoice distribution.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeCode":{
            "title":"Charge Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the landed cost charge.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierId":{
            "title":"Supplier ID",
            "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
        },
        "SupplierSite":{
            "title":"Supplier Site",
            "maxLength":"240",
            "type":"string",
            "description":"Value that indicates the supplier site on the charge line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TradeOperationName":{
            "title":"Trade Operation Name",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the trade operation associated with the charge invoice.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeId":{
            "title":"Charge ID",
            "type":"integer",
            "description":"Value that uniquely identifies the trade operation charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "fnd:APPLCORE_SETID_DETERMINANT_ATTR":"PrcBuId"
            },
            "x-queryable":true
        },
        "InvoiceCurrencyCode":{
            "title":"Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"Abbreviation that identifies the invoice currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Charge References

Type: array

Title: Charge References

The Charge References resource manages the charge references on the charge used for an invoice association.

Show Source

• Array of: object invoicesForLandedCostChargeRequests-landedCostChargeReferencesForInvoiceLinesV2-item-response

{
    "title":"Charge References",
    "type":"array",
    "description":"The Charge References resource manages the charge references on the charge used for an invoice association.",
    "items":{
        "$ref":"#/components/schemas/invoicesForLandedCostChargeRequests-landedCostChargeReferencesForInvoiceLinesV2-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 : invoicesForLandedCostChargeRequests-landedCostChargeReferencesForInvoiceLinesV2-item-response

Type: object

Show Source

• ChargeReferenceDataType: string
  Title: Reference Data Type

  Value that defines the type of input data for charge reference.
• ChargeReferenceName: string
  Title: Charge Reference Name

  Name of the charge reference type.
• ChargeReferencePredefined: string
  Title: Predefined

  Read Only: true

  Maximum Length: 255

  Contains one of the following values: true or false. If true, then the reference type is predefined in the default charge references setup. If false, then the reference type isn't predefined. The default value is false.
• ChargeReferenceTypeId: integer (int64)
  Title: Charge Reference Type ID

  Value that uniquely identifies the type of charge reference.
• ChargeReferenceValueDataType: string
  Title: Reference Data Type

  Read Only: true

  Maximum Length: 80

  Value that identifies the type of input data for charge references.
• InvoiceChargeReferenceId: integer (int64)
  Title: Invoice Charge Reference ID

  Value that uniquely identifies the invoice charge reference.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProcurementBU: string
  Title: Procurement BU

  Read Only: true

  Maximum Length: 240

  Value that indicates the procurement business unit on the charge reference.
• ProcurementBUId: integer (int64)
  Title: Procurement Business Unit ID

  Value that uniquely identifies the procurement business unit for a charge reference.
• ReferenceValueDate: string (date-time)
  Title: Date Reference

  Date value of the charge reference.
• ReferenceValueNumber: number
  Title: Numeric Reference

  Number that identifies the charge reference.
• ReferenceValueText: string
  Title: Alphanumeric Reference

  Maximum Length: 64

  Text of the charge reference.
• UserComment: string
  Title: Comments

  Maximum Length: 240

  Comments added by the user for the charge reference.

{
    "type":"object",
    "properties":{
        "ProcurementBU":{
            "title":"Procurement BU",
            "maxLength":"240",
            "type":"string",
            "description":"Value that indicates the procurement business unit on the charge reference.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcurementBUId":{
            "title":"Procurement Business Unit ID",
            "type":"integer",
            "description":"Value that uniquely identifies the procurement business unit for a charge reference.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReferenceValueText":{
            "title":"Alphanumeric Reference",
            "maxLength":"64",
            "type":"string",
            "description":"Text of the charge reference.",
            "nullable":true,
            "x-queryable":true
        },
        "ReferenceValueNumber":{
            "title":"Numeric Reference",
            "type":"number",
            "description":"Number that identifies the charge reference.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "UserComment":{
            "title":"Comments",
            "maxLength":"240",
            "type":"string",
            "description":"Comments added by the user for the charge reference.",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceChargeReferenceId":{
            "title":"Invoice Charge Reference ID",
            "type":"integer",
            "description":"Value that uniquely identifies the invoice charge reference.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ChargeReferenceValueDataType":{
            "title":"Reference Data Type",
            "maxLength":"80",
            "type":"string",
            "description":"Value that identifies the type of input data for charge references.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeReferenceTypeId":{
            "title":"Charge Reference Type ID",
            "type":"integer",
            "description":"Value that uniquely identifies the type of charge reference.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:APPLCORE_SETID_DETERMINANT_ATTR":"PrcBuId"
            },
            "x-queryable":true
        },
        "ChargeReferenceDataType":{
            "title":"Reference Data Type",
            "type":"string",
            "description":"Value that defines the type of input data for charge reference.",
            "nullable":true,
            "x-queryable":false
        },
        "ChargeReferencePredefined":{
            "title":"Predefined",
            "maxLength":"255",
            "type":"string",
            "description":"Contains one of the following values: true or false. If true, then the reference type is predefined in the default charge references setup. If false, then the reference type isn't predefined. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ChargeReferenceName":{
            "title":"Charge Reference Name",
            "type":"string",
            "description":"Name of the charge reference type.",
            "nullable":true,
            "x-queryable":true
        },
        "ReferenceValueDate":{
            "title":"Date Reference",
            "type":"string",
            "description":"Date value of the charge reference.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "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