BokaMera.API.Host

<back to all web services

UpdateVossInvoiceConfigurations

Requires Authentication
Requires the role:superadmin
The following routes are available for this service:
GET/voss/invoiceConfigurationsinit voss invoice
"use strict";
/** @typedef {'None'|'IncludeIn21StColumn'|'IncludeIn7ThColumn'} */
export var IntermediaryPlacementEnum;
(function (IntermediaryPlacementEnum) {
    IntermediaryPlacementEnum["None"] = "None"
    IntermediaryPlacementEnum["IncludeIn21StColumn"] = "IncludeIn21StColumn"
    IntermediaryPlacementEnum["IncludeIn7ThColumn"] = "IncludeIn7ThColumn"
})(IntermediaryPlacementEnum || (IntermediaryPlacementEnum = {}));
/** @typedef {'Default'|'Dutch'} */
export var AccrualCodeFormatEnum;
(function (AccrualCodeFormatEnum) {
    AccrualCodeFormatEnum["Default"] = "Default"
    AccrualCodeFormatEnum["Dutch"] = "Dutch"
})(AccrualCodeFormatEnum || (AccrualCodeFormatEnum = {}));
/** @typedef {'Day'|'Month'|'Year'} */
export var UnitEnum;
(function (UnitEnum) {
    UnitEnum["Day"] = "Day"
    UnitEnum["Month"] = "Month"
    UnitEnum["Year"] = "Year"
})(UnitEnum || (UnitEnum = {}));
export class TimeLengthRequestDto {
    /** @param {{unit?:UnitEnum,value?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {UnitEnum} */
    unit;
    /** @type {number} */
    value;
}
export class UpdateInvoiceConfigurationsRequest {
    /** @param {{intermediaryPlacement?:IntermediaryPlacementEnum,accrualCodeFormat?:AccrualCodeFormatEnum,dateFormat?:string,delimiter?:string,decimalSeparator?:string,orderCreatorCode?:string,salesPersonId?:string,salesDepartmentId?:string,includeBillingPeriodDates?:boolean,trackInvoicePayments?:boolean,includeInvoicedCustomerDetails?:boolean,billingPeriodTextFormat?:string,customerFooterText?:string,addEmptyLineBeforeCustomerFooter?:boolean,includeOnlyDefaultSalesPersonAndDepartment?:boolean,includeSubscriptionCustomerDetailsIfPayedByAnotherCustomer?:boolean,transactionGroup?:string,invoiceArbitraryNumber?:string,deliveryMethod?:string,deliveryConditions?:string,orderType?:string,invoiceStatus?:string,useProductGroupRevenueRecognition?:boolean,productGroupLineExcludePrint?:string,productGroupLineEditPreferences?:string,productLineExcludePrint?:string,useDiscountedPrices?:boolean,terminateUnpaidSubscriptions?:boolean,allowedUnpaidAmountLimit?:number,allowedPaymentOverdue?:TimeLengthRequestDto,unpaidSubscriptionTerminationReasonId?:string,unpaidSubscriptionTerminationComment?:string,creditInvoiceNumberReferenceTextFormat?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {IntermediaryPlacementEnum} */
    intermediaryPlacement;
    /** @type {AccrualCodeFormatEnum} */
    accrualCodeFormat;
    /** @type {string} */
    dateFormat;
    /** @type {string} */
    delimiter;
    /** @type {string} */
    decimalSeparator;
    /** @type {string} */
    orderCreatorCode;
    /** @type {string} */
    salesPersonId;
    /** @type {string} */
    salesDepartmentId;
    /** @type {boolean} */
    includeBillingPeriodDates;
    /** @type {boolean} */
    trackInvoicePayments;
    /** @type {boolean} */
    includeInvoicedCustomerDetails;
    /** @type {string} */
    billingPeriodTextFormat;
    /** @type {string} */
    customerFooterText;
    /** @type {boolean} */
    addEmptyLineBeforeCustomerFooter;
    /** @type {boolean} */
    includeOnlyDefaultSalesPersonAndDepartment;
    /** @type {boolean} */
    includeSubscriptionCustomerDetailsIfPayedByAnotherCustomer;
    /** @type {string} */
    transactionGroup;
    /** @type {string} */
    invoiceArbitraryNumber;
    /** @type {string} */
    deliveryMethod;
    /** @type {string} */
    deliveryConditions;
    /** @type {string} */
    orderType;
    /** @type {string} */
    invoiceStatus;
    /** @type {boolean} */
    useProductGroupRevenueRecognition;
    /** @type {string} */
    productGroupLineExcludePrint;
    /** @type {string} */
    productGroupLineEditPreferences;
    /** @type {string} */
    productLineExcludePrint;
    /** @type {boolean} */
    useDiscountedPrices;
    /** @type {boolean} */
    terminateUnpaidSubscriptions;
    /** @type {number} */
    allowedUnpaidAmountLimit;
    /** @type {TimeLengthRequestDto} */
    allowedPaymentOverdue;
    /** @type {?string} */
    unpaidSubscriptionTerminationReasonId;
    /** @type {string} */
    unpaidSubscriptionTerminationComment;
    /** @type {string} */
    creditInvoiceNumberReferenceTextFormat;
}
export class UpdateVossInvoiceConfigurations extends UpdateInvoiceConfigurationsRequest {
    /** @param {{intermediaryPlacement?:IntermediaryPlacementEnum,accrualCodeFormat?:AccrualCodeFormatEnum,dateFormat?:string,delimiter?:string,decimalSeparator?:string,orderCreatorCode?:string,salesPersonId?:string,salesDepartmentId?:string,includeBillingPeriodDates?:boolean,trackInvoicePayments?:boolean,includeInvoicedCustomerDetails?:boolean,billingPeriodTextFormat?:string,customerFooterText?:string,addEmptyLineBeforeCustomerFooter?:boolean,includeOnlyDefaultSalesPersonAndDepartment?:boolean,includeSubscriptionCustomerDetailsIfPayedByAnotherCustomer?:boolean,transactionGroup?:string,invoiceArbitraryNumber?:string,deliveryMethod?:string,deliveryConditions?:string,orderType?:string,invoiceStatus?:string,useProductGroupRevenueRecognition?:boolean,productGroupLineExcludePrint?:string,productGroupLineEditPreferences?:string,productLineExcludePrint?:string,useDiscountedPrices?:boolean,terminateUnpaidSubscriptions?:boolean,allowedUnpaidAmountLimit?:number,allowedPaymentOverdue?:TimeLengthRequestDto,unpaidSubscriptionTerminationReasonId?:string,unpaidSubscriptionTerminationComment?:string,creditInvoiceNumberReferenceTextFormat?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}

JavaScript UpdateVossInvoiceConfigurations DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /voss/invoiceConfigurations HTTP/1.1 
Host: api.bokamera.se 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{}