BokaMera.API.Host

EaccountingInvoiceQuery

The following routes are available for this service:
GET	/eaccounting/invoices

**EaccountingInvoiceQuery** Parameters:
Name	Parameter	Data Type	Required
BookingId	query	int?	No
Paid	query	bool?	No
IncludeInvoiceLines	query	bool	No
IncludeInvoiceNotes	query	bool	No
IncludePaymentTermData	query	bool	No
IncludeInvoiceAddress	query	bool	No
CompanyId	query	Guid?	No

**QueryBase** Parameters:
Name	Parameter	Data Type	Required
Skip	form	int?	No
Take	form	int?	No
OrderBy	form	string	No
OrderByDesc	form	string	No
Include	form	string	No
Fields	form	string	No
Meta	form	Dictionary<string, string>	No

**InvoiceQueryResponse** Parameters:
Name	Parameter	Data Type	Required
InvoiceId	form	Guid	No
CreatedDate	form	DateTime	No
TotalAmount	form	decimal	No
TotalVatAmount	form	decimal	No
CustomerId	form	string	Yes
Rows	form	List<InvoiceLineQueryResponse>	Yes
VatSpecification	form	List<VatSpecificationQueryResponse>	Yes
InvoiceDate	form	string	Yes
DueDate	form	string	Yes
DeliveryDate	form	DateTime?	No
Persons	form	List<Person>	Yes
InvoiceCustomerName	form	string	Yes
InvoiceAddress	form	EAccountingInvoiceAddress	Yes
CustomerIsPrivatePerson	form	bool	No
TermsOfPaymentId	form	string	Yes
TermsOfPaymentData	form	EAccountingTermsOfPaymentQueryResponse	Yes
CustomerEmail	form	string	Yes
InvoiceNumber	form	int	No
CustomerNumber	form	string	Yes
Notes	form	List<NoteQueryResponse>	Yes
NoteIds	form	List<string>	Yes
CreatedUtc	form	DateTime	No
ModifiedUtc	form	DateTime	No
IncludesVat	form	bool	No
SendType	form	EAccountingInvoiceSendTypes?	No
IsSold	form	bool	No
PaymentDate	form	DateTime?	No
PaymentStatus	form	PaymentStatus	No
PaymentStatusTitle	form	string	Yes
CreditedBy	form	List<CreditedBy>	Yes
PriceSign	form	string	Yes
BookingId	form	string	Yes

**InvoiceLineQueryResponse** Parameters:
Name	Parameter	Data Type	Required
ArticleNumber	form	string	Yes
ArticleId	form	string	Yes
IsServiceArticle	form	bool	No
AmountNoVat	form	decimal	No
PercentVat	form	decimal?	No
LineNumber	form	int	No
IsTextRow	form	bool	No
Text	form	string	Yes
UnitPrice	form	decimal	No
UnitAbbreviation	form	string	Yes
UnitAbbreviationEnglish	form	string	Yes
DiscountPercentage	form	decimal	No
Quantity	form	float	No
IsWorkCost	form	bool	No
IsVatFree	form	bool	No
CostCenterItemId1	form	string	Yes
CostCenterItemId2	form	string	Yes
CostCenterItemId3	form	string	Yes
UnitId	form	string	Yes
ProjectId	form	string	Yes
WorkCostType	form	int?	No
WorkHours	form	float?	No
MaterialCosts	form	decimal?	No
GreenTechnologyType	form	GreenTechnologyType?	No
ContributionMargin	form	ContributionMargin	Yes

**GreenTechnologyType** Enum:
None
SolarCellInstallation
ElectricEnergyStorageInstallation
ElectricVehicleChargingPointInstallation

**ContributionMargin** Parameters:
Name	Parameter	Data Type	Required	Description
Amount	form	int?	No
Percentage	form	int?	No

**VatSpecificationQueryResponse** Parameters:
Name	Parameter	Data Type	Required
AmountInvoiceCurrency	form	decimal	No
VatAmountInvoiceCurrency	form	decimal	No
VatPercent	form	decimal	No

**Person** Parameters:
Name	Parameter	Data Type	Required	Description
Ssn	form	string	Yes
Amount	form	int	No

