Jump to

• Request
• Response
• Examples

Get all receipt costs

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: Find receipt transactions eligible for adjustment according to the transaction identifier as the primary key.
    Finder Variables:
    • TransactionId; integer; Value that uniquely identifies the receipt transaction.
  • findReceiptsWithActualCost: Find receipts eligible for layer cost adjustment according to the specified values. To use this finder, you need one of the following values: Cost Organization, or Cost book, or Item.
    Finder Variables:
    • bindCostBook; string; Name of the cost book.
    • bindCostOrgName; string; Name of the cost organization.
    • bindCostProfile; string; Name of the cost profile.
    • bindItem; string; Name of the item.
    • bindItemId; integer; Value that uniquely identifies the item. It is recommended that you use this attribute with the finder. The item rest service contains this value.
    • bindReceiptNumber; string; Number of the receipt.
    • bindReferenceNumber; string; Number that uniquely identifies the reference.
    • bindTxnTypeName; string; Name of the transaction type.
    • bindValuationUnit; string; Name of the valuation unit.
  • findReceiptsWithCost: Find receipt transactions eligible for receipt cost adjustment according to the specified values. To use this finder, you need one of the following values: Cost Organization, or Cost book, or Item.
    Finder Variables:
    • bindCostBook; string; Name of the cost book.
    • bindCostOrgName; string; Name of the cost organization. This is
    • bindCostProfile; string; Name of the cost profile.
    • bindItem; string; Name of the item.
    • bindItemId; integer; Value that uniquely identifies the item. It is recommended that you use this attribute with the finder. The item rest service contains this value.
    • bindReceiptNumber; string; Number of the receipt.
    • bindReferenceNumber; string; Number that uniquely identifies the reference.
    • bindTxnTypeName; string; Name of the transaction type.
    • bindValuationUnit; string; Name of the valuation unit.
  • findReceiptsWithNoCost: Find receipt transactions eligible for receipt with no cost adjustment according to the specified values. To use this finder, you need one of the following values: Cost Organization, or Cost book, or Item.
    Finder Variables:
    • bindCostBook; string; Name of the cost book.
    • bindCostOrgName; string; Name of the cost organization.
    • bindCostProfile; string; Name of the cost profile.
    • bindItem; string; Name of the item.
    • bindItemId; integer; Value that uniquely identifies the item. It is recommended that you use this attribute with the finder. The item REST service contains this value.
    • bindReceiptNumber; string; Number of the receipt.
    • bindReferenceNumber; string; Number that uniquely identifies the reference.
    • bindTxnTypeName; string; Name of the transaction type.
    • 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; Name of the cost book where the receipt applies.
  • CostBookId; integer; Value that uniquely identifies the cost book.
  • CostDate; string; Date of the costing transaction.
  • CostEffectiveDate; string; Date when the cost for the transaction becomes active.
  • CostOrganizationId; integer; Value that uniquely identifies the cost organization.
  • CostOrganizationName; string; Name of the cost organization where the receipt applies.
  • CostProfile; string; Cost profile associated with the receipt item.
  • CostProfileId; integer; Value that uniquely identifies the cost profile.
  • CurrencyCode; string; Abbreviation that identifies the currency.
  • InventoryOrganizationId; integer; Value that uniquely identifies the inventory organization.
  • InventoryOrganizationName; string; Name of the inventory organization where the receipt applies.
  • Item; string; Name of the inventory item where the receipt applies.
  • ItemId; integer; Value that uniquely identifies the inventory item.
  • QuantityOnhand; number; Remaining quantity of the inventory item.
  • ReceiptNumber; string; Number that identifies the receipt.
  • ReceiptQuantity; number; Quantity of the inventory item received.
  • ReferenceNumber; string; Number that uniquely identifies the reference.
  • TotalUnitCost; number; Total cost of the received inventory item.
  • TransactionId; integer; Value that uniquely identifies the receipt transaction in costing.
  • TransactionTypeName; string; Name of the transaction type where the receipt applies.
  • UOMCode; string; Abbreviation that identifies the unit of measure.
  • UOMName; string; Name of the unit of measure.
  • ValuationUnit; string; Valuation unit where the receipt applies.
  • ValuationUnitId; integer; Value that uniquely identifies the valuation unit.
• 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 : 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":{
        "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/receiptCosts-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 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

  Name of the cost book where the receipt applies.
