GET – Retrieve a list of all predefined voucher series

Description

Retrieve a list of all predefined voucher series

URL structure

https://api.fortnox.se/3/predefinedvoucherseries/

Method

GET

Version

3

Response

Retrieves all type of vouchers and it’s predefined series.

<?xml version="1.0" encoding="UTF-8"?>
<PreDefinedVoucherSeriesCollection>
    <PreDefinedVoucherSeriesSubset url="https://api.fortnox.se/3/predefinedvoucherseries/INVOICE">
        <Name>INVOICE</Name>
        <VoucherSeries>B</VoucherSeries>
    </PreDefinedVoucherSeriesSubset>
    <PreDefinedVoucherSeriesSubset url="https://api.fortnox.se/3/predefinedvoucherseries/INVOICEPAYMENT">
        <Name>INVOICEPAYMENT</Name>
        <VoucherSeries>C</VoucherSeries>
    </PreDefinedVoucherSeriesSubset>
    <PreDefinedVoucherSeriesSubset url="https://api.fortnox.se/3/predefinedvoucherseries/SUPPLIERINVOICE">
        <Name>SUPPLIERINVOICE</Name>
        <VoucherSeries>D</VoucherSeries>
    </PreDefinedVoucherSeriesSubset>
    <PreDefinedVoucherSeriesSubset url="https://api.fortnox.se/3/predefinedvoucherseries/SUPPLIERINVOICEPAYMENT">
        <Name>SUPPLIERINVOICEPAYMENT</Name>
        <VoucherSeries>E</VoucherSeries>
    </PreDefinedVoucherSeriesSubset>
    <PreDefinedVoucherSeriesSubset url="https://api.fortnox.se/3/predefinedvoucherseries/ANL">
        <Name>ANL</Name>
        <VoucherSeries>G</VoucherSeries>
    </PreDefinedVoucherSeriesSubset>
    <PreDefinedVoucherSeriesSubset url="https://api.fortnox.se/3/predefinedvoucherseries/INVOICEACCRUAL">
        <Name>INVOICEACCRUAL</Name>
        <VoucherSeries>H</VoucherSeries>
    </PreDefinedVoucherSeriesSubset>
    <PreDefinedVoucherSeriesSubset url="https://api.fortnox.se/3/predefinedvoucherseries/SUPPLIERINVOICEACCRUAL">
        <Name>SUPPLIERINVOICEACCRUAL</Name>
        <VoucherSeries>H</VoucherSeries>
    </PreDefinedVoucherSeriesSubset>
    <PreDefinedVoucherSeriesSubset url="https://api.fortnox.se/3/predefinedvoucherseries/SALARY">
        <Name>SALARY</Name>
        <VoucherSeries>K</VoucherSeries>
    </PreDefinedVoucherSeriesSubset>
    <PreDefinedVoucherSeriesSubset url="https://api.fortnox.se/3/predefinedvoucherseries/CASHINVOICE">
        <Name>CASHINVOICE</Name>
        <VoucherSeries>L</VoucherSeries>
    </PreDefinedVoucherSeriesSubset>
    <PreDefinedVoucherSeriesSubset url="https://api.fortnox.se/3/predefinedvoucherseries/VAT">
        <Name>VAT</Name>
        <VoucherSeries>M</VoucherSeries>
    </PreDefinedVoucherSeriesSubset>
    <PreDefinedVoucherSeriesSubset url="https://api.fortnox.se/3/predefinedvoucherseries/CLOSINGSERIES">
        <Name>CLOSINGSERIES</Name>
        <VoucherSeries/>
    </PreDefinedVoucherSeriesSubset>
