Get organization contract

Authorizations

Authorization

string

header

required

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

organizationId

string

required

Fabric internal id of the record.

contractId

string

required

Fabric internal id of the record or contract id.

Query Parameters

includeDeleted

boolean

default:

false

Whether to fetch contracts that have already been deleted or not.

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.

createdAt

string

required

date of creation of the record

endDate

string

required

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

isDeleted

boolean

required

flag that indicates if the record is deleted

onContract

boolean

required

on contract flag. The default value is false.

partyId

string

required

Fabric internal id for party

promotionStacking

boolean

required

promotion stacking flag. The default value is false.

startDate

string

required

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

status

enum<string>

required

status. Default value will be DRAFT.

Available options:

ACTIVE,

DRAFT,

INACTIVE

updatedAt

string

required

laste date of update of the record

accountId

string

Fabric internal id for account

additionalAttributes

object

Contains all additional attributes not captured in the schema.

addressId

string

Fabric internal id for address

contractType

string

contract type

party

object

data of the related party

Show child attributes

party.additionalAttributes

object

Contains all additional attributes not captured in the schema.

party.email

string

party.isActive

boolean

party.name

string

party.parentPartyId

string

party.partyType

enum<string>

Available options:

H,

O,

P,

C

priceLists

object[]

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

Show child attributes

priceLists._id

string

Fabric internal id of the record

priceLists.contractId

string

Fabric internal id of the contract

priceLists.createdAt

string

date of creation of the relationship

priceLists.priceListId

integer

A unique identifier of the priceList event. The price list ID.

priceLists.updatedAt

string

last date of update of the relationship