BokaMera.API.Host

<back to all web services

ExportPayableEntityReport

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
GET/articles/{InternalReferenceId}/reportsGet a report as a PDF fileGet a PDF report.
import 'package:servicestack/servicestack.dart';

enum SendReceiptMethod
{
    Email,
    PdfExport,
}

// @ValidateRequest(Validator="IsAuthenticated")
class ExportPayableEntityReport implements ICompany, IConvertible
{
    /**
    * The company id, if empty will use the company id for the user you are logged in with.
    */
    // @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
    String? CompanyId;

    /**
    * Id of the internal reference (booking, rebate code, etc)
    */
    // @ApiMember(Description="Id of the internal reference (booking, rebate code, etc)", IsRequired=true, ParameterType="path")
    String? InternalReferenceId;

    SendReceiptMethod? SendReceiptMethod;
    /**
    * Article type (Could be Service, rebate code types, etc..
    */
    // @ApiMember(Description="Article type (Could be Service, rebate code types, etc..", IsRequired=true)
    int? ArticleTypeId;

    ExportPayableEntityReport({this.CompanyId,this.InternalReferenceId,this.SendReceiptMethod,this.ArticleTypeId});
    ExportPayableEntityReport.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        CompanyId = json['CompanyId'];
        InternalReferenceId = json['InternalReferenceId'];
        SendReceiptMethod = JsonConverters.fromJson(json['SendReceiptMethod'],'SendReceiptMethod',context!);
        ArticleTypeId = json['ArticleTypeId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'CompanyId': CompanyId,
        'InternalReferenceId': InternalReferenceId,
        'SendReceiptMethod': JsonConverters.toJson(SendReceiptMethod,'SendReceiptMethod',context!),
        'ArticleTypeId': ArticleTypeId
    };

    getTypeName() => "ExportPayableEntityReport";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.bokamera.se', types: <String, TypeInfo> {
    'SendReceiptMethod': TypeInfo(TypeOf.Enum, enumValues:SendReceiptMethod.values),
    'ExportPayableEntityReport': TypeInfo(TypeOf.Class, create:() => ExportPayableEntityReport()),
});

Dart ExportPayableEntityReport DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /articles/{InternalReferenceId}/reports HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{}