**EAccountingInvoiceAddress** Parameters:
Name	Parameter	Data Type	Required
CorporateIdentityNumber	form	string	Yes
InvoiceAddress1	form	string	Yes
InvoiceAddress2	form	string	Yes
InvoiceCity	form	string	Yes
InvoicePostalCode	form	string	Yes
InvoiceCountryCode	form	string	Yes

**EAccountingTermsOfPaymentQueryResponse** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	Yes
Name	form	string	Yes
NameEnglish	form	string	Yes
NumberOfDays	form	int	No
TermsOfPaymentTypeId	form	int	No
TermsOfPaymentTypeText	form	string	Yes
AvailableForSales	form	bool	No
AvailableForPurchase	form	bool	No

**NoteQueryResponse** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	Yes
Text	form	string	Yes
CreatedUtc	form	DateTime	No
ModifiedUtc	form	DateTime	No

**EAccountingInvoiceSendTypes** Enum:
None
AutoInvoiceElectronic
AutoInvoicePrint
AutoInvoiceB2C

**PaymentStatus** Enum:
Paid
Unpaid
Overdue

**CreditedBy** Parameters:
Name	Parameter	Data Type	Required	Description
CreditInvoiceId	form	string	Yes

**QueryResponse<T>** Parameters:
Name	Parameter	Data Type	Required
Offset	form	int	No
Total	form	int	No
Results	form	List<AccessKeyTypeResponse>	Yes
Meta	form	Dictionary<string, string>	No
ResponseStatus	form	ResponseStatus	No

**AccessKeyTypeResponse** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
KeyType	form	string	Yes
Description	form	string	Yes

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/invoices HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv

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

{
	Offset: 0,
	Total: 0,
	Results: 
	[
		{
			TotalAmount: 0,
			TotalVatAmount: 0,
			CustomerId: String,
			Rows: 
			[
				{
					ArticleNumber: String,
					ArticleId: String,
					IsServiceArticle: False,
					AmountNoVat: 0,
					PercentVat: 0,
					LineNumber: 0,
					IsTextRow: False,
					Text: String,
					UnitPrice: 0,
					UnitAbbreviation: String,
					UnitAbbreviationEnglish: String,
					DiscountPercentage: 0,
					Quantity: 0,
					IsWorkCost: False,
					IsVatFree: False,
					CostCenterItemId1: String,
					CostCenterItemId2: String,
					CostCenterItemId3: String,
					UnitId: String,
					ProjectId: String,
					WorkCostType: 0,
					WorkHours: 0,
					MaterialCosts: 0,
					GreenTechnologyType: None,
					ContributionMargin: 
					{
						Amount: 0,
						Percentage: 0
					}
				}
			],
			VatSpecification: 
			[
				{
					AmountInvoiceCurrency: 0,
					VatAmountInvoiceCurrency: 0,
					VatPercent: 0
				}
			],
			InvoiceDate: String,
			DueDate: String,
			DeliveryDate: "0001-01-01T00:00:00",
			Persons: 
			[
				{
					Ssn: String,
					Amount: 0
				}
			],
			InvoiceCustomerName: String,
			InvoiceAddress: 
			{
				CorporateIdentityNumber: String,
				InvoiceAddress1: String,
				InvoiceAddress2: String,
				InvoiceCity: String,
				InvoicePostalCode: String,
				InvoiceCountryCode: String
			},
			CustomerIsPrivatePerson: False,
			TermsOfPaymentId: String,
			TermsOfPaymentData: 
			{
				Id: String,
				Name: String,
				NameEnglish: String,
				NumberOfDays: 0,
				TermsOfPaymentTypeId: 0,
				TermsOfPaymentTypeText: String,
				AvailableForSales: False,
				AvailableForPurchase: False
			},
			CustomerEmail: String,
			InvoiceNumber: 0,
			CustomerNumber: String,
			Notes: 
			[
				{
					Id: String,
					Text: String
				}
			],
			NoteIds: 
			[
				String
			],
			IncludesVat: False,
			SendType: None,
			IsSold: False,
			PaymentDate: "0001-01-01T00:00:00",
			PaymentStatus: Paid,
			PaymentStatusTitle: String,
			CreditedBy: 
			[
				{
					CreditInvoiceId: String
				}
			],
			PriceSign: String,
			BookingId: String
		}
	],
	Meta: 
	{
		String: String
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}