# Get a list of available contract owner sub-brands

Endpoint: GET /contract-owner-sub-brands
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"

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

  - `activeCustomersBillingCycleId` (string)
    Filter sub-brands that are used by active customers and associated to the billing cycle identifier
    Example: "xyz | in:x,y | like:xyz"

  - `adhocBillRunId` (string)
    Filter sub-brands that are associated to the adhoc bill run
    Example: "xyz | in:x,y | like:xyz"

## Response 200 fields (application/json):

  - `id` (integer)
    Identifier
    Example: 1

  - `createdAt` (string)
    Created at
    Example: "2023-10-05 16:40:04"

  - `updatedAt` (string)
    Updated at
    Example: "2023-10-05 16:40:04"

  - `accountNumberFormat` (string)
    Account number format
    Example: "SI0000"

  - `attachInvoiceToEmail` (boolean)
    Attach invoice to email
    Example: "0x01"

  - `bacsReference` (string)
    Bacs reference
    Example: "Bacs Reference"

  - `bankAccountName` (string)
    Bank account name
    Example: "Bank Account Name"

  - `bankAccountNumber` (string)
    Bank account number
    Example: "1234567890"

  - `summaryCustomerAccountNumberLabel` (string, required)
    An alternative name for the “account number” label that will appear on the invoice
    Example: "Summary customer account number label"

  - `bankSortCode` (string)
    Bank sort code
    Example: "123456"

  - `swiftCode` (string)
    SWIFT - ISO 9362 is an international standard for Business Identifier Codes
    Example: "DEUTDEFFXXX"

  - `billingPeriodEndDateLabel` (string, required)
    An alternative name for the “End date” label that will appear on the invoice
    Example: "Billing Period (Ending)"

  - `companyRegistrationNumber` (string)
    Company registration number to appear on the invoice
    Example: "CompanyReg123"

  - `companyRegistrationNumberLabel` (string)
    An alternative name for the “Company registration number” label that will appear on the invoice
    Example: "Company Number"

  - `vatRegistrationNumber` (string, required)
    VAT registration number to appear on the invoice
    Example: "Vat registration Number123"

  - `customerServiceEmail` (string)
    Customer service email address to appear on the invoice
    Example: "customer@email.com"

  - `customerServiceTelephoneNumber` (string)
    Customer service telephone number to appear on the invoice
    Example: "123-456-7890"

  - `customerServiceWebSite` (string)
    Customer service web site to appear on the invoice
    Example: "https://www.customerservice.com"

  - `defaultSubBrand` (boolean, required)
    Whether this sub brand is the default for the contract owner in hand
    Example: true

  - `emailBillingFromAddress` (string, required)
    Email billing 'from' address
    Example: "billing@example.com"

  - `iban` (string)
    IBAN Number to appear on the invoice
    Example: "IBAN1234567890"

  - `invoiceCustomerAccountNumberLabel` (string, required)
    An alternative name for the customer “Account number” label that will appear on the invoice
    Example: "Account Label"

  - `invoiceDateLabel` (string, required)
    An alternative name for the “Invoice date” label that will appear on the invoice
    Example: "Invoice Date Label"

  - `invoiceEmailSubject` (string, required)
    Invoice email subject text
    Example: "Invoice Email Subject"

  - `invoiceNumberFormat` (string)
    Invoice number format
    Example: "InvoiceFormat123"

  - `invoiceNumberLabel` (string, required)
    An alternative name for the “Invoice number” label that will appear on the invoice
    Example: "Invoice Number Label"

  - `invoicePresentationName` (string)
    Invoice presentation name
    Example: "Invoice Presentation Name"

  - `invoiceTaxLabel` (string)
    An alternative name for the “Tax” label that will appear on the invoice
    Example: "Invoice Tax Label"

  - `name` (string, required)
    Name
    Example: "bcn"

  - `ofcomRid` (string)
    Ofcom Reseller identification codes (RID)
    Example: "OfcomRID123"

  - `productReferenceLabel` (string, required)
    An alternative name for the “Product reference” label that will appear on the invoice summary
    Example: "Product Reference Label"

  - `summaryInvoiceNumberLabel` (string, required)
    An alternative name for the “invoice number” label that will appear on the invoice summary
    Example: "Summary invoice number label"

  - `taxExemptLabel` (string, required)
    If the invoice is set to Tax Exempt, a standard text to show on the invoice
    Example: "Tax exempt label"

  - `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"

  - `contractOwnerId` (integer, required)
    Contract Owner identifier
    Example: 1

  - `emailTemplateId` (integer, required)
    Email template identifier to be used for the invoice email
    Example: 1

  - `prePopulatedTripwirePlanId` (integer)
    When creating a new customer, pre-populate this Tripwire plan identifier
    Example: 1

  - `invoiceNotesLabel` (string)
    Notes to appear on the invoice
    Example: "Invoice notes label"


## Response 400 fields

## Response 401 fields

## Response 403 fields

## Response 500 fields