Jump to

• Request
• Response

Get one price agreement for an order

post

/fscmRestApi/resources/11.13.18.05/buyerPlanningAgreements

A GET action to retrieve data for a price agreement against an order.

Request

Header Parameters

• Metadata-Context(required):
  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(required):
  The protocol version between a REST client and service. If the client doesn't specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Match All

Show Source

• object buyerPlanningAgreements-item

{
    "allOf":[
        {
            "$ref":"#/components/schemas/buyerPlanningAgreements-item"
        }
    ]
}

Nested Schema : buyerPlanningAgreements-item

Type: object

Show Source

• AgreementCurrencyCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the currency for the purchase agreement.
• AgreementEndDate: string
  Read Only: true

  Date when the purcahse agreement expires.
• AgreementHeaderAmount: number (double)
  Read Only: true

  Value that identifies the amount agreed to for the planned or blanket purchase order.
• AgreementHeaderId: integer (int64)
  Read Only: true

  Value that uniquely identifies the purchase agreement.
• AgreementHeaderMinReleaseAmount: number (double)
  Read Only: true

  Value that identifies the minimum amount that can be released against the sum of all the PO line amounts.
• AgreementHeaderReleaseAmount: number (double)
  Read Only: true

  Value that identifies the amount released against this agreement. It's the sum of all the approved standard PO amounts.
• AgreementLineId: integer (int64)
  Read Only: true

  Value that uniquely identifies the purchase agreement line.
• AgreementNumber: string
  Read Only: true

  Maximum Length: 30

  Number that uniquely identifies the purchase agreement.
• AgreementStartDate: string
  Read Only: true

  Date when the purcahse agreement goes into effect.
• ConfiguredItemFlag: string
  Maximum Length: 1

  Indicates whether or not the item configured. The values can be Yes or No. If the value is Yes, then item is configured.
• CurrencyCode: string
  Read Only: true

  Maximum Length: 15

  Abbreviation that identifies the currency for the order in buyer planning.
• DockDate: string
  Date when the material should be on the receiving dock when the order is released.
• ItemId: integer (int64)
  Value that uniquely identifies the item associated with the order in buyer planning.
• ItemPrice: number (double)
  Read Only: true

  Price per unit offered for the quantity range.
• ItemRevisionCode: string
  Maximum Length: 30

  Abbreviation that identifies the revision of the item on the purchase agreement.
• LineAgreementAmount: number (double)
  Read Only: true

  Value that identifies the amount agreed to for the planned or blanket purchase order line.
• LineAgreementQuantity: number (double)
  Read Only: true

  Value that identifies the total quanity of the item to be released against this agreement. It's the sum of all the approved standard PO line quantities.
• LineExpiryDate: string
  Read Only: true

  Date when the agreement line expires.
• LineMinimumReleaseAmount: number (double)
  Read Only: true

  Value that identifies the minimum amount that can be released against the PO line.
• LineNumber: string
  Read Only: true

  Maximum Length: 30

  Number that identifies the purchase agreement line.
• LineReleaseAmount: number (double)
  Read Only: true

  Value that identifies the amount released against this agreement. It's the sum of all the approved standard PO amounts.
• LocationId: integer (int64)
  Value that uniquely identifies the location associated to the order in buyer planning.
• MappedItemId: integer (int64)
  Value that uniquely identifies the mapped fusion item associated with the order in in buyer planning.
• MappedOrganizationId: integer (int64)
  Value that uniquely identifies the mapped fusion organization associated with the order in buyer planning.
• MappedSupplierId: integer (int64)
  Value that uniquely identifies the mapped fusion supplier from where the item is being sourced in buyer planning.
• OrderQuantity: number (double)
  Value that identifies the order quantity in buyer planning.
• OrderTotalPrice: number (double)
  Read Only: true

  Value that identifies the total price for order quantity in buyer planning.
• PoDiscount: number (double)
  Read Only: true

  Value that indicates the discount percent or amount of the purchase order line.
• PoDiscountType: string
  Read Only: true

  Maximum Length: 30

  Type of discount that indicates whether the discount is based on amount or percent.
• PoHeaderId: integer (int64)
  Value that uniquely identifies the purchase order in buyer planning.
• PoIsNewPriceApplicable: string
  Read Only: true

  Maximum Length: 1

  Indicates whether or not the agreement price is applicable to the order. The values can be Y or N. If the value is Yes, then the agreement price can be applied to the purchase order.
• PoLineId: integer (int64)
  Value that uniquely identifies the purchase order line in buyer planning.
• PriceBreakTypeCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the type of price break.
• PriceBreakTypeName: string
  Read Only: true

  Maximum Length: 30

  Indicates type of price break.
• PurchasingUomCode: string
  Read Only: true

  Maximum Length: 3

  Abbreviation that identifies the purchasing unit of measure associated with the purchase agreement.
• SupplierSite: string
  Maximum Length: 30

  Abbreviation that indicates the specific supplier site from where the item is being sourced in buyer planning.
• UomCode: string
  Maximum Length: 30

  Abbreviation that identifies the unit of measure associated to the order in buyer planning.

{
    "type":"object",
    "properties":{
        "MappedSupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the mapped fusion supplier  from where the item is being sourced in buyer planning.",
            "format":"int64",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":18
            }
        },
        "SupplierSite":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that indicates the specific supplier site from where the item is being sourced in buyer planning.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "ItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item associated with the order in buyer planning.",
            "format":"int64",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":18
            }
        },
        "MappedItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the mapped fusion item associated with the order in in buyer planning.",
            "format":"int64",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":18
            }
        },
        "ItemPrice":{
            "type":"number",
            "description":"Price per unit offered for the quantity range.",
            "format":"double",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":18
            }
        },
        "ItemRevisionCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the revision of the item on the purchase agreement.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "ConfiguredItemFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether or not the item configured. The values can be Yes or No. If the value is Yes, then item is configured.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "UomCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure associated to the order in buyer planning.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "MappedOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the mapped fusion organization associated with the order in buyer planning.",
            "format":"int64",
            "nullable":false,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":18
            }
        },
        "OrderQuantity":{
            "type":"number",
            "description":"Value that identifies the order quantity in buyer planning.",
            "format":"double",
            "nullable":false,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":18
            }
        },
        "DockDate":{
            "type":"string",
            "description":"Date when the material should be on the receiving dock when the order is released.",
            "nullable":false,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "LocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the location associated to the order in buyer planning.",
            "format":"int64",
            "nullable":false,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":18
            }
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Abbreviation that identifies the currency for the order in buyer planning.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "PoHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase order in buyer planning.",
            "format":"int64",
            "nullable":false,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":18
            }
        },
        "PoLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase order line in buyer planning.",
            "format":"int64",
            "nullable":false,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":18
            }
        },
        "AgreementHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase agreement.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":18
            }
        },
        "AgreementLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase agreement line.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":18
            }
        },
        "AgreementNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Number that uniquely identifies the purchase agreement.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "AgreementHeaderReleaseAmount":{
            "type":"number",
            "description":"Value that identifies the amount released against this agreement. It's the sum of all the approved standard PO amounts.",
            "format":"double",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":18
            }
        },
        "AgreementHeaderAmount":{
            "type":"number",
            "description":"Value that identifies the amount agreed to for the planned or blanket purchase order.",
            "format":"double",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":18
            }
        },
        "AgreementStartDate":{
            "type":"string",
            "description":"Date when the purcahse agreement goes into effect.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "AgreementEndDate":{
            "type":"string",
            "description":"Date when the purcahse agreement expires.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "AgreementHeaderMinReleaseAmount":{
            "type":"number",
            "description":"Value that identifies the minimum amount that can be released against the sum of all the PO line amounts.",
            "format":"double",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":18
            }
        },
        "AgreementCurrencyCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the currency for the purchase agreement.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "LineNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Number that identifies the purchase agreement line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "LineMinimumReleaseAmount":{
            "type":"number",
            "description":"Value that identifies the minimum amount that can be released against the PO line.",
            "format":"double",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":18
            }
        },
        "LineReleaseAmount":{
            "type":"number",
            "description":"Value that identifies the amount released against this agreement. It's the sum of all the approved standard PO amounts.",
            "format":"double",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":18
            }
        },
        "LineAgreementQuantity":{
            "type":"number",
            "description":"Value that identifies the total quanity of the item to be released against this agreement. It's the sum of all the approved standard PO line quantities.",
            "format":"double",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":18
            }
        },
        "LineAgreementAmount":{
            "type":"number",
            "description":"Value that identifies the amount agreed to for the planned or blanket purchase order line.",
            "format":"double",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":18
            }
        },
        "LineExpiryDate":{
            "type":"string",
            "description":"Date when the agreement line expires.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "OrderTotalPrice":{
            "type":"number",
            "description":"Value that identifies the total price for order quantity in buyer planning.",
            "format":"double",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":18
            }
        },
        "PurchasingUomCode":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the purchasing unit of measure associated with the purchase agreement.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "PriceBreakTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the type of price break.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "PriceBreakTypeName":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates type of price break.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "PoDiscountType":{
            "maxLength":30,
            "type":"string",
            "description":"Type of discount that indicates whether the discount is based on amount or percent.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "PoDiscount":{
            "type":"number",
            "description":"Value that indicates the discount percent or amount of the purchase order line.",
            "format":"double",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":18
            }
        },
        "PoIsNewPriceApplicable":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether or not the agreement price is applicable to the order. The values can be Y or N. If the value is Yes, then the agreement price can be applied to the purchase order.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  The protocol version between a REST client and service. If the client doesn't specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : buyerPlanningAgreements-item-response

