| Requires any of the roles: | bookingsupplier-administrator-write, bookingsupplier-administrator-read, superadmin |
| GET | /articles/mappings | Get all external article mappings for the company articles | Get all 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')
# @ValidateRequest(Validator="IsAuthenticated")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ArticleMappingsQuery(ICompany):
# @ApiMember(Description="Company to show article mappings for")
company_id: Optional[str] = None
"""
Company to show article mappings for
"""
# @ApiMember(Description="The Reference Type to filter on: StripeArticle, EAccountingArticle")
reference_type: Optional[str] = None
"""
The Reference Type to filter on: StripeArticle, EAccountingArticle
"""
# @ApiMember(Description="Article to show mappings for")
article_id: Optional[int] = None
"""
Article to show mappings for
"""
Python ArticleMappingsQuery DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ArrayOfArticleMappingResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<ArticleMappingResponse>
<ArticleId>0</ArticleId>
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<ExternalReference>String</ExternalReference>
<Id>00000000-0000-0000-0000-000000000000</Id>
<ReferenceType>String</ReferenceType>
</ArticleMappingResponse>
</ArrayOfArticleMappingResponse>