Create a new contract owner

post/contract-owners
SecuritybearerAuth
Request
Request Body schema: application/json

New contract owner

name
required
string [ 1 .. 50 ] characters [\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Contract owner name

availableFrom
required
string <date>

Contract owner is available from

availableTo
string <date>

Contract owner is available to

bankAccountName
string [ 0 .. 50 ] characters [\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Bank account name

bankAccountNumber
string [ 8 .. 10 ] characters [0-9]+

Bank account number

bankSortCode
string = 6 characters [0-9]+

Bank sort code

bankSwiftCode
string [ 8 .. 11 ] characters [0-9A-Z]*

Bank SWIFT/BIC code

bankIban
string [ 4 .. 34 ] characters [0-9A-Z]*

International Bank Account Number (IBAN), which you can use when making or receiving international payments

companyRegistrationNumber
string [ 0 .. 20 ] characters [A-Za-z0-9]*

Company registration number

coBccEmailAddress
string [ 0 .. 50 ] characters (^$)|([a-zA-Z0-9.!#$%&'\*\+\/=?^_`{|}~-]+@[a-...

Email address for contract owner

mandatoryAccountReferenceForSite
boolean
Default: false

Mandatory account reference for site

prePopulatedFraudPlanId
integer <int64>

When creating a customer, its tripwireId will be pre-populated with this identifier

siBccEmailAddress
required
string [ 1 .. 50 ] characters [a-zA-Z0-9.!#$%&'\*\+\/=?^_`{|}~-]+@[a-zA-Z0-...

Email address for SI

taxRegistrationNumber
required
string [ 1 .. 50 ] characters ([A-Za-z0-9\p{L}\s]*)

Tax registration number

required
object (Address)
customerServiceTelephoneNumber
string [ 0 .. 26 ] characters ^$|[a-zA-Z0-9\p{L}\s()@&.,-_£|]{4,100}

Customer service telephone number

customerServiceWebsite
string [ 0 .. 255 ] characters

Customer service website

customerServiceEmail
string [ 0 .. 255 ] characters (^$)|[a-zA-Z0-9.!#$%&'\*\+\/=?^_`{|}~-]+@[a-z...

Customer service email

emailBillingFromAddress
required
string [ 1 .. 50 ] characters [a-zA-Z0-9.!#$%&'\*\+\/=?^_`{|}~-]+@[a-zA-Z0-...

Email billing from address

invoiceCombiningType
required
string (InvoiceCombiningType)

Invoice combining type

Enum: "NONE" "COMBINE_ALL" "COMBINE_INDIVIDUALLY" "COMBINE_ALL_DUPLEX" "COMBINE_INDIVIDUALLY_DUPLEX"
invoiceNumberFormat
string [ 0 .. 50 ] characters

Invoice number format

invoiceEmailSubject
required
string [ 1 .. 200 ] characters [\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Invoice email subject

minimumItemisationValueInPence
number

Minimum itemisation value in pence

mandatoryBankPaymentForDirectDebit
boolean
Default: false

Specifies whether bank payment details are mandatory for direct debit

enableBalanceCarryForward
required
boolean

Enable balance carry forward

emailTemplateId
required
integer <int64>

Email template identifier

invoiceNumberLabel
required
string [ 1 .. 50 ] characters [\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Invoice number label on the generated pdf invoice document

localeId
required
integer <int64>

Locale identifier

invoicePresentationName
string [ 1 .. 255 ] characters [\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Invoice presentation name

summaryInvoiceNumberLabel
required
string [ 1 .. 50 ] characters [\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Invoice number label on the generated pdf invoice summary document

priceRoundingMode
string (RoundingMode)

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 [ 1 .. 255 ] characters [\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Accounting cost centre code

companyRegistrationNumberLabel
string [ 1 .. 255 ] characters [\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...
Default: "Company Number"

Company registration number label on generated invoice pdf document

invoiceTaxLabel
string [ 1 .. 255 ] characters [\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...
Default: "VAT Number"

Invoice Tax label on the generated invoice pdf document

forceBillingDefault
boolean

Auto populate force billing on rental product inventories at creation

taxExemptLabel
required
string [ 1 .. 50 ] characters [\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...
Default: "VAT Exempt"

If a site is marked as Tax Exempt, text message to appear on the generated pdf invoice document

netAccountingAdjustmentNominalCode
string [ 1 .. 255 ] characters [\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Nominal code to be used for an adjustment line added for the net value in the account export file

taxAccountingAdjustmentNominalCode
string [ 1 .. 255 ] characters [\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Nominal code to be used for an adjustment line added for the tax value in the account export file

netAccountingAdjustmentTaxCode
string [ 1 .. 255 ] characters [\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Tax code to be used for an adjustment line added for the net value in the account export file

taxAccountingAdjustmentTaxCode
string [ 1 .. 255 ] characters [\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

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
required
string [ 1 .. 50 ] characters [\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...
Default: "Billing Period (Ending)"

Billing period end date label on the generated invoice

invoiceCustomerAccountNumberLabel
required
string [ 1 .. 50 ] characters [\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...
Default: "Account number"

Customer account number label on the generated invoice

summaryCustomerAccountNumberLabel
required
string [ 1 .. 50 ] characters [\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...
Default: "Account number"

Customer account number label on the generated invoice summary

invoiceDateLabel
required
string [ 1 .. 50 ] characters [\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...
Default: "Date (And Tax Point)"

Invoice Date label on the generated invoice

productReferenceLabel
required
string [ 1 .. 50 ] characters [\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...
Default: "Product Reference"

Product reference label to show on the screen

Responses
200

OK

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

Request samples
application/json
{
  • "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": {
    • "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,
  • "enableBalanceCarryForward": true,
  • "emailTemplateId": 1,
  • "invoiceNumberLabel": "string",
  • "localeId": 1,
  • "invoicePresentationName": "string",
  • "summaryInvoiceNumberLabel": "string",
  • "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"
}
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"
}