Skip to content
API References
/
/
List Contracts

DualEntry Public API (1.0.0)

Download OpenAPI description
resources.json
resources.yaml
Languages
Servers
Production environment
https://api.dualentry.com
Development environment (for testing)
https://api-dev.dualentry.com

Health

Monitor API availability and service status. Use these endpoints to verify connectivity and check if the API is operational.

Operations

Accounts

Manage your chart of accounts. Create and maintain the accounts used to categorize financial transactions, including assets, liabilities, equity, revenue, and expenses.

Operations

Items

Manage products and services. Define items that appear on invoices and bills, including pricing, descriptions, and associated accounts for revenue or expense tracking.

Operations

Classifications

Manage custom classification dimensions. Create and maintain classification categories (e.g., departments, locations, projects) used to tag and analyze transactions across multiple dimensions.

Operations

Classifications Lines

Manage classification values. Define the specific values within each classification category that can be assigned to transaction line items for detailed reporting and analysis.

Operations

Companies

Access and manage company information. Retrieve details about your organization including legal name, tax identifiers, addresses, and accounting preferences.

Operations

Approval Policies

Manage approval workflows and policies. Define approval rules, steps, conditions, and approvers for different record types. Monitor workflow execution states and view approval history.

Operations

Inbox

View pending approvals and approval status. Access transactions and records awaiting approval across the organization, including full approval workflow details, approvers, and action history.

Operations

Budgets

Manage financial budgets. Create and track income statement and balance sheet budgets with monthly cell values, actuals comparison, and classification filtering.

Operations

Journal Entries

Create and manage manual journal entries. Record direct debits and credits to accounts for adjustments, accruals, reclassifications, and other accounting transactions.

Operations

Recurring Journal Entries

Automate recurring journal entries. Create templates for journal entries that occur regularly (e.g., monthly depreciation, amortization) to ensure consistent accounting treatment.

Operations

Bank Transfers

Manage bank-to-bank transfers. Record and track transfers between bank and credit card accounts, including multi-currency transfers with exchange rate handling.

Operations

Invoices

Manage sales invoices. Create and track invoices sent to customers for goods or services rendered, including line items, taxes, discounts, and payment status.

Operations

Contracts

Manage revenue recognition contracts. Create and retrieve contracts with performance obligations, and manage obligation usage for usage-based obligations.

Operations

List Contracts

Request

Query
searchstring or null(Search)
idArray of integers or null(Id)
company_idArray of integers or null(Company Id)
numberArray of integers or null(Number)
customer_idArray of integers or null(Customer Id)
statusArray of strings or null(Status)
Enum"draft""active""completed""archived"
start_datestring or null(date)(Start Date)
end_datestring or null(date)(End Date)
contract_start_datestring or null(date)(Contract Start Date)
contract_end_datestring or null(date)(Contract End Date)
orderingstring or null(Ordering)
Default "-updated_at"
limitinteger(Limit)>= 1

Number of records to return per page (capped at 100)

Default 100
offsetinteger(Offset)>= 0

Number of records to skip before starting to return results

Default 0
curl -i -X GET \
  'https://api.dualentry.com/public/v1/contracts/?search=string&id=0&company_id=0&number=0&customer_id=0&status=draft&start_date=2019-08-24&end_date=2019-08-24&contract_start_date=2019-08-24&contract_end_date=2019-08-24&ordering=-updated_at&limit=100&offset=0'

Responses

OK

Bodyapplication/json
itemsArray of objects(Items)required
items[].​custom_fieldsArray of objects(Custom Fields)
Default []
items[].​integration_remote_recordsArray of objects(Integration Remote Records)
Default []
items[].​idinteger(Id)required
items[].​numberinteger(Number)required
items[].​company_idinteger(Company Id)required
items[].​company_namestring(Company Name)required
items[].​company_currencystring(Company Currency)required
items[].​customer_idinteger(Customer Id)required
items[].​customer_namestring(Customer Name)required
items[].​namestring(Name)required
items[].​currency_iso_4217_codestring(SystemCurrencies)required
Enum"AED""AFN""ALL""AMD""ANG""AOA""ARS""AUD""AWG""AZN"
items[].​memostring(Memo)required
items[].​datestring(date)(Date)required
items[].​term_idinteger or null(Term Id)
items[].​start_datestring(date)(Start Date)required
items[].​end_datestring or null(date)(End Date)
items[].​bill_to_addressstring(Bill To Address)required
items[].​ship_to_addressstring(Ship To Address)required
items[].​billing_addressobject or null(AddressSchemaIn)
items[].​shipping_addressobject or null(AddressSchemaIn)
items[].​billing_start_datestring(date)(Billing Start Date)required
items[].​billing_frequencystring(RecognitionCadence)required
Enum"daily""weekly""monthly""annually"
items[].​billing_intervalinteger(Billing Interval)required
items[].​billing_anchor_weekdayinteger or null(Billing Anchor Weekday)
items[].​recognition_start_datestring(date)(Recognition Start Date)required
items[].​recognition_frequencystring(RecognitionCadence)required
Enum"daily""weekly""monthly""annually"
items[].​recognition_intervalinteger(Recognition Interval)required
items[].​recognition_anchor_weekdayinteger or null(Recognition Anchor Weekday)
items[].​statusstring(ContractStatus)required
Enum"draft""active""completed""archived"
items[].​record_statusstring(RecordStatus)required
Enum"draft""posted""archived"
items[].​is_lockedboolean(Is Locked)required
items[].​paymentobject or null(PaymentSchemaOut)

