BokaMera.API.Host

<back to all web services

QuerySummarizedInvoices

Requires Authentication
The following routes are available for this service:
GET/eaccounting/summarizedinvoicesList summarized invoices with optional filtersQuery summarized invoices by company, customer, date range, and status.
"use strict";
export class SummarizedInvoiceDetailResponse {
    /** @param {{Id?:string,CompanyId?:string,CustomerId?:string,CustomerName?:string,EAccountingInvoiceId?:string,Draft?:boolean,DateFrom?:string,DateTo?:string,ServiceId?:number,Status?:number,StatusName?:string,ErrorMessage?:string,BookingIds?:number[],CreatedDate?:string,UpdatedDate?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Id;
    /** @type {string} */
    CompanyId;
    /** @type {string} */
    CustomerId;
    /** @type {string} */
    CustomerName;
    /** @type {?string} */
    EAccountingInvoiceId;
    /** @type {boolean} */
    Draft;
    /** @type {string} */
    DateFrom;
    /** @type {string} */
    DateTo;
    /** @type {?number} */
    ServiceId;
    /** @type {number} */
    Status;
    /** @type {string} */
    StatusName;
    /** @type {?string} */
    ErrorMessage;
    /** @type {number[]} */
    BookingIds = [];
    /** @type {string} */
    CreatedDate;
    /** @type {string} */
    UpdatedDate;
}
export class QuerySummarizedInvoicesResponse {
    /** @param {{Results?:SummarizedInvoiceDetailResponse[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {SummarizedInvoiceDetailResponse[]} */
    Results = [];
    /** @type {ResponseStatus} */
    ResponseStatus;
}
/** @typedef {'Pending'|'Processing'|'Completed'|'Failed'} */
export var SummarizedInvoiceStatus;
(function (SummarizedInvoiceStatus) {
    SummarizedInvoiceStatus["Pending"] = "Pending"
    SummarizedInvoiceStatus["Processing"] = "Processing"
    SummarizedInvoiceStatus["Completed"] = "Completed"
    SummarizedInvoiceStatus["Failed"] = "Failed"
})(SummarizedInvoiceStatus || (SummarizedInvoiceStatus = {}));
export class QuerySummarizedInvoices {
    /** @param {{CompanyId?:string,CustomerId?:string,DateFrom?:string,DateTo?:string,Status?:SummarizedInvoiceStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {?string}
     * @description The company id, if empty will use the company id for the user you are logged in with. */
    CompanyId;
    /**
     * @type {?string}
     * @description Filter by customer id. */
    CustomerId;
    /**
     * @type {?string}
     * @description Filter by date from. */
    DateFrom;
    /**
     * @type {?string}
     * @description Filter by date to. */
    DateTo;
    /**
     * @type {?SummarizedInvoiceStatus}
     * @description Filter by status (0=Pending, 1=Processing, 2=Completed, 3=Failed). */
    Status;
}

JavaScript QuerySummarizedInvoices 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/summarizedinvoices HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QuerySummarizedInvoicesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <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>
  <Results>
    <SummarizedInvoiceDetailResponse>
      <BookingIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>0</d4p1: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>
  </Results>
</QuerySummarizedInvoicesResponse>