Match All

Show Source

• object buyerPlanningAgreements-item
• object buyerPlanningAgreements-item-response-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/buyerPlanningAgreements-item"
        },
        {
            "type":"object",
            "properties":{
                "priceBreaks":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/buyerPlanningAgreements-priceBreaks-item-response"
                    }
                }
            }
        }
    ]
}

Nested Schema : buyerPlanningAgreements-item

Type: object

Show Source

• AgreementCurrencyCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the currency for the purchase agreement.
• AgreementEndDate: string
  Read Only: true

  Date when the purcahse agreement expires.
• AgreementHeaderAmount: number (double)
  Read Only: true

  Value that identifies the amount agreed to for the planned or blanket purchase order.
• AgreementHeaderId: integer (int64)
  Read Only: true

  Value that uniquely identifies the purchase agreement.
• AgreementHeaderMinReleaseAmount: number (double)
  Read Only: true

  Value that identifies the minimum amount that can be released against the sum of all the PO line amounts.
• AgreementHeaderReleaseAmount: number (double)
  Read Only: true

  Value that identifies the amount released against this agreement. It's the sum of all the approved standard PO amounts.
• AgreementLineId: integer (int64)
  Read Only: true

  Value that uniquely identifies the purchase agreement line.
• AgreementNumber: string
  Read Only: true

  Maximum Length: 30

  Number that uniquely identifies the purchase agreement.
• AgreementStartDate: string
  Read Only: true

  Date when the purcahse agreement goes into effect.
• ConfiguredItemFlag: string
  Maximum Length: 1

  Indicates whether or not the item configured. The values can be Yes or No. If the value is Yes, then item is configured.
• CurrencyCode: string
  Read Only: true

  Maximum Length: 15

  Abbreviation that identifies the currency for the order in buyer planning.
• DockDate: string
  Date when the material should be on the receiving dock when the order is released.
• ItemId: integer (int64)
  Value that uniquely identifies the item associated with the order in buyer planning.
• ItemPrice: number (double)
  Read Only: true

  Price per unit offered for the quantity range.
• ItemRevisionCode: string
  Maximum Length: 30

  Abbreviation that identifies the revision of the item on the purchase agreement.
• LineAgreementAmount: number (double)
  Read Only: true

  Value that identifies the amount agreed to for the planned or blanket purchase order line.
• LineAgreementQuantity: number (double)
  Read Only: true

  Value that identifies the total quanity of the item to be released against this agreement. It's the sum of all the approved standard PO line quantities.
• LineExpiryDate: string
  Read Only: true

  Date when the agreement line expires.
• LineMinimumReleaseAmount: number (double)
  Read Only: true

  Value that identifies the minimum amount that can be released against the PO line.
• LineNumber: string
  Read Only: true

  Maximum Length: 30

  Number that identifies the purchase agreement line.
• LineReleaseAmount: number (double)
  Read Only: true

  Value that identifies the amount released against this agreement. It's the sum of all the approved standard PO amounts.
• LocationId: integer (int64)
  Value that uniquely identifies the location associated to the order in buyer planning.
• MappedItemId: integer (int64)
  Value that uniquely identifies the mapped fusion item associated with the order in in buyer planning.
• MappedOrganizationId: integer (int64)
  Value that uniquely identifies the mapped fusion organization associated with the order in buyer planning.
• MappedSupplierId: integer (int64)
  Value that uniquely identifies the mapped fusion supplier from where the item is being sourced in buyer planning.
• OrderQuantity: number (double)
  Value that identifies the order quantity in buyer planning.
• OrderTotalPrice: number (double)
  Read Only: true

  Value that identifies the total price for order quantity in buyer planning.
