BokaMera.API.Host

<back to all web services

EAccountingInvoiceDraftQuery

The following routes are available for this service:
GET/eaccounting/invoicedrafts
EAccountingInvoiceDraftQuery Parameters:
NameParameterData TypeRequiredDescription
BookingIdqueryint?No
IncludeInvoiceLinesqueryboolNo
IncludeInvoiceNotesqueryboolNo
CompanyIdqueryGuid?No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
InvoiceDraftQueryResponse Parameters:
NameParameterData TypeRequiredDescription
InvoiceIdformGuidNo
CreatedDateformDateTime?No
TotalAmountformdecimal?No
TotalVatAmountformdecimal?No
CustomerIdformstringYes
RowsformList<InvoiceDraftLineQueryResponse>Yes
InvoiceDateformstringYes
DueDateformstringYes
DeliveryDateformDateTime?No
PersonsformList<Person>Yes
InvoiceCustomerNameformstringYes
InvoiceAddressformEAccountingInvoiceAddressYes
CustomerIsPrivatePersonformboolNo
CustomerNumberformstringYes
NotesformList<NoteQueryResponse>Yes
NoteIdsformList<string>Yes
CreatedUtcformDateTimeNo
IncludesVatformboolNo
PriceSignformstringYes
BookingIdformstringNo
InvoiceDraftLineQueryResponse Parameters:
NameParameterData TypeRequiredDescription
ArticleNumberformstringYes
ArticleIdformstringYes
IsServiceArticleformbool?No
AmountNoVatformdecimalNo
PercentVatformdecimalNo
LineNumberformint?No
IsTextRowformboolNo
TextformstringYes
UnitPriceformdecimal?No
UnitAbbreviationformstringYes
UnitAbbreviationEnglishformstringYes
DiscountPercentageformdecimal?No
Quantityformdouble?No
IsWorkCostformboolNo
IsVatFreeformboolNo
CostCenterItemId1formstringYes
CostCenterItemId2formstringYes
CostCenterItemId3formstringYes
UnitIdformstringYes
ProjectIdformstringYes
WorkCostTypeformint?No
WorkHoursformdouble?No
MaterialCostsformdecimal?No
GreenTechnologyTypeformGreenTechnologyType?No
ContributionMarginformContributionMarginYes
GreenTechnologyType Enum:
None
SolarCellInstallation
ElectricEnergyStorageInstallation
ElectricVehicleChargingPointInstallation
ContributionMargin Parameters:
NameParameterData TypeRequiredDescription
Amountformint?No
Percentageformint?No
Person Parameters:
NameParameterData TypeRequiredDescription
SsnformstringYes
AmountformintNo
EAccountingInvoiceAddress Parameters:
NameParameterData TypeRequiredDescription
CorporateIdentityNumberformstringYes
InvoiceAddress1formstringYes
InvoiceAddress2formstringYes
InvoiceCityformstringYes
InvoicePostalCodeformstringYes
InvoiceCountryCodeformstringYes
NoteQueryResponse Parameters:
NameParameterData TypeRequiredDescription
IdformstringYes
TextformstringYes
CreatedUtcformDateTimeNo
ModifiedUtcformDateTimeNo
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<AccessKeyTypeResponse>Yes
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo
AccessKeyTypeResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
KeyTypeformstringYes
DescriptionformstringYes

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/invoicedrafts 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: 
	[
		{
			CreatedDate: "0001-01-01T00:00:00",
			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
					}
				}
			],
			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,
			CustomerNumber: String,
			Notes: 
			[
				{
					Id: String,
					Text: String
				}
			],
			NoteIds: 
			[
				String
			],
			IncludesVat: False,
			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
		}
	}
}