BokaMera.API.Host

CompanyBillingInformation

**Requires Authentication**
Requires any of the roles:	bookingsupplier-administrator-write, bookingsupplier-administrator-read, superadmin

The following routes are available for this service:
GET	/billing/company	Get billing details for the company.	Get billing details for the company.

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;
using BokaMera.API.ServiceModel.Db;

namespace BokaMera.API.ServiceModel.Db
{
    public partial class BaseModel
    {
    }

    public partial class BillingInformation
        : BaseModel, IBaseModelCreated, IBaseModelUpdated
    {
        public virtual BillingMethod BillingMethod { get; set; }
        [Required]
        public virtual int BillingMethodId { get; set; }

        [Required]
        public virtual string Name { get; set; }

        public virtual string? FirstName { get; set; }
        public virtual string? LastName { get; set; }
        public virtual string? PhoneNumber { get; set; }
        public virtual string? Attention { get; set; }
        public virtual string? Street1 { get; set; }
        public virtual string? Street2 { get; set; }
        public virtual string? ZipCode { get; set; }
        public virtual string? City { get; set; }
        public virtual string? Email { get; set; }
        public virtual string? CreditCard { get; set; }
        public virtual string? CreditCardHolder { get; set; }
        public virtual string? CreditCardNumber { get; set; }
        public virtual short? ValidToYear { get; set; }
        public virtual short? ValidToMonth { get; set; }
        public virtual string? CSV { get; set; }
        [Required]
        public virtual DateTime UpdatedDate { get; set; }

        [Required]
        public virtual DateTime CreatedDate { get; set; }

        [Required]
        public virtual string CountryId { get; set; }

        [Required]
        public virtual int PaymentTermsDays { get; set; }

        public virtual string? VatRegistrationNumber { get; set; }
        public virtual int LicensePlanId { get; set; }
        public virtual string? GLN { get; set; }
        public virtual string? ReferenceLine1 { get; set; }
        public virtual string? ReferenceLine2 { get; set; }
        public virtual DateTimeOffset? ModifiedDate { get; set; }
        [Required]
        public virtual Guid Id { get; set; }
    }

    public partial class BillingMethod
        : BaseModel
    {
        public virtual List<BillingMethodCountriesRelation> BillingMethodCountriesRelation { get; set; } = [];
        [Required]
        public virtual string Name { get; set; }

        [Required]
        public virtual string Description { get; set; }

        public virtual DateTimeOffset? ModifiedDate { get; set; }
        public virtual int Id { get; set; }
    }

    public partial class BillingMethodCountriesRelation
        : BaseModel
    {
        [Required]
        public virtual int BillingMethodId { get; set; }

        [Required]
        public virtual string CountryId { get; set; }

        public virtual DateTimeOffset? ModifiedDate { get; set; }
    }

}

namespace BokaMera.API.ServiceModel.Dtos
{
    public partial class AccessKeyTypeResponse
    {
        public virtual int Id { get; set; }
        public virtual string KeyType { get; set; }
        public virtual string Description { get; set; }
    }

    public partial class BillingMethodQueryResponse
    {
        ///<summary>
        ///The billing method id
        ///</summary>
        [ApiMember(Description="The billing method id")]
        public virtual int Id { get; set; }

        ///<summary>
        ///The billing method name
        ///</summary>
        [ApiMember(Description="The billing method name")]
        public virtual string Name { get; set; }

        ///<summary>
        ///The billing method description
        ///</summary>
        [ApiMember(Description="The billing method description")]
        public virtual string Description { get; set; }

        ///<summary>
        ///The billing method is valid for the following countries
        ///</summary>
        [ApiMember(Description="The billing method is valid for the following countries")]
        public virtual List<string> Countries { get; set; } = [];
    }

    [ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)]
    [ValidateRequest("IsAuthenticated")]
    public partial class CompanyBillingInformation
        : QueryDb<BillingInformation, BillingMethodQueryResponse>
    {
        ///<summary>
        ///The company id, if empty will use the company id for the user you are logged in with.
        ///</summary>
        [ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")]
        public virtual Guid? CompanyId { get; set; }

        ///<summary>
        ///If you want to include the billing methods to select from
        ///</summary>
        [ApiMember(DataType="boolean", Description="If you want to include the billing methods to select from", ParameterType="query")]
        public virtual bool IncludeBillingMethodOptions { get; set; }
    }

}

namespace ServiceStack
{
    [DataContract]
    public partial class QueryBase
    {
        [DataMember(Order=1)]
        public virtual int? Skip { get; set; }

        [DataMember(Order=2)]
        public virtual int? Take { get; set; }

        [DataMember(Order=3)]
        public virtual string? OrderBy { get; set; }

        [DataMember(Order=4)]
        public virtual string? OrderByDesc { get; set; }

        [DataMember(Order=5)]
        public virtual string? Include { get; set; }

        [DataMember(Order=6)]
        public virtual string? Fields { get; set; }

        [DataMember(Order=7)]
        public virtual Dictionary<string, string>? Meta { get; set; }
    }

    public partial class QueryDb<From, Into>
        : QueryBase
    {
    }

    [DataContract]
    public partial class QueryResponse<T>
    {
        [DataMember(Order=1)]
        public virtual int Offset { get; set; }

        [DataMember(Order=2)]
        public virtual int Total { get; set; }

        [DataMember(Order=3)]
        public virtual List<AccessKeyTypeResponse> Results { get; set; } = [];

        [DataMember(Order=4)]
        public virtual Dictionary<string, string>? Meta { get; set; }

        [DataMember(Order=5)]
        public virtual ResponseStatus? ResponseStatus { get; set; }
    }

}

C# CompanyBillingInformation DTOs

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

HTTP + XML

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

GET /billing/company HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfBillingMethodQueryResponseWg5EthtI xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Offset>0</Offset>
  <Total>0</Total>
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
    <d2p1:BillingMethodQueryResponse>
      <d2p1:Countries xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:Countries>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:Name>String</d2p1:Name>
    </d2p1:BillingMethodQueryResponse>
  </Results>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Meta>
      </ResponseError>
    </Errors>
    <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Meta>
  </ResponseStatus>
</QueryResponseOfBillingMethodQueryResponseWg5EthtI>