Get a List of Contracts

Returns a list of all financial contracts with contract dates that start and end based on the optional date parameters entered. The date format is based on yyyy-MM-dd only.

Query String Parameters

Name	Type	Description	Required
Action	String	ContractsList	Required
DateFrom	DateTime	Start date of the contract. Format: yyyy-MM-dd	Optional
DateTo	DateTime	End date of the contract. Format: yyyy-MM-dd	Optional
RowCount	Int	Adds a row count option to the routine to limit the number of rows returned	Optional
IncludeCustomFields	Bool	Include any custom fields. 1 = true, 0 = false	Optional

Response Codes

Example

Request

Request URL

https://webservice.bigchange.com/v01/services.ashx?action=ContractsList&DateFrom=2024-10-01&DateTo=2025-12-01

Response

Response Data

{
  "Code": 0,
  "Result": [
    {
      "ContractId": 77643,
      "ContractContactId": 17105910,
      "ContractName": "Contract Test",
      "ContractCreationDate": "2021-08-18 00:00:00",
      "ContractReference": "JEI/CON/001",
      "ContractEndDate": "2025-08-27 00:00:00",
      "ContractInitialAmount": null,
      "ContractCurrency": "GBP"
    }
  ]
}