# Get a list of available contract owners

Endpoint: GET /contract-owners
Version: 1.44
Security: bearerAuth

## Query parameters:

  - `page` (integer, required)
    Page of results to show
    Example: 1

  - `pageSize` (integer, required)
    Results to return per page
    Example: 100

  - `sort` (string)
    Comma-delimited list of the fields to sort by - defaults to ascending order, suffix :desc to change
    Example: "id,name | name:desc"

  - `fields` (string)
    Comma-delimited list of the field(s) to return if only a subset is required
    Example: "id,name"

  - `name` (string)
    Filter by name
    Example: "xyz | in:x,y | like:xyz"

## Response 200 fields (application/json):

  - `id` (integer)
    Contract owner identifier
    Example: 1

  - `name` (string, required)
    Contract owner name

  - `availableFrom` (string, required)
    Contract owner is available from

  - `availableTo` (string)
    Contract owner is available to

  - `bankAccountName` (string)
    Bank account name

  - `bankAccountNumber` (string)
    Bank account number

  - `bankSortCode` (string)
    Bank sort code

  - `bankSwiftCode` (string)
    Bank SWIFT/BIC code
    Example: "AAAABB11222"

  - `bankIban` (string)
    International Bank Account Number (IBAN), which you can use when making or receiving international payments
    Example: "GB29NWBK60161331926819"

  - `companyRegistrationNumber` (string)
    Company registration number

  - `coBccEmailAddress` (string)
    Email address for contract owner

  - `mandatoryAccountReferenceForSite` (boolean)
    Mandatory account reference for site

  - `prePopulatedFraudPlanId` (integer)
    When creating a customer, its tripwireId will be pre-populated with this identifier
    Example: 1

  - `siBccEmailAddress` (string, required)
    Email address for SI

  - `taxRegistrationNumber` (string, required)
    Tax registration number

  - `address` (object, required)

  - `address.id` (integer)
    Internal identifier for address entry
    Example: 1

  - `address.businessName` (string)
    Business name

  - `address.address1` (string, required)
    Address line 1

  - `address.address2` (string)
    Address line 2

  - `address.address3` (string)
    Address line 3

  - `address.town` (string, required)
    Town

  - `address.county` (string)
    County

  - `address.postcode` (string, required)
    Postcode

  - `address.country` (string, required)
    ISO 3166 alpha-2 code representing country
    Example: "GB"

  - `customerServiceTelephoneNumber` (string)
    Customer service telephone number

  - `customerServiceWebsite` (string)
    Customer service website

  - `customerServiceEmail` (string)
    Customer service email

  - `emailBillingFromAddress` (string, required)
    Email billing from address

  - `invoiceCombiningType` (string, required)
    Invoice combining type
    Enum: "NONE", "COMBINE_ALL", "COMBINE_INDIVIDUALLY", "COMBINE_ALL_DUPLEX", "COMBINE_INDIVIDUALLY_DUPLEX"

  - `invoiceNumberFormat` (string)
    Invoice number format

  - `invoiceEmailSubject` (string, required)
    Invoice email subject

  - `minimumItemisationValueInPence` (number)
    Minimum itemisation value in pence

  - `mandatoryBankPaymentForDirectDebit` (boolean)
    Specifies whether bank payment details are mandatory for direct debit

  - `createdDate` (string)
    Date when this contract profile was created

  - `updatedDate` (string)
    Contract owner updated date

  - `enableBalanceCarryForward` (boolean, required)
    Enable balance carry forward

  - `emailTemplateId` (integer, required)
    Email template identifier
    Example: 1

  - `invoiceNumberLabel` (string, required)
    Invoice number label on the generated pdf invoice document

  - `localeId` (integer, required)
    Locale identifier
    Example: 1

  - `invoicePresentationName` (string)
    Invoice presentation name

  - `summaryInvoiceNumberLabel` (string, required)
    Invoice number  label on the generated pdf invoice summary document

  - `priceDecimalPlaces` (integer, required)
    Number of decimal places to show on the screen for rated records etc.
    Example: 1

  - `priceRoundingMode` (string)
    Specifies a rounding behavior for numerical operations capable of discarding precision. Default is HALF_UP.

