BusinessApi

<back to all web services

GetBillingRequest

Business
Requires Authentication
Required role:Business
The following routes are available for this service:
GET/business/get_billing
<?php namespace BusinessApi;

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};


class BillingEntity implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $name='',
        /** @var string */
        public string $organizationNumber='',
        /** @var string */
        public string $postalAddress='',
        /** @var string */
        public string $postalCode='',
        /** @var string */
        public string $city='',
        /** @var string */
        public string $countryCode=''
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['name'])) $this->name = $o['name'];
        if (isset($o['organizationNumber'])) $this->organizationNumber = $o['organizationNumber'];
        if (isset($o['postalAddress'])) $this->postalAddress = $o['postalAddress'];
        if (isset($o['postalCode'])) $this->postalCode = $o['postalCode'];
        if (isset($o['city'])) $this->city = $o['city'];
        if (isset($o['countryCode'])) $this->countryCode = $o['countryCode'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->name)) $o['name'] = $this->name;
        if (isset($this->organizationNumber)) $o['organizationNumber'] = $this->organizationNumber;
        if (isset($this->postalAddress)) $o['postalAddress'] = $this->postalAddress;
        if (isset($this->postalCode)) $o['postalCode'] = $this->postalCode;
        if (isset($this->city)) $o['city'] = $this->city;
        if (isset($this->countryCode)) $o['countryCode'] = $this->countryCode;
        return empty($o) ? new class(){} : $o;
    }
}

class BillingContact implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $person='',
        /** @var string|null */
        public ?string $phone=null,
        /** @var string|null */
        public ?string $email=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['person'])) $this->person = $o['person'];
        if (isset($o['phone'])) $this->phone = $o['phone'];
        if (isset($o['email'])) $this->email = $o['email'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->person)) $o['person'] = $this->person;
        if (isset($this->phone)) $o['phone'] = $this->phone;
        if (isset($this->email)) $o['email'] = $this->email;
        return empty($o) ? new class(){} : $o;
    }
}

PHP GetBillingRequest DTOs

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

HTTP + CSV

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

GET /business/get_billing HTTP/1.1 
Host: business-api.brovs.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"entity":{"name":"String","organizationNumber":"String","postalAddress":"String","postalCode":"String","city":"String","countryCode":"String"},"contactPerson":{"person":"String","phone":"String","email":"String"},"emailForBillingNotifications":"String","customReference":"String"}