Sign in
Contract

Retrieves a Contract resource.

Retrieves a Contract resource.

get/contracts/{id}

Path parameters

idstring required

Resource identifier

Response

Contract resource

idstring
integrationstring

The key of the integration source e.g. "quickbooks", or "xero"

srcIdstring

the unique identifier of the source 3rd party integration

contractNamestring nullable

contract name

customerstring nullable

customer related to the contract

contractDatestring date-time nullable

when the contract is signed

startDatestring date-time nullable

when the contract will start

endDatestring date-time nullable

when the contract will end

descriptionstring nullable

additional details about the contract

statusstring nullable

status of the contract e.g: activated, draft

Example response

{
  "integration": "quickbooks"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.