Search Knowledge Base Articles

API Guide Items- Contracts - Add New Contract

Contracts - Add New Contract

POST yourdomain.com/api/contracts

Header

json
Field Type Description
Authorization String

Basic Access Authentication token.

Parameter

json
Field Type Description
subject String

Mandatory. Contract subject
datestart Date

Mandatory. Contract start date
client Number

Mandatory. Customer ID
dateend Date

Optional. Contract end date
contract_type Number

Optional. Contract type
contract_value Number

Optional. Contract value
description String

Optional. Contract description
content String

Optional. Contract content

Success 200

json
Field Type Description
status Boolean

Request status.
message String

Contracts Added Successfully

Error 4xx

json
Name Type Description
status Boolean

Request status.
message String

Contract add fail
  • Success-Response:
HTTP/1.1 404 Not Found
{
  "status": false,
  "message": "Contract ID Exists"
}
  • Error-Response: 
    HTTP/1.1 404 Not Found
{
  "status": false,
  "message": "Contract ID Exists"
}
  • Error-Response: 
    HTTP/1.1 404 Not Found
   {
	    "status": false,
	    "error": {
	        "newitems[]": "The Start date field is required"
	    },
	    "message": "<p>The Start date field is required</p>\n"
	}
  • Error-Response: 
      HTTP/1.1 404 Not Found
   {
	    "status": false,
	    "error": {
	        "subtotal": "The Subject field is required"
	    },
	    "message": "<p>The Subject field is required</p>\n"
	}
  • Error-Response:
  HTTP/1.1 404 Not Found
   {
	    "status": false,
	    "error": {
	        "total": "The Customer ID is required"
	    },
	    "message": "<p>The Customer ID is required</p>\n"
	}

Did you find this article useful?

Related Articles