Contracts

The contract object represents a transaction for goods and services between the buyer (customer) and seller (organization). The contract is stored in the source and is used for provisioning.

Diagram

../_images/contracts_erd.svg

Table description

Column name

Data type

Description

id

BIGINT

An identifier for looking up or referencing this specific object.

org_id

INTEGER

An identifier referencing the organization related to this object.

env_id

INTEGER

An identifier referencing the environment related to this object.

branch_id

INTEGER

An identifier referencing the branch related to this object.

created_at

TIMESTAMP

A timestamp for when this row was first created.

durable_id

VARCHAR

An identifier for looking up or referencing this specific object. It will not change over time.

prorate

BOOLEAN

A boolean that determines whether or not proration is applied to the object.

started_at

TIMESTAMP

A timestamp that represents the beginning of the objects billing period. This timestamp is inclusive.

ended_at

TIMESTAMP

A timestamp that represents the completion of the objects billing period. This timestamp is exclusive.

customer_id

VARCHAR

An identifier referencing a customer. Refers to customers.durable_id.

pricebook_id

VARCHAR

An identifier referencing a pricebook. Refers to pricebooks.durable_id.

void

BOOLEAN

A boolean that signifies whether or not to ignore the object.

voided_at

TIMESTAMP

A timestamp for when this object was voided.

archived_at

TIMESTAMP

A timestamp for when this object was archived.

effective_at

TIMESTAMP

A timestamp that represents the beginning of the objects active period. This timestamp is inclusive.

ineffective_at

TIMESTAMP

A timestamp that represents the completion of the objects active period. This timestamp is exclusive.

version

INTEGER

An incrementing integer which denotes the most up to date object associated with an ID.