• PoDiscount: number (double)
  Read Only: true

  Value that indicates the discount percent or amount of the purchase order line.
• PoDiscountType: string
  Read Only: true

  Maximum Length: 30

  Type of discount that indicates whether the discount is based on amount or percent.
• PoHeaderId: integer (int64)
  Value that uniquely identifies the purchase order in buyer planning.
• PoIsNewPriceApplicable: string
  Read Only: true

  Maximum Length: 1

  Indicates whether or not the agreement price is applicable to the order. The values can be Y or N. If the value is Yes, then the agreement price can be applied to the purchase order.
• PoLineId: integer (int64)
  Value that uniquely identifies the purchase order line in buyer planning.
• PriceBreakTypeCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the type of price break.
• PriceBreakTypeName: string
  Read Only: true

  Maximum Length: 30

  Indicates type of price break.
• PurchasingUomCode: string
  Read Only: true

  Maximum Length: 3

  Abbreviation that identifies the purchasing unit of measure associated with the purchase agreement.
• SupplierSite: string
  Maximum Length: 30

  Abbreviation that indicates the specific supplier site from where the item is being sourced in buyer planning.
• UomCode: string
  Maximum Length: 30

  Abbreviation that identifies the unit of measure associated to the order in buyer planning.

{
    "type":"object",
    "properties":{
        "MappedSupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the mapped fusion supplier  from where the item is being sourced in buyer planning.",
            "format":"int64",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":18
            }
        },
        "SupplierSite":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that indicates the specific supplier site from where the item is being sourced in buyer planning.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "ItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item associated with the order in buyer planning.",
            "format":"int64",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":18
            }
        },
        "MappedItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the mapped fusion item associated with the order in in buyer planning.",
            "format":"int64",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":18
            }
        },
        "ItemPrice":{
            "type":"number",
            "description":"Price per unit offered for the quantity range.",
            "format":"double",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":18
            }
        },
        "ItemRevisionCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the revision of the item on the purchase agreement.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "ConfiguredItemFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether or not the item configured. The values can be Yes or No. If the value is Yes, then item is configured.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "UomCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure associated to the order in buyer planning.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "MappedOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the mapped fusion organization associated with the order in buyer planning.",
            "format":"int64",
            "nullable":false,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":18
            }
        },
        "OrderQuantity":{
            "type":"number",
            "description":"Value that identifies the order quantity in buyer planning.",
            "format":"double",
            "nullable":false,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":18
            }
        },
        "DockDate":{
            "type":"string",
            "description":"Date when the material should be on the receiving dock when the order is released.",
            "nullable":false,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "LocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the location associated to the order in buyer planning.",
            "format":"int64",
            "nullable":false,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":18
            }
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Abbreviation that identifies the currency for the order in buyer planning.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "PoHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase order in buyer planning.",
            "format":"int64",
            "nullable":false,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":18
            }
        },
        "PoLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase order line in buyer planning.",
            "format":"int64",
            "nullable":false,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":18
            }
        },
        "AgreementHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase agreement.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":18
            }
        },
        "AgreementLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase agreement line.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":18
            }
        },
        "AgreementNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Number that uniquely identifies the purchase agreement.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "AgreementHeaderReleaseAmount":{
            "type":"number",
            "description":"Value that identifies the amount released against this agreement. It's the sum of all the approved standard PO amounts.",
            "format":"double",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":18
            }
        },
        "AgreementHeaderAmount":{
            "type":"number",
            "description":"Value that identifies the amount agreed to for the planned or blanket purchase order.",
            "format":"double",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":18
            }
        },
        "AgreementStartDate":{
            "type":"string",
            "description":"Date when the purcahse agreement goes into effect.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "AgreementEndDate":{
            "type":"string",
            "description":"Date when the purcahse agreement expires.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "AgreementHeaderMinReleaseAmount":{
            "type":"number",
            "description":"Value that identifies the minimum amount that can be released against the sum of all the PO line amounts.",
            "format":"double",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":18
            }
        },
        "AgreementCurrencyCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the currency for the purchase agreement.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "LineNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Number that identifies the purchase agreement line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "LineMinimumReleaseAmount":{
            "type":"number",
            "description":"Value that identifies the minimum amount that can be released against the PO line.",
            "format":"double",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":18
            }
        },
        "LineReleaseAmount":{
            "type":"number",
            "description":"Value that identifies the amount released against this agreement. It's the sum of all the approved standard PO amounts.",
            "format":"double",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":18
            }
        },
        "LineAgreementQuantity":{
            "type":"number",
            "description":"Value that identifies the total quanity of the item to be released against this agreement. It's the sum of all the approved standard PO line quantities.",
            "format":"double",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":18
            }
        },
        "LineAgreementAmount":{
            "type":"number",
            "description":"Value that identifies the amount agreed to for the planned or blanket purchase order line.",
            "format":"double",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":18
            }
        },
        "LineExpiryDate":{
            "type":"string",
            "description":"Date when the agreement line expires.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "OrderTotalPrice":{
            "type":"number",
            "description":"Value that identifies the total price for order quantity in buyer planning.",
            "format":"double",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":18
            }
        },
        "PurchasingUomCode":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the purchasing unit of measure associated with the purchase agreement.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "PriceBreakTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the type of price break.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "PriceBreakTypeName":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates type of price break.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "PoDiscountType":{
            "maxLength":30,
            "type":"string",
            "description":"Type of discount that indicates whether the discount is based on amount or percent.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "PoDiscount":{
            "type":"number",
            "description":"Value that indicates the discount percent or amount of the purchase order line.",
            "format":"double",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":18
            }
        },
        "PoIsNewPriceApplicable":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether or not the agreement price is applicable to the order. The values can be Y or N. If the value is Yes, then the agreement price can be applied to the purchase order.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        }
    }
}

