BokaMera.API.Host

<back to all web services

EAccountingCustomerQuery

The following routes are available for this service:
GET/eaccounting/customers
// @ts-nocheck

// @DataContract
export class QueryBase
{
    // @DataMember(Order=1)
    public Skip?: number;

    // @DataMember(Order=2)
    public Take?: number;

    // @DataMember(Order=3)
    public OrderBy?: string;

    // @DataMember(Order=4)
    public OrderByDesc?: string;

    // @DataMember(Order=5)
    public Include?: string;

    // @DataMember(Order=6)
    public Fields?: string;

    // @DataMember(Order=7)
    public Meta?: { [index:string]: string; };

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

export class QueryData<T> extends QueryBase
{

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

export class EAccountingInvoiceAddress
{
    public CorporateIdentityNumber: string;
    public InvoiceAddress1: string;
    public InvoiceAddress2: string;
    public InvoiceCity: string;
    public InvoicePostalCode: string;
    public InvoiceCountryCode: string;

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

export class EAccountingTermsOfPaymentQueryResponse
{
    public Id: string;
    public Name: string;
    public NameEnglish: string;
    public NumberOfDays: number;
    public TermsOfPaymentTypeId: number;
    public TermsOfPaymentTypeText: string;
    public AvailableForSales: boolean;
    public AvailableForPurchase: boolean;

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

export class CustomerLabelQueryResponse
{
    public Id: string;
    public Name: string;
    public Description: string;

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

export class DirectDebitCustomerSettingsQueryResponse
{
    public MandateId: string;
    public MandateType: number;
    public SequenceType: number;
    public SigningDate: string;
    public EndDate: string;
    public LatestDirectDebit: string;

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

export class EAccountingCustomerQueryResponse
{
    public Id: string;
    public CustomerNumber: string;
    public CorporateIdentityNumber: string;
    public ContactPersonEmail: string;
    public ContactPersonMobile: string;
    public ContactPersonName: string;
    public ContactPersonPhone: string;
    public CurrencyCode: string;
    public GLN: string;
    public InvoiceCity: string;
    public InvoicePostalCode: string;
    public EmailAddress: string;
    public EmailAddressOrder: string;
    public EmailAddressQuote: string;
    public InvoiceAddress: EAccountingInvoiceAddress;
    public DeliveryCustomerName: string;
    public DeliveryAddress1: string;
    public DeliveryAddress2: string;
    public DeliveryCity: string;
    public DeliveryCountryCode: string;
    public DeliveryPostalCode: string;
    public DeliveryMethodId: string;
    public DeliveryTermId: string;
    public PayToAccountId: string;
    public Name: string;
    public Note: string;
    public ReverseChargeOnConstructionServices: boolean;
    public WebshopCustomerNumber?: number;
    public MobilePhone: string;
    public Telephone: string;
    public TermsOfPaymentId: string;
    public EAccountingTermsOfPayment: EAccountingTermsOfPaymentQueryResponse;
    public VatNumber: string;
    public WwwAddress: string;
    public LastInvoiceDate: string;
    public IsPrivatePerson: boolean;
    public IsNorthernIreland: boolean;
    public DiscountPercentage?: number;
    public ChangedUtc?: string;
    public IsActive: boolean;
    public ForceBookkeepVat: boolean;
    public EdiGlnNumber: string;
    public SalesDocumentLanguage: string;
    public ElectronicAddress: string;
    public ElectronicReference: string;
    public EdiServiceDelivererId: string;
    public AutoInvoiceActivationEmailSentDate?: string;
    public AutoInvoiceRegistrationRequestSentDate?: string;
    public EmailAddresses: string[] = [];
    public CustomerLabels: CustomerLabelQueryResponse[] = [];
    public MessageThreads: string[] = [];
    public Notes: string[] = [];
    public IsFutureInvoiceDateAllowed: boolean;
    public DeliveryBasedVat: boolean;
    public SalesPriceListId: string;
    public Iban: string;
    public DirectDebitCustomerSettings: DirectDebitCustomerSettingsQueryResponse;
    public DiscountAgreementId: string;
    public UnpaidInvoicesAmount: number;

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

export class EAccountingCustomerQuery extends QueryData<EAccountingCustomerQueryResponse> implements ICompany
{
    public CompanyId?: string;

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

export class AccessKeyTypeResponse
{
    public Id: number;
    public KeyType: string;
    public Description: string;

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

// @DataContract
export class QueryResponse<T>
{
    // @DataMember(Order=1)
    public Offset: number;

