Skip to main content
Save Sale Entity Copy

Authorizations

​
Authorization
string
header
required

SuperOffice username:password are passed in Base64-encoded.

You can also pass inn an unencoded ticket 7T:abc== with the HTTP Authenticate header.

​
Authorization
string
header
required

SuperOffice SuperId OAuth implicit flow. You need to issue a request to the SuperId authorization URL https://online.superoffice.com/login/common/oauth/authorize?response_type=token &client_id=670734e0-4c5a-11e3-be9e-a171392e81db &redirect_uri=https://example.com/spa/

passing in the application id and redirect URL.

SuperId will log the user in, and redirect to the requested redirect URL with a #payload containing the access token and claims. (The redirect URL must be registered with SuperId in advance)

https://example.com/spa#access_token=8A%3aCust12227.AXRrCITpPBvQX3UbIohb &token_type=bearer &state= &expires_in=3600 &ctx=Cust12227 &netserver_url=https%3a%2f%2fsod.superoffice.com%2fCust12227%2fRemote%2fServices82%2f

You can take the #access_token value and pass it as the Authenticate HTTP header as a BEARER token.

Headers

​
Accept-Language
string

Convert string references and multi-language values into a specified language (iso2) code.

​
SO-Language
string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

​
SO-Culture
string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

​
SO-TimeZone
string

Specify the timezone code that you would like date/time responses converted to.

​
SO-AppToken
string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Query Parameters

​
$select
string

Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.

Body

SaleEntity, SourceSaleId, Options

SaveSaleEntityCopy: Save a sale copy prepared by CreateSaleEntityFromExisting, optionally copying parts of the source sale along with it. Those parts are read from the source sale by the server; they are not carried on the passed entity. Pass null options, or options with nothing set, to copy the sale alone.

​
SaleEntity
object

Partial SaleEntity class associating the generated SaleEntity with an interface.

​
SourceSaleId
integer<int32>
​
Options
object

Which optional parts to copy alongside a sale, for SaleAgent.SaveSaleEntityCopy. Options live here rather than as parameters on the operation, so a new one can be added without changing the signature. Nothing set copies the sale alone. Carrier object for SaleCopyOptions. Services for the SaleCopyOptions Carrier is available from the Sale Agent.

Response

OK

Result of saving a copied sale: the sale that was created, and what became of each optional part. Carrier object for SaleCopyResult. Services for the SaleCopyResult Carrier is available from the Sale Agent.

​
SaleId
integer<int32>

Id of the sale that was created.

​
StakeholderResult
enum<string>

What became of the stakeholders: not requested, copied, nothing on the source to copy, or attempted and failed.

Available options:
NotRequested,
Success,
Failure,
NothingToCopy
​
QuoteResult
enum<string>

What became of the quote: not requested, copied, nothing on the source to copy, or attempted and failed.

Available options:
NotRequested,
Success,
Failure,
NothingToCopy
​
NotesResult
enum<string>

What became of the notes: not requested, copied, nothing on the source to copy, or attempted and failed.

Available options:
NotRequested,
Success,
Failure,
NothingToCopy
​
LinksResult
enum<string>

What became of the links: not requested, copied, nothing on the source to copy, or attempted and failed.

Available options:
NotRequested,
Success,
Failure,
NothingToCopy
​
Warnings
string[]

One localized explanation per optional part that was requested but could not be copied, so a caller can present them separately rather than unpicking one joined string. Empty when everything requested succeeded. The sale itself is always created - a failure here never means the sale is missing.