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
"use strict";
export class ArticleMappingsQuery {
    /** @param {{CompanyId?:string,ReferenceType?:string,ArticleId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {?string}
     * @description Company to show article mappings for */
    CompanyId;
    /**
     * @type {string}
     * @description The Reference Type to filter on: StripeArticle, EAccountingArticle */
    ReferenceType;
    /**
     * @type {?number}
     * @description Article to show mappings for */
    ArticleId;
}

JavaScript 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: api.bookmore.dev 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

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