BokaMera.API.Host

<back to all web services

CompanyBillingInformation

// @ts-nocheck

// @DataContract
export class QueryBase
{
    // @DataMember(Order=1)
    public Skip?: number;

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

    // @DataMember(Order=3)
    public OrderBy?: string;

    // @DataMember(Order=4)
    public OrderByDesc?: string;

    // @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 implements IBaseModelCreated, IBaseModelUpdated
{
    public BillingMethod: BillingMethod;
    // @Required()
    public BillingMethodId: number;

    // @Required()
    public Name: string;

    public FirstName?: string;
    public LastName?: string;
    public PhoneNumber?: 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 UpdatedDate: string;

    // @Required()
    public CreatedDate: string;

    // @Required()
    public CountryId: string;

    // @Required()
    public PaymentTermsDays: number;

    public VatRegistrationNumber?: string;
    public LicensePlanId: number;
    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<T>
{
    // @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<T>>) { (Object as any).assign(this, init); }
}

TypeScript CompanyBillingInformation DTOs

GET /billing/company HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
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
		}
	}
}