Description
This document describes the ISPnext API entry point for Contracts.
General
Entry Point Reference
Methods
POST Contracts
Location
https://XXX.vendorlink.nl/API/Contracts/Contracts
Header
- Key "Authorization", Value "Bearer <accessToken>"
Querystring parameters
- none
Body
{
"version": 1,
"operation": string, (supported values: "insert", "update", "delete")
"data": [
{
{
"SupplierContractId": int (not available for insert, mandatory for delete, update),
"SupplierId": int (optional for delete, update, mandatory for insert),
"Name": string (optional, mandatory for insert),
"Description": string (optional),
"Number1": string (optional),
"Number2": string (optional),
"Number3": string (optional),
"StartDate": datetime (optional)(YYYY-MM-DD HH:MM:SS.mmm),
"EndDate": datetime (optional)(YYYY-MM-DD HH:MM:SS.mmm),
"Status": string (optional),
"Sharing": boolean (optional),
"StatusCode": int (optional),
"TerminatePeriodNum": number(optional),
"TerminatePeriodAlf": string (optional)(y,q,m,w,d),
"OptionSilentRenewal": int (optional),
"RenewalTermNumber": number(optional),
"RenewalTermUnit": string (optional)(y,q,m,w,d),
"RenewalsCount": int (optional),
"Remarks": string (optional),
"TerminationDate": datetime (optional)(YYYY-MM-DD HH:MM:SS.mmm),
"IndexInfo": string (optional),
"PurchasingConditions": boolean (optional),
"Currency": string (optional) "<ISO>",
"Archived": int (optional, can not be 1 if Concept = true),
"ArchivedDate": datetime (optional)(YYYY-MM-DD HH:MM:SS.mmm),
"ProjectNummer": string (optional),
"Concept": boolean (optional, can not be true if Archived = 1),
"Weight": number(optional),
"RenewalTermDate": datetime (optional)(YYYY-MM-DD HH:MM:SS.mmm),
"NoCompliance": boolean (optional),
"TypeId": int(optional, do not use in combination with TypeExternalId),
"TypeExternalId": string(optional, do not use in combination with TypeId),
"CostCentreIds": [] string (optional, do not use in combination with CostCentreExternalIds),
"CostCentreExternalIds": [] string (optional, do not use in combination with CostCentreIds),
"OwnerUserid": int (optional),
"ParentId": int (optional, do not use in combination with ParentName),
"ParentName": string (optional, do not use in combination with ParentId),
"ProcedureId": int (optional),
"CompanyId": int (optional),
"ExternalId": string (optional),
"CustomFields": [
{
"Name": string (mandatory),
"Value": string (mandatory)
},
{
"Name": string (mandatory),
"Value": string (mandatory)
}
]
}
}
]
}
Response
{
"hasErrors": bool,
"messages": array
}
Remarks
The messages array consists of objects:
{
severity: string,
message: string,
Data: object
}
Please note that data will contain the original sent object that was inserted, or for which the error occurred.
Contract Field requirements depend on the field configuration of the environment done via Admin -> Contract Settings -> Customization -> Contract Field Visibility.