Richemont.Booster2.PublicApi

<back to all web services

ExportInvoice

Requires Authentication
The following routes are available for this service:
POST/invoice/{brand}/exportExport Invoice DataCreate a invoice in a POS you are authorised for
import java.math.*
import java.util.*
import net.servicestack.client.*


open class ExportInvoice
{
    /**
    * Brand Trigram, e.g. CAR, IWC
    */
    @ApiMember(Description="Brand Trigram, e.g. CAR, IWC", IsRequired=true)
    var brand:String? = null

    /**
    * Pos Legacy IDs / Codes
    */
    @ApiMember(Description="Pos Legacy IDs / Codes", IsRequired=true)
    var posCodes:ArrayList<String> = ArrayList<String>()

    /**
    * Date To
    */
    @ApiMember(Description="Date To")
    var dateTo:Date? = null

    /**
    * Date From
    */
    @ApiMember(Description="Date From")
    var dateFrom:Date? = null

    /**
    * Reason Code e.g. Y00, Y06
    */
    @ApiMember(Description="Reason Code e.g. Y00, Y06")
    var reasonCodes:ArrayList<String> = ArrayList<String>()

    /**
    * Product Categories
    */
    @ApiMember(Description="Product Categories")
    var productCategories:ArrayList<ProductCategory> = ArrayList<ProductCategory>()

    /**
    * Export Request ID of the API Consumers
    */
    @ApiMember(Description="Export Request ID of the API Consumers", IsRequired=true)
    var downloadRequestId:String? = null
}

open class ProductCategory
{
    /**
    * Brand Category ID
    */
    @ApiMember(Description="Brand Category ID")
    var brandCategoryId:String? = null

    /**
    * Grand Category ID
    */
    @ApiMember(Description="Grand Category ID", IsRequired=true)
    var grandCategoryId:String? = null

    /**
    * Master Category ID
    */
    @ApiMember(Description="Master Category ID")
    var masterCategoryId:String? = null

    /**
    * Category ID
    */
    @ApiMember(Description="Category ID")
    var categoryId:String? = null

    /**
    * Sub Category ID
    */
    @ApiMember(Description="Sub Category ID")
    var subCategoryId:String? = null
}

open class ExportInvoiceResponse
{
    /**
    * Unique Identifier of the Export Request created
    */
    @ApiMember(Description="Unique Identifier of the Export Request created", IsRequired=true)
    var asyncTaskId:UUID? = null
}

Kotlin ExportInvoice DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	brand: String,
	posCodes: 
	[
		String
	],
	dateTo: 0001-01-01,
	dateFrom: 0001-01-01,
	reasonCodes: 
	[
		String
	],
	productCategories: 
	[
		{
			brandCategoryId: String,
			grandCategoryId: String,
			masterCategoryId: String,
			categoryId: String,
			subCategoryId: String
		}
	],
	downloadRequestId: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	asyncTaskId: 00000000000000000000000000000000
}