BokaMera.API.Host

<back to all web services

ArticleMappingsQuery

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, bookingsupplier-administrator-read, superadmin
The following routes are available for this service:
GET/articles/mappingsGet all external article mappings for the company articlesGet all mappings between BokaMera articles and articles in an external system, for example e-accounting
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


@ValidateRequest(Validator="IsAuthenticated")
open class ArticleMappingsQuery : ICompany
{
    /**
    * Company to show article mappings for
    */
    @ApiMember(Description="Company to show article mappings for")
    override var CompanyId:UUID? = null

    /**
    * The Reference Type to filter on: StripeArticle, EAccountingArticle
    */
    @ApiMember(Description="The Reference Type to filter on: StripeArticle, EAccountingArticle")
    open var ReferenceType:String? = null

    /**
    * Article to show mappings for
    */
    @ApiMember(Description="Article to show mappings for")
    open var ArticleId:Int? = null
}

Kotlin ArticleMappingsQuery DTOs

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

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /articles/mappings HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

[{"ArticleId":0,"ExternalReference":"String","ReferenceType":"String"}]