• CostBookId: integer (int64)
  Title: Cost Book ID

  Read Only: true

  Value that uniquely identifies the cost book.
• CostDate: string (date-time)
  Title: Cost Date

  Read Only: true

  Date of the costing transaction.
• CostEffectiveDate: string (date-time)
  Title: Effective Date

  Read Only: true

  Date when the cost for the transaction becomes active.
• CostOrganizationId: integer (int64)
  Title: Cost Organization ID

  Read Only: true

  Value that uniquely identifies the cost organization.
• CostOrganizationName: string
  Title: Cost Organization Name

  Read Only: true

  Maximum Length: 240

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

  Read Only: true

  Maximum Length: 30

  Cost profile associated with the receipt item.
• CostProfileId: integer (int64)
  Title: Cost Profile ID

  Read Only: true

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

  Read Only: true

  Maximum Length: 15

  Abbreviation that identifies the currency.
• InventoryOrganizationId: integer (int64)
  Title: Inventory Organization ID

  Read Only: true

  Value that uniquely identifies the inventory organization.
• InventoryOrganizationName: string
  Title: Inventory Organization Name

  Read Only: true

  Maximum Length: 240

  Name of the inventory organization where the receipt applies.
• Item: string
  Title: Item

  Read Only: true

  Maximum Length: 300

  Name of the inventory item where the receipt applies.
• ItemId: integer (int64)
  Title: Item ID

  Read Only: true

  Value that uniquely identifies the inventory item.
• links: array Links
  Title: Links

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

  Read Only: true

  Remaining quantity of the inventory item.
• ReceiptCostDetails: array Receipt Cost Details
  Title: Receipt Cost Details

  The Receipt Cost Details resource allows you to view the cost elements and unit costs of the received items.
• ReceiptNumber: string
  Title: Receipt Number

  Read Only: true

  Maximum Length: 50

  Number that identifies the receipt.
• ReceiptQuantity: number
  Title: Receipt Quantity

  Read Only: true

  Quantity of the inventory item received.
• ReferenceNumber: string
  Title: Reference Number

  Read Only: true

  Maximum Length: 240

  Number that uniquely identifies the reference.
• TotalUnitCost: number
  Title: Total Unit Cost

  Read Only: true

  Total cost of the received inventory item.
• TransactionId: integer
  Title: Transaction ID

  Read Only: true

  Value that uniquely identifies the receipt transaction in costing.
• TransactionTypeName: string
  Title: Transaction Type

  Read Only: true

  Maximum Length: 80

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

  Read Only: true

  Maximum Length: 3

  Abbreviation that identifies the unit of measure.
• UOMName: string
  Title: UOM Name

  Read Only: true

  Maximum Length: 25

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

  Read Only: true

  Maximum Length: 1000

  Valuation unit where the receipt applies.
• ValuationUnitId: integer (int64)
  Title: Valuation Unit ID

  Read Only: true

  Value that uniquely identifies the valuation unit.

