POST v1/bunits/{bunitId}/contract
Create a contract for a business unit.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
bunitId |
The ID of the business unit the contract will be bound to. | integer |
Required |
Body Parameters
The new contract.
Contract| Name | Description | Type | Additional information |
|---|---|---|---|
BillingStartDate |
The date the contract is effective from. No invoice will be done until this date is crossed. |
date |
If omitted during creation, the value will be set to current date. |
BillingEndDate |
The contract will no longer be in effect after this date. It may be in the future. |
date |
None. |
AgreedLegalTerms |
The legal terms of the contract |
string |
None. |
Ean |
International Article Number (formerly European Article Number). |
string |
None. |
EanRequisitionNumber |
Auxiliary information related to electronic invoicing |
string |
None. |
EanContactNumber |
Auxiliary information related to electronic invoicing |
string |
None. |
ErpReference |
A reference to an external ERP (or CRM) system. This field will be included in billing data. |
string |
None. |
OptionalErpReference |
A reference to an external ERP (or CRM) system. This field will be included in billing data. |
string |
None. |
Discount |
This percentage will give the consumer a visible discount on the invoice. |
decimal number |
None. |
ByCalendar |
Force the invoicing to adhere to the calendar year. This becomes relevant when the billing cycle is set to quarterly, semiannually or annually. |
boolean |
None. |
PrepayConsumption |
If true consumption is paid in advance for one billing cycle based on the amount at time of invoicing If false actual consumption is paid monthly based on actual consumption |
boolean |
None. |
UseCpuMultiplier |
Use the backup node's CPU count as a multiplier. This option is relevant in some SP licensing situations. |
boolean |
None. |
BillingCycle |
The billing cycle contains information about how often the business unit is billed This can be monthly, quarterly, semi-annually and annually |
BillingCycle |
Required. |
PaymentTerms |
Information about what kind of credit is extended to the business unit. The code of the payment terms will be displayed on the contract's billing data. |
PaymentTerms |
None. |
Currency |
Currency will be displayed on the contract's billing data. |
Currency |
None. |
Commission |
Contract commission details. |
Commission |
A commission contract cannot have a subscription. Pricing for the business unit's own consumption can be defined on the commission instance. |
Subscriptions |
Contract subscription details. |
Collection of ContractSubscription |
A subscription contract cannot have a commission. |
Exceptions |
Exceptions to the contract that changes the way the contract is invoiced for certain business units. |
Collection of ContractException |
None. |
Consumer |
The business unit the contract concerns |
BusinessUnit |
None. |
Referrals |
If the contract has a referral, it was referred to its provider by another business unit. |
Collection of Referral |
None. |
Id |
A unique ID for the object. |
integer |
Read-only. |
CreatedDate |
Time and date the object was created. |
date |
Read-only. |
ArchivedDate |
Time and date the object was or is going to be archived. Unarchived objects have no value in ArchivedDate |
date |
Read-only. |
Operations |
Collection of OperationResult |
None. |
Request Formats
application/json
Sample:
Sample not available.
text/json
Sample:
Sample not available.
Response Information
Resource Description
The created contract.
Contract| Name | Description | Type | Additional information |
|---|---|---|---|
BillingStartDate |
The date the contract is effective from. No invoice will be done until this date is crossed. |
date |
If omitted during creation, the value will be set to current date. |
BillingEndDate |
The contract will no longer be in effect after this date. It may be in the future. |
date |
None. |
AgreedLegalTerms |
The legal terms of the contract |
string |
None. |
Ean |
International Article Number (formerly European Article Number). |
string |
None. |
EanRequisitionNumber |
Auxiliary information related to electronic invoicing |
string |
None. |
EanContactNumber |
Auxiliary information related to electronic invoicing |
string |
None. |
ErpReference |
A reference to an external ERP (or CRM) system. This field will be included in billing data. |
string |
None. |
OptionalErpReference |
A reference to an external ERP (or CRM) system. This field will be included in billing data. |
string |
None. |
Discount |
This percentage will give the consumer a visible discount on the invoice. |
decimal number |
None. |
ByCalendar |
Force the invoicing to adhere to the calendar year. This becomes relevant when the billing cycle is set to quarterly, semiannually or annually. |
boolean |
None. |
PrepayConsumption |
If true consumption is paid in advance for one billing cycle based on the amount at time of invoicing If false actual consumption is paid monthly based on actual consumption |
boolean |
None. |
UseCpuMultiplier |
Use the backup node's CPU count as a multiplier. This option is relevant in some SP licensing situations. |
boolean |
None. |
BillingCycle |
The billing cycle contains information about how often the business unit is billed This can be monthly, quarterly, semi-annually and annually |
BillingCycle |
Required. |
PaymentTerms |
Information about what kind of credit is extended to the business unit. The code of the payment terms will be displayed on the contract's billing data. |
PaymentTerms |
None. |
Currency |
Currency will be displayed on the contract's billing data. |
Currency |
None. |
Commission |
Contract commission details. |
Commission |
A commission contract cannot have a subscription. Pricing for the business unit's own consumption can be defined on the commission instance. |
Subscriptions |
Contract subscription details. |
Collection of ContractSubscription |
A subscription contract cannot have a commission. |
Exceptions |
Exceptions to the contract that changes the way the contract is invoiced for certain business units. |
Collection of ContractException |
None. |
Consumer |
The business unit the contract concerns |
BusinessUnit |
None. |
Referrals |
If the contract has a referral, it was referred to its provider by another business unit. |
Collection of Referral |
None. |
Id |
A unique ID for the object. |
integer |
Read-only. |
CreatedDate |
Time and date the object was created. |
date |
Read-only. |
ArchivedDate |
Time and date the object was or is going to be archived. Unarchived objects have no value in ArchivedDate |
date |
Read-only. |
Operations |
Collection of OperationResult |
None. |
Response Formats
application/json
Sample:
Sample not available.
text/json
Sample:
Sample not available.