</PreDefinedVoucherSeriesCollection>
{
    "PreDefinedVoucherSeriesCollection": [
        {
            "@url": "https://api.fortnox.se/3/predefinedvoucherseries/INVOICE",
            "Name": "INVOICE",
            "VoucherSeries": "B"
        },
        {
            "@url": "https://api.fortnox.se/3/predefinedvoucherseries/INVOICEPAYMENT",
            "Name": "INVOICEPAYMENT",
            "VoucherSeries": "C"
        },
        {
            "@url": "https://api.fortnox.se/3/predefinedvoucherseries/SUPPLIERINVOICE",
            "Name": "SUPPLIERINVOICE",
            "VoucherSeries": "D"
        },
        {
            "@url": "https://api.fortnox.se/3/predefinedvoucherseries/SUPPLIERINVOICEPAYMENT",
            "Name": "SUPPLIERINVOICEPAYMENT",
            "VoucherSeries": "E"
        },
        {
            "@url": "https://api.fortnox.se/3/predefinedvoucherseries/ANL",
            "Name": "ANL",
            "VoucherSeries": "G"
        },
        {
            "@url": "https://api.fortnox.se/3/predefinedvoucherseries/INVOICEACCRUAL",
            "Name": "INVOICEACCRUAL",
            "VoucherSeries": "H"
        },
        {
            "@url": "https://api.fortnox.se/3/predefinedvoucherseries/SUPPLIERINVOICEACCRUAL",
            "Name": "SUPPLIERINVOICEACCRUAL",
            "VoucherSeries": "H"
        },
        {
            "@url": "https://api.fortnox.se/3/predefinedvoucherseries/SALARY",
            "Name": "SALARY",
            "VoucherSeries": "K"
        },
        {
            "@url": "https://api.fortnox.se/3/predefinedvoucherseries/CASHINVOICE",
            "Name": "CASHINVOICE",
            "VoucherSeries": "L"
        },
        {
            "@url": "https://api.fortnox.se/3/predefinedvoucherseries/VAT",
            "Name": "VAT",
            "VoucherSeries": "M"
        },
        {
            "@url": "https://api.fortnox.se/3/predefinedvoucherseries/CLOSINGSERIES",
            "Name": "CLOSINGSERIES",
            "VoucherSeries": ""
        }
    ]
}

GET – Retrieve predefined series for a specific voucher type

Description

Retrieve predefined series for a specific voucher type

URL structure

https://api.fortnox.se/3/predefinedvoucherseries/{name} (capital letters on {name})

Method

GET

Version

3

Response

Retrieves predefined series for the requested voucher type.

<?xml version="1.0" encoding="UTF-8"?>
<PreDefinedVoucherSeries url="https://api.fortnox.se/3/predefinedvoucherseries/INVOICE">
        <Name>INVOICE</Name>
        <VoucherSeries>B</VoucherSeries>
</PreDefinedVoucherSeries>
{
    "PreDefinedVoucherSeries": {
        "@url": "https://api.fortnox.se/3/predefinedvoucherseries/INVOICE",
        "Name": "INVOICE",
        "VoucherSeries": "B"
    }
}

PUT – Update existing voucher type with a predefined voucher series.

Description

Update existing voucher type with a predefined voucher series.

URL structure

https://api.fortnox.se/3/predefinedvoucherseries/{name} (capital letters on {name})

Method

PUT

Version

3

Request

The request body should contain a structure of an PreDefinedVoucherSeries, either in JSON or XML.

<?xml version="1.0" encoding="UTF-8"?>
<PreDefinedVoucherSeries>
    <VoucherSeries>B</VoucherSeries>
</PreDefinedVoucherSeries>
{
    "PreDefinedVoucherSeries": {
        "VoucherSeries": "B"
    }
}

Response

The response should contain the updated object in either JSON or XML.

<?xml version="1.0" encoding="UTF-8"?>
<PreDefinedVoucherSeries url="https://api.fortnox.se/3/predefinedvoucherseries/INVOICE">
    <Name>INVOICE</Name>
    <VoucherSeries>B</VoucherSeries>
</PreDefinedVoucherSeries>
{
    "PreDefinedVoucherSeries": {
        "@url": "https://api.fortnox.se/3/predefinedvoucherseries/INVOICE",
        "Name": "INVOICE",
        "VoucherSeries": "B"
    }
}

Fields

Predefined Voucher Series

Field Description Limits Type Searchable Sortable Required R/W
Url Direct url to the record. String R
Name Name of voucher type String R
VoucherSeries Predefined voucher series 1 character String R/W