BokaMera.API.Host

<back to all web services

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/companyGet billing details for the company.Get billing details for the company.

// @DataContract
export class QueryBase
{
    /** @description 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> */
    // @DataMember(Order=1)
    public Skip?: number;

    /** @description 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> */
    // @DataMember(Order=2)
    public Take?: number;

    /** @description 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> */
    // @DataMember(Order=3)
    public OrderBy: string;

    /** @description 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> */
    // @DataMember(Order=4)
    public OrderByDesc: string;

    /** @description 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> */
    // @DataMember(Order=5)
    public Include: string;

    // @DataMember(Order=6)
    public Fields: string;

    // @DataMember(Order=7)
    public Meta: { [index: string]: string; };

    public constructor(init?: Partial<QueryBase>) { (Object as any).assign(this, init); }
}

export class QueryDb<From, Into> extends QueryBase
{

    public constructor(init?: Partial<QueryDb<From, Into>>) { super(init); (Object as any).assign(this, init); }
}

export class BillingMethodQueryResponse
{
    /** @description The billing method id */
    // @ApiMember(Description="The billing method id")
    public Id: number;

    /** @description The billing method name */
    // @ApiMember(Description="The billing method name")
    public Name: string;

    /** @description The billing method description */
    // @ApiMember(Description="The billing method description")
    public Description: string;

    /** @description The billing method is valid for the following countries */
    // @ApiMember(Description="The billing method is valid for the following countries")
    public Countries: string[];

    public constructor(init?: Partial<BillingMethodQueryResponse>) { (Object as any).assign(this, init); }
}

export class BaseModel
{

    public constructor(init?: Partial<BaseModel>) { (Object as any).assign(this, init); }
}

export class BillingMethodCountriesRelation extends BaseModel
{
    // @Required()
    public BillingMethodId: number;

    // @Required()
    public CountryId: string;

    public ModifiedDate?: string;

    public constructor(init?: Partial<BillingMethodCountriesRelation>) { super(init); (Object as any).assign(this, init); }
}

export class BillingMethod extends BaseModel
{
    public BillingMethodCountriesRelation: BillingMethodCountriesRelation[];
    // @Required()
    public Name: string;

    // @Required()
    public Description: string;

    public ModifiedDate?: string;
    public Id: number;

    public constructor(init?: Partial<BillingMethod>) { super(init); (Object as any).assign(this, init); }
}

export class BillingInformation extends BaseModel
{
    public BillingMethod: BillingMethod;
    // @Required()
    public BillingMethodId: number;

    // @Required()
    public Name: string;

    public Attention: string;
    public Street1: string;
    public Street2: string;
    public ZipCode: string;
    public City: string;
    public Email: string;
    public CreditCard: string;
    public CreditCardHolder: string;
    public CreditCardNumber: string;
    public ValidToYear?: number;
    public ValidToMonth?: number;
    public CSV: string;
    // @Required()
    public Updated: string;

    // @Required()
    public Created: string;

    // @Required()
    public CountryId: string;

    // @Required()
    public PaymentTermsDays: number;

    public VATRegistrationNumber: string;
    public GLN: string;
    public ReferenceLine1: string;
    public ReferenceLine2: string;
    public ModifiedDate?: string;
    // @Required()
    public Id: string;

    public constructor(init?: Partial<BillingInformation>) { super(init); (Object as any).assign(this, init); }
}

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
export class CompanyBillingInformation extends QueryDb<BillingInformation, BillingMethodQueryResponse>
{
    /** @description 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.")
    public CompanyId?: string;

    /** @description If you want to include the billing methods to select from */
    // @ApiMember(DataType="boolean", Description="If you want to include the billing methods to select from", ParameterType="query")
    public IncludeBillingMethodOptions: boolean;

    public constructor(init?: Partial<CompanyBillingInformation>) { super(init); (Object as any).assign(this, init); }
}

export class AccessKeyTypeResponse
{
    public Id: number;
    public KeyType: string;
    public Description: string;

    public constructor(init?: Partial<AccessKeyTypeResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class QueryResponse<AccessKeyTypeResponse>
{
    // @DataMember(Order=1)
    public Offset: number;

    // @DataMember(Order=2)
    public Total: number;

    // @DataMember(Order=3)
    public Results: AccessKeyTypeResponse[];

    // @DataMember(Order=4)
    public Meta: { [index: string]: string; };

    // @DataMember(Order=5)
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<QueryResponse<AccessKeyTypeResponse>>) { (Object as any).assign(this, init); }
}

TypeScript CompanyBillingInformation 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 /billing/company HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Offset":0,"Total":0,"Results":[{"Id":0,"Name":"String","Description":"String","Countries":["String"]}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}