| 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 |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CompanyId | body | Guid? | No | Company to update article mappings for |
| ArticleMappings | body | List<ArticleMappingToHandle> | Yes | The article mappings to create or update |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | Guid? | No | The id of an existing mapping to update; leave empty to create a new one |
| ArticleId | form | int | No | The BokaMera article id |
| ReferenceType | form | string | Yes | The Reference Type: StripeArticle = 1, EAccountingArticle = 2 |
| ExternalReference | form | string | Yes | The external reference; Values for EAccountingArticle, StripeArticle |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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/jsv
Content-Type: text/jsv
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/jsv
Content-Length: length
[
{
ArticleId: 0,
ExternalReference: String,
ReferenceType: String
}
]