Schema for payment collection configuration output.

items[].​revenue_recognitionsArray of objects(Revenue Recognitions)required
items[].​revenue_recognitions[].​idinteger(Id)required
items[].​revenue_recognitions[].​numberinteger(Number)required
items[].​revenue_recognitions[].​contract_idinteger(Contract Id)required
items[].​revenue_recognitions[].​performance_obligation_idinteger or null(Performance Obligation Id)
items[].​revenue_recognitions[].​datestring(date)(Date)required
items[].​revenue_recognitions[].​transaction_datestring(date)(Transaction Date)required
items[].​revenue_recognitions[].​amountstring(Amount)^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$required
items[].​revenue_recognitions[].​transaction_idinteger(Transaction Id)required
items[].​revenue_recognitions[].​record_statusstring(RecordStatus)required
Enum"draft""posted""archived"
items[].​revenue_recognitions[].​income_account_idinteger(Income Account Id)required
items[].​revenue_recognitions[].​deferrered_revenue_account_idinteger(Deferrered Revenue Account Id)required
items[].​invoicesArray of objects(Invoices)required
items[].​invoices[].​idinteger(Id)required
items[].​invoices[].​numberinteger(Number)required
items[].​invoices[].​datestring(date)(Date)required
items[].​invoices[].​due_datestring(date)(Due Date)required
items[].​invoices[].​amountstring(Amount)^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$required
items[].​invoices[].​tax_amountstring(Tax Amount)^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$required
items[].​invoices[].​paid_totalstring(Paid Total)^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$required

Amount that was already paid by Customer Repayment Applications or Customer Payments

items[].​invoices[].​record_statusstring(RecordStatus)required
Enum"draft""posted""archived"
items[].​invoices[].​term_idinteger or null(Term Id)
items[].​obligationsArray of objects(Obligations)required
items[].​obligations[].​idinteger(Id)required
items[].​obligations[].​item_idinteger(Item Id)required
items[].​obligations[].​quantitystring(Quantity)^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,6}0*$required
items[].​obligations[].​ratestring(Rate)^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$required
items[].​obligations[].​positioninteger(Position)required
items[].​obligations[].​memostring(Memo)required
items[].​obligations[].​standalone_selling_pricestring or null(Standalone Selling Price)^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
items[].​obligations[].​term_idinteger or null(Term Id)
items[].​obligations[].​recognition_strategystring(RecognitionStrategy)
Default "straight_line"
Enum"straight_line""straight_line_start_end_even""daily_prorata""milestone""usage_tiered""usage""immediate""deposit_release"
items[].​obligations[].​obligation_conditionsobject(Obligation Conditions)
items[].​obligations[].​classificationsArray of objects(Classifications)
Default []
items[].​obligations[].​billing_start_datestring or null(date)(Billing Start Date)
items[].​obligations[].​billing_end_datestring or null(date)(Billing End Date)
items[].​obligations[].​billing_frequencystring or null(RecognitionCadence)
Enum"daily""weekly""monthly""annually"
items[].​obligations[].​billing_intervalinteger or null(Billing Interval)
items[].​obligations[].​sync_billing_with_recognitionboolean(Sync Billing With Recognition)
Default false
items[].​obligations[].​skip_invoice_generationboolean(Skip Invoice Generation)
Default false
items[].​obligations[].​recognition_start_datestring or null(date)(Recognition Start Date)
items[].​obligations[].​recognition_end_datestring or null(date)(Recognition End Date)
items[].​obligations[].​recognition_frequencystring or null(RecognitionCadence)
Enum"daily""weekly""monthly""annually"
items[].​obligations[].​recognition_intervalinteger or null(Recognition Interval)
items[].​obligations[].​discount_typestring or null(DiscountType)
Enum"PERCENTAGE""FIXED"
items[].​obligations[].​discount_valuestring or null(Discount Value)^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,6}0*$
items[].​obligations[].​amountstring(Amount)^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$read-onlyrequired

