Contract prices

The contract price represents a custom price for specific goods and services, they override list prices. From a modeling perspective, each contract price object represents a product within the context of a specific contract. The contract price is stored in the source and is used for pricing.

Diagram

../_images/contract_prices_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.

price

VARCHAR

A string that determines the rate of this object.

invoice_delivery

VARCHAR

A string that represents if the invoice will be delivered at the beginning of the month, “ADVANCED”, or at the end of the month, “ARREARS”

invoice_schedule

INTEGER

An integer for the number of months in a billing or service period.

start_period

INTEGER

An integer that determines what period the object will begin to be applied.

end_period

INTEGER

An integer that determines what period the object will stop being applied.

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.

fixed_quantity

DECIMAL(18,3)

A decimal that defines a static count of a product being sold.

prorate

BOOLEAN

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

product_uid

INTEGER

An identifier referencing a unique product row. Refers to product.id.

list_price_uid

INTEGER

An identifier referencing a unique list price row. Refers to list_prices.id.

contract_uid

INTEGER

An identifier referencing a unique contract row. Refers to contracts.id.

pricing_metadata

JSON

A JSON object that contains custom logic for pricing (user defined).

version

INTEGER

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