GET
/
v1
/
contracts
/
{contractId}

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-site-context
string
required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Path Parameters

contractId
string
required

contractId of the contract to delete

Response

200 - application/json
_id
string
required

Fabric internal id of the record

contractId
string
required

contract id. It must have 2 or more characters.

partyId
string
required

Fabric internal id for party

status
enum<string>
required

status. Default value will be DRAFT.

Available options:
ACTIVE,
DRAFT,
INACTIVE
startDate
string
required

start date of the contract. It should be lower that the end date.

endDate
string
required

end date of the contract. It should be after the start date.

onContract
boolean
required

on contract flag. The default value is false.

promotionStacking
boolean
required

promotion stacking flag. The default value is false.

isDeleted
boolean
required

flag that indicates if the record is deleted

createdAt
string
required

date of creation of the record

updatedAt
string
required

laste date of update of the record

addressId
string

Fabric internal id for address

accountId
string

Fabric internal id for account

contractType
string

contract type

additionalAttributes
object

Contains all additional attributes not captured in the schema.

priceLists
object[]

This variable only has data if the contract has a related priceListId

party
object

data of the related party

Was this page helpful?

Update contractDelete contract