ISPnext API - Contracts

Description

This document describes the ISPnext API entry point for Contracts.

General

Entry Point Reference

Methods

POSTObligations

Location

https://XXX.vendorlink.nl/API/ContractObligations/ContractObligations

Header

Key "Authorization", Value "Bearer <accessToken>"

Querystring parameters

none

Body

{
	"version": 1,
	"operation": string, (supported values: "insert", "update", "delete")
	"data": [
		{
            "ContractObligationId": int (optional, mandatory for delete, update),
            "ContractId": int (optional, mandatory for insert, update),
            "Description": string (optional, mandatory for insert, update),
            "Year": int (optional, mandatory for insert, update),
            "Month": int (optional, mandatory for insert, update),
            "Amount": number (optional, mandatory for insert, update),
            "SupplierReference": string (optional, mandatory for insert, update),
            "CommodityId": int (optional),
            "CostCentreId": int (optional),
            "CostTypeId": int (optional)
        }
	]
}

Response

{
    "hasErrors": bool,
    "messages": array
}

Remarks

In case of errors, the messages array consists of objects:

{
    severity: string,
    message: string,
    Data: object
}

Please note that data will contain the original sent object for which the error occurred.