Get a list of available contract owners

get/contract-owners
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
Responses
200

OK

400

Bad Request

401

Unauthorized

404

Not Found

412

Precondition Failed

500

Internal Server Error

501

Not Implemented Yet

Response samples
application/json
[
  • {
    • "id": 1,
    • "name": "string",
    • "availableFrom": "2019-08-24",
    • "availableTo": "2019-08-24",
    • "bankAccountName": "string",
    • "bankAccountNumber": "stringst",
    • "bankSortCode": "string",
    • "bankSwiftCode": "AAAABB11222",
    • "bankIban": "GB29NWBK60161331926819",
    • "companyRegistrationNumber": "string",
    • "coBccEmailAddress": "string",
    • "mandatoryAccountReferenceForSite": false,
    • "prePopulatedFraudPlanId": 1,
    • "siBccEmailAddress": "string",
    • "taxRegistrationNumber": "string",
    • "address": {
      • "id": 1,
      • "businessName": "string",
      • "address1": "string",
      • "address2": "string",
      • "address3": "string",
      • "town": "string",
      • "county": "string",
      • "postcode": "string",
      • "country": "GB"
      },
    • "customerServiceTelephoneNumber": "string",
    • "customerServiceWebsite": "string",
    • "customerServiceEmail": "string",
    • "emailBillingFromAddress": "string",
    • "invoiceCombiningType": "NONE",
    • "invoiceNumberFormat": "string",
    • "invoiceEmailSubject": "string",
    • "minimumItemisationValueInPence": 0,
    • "mandatoryBankPaymentForDirectDebit": false,
    • "createdDate": "2019-08-24T14:15:22Z",
    • "updatedDate": "2019-08-24T14:15:22Z",
    • "enableBalanceCarryForward": true,
    • "emailTemplateId": 1,
    • "invoiceNumberLabel": "string",
    • "localeId": 1,
    • "invoicePresentationName": "string",
    • "summaryInvoiceNumberLabel": "string",
    • "priceDecimalPlaces": 1,
    • "priceRoundingMode": "UP",
    • "accountingCostCentre": "string",
    • "companyRegistrationNumberLabel": "Company Number",
    • "invoiceTaxLabel": "VAT Number",
    • "forceBillingDefault": true,
    • "taxExemptLabel": "VAT Exempt",
    • "netAccountingAdjustmentNominalCode": "string",
    • "taxAccountingAdjustmentNominalCode": "string",
    • "netAccountingAdjustmentTaxCode": "string",
    • "taxAccountingAdjustmentTaxCode": "string",
    • "attachInvoiceToEmail": true,
    • "billingPeriodEndDateLabel": "Billing Period (Ending)",
    • "invoiceCustomerAccountNumberLabel": "Account number",
    • "summaryCustomerAccountNumberLabel": "Account number",
    • "invoiceDateLabel": "Date (And Tax Point)",
    • "productReferenceLabel": "Product Reference",
    • "features": [
      • "USAGE"
      ]
    }
]