Create 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.

Body

application/json

endDate

string

required

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

startDate

string

required

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

additionalAttributes

object

Contains all additional attributes not captured in the schema.

contractId

string

contract id. It must have 2 or more characters. If not sent an internal contractId will be generated.

contractType

string

contract type

priceListId

integer

price list id to create a relationship priceList-contract if sent.

status

enum<string>

status. If not sent, the default value will be DRAFT.

Available options:

ACTIVE,

DRAFT,

INACTIVE

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

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

contractPriceList

object

this relationship we'll be created only if priceListId was sent in the request body

Show child attributes

contractPriceList._id

string

Fabric internal id of the record

contractPriceList.contractId

string

Fabric internal id of the contract

contractPriceList.createdAt

string

date of creation of the record

contractPriceList.priceListId

string

price list ID

contractPriceList.updatedAt

string

laste date of update of the record

contractType

string

contract type