| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| PUT | /articles/mappings | Update external article mappings for the company articles | Create or update mappings between BokaMera articles and articles in an external system, for example e-accounting |
|---|
"use strict";
export class ArticleMappingToHandle {
/** @param {{Id?:string,ArticleId?:number,ReferenceType?:string,ExternalReference?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {?string}
* @description The id of an existing mapping to update; leave empty to create a new one */
Id;
/**
* @type {number}
* @description The BokaMera article id */
ArticleId;
/**
* @type {string}
* @description The Reference Type: StripeArticle = 1, EAccountingArticle = 2 */
ReferenceType;
/**
* @type {string}
* @description The external reference; Values for EAccountingArticle, StripeArticle */
ExternalReference;
}
export class UpdateArticleMappings {
/** @param {{CompanyId?:string,ArticleMappings?:ArticleMappingToHandle[]}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {?string}
* @description Company to update article mappings for */
CompanyId;
/**
* @type {ArticleMappingToHandle[]}
* @description The article mappings to create or update */
ArticleMappings = [];
}
JavaScript UpdateArticleMappings DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /articles/mappings HTTP/1.1
Host: testapi.bokamera.se
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"CompanyId":"00000000-0000-0000-0000-000000000000","ArticleMappings":[{"Id":"00000000-0000-0000-0000-000000000000","ArticleId":0,"ReferenceType":"String","ExternalReference":"String"}]}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
[{"ArticleId":0,"ExternalReference":"String","ReferenceType":"String"}]