    // @DataMember(Order=2)
    public Total: number;

    // @DataMember(Order=3)
    public Results: AccessKeyTypeResponse[] = [];

    // @DataMember(Order=4)
    public Meta?: { [index:string]: string; };

    // @DataMember(Order=5)
    public ResponseStatus?: ResponseStatus;

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

TypeScript EAccountingCustomerQuery 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/customers 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: 
	[
		{
			Id: String,
			CustomerNumber: String,
			CorporateIdentityNumber: String,
			ContactPersonEmail: String,
			ContactPersonMobile: String,
			ContactPersonName: String,
			ContactPersonPhone: String,
			CurrencyCode: String,
			GLN: String,
			InvoiceCity: String,
			InvoicePostalCode: String,
			EmailAddress: String,
			EmailAddressOrder: String,
			EmailAddressQuote: String,
			InvoiceAddress: 
			{
				CorporateIdentityNumber: String,
				InvoiceAddress1: String,
				InvoiceAddress2: String,
				InvoiceCity: String,
				InvoicePostalCode: String,
				InvoiceCountryCode: String
			},
			DeliveryCustomerName: String,
			DeliveryAddress1: String,
			DeliveryAddress2: String,
			DeliveryCity: String,
			DeliveryCountryCode: String,
			DeliveryPostalCode: String,
			DeliveryMethodId: String,
			DeliveryTermId: String,
			PayToAccountId: String,
			Name: String,
			Note: String,
			ReverseChargeOnConstructionServices: False,
			WebshopCustomerNumber: 0,
			MobilePhone: String,
			Telephone: String,
			TermsOfPaymentId: String,
			EAccountingTermsOfPayment: 
			{
				Id: String,
				Name: String,
				NameEnglish: String,
				NumberOfDays: 0,
				TermsOfPaymentTypeId: 0,
				TermsOfPaymentTypeText: String,
				AvailableForSales: False,
				AvailableForPurchase: False
			},
			VatNumber: String,
			WwwAddress: String,
			LastInvoiceDate: String,
			IsPrivatePerson: False,
			IsNorthernIreland: False,
			DiscountPercentage: 0,
			ChangedUtc: "0001-01-01T00:00:00",
			IsActive: False,
			ForceBookkeepVat: False,
			EdiGlnNumber: String,
			SalesDocumentLanguage: String,
			ElectronicAddress: String,
			ElectronicReference: String,
			EdiServiceDelivererId: String,
			AutoInvoiceActivationEmailSentDate: "0001-01-01T00:00:00",
			AutoInvoiceRegistrationRequestSentDate: "0001-01-01T00:00:00",
			EmailAddresses: 
			[
				String
			],
			CustomerLabels: 
			[
				{
					Id: String,
					Name: String,
					Description: String
				}
			],
			MessageThreads: 
			[
				String
			],
			Notes: 
			[
				String
			],
			IsFutureInvoiceDateAllowed: False,
			DeliveryBasedVat: False,
			SalesPriceListId: String,
			Iban: String,
			DirectDebitCustomerSettings: 
			{
				MandateId: String,
				MandateType: 0,
				SequenceType: 0
			},
			DiscountAgreementId: String,
			UnpaidInvoicesAmount: 0
		}
	],
	Meta: 
	{
		String: String
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}