Gross amount before discount.

items[].​obligations[].​discount_amountstring(Discount Amount)^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$read-onlyrequired

Calculated discount amount.

items[].​obligations[].​net_amountstring(Net Amount)^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$read-onlyrequired

Net amount after discount.

countinteger(Count)required
Response
application/json
{
  "items": [
    { … }
  ],
  "count": 0
}

Create Contract

Request

Bodyapplication/jsonrequired
custom_fieldsArray of objects or null(Custom Fields)
memostring(Memo)required
datestring(date)(Date)required
start_datestring(date)(Start Date)required
end_datestring or null(date)(End Date)
company_idinteger(Company Id)required
customer_idinteger(Customer Id)required
namestring or null(Name)
currency_iso_4217_codestring(SystemCurrencies)required
Enum"AED""AFN""ALL""AMD""ANG""AOA""ARS""AUD""AWG""AZN"
bill_to_addressstring(Bill To Address)
Default ""
billing_addressobject or null(AddressSchemaIn)
ship_to_addressstring(Ship To Address)
Default ""
shipping_addressobject or null(AddressSchemaIn)
obligationsArray of objects(Obligations)required
obligations[].​item_idinteger(Item Id)required
obligations[].​quantityQuantity (number) or Quantity (string)(Quantity)required
Any of:
>= 0
number(Quantity)>= 0
obligations[].​rateRate (number) or Rate (string)(Rate)required
Any of:
number(Rate)
obligations[].​positioninteger(Position)required
obligations[].​memostring(Memo)required
obligations[].​standalone_selling_priceStandalone Selling Price (number) or Standalone Selling Price (string) or Standalone Selling Price (null)(Standalone Selling Price)
Any of:
number(Standalone Selling Price)
obligations[].​term_idinteger or null(Term Id)
obligations[].​recognition_strategystring(RecognitionStrategy)
Default "straight_line"
Enum"straight_line""straight_line_start_end_even""daily_prorata""milestone""usage_tiered""usage""immediate""deposit_release"
obligations[].​obligation_conditionsobject(Obligation Conditions)
obligations[].​classificationsArray of objects(Classifications)
Default []
obligations[].​billing_start_datestring or null(date)(Billing Start Date)
obligations[].​billing_end_datestring or null(date)(Billing End Date)
obligations[].​billing_frequencystring or null(RecognitionCadence)
Enum"daily""weekly""monthly""annually"
obligations[].​billing_intervalinteger or null(Billing Interval)
obligations[].​sync_billing_with_recognitionboolean(Sync Billing With Recognition)
Default false
obligations[].​skip_invoice_generationboolean(Skip Invoice Generation)
Default false
obligations[].​recognition_start_datestring or null(date)(Recognition Start Date)
obligations[].​recognition_end_datestring or null(date)(Recognition End Date)
obligations[].​recognition_frequencystring or null(RecognitionCadence)
Enum"daily""weekly""monthly""annually"
obligations[].​recognition_intervalinteger or null(Recognition Interval)
obligations[].​discount_typestring or null(DiscountType)
Enum"PERCENTAGE""FIXED"
obligations[].​discount_valueDiscount Value (number) or Discount Value (string) or Discount Value (null)(Discount Value)
Any of:
> 0
number(Discount Value)> 0
term_idinteger or null(Term Id)
billing_start_datestring or null(date)(Billing Start Date)
billing_frequencystring(RecognitionCadence)
Default "monthly"
Enum"daily""weekly""monthly""annually"
billing_intervalinteger(Billing Interval)>= 1
Default 1
billing_anchor_weekdayinteger or null(Billing Anchor Weekday)[ 0 .. 6 ]

Optional weekday anchor for weekly billing (0=Monday)

recognition_start_datestring or null(date)(Recognition Start Date)
recognition_frequencystring(RecognitionCadence)
Default "monthly"
Enum"daily""weekly""monthly""annually"
recognition_intervalinteger(Recognition Interval)>= 1
Default 1
recognition_anchor_weekdayinteger or null(Recognition Anchor Weekday)[ 0 .. 6 ]

Optional weekday anchor for weekly recognition (0=Monday)