Nested Schema : buyerPlanningAgreements-item-response-allOf[1]

Type: object

Show Source

• priceBreaks: array priceBreaks

{
    "type":"object",
    "properties":{
        "priceBreaks":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/buyerPlanningAgreements-priceBreaks-item-response"
            }
        }
    }
}

Nested Schema : priceBreaks

Type: array

Show Source

• Array of: buyerPlanningAgreements-priceBreaks-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/buyerPlanningAgreements-priceBreaks-item-response"
    }
}

Nested Schema : buyerPlanningAgreements-priceBreaks-item-response

Match All

Show Source

• object buyerPlanningAgreements-priceBreaks-item

{
    "allOf":[
        {
            "$ref":"#/components/schemas/buyerPlanningAgreements-priceBreaks-item"
        }
    ]
}

Nested Schema : buyerPlanningAgreements-priceBreaks-item

Type: object

Show Source

• EndDate: string
  Read Only: true

  Date when the price break expires.
• LocationCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the location on a price break.
• LocationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the location associated with the price break.
• MappedOrganizationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the mapped fusion organization associated with the price break.
• OrganizationCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the organization associated with the price break.
• Price: number (double)
  Read Only: true

  Value that identifies the break price for blanket purchase orders when a discount percent is applied.
• PriceBreakId: integer (int64)
  Read Only: true

  Value that uniquely identifies the price break.
• PriceDiscount: number (double)
  Read Only: true

  Percentage reduction in the line price or the response price that the supplier can offer depending upon certain quantities, or locations in a price break.
• PurchaseAgreemenLineId: integer (int64)
  Read Only: true

  Value that uniquely identifies the purchase agreement line.
• PurchaseAgreementHeaderId: integer (int64)
  Read Only: true

  Value that uniquely identifies the purchase agreement.
• Quantity: number (double)
  Read Only: true

  Quantity needed to obtain the price break.
• StartDate: string
  Read Only: true

  Date when the price break goes into effect.

{
    "type":"object",
    "properties":{
        "PurchaseAgreementHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase agreement.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":18
            }
        },
        "PurchaseAgreemenLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase agreement line.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":18
            }
        },
        "LocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the location associated with the price break.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":18
            }
        },
        "LocationCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the location on a price break.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "MappedOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the mapped fusion organization associated with the price break.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":18
            }
        },
        "OrganizationCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the organization associated with the price break.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "PriceBreakId":{
            "type":"integer",
            "description":"Value that uniquely identifies the price break.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":18
            }
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity needed to obtain the price break.",
            "format":"double",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":18
            }
        },
        "Price":{
            "type":"number",
            "description":"Value that identifies the break price for blanket purchase orders when a discount percent is applied.",
            "format":"double",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":18
            }
        },
        "PriceDiscount":{
            "type":"number",
            "description":"Percentage reduction in the line price or the response price that the supplier can offer depending upon certain quantities, or locations in a price break.",
            "format":"double",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":18
            }
        },
        "StartDate":{
            "type":"string",
            "description":"Date when the price break goes into effect.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "EndDate":{
            "type":"string",
            "description":"Date when the price break expires.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        }
    }
}

Back to Top