Jump to

• Request
• Response
• Examples

Get all receipts for an item

get

/fscmRestApi/resources/11.13.18.05/receiptCosts

Request

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • PrimaryKey Finds receipts according to the primary key.
    Finder Variables
    • TransactionId; integer; Indicates the transaction identifier of the transaction.
  • findReceiptsWithActualCost Finds receipts with the actual cost.
    Finder Variables
    • bindCostBook; string; Name of the cost book.
    • bindCostOrgName; string; Name of the cost organization.
    • bindCostProfile; string; Value that identifies the cost profile.
    • bindItem; string; Name of the item.
    • bindItemId; integer; Unique identifier for the item.
    • bindReceiptNumber; string; Value that uniquely identifies the receipt transaction.
    • bindReferenceNumber; string; Reference document number.
    • bindTxnTypeName; string; Name of the base transaction type.
    • bindValuationUnit; string; Name of the valuation unit.
  • findReceiptsWithCost Finds receipts that have a cost associated with them.
    Finder Variables
    • bindCostBook; string; Name of the cost book.
    • bindCostOrgName; string; Name of the cost organization.
    • bindCostProfile; string; Value that identifies the cost profile.
    • bindItem; string; Name of the item.
    • bindItemId; integer; Unique identifier for the item.
    • bindReceiptNumber; string; Value that uniquely identifies the receipt transaction.
    • bindReferenceNumber; string; Reference document number.
    • bindTxnTypeName; string; Transaction type name.
    • bindValuationUnit; string; Name of the valuation unit.
  • findReceiptsWithNoCost Finds receipts that have no cost.
    Finder Variables
    • bindCostBook; string; Name of the cost book.
    • bindCostOrgName; string; Name of the cost organization.
    • bindCostProfile; string; Value that identifies the cost profile.
    • bindItem; string; Name of the item.
    • bindItemId; integer; Unique identifier for the item.
    • bindReceiptNumber; string; Value that uniquely identifies the receipt transaction.
    • bindReferenceNumber; string; Reference document number.
    • bindTxnTypeName; string; Transaction type name.
    • bindValuationUnit; string; Name of the valuation 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:
  

  • CostBook; string; User-defined description of the cost book.
  • CostBookId; integer; Code for the valuation unit.
  • CostDate; string; Transaction cost date.
  • CostEffectiveDate; string; Date from which cost is effective.
  • CostOrganizationId; integer; Unique identifier for the cost organization.
  • CostOrganizationName; string; Name of the cost organization.
  • CostProfile; string; Value that identifies the cost profile.
  • CostProfileId; integer; Value that identifies the cost profile.
  • CurrencyCode; string; Indicates the currency code in which the cost is stored.
  • InventoryOrganizationId; integer; Unique identifier for the inventory organization.
  • InventoryOrganizationName; string; Indicates the name for the inventory organization associated with the cost organization.
  • Item; string; Inventory item name.
  • ItemId; integer; Unique item identifier
  • QuantityOnhand; number; Quantity on hand at the valuation unit.
  • ReceiptNumber; string; Receipt transaction number.
  • ReceiptQuantity; number; Receipt quantity.
  • ReferenceNumber; string; A unique reference number added by the user to identify the adjustment.
  • TotalUnitCost; number; Total unit cost for the adjustment transaction, which is the sum of the unit cost of all the cost elements.
  • TransactionId; integer; Indicates the transaction identifier of the transaction.
  • TransactionTypeName; string; Name of the transaction type.
  • UOMCode; string; Indicates the costing unit of measure code.
  • UOMName; string; Indicates the costing unit of measure.
  • ValuationUnit; string; Code for the valuation unit.
  • ValuationUnitId; integer; Indicates the valuation unit identifier used for the transaction.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : receiptCosts

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/receiptCosts-item-response"
            }
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    },
    "x-hints":{
        "subgroup":"InventoryManagement",
        "usage":"BusinessObject",
        "group":"SCM"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object receiptCosts-item-response

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

Type: object

Show Source

• CostBook: string
  Title: Cost Book

  Read Only: true

  Maximum Length: 30

  User-defined description of the cost book.
• CostBookId: integer (int64)
  Title: Cost Book ID

  Read Only: true

  Code for the valuation unit.
• CostDate: string (date-time)
  Title: Cost Date

  Read Only: true

  Transaction cost date.
• CostEffectiveDate: string (date-time)
  Title: Effective Date

  Read Only: true

  Date from which cost is effective.
• CostOrganizationId: integer (int64)
  Title: Cost Organization ID

  Read Only: true

  Unique identifier for the cost organization.
• CostOrganizationName: string
  Title: Cost Organization Name

  Read Only: true

  Maximum Length: 240

  Name of the cost organization.
• CostProfile: string
  Title: Cost Profile

  Read Only: true

  Maximum Length: 30

  Value that identifies the cost profile.
• CostProfileId: integer (int64)
  Title: Cost Profile ID

  Read Only: true

  Value that identifies the cost profile.
• CurrencyCode: string
  Title: Currency Code

  Read Only: true

  Maximum Length: 15

  Indicates the currency code in which the cost is stored.
• InventoryOrganizationId: integer (int64)
  Title: Inventory Organization ID

  Read Only: true

  Unique identifier for the inventory organization.
• InventoryOrganizationName: string
  Title: Inventory Organization Name

  Read Only: true

  Maximum Length: 240

  Indicates the name for the inventory organization associated with the cost organization.
• Item: string
  Title: Item

  Read Only: true

  Maximum Length: 300

  Inventory item name.
• ItemId: integer (int64)
  Title: Item ID

  Read Only: true

  Unique item identifier
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• QuantityOnhand: number
  Title: Remaining Receipt Quantity

  Read Only: true

  Quantity on hand at the valuation unit.
• ReceiptCostDetails: array Receipt Cost Adjustment Details
  Title: Receipt Cost Adjustment Details

  Costs associated with a receipt are adjusted through a receipt cost adjustment. Receipt cost details include the cost elements associated with it and their individual costs.
• ReceiptNumber: string
  Title: Receipt Number

  Read Only: true

  Maximum Length: 50

  Receipt transaction number.
• ReceiptQuantity: number
  Title: Receipt Quantity

  Read Only: true

  Receipt quantity.
• ReferenceNumber: string
  Title: Reference Number

  Read Only: true

  Maximum Length: 240

  A unique reference number added by the user to identify the adjustment.
• TotalUnitCost: number
  Title: Total Unit Cost

  Read Only: true

  Total unit cost for the adjustment transaction, which is the sum of the unit cost of all the cost elements.
• TransactionId: integer
  Title: Transaction ID

  Read Only: true

  Indicates the transaction identifier of the transaction.
• TransactionTypeName: string
  Title: Transaction Type

  Read Only: true

  Maximum Length: 80

  Name of the transaction type.
• UOMCode: string
  Title: UOM Code

  Read Only: true

  Maximum Length: 3

  Indicates the costing unit of measure code.
• UOMName: string
  Title: UOM Name

  Read Only: true

  Maximum Length: 25

  Indicates the costing unit of measure.
• ValuationUnit: string
  Title: Valuation Unit

  Read Only: true

  Maximum Length: 1000

  Code for the valuation unit.
• ValuationUnitId: integer (int64)
  Title: Valuation Unit ID

  Read Only: true

  Indicates the valuation unit identifier used for the transaction.

{
    "type":"object",
    "properties":{
        "CostBook":{
            "title":"Cost Book",
            "maxLength":30,
            "type":"string",
            "description":"User-defined description of the cost book.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CostBookId":{
            "title":"Cost Book ID",
            "type":"integer",
            "description":"Code for the valuation unit.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CostDate":{
            "title":"Cost Date",
            "type":"string",
            "description":"Transaction cost date.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CostEffectiveDate":{
            "title":"Effective Date",
            "type":"string",
            "description":"Date from which cost is effective.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CostOrganizationId":{
            "title":"Cost Organization ID",
            "type":"integer",
            "description":"Unique identifier for the cost organization.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CostOrganizationName":{
            "title":"Cost Organization Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the cost organization.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CostProfile":{
            "title":"Cost Profile",
            "maxLength":30,
            "type":"string",
            "description":"Value that identifies the cost profile.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CostProfileId":{
            "title":"Cost Profile ID",
            "type":"integer",
            "description":"Value that identifies the cost profile.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"Indicates the currency code in which the cost is stored.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InventoryOrganizationId":{
            "title":"Inventory Organization ID",
            "type":"integer",
            "description":"Unique identifier for the inventory organization.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InventoryOrganizationName":{
            "title":"Inventory Organization Name",
            "maxLength":240,
            "type":"string",
            "description":"Indicates the name for the inventory organization associated with the cost organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Item":{
            "title":"Item",
            "maxLength":300,
            "type":"string",
            "description":"Inventory item name.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ItemId":{
            "title":"Item ID",
            "type":"integer",
            "description":"Unique item identifier",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "QuantityOnhand":{
            "title":"Remaining Receipt Quantity",
            "type":"number",
            "description":"Quantity on hand at the valuation unit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReceiptCostDetails":{
            "title":"Receipt Cost Adjustment Details",
            "type":"array",
            "description":"Costs associated with a receipt are adjusted through a receipt cost adjustment. Receipt cost details include the cost elements associated with it and their individual costs.",
            "items":{
                "$ref":"#/components/schemas/receiptCosts-ReceiptCostDetails-item-response"
            }
        },
        "ReceiptNumber":{
            "title":"Receipt Number",
            "maxLength":50,
            "type":"string",
            "description":"Receipt transaction number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReceiptQuantity":{
            "title":"Receipt Quantity",
            "type":"number",
            "description":"Receipt quantity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReferenceNumber":{
            "title":"Reference Number",
            "maxLength":240,
            "type":"string",
            "description":"A unique reference number added by the user to identify the adjustment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalUnitCost":{
            "title":"Total Unit Cost",
            "type":"number",
            "description":"Total unit cost for the adjustment transaction, which is the sum of the unit cost of all the cost elements.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionId":{
            "title":"Transaction ID",
            "type":"integer",
            "description":"Indicates the transaction identifier of the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionTypeName":{
            "title":"Transaction Type",
            "maxLength":80,
            "type":"string",
            "description":"Name of the transaction type.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "UOMCode":{
            "title":"UOM Code",
            "maxLength":3,
            "type":"string",
            "description":"Indicates the costing unit of measure code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UOMName":{
            "title":"UOM Name",
            "maxLength":25,
            "type":"string",
            "description":"Indicates the costing unit of measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ValuationUnit":{
            "title":"Valuation Unit",
            "maxLength":1000,
            "type":"string",
            "description":"Code for the valuation unit.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ValuationUnitId":{
            "title":"Valuation Unit ID",
            "type":"integer",
            "description":"Indicates the valuation unit identifier used for the transaction.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Receipt Cost Adjustment Details

Type: array

Title: Receipt Cost Adjustment Details

Costs associated with a receipt are adjusted through a receipt cost adjustment. Receipt cost details include the cost elements associated with it and their individual costs.

Show Source

• Array of: object receiptCosts-ReceiptCostDetails-item-response

{
    "title":"Receipt Cost Adjustment Details",
    "type":"array",
    "description":"Costs associated with a receipt are adjusted through a receipt cost adjustment. Receipt cost details include the cost elements associated with it and their individual costs.",
    "items":{
        "$ref":"#/components/schemas/receiptCosts-ReceiptCostDetails-item-response"
    }
}

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."
        }
    }
}

Nested Schema : receiptCosts-ReceiptCostDetails-item-response

Type: object

Show Source

• CostElement: string
  Title: Cost Element

  Read Only: true

  Maximum Length: 30

  Code of the cost element.
• CostElementId: integer (int64)
  Title: Cost Element ID

  Read Only: true

  Indicates the cost element identifier associated to the selected cost element.
• CostElementType: string
  Title: Cost Element Type

  Read Only: true

  Maximum Length: 30

  Type of cost element.
• CurrencyCode: string
  Title: Currency Code

  Read Only: true

  Maximum Length: 15

  Indicates the currency code in which the cost is stored.
• ExpensePool: string
  Title: Expense Pool

  Read Only: true

  Maximum Length: 30

  Indicates the name of the expense pool.
• ExpensePoolId: integer (int64)
  Title: Expense Pool ID

  Read Only: true

  Indicates the code to identify the expense pool.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• TransactionCostId: integer (int64)
  Title: Transaction Cost ID

  Read Only: true

  Transaction cost identifier.
• UnitCost: number
  Title: Unit Cost

  Read Only: true

  Unit cost for actual costed item.

{
    "type":"object",
    "properties":{
        "CostElement":{
            "title":"Cost Element",
            "maxLength":30,
            "type":"string",
            "description":"Code of the cost element.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CostElementId":{
            "title":"Cost Element ID",
            "type":"integer",
            "description":"Indicates the cost element identifier associated to the selected cost element.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CostElementType":{
            "title":"Cost Element Type",
            "maxLength":30,
            "type":"string",
            "description":"Type of cost element.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"Indicates the currency code in which the cost is stored.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpensePool":{
            "title":"Expense Pool",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the name of the expense pool.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpensePoolId":{
            "title":"Expense Pool ID",
            "type":"integer",
            "description":"Indicates the code to identify the expense pool.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TransactionCostId":{
            "title":"Transaction Cost ID",
            "type":"integer",
            "description":"Transaction cost identifier.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UnitCost":{
            "title":"Unit Cost",
            "type":"number",
            "description":"Unit cost for actual costed item.",
            "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"
            }
        }
    }
}

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"
    }
}

Back to Top

Examples

This example describes how to get all receipt costs.

Get All

Use the following cURL command to submit a request on the REST resource to get all receipt costs that the database contains:

curl -u username:password "https://servername/fscmRestApi/resources/version/receiptCosts"

The following example includes the contents of the response body in JSON format:

{
  "items" : [ {
    "TransactionId" : 11578,
    "CostOrganizationId" : 100000014977014,
    "CostOrganizationName" : "ZCST-Seattle",
    "CostBookId" : 100000016508002,
    "CostBook" : "zBIA-CB-M1",
    "InventoryOrganizationId" : 207,
    "InventoryOrganizationName" : "Tall Manufacturing",
    "ItemId" : 663915,
    "Item" : "INV-102",
    "TransactionTypeName" : "Miscellaneous Receipt",
    "ValuationUnitId" : 300100007497728,
    "ValuationUnit" : "ORG11-M1-DSR\\-NLOC\\-1",
    "CostProfileId" : 300100007497621,
    "CostProfile" : "Actual-Inv-Sub-Asset",
    "CostDate" : "2009-08-13T23:52:19-07:00",
    "CostEffectiveDate" : "2010-04-04T16:11:57-07:00",
    "ReceiptNumber" : 3456,
    "ReceiptQuantity" : 1,
    "QuantityOnhand" : 1,
    "TotalUnitCost" : 123,
    "CurrencyCode" : "USD",
    "UOMName" : "Each",
    "UOMCode" : "Ea",
 ...
 }, {
 ...
 }, {
 ...
 }
 ],
 ...
}

Get All According to Attribute Values

Example 1

Example 2

Example 3

Example 4

Example 5

Example 6

Example 7

Use the following cURL command to submit a request on the REST resource to get all receipt costs according to the attribute values:

curl -u username:password "server/fscmRestApi/resources/release_number/receiptCosts?attribute=value"

The following command gets receipt costs where the item identifier is 663915:

curl -u username:password "server/fscmRestApi/resources/release_number/receiptCosts?q=ItemId=663915"

The following example includes the contents of the response body in JSON format:

{
  "items" : [ {
    "TransactionId" : 11578,
    "CostOrganizationId" : 100000014977014,
    "CostOrganizationName" : "ZCST-Seattle",
    "CostBookId" : 100000016508002,
    "CostBook" : "zBIA-CB-M1",
    "InventoryOrganizationId" : 207,
    "InventoryOrganizationName" : "Tall Manufacturing",
    "ItemId" : 663915,
    "Item" : "INV-102",
    "TransactionTypeName" : "Miscellaneous Receipt",
    "ValuationUnitId" : 300100007497728,
    "ValuationUnit" : "ORG11-M1-DSR\\-NLOC\\-1",
    "CostProfileId" : 300100007497621,
    "CostProfile" : "Actual-Inv-Sub-Asset",
    "CostDate" : "2009-08-13T23:52:19-07:00",
    "CostEffectiveDate" : "2010-04-04T16:11:57-07:00",
    "ReceiptNumber" : 3456,
    "ReceiptQuantity" : 1,
    "QuantityOnhand" : 1,
    "TotalUnitCost" : 123,
    "CurrencyCode" : "USD",
    "UOMName" : "Each",
    "UOMCode" : "Ea",
 ...
 }, {
 ...
 }, {
 ...
 }
 ],
 ...
}

The following command gets receipts eligible for receipt cost adjustment:

curl -u username:password "server/fscmRestApi/resources/release_number/receiptCosts?finder=findReceiptsWithCost;bindCostOrgName=ZCST-Seattle,bindCostBook=ZCST-Seattle,bindItem=AS54888"

The following example includes the contents of the response body in JSON format:

{
  "items" : [ {
    "TransactionId" : 333121,
    "CostOrganizationId" : 100000014977014,
    "CostOrganizationName" : "ZCST-Seattle",
    "CostBookId" : 100000014978010,
    "CostBook" : "ZCST-Seattle",
    "InventoryOrganizationId" : 207,
    "InventoryOrganizationName" : "Tall Manufacturing",
    "ItemId" : 149,
    "Item" : "AS54888",
    "TransactionTypeName" : "Purchase Order Receipt",
    "ValuationUnitId" : 300100002799598,
    "ValuationUnit" : "ORG11-M1",
    "CostProfileId" : 100000011883009,
    "CostProfile" : "ZCST-InvOrg-Asset",
    "CostDate" : "2012-04-24T08:56:31-07:00",
    "CostEffectiveDate" : "2011-12-06T07:09:19-08:00",
    "ReceiptNumber" : "33592",
    "ReceiptQuantity" : 5,
    "QuantityOnhand" : 5,
    "TotalUnitCost" : 10,
    "CurrencyCode" : "USD",
    "UOMName" : "Each",
    "UOMCode" : "Ea",
 ...
 }, {
 ...
 }, {
 ...
 }
 ],
 ...
}

The following command gets receipts eligible for receipt cost adjustment for item ID 149:

curl -u username:password "server/fscmRestApi/resources/release_number/receiptCosts?finder=findReceiptsWithCost;bindItemId=149"

The following example includes the contents of the response body in JSON format:

{
  "items" : [ {
    "TransactionId" : 333121,
    "CostOrganizationId" : 100000014977014,
    "CostOrganizationName" : "ZCST-Seattle",
    "CostBookId" : 100000014978010,
    "CostBook" : "ZCST-Seattle",
    "InventoryOrganizationId" : 207,
    "InventoryOrganizationName" : "Tall Manufacturing",
    "ItemId" : 149,
    "Item" : "AS54888",
    "TransactionTypeName" : "Purchase Order Receipt",
    "ValuationUnitId" : 300100002799598,
    "ValuationUnit" : "ORG11-M1",
    "CostProfileId" : 100000011883009,
    "CostProfile" : "ZCST-InvOrg-Asset",
    "CostDate" : "2012-04-24T08:56:31-07:00",
    "CostEffectiveDate" : "2011-12-06T07:09:19-08:00",
    "ReceiptNumber" : "33592",
    "ReceiptQuantity" : 5,
    "QuantityOnhand" : 5,
    "TotalUnitCost" : 10,
    "CurrencyCode" : "USD",
    "UOMName" : "Each",
    "UOMCode" : "Ea",
 ...
 }, {
 ...
 }, {
 ...
 }
 ],
 ...
}

The following command gets receipts eligible for receipt with no cost adjustment:

curl -u username:password "server/fscmRestApi/resources/release_number/receiptCosts?finder=findReceiptsWithNoCost;bindCostOrgName=ZCST-Seattle,bindCostBook=Standard,bindItem=AS54888"

The following example includes the contents of the response body in JSON format:

{
  "items" : [ {
    "TransactionId" : 404887,
    "CostOrganizationId" : 100000014977014,
    "CostOrganizationName" : "ZCST-Seattle",
    "CostBookId" : 300100007497625,
    "CostBook" : "Standard",
    "InventoryOrganizationId" : 207,
    "InventoryOrganizationName" : "Tall Manufacturing",
    "ItemId" : 149,
    "Item" : "AS54888",
    "TransactionTypeName" : "Miscellaneous Receipt",
    "ValuationUnitId" : 300100026322768,
    "ValuationUnit" : "ORG11-M1-FGI",
    "CostProfileId" : 300100016118876,
    "CostProfile" : "Standard-Inv-Sub-Asset",
    "CostDate" : "2015-03-18T23:01:54-07:00",
    "CostEffectiveDate" : "2015-03-18T23:01:54-07:00",
    "ReceiptNumber" : "22207559",
    "ReceiptQuantity" : 1000000000,
    "QuantityOnhand" : 999999984,
    "TotalUnitCost" : null,
    "CurrencyCode" : "USD",
    "UOMName" : "Each",
    "UOMCode" : "Ea",
    ...
   }, {
    ...
   }, {
    ...
   }
  ],
 ...
}

The following command gets receipts eligible for receipt with no cost adjustment for item ID 149:

curl -u username:password "server/fscmRestApi/resources/release_number/receiptCosts?finder=findReceiptsWithNoCost;bindItemId=149"

The following example includes the contents of the response body in JSON format:

{
  "items" : [ {
    "TransactionId" : 404887,
    "CostOrganizationId" : 100000014977014,
    "CostOrganizationName" : "ZCST-Seattle",
    "CostBookId" : 300100007497625,
    "CostBook" : "Standard",
    "InventoryOrganizationId" : 207,
    "InventoryOrganizationName" : "Tall Manufacturing",
    "ItemId" : 149,
    "Item" : "AS54888",
    "TransactionTypeName" : "Miscellaneous Receipt",
    "ValuationUnitId" : 300100026322768,
    "ValuationUnit" : "ORG11-M1-FGI",
    "CostProfileId" : 300100016118876,
    "CostProfile" : "Standard-Inv-Sub-Asset",
    "CostDate" : "2015-03-18T23:01:54-07:00",
    "CostEffectiveDate" : "2015-03-18T23:01:54-07:00",
    "ReceiptNumber" : "22207559",
    "ReceiptQuantity" : 1000000000,
    "QuantityOnhand" : 999999984,
    "TotalUnitCost" : null,
    "CurrencyCode" : "USD",
    "UOMName" : "Each",
    "UOMCode" : "Ea",
    ...
   }, {
    ...
   }, {
    ...
   }
  ],
 ...
}

The following command gets receipts eligible for layer cost adjustment:

curl -u username:password "server/fscmRestApi/resources/release_number/receiptCosts?finder=findReceiptsWithActualCost;bindCostOrgName=ZCST-Seattle,bindCostBook=Actual,bindItem=ZCST-Plain-Asset1"

The following example includes the contents of the response body in JSON format:

{
  "items" : [ {
    "TransactionId" : 432426,
    "CostOrganizationId" : 100000014977014,
    "CostOrganizationName" : "ZCST-Seattle",
    "CostBookId" : 300100007497624,
    "CostBook" : "Actual",
    "InventoryOrganizationId" : 207,
    "InventoryOrganizationName" : "Tall Manufacturing",
    "ItemId" : 100000012013473,
    "Item" : "ZCST-Plain-Asset1",
    "TransactionTypeName" : "Acquisition Cost Adjustment",
    "ValuationUnitId" : 300100012010907,
    "ValuationUnit" : "ORG11-M1-Stores",
    "CostProfileId" : 300100007497621,
    "CostProfile" : "Actual-Inv-Sub-Asset",
    "CostDate" : "2014-06-26T16:14:30-07:00",
    "CostEffectiveDate" : "2017-07-24T11:26:56.179-07:00",
    "ReceiptNumber" : "33642",
    "ReceiptQuantity" : 3,
    "QuantityOnhand" : 3,
    "TotalUnitCost" : 12.347,
    "CurrencyCode" : "USD",
    "UOMName" : "EA",
    "UOMCode" : "EA",
 ...
 }, {
 ...
 }, {
 ...
 }
 ],
 ...
}

The following command gets receipts eligible for layer cost adjustment for item ID 100000012013473:

curl -u username:password "server/fscmRestApi/resources/release_number/receiptCosts?finder=findReceiptsWithActualCost;bindItemId=100000012013473"

The following example includes the contents of the response body in JSON format:

{
  "items" : [ {
    "TransactionId" : 432426,
    "CostOrganizationId" : 100000014977014,
    "CostOrganizationName" : "ZCST-Seattle",
    "CostBookId" : 300100007497624,
    "CostBook" : "Actual",
    "InventoryOrganizationId" : 207,
    "InventoryOrganizationName" : "Tall Manufacturing",
    "ItemId" : 100000012013473,
    "Item" : "ZCST-Plain-Asset1",
    "TransactionTypeName" : "Acquisition Cost Adjustment",
    "ValuationUnitId" : 300100012010907,
    "ValuationUnit" : "ORG11-M1-Stores",
    "CostProfileId" : 300100007497621,
    "CostProfile" : "Actual-Inv-Sub-Asset",
    "CostDate" : "2014-06-26T16:14:30-07:00",
    "CostEffectiveDate" : "2017-07-24T11:26:56.179-07:00",
    "ReceiptNumber" : "33642",
    "ReceiptQuantity" : 3,
    "QuantityOnhand" : 3,
    "TotalUnitCost" : 12.347,
    "CurrencyCode" : "USD",
    "UOMName" : "EA",
    "UOMCode" : "EA",
 ...
 }, {
 ...
 }, {
 ...
 }
 ],
 ...
}

Back to Top