statusstring(ContractStatus)required
Enum"draft""active""completed""archived"
contract_attachmentsArray of objects(Contract Attachments)
Default []
change_orders_attachmentsArray of objects(Change Orders Attachments)
Default []
paymentobject or null(PaymentSchemaIn)

Schema for payment collection configuration input (matches frontend structure).

prepared_invoicesArray of objects(Prepared Invoices)
Default []
revenue_recognitionsArray of objects(Revenue Recognitions)
Default []
curl -i -X POST \
  https://api.dualentry.com/public/v1/contracts/ \
  -H 'Content-Type: application/json' \
  -d '{
    "custom_fields": [
      {}
    ],
    "memo": "string",
    "date": "2019-08-24",
    "start_date": "2019-08-24",
    "end_date": "2019-08-24",
    "company_id": 0,
    "customer_id": 0,
    "name": "string",
    "currency_iso_4217_code": "AED",
    "bill_to_address": "",
    "billing_address": {
      "street": "string",
      "city": "string",
      "state": "",
      "postal_code": "string",
      "country": "",
      "second_line": "",
      "name": "string"
    },
    "ship_to_address": "",
    "shipping_address": {
      "street": "string",
      "city": "string",
      "state": "",
      "postal_code": "string",
      "country": "",
      "second_line": "",
      "name": "string"
    },
    "obligations": [
      {
        "item_id": 0,
        "quantity": 0,
        "rate": 0,
        "position": 0,
        "memo": "string",
        "standalone_selling_price": 0,
        "term_id": 0,
        "recognition_strategy": "straight_line",
        "obligation_conditions": {},
        "classifications": [],
        "billing_start_date": "2019-08-24",
        "billing_end_date": "2019-08-24",
        "billing_frequency": "daily",
        "billing_interval": 0,
        "sync_billing_with_recognition": false,
        "skip_invoice_generation": false,
        "recognition_start_date": "2019-08-24",
        "recognition_end_date": "2019-08-24",
        "recognition_frequency": "daily",
        "recognition_interval": 0,
        "discount_type": "PERCENTAGE",
        "discount_value": 0
      }
    ],
    "term_id": 0,
    "billing_start_date": "2019-08-24",
    "billing_frequency": "monthly",
    "billing_interval": 1,
    "billing_anchor_weekday": 6,
    "recognition_start_date": "2019-08-24",
    "recognition_frequency": "monthly",
    "recognition_interval": 1,
    "recognition_anchor_weekday": 6,
    "status": "draft",
    "contract_attachments": [],
    "change_orders_attachments": [],
    "payment": {
      "type": "string",
      "id": 0,
      "body": "string",
      "link": "string"
    },
    "prepared_invoices": [],
    "revenue_recognitions": []
  }'

Responses

OK

Bodyapplication/json
custom_fieldsArray of objects(Custom Fields)
Default []
integration_remote_recordsArray of objects(Integration Remote Records)
Default []
idinteger(Id)required
numberinteger(Number)required
company_idinteger(Company Id)required
company_namestring(Company Name)required
company_currencystring(Company Currency)required
customer_idinteger(Customer Id)required
customer_namestring(Customer Name)required
namestring(Name)required
currency_iso_4217_codestring(SystemCurrencies)required
Enum"AED""AFN""ALL""AMD""ANG""AOA""ARS""AUD""AWG""AZN"
memostring(Memo)required
datestring(date)(Date)required
term_idinteger or null(Term Id)
start_datestring(date)(Start Date)required
end_datestring or null(date)(End Date)
bill_to_addressstring(Bill To Address)required
ship_to_addressstring(Ship To Address)required
billing_addressobject or null(AddressSchemaIn)
shipping_addressobject or null(AddressSchemaIn)
billing_start_datestring(date)(Billing Start Date)required
billing_frequencystring(RecognitionCadence)required
Enum"daily""weekly""monthly""annually"
billing_intervalinteger(Billing Interval)required
billing_anchor_weekdayinteger or null(Billing Anchor Weekday)
recognition_start_datestring(date)(Recognition Start Date)required
recognition_frequencystring(RecognitionCadence)required
Enum"daily""weekly""monthly""annually"
recognition_intervalinteger(Recognition Interval)required
recognition_anchor_weekdayinteger or null(Recognition Anchor Weekday)
statusstring(ContractStatus)required
Enum"draft""active""completed""archived"
record_statusstring(RecordStatus)required
Enum"draft""posted""archived"
is_lockedboolean(Is Locked)required
paymentobject or null(PaymentSchemaOut)

Schema for payment collection configuration output.

