Contract owners segregate Customers for reporting and/or branding purposes
- Get a list of available contract owners
Create a new contract owner
Get a specific contract owner
Update a contract_owner
Get a list of available c...
Elevate Admin API (1.44)
Currently provides read-only access to list admin entities required by other endpoints. Maintenance of these entities is available via the Elevate frontend or by contacting the Elevate support team.
Contract Owner - the party with which a Customer is contracted to purchase products and services - segregates Customers for reporting and/or branding purposes.
Billing Cycle - means of segregating a Contract Owner's Customer base into separate billing processes which have different start days.
Supplier - the third party supplier of the product or service - allows for a number of different accounts with each supplier.
Invoice Document Profile - defines the configuration used to generate invoices for Customers. This is used on creation of Sites only.
Admin Contact - a configurable contact usable across the entire platform that can receive tripwire, usage cap, and auto-close notifications.
Email Template - a named template of text and substituted values that is used to send emails from the system.
Invoice Marketing Information - for a given sub-brand and invoice template, the marketing information used to populate the invoice template slots. This might be blank, text, images or rich text.
Download OpenAPI description
Languages
Servers
https://rest.elevatebilling.com/v1
- https://rest.elevatebilling.com/v1/contract-owners
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://rest.elevatebilling.com/v1/contract-owners?page=1&pageSize=100&sort=id%2Cname+%7C+name%3Adesc&fields=id%2Cname&name=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'OK
Contract owner name
Bank account name
International Bank Account Number (IBAN), which you can use when making or receiving international payments
Example: "GB29NWBK60161331926819"
Email address for contract owner
When creating a customer, its tripwireId will be pre-populated with this identifier
Example: 1
siBccEmailAddressstring[ 1 .. 50 ] characters[a-zA-Z0-9.!#$%&'\*\+\/=?^_`{|}~-]+@[a-zA-Z0-...required
Email address for SI
Tax registration number
Customer service telephone number
Customer service email
emailBillingFromAddressstring[ 1 .. 50 ] characters[a-zA-Z0-9.!#$%&'\*\+\/=?^_`{|}~-]+@[a-zA-Z0-...required
Email billing from address
Invoice combining type
Enum"NONE""COMBINE_ALL""COMBINE_INDIVIDUALLY""COMBINE_ALL_DUPLEX""COMBINE_INDIVIDUALLY_DUPLEX"
invoiceEmailSubjectstring[ 1 .. 200 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required
Invoice email subject
Specifies whether bank payment details are mandatory for direct debit
Default false
invoiceNumberLabelstring[ 1 .. 50 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required
Invoice number label on the generated pdf invoice document
invoicePresentationNamestring[ 1 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...
Invoice presentation name
summaryInvoiceNumberLabelstring[ 1 .. 50 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required
Invoice number label on the generated pdf invoice summary document
Number of decimal places to show on the screen for rated records etc.
Example: 1
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"
Accounting cost centre code
companyRegistrationNumberLabelstring[ 1 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...
Company registration number label on generated invoice pdf document
Default "Company Number"
Invoice Tax label on the generated invoice pdf document
Default "VAT Number"
If a site is marked as Tax Exempt, text message to appear on the generated pdf invoice document
Default "VAT Exempt"
netAccountingAdjustmentNominalCodestring[ 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
taxAccountingAdjustmentNominalCodestring[ 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
netAccountingAdjustmentTaxCodestring[ 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
taxAccountingAdjustmentTaxCodestring[ 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
Should the pdf invoice be attached to the invoice email? If the email includes a link to the invoice, set this to False
billingPeriodEndDateLabelstring[ 1 .. 50 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required
Billing period end date label on the generated invoice
Default "Billing Period (Ending)"
invoiceCustomerAccountNumberLabelstring[ 1 .. 50 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required
Customer account number label on the generated invoice
Default "Account number"
summaryCustomerAccountNumberLabelstring[ 1 .. 50 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required
Customer account number label on the generated invoice summary
Default "Account number"
invoiceDateLabelstring[ 1 .. 50 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required
Invoice Date label on the generated invoice
Default "Date (And Tax Point)"
productReferenceLabelstring[ 1 .. 50 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required
Product reference label to show on the screen
Default "Product Reference"
Items Enum"USAGE""USAGE_TRIPWIRE""FULL_CUSTOMER""MATCHMAKER"
Response
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": { … }, "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": [ … ] } ]
Bodyapplication/jsonrequired
New contract owner
Contract owner name
Bank account name
International Bank Account Number (IBAN), which you can use when making or receiving international payments
Example: "GB29NWBK60161331926819"
Email address for contract owner
When creating a customer, its tripwireId will be pre-populated with this identifier
Example: 1
siBccEmailAddressstring[ 1 .. 50 ] characters[a-zA-Z0-9.!#$%&'\*\+\/=?^_`{|}~-]+@[a-zA-Z0-...required
Email address for SI
Tax registration number
Customer service telephone number
Customer service email
emailBillingFromAddressstring[ 1 .. 50 ] characters[a-zA-Z0-9.!#$%&'\*\+\/=?^_`{|}~-]+@[a-zA-Z0-...required
Email billing from address
Invoice combining type
Enum"NONE""COMBINE_ALL""COMBINE_INDIVIDUALLY""COMBINE_ALL_DUPLEX""COMBINE_INDIVIDUALLY_DUPLEX"
invoiceEmailSubjectstring[ 1 .. 200 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required
Invoice email subject
Specifies whether bank payment details are mandatory for direct debit
Default false
invoiceNumberLabelstring[ 1 .. 50 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required
Invoice number label on the generated pdf invoice document
invoicePresentationNamestring[ 1 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...
Invoice presentation name
summaryInvoiceNumberLabelstring[ 1 .. 50 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required
Invoice number label on the generated pdf invoice summary document
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"
Accounting cost centre code
companyRegistrationNumberLabelstring[ 1 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...
Company registration number label on generated invoice pdf document
Default "Company Number"
Invoice Tax label on the generated invoice pdf document
Default "VAT Number"
If a site is marked as Tax Exempt, text message to appear on the generated pdf invoice document
Default "VAT Exempt"
netAccountingAdjustmentNominalCodestring[ 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
taxAccountingAdjustmentNominalCodestring[ 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
netAccountingAdjustmentTaxCodestring[ 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
taxAccountingAdjustmentTaxCodestring[ 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
Should the pdf invoice be attached to the invoice email? If the email includes a link to the invoice, set this to False
billingPeriodEndDateLabelstring[ 1 .. 50 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required
Billing period end date label on the generated invoice
Default "Billing Period (Ending)"
invoiceCustomerAccountNumberLabelstring[ 1 .. 50 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required
Customer account number label on the generated invoice
Default "Account number"
summaryCustomerAccountNumberLabelstring[ 1 .. 50 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required
Customer account number label on the generated invoice summary
Default "Account number"
- https://rest.elevatebilling.com/v1/contract-owners
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://rest.elevatebilling.com/v1/contract-owners \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"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"
}'OK
Contract owner name
Bank account name
International Bank Account Number (IBAN), which you can use when making or receiving international payments
Example: "GB29NWBK60161331926819"
Email address for contract owner
When creating a customer, its tripwireId will be pre-populated with this identifier
Example: 1
siBccEmailAddressstring[ 1 .. 50 ] characters[a-zA-Z0-9.!#$%&'\*\+\/=?^_`{|}~-]+@[a-zA-Z0-...required
Email address for SI
Tax registration number
Customer service telephone number
Customer service email
emailBillingFromAddressstring[ 1 .. 50 ] characters[a-zA-Z0-9.!#$%&'\*\+\/=?^_`{|}~-]+@[a-zA-Z0-...required
Email billing from address
Invoice combining type
Enum"NONE""COMBINE_ALL""COMBINE_INDIVIDUALLY""COMBINE_ALL_DUPLEX""COMBINE_INDIVIDUALLY_DUPLEX"
invoiceEmailSubjectstring[ 1 .. 200 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required
Invoice email subject
Specifies whether bank payment details are mandatory for direct debit
Default false
invoiceNumberLabelstring[ 1 .. 50 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required
Invoice number label on the generated pdf invoice document
invoicePresentationNamestring[ 1 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...
Invoice presentation name
summaryInvoiceNumberLabelstring[ 1 .. 50 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required
Invoice number label on the generated pdf invoice summary document
Number of decimal places to show on the screen for rated records etc.
Example: 1
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"
Accounting cost centre code
companyRegistrationNumberLabelstring[ 1 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...
Company registration number label on generated invoice pdf document
Default "Company Number"
Invoice Tax label on the generated invoice pdf document
Default "VAT Number"
If a site is marked as Tax Exempt, text message to appear on the generated pdf invoice document
Default "VAT Exempt"
netAccountingAdjustmentNominalCodestring[ 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
taxAccountingAdjustmentNominalCodestring[ 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
netAccountingAdjustmentTaxCodestring[ 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
taxAccountingAdjustmentTaxCodestring[ 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
Should the pdf invoice be attached to the invoice email? If the email includes a link to the invoice, set this to False
billingPeriodEndDateLabelstring[ 1 .. 50 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required
Billing period end date label on the generated invoice
Default "Billing Period (Ending)"
invoiceCustomerAccountNumberLabelstring[ 1 .. 50 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required
Customer account number label on the generated invoice
Default "Account number"
summaryCustomerAccountNumberLabelstring[ 1 .. 50 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required
Customer account number label on the generated invoice summary
Default "Account number"
invoiceDateLabelstring[ 1 .. 50 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required
Invoice Date label on the generated invoice
Default "Date (And Tax Point)"
Response
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" ] }
- https://rest.elevatebilling.com/v1/contract-owners/{contract_owner_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://rest.elevatebilling.com/v1/contract-owners/1 \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Contract owner found
Contract owner name
Bank account name
International Bank Account Number (IBAN), which you can use when making or receiving international payments
Example: "GB29NWBK60161331926819"
Email address for contract owner
When creating a customer, its tripwireId will be pre-populated with this identifier
Example: 1
siBccEmailAddressstring[ 1 .. 50 ] characters[a-zA-Z0-9.!#$%&'\*\+\/=?^_`{|}~-]+@[a-zA-Z0-...required
Email address for SI
Tax registration number
Customer service telephone number
Customer service email
emailBillingFromAddressstring[ 1 .. 50 ] characters[a-zA-Z0-9.!#$%&'\*\+\/=?^_`{|}~-]+@[a-zA-Z0-...required
Email billing from address
Invoice combining type
Enum"NONE""COMBINE_ALL""COMBINE_INDIVIDUALLY""COMBINE_ALL_DUPLEX""COMBINE_INDIVIDUALLY_DUPLEX"
invoiceEmailSubjectstring[ 1 .. 200 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required
Invoice email subject
Specifies whether bank payment details are mandatory for direct debit
Default false
invoiceNumberLabelstring[ 1 .. 50 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required
Invoice number label on the generated pdf invoice document
invoicePresentationNamestring[ 1 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...
Invoice presentation name
summaryInvoiceNumberLabelstring[ 1 .. 50 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required
Invoice number label on the generated pdf invoice summary document
Number of decimal places to show on the screen for rated records etc.
Example: 1
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"
Accounting cost centre code
companyRegistrationNumberLabelstring[ 1 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...
Company registration number label on generated invoice pdf document
Default "Company Number"
Invoice Tax label on the generated invoice pdf document
Default "VAT Number"
If a site is marked as Tax Exempt, text message to appear on the generated pdf invoice document
Default "VAT Exempt"
netAccountingAdjustmentNominalCodestring[ 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
taxAccountingAdjustmentNominalCodestring[ 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
netAccountingAdjustmentTaxCodestring[ 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
taxAccountingAdjustmentTaxCodestring[ 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
Should the pdf invoice be attached to the invoice email? If the email includes a link to the invoice, set this to False
billingPeriodEndDateLabelstring[ 1 .. 50 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required
Billing period end date label on the generated invoice
Default "Billing Period (Ending)"
invoiceCustomerAccountNumberLabelstring[ 1 .. 50 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required
Customer account number label on the generated invoice
Default "Account number"
summaryCustomerAccountNumberLabelstring[ 1 .. 50 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required
Customer account number label on the generated invoice summary
Default "Account number"
invoiceDateLabelstring[ 1 .. 50 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required
Invoice Date label on the generated invoice
Default "Date (And Tax Point)"
Response
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" ] }
Bodyapplication/json-patch+jsonrequired
A set of JSONPatch operations to be performed
The JSON Patch operation to be performed
Enum"add""remove""replace""move""copy""test"
- https://rest.elevatebilling.com/v1/contract-owners/{contract_owner_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PATCH \
https://rest.elevatebilling.com/v1/contract-owners/1 \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json-patch+json' \
-d '[
{
"op": "replace",
"path": "/bankIban",
"value": "AL472121100900000002356987411"
}
]'Success
Contract owner name
Bank account name
International Bank Account Number (IBAN), which you can use when making or receiving international payments
Example: "GB29NWBK60161331926819"
Email address for contract owner
When creating a customer, its tripwireId will be pre-populated with this identifier
Example: 1
siBccEmailAddressstring[ 1 .. 50 ] characters[a-zA-Z0-9.!#$%&'\*\+\/=?^_`{|}~-]+@[a-zA-Z0-...required
Email address for SI
Tax registration number
Customer service telephone number
Customer service email
emailBillingFromAddressstring[ 1 .. 50 ] characters[a-zA-Z0-9.!#$%&'\*\+\/=?^_`{|}~-]+@[a-zA-Z0-...required
Email billing from address
Invoice combining type
Enum"NONE""COMBINE_ALL""COMBINE_INDIVIDUALLY""COMBINE_ALL_DUPLEX""COMBINE_INDIVIDUALLY_DUPLEX"
invoiceEmailSubjectstring[ 1 .. 200 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required
Invoice email subject
Specifies whether bank payment details are mandatory for direct debit
Default false
invoiceNumberLabelstring[ 1 .. 50 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required
Invoice number label on the generated pdf invoice document
invoicePresentationNamestring[ 1 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...
Invoice presentation name
summaryInvoiceNumberLabelstring[ 1 .. 50 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required
Invoice number label on the generated pdf invoice summary document
Number of decimal places to show on the screen for rated records etc.
Example: 1
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"
Accounting cost centre code
companyRegistrationNumberLabelstring[ 1 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...
Company registration number label on generated invoice pdf document
Default "Company Number"
Invoice Tax label on the generated invoice pdf document
Default "VAT Number"
If a site is marked as Tax Exempt, text message to appear on the generated pdf invoice document
Default "VAT Exempt"
netAccountingAdjustmentNominalCodestring[ 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
taxAccountingAdjustmentNominalCodestring[ 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
netAccountingAdjustmentTaxCodestring[ 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
taxAccountingAdjustmentTaxCodestring[ 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
Should the pdf invoice be attached to the invoice email? If the email includes a link to the invoice, set this to False
billingPeriodEndDateLabelstring[ 1 .. 50 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required
Billing period end date label on the generated invoice
Default "Billing Period (Ending)"
invoiceCustomerAccountNumberLabelstring[ 1 .. 50 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required
Customer account number label on the generated invoice
Default "Account number"
summaryCustomerAccountNumberLabelstring[ 1 .. 50 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required
Customer account number label on the generated invoice summary
Default "Account number"
invoiceDateLabelstring[ 1 .. 50 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required
Invoice Date label on the generated invoice
Default "Date (And Tax Point)"
Response
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" ] }