Get a Contract By Id

This service returns details of a single contract

Query String Parameters

Name	Type	Description	Required
Action	String	ContractsById	Required
ContractId	Int	The unique identifier of the contract	Required
IncludeStock	Bool	Include Stock items in response	Optional

Response Codes

Example

Request

Request URL

https://webservice.bigchange.com/v01/services.ashx?action=ContractsById&ContractId=304734&IncludeStock=1

Response

Response Data

{
  "Code": 0,
  "Result": {
    "ContractId": 304734,
    "ContractContactId": 30967687,
    "ContractName": null,
    "ContractCreationDate": "2024-10-15 14:01:21",
    "ContractReference": "Test1",
    "ContractEndDate": null,
    "ContractInitialAmount": 1,
    "ContractCurrency": "GBP",
    "ContractMinimumPeriod": {
      "RecurrenceId": 95659848,
      "EntityType": 5,
      "Recurrence": 1,
      "DaysOfWeek": [],
      "DayOfMonth": 1,
      "Interval": 1,
      "EndDate": "2025-11-01 00:00:00",
      "RepeatCount": 2,
      "StartDate": "2024-11-01 00:00:00",
      "HourScheduledLocal": 0,
      "LinkedAction": 0
    },
    "ContractStartDate": "2024-11-01 00:00:00",
    "ContractPayments": 1.23,
    "ContractNotes": "",
    "ContractInternalNotes": "",
    "ContractDescription": "Line 1"
  }
}