| Requires any of the roles: | bookingsupplier-administrator-write, bookingsupplier-administrator-read, superadmin |
| GET | /billing/company | Get billing details for the company. | Get billing details for the company. |
|---|
<?php namespace dtos;
use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};
// @DataContract
class QueryBase implements JsonSerializable
{
public function __construct(
/** @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)
/** @var int|null */
public ?int $Skip=null,
/** @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)
/** @var int|null */
public ?int $Take=null,
/** @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)
/** @var string|null */
public ?string $OrderBy=null,
/** @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)
/** @var string|null */
public ?string $OrderByDesc=null,
/** @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)
/** @var string|null */
public ?string $Include=null,
// @DataMember(Order=6)
/** @var string|null */
public ?string $Fields=null,
// @DataMember(Order=7)
/** @var array<string,string>|null */
public ?array $Meta=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Skip'])) $this->Skip = $o['Skip'];
if (isset($o['Take'])) $this->Take = $o['Take'];
if (isset($o['OrderBy'])) $this->OrderBy = $o['OrderBy'];
if (isset($o['OrderByDesc'])) $this->OrderByDesc = $o['OrderByDesc'];
if (isset($o['Include'])) $this->Include = $o['Include'];
if (isset($o['Fields'])) $this->Fields = $o['Fields'];
if (isset($o['Meta'])) $this->Meta = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','string']), $o['Meta']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Skip)) $o['Skip'] = $this->Skip;
if (isset($this->Take)) $o['Take'] = $this->Take;
if (isset($this->OrderBy)) $o['OrderBy'] = $this->OrderBy;
if (isset($this->OrderByDesc)) $o['OrderByDesc'] = $this->OrderByDesc;
if (isset($this->Include)) $o['Include'] = $this->Include;
if (isset($this->Fields)) $o['Fields'] = $this->Fields;
if (isset($this->Meta)) $o['Meta'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','string']), $this->Meta);
return empty($o) ? new class(){} : $o;
}
}
/**
* @template From
* @template Into
*/
class QueryDb2 extends QueryBase implements JsonSerializable
{
public array $genericArgs = [];
public static function create(array $genericArgs=[]): QueryDb2 {
$to = new QueryDb2();
$to->genericArgs = $genericArgs;
return $to;
}
/**
* @param int|null $Skip
* @param int|null $Take
* @param string|null $OrderBy
* @param string|null $OrderByDesc
* @param string|null $Include
* @param string|null $Fields
* @param array<string,string>|null $Meta
*/
public function __construct(
mixed $Skip=null,
mixed $Take=null,
mixed $OrderBy=null,
mixed $OrderByDesc=null,
mixed $Include=null,
mixed $Fields=null,
mixed $Meta=null
) {
parent::__construct($Skip,$Take,$OrderBy,$OrderByDesc,$Include,$Fields,$Meta);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
return empty($o) ? new class(){} : $o;
}
}
class BillingMethodQueryResponse implements JsonSerializable
{
public function __construct(
/** @description The billing method id */
// @ApiMember(Description="The billing method id")
/** @var int */
public int $Id=0,
/** @description The billing method name */
// @ApiMember(Description="The billing method name")
/** @var string|null */
public ?string $Name=null,
/** @description The billing method description */
// @ApiMember(Description="The billing method description")
/** @var string|null */
public ?string $Description=null,
/** @description The billing method is valid for the following countries */
// @ApiMember(Description="The billing method is valid for the following countries")
/** @var array<string>|null */
public ?array $Countries=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Id'])) $this->Id = $o['Id'];
if (isset($o['Name'])) $this->Name = $o['Name'];
if (isset($o['Description'])) $this->Description = $o['Description'];
if (isset($o['Countries'])) $this->Countries = JsonConverters::fromArray('string', $o['Countries']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Id)) $o['Id'] = $this->Id;
if (isset($this->Name)) $o['Name'] = $this->Name;
if (isset($this->Description)) $o['Description'] = $this->Description;
if (isset($this->Countries)) $o['Countries'] = JsonConverters::toArray('string', $this->Countries);
return empty($o) ? new class(){} : $o;
}
}
class BaseModel implements JsonSerializable
{
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
return empty($o) ? new class(){} : $o;
}
}
class BillingMethodCountriesRelation extends BaseModel implements JsonSerializable
{
public function __construct(
// @Required()
/** @var int */
public int $BillingMethodId=0,
// @Required()
/** @var string */
public string $CountryId='',
/** @var DateTime|null */
public ?DateTime $ModifiedDate=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['BillingMethodId'])) $this->BillingMethodId = $o['BillingMethodId'];
if (isset($o['CountryId'])) $this->CountryId = $o['CountryId'];
if (isset($o['ModifiedDate'])) $this->ModifiedDate = JsonConverters::from('DateTimeOffset', $o['ModifiedDate']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->BillingMethodId)) $o['BillingMethodId'] = $this->BillingMethodId;
if (isset($this->CountryId)) $o['CountryId'] = $this->CountryId;
if (isset($this->ModifiedDate)) $o['ModifiedDate'] = JsonConverters::to('DateTimeOffset', $this->ModifiedDate);
return empty($o) ? new class(){} : $o;
}
}
class BillingMethod extends BaseModel implements JsonSerializable
{
public function __construct(
/** @var array<BillingMethodCountriesRelation>|null */
public ?array $BillingMethodCountriesRelation=null,
// @Required()
/** @var string */
public string $Name='',
// @Required()
/** @var string */
public string $Description='',
/** @var DateTime|null */
public ?DateTime $ModifiedDate=null,
/** @var int */
public int $Id=0
) {
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['BillingMethodCountriesRelation'])) $this->BillingMethodCountriesRelation = JsonConverters::fromArray('BillingMethodCountriesRelation', $o['BillingMethodCountriesRelation']);
if (isset($o['Name'])) $this->Name = $o['Name'];
if (isset($o['Description'])) $this->Description = $o['Description'];
if (isset($o['ModifiedDate'])) $this->ModifiedDate = JsonConverters::from('DateTimeOffset', $o['ModifiedDate']);
if (isset($o['Id'])) $this->Id = $o['Id'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->BillingMethodCountriesRelation)) $o['BillingMethodCountriesRelation'] = JsonConverters::toArray('BillingMethodCountriesRelation', $this->BillingMethodCountriesRelation);
if (isset($this->Name)) $o['Name'] = $this->Name;
if (isset($this->Description)) $o['Description'] = $this->Description;
if (isset($this->ModifiedDate)) $o['ModifiedDate'] = JsonConverters::to('DateTimeOffset', $this->ModifiedDate);
if (isset($this->Id)) $o['Id'] = $this->Id;
return empty($o) ? new class(){} : $o;
}
}
class BillingInformation extends BaseModel implements JsonSerializable
{
public function __construct(
/** @var BillingMethod|null */
public ?BillingMethod $BillingMethod=null,
// @Required()
/** @var int */
public int $BillingMethodId=0,
// @Required()
/** @var string */
public string $Name='',
/** @var string|null */
public ?string $Attention=null,
/** @var string|null */
public ?string $Street1=null,
/** @var string|null */
public ?string $Street2=null,
/** @var string|null */
public ?string $ZipCode=null,
/** @var string|null */
public ?string $City=null,
/** @var string|null */
public ?string $Email=null,
/** @var string|null */
public ?string $CreditCard=null,
/** @var string|null */
public ?string $CreditCardHolder=null,
/** @var string|null */
public ?string $CreditCardNumber=null,
/** @var int|null */
public ?int $ValidToYear=null,
/** @var int|null */
public ?int $ValidToMonth=null,
/** @var string|null */
public ?string $CSV=null,
// @Required()
/** @var DateTime */
public DateTime $Updated=new DateTime(),
// @Required()
/** @var DateTime */
public DateTime $Created=new DateTime(),
// @Required()
/** @var string */
public string $CountryId='',
// @Required()
/** @var int */
public int $PaymentTermsDays=0,
/** @var string|null */
public ?string $VATRegistrationNumber=null,
/** @var string|null */
public ?string $GLN=null,
/** @var string|null */
public ?string $ReferenceLine1=null,
/** @var string|null */
public ?string $ReferenceLine2=null,
/** @var DateTime|null */
public ?DateTime $ModifiedDate=null,
// @Required()
/** @var string */
public string $Id=''
) {
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['BillingMethod'])) $this->BillingMethod = JsonConverters::from('BillingMethod', $o['BillingMethod']);
if (isset($o['BillingMethodId'])) $this->BillingMethodId = $o['BillingMethodId'];
if (isset($o['Name'])) $this->Name = $o['Name'];
if (isset($o['Attention'])) $this->Attention = $o['Attention'];
if (isset($o['Street1'])) $this->Street1 = $o['Street1'];
if (isset($o['Street2'])) $this->Street2 = $o['Street2'];
if (isset($o['ZipCode'])) $this->ZipCode = $o['ZipCode'];
if (isset($o['City'])) $this->City = $o['City'];
if (isset($o['Email'])) $this->Email = $o['Email'];
if (isset($o['CreditCard'])) $this->CreditCard = $o['CreditCard'];
if (isset($o['CreditCardHolder'])) $this->CreditCardHolder = $o['CreditCardHolder'];
if (isset($o['CreditCardNumber'])) $this->CreditCardNumber = $o['CreditCardNumber'];
if (isset($o['ValidToYear'])) $this->ValidToYear = $o['ValidToYear'];
if (isset($o['ValidToMonth'])) $this->ValidToMonth = $o['ValidToMonth'];
if (isset($o['CSV'])) $this->CSV = $o['CSV'];
if (isset($o['Updated'])) $this->Updated = JsonConverters::from('DateTime', $o['Updated']);
if (isset($o['Created'])) $this->Created = JsonConverters::from('DateTime', $o['Created']);
if (isset($o['CountryId'])) $this->CountryId = $o['CountryId'];
if (isset($o['PaymentTermsDays'])) $this->PaymentTermsDays = $o['PaymentTermsDays'];
if (isset($o['VATRegistrationNumber'])) $this->VATRegistrationNumber = $o['VATRegistrationNumber'];
if (isset($o['GLN'])) $this->GLN = $o['GLN'];
if (isset($o['ReferenceLine1'])) $this->ReferenceLine1 = $o['ReferenceLine1'];
if (isset($o['ReferenceLine2'])) $this->ReferenceLine2 = $o['ReferenceLine2'];
if (isset($o['ModifiedDate'])) $this->ModifiedDate = JsonConverters::from('DateTimeOffset', $o['ModifiedDate']);
if (isset($o['Id'])) $this->Id = $o['Id'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->BillingMethod)) $o['BillingMethod'] = JsonConverters::to('BillingMethod', $this->BillingMethod);
if (isset($this->BillingMethodId)) $o['BillingMethodId'] = $this->BillingMethodId;
if (isset($this->Name)) $o['Name'] = $this->Name;
if (isset($this->Attention)) $o['Attention'] = $this->Attention;
if (isset($this->Street1)) $o['Street1'] = $this->Street1;
if (isset($this->Street2)) $o['Street2'] = $this->Street2;
if (isset($this->ZipCode)) $o['ZipCode'] = $this->ZipCode;
if (isset($this->City)) $o['City'] = $this->City;
if (isset($this->Email)) $o['Email'] = $this->Email;
if (isset($this->CreditCard)) $o['CreditCard'] = $this->CreditCard;
if (isset($this->CreditCardHolder)) $o['CreditCardHolder'] = $this->CreditCardHolder;
if (isset($this->CreditCardNumber)) $o['CreditCardNumber'] = $this->CreditCardNumber;
if (isset($this->ValidToYear)) $o['ValidToYear'] = $this->ValidToYear;
if (isset($this->ValidToMonth)) $o['ValidToMonth'] = $this->ValidToMonth;
if (isset($this->CSV)) $o['CSV'] = $this->CSV;
if (isset($this->Updated)) $o['Updated'] = JsonConverters::to('DateTime', $this->Updated);
if (isset($this->Created)) $o['Created'] = JsonConverters::to('DateTime', $this->Created);
if (isset($this->CountryId)) $o['CountryId'] = $this->CountryId;
if (isset($this->PaymentTermsDays)) $o['PaymentTermsDays'] = $this->PaymentTermsDays;
if (isset($this->VATRegistrationNumber)) $o['VATRegistrationNumber'] = $this->VATRegistrationNumber;
if (isset($this->GLN)) $o['GLN'] = $this->GLN;
if (isset($this->ReferenceLine1)) $o['ReferenceLine1'] = $this->ReferenceLine1;
if (isset($this->ReferenceLine2)) $o['ReferenceLine2'] = $this->ReferenceLine2;
if (isset($this->ModifiedDate)) $o['ModifiedDate'] = JsonConverters::to('DateTimeOffset', $this->ModifiedDate);
if (isset($this->Id)) $o['Id'] = $this->Id;
return empty($o) ? new class(){} : $o;
}
}
// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
/**
* @template QueryDb2 of BillingInformation
* @template QueryDb21 of BillingMethodQueryResponse
*/
class CompanyBillingInformation extends QueryDb2 implements JsonSerializable
{
/**
* @param int|null $Skip
* @param int|null $Take
* @param string|null $OrderBy
* @param string|null $OrderByDesc
* @param string|null $Include
* @param string|null $Fields
* @param array<string,string>|null $Meta
*/
public function __construct(
?int $Skip=null,
?int $Take=null,
?string $OrderBy=null,
?string $OrderByDesc=null,
?string $Include=null,
?string $Fields=null,
?array $Meta=null,
/** @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.")
/** @var string|null */
public ?string $CompanyId=null,
/** @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")
/** @var bool|null */
public ?bool $IncludeBillingMethodOptions=null
) {
parent::__construct($Skip,$Take,$OrderBy,$OrderByDesc,$Include,$Fields,$Meta);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['CompanyId'])) $this->CompanyId = $o['CompanyId'];
if (isset($o['IncludeBillingMethodOptions'])) $this->IncludeBillingMethodOptions = $o['IncludeBillingMethodOptions'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->CompanyId)) $o['CompanyId'] = $this->CompanyId;
if (isset($this->IncludeBillingMethodOptions)) $o['IncludeBillingMethodOptions'] = $this->IncludeBillingMethodOptions;
return empty($o) ? new class(){} : $o;
}
}
class AccessKeyTypeResponse implements JsonSerializable
{
public function __construct(
/** @var int */
public int $Id=0,
/** @var string|null */
public ?string $KeyType=null,
/** @var string|null */
public ?string $Description=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Id'])) $this->Id = $o['Id'];
if (isset($o['KeyType'])) $this->KeyType = $o['KeyType'];
if (isset($o['Description'])) $this->Description = $o['Description'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Id)) $o['Id'] = $this->Id;
if (isset($this->KeyType)) $o['KeyType'] = $this->KeyType;
if (isset($this->Description)) $o['Description'] = $this->Description;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
/**
* @template AccessKeyTypeResponse
*/
class QueryResponse implements JsonSerializable
{
public array $genericArgs = [];
public static function create(array $genericArgs=[]): QueryResponse {
$to = new QueryResponse();
$to->genericArgs = $genericArgs;
return $to;
}
public function __construct(
// @DataMember(Order=1)
/** @var int */
public mixed $Offset=0,
// @DataMember(Order=2)
/** @var int */
public mixed $Total=0,
// @DataMember(Order=3)
/** @var array<AccessKeyTypeResponse>|null */
public mixed $Results=null,
// @DataMember(Order=4)
/** @var array<string,string>|null */
public mixed $Meta=null,
// @DataMember(Order=5)
/** @var ResponseStatus|null */
public mixed $ResponseStatus=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Offset'])) $this->Offset = $o['Offset'];
if (isset($o['Total'])) $this->Total = $o['Total'];
if (isset($o['Results'])) $this->Results = JsonConverters::fromArray($this->genericArgs[0], $o['Results']);
if (isset($o['Meta'])) $this->Meta = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','string']), $o['Meta']);
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Offset)) $o['Offset'] = $this->Offset;
if (isset($this->Total)) $o['Total'] = $this->Total;
if (isset($this->Results)) $o['Results'] = JsonConverters::toArray($this->genericArgs[0], $this->Results);
if (isset($this->Meta)) $o['Meta'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','string']), $this->Meta);
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
return empty($o) ? new class(){} : $o;
}
}
PHP CompanyBillingInformation DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: 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
}
}
}