Update a contract based on the contractId
patch
https://api.mercadoe.com/v1/contracts/{contractId}
Change a specific contract field with a provided value.
Request
Path Parameters
contractId
int32
required
The contract Id in ME
Body
application/json
clientContractId
string | null
Contract Id in client’s ERP
description
string | null
Contract brief description
category
string | null
Contract category
supplierId
int32 | null
Supplier Id in ME
clientSupplierId
string | null
Supplier Id in client’s ERP
integrationTag
string | null
Identification of the ME user used in the integration.
startDate
date-time | null
Contract start date
endDate
date-time | null
Contract end date
clientPaymentConditionId
string | null
Payment condition code
incoTerms
string | null
Freight code (Incoterms)
currencyCode
string | null
Currency in alphabetic code (for more information, please refer to: https://www.iso.org/iso-4217-currency-codes.html).
deliveryDeadline
int32 | null
Delivery deadline
status
int32 | null
Contract status
totalValue
float | null
Contract total value
fixedValue
float | null
Contract fixed value
usedValue
float | null
Contract used value
note
string | null
Contract notes
isPreOrderCreatedAutomatically
boolean | null
This flag indicates if the pre-order is generated automatically.
isControlledByBalance
boolean | null
This flag indicates if the contract balance is controlled by workflow.
isRequestEstimatedPriceUsedInPreOrder
boolean | null
This flag indicates if the request estimated price is used in pre-order creation.
isPreOrderBlockedIfEstimatedRequestDateGreaterThanContractEndDate
boolean | null
This flag indicates if the pre-order is blocked if the request estimated date is greather than contract end date.
purchasingGroup
string | null
Purchasing Group
attributes
array of object | null
Attributes of the contract, consisting of a name, a value and a description.
businessOrganizations
array of object | null
List with the Business Organizations comprising the Company Code, the Entity Type and their Descriptions.
items
array of object | null
List with the contract items
balanceControl
string
allowed values:
NoBalanceControlQuantityValueItemValueResponses
202
400
404
Accepted
Body
application/json
correlationId
string