| POST | /eaccounting/summarizedinvoice | Create summarized invoices for customer bookings in a date range | Creates a single invoice per customer covering all their bookings in the specified date range. Processing is async via queue. |
|---|
<?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};
class SummarizedInvoiceJobResponse implements JsonSerializable
{
public function __construct(
/** @var string */
public string $SummarizedInvoiceId='',
/** @var string */
public string $CustomerId='',
/** @var string */
public string $CustomerName='',
/** @var int */
public int $BookingCount=0
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['SummarizedInvoiceId'])) $this->SummarizedInvoiceId = $o['SummarizedInvoiceId'];
if (isset($o['CustomerId'])) $this->CustomerId = $o['CustomerId'];
if (isset($o['CustomerName'])) $this->CustomerName = $o['CustomerName'];
if (isset($o['BookingCount'])) $this->BookingCount = $o['BookingCount'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->SummarizedInvoiceId)) $o['SummarizedInvoiceId'] = $this->SummarizedInvoiceId;
if (isset($this->CustomerId)) $o['CustomerId'] = $this->CustomerId;
if (isset($this->CustomerName)) $o['CustomerName'] = $this->CustomerName;
if (isset($this->BookingCount)) $o['BookingCount'] = $this->BookingCount;
return empty($o) ? new class(){} : $o;
}
}
class CreateSummarizedInvoiceResponse implements JsonSerializable
{
public function __construct(
/** @var int */
public int $TotalCustomersQueued=0,
/** @var array<SummarizedInvoiceJobResponse>|null */
public ?array $Jobs=null,
/** @var ResponseStatus|null */
public ?ResponseStatus $ResponseStatus=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['TotalCustomersQueued'])) $this->TotalCustomersQueued = $o['TotalCustomersQueued'];
if (isset($o['Jobs'])) $this->Jobs = JsonConverters::fromArray('SummarizedInvoiceJobResponse', $o['Jobs']);
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->TotalCustomersQueued)) $o['TotalCustomersQueued'] = $this->TotalCustomersQueued;
if (isset($this->Jobs)) $o['Jobs'] = JsonConverters::toArray('SummarizedInvoiceJobResponse', $this->Jobs);
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
return empty($o) ? new class(){} : $o;
}
}
enum EAccountingInvoiceSendTypes : string
{
case None = 'None';
case AutoInvoiceElectronic = 'AutoInvoiceElectronic';
case AutoInvoicePrint = 'AutoInvoicePrint';
case AutoInvoiceB2C = 'AutoInvoiceB2C';
}
// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
class CreateSummarizedInvoice implements ICompany, JsonSerializable
{
public function __construct(
/** @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 Start date for the booking range to include. */
// @ApiMember(Description="Start date for the booking range to include.", IsRequired=true)
/** @var DateTime */
public DateTime $DateFrom=new DateTime(),
/** @description End date for the booking range to include. */
// @ApiMember(Description="End date for the booking range to include.", IsRequired=true)
/** @var DateTime */
public DateTime $DateTo=new DateTime(),
/** @description Optional customer id. If null, creates one summarized invoice per customer with eligible bookings. */
// @ApiMember(Description="Optional customer id. If null, creates one summarized invoice per customer with eligible bookings.")
/** @var string|null */
public ?string $CustomerId=null,
/** @description Optional service/event id filter. Only include bookings for this service. */
// @ApiMember(Description="Optional service/event id filter. Only include bookings for this service.")
/** @var int|null */
public ?int $ServiceId=null,
/** @description Optional list of booking status ids to include. If empty, all statuses are included. */
// @ApiMember(Description="Optional list of booking status ids to include. If empty, all statuses are included.")
/** @var array<int>|null */
public ?array $BookingStatusIds=null,
/** @description The terms of payment id from EAccounting. */
// @ApiMember(Description="The terms of payment id from EAccounting.", IsRequired=true)
/** @var string */
public string $TermsOfPaymentId='',
/** @description Invoice creation type: 'Draft' or 'Invoice'. Defaults to company's EAccounting DefaultCreateType. */
// @ApiMember(Description="Invoice creation type: 'Draft' or 'Invoice'. Defaults to company's EAccounting DefaultCreateType.")
/** @var string|null */
public ?string $CreateType=null,
/** @description Send type for final invoices. 0 = None, 1 = AutoInvoiceElectronic, 2 = AutoInvoicePrint, 3 = AutoInvoiceB2C. */
// @ApiMember(Description="Send type for final invoices. 0 = None, 1 = AutoInvoiceElectronic, 2 = AutoInvoicePrint, 3 = AutoInvoiceB2C.")
/** @var EAccountingInvoiceSendTypes|null */
public ?EAccountingInvoiceSendTypes $SendType=null,
/** @description Override corporate identity number for invoice address. */
// @ApiMember(Description="Override corporate identity number for invoice address.")
/** @var string|null */
public ?string $CorporateIdentityNumber=null,
/** @description Override invoice address line 1. */
// @ApiMember(Description="Override invoice address line 1.")
/** @var string|null */
public ?string $InvoiceAddress1=null,
/** @description Override invoice address line 2. */
// @ApiMember(Description="Override invoice address line 2.")
/** @var string|null */
public ?string $InvoiceAddress2=null,
/** @description Override invoice city. */
// @ApiMember(Description="Override invoice city.")
/** @var string|null */
public ?string $InvoiceCity=null,
/** @description Override invoice postal code. */
// @ApiMember(Description="Override invoice postal code.")
/** @var string|null */
public ?string $InvoicePostalCode=null,
/** @description Override invoice country code. */
// @ApiMember(Description="Override invoice country code.")
/** @var string|null */
public ?string $InvoiceCountryCode=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['CompanyId'])) $this->CompanyId = $o['CompanyId'];
if (isset($o['DateFrom'])) $this->DateFrom = JsonConverters::from('DateTime', $o['DateFrom']);
if (isset($o['DateTo'])) $this->DateTo = JsonConverters::from('DateTime', $o['DateTo']);
if (isset($o['CustomerId'])) $this->CustomerId = $o['CustomerId'];
if (isset($o['ServiceId'])) $this->ServiceId = $o['ServiceId'];
if (isset($o['BookingStatusIds'])) $this->BookingStatusIds = JsonConverters::fromArray('int', $o['BookingStatusIds']);
if (isset($o['TermsOfPaymentId'])) $this->TermsOfPaymentId = $o['TermsOfPaymentId'];
if (isset($o['CreateType'])) $this->CreateType = $o['CreateType'];
if (isset($o['SendType'])) $this->SendType = JsonConverters::from('EAccountingInvoiceSendTypes', $o['SendType']);
if (isset($o['CorporateIdentityNumber'])) $this->CorporateIdentityNumber = $o['CorporateIdentityNumber'];
if (isset($o['InvoiceAddress1'])) $this->InvoiceAddress1 = $o['InvoiceAddress1'];
if (isset($o['InvoiceAddress2'])) $this->InvoiceAddress2 = $o['InvoiceAddress2'];
if (isset($o['InvoiceCity'])) $this->InvoiceCity = $o['InvoiceCity'];
if (isset($o['InvoicePostalCode'])) $this->InvoicePostalCode = $o['InvoicePostalCode'];
if (isset($o['InvoiceCountryCode'])) $this->InvoiceCountryCode = $o['InvoiceCountryCode'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->CompanyId)) $o['CompanyId'] = $this->CompanyId;
if (isset($this->DateFrom)) $o['DateFrom'] = JsonConverters::to('DateTime', $this->DateFrom);
if (isset($this->DateTo)) $o['DateTo'] = JsonConverters::to('DateTime', $this->DateTo);
if (isset($this->CustomerId)) $o['CustomerId'] = $this->CustomerId;
if (isset($this->ServiceId)) $o['ServiceId'] = $this->ServiceId;
if (isset($this->BookingStatusIds)) $o['BookingStatusIds'] = JsonConverters::toArray('int', $this->BookingStatusIds);
if (isset($this->TermsOfPaymentId)) $o['TermsOfPaymentId'] = $this->TermsOfPaymentId;
if (isset($this->CreateType)) $o['CreateType'] = $this->CreateType;
if (isset($this->SendType)) $o['SendType'] = JsonConverters::to('EAccountingInvoiceSendTypes', $this->SendType);
if (isset($this->CorporateIdentityNumber)) $o['CorporateIdentityNumber'] = $this->CorporateIdentityNumber;
if (isset($this->InvoiceAddress1)) $o['InvoiceAddress1'] = $this->InvoiceAddress1;
if (isset($this->InvoiceAddress2)) $o['InvoiceAddress2'] = $this->InvoiceAddress2;
if (isset($this->InvoiceCity)) $o['InvoiceCity'] = $this->InvoiceCity;
if (isset($this->InvoicePostalCode)) $o['InvoicePostalCode'] = $this->InvoicePostalCode;
if (isset($this->InvoiceCountryCode)) $o['InvoiceCountryCode'] = $this->InvoiceCountryCode;
return empty($o) ? new class(){} : $o;
}
}
PHP CreateSummarizedInvoice DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /eaccounting/summarizedinvoice HTTP/1.1
Host: api.bokamera.se
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<CreateSummarizedInvoice xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<BookingStatusIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>0</d2p1:int>
</BookingStatusIds>
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<CorporateIdentityNumber>String</CorporateIdentityNumber>
<CreateType>String</CreateType>
<CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
<DateFrom>0001-01-01T00:00:00</DateFrom>
<DateTo>0001-01-01T00:00:00</DateTo>
<InvoiceAddress1>String</InvoiceAddress1>
<InvoiceAddress2>String</InvoiceAddress2>
<InvoiceCity>String</InvoiceCity>
<InvoiceCountryCode>String</InvoiceCountryCode>
<InvoicePostalCode>String</InvoicePostalCode>
<SendType>None</SendType>
<ServiceId>0</ServiceId>
<TermsOfPaymentId>String</TermsOfPaymentId>
</CreateSummarizedInvoice>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<CreateSummarizedInvoiceResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<Jobs>
<SummarizedInvoiceJobResponse>
<BookingCount>0</BookingCount>
<CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
<CustomerName>String</CustomerName>
<SummarizedInvoiceId>00000000-0000-0000-0000-000000000000</SummarizedInvoiceId>
</SummarizedInvoiceJobResponse>
</Jobs>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1: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>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1: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>
</d2p1:Meta>
</ResponseStatus>
<TotalCustomersQueued>0</TotalCustomersQueued>
</CreateSummarizedInvoiceResponse>