revenue_recognitionsArray of objects(Revenue Recognitions)required
revenue_recognitions[].​idinteger(Id)required
revenue_recognitions[].​numberinteger(Number)required
revenue_recognitions[].​contract_idinteger(Contract Id)required
revenue_recognitions[].​performance_obligation_idinteger or null(Performance Obligation Id)
revenue_recognitions[].​datestring(date)(Date)required
revenue_recognitions[].​transaction_datestring(date)(Transaction Date)required
revenue_recognitions[].​amountstring(Amount)^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$required
revenue_recognitions[].​transaction_idinteger(Transaction Id)required
revenue_recognitions[].​record_statusstring(RecordStatus)required
Enum"draft""posted""archived"
revenue_recognitions[].​income_account_idinteger(Income Account Id)required
revenue_recognitions[].​deferrered_revenue_account_idinteger(Deferrered Revenue Account Id)required
invoicesArray of objects(Invoices)required
invoices[].​idinteger(Id)required
invoices[].​numberinteger(Number)required
invoices[].​datestring(date)(Date)required
invoices[].​due_datestring(date)(Due Date)required
invoices[].​amountstring(Amount)^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$required
invoices[].​tax_amountstring(Tax Amount)^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$required
invoices[].​paid_totalstring(Paid Total)^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$required

Amount that was already paid by Customer Repayment Applications or Customer Payments

invoices[].​record_statusstring(RecordStatus)required
Enum"draft""posted""archived"
invoices[].​term_idinteger or null(Term Id)
obligationsArray of objects(Obligations)required
obligations[].​idinteger(Id)required
obligations[].​item_idinteger(Item Id)required
obligations[].​quantitystring(Quantity)^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,6}0*$required
obligations[].​ratestring(Rate)^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$required
obligations[].​positioninteger(Position)required
obligations[].​memostring(Memo)required
obligations[].​standalone_selling_pricestring or null(Standalone Selling Price)^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
obligations[].​term_idinteger or null(Term Id)
obligations[].​recognition_strategystring(RecognitionStrategy)
Default "straight_line"
Enum"straight_line""straight_line_start_end_even""daily_prorata""milestone""usage_tiered""usage""immediate""deposit_release"
obligations[].​obligation_conditionsobject(Obligation Conditions)
obligations[].​classificationsArray of objects(Classifications)
Default []
obligations[].​billing_start_datestring or null(date)(Billing Start Date)
obligations[].​billing_end_datestring or null(date)(Billing End Date)
obligations[].​billing_frequencystring or null(RecognitionCadence)
Enum"daily""weekly""monthly""annually"
obligations[].​billing_intervalinteger or null(Billing Interval)
obligations[].​sync_billing_with_recognitionboolean(Sync Billing With Recognition)
Default false
obligations[].​skip_invoice_generationboolean(Skip Invoice Generation)
Default false
obligations[].​recognition_start_datestring or null(date)(Recognition Start Date)
obligations[].​recognition_end_datestring or null(date)(Recognition End Date)
obligations[].​recognition_frequencystring or null(RecognitionCadence)
Enum"daily""weekly""monthly""annually"
obligations[].​recognition_intervalinteger or null(Recognition Interval)
obligations[].​discount_typestring or null(DiscountType)
Enum"PERCENTAGE""FIXED"
obligations[].​discount_valuestring or null(Discount Value)^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,6}0*$
obligations[].​amountstring(Amount)^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$read-onlyrequired

Gross amount before discount.

obligations[].​discount_amountstring(Discount Amount)^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$read-onlyrequired

Calculated discount amount.

obligations[].​net_amountstring(Net Amount)^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$read-onlyrequired

Net amount after discount.

