Get a list of available contract owner sub-brands

get/contract-owner-sub-brands
SecuritybearerAuth
Request
query Parameters
page
required
integer <int32> (PageParam) >= 1

Page of results to show

Example: page=1
pageSize
required
integer <int32> (ResultsPerPageParam) [ 1 .. 1000 ]

Results to return per page

Example: pageSize=100
sort
string (SortParam)

Comma-delimited list of the fields to sort by - defaults to ascending order, suffix :desc to change

Example: sort=id,name | name:desc
fields
string (FieldsParam)

Comma-delimited list of the field(s) to return if only a subset is required

Example: fields=id,name
name
string (StringFilterParam)

Filter by name

Example: name=xyz | in:x,y | like:xyz
contractOwnerId
integer <int64> (IdParam) >= 1

Contract owner identifier

Example: contractOwnerId=1
activeCustomersBillingCycleId
string (StringFilterParam)

Filter sub-brands that are used by active customers and associated to the billing cycle identifier

Example: activeCustomersBillingCycleId=xyz | in:x,y | like:xyz
adhocBillRunId
string (StringFilterParam)

Filter sub-brands that are associated to the adhoc bill run

Example: adhocBillRunId=xyz | in:x,y | like:xyz
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

Response samples
application/json
[
  • {
    • "id": 1,
    • "createdAt": "2023-10-05 16:40:04",
    • "updatedAt": "2023-10-05 16:40:04",
    • "accountNumberFormat": "SI0000",
    • "attachInvoiceToEmail": "0x01",
    • "bacsReference": "Bacs Reference",
    • "bankAccountName": "Bank Account Name",
    • "bankAccountNumber": "1234567890",
    • "summaryCustomerAccountNumberLabel": "Summary customer account number label",
    • "bankSortCode": "123456",
    • "swiftCode": "DEUTDEFFXXX",
    • "billingPeriodEndDateLabel": "Billing Period (Ending)",
    • "companyRegistrationNumber": "CompanyReg123",
    • "companyRegistrationNumberLabel": "Company Number",
    • "vatRegistrationNumber": "Vat registration Number123",
    • "customerServiceEmail": "customer@email.com",
    • "customerServiceTelephoneNumber": "123-456-7890",
    • "customerServiceWebSite": "https://www.customerservice.com",
    • "defaultSubBrand": true,
    • "emailBillingFromAddress": "billing@example.com",
    • "iban": "IBAN1234567890",
    • "invoiceCustomerAccountNumberLabel": "Account Label",
    • "invoiceDateLabel": "Invoice Date Label",
    • "invoiceEmailSubject": "Invoice Email Subject",
    • "invoiceNumberFormat": "InvoiceFormat123",
    • "invoiceNumberLabel": "Invoice Number Label",
    • "invoicePresentationName": "Invoice Presentation Name",
    • "invoiceTaxLabel": "Invoice Tax Label",
    • "name": "bcn",
    • "ofcomRid": "OfcomRID123",
    • "productReferenceLabel": "Product Reference Label",
    • "summaryInvoiceNumberLabel": "Summary invoice number label",
    • "taxExemptLabel": "Tax exempt label",
    • "address": {
      • "id": 1,
      • "businessName": "string",
      • "address1": "string",
      • "address2": "string",
      • "address3": "string",
      • "town": "string",
      • "county": "string",
      • "postcode": "string",
      • "country": "GB"
      },
    • "contractOwnerId": 1,
    • "emailTemplateId": 1,
    • "prePopulatedTripwirePlanId": 1,
    • "invoiceNotesLabel": "Invoice notes label"
    }
]