# List Contracts

Endpoint: GET /public/v1/contracts/
Version: 1.0.0

## Query parameters:

  - `search` (string,null)

  - `id` (array,null)

  - `company_id` (array,null)

  - `number` (array,null)

  - `customer_id` (array,null)

  - `status` (array,null)
    Enum: "draft", "active", "completed", "archived"

  - `start_date` (string,null)

  - `end_date` (string,null)

  - `contract_start_date` (string,null)

  - `contract_end_date` (string,null)

  - `ordering` (string,null)

  - `limit` (integer)
    Number of records to return per page (capped at 100)

  - `offset` (integer)
    Number of records to skip before starting to return results

## Response 200 fields (application/json):

  - `items` (array, required)

  - `items.custom_fields` (array)

  - `items.custom_fields.field` (object, required)

  - `items.custom_fields.field.id` (integer, required)

  - `items.custom_fields.field.company_id` (integer,null)

  - `items.custom_fields.field.company_ids` (array,null)

  - `items.custom_fields.field.name` (string, required)

  - `items.custom_fields.field.description` (string,null, required)

  - `items.custom_fields.field.helper_text` (string,null, required)

  - `items.custom_fields.field.field_type` (string, required)
    Enum: "text", "number", "currency", "date", "boolean", "single_select", "multi_select", "link", "paragraph"

  - `items.custom_fields.field.applies_to` (array, required)

  - `items.custom_fields.field.applies_to.type` (string, required)
    Enum: "invoice", "bill", "direct_expense", "journal_entry", "vendor_prepayment", "vendor_credit", "vendor_payment", "vendor_refund", "customer_payment", "customer_prepayment", "customer_refund", "customer_deposit", "currency_revaluation", "contract", "customer", "vendor", "sales_order", "cash_sale", "customer_credit"

  - `items.custom_fields.field.applies_to.is_active` (boolean)

  - `items.custom_fields.field.applies_to.is_required` (boolean)

  - `items.custom_fields.field.default_value` (any)

  - `items.custom_fields.field.options` (array,null, required)

  - `items.custom_fields.value` (object,null)
    Schema for custom field values with full details.

  - `items.custom_fields.value.custom_field_id` (integer, required)

  - `items.custom_fields.value.custom_field_name` (string, required)

  - `items.custom_fields.value.custom_field_type` (string, required)

  - `items.custom_fields.value.custom_field_value_id` (integer, required)

  - `items.custom_fields.value.value` (any, required)

  - `items.custom_fields.value.created_at` (string, required)

  - `items.custom_fields.value.updated_at` (string, required)

  - `items.integration_remote_records` (array)

  - `items.integration_remote_records.transactional_date` (string,null)

  - `items.integration_remote_records.external_source` (object,null)

  - `items.integration_remote_records.external_source.integration_type` (any, required)

  - `items.integration_remote_records.external_source.external_integration_url` (string,null, required)

  - `items.integration_remote_records.source_id` (string, required)

  - `items.integration_remote_records.connection_id` (integer,null)

  - `items.integration_remote_records.integration_id` (integer,null)

  - `items.integration_remote_records.integration_provider` (object,null)

  - `items.integration_remote_records.integration_provider.logo_url` (string,null)

  - `items.integration_remote_records.integration_provider.website` (string,null)

  - `items.integration_remote_records.integration_provider.category` (string,null)

  - `items.integration_remote_records.url` (string,null)

  - `items.number` (integer, required)

  - `items.company_name` (string, required)

  - `items.company_currency` (string, required)

  - `items.customer_id` (integer, required)

  - `items.customer_name` (string, required)

  - `items.currency_iso_4217_code` (string, required)
    Enum: "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLF", "CLP", "CNY", "COP", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VES", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "YER", "ZAR", "ZMW", "ZWL"

  - `items.memo` (string, required)

  - `items.date` (string, required)

  - `items.term_id` (integer,null)

  - `items.start_date` (string, required)

  - `items.end_date` (string,null)

  - `items.bill_to_address` (string, required)

  - `items.ship_to_address` (string, required)

  - `items.billing_address` (object,null)

  - `items.billing_address.street` (string, required)

  - `items.billing_address.city` (string, required)

  - `items.billing_address.state` (string)

  - `items.billing_address.postal_code` (string, required)

  - `items.billing_address.country` (any)

  - `items.billing_address.second_line` (string)

  - `items.shipping_address` (object,null)

  - `items.billing_start_date` (string, required)

  - `items.billing_frequency` (string, required)
    Enum: "daily", "weekly", "monthly", "annually"

  - `items.billing_interval` (integer, required)

  - `items.billing_anchor_weekday` (integer,null)

  - `items.recognition_start_date` (string, required)

  - `items.recognition_frequency` (string, required)
    Enum: "daily", "weekly", "monthly", "annually"

  - `items.recognition_interval` (integer, required)

  - `items.recognition_anchor_weekday` (integer,null)

  - `items.status` (string, required)
    Enum: "draft", "active", "completed", "archived"

  - `items.record_status` (string, required)
    Enum: "draft", "posted", "archived"

  - `items.is_locked` (boolean, required)

  - `items.payment` (object,null)
    Schema for payment collection configuration output.

  - `items.payment.body` (string,null)

  - `items.payment.link` (string,null)

  - `items.revenue_recognitions` (array, required)

  - `items.revenue_recognitions.contract_id` (integer, required)

  - `items.revenue_recognitions.performance_obligation_id` (integer,null)

  - `items.revenue_recognitions.transaction_date` (string, required)

  - `items.revenue_recognitions.amount` (string, required)

  - `items.revenue_recognitions.transaction_id` (integer, required)

  - `items.revenue_recognitions.income_account_id` (integer, required)

  - `items.revenue_recognitions.deferrered_revenue_account_id` (integer, required)

  - `items.invoices` (array, required)

  - `items.invoices.due_date` (string, required)

  - `items.invoices.tax_amount` (string, required)

  - `items.invoices.paid_total` (string, required)
    Amount that was already paid by Customer Repayment Applications or Customer Payments

  - `items.obligations` (array, required)

  - `items.obligations.item_id` (integer, required)

  - `items.obligations.quantity` (string, required)

  - `items.obligations.rate` (string, required)

  - `items.obligations.position` (integer, required)

  - `items.obligations.standalone_selling_price` (string,null)

  - `items.obligations.recognition_strategy` (string)
    Enum: "straight_line", "straight_line_start_end_even", "daily_prorata", "milestone", "usage_tiered", "usage", "immediate", "deposit_release"

  - `items.obligations.obligation_conditions` (object)

  - `items.obligations.classifications` (array)

  - `items.obligations.classifications.line_id` (integer, required)

  - `items.obligations.classifications.line_name` (string, required)

  - `items.obligations.classifications.parent_classification_id` (integer,null)

  - `items.obligations.classifications.parent_classification_line_id` (integer,null)

  - `items.obligations.billing_end_date` (string,null)

  - `items.obligations.sync_billing_with_recognition` (boolean)

  - `items.obligations.skip_invoice_generation` (boolean)

  - `items.obligations.recognition_end_date` (string,null)

  - `items.obligations.discount_type` (string,null)
    Enum: "PERCENTAGE", "FIXED"

  - `items.obligations.discount_value` (string,null)

  - `items.obligations.amount` (string, required)
    Gross amount before discount.

  - `items.obligations.discount_amount` (string, required)
    Calculated discount amount.

  - `items.obligations.net_amount` (string, required)
    Net amount after discount.

  - `count` (integer, required)

## Response 400 fields (application/json):

  - `success` (boolean)

  - `errors` (object, required)