GET v1/bunits/{bunitId}/referrals/{referralId}

Get a referral of a business unit

Request Information

URI Parameters

NameDescriptionTypeAdditional information
bunitId Id of the business unit integer

Required

referralId Id of the referral integer

Required

Body Parameters

None.

Response Information

Resource Description

The requested referral

Referral
NameDescriptionTypeAdditional 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.

Response Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.