POST v1/bunits/{bunitId}/referrals
Create a referral
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
bunitId |
Id of the business unit receiving the referral | integer |
Required |
Body Parameters
The referral to be created
Referral| Name | Description | Type | Additional information |
|---|---|---|---|
Contract |
The contract that the referrer has made possible |
Contract |
Required. |
Referrer |
The referrer of the contract |
BusinessUnit |
Required. |
Percentage |
Information about how much the referrer will receive of the revenue generated by the contract |
decimal number |
Required. |
BillingStartDate |
The date the referral 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 referral will no longer be in effect after this date. It may be in the future. |
date |
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 referral
Referral| Name | Description | Type | Additional information |
|---|---|---|---|
Contract |
The contract that the referrer has made possible |
Contract |
Required. |
Referrer |
The referrer of the contract |
BusinessUnit |
Required. |
Percentage |
Information about how much the referrer will receive of the revenue generated by the contract |
decimal number |
Required. |
BillingStartDate |
The date the referral 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 referral will no longer be in effect after this date. It may be in the future. |
date |
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.