| 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 |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
Object = TypeVar('Object')
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ArticleMappingToHandle:
# @ApiMember(Description="The id of an existing mapping to update; leave empty to create a new one")
id: Optional[str] = None
"""
The id of an existing mapping to update; leave empty to create a new one
"""
# @ApiMember(Description="The BokaMera article id")
article_id: int = 0
"""
The BokaMera article id
"""
# @ApiMember(Description="The Reference Type: StripeArticle = 1, EAccountingArticle = 2")
reference_type: Optional[str] = None
"""
The Reference Type: StripeArticle = 1, EAccountingArticle = 2
"""
# @ApiMember(Description="The external reference; Values for EAccountingArticle, StripeArticle")
external_reference: Optional[str] = None
"""
The external reference; Values for EAccountingArticle, StripeArticle
"""
# @ValidateRequest(Validator="IsAuthenticated")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UpdateArticleMappings(ICompany):
# @ApiMember(Description="Company to update article mappings for")
company_id: Optional[str] = None
"""
Company to update article mappings for
"""
# @ApiMember(Description="The article mappings to create or update", IsRequired=true)
article_mappings: List[ArticleMappingToHandle] = field(default_factory=list)
"""
The article mappings to create or update
"""
Python UpdateArticleMappings DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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: application/json
Content-Type: application/json
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: application/json
Content-Length: length
[{"ArticleId":0,"ExternalReference":"String","ReferenceType":"String"}]