Create other costs - Intergraph Smart Materials - Help - Hexagon

Intergraph Smart Materials Web API Help (10.6)
ft:locale
en-US
Product
Intergraph Smart Materials
Subproduct
Web API
Search by Category
Help
Smart Materials/Smart Reference Data Version
10.6

This API creates other costs details for an agreement present in a specified project of Smart Materials.

This API only supports the following agreement types:

  • Manual PO

  • Agreement by Requisition

  • Agreement by Inquiry

  • Sub Contracts

Required Privilege: API_AGREEMENT

Headers

Header Name

Description

Required

Values

Authorization

Access token

Required

Bearer <access_token>

Content-Type

Request type format

Required

application/JSON

Body

POST http://localhost:65116/smat/v1/Projects(‘:project')/Disciplines(‘:discipline')/Nls(':language’)/PurchaseOrders({key})/UsedOtherCosts

Specify the values for the project, discipline, language, and key parameters in the URL. The project, discipline, and language together, define the project environment where the used other costs details are created. The key parameter defines the agreement/purchase order ID (PohId) within which these details are added.

Element

Description

Type

Required

Notes

OtherCostCode

Name of the other cost.

String

Required

AccountCode

Name of the account code.

String

Optional

EvalCostInd

Indicates whether the other cost is an evaluation cost or not. Allowed values are Y and N, and the default value is N.

Evaluation costs are not considered while calculating the Total Costs of an agreement and cannot be modified.

String

Optional

ProgressPayCostInd

Indicates whether this other cost must be provided for Total Material Cost in Prog Pay Events or not. Allowed values are Y and N, and the default value is Y.

String

Optional

DiscountableInd

Indicates whether the other cost is discountable or not. Allowed values are Y and N.

You can use this element only, if the discount base is Discount% at agreement level and OcPercent, CostValueTotal have positive values.

String

Optional

OcPercent

Refers to other cost percentage and is an alternative to other cost value.

For example, the costs for the documentation delivered for an agreement line item amount to 2% of the agreement line item costs.

  • If project default ZP_CODELTA has been set to 'Y' the percentage will only be applied to the changed agreement line item costs in case of a CO.

  • To apply a discount to an agreement line item, you should give a negative value as percentage. Such a discount is applied to the extended price and to all other costs assigned to the agreement line item that is marked as being discountable. However, discount can only be applied, if the project default ZP_OC_DISC is set to Y. If set to N, negative values are not allowed as percentage.

Decimal

Optional

CostValueTotal

Total value of the other cost.

  • You cannot modify CostValueTotal, if the OcPercent is provided.

  • If the project default ZP_NEG_OC is set Y, then only negative values are allowed for the CostValueTotal.

  • You cannot provide negative values, if the Discount% or Discount Amount is defined on agreement level.

Decimal

Optional

UnitCode

Refers to the currency of the other cost.

  • Default value is given by the currency of the agreement which can be modified. However, you cannot modify it, if the OcPercent value is provided, and the currency of the agreement is also available.

String

Optional

TaxableInd

Indicates whether the assigned other cost is taxable or not. Allowed values are Y and N. The default value is defined by the value of the project default ZP_DEF_TAX.

String

Optional

ShortDesc

Short description of the other costs.

String

Optional

Description

Description of the other costs.

String

Optional

ProgressPayInd

Indicates whether the other cost will be available while invoicing against progress payments or not. Allowed values are Y and N, and the default value is N.

String

Optional

Sample Body

POST http://localhost:65116/smat/v1/Projects('RS')/Disciplines('PIPING')/Nls('English')/PurchaseOrders(10000140021)/UsedOtherCosts

{

    "OtherCostCode": "ABC20456",

    "AccountCode": "1234",

    "EvalCostInd": "N",

    "ProgressPayCostInd": "Y",

    "DiscountableInd": "N",

    "OcPercent": 0,

    "CostValueTotal": 100,

    "UnitCode": "USD",

    "TaxableInd": "Y",

    "ShortDesc": null,

    "Description": null,

    "ProgressPayInd": "N"

}

Success Response

Status Code: 201 Created

{

    "@odata.context": "http://localhost:57101/SMAT/V1/$metadata#Projects('AB')/Disciplines('PIPING')/Nls('English')/PurchaseOrders(10000139937)/UsedOtherCosts/$entity",

    "UocId": 10000620435,

    "OcId": 10000006321,

    "ProjId": "AB",

    "DpId": 5020,

    "PohId": 10000139937,

    "OtherCostCode": "ABC20456",

    "Supplement": 0,

    "AccountCode": "1234",

    "EvalCostInd": "N",

    "ProgressPayCostInd": "Y",

    "DiscountableInd": "N",

    "OcPercent": 0,

    "CostValueTotal": 100,

    "UnitCode": "USD",

    "TaxableInd": "Y",

    "ShortDesc": null,

    "Description": null,

    "ProgressPayInd": "N",

    "ChangedCostValTot": 0,

    "CostValTotToSup": 100

}

Element

Description

Type

UocId

Unique ID of the used other costs which is a part of an agreement.

Integer

OcId

Unique ID of the other costs.

Integer

Supplement

Supplement number of the created other cost.

Integer

ChangedCostValTot

Refers to the difference between the previous and the actual costs. Only in the case of a changed agreement line item, the value can differ from 0 (zero).

Decimal

CostValTotToSup

Refers to the total cost value up to this supplement i.e. it contains the total costs of this supplement along with all the previous supplements.

Decimal