{
    "type":"object",
    "properties":{
        "TransactionTypeName":{
            "title":"Transaction Type",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the transaction type where the receipt applies.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "InventoryOrganizationName":{
            "title":"Inventory Organization Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the inventory organization where the receipt applies.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalUnitCost":{
            "title":"Total Unit Cost",
            "type":"number",
            "description":"Total cost of the received inventory item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemId":{
            "title":"Item ID",
            "type":"integer",
            "description":"Value that uniquely identifies the inventory item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"Abbreviation that identifies the currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CostOrganizationName":{
            "title":"Cost Organization Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the cost organization where the receipt applies.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Item":{
            "title":"Item",
            "maxLength":"300",
            "type":"string",
            "description":"Name of the inventory item where the receipt applies.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ValuationUnitId":{
            "title":"Valuation Unit ID",
            "type":"integer",
            "description":"Value that uniquely identifies the valuation unit.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "InventoryOrganizationId":{
            "title":"Inventory Organization ID",
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization.",
            "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"
            }
        },
        "UOMCode":{
            "title":"UOM Code",
            "maxLength":"3",
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReceiptNumber":{
            "title":"Receipt Number",
            "maxLength":"50",
            "type":"string",
            "description":"Number that identifies the receipt.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ValuationUnit":{
            "title":"Valuation Unit",
            "maxLength":"1000",
            "type":"string",
            "description":"Valuation unit where the receipt applies.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CostEffectiveDate":{
            "title":"Effective Date",
            "type":"string",
            "description":"Date when the cost for the transaction becomes active.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReferenceNumber":{
            "title":"Reference Number",
            "maxLength":"240",
            "type":"string",
            "description":"Number that uniquely identifies the reference.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CostProfileId":{
            "title":"Cost Profile ID",
            "type":"integer",
            "description":"Value that uniquely identifies the cost profile.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TransactionId":{
            "title":"Transaction ID",
            "type":"integer",
            "description":"Value that uniquely identifies the receipt transaction in costing.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReceiptCostDetails":{
            "title":"Receipt Cost Details",
            "type":"array",
            "description":"The Receipt Cost Details resource allows you to view the cost elements and unit costs of the received items.",
            "items":{
                "$ref":"#/components/schemas/receiptCosts-ReceiptCostDetails-item-response"
            }
        },
        "CostBook":{
            "title":"Cost Book",
            "maxLength":"30",
            "type":"string",
            "description":"Name of the cost book where the receipt applies.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CostOrganizationId":{
            "title":"Cost Organization ID",
            "type":"integer",
            "description":"Value that uniquely identifies the cost organization.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CostDate":{
            "title":"Cost Date",
            "type":"string",
            "description":"Date of the costing transaction.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CostProfile":{
            "title":"Cost Profile",
            "maxLength":"30",
            "type":"string",
            "description":"Cost profile associated with the receipt item.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "UOMName":{
            "title":"UOM Name",
            "maxLength":"25",
            "type":"string",
            "description":"Name of the unit of measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReceiptQuantity":{
            "title":"Receipt Quantity",
            "type":"number",
            "description":"Quantity of the inventory item received.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QuantityOnhand":{
            "title":"Remaining Receipt Quantity",
            "type":"number",
            "description":"Remaining quantity of the inventory item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CostBookId":{
            "title":"Cost Book ID",
            "type":"integer",
            "description":"Value that uniquely identifies the cost book.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "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 : Receipt Cost Details

Type: array

Title: Receipt Cost Details

The Receipt Cost Details resource allows you to view the cost elements and unit costs of the received items.

Show Source

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

{
    "title":"Receipt Cost Details",
    "type":"array",
    "description":"The Receipt Cost Details resource allows you to view the cost elements and unit costs of the received items.",
    "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

  Cost element to use with the receipt item.
• CostElementId: integer (int64)
  Title: Cost Element ID

  Read Only: true

  Value that uniquely identifies the cost element.
• CostElementType: string
  Title: Cost Element Type

  Read Only: true

  Maximum Length: 30

  Name of the cost element type.
• CurrencyCode: string
  Title: Currency Code

  Read Only: true

  Maximum Length: 15

  Abbreviation that identifies the currency.
• ExpensePool: string
  Title: Expense Pool

  Read Only: true

  Maximum Length: 30

  Expense pool to use when creating the cost.
• ExpensePoolId: integer (int64)
  Title: Expense Pool ID

  Read Only: true

  Value that uniquely identifies 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

  Value that uniquely identifies the transaction cost.
• UnitCost: number
  Title: Unit Cost

  Read Only: true

  Unit cost of the cost element.

{
    "type":"object",
    "properties":{
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"Abbreviation that identifies the currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitCost":{
            "title":"Unit Cost",
            "type":"number",
            "description":"Unit cost of the cost element.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CostElementId":{
            "title":"Cost Element ID",
            "type":"integer",
            "description":"Value that uniquely identifies the cost element.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ExpensePoolId":{
            "title":"Expense Pool ID",
            "type":"integer",
            "description":"Value that uniquely identifies the expense pool.",
            "format":"int64",
            "nullable":false,
            "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"
            }
        },
        "TransactionCostId":{
            "title":"Transaction Cost ID",
            "type":"integer",
            "description":"Value that uniquely identifies the transaction cost.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CostElement":{
            "title":"Cost Element",
            "maxLength":"30",
            "type":"string",
            "description":"Cost element to use with the receipt item.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ExpensePool":{
            "title":"Expense Pool",
            "maxLength":"30",
            "type":"string",
            "description":"Expense pool to use when creating the cost.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CostElementType":{
            "title":"Cost Element Type",
            "maxLength":"30",
            "type":"string",
            "description":"Name of the cost element type.",
            "nullable":false,
            "readOnly":true,
            "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"
    }
}

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