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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Results: 
	[
		{
			CustomerName: String,
			EAccountingInvoiceId: String,
			Draft: False,
			ServiceId: 0,
			Status: 0,
			StatusName: String,
			ErrorMessage: String,
			BookingIds: 
			[
				0
			]
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}