obligation_usageArray of objects(Obligation Usage)required
obligation_usage[].​idinteger(Id)required
obligation_usage[].​contract_idinteger(Contract Id)required
obligation_usage[].​obligation_idinteger(Obligation Id)required
obligation_usage[].​usage_datestring(date)(Usage Date)required
obligation_usage[].​quantitystring(Quantity)^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,6}0*$required
obligation_usage[].​ratestring or null(Rate)^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
obligation_usage[].​amountstring(Amount)^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$required
obligation_usage[].​effective_ratestring(Effective Rate)^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$required
obligation_usage[].​revenue_recognition_idinteger or null(Revenue Recognition Id)
obligation_usage[].​statusstring(ObligationUsageStatus)required
Enum"draft""invoiced""archived"
obligation_usage[].​invoice_statusstring or null(Invoice Status)
obligation_usage[].​memostring(Memo)
Default ""
obligation_usage[].​created_atstring(date-time)(Created At)required
obligation_usage[].​updated_atstring(date-time)(Updated At)required
contract_attachmentsArray of objects(Contract Attachments)
Default []
change_orders_attachmentsArray of objects(Change Orders Attachments)
Default []
Response
application/json
{
  "custom_fields": [],
  "integration_remote_records": [],
  "id": 0,
  "number": 0,
  "company_id": 0,
  "company_name": "string",
  "company_currency": "string",
  "customer_id": 0,
  "customer_name": "string",
  "name": "string",
  "currency_iso_4217_code": "AED",
  "memo": "string",
  "date": "2019-08-24",
  "term_id": 0,
  "start_date": "2019-08-24",
  "end_date": "2019-08-24",
  "bill_to_address": "string",
  "ship_to_address": "string",
  "billing_address": {
    "street": "string",
    "city": "string",
    "state": "",
    "postal_code": "string",
    "country": "",
    "second_line": "",
    "name": "string"
  },
  "shipping_address": {
    "street": "string",
    "city": "string",
    "state": "",
    "postal_code": "string",
    "country": "",
    "second_line": "",
    "name": "string"
  },
  "billing_start_date": "2019-08-24",
  "billing_frequency": "daily",
  "billing_interval": 0,
  "billing_anchor_weekday": 0,
  "recognition_start_date": "2019-08-24",
  "recognition_frequency": "daily",
  "recognition_interval": 0,
  "recognition_anchor_weekday": 0,
  "status": "draft",
  "record_status": "draft",
  "is_locked": true,
  "payment": {
    "type": "string",
    "id": 0,
    "body": "string",
    "link": "string"
  },
  "revenue_recognitions": [
    { … }
  ],
  "invoices": [
    { … }
  ],
  "obligations": [
    { … }
  ],
  "obligation_usage": [
    { … }
  ],
  "contract_attachments": [],
  "change_orders_attachments": []
}

Get Contract

Request

Path
record_idinteger(Record Id)required
curl -i -X GET \
  'https://api.dualentry.com/public/v1/contracts/{record_id}/'

Responses

OK

Bodyapplication/json
custom_fieldsArray of objects(Custom Fields)
Default []
integration_remote_recordsArray of objects(Integration Remote Records)
Default []
idinteger(Id)required
numberinteger(Number)required
company_idinteger(Company Id)required
company_namestring(Company Name)required
company_currencystring(Company Currency)required
customer_idinteger(Customer Id)required
customer_namestring(Customer Name)required
namestring(Name)required
currency_iso_4217_codestring(SystemCurrencies)required
Enum"AED""AFN""ALL""AMD""ANG""AOA""ARS""AUD""AWG""AZN"
memostring(Memo)required
datestring(date)(Date)required
term_idinteger or null(Term Id)
start_datestring(date)(Start Date)required
end_datestring or null(date)(End Date)
bill_to_addressstring(Bill To Address)required
ship_to_addressstring(Ship To Address)required
billing_addressobject or null(AddressSchemaIn)
shipping_addressobject or null(AddressSchemaIn)
billing_start_datestring(date)(Billing Start Date)required
billing_frequencystring(RecognitionCadence)required
Enum"daily""weekly""monthly""annually"
billing_intervalinteger(Billing Interval)required
billing_anchor_weekdayinteger or null(Billing Anchor Weekday)
recognition_start_datestring(date)(Recognition Start Date)required
recognition_frequencystring(RecognitionCadence)required
Enum"daily""weekly""monthly""annually"
recognition_intervalinteger(Recognition Interval)required
recognition_anchor_weekdayinteger or null(Recognition Anchor Weekday)
statusstring(ContractStatus)required
Enum"draft""active""completed""archived"
record_statusstring(RecordStatus)required
Enum"draft""posted""archived"
is_lockedboolean(Is Locked)required
paymentobject or null(PaymentSchemaOut)

Schema for payment collection configuration output.