* UP = Rounding mode to round away from zero.  Always increments the digit prior to a non-zero discarded fraction.  Note that this rounding mode never decreases the magnitude of the calculated value. Examples, 5.5 -> 6, 2.6 -> 3, 1.1 -> 2, -1.1 -> -2
* DOWN = Rounding mode to round towards zero.  Never increments the digit prior to a discarded fraction (i.e., truncates).  Note that this rounding mode never increases the magnitude of the calculated value. Examples, 5.5 -> 5, 2.6 -> 2, 1.1 -> 1, -1.1 -> -1
* CEILING = Rounding mode to round towards positive infinity.  If the result is positive, behaves as for UP, if negative, behaves as for DOWN. Note that this rounding mode never decreases the calculated value. Examples, 5.5 -> 6, 2.6 -> 3, 1.1 -> 2, -1.1 -> -1
* FLOOR = Rounding mode to round towards negative infinity.  If the result is positive, behave as for DOWN if negative, behave as for UP.  Note that this rounding mode never increases the calculated value. Examples, 5.5 -> 5, 2.6 -> 2, 1.1 -> 1, -1.1 -> -2
* HALF_UP = Rounding mode to round towards "nearest neighbor" unless both neighbors are equidistant, in which case round up. Behaves as for UP if the discarded fraction is ≥ 0.5; otherwise, behaves as for DOWN.  Note that this is the rounding mode commonly taught at school. Examples, 5.5 -> 6, 2.6 -> 3, 1.1 -> 1, -1.1 -> -1
* HALF_DOWN = Rounding mode to round towards "nearest neighbor" unless both neighbors are equidistant, in which case round down.  Behaves as for UP if the discarded fraction is > 0.5; otherwise, behaves as for DOWN. Examples, 5.5 -> 5, 2.6 -> 3, 1.1 -> 1, -1.1 -> -1
* HALF_EVEN = Rounding mode to round towards the "nearest neighbor" unless both neighbors are equidistant, in which case, round owards the even neighbor.  Behaves as for HALF_UP if the digit to the left of the discarded fraction is odd; behaves as for HALF_DOWN if it's even.  Note that this is the rounding mode that statistically minimizes cumulative error when applied repeatedly over a sequence of calculations. It is sometimes known as "Banker's rounding," and is chiefly used in the USA. Examples, 5.5 -> 6, 2.6 -> 2, 1.1 -> 1, -1.1 -> -1
    Enum: "UP", "DOWN", "CEILING", "FLOOR", "HALF_UP", "HALF_DOWN", "HALF_EVEN"

  - `accountingCostCentre` (string)
    Accounting cost centre code

  - `companyRegistrationNumberLabel` (string)
    Company registration number label on generated invoice pdf document

  - `invoiceTaxLabel` (string)
    Invoice Tax label on the generated invoice pdf document

  - `forceBillingDefault` (boolean)
    Auto populate force billing on rental product inventories at creation

  - `taxExemptLabel` (string, required)
    If a site is marked as Tax Exempt, text message to appear on the generated pdf invoice document

  - `netAccountingAdjustmentNominalCode` (string)
    Nominal code to be used for an adjustment line added for the net value in the account export file

  - `taxAccountingAdjustmentNominalCode` (string)
    Nominal code to be used for an adjustment line added for the tax value in the account export file

  - `netAccountingAdjustmentTaxCode` (string)
    Tax code to be used for an adjustment line added for the net value in the account export file

  - `taxAccountingAdjustmentTaxCode` (string)
    Tax code to be used for an adjustment line added for the tax value in the account export file

  - `attachInvoiceToEmail` (boolean)
    Should the pdf invoice be attached to the invoice email? If the email includes a link to the invoice, set this to False

  - `billingPeriodEndDateLabel` (string, required)
    Billing period end date label on the generated invoice

  - `invoiceCustomerAccountNumberLabel` (string, required)
    Customer account number label on the generated invoice

  - `summaryCustomerAccountNumberLabel` (string, required)
    Customer account number label on the generated invoice summary

  - `invoiceDateLabel` (string, required)
    Invoice Date label on the generated invoice

  - `productReferenceLabel` (string, required)
    Product reference label to show on the screen

  - `features` (array)
    Enum: "USAGE", "USAGE_TRIPWIRE", "FULL_CUSTOMER", "MATCHMAKER"


## Response 400 fields

## Response 401 fields

## Response 404 fields

## Response 412 fields

## Response 500 fields

## Response 501 fields