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.

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BokaMera.API.ServiceModel.Dtos
Imports BokaMera.API.ServiceModel.Db

Namespace Global

    Namespace BokaMera.API.ServiceModel.Db

        Public Partial Class BaseModel
        End Class

        Public Partial Class BillingInformation
            Inherits BaseModel
            Public Overridable Property BillingMethod As BillingMethod
            <Required>
            Public Overridable Property BillingMethodId As Integer

            <Required>
            Public Overridable Property Name As String

            Public Overridable Property Attention As String
            Public Overridable Property Street1 As String
            Public Overridable Property Street2 As String
            Public Overridable Property ZipCode As String
            Public Overridable Property City As String
            Public Overridable Property Email As String
            Public Overridable Property CreditCard As String
            Public Overridable Property CreditCardHolder As String
            Public Overridable Property CreditCardNumber As String
            Public Overridable Property ValidToYear As Nullable(Of Short)
            Public Overridable Property ValidToMonth As Nullable(Of Short)
            Public Overridable Property CSV As String
            <Required>
            Public Overridable Property Updated As Date

            <Required>
            Public Overridable Property Created As Date

            <Required>
            Public Overridable Property CountryId As String

            <Required>
            Public Overridable Property PaymentTermsDays As Integer

            Public Overridable Property VATRegistrationNumber As String
            Public Overridable Property GLN As String
            Public Overridable Property ReferenceLine1 As String
            Public Overridable Property ReferenceLine2 As String
            Public Overridable Property ModifiedDate As Nullable(Of DateTimeOffset)
            <Required>
            Public Overridable Property Id As Guid
        End Class

        Public Partial Class BillingMethod
            Inherits BaseModel
            Public Sub New()
                BillingMethodCountriesRelation = New List(Of BillingMethodCountriesRelation)
            End Sub

            Public Overridable Property BillingMethodCountriesRelation As List(Of BillingMethodCountriesRelation)
            <Required>
            Public Overridable Property Name As String

            <Required>
            Public Overridable Property Description As String

            Public Overridable Property ModifiedDate As Nullable(Of DateTimeOffset)
            Public Overridable Property Id As Integer
        End Class

        Public Partial Class BillingMethodCountriesRelation
            Inherits BaseModel
            <Required>
            Public Overridable Property BillingMethodId As Integer

            <Required>
            Public Overridable Property CountryId As String

            Public Overridable Property ModifiedDate As Nullable(Of DateTimeOffset)
        End Class
    End Namespace

    Namespace BokaMera.API.ServiceModel.Dtos

        Public Partial Class AccessKeyTypeResponse
            Public Overridable Property Id As Integer
            Public Overridable Property KeyType As String
            Public Overridable Property Description As String
        End Class

        Public Partial Class BillingMethodQueryResponse
            Public Sub New()
                Countries = New List(Of String)
            End Sub

            '''<Summary>
            '''The billing method id
            '''</Summary>
            <ApiMember(Description:="The billing method id")>
            Public Overridable Property Id As Integer

            '''<Summary>
            '''The billing method name
            '''</Summary>
            <ApiMember(Description:="The billing method name")>
            Public Overridable Property Name As String

            '''<Summary>
            '''The billing method description
            '''</Summary>
            <ApiMember(Description:="The billing method description")>
            Public Overridable Property Description As String

            '''<Summary>
            '''The billing method is valid for the following countries
            '''</Summary>
            <ApiMember(Description:="The billing method is valid for the following countries")>
            Public Overridable Property Countries As List(Of String)
        End Class

        <ApiResponse(Description:="You were unauthorized to call this service", StatusCode:=401)>
        <ValidateRequest(Validator:="IsAuthenticated")>
        Public Partial Class CompanyBillingInformation
            Inherits QueryDb(Of 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 Overridable Property CompanyId As Nullable(Of Guid)

            '''<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 Overridable Property IncludeBillingMethodOptions As Boolean
        End Class
    End Namespace

    Namespace ServiceStack

        <DataContract>
        Public Partial Class QueryBase
            Public Sub New()
                Meta = New Dictionary(Of String, String)
            End Sub

            '''<Summary>
            '''Skip over a given number of elements in a sequence and then return the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?skip=10&orderBy=Id</code>
            '''</Summary>
            <DataMember(Order:=1)>
            Public Overridable Property Skip As Nullable(Of Integer)

            '''<Summary>
            '''Return a given number of elements in a sequence and then skip over the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?take=20</code>
            '''</Summary>
            <DataMember(Order:=2)>
            Public Overridable Property Take As Nullable(Of Integer)

            '''<Summary>
            '''Comma separated list of fields to order by. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderBy=Id,-Age,FirstName</code>
            '''</Summary>
            <DataMember(Order:=3)>
            Public Overridable Property OrderBy As String

            '''<Summary>
            '''Comma separated list of fields to order by in descending order. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderByDesc=Id,-Age,FirstName</code>
            '''</Summary>
            <DataMember(Order:=4)>
            Public Overridable Property OrderByDesc As String

            '''<Summary>
            '''Include any of the aggregates <code>AVG, COUNT, FIRST, LAST, MAX, MIN, SUM</code> in your result set. The results will be returned in the meta field.<br/><br/><strong>Example:</strong><br/><code>?include=COUNT(*) as Total</code><br/><br/>or multiple fields with<br/><code>?include=Count(*) Total, Min(Age), AVG(Age) AverageAge</code><br/></br>or unique with<br/><code>?include=COUNT(DISTINCT LivingStatus) as UniqueStatus</code>
            '''</Summary>
            <DataMember(Order:=5)>
            Public Overridable Property Include As String

            <DataMember(Order:=6)>
            Public Overridable Property Fields As String

            <DataMember(Order:=7)>
            Public Overridable Property Meta As Dictionary(Of String, String)
        End Class

        Public Partial Class QueryDb(Of From, Into)
            Inherits QueryBase
        End Class

        <DataContract>
        Public Partial Class QueryResponse(Of AccessKeyTypeResponse)
            Public Sub New()
                Results = New List(Of AccessKeyTypeResponse)
                Meta = New Dictionary(Of String, String)
            End Sub

            <DataMember(Order:=1)>
            Public Overridable Property Offset As Integer

            <DataMember(Order:=2)>
            Public Overridable Property Total As Integer

            <DataMember(Order:=3)>
            Public Overridable Property Results As List(Of AccessKeyTypeResponse)

            <DataMember(Order:=4)>
            Public Overridable Property Meta As Dictionary(Of String, String)

            <DataMember(Order:=5)>
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET 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: api.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>