revenue_recognitionsArray of objects(Revenue Recognitions)required
revenue_recognitions[].​idinteger(Id)required
revenue_recognitions[].​numberinteger(Number)required
revenue_recognitions[].​contract_idinteger(Contract Id)required
revenue_recognitions[].​performance_obligation_idinteger or null(Performance Obligation Id)
revenue_recognitions[].​datestring(date)(Date)required
revenue_recognitions[].​transaction_datestring(date)(Transaction Date)required
revenue_recognitions[].​amountstring(Amount)^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$required
revenue_recognitions[].​transaction_idinteger(Transaction Id)required
revenue_recognitions[].​record_statusstring(RecordStatus)required
Enum"draft""posted""archived"
revenue_recognitions[].​income_account_idinteger(Income Account Id)required
revenue_recognitions[].​deferrered_revenue_account_idinteger(Deferrered Revenue Account Id)required
invoicesArray of objects(Invoices)required
invoices[].​idinteger(Id)required
invoices[].​numberinteger(Number)required
invoices[].​datestring(date)(Date)required
invoices[].​due_datestring(date)(Due Date)required
invoices[].​amountstring(Amount)^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$required
invoices[].​tax_amountstring(Tax Amount)^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$required
invoices[].​paid_totalstring(Paid Total)^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$required

Amount that was already paid by Customer Repayment Applications or Customer Payments

invoices[].​record_statusstring(RecordStatus)required
Enum"draft""posted""archived"
invoices[].​term_idinteger or null(Term Id)
obligationsArray of objects(Obligations)required
obligations[].​idinteger(Id)required
obligations[].​item_idinteger(Item Id)required
obligations[].​quantitystring(Quantity)^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,6}0*$required
obligations[].​ratestring(Rate)^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$required
obligations[].​positioninteger(Position)required
obligations[].​memostring(Memo)required
obligations[].​standalone_selling_pricestring or null(Standalone Selling Price)^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
obligations[].​term_idinteger or null(Term Id)
obligations[].​recognition_strategystring(RecognitionStrategy)
Default "straight_line"
Enum"straight_line""straight_line_start_end_even""daily_prorata""milestone""usage_tiered""usage""immediate""deposit_release"
obligations[].​obligation_conditionsobject(Obligation Conditions)
obligations[].​classificationsArray of objects(Classifications)
Default []
obligations[].​billing_start_datestring or null(date)(Billing Start Date)
obligations[].​billing_end_datestring or null(date)(Billing End Date)
obligations[].​billing_frequencystring or null(RecognitionCadence)
Enum"daily""weekly""monthly""annually"
obligations[].​billing_intervalinteger or null(Billing Interval)
obligations[].​sync_billing_with_recognitionboolean(Sync Billing With Recognition)
Default false
obligations[].​skip_invoice_generationboolean(Skip Invoice Generation)
Default false
obligations[].​recognition_start_datestring or null(date)(Recognition Start Date)
obligations[].​recognition_end_datestring or null(date)(Recognition End Date)
obligations[].​recognition_frequencystring or null(RecognitionCadence)
Enum"daily""weekly""monthly""annually"
obligations[].​recognition_intervalinteger or null(Recognition Interval)
obligations[].​discount_typestring or null(DiscountType)
Enum"PERCENTAGE""FIXED"
obligations[].​discount_valuestring or null(Discount Value)^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,6}0*$
obligations[].​amountstring(Amount)^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$read-onlyrequired

Gross amount before discount.

obligations[].​discount_amountstring(Discount Amount)^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$read-onlyrequired

Calculated discount amount.

obligations[].​net_amountstring(Net Amount)^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$read-onlyrequired

Net amount after discount.

obligation_usageArray of objects(Obligation Usage)required
obligation_usage[].​idinteger(Id)required
obligation_usage[].​contract_idinteger(Contract Id)required
obligation_usage[].​obligation_idinteger(Obligation Id)required
obligation_usage[].​usage_datestring(date)(Usage Date)required
obligation_usage[].​quantitystring(Quantity)^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,6}0*$required
obligation_usage[].​ratestring or null(Rate)^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
obligation_usage[].​amountstring(Amount)^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$required
obligation_usage[].​effective_ratestring(Effective Rate)^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$required
obligation_usage[].​revenue_recognition_idinteger or null(Revenue Recognition Id)
obligation_usage[].​statusstring(ObligationUsageStatus)required
Enum"draft""invoiced""archived"
obligation_usage[].​invoice_statusstring or null(Invoice Status)
obligation_usage[].​memostring(Memo)
Default ""
obligation_usage[].​created_atstring(date-time)(Created At)required
obligation_usage[].​updated_atstring(date-time)(Updated At)required
contract_attachmentsArray of objects(Contract Attachments)
Default []
change_orders_attachmentsArray of objects(Change Orders Attachments)
Default []
Response
application/json
{
  "custom_fields": [],
  "integration_remote_records": [],
  "id": 0,
  "number": 0,
  "company_id": 0,
  "company_name": "string",
  "company_currency": "string",
  "customer_id": 0,
  "customer_name": "string",
  "name": "string",
  "currency_iso_4217_code": "AED",
  "memo": "string",
  "date": "2019-08-24",
  "term_id": 0,
  "start_date": "2019-08-24",
  "end_date": "2019-08-24",
  "bill_to_address": "string",
  "ship_to_address": "string",
  "billing_address": {
    "street": "string",
    "city": "string",
    "state": "",
    "postal_code": "string",
    "country": "",
    "second_line": "",
    "name": "string"
  },
  "shipping_address": {
    "street": "string",
    "city": "string",
    "state": "",
    "postal_code": "string",
    "country": "",
    "second_line": "",
    "name": "string"
  },
  "billing_start_date": "2019-08-24",
  "billing_frequency": "daily",
  "billing_interval": 0,
  "billing_anchor_weekday": 0,
  "recognition_start_date": "2019-08-24",
  "recognition_frequency": "daily",
  "recognition_interval": 0,
  "recognition_anchor_weekday": 0,
  "status": "draft",
  "record_status": "draft",
  "is_locked": true,
  "payment": {
    "type": "string",
    "id": 0,
    "body": "string",
    "link": "string"
  },
  "revenue_recognitions": [
    { … }
  ],
  "invoices": [
    { … }
  ],
  "obligations": [
    { … }
  ],
  "obligation_usage": [
    { … }
  ],
  "contract_attachments": [],
  "change_orders_attachments": []
}

