BokaMera.API.Host

<back to all web services

GetSummarizedInvoice

Requires Authentication
The following routes are available for this service:
GET/eaccounting/summarizedinvoice/{Id}Get a single summarized invoice by idReturns the summarized invoice details including associated booking ids.
// @ts-nocheck

export class SummarizedInvoiceDetailResponse
{
    public Id: string;
    public CompanyId: string;
    public CustomerId: string;
    public CustomerName: string;
    public EAccountingInvoiceId?: string;
    public Draft: boolean;
    public DateFrom: string;
    public DateTo: string;
    public ServiceId?: number;
    public Status: number;
    public StatusName: string;
    public ErrorMessage?: string;
    public BookingIds: number[] = [];
    public CreatedDate: string;
    public UpdatedDate: string;

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

// @ValidateRequest(Validator="IsAuthenticated")
export class GetSummarizedInvoice implements ICompany
{
    /** @description The summarized invoice id. */
    // @ApiMember(Description="The summarized invoice id.", IsRequired=true)
    public Id: string;

    /** @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;

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

TypeScript GetSummarizedInvoice 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.

GET /eaccounting/summarizedinvoice/{Id} HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SummarizedInvoiceDetailResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <BookingIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </BookingIds>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <CreatedDate>0001-01-01T00:00:00</CreatedDate>
  <CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
  <CustomerName>String</CustomerName>
  <DateFrom>0001-01-01T00:00:00</DateFrom>
  <DateTo>0001-01-01T00:00:00</DateTo>
  <Draft>false</Draft>
  <EAccountingInvoiceId>String</EAccountingInvoiceId>
  <ErrorMessage>String</ErrorMessage>
  <Id>00000000-0000-0000-0000-000000000000</Id>
  <ServiceId>0</ServiceId>
  <Status>0</Status>
  <StatusName>String</StatusName>
  <UpdatedDate>0001-01-01T00:00:00</UpdatedDate>
</SummarizedInvoiceDetailResponse>