Add or Update a Contract

This webservice will add or edit a contract based on the parameters listed below. Each of the parameters correspond to the section and field name of a contract. When running this web service, an output of the contract’s details is provided.

Query String Parameters

Name	Type	Description	Required
Action	String	ContractSave	Required
ContractId	Int	If amending an existing contract	Required
ContractReference	String	Specify if creating a new contract	Required
ContactId	Int	If contact reference not used	Required
ContactReference	String	If contact Id not used	Required
ContractLineDescription	String	Contract line description.	Required
Currency	String	Specify if creating a new contract	Required
VatCode	String	Specify if creating a new contract	Required
InitialPayment	Double	Specify if creating a new contract	Required
MinimumPayment	Double	Specify if creating a new contract	Required
MinimumContractStartDate	DateTime	Minimum period contract start date. Specify if creating a new contract	Required
Recurrence1	String	Minimum period payment recurrence. Specify if creating a new contract	Required
ContractCreationDate	DateTime	The date the contract is created	Optional
ContractEndDate	DateTime	The date the contract ends	Optional
NominalCode	String	The contracts nominal code	Optional
DepartmentCode	String	The contracts department code	Optional
VatCode	String	The contracts vat code	Optional
Currency	String	The contract currency. i.e. GBP	Optional
InitialPayment	Double	The initial payment of the contract	Optional
Recurrence1	String	Minimum period payment recurrence	Optional
MinimumContractStartDate	DateTime	Minimum period contract start date. See Recurrence format	Optional
MinimumPayment	Double	Minimum period payment	Optional
AfterMinimumStartDate	DateTime	After minimum period start date	Optional
Recurrence2	String	After minimum period recurrence. See Recurrence format	Optional
AfterMinimumPayment	Double	After minimum period payment	Optional
ContractLineDescription	String	Contracts invoice line description	Optional
ContractNotes	String	Contracts notes	Optional
ContractInternalNotes	String	Contracts Internal notes	Optional

Recurrence Format:

The recurrence strings are delimited by a pipe and they are split into the below parameters. Examples of the strings have been provided below.

Query String Parameters

Name	Split	Description	Note
Recurrence	0	Daily, Monthly, Weekly, Weekofmonth.
DaysOfWeek	1	Numerical value.	0 = Sunday, 6 = Saturday
DayOfMonth	2	Numerical value.	1 to 28
WeekOfMonth	3	Numerical value.	0 = last, 1 = First, 4 = Fourth
Interval	4	Occurs Every.
EndDate	5	End By.
RepeatCount	6	End After x occurrences.

Response Codes

Example

Request

Request URL

https://webservice.bigchange.com/v01/services.ashx?action=ContractSave&ContractReference=AGCTest1&ContactId=30967687&ContractLineDescription=Line 1&Currency=GBP&VatCode=001&InitialPayment=1&MinimumPayment=1&MinimumContractStartDate=2024-11-01&Recurrence1=Monthly||1||1|2025-11-01|2

Response

Response Data

{
  "Code": 0,
  "Result": {
    "ContractId": 304734
  }
}