Get a Contract by Id
get
https://api.mercadoe.com/v1/contracts/{contractId}
Get information about a specific contract with the given contractId.
Request
Path Parameters
contractId
int32
required
The contract Id in ME
Responses
200
404
OK
Body
application/json
contractId
int32
ME contract Id
description
string
Contract brief description
category
string
Contract category
supplierClientId
string
Supplier Id in client’s ERP
integrationTag
string
Identification of the ME user used in the integration.
startDate
date-time
Contract start date
endDate
date-time
Contract end date
clientPaymentConditionId
string
Payment condition code
freightValue
double | null
Freight value
currency
string
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
double | null
Contract total value
fixedValue
double | null
Contract fixed value
usedValue
double | null
Contract used value
contractCode
int32 | null
Contract type code
documentDate
date-time
Document date
note
string
Contract notes
isCreatedPreOrderAutomatically
boolean | null
This flag indicates if the pre-order is generated automatically.
isControlsBalance
boolean | null
This flag indicates if the contract balance is controlled by workflow.
isRequestEstimatedPriceInPreOrder
boolean | null
This flag indicates if the request estimated price is used in pre-order creation.
quotationId
int32 | null
Quotation Id associated with the contract.
isActive
boolean | null
This flag indicates if the contract is active.
supplierId
int32 | null
Supplier Id in ME
buyerId
int32 | null
Buyer Id in ME
purchasingGroup
string | null
Purchasing Group
attributes
array of object
Attributes of the contract, consisting of a name and a value.
balanceControl
string
allowed values:
NoBalanceControlQuantityValueItemValue