| POST | /invoice/{brand}/export | Export Invoice Data | Create a invoice in a POS you are authorised for |
|---|
<?php namespace dtos;
use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};
class ExportInvoiceResponse implements JsonSerializable
{
public function __construct(
/** @description Unique Identifier of the Export Request created */
// @ApiMember(Description="Unique Identifier of the Export Request created", IsRequired=true)
/** @var string */
public string $asyncTaskId=''
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['asyncTaskId'])) $this->asyncTaskId = $o['asyncTaskId'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->asyncTaskId)) $o['asyncTaskId'] = $this->asyncTaskId;
return empty($o) ? new class(){} : $o;
}
}
class ProductCategory implements JsonSerializable
{
public function __construct(
/** @description Brand Category ID */
// @ApiMember(Description="Brand Category ID")
/** @var string|null */
public ?string $brandCategoryId=null,
/** @description Grand Category ID */
// @ApiMember(Description="Grand Category ID", IsRequired=true)
/** @var string */
public string $grandCategoryId='',
/** @description Master Category ID */
// @ApiMember(Description="Master Category ID")
/** @var string|null */
public ?string $masterCategoryId=null,
/** @description Category ID */
// @ApiMember(Description="Category ID")
/** @var string|null */
public ?string $categoryId=null,
/** @description Sub Category ID */
// @ApiMember(Description="Sub Category ID")
/** @var string|null */
public ?string $subCategoryId=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['brandCategoryId'])) $this->brandCategoryId = $o['brandCategoryId'];
if (isset($o['grandCategoryId'])) $this->grandCategoryId = $o['grandCategoryId'];
if (isset($o['masterCategoryId'])) $this->masterCategoryId = $o['masterCategoryId'];
if (isset($o['categoryId'])) $this->categoryId = $o['categoryId'];
if (isset($o['subCategoryId'])) $this->subCategoryId = $o['subCategoryId'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->brandCategoryId)) $o['brandCategoryId'] = $this->brandCategoryId;
if (isset($this->grandCategoryId)) $o['grandCategoryId'] = $this->grandCategoryId;
if (isset($this->masterCategoryId)) $o['masterCategoryId'] = $this->masterCategoryId;
if (isset($this->categoryId)) $o['categoryId'] = $this->categoryId;
if (isset($this->subCategoryId)) $o['subCategoryId'] = $this->subCategoryId;
return empty($o) ? new class(){} : $o;
}
}
class ExportInvoice implements JsonSerializable
{
public function __construct(
/** @description Brand Trigram, e.g. CAR, IWC */
// @ApiMember(Description="Brand Trigram, e.g. CAR, IWC", IsRequired=true)
/** @var string */
public string $brand='',
/** @description Pos Legacy IDs / Codes */
// @ApiMember(Description="Pos Legacy IDs / Codes", IsRequired=true)
/** @var array<string>|null */
public ?array $posCodes=null,
/** @description Date To */
// @ApiMember(Description="Date To")
/** @var DateTime|null */
public ?DateTime $dateTo=null,
/** @description Date From */
// @ApiMember(Description="Date From")
/** @var DateTime|null */
public ?DateTime $dateFrom=null,
/** @description Reason Code e.g. Y00, Y06 */
// @ApiMember(Description="Reason Code e.g. Y00, Y06")
/** @var array<string>|null */
public ?array $reasonCodes=null,
/** @description Product Categories */
// @ApiMember(Description="Product Categories")
/** @var array<ProductCategory>|null */
public ?array $productCategories=null,
/** @description Export Request ID of the API Consumers */
// @ApiMember(Description="Export Request ID of the API Consumers", IsRequired=true)
/** @var string */
public string $downloadRequestId=''
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['brand'])) $this->brand = $o['brand'];
if (isset($o['posCodes'])) $this->posCodes = JsonConverters::fromArray('string', $o['posCodes']);
if (isset($o['dateTo'])) $this->dateTo = JsonConverters::from('DateTime', $o['dateTo']);
if (isset($o['dateFrom'])) $this->dateFrom = JsonConverters::from('DateTime', $o['dateFrom']);
if (isset($o['reasonCodes'])) $this->reasonCodes = JsonConverters::fromArray('string', $o['reasonCodes']);
if (isset($o['productCategories'])) $this->productCategories = JsonConverters::fromArray('ProductCategory', $o['productCategories']);
if (isset($o['downloadRequestId'])) $this->downloadRequestId = $o['downloadRequestId'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->brand)) $o['brand'] = $this->brand;
if (isset($this->posCodes)) $o['posCodes'] = JsonConverters::toArray('string', $this->posCodes);
if (isset($this->dateTo)) $o['dateTo'] = JsonConverters::to('DateTime', $this->dateTo);
if (isset($this->dateFrom)) $o['dateFrom'] = JsonConverters::to('DateTime', $this->dateFrom);
if (isset($this->reasonCodes)) $o['reasonCodes'] = JsonConverters::toArray('string', $this->reasonCodes);
if (isset($this->productCategories)) $o['productCategories'] = JsonConverters::toArray('ProductCategory', $this->productCategories);
if (isset($this->downloadRequestId)) $o['downloadRequestId'] = $this->downloadRequestId;
return empty($o) ? new class(){} : $o;
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /invoice/{brand}/export HTTP/1.1
Host: dev-api-booster.richemont.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<ExportInvoice xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Richemont.Booster2.PublicApi.Purchase.ServiceModel">
<brand>String</brand>
<dateFrom>0001-01-01T00:00:00</dateFrom>
<dateTo>0001-01-01T00:00:00</dateTo>
<downloadRequestId>String</downloadRequestId>
<posCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</posCodes>
<productCategories xmlns:d2p1="http://schemas.datacontract.org/2004/07/Richemont.Booster2.PublicApi.Common.ServiceModel">
<d2p1:ProductCategory>
<d2p1:brandCategoryId>String</d2p1:brandCategoryId>
<d2p1:categoryId>String</d2p1:categoryId>
<d2p1:grandCategoryId>String</d2p1:grandCategoryId>
<d2p1:masterCategoryId>String</d2p1:masterCategoryId>
<d2p1:subCategoryId>String</d2p1:subCategoryId>
</d2p1:ProductCategory>
</productCategories>
<reasonCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</reasonCodes>
</ExportInvoice>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <ExportInvoiceResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Richemont.Booster2.PublicApi.Purchase.ServiceModel"> <asyncTaskId>00000000-0000-0000-0000-000000000000</asyncTaskId> </ExportInvoiceResponse>