Sales Orders

Create and manage sales orders. Track customer orders for goods or services before invoicing, including line items, quantities, fulfillment status, and invoicing progress.

Operations

Recurring Invoices

Automate recurring billing. Set up and manage templates for invoices that are automatically generated on a regular schedule (e.g., monthly subscriptions).

Operations

Customers

Manage customer records. Create, update, and track customers who purchase goods or services from your organization, including contact information, billing addresses, and payment terms.

Operations

Customer Payments

Record and manage customer payments. Track payments received from customers and apply them to outstanding invoices, including partial payments and overpayments.

Operations

Customer Prepayments

Track advance payments from customers. Access prepayments received before goods or services are delivered, which can be applied to future invoices.

Operations

Customer Prepayment Applications

Apply customer prepayments and credits to invoices. Record applications of prepayments or credit memos to reduce invoice balances.

Operations

Customer Deposits

Manage customer deposit transactions. Record and track deposits received from customers as security or partial payment, held in liability accounts until earned or refunded.

Operations

Customer Refunds

Process and track customer refunds. Record refunds issued to customers for overpayments, returns, or cancelled transactions.

Operations

Customer Credits

Manage credit memos for customers. Issue credits for returned goods, billing adjustments, or discounts that reduce customer balances or can be applied to future invoices.

Operations

Cash Sales

Record immediate cash sales transactions. Track sales where payment is received at the time of sale, including point-of-sale transactions and cash receipts.

Operations

Bills

Manage vendor bills and payables. Record and track bills received from vendors for goods or services purchased, including line items, due dates, and payment tracking.

Operations

Recurring Bills

Automate recurring expenses. Configure templates for bills that repeat on a regular basis (e.g., monthly rent, subscriptions) to streamline expense tracking.

Operations

Purchase Orders

Create and track purchase orders. Manage formal requests to vendors for goods or services, including approval workflows, receiving tracking, and bill matching.

Operations

Direct Expenses

Record direct expense transactions. Track payments made directly from a bank or credit card account for expenses, without going through the accounts payable process.

Operations

Vendors

Manage vendor and supplier records. Track businesses and individuals from whom you purchase goods or services, including contact details, payment terms, and tax information.

Operations

Vendor Payments

Record and manage vendor payments. Track payments made to vendors and apply them to outstanding bills and credits, including partial payments and overpayments.

Operations

Vendor Prepayments

Track advance payments to vendors. Record prepayments made before goods or services are received, which can be applied to future bills.

Operations

Vendor Prepayment Applications

Apply vendor prepayments to bills. Record applications of prepayments to reduce bill balances and track amounts owed.

Operations

Vendor Credits

Manage vendor credit memos. Record credits from vendors for returned goods, billing adjustments, or discounts that reduce amounts owed or can be applied to future bills.

Operations

Vendor Refunds

Process and track vendor refunds. Record refunds received from vendors for overpayments, returns, or cancelled transactions.

Operations

Paper Checks

Manage paper check printing. Create, queue, and batch print paper checks for vendor payments, direct expenses, vendor prepayments, and customer refunds.

Operations

Fixed Assets

Manage fixed assets and capital equipment. Create, update, and track long-lived tangible assets including depreciation schedules, account assignments, and asset lifecycle management.

Operations