BokaMera.API.Host

<back to all web services

CreateVossInvoice

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/voss/invoiceinit voss invoice

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
export class CreateVossInvoice
{
    /** @description Company ids to create invoice. If none added invoice for all will be created */
    // @ApiMember(Description="Company ids to create invoice. If none added invoice for all will be created")
    public CompanyIds: string[] = [];

    /** @description Controls up to which point of time transactions are included in invoice, can be set to any date, if not provided current UTC time will be used instead */
    // @ApiMember(Description="Controls up to which point of time transactions are included in invoice, can be set to any date, if not provided current UTC time will be used instead")
    public InvoiceDate?: string;

    /** @description If present the operation will start only after this date */
    // @ApiMember(Description="If present the operation will start only after this date")
    public ScheduledStartTime?: string;

    /** @description Optional CRON expression for recurring operations. */
    // @ApiMember(Description="Optional CRON expression for recurring operations.")
    public RecurringSchedule: string;

    /** @description Only usage. */
    // @ApiMember(Description="Only usage.")
    public OnlyUsage: boolean;

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

TypeScript CreateVossInvoice DTOs

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

HTTP + XML

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

POST /voss/invoice HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateVossInvoice xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <CompanyIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
  </CompanyIds>
  <InvoiceDate>0001-01-01T00:00:00</InvoiceDate>
  <OnlyUsage>false</OnlyUsage>
  <RecurringSchedule>String</RecurringSchedule>
  <ScheduledStartTime>0001-01-01T00:00:00</ScheduledStartTime>
</CreateVossInvoice>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<z:anyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />