Jump to

• Request
• Response

Update Obligation Component

post

/services/private/ObligationUpload/modifyObligationComp

This service is used to update obligation component.

Request

Header Parameters

• Accept-Language:
  Accept-Language header

  Example:

  en-US

Supported Media Types

• application/xml
• application/json

Request Body - application/xml ()

Modify Obligation Component RDO

Root Schema : schema

Type: object

Show Source

• attributeNames: array attributeNames
• attributes: array attributes
• checkAuthNo: string
• comments: string
• currency: string
• exchangeRate: number
• hyperMediaContent: object hyperMediaContent
• invoice: string
• invoiceDate: string
• jsonFieldNameMap: object jsonFieldNameMap
  Additional Properties Allowed: additionalProperties
• keyValue1: string
• keyValue2: string
• keyValue3: string
• keyValue4: string
• keyValue5: string
• keyValue6: string
• links: array links
• obligationCompTbl: array obligationCompTbl
• obligationKey: number
• obligationLevel: string
• paidAmt: number
• paidDate: string
• partnerId: string
• partnerType: string
• paymentMethod: string
• qty: number
• qtyUom: string
• status: string
• supplierSite: number

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        },
        "attributeNames":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "attributes":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "jsonFieldNameMap":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "obligationKey":{
            "type":"number"
        },
        "obligationLevel":{
            "type":"string"
        },
        "keyValue1":{
            "type":"string"
        },
        "keyValue2":{
            "type":"string"
        },
        "keyValue3":{
            "type":"string"
        },
        "keyValue4":{
            "type":"string"
        },
        "keyValue5":{
            "type":"string"
        },
        "keyValue6":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "partnerType":{
            "type":"string"
        },
        "partnerId":{
            "type":"string"
        },
        "supplierSite":{
            "type":"number"
        },
        "invoice":{
            "type":"string"
        },
        "invoiceDate":{
            "type":"string"
        },
        "qty":{
            "type":"number"
        },
        "qtyUom":{
            "type":"string"
        },
        "currency":{
            "type":"string"
        },
        "exchangeRate":{
            "type":"number"
        },
        "paymentMethod":{
            "type":"string"
        },
        "checkAuthNo":{
            "type":"string"
        },
        "paidAmt":{
            "type":"number"
        },
        "paidDate":{
            "type":"string"
        },
        "comments":{
            "type":"string"
        },
        "obligationCompTbl":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RestObligationCompRec"
            }
        },
        "hyperMediaContent":{
            "type":"object"
        }
    }
}

Nested Schema : attributeNames

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : attributes

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : hyperMediaContent

Type: object

Nested Schema : jsonFieldNameMap

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : obligationCompTbl

Type: array

Show Source

• Array of: object RestObligationCompRec

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RestObligationCompRec"
    }
}

Nested Schema : items

Type: object

Nested Schema : Link

Type: object

Show Source

• href: string
• methodType: string
• rel: string
• type: string

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string"
        },
        "rel":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "methodType":{
            "type":"string"
        }
    }
}

Nested Schema : RestObligationCompRec

Type: object

Show Source

• allocateToAlc: string
• allocationBasisUom: string
• allocationType: string
• amt: number
• attributeNames: array attributeNames
• attributes: array attributes
• compId: string
• hyperMediaContent: object hyperMediaContent
• jsonFieldNameMap: object jsonFieldNameMap
  Additional Properties Allowed: additionalProperties
• links: array links
• obligationCompLocTbl: array obligationCompLocTbl
• perCount: number
• perCountUom: string
• rate: number

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        },
        "attributeNames":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "attributes":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "jsonFieldNameMap":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "compId":{
            "type":"string"
        },
        "allocateToAlc":{
            "type":"string"
        },
        "allocationType":{
            "type":"string"
        },
        "allocationBasisUom":{
            "type":"string"
        },
        "amt":{
            "type":"number"
        },
        "rate":{
            "type":"number"
        },
        "perCount":{
            "type":"number"
        },
        "perCountUom":{
            "type":"string"
        },
        "obligationCompLocTbl":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RestObligationCompLocRec"
            }
        },
        "hyperMediaContent":{
            "type":"object"
        }
    }
}

Nested Schema : attributeNames

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : attributes

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : hyperMediaContent

Type: object

Nested Schema : jsonFieldNameMap

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : obligationCompLocTbl

Type: array

Show Source

• Array of: object RestObligationCompLocRec

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RestObligationCompLocRec"
    }
}

Nested Schema : items

Type: object

Nested Schema : RestObligationCompLocRec

Type: object

Show Source

• action: string
• amt: number
• attributeNames: array attributeNames
• attributes: array attributes
• hyperMediaContent: object hyperMediaContent
• jsonFieldNameMap: object jsonFieldNameMap
  Additional Properties Allowed: additionalProperties
• links: array links
• locId: number
• locType: string
• qty: number

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        },
        "attributeNames":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "attributes":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "jsonFieldNameMap":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "action":{
            "type":"string"
        },
        "locType":{
            "type":"string"
        },
        "locId":{
            "type":"number"
        },
        "qty":{
            "type":"number"
        },
        "amt":{
            "type":"number"
        },
        "hyperMediaContent":{
            "type":"object"
        }
    }
}

Nested Schema : attributeNames

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : attributes

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : hyperMediaContent

Type: object

Nested Schema : jsonFieldNameMap

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : items

Type: object

Request Body - application/json ()

Modify Obligation Component RDO

Root Schema : schema

Type: object

Show Source

• attributeNames: array attributeNames
• attributes: array attributes
• checkAuthNo: string
• comments: string
• currency: string
• exchangeRate: number
• hyperMediaContent: object hyperMediaContent
• invoice: string
• invoiceDate: string
• jsonFieldNameMap: object jsonFieldNameMap
  Additional Properties Allowed: additionalProperties
• keyValue1: string
• keyValue2: string
• keyValue3: string
• keyValue4: string
• keyValue5: string
• keyValue6: string
• links: array links
• obligationCompTbl: array obligationCompTbl
• obligationKey: number
• obligationLevel: string
• paidAmt: number
• paidDate: string
• partnerId: string
• partnerType: string
• paymentMethod: string
• qty: number
• qtyUom: string
• status: string
• supplierSite: number

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        },
        "attributeNames":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "attributes":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "jsonFieldNameMap":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "obligationKey":{
            "type":"number"
        },
        "obligationLevel":{
            "type":"string"
        },
        "keyValue1":{
            "type":"string"
        },
        "keyValue2":{
            "type":"string"
        },
        "keyValue3":{
            "type":"string"
        },
        "keyValue4":{
            "type":"string"
        },
        "keyValue5":{
            "type":"string"
        },
        "keyValue6":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "partnerType":{
            "type":"string"
        },
        "partnerId":{
            "type":"string"
        },
        "supplierSite":{
            "type":"number"
        },
        "invoice":{
            "type":"string"
        },
        "invoiceDate":{
            "type":"string"
        },
        "qty":{
            "type":"number"
        },
        "qtyUom":{
            "type":"string"
        },
        "currency":{
            "type":"string"
        },
        "exchangeRate":{
            "type":"number"
        },
        "paymentMethod":{
            "type":"string"
        },
        "checkAuthNo":{
            "type":"string"
        },
        "paidAmt":{
            "type":"number"
        },
        "paidDate":{
            "type":"string"
        },
        "comments":{
            "type":"string"
        },
        "obligationCompTbl":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RestObligationCompRec"
            }
        },
        "hyperMediaContent":{
            "type":"object"
        }
    }
}

Nested Schema : attributeNames

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : attributes

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : hyperMediaContent

Type: object

Nested Schema : jsonFieldNameMap

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : obligationCompTbl

Type: array

Show Source

• Array of: object RestObligationCompRec

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RestObligationCompRec"
    }
}

Nested Schema : items

Type: object

Nested Schema : Link

Type: object

Show Source

• href: string
• methodType: string
• rel: string
• type: string

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string"
        },
        "rel":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "methodType":{
            "type":"string"
        }
    }
}

Nested Schema : RestObligationCompRec

Type: object

Show Source

• allocateToAlc: string
• allocationBasisUom: string
• allocationType: string
• amt: number
• attributeNames: array attributeNames
• attributes: array attributes
• compId: string
• hyperMediaContent: object hyperMediaContent
• jsonFieldNameMap: object jsonFieldNameMap
  Additional Properties Allowed: additionalProperties
• links: array links
• obligationCompLocTbl: array obligationCompLocTbl
• perCount: number
• perCountUom: string
• rate: number

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        },
        "attributeNames":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "attributes":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "jsonFieldNameMap":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "compId":{
            "type":"string"
        },
        "allocateToAlc":{
            "type":"string"
        },
        "allocationType":{
            "type":"string"
        },
        "allocationBasisUom":{
            "type":"string"
        },
        "amt":{
            "type":"number"
        },
        "rate":{
            "type":"number"
        },
        "perCount":{
            "type":"number"
        },
        "perCountUom":{
            "type":"string"
        },
        "obligationCompLocTbl":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RestObligationCompLocRec"
            }
        },
        "hyperMediaContent":{
            "type":"object"
        }
    }
}

Nested Schema : attributeNames

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : attributes

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : hyperMediaContent

Type: object

Nested Schema : jsonFieldNameMap

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : obligationCompLocTbl

Type: array

Show Source

• Array of: object RestObligationCompLocRec

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RestObligationCompLocRec"
    }
}

Nested Schema : items

Type: object

Nested Schema : RestObligationCompLocRec

Type: object

Show Source

• action: string
• amt: number
• attributeNames: array attributeNames
• attributes: array attributes
• hyperMediaContent: object hyperMediaContent
• jsonFieldNameMap: object jsonFieldNameMap
  Additional Properties Allowed: additionalProperties
• links: array links
• locId: number
• locType: string
• qty: number

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        },
        "attributeNames":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "attributes":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "jsonFieldNameMap":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "action":{
            "type":"string"
        },
        "locType":{
            "type":"string"
        },
        "locId":{
            "type":"number"
        },
        "qty":{
            "type":"number"
        },
        "amt":{
            "type":"number"
        },
        "hyperMediaContent":{
            "type":"object"
        }
    }
}

Nested Schema : attributeNames

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : attributes

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : hyperMediaContent

Type: object

Nested Schema : jsonFieldNameMap

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : items

Type: object

Examples

Select an example

Back to Top

Response

Supported Media Types

• application/xml
• application/json

Default Response

default response

Body ()

Root Schema : Record

Type: object

Show Source

• attributeNames: array attributeNames
• attributes: array attributes
• hyperMediaContent: object hyperMediaContent
• jsonFieldNameMap: object jsonFieldNameMap
  Additional Properties Allowed: additionalProperties
• links: array links

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        },
        "attributeNames":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "attributes":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "jsonFieldNameMap":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "hyperMediaContent":{
            "type":"object"
        }
    }
}

Nested Schema : attributeNames

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : attributes

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : hyperMediaContent

Type: object

Nested Schema : jsonFieldNameMap

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : items

Type: object

Nested Schema : Link

Type: object

Show Source

• href: string
• methodType: string
• rel: string
• type: string

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string"
        },
        "rel":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "methodType":{
            "type":"string"
        }
    }
}

Back to Top