VAT Returns

Minimum access level: Tax, Accounting & Users, unless stated otherwise.

This endpoint allows API applications to retrieve information on a company's VAT Returns, including details on payments due and filing status.

Attributes

Attribute Description Kind
url Unique identifier for the record URI
period_ends_on The end date of the period covered by the return Date
period_starts_on The start date of the period covered by the return Date
payments An array of Payments Array
filing_due_on The date on which submission is due Date
filing_status One of unfiled, pending, rejected, filed or marked_as_filed. String
filed_at For returns which have been filed online, the date and time at which that happened Datetime
filed_reference For returns which have been filed online, the form bundle number returned by the submission String
breakdown A Breakdown object Object

Payment Attributes

Attribute Description Kind
label A human-readable name for the payment String
due_on The date on which a payment is due Date
amount_due The amount due on that date. May be negative in the case of a refund. Decimal
status One of unpaid or marked_as_paid. paid is reserved for future use. Key is omitted if amount_due is zero or negative. String

Breakdown Attributes

Attribute Description Kind
title A human-readable name for the breakdown String
rows An array of Breakdown Rows Date

Breakdown Row Attributes

Attribute Description Kind
title A human-readable name for the breakdown row String
value The value in the row Decimal
key An identifier for the row String
box_number The VAT box number of the row String

List VAT Returns for a Company

GET https://api.freeagent.com/v2/vat_returns

Response

Status: 200 OK
{
    "vat_returns": [
        {
            "url": "https://api.freeagent.com/v2/vat_returns/2023-07-31",
            "period_ends_on": "2023-07-31",
            "period_starts_on": "2023-05-01",
            "payments": [
                {
                    "label": "Payment Due",
                    "amount_due": "5450.91",
                    "due_on": "2023-09-07",
                    "status": "unpaid"
                }
            ],
            "filing_due_on": "2023-09-07",
            "filing_status": "filed",
            "filed_at": "2023-10-10T10:32:49.000+00:00",
            "filed_reference": "00000000001"
        },
        {
            "url": "https://api.freeagent.com/v2/vat_returns/2023-10-31",
            "period_ends_on": "2023-10-31",
            "period_starts_on": "2023-08-01",
            "payments": [
                {
                    "label": "Refund Due",
                    "amount_due": "-62.89",
                    "due_on": "2023-12-07"
                }
            ],
            "filing_due_on": "2023-12-07",
            "filing_status": "unfiled"
        }
    ]
}
Show as XML
<?xml version="1.0" encoding="UTF-8"?>
<freeagent>
    <vat-returns type="array">
        <vat-return>
            <url>https://api.freeagent.com/v2/vat_returns/2023-07-31</url>
            <period-ends-on type="date">2023-07-31</period-ends-on>
            <period-starts-on type="date">2023-05-01</period-starts-on>
            <payments type="array">
                <payment>
                    <label>Payment Due</label>
                    <amount-due type="decimal">5450.91</amount-due>
                    <due-on type="date">2023-09-07</due-on>
                    <status>unpaid</status>
                </payment>
            </payments>
            <filing-due-on type="date">2023-09-07</filing-due-on>
            <filing-status>filed</filing-status>
            <filed-at type="dateTime">2023-10-10T10:32:49+00:00</filed-at>
            <filed-reference>00000000001</filed-reference>
        </vat-return>
        <vat-return>
            <url>https://api.freeagent.com/v2/vat_returns/2023-10-31</url>
            <period-ends-on type="date">2023-10-31</period-ends-on>
            <period-starts-on type="date">2023-08-01</period-starts-on>
            <payments type="array">
                <payment>
                    <label>Refund Due</label>
                    <amount-due type="decimal">-62.89</amount-due>
                    <due-on type="date">2023-12-07</due-on>
                </payment>
            </payments>
            <filing-due-on type="date">2023-12-07</filing-due-on>
            <filing-status>unfiled</filing-status>
        </vat-return>
    </vat-returns>
</freeagent>
Show as JSON

Fetch details for a VAT Return

GET https://api.freeagent.com/v2/vat_returns/:period_ends_on

Response

Status: 200 OK
{
    "vat_return": {
        "url": "https://api.freeagent.com/v2/vat_returns/2023-07-31",
        "period_ends_on": "2023-07-31",
        "period_starts_on": "2023-05-01",
        "payments": [
            {
                "label": "Payment Due",
                "amount_due": "5450.91",
                "due_on": "2023-09-07",
                "status": "unpaid"
            }
        ],
        "filing_due_on": "2023-09-07",
        "filing_status": "filed",
        "filed_at": "2023-10-10T10:32:49.000+00:00",
        "filed_reference": "00000000001",
        "breakdown": {
            "title": "VAT Return 01 May 23 to 31 Jul 23",
            "rows": [
                {
                    "title": "VAT due on sales and other outputs",
                    "value": "9658.63",
                    "key": "vatDueSales",
                    "box_number": 1
                },
                {
                    "title": "VAT due on acquisitions from other EC Member States",
                    "value": "0.0",
                    "key": "vatDueAcquisitions",
                    "box_number": 2
                },
                {
                    "title": "Total VAT due",
                    "value": "9658.63",
                    "key": "totalVatDue",
                    "box_number": 3
                },
                {
                    "title": "VAT reclaimed on purchases and other inputs (including acquisitions from the EC)",
                    "value": "4207.72",
                    "key": "vatReclaimedCurrPeriod",
                    "box_number": 4
                },
                {
                    "title": "Net VAT to be paid to Customs or reclaimed by you",
                    "value": "5450.91",
                    "key": "netVatDue",
                    "box_number": 5
                },
                {
                    "title": "Total value of sales and all other outputs excluding any VAT",
                    "value": "48293.0",
                    "key": "totalValueSalesExVAT",
                    "box_number": 6
                },
                {
                    "title": "Total value of purchases and all other inputs excluding any VAT",
                    "value": "21039.0",
                    "key": "totalValuePurchasesExVAT",
                    "box_number": 7
                },
                {
                    "title": "Total value of all supplies of goods and related costs, excluding any VAT, to other EC Member States",
                    "value": "0.0",
                    "key": "totalValueGoodsSuppliedExVAT",
                    "box_number": 8
                },
                {
                    "title": "Total value of all acquisitions of goods and related costs, excluding any VAT, from other EC Member States",
                    "value": "0.0",
                    "key": "totalValueGoodsAcquiredExVAT",
                    "box_number": 9
                }
            ]
        }
    }
}
Show as XML
<?xml version="1.0" encoding="UTF-8"?>
<freeagent>
    <vat-return>
        <url>https://api.freeagent.com/v2/vat_returns/2023-07-31</url>
        <period-ends-on type="date">2023-07-31</period-ends-on>
        <period-starts-on type="date">2023-05-01</period-starts-on>
        <payments type="array">
            <payment>
                <label>Payment Due</label>
                <amount-due type="decimal">5450.91</amount-due>
                <due-on type="date">2023-09-07</due-on>
                <status>unpaid</status>
            </payment>
        </payments>
        <filing-due-on type="date">2023-09-07</filing-due-on>
        <filing-status>filed</filing-status>
        <filed-at type="dateTime">2023-10-10T10:32:49+00:00</filed-at>
        <filed-reference>00000000001</filed-reference>
        <breakdown>
            <title>VAT Return 01 May 23 to 31 Jul 23</title>
            <rows type="array">
                <row>
                    <box-number type="integer">1</box-number>
                    <key>vatDueSales</key>
                    <value type="decimal">9658.63</value>
                    <title>VAT due on sales and other outputs</title>
                </row>
                <row>
                    <box-number type="integer">2</box-number>
                    <key>vatDueAcquisitions</key>
                    <value type="decimal">0.0</value>
                    <title>VAT due on acquisitions from other EC Member States</title>
                </row>
                <row>
                    <box-number type="integer">3</box-number>
                    <key>totalVatDue</key>
                    <value type="decimal">9658.63</value>
                    <title>Total VAT due</title>
                </row>
                <row>
                    <box-number type="integer">4</box-number>
                    <key>vatReclaimedCurrPeriod</key>
                    <value type="decimal">4207.72</value>
                    <title>VAT reclaimed on purchases and other inputs (including acquisitions from the EC)</title>
                </row>
                <row>
                    <box-number type="integer">5</box-number>
                    <key>netVatDue</key>
                    <value type="decimal">5450.91</value>
                    <title>Net VAT to be paid to Customs or reclaimed by you</title>
                </row>
                <row>
                    <box-number type="integer">6</box-number>
                    <key>totalValueSalesExVAT</key>
                    <value type="decimal">48293.0</value>
                    <title>Total value of sales and all other outputs excluding any VAT</title>
                </row>
                <row>
                    <box-number type="integer">7</box-number>
                    <key>totalValuePurchasesExVAT</key>
                    <value type="decimal">21039.0</value>
                    <title>Total value of purchases and all other inputs excluding any VAT</title>
                </row>
                <row>
                    <box-number type="integer">8</box-number>
                    <key>totalValueGoodsSuppliedExVAT</key>
                    <value type="decimal">0.0</value>
                    <title>Total value of all supplies of goods and related costs, excluding any VAT, to other EC Member States</title>
                </row>
                <row>
                    <box-number type="integer">9</box-number>
                    <key>totalValueGoodsAcquiredExVAT</key>
                    <value type="decimal">0.0</value>
                    <title>Total value of all acquisitions of goods and related costs, excluding any VAT, from other EC Member States</title>
                </row>
            </rows>
        </breakdown>
    </vat-return>
</freeagent>
Show as JSON

Mark a VAT Return as Filed

Minimum access level: Full Access

PUT https://api.freeagent.com/v2/vat_returns/:period_ends_on/mark_as_filed

Response

Status: 200 OK
{
    "vat_return": {
        "url": "https://api.freeagent.com/v2/vat_returns/2023-07-31",
        "period_ends_on": "2023-07-31",
        "period_starts_on": "2023-05-01",
        "payments": [
            {
                "label": "Payment Due",
                "amount_due": "5450.91",
                "due_on": "2023-09-07",
                "status": "unpaid"
            }
        ],
        "filing_due_on": "2023-09-07",
        "filing_status": "marked_as_filed",
        "breakdown": {
            "title": "VAT Return 01 May 23 to 31 Jul 23",
            "rows": [
                {
                    "title": "VAT due on sales and other outputs",
                    "value": "9658.63",
                    "key": "vatDueSales",
                    "box_number": 1
                },
                {
                    "title": "VAT due on acquisitions from other EC Member States",
                    "value": "0.0",
                    "key": "vatDueAcquisitions",
                    "box_number": 2
                },
                {
                    "title": "Total VAT due",
                    "value": "9658.63",
                    "key": "totalVatDue",
                    "box_number": 3
                },
                {
                    "title": "VAT reclaimed on purchases and other inputs (including acquisitions from the EC)",
                    "value": "4207.72",
                    "key": "vatReclaimedCurrPeriod",
                    "box_number": 4
                },
                {
                    "title": "Net VAT to be paid to Customs or reclaimed by you",
                    "value": "5450.91",
                    "key": "netVatDue",
                    "box_number": 5
                },
                {
                    "title": "Total value of sales and all other outputs excluding any VAT",
                    "value": "48293.0",
                    "key": "totalValueSalesExVAT",
                    "box_number": 6
                },
                {
                    "title": "Total value of purchases and all other inputs excluding any VAT",
                    "value": "21039.0",
                    "key": "totalValuePurchasesExVAT",
                    "box_number": 7
                },
                {
                    "title": "Total value of all supplies of goods and related costs, excluding any VAT, to other EC Member States",
                    "value": "0.0",
                    "key": "totalValueGoodsSuppliedExVAT",
                    "box_number": 8
                },
                {
                    "title": "Total value of all acquisitions of goods and related costs, excluding any VAT, from other EC Member States",
                    "value": "0.0",
                    "key": "totalValueGoodsAcquiredExVAT",
                    "box_number": 9
                }
            ]
        }
    }
}
Show as XML
<?xml version="1.0" encoding="UTF-8"?>
<freeagent>
    <vat-return>
        <url>https://api.freeagent.com/v2/vat_returns/2023-07-31</url>
        <period-ends-on type="date">2023-07-31</period-ends-on>
        <period-starts-on type="date">2023-05-01</period-starts-on>
        <payments type="array">
            <payment>
                <label>Payment Due</label>
                <amount-due type="decimal">5450.91</amount-due>
                <due-on type="date">2023-09-07</due-on>
                <status>unpaid</status>
            </payment>
        </payments>
        <filing-due-on type="date">2023-09-07</filing-due-on>
        <filing-status>marked_as_filed</filing-status>
        <breakdown>
            <title>VAT Return 01 May 23 to 31 Jul 23</title>
            <rows type="array">
                <row>
                    <box-number type="integer">1</box-number>
                    <key>vatDueSales</key>
                    <value type="decimal">9658.63</value>
                    <title>VAT due on sales and other outputs</title>
                </row>
                <row>
                    <box-number type="integer">2</box-number>
                    <key>vatDueAcquisitions</key>
                    <value type="decimal">0.0</value>
                    <title>VAT due on acquisitions from other EC Member States</title>
                </row>
                <row>
                    <box-number type="integer">3</box-number>
                    <key>totalVatDue</key>
                    <value type="decimal">9658.63</value>
                    <title>Total VAT due</title>
                </row>
                <row>
                    <box-number type="integer">4</box-number>
                    <key>vatReclaimedCurrPeriod</key>
                    <value type="decimal">4207.72</value>
                    <title>VAT reclaimed on purchases and other inputs (including acquisitions from the EC)</title>
                </row>
                <row>
                    <box-number type="integer">5</box-number>
                    <key>netVatDue</key>
                    <value type="decimal">5450.91</value>
                    <title>Net VAT to be paid to Customs or reclaimed by you</title>
                </row>
                <row>
                    <box-number type="integer">6</box-number>
                    <key>totalValueSalesExVAT</key>
                    <value type="decimal">48293.0</value>
                    <title>Total value of sales and all other outputs excluding any VAT</title>
                </row>
                <row>
                    <box-number type="integer">7</box-number>
                    <key>totalValuePurchasesExVAT</key>
                    <value type="decimal">21039.0</value>
                    <title>Total value of purchases and all other inputs excluding any VAT</title>
                </row>
                <row>
                    <box-number type="integer">8</box-number>
                    <key>totalValueGoodsSuppliedExVAT</key>
                    <value type="decimal">0.0</value>
                    <title>Total value of all supplies of goods and related costs, excluding any VAT, to other EC Member States</title>
                </row>
                <row>
                    <box-number type="integer">9</box-number>
                    <key>totalValueGoodsAcquiredExVAT</key>
                    <value type="decimal">0.0</value>
                    <title>Total value of all acquisitions of goods and related costs, excluding any VAT, from other EC Member States</title>
                </row>
            </rows>
        </breakdown>
    </vat-return>
</freeagent>
Show as JSON

Mark a VAT Return as Unfiled

Minimum access level: Full Access

PUT https://api.freeagent.com/v2/vat_returns/:period_ends_on/mark_as_unfiled

Response

Status: 200 OK
{
    "vat_return": {
        "url": "https://api.freeagent.com/v2/vat_returns/2023-07-31",
        "period_ends_on": "2023-07-31",
        "period_starts_on": "2023-05-01",
        "payments": [
            {
                "label": "Payment Due",
                "amount_due": "5450.91",
                "due_on": "2023-09-07",
                "status": "unpaid"
            }
        ],
        "filing_due_on": "2023-09-07",
        "filing_status": "unfiled",
        "breakdown": {
            "title": "VAT Return 01 May 23 to 31 Jul 23",
            "rows": [
                {
                    "title": "VAT due on sales and other outputs",
                    "value": "9658.63",
                    "key": "vatDueSales",
                    "box_number": 1
                },
                {
                    "title": "VAT due on acquisitions from other EC Member States",
                    "value": "0.0",
                    "key": "vatDueAcquisitions",
                    "box_number": 2
                },
                {
                    "title": "Total VAT due",
                    "value": "9658.63",
                    "key": "totalVatDue",
                    "box_number": 3
                },
                {
                    "title": "VAT reclaimed on purchases and other inputs (including acquisitions from the EC)",
                    "value": "4207.72",
                    "key": "vatReclaimedCurrPeriod",
                    "box_number": 4
                },
                {
                    "title": "Net VAT to be paid to Customs or reclaimed by you",
                    "value": "5450.91",
                    "key": "netVatDue",
                    "box_number": 5
                },
                {
                    "title": "Total value of sales and all other outputs excluding any VAT",
                    "value": "48293.0",
                    "key": "totalValueSalesExVAT",
                    "box_number": 6
                },
                {
                    "title": "Total value of purchases and all other inputs excluding any VAT",
                    "value": "21039.0",
                    "key": "totalValuePurchasesExVAT",
                    "box_number": 7
                },
                {
                    "title": "Total value of all supplies of goods and related costs, excluding any VAT, to other EC Member States",
                    "value": "0.0",
                    "key": "totalValueGoodsSuppliedExVAT",
                    "box_number": 8
                },
                {
                    "title": "Total value of all acquisitions of goods and related costs, excluding any VAT, from other EC Member States",
                    "value": "0.0",
                    "key": "totalValueGoodsAcquiredExVAT",
                    "box_number": 9
                }
            ]
        }
    }
}
Show as XML
<?xml version="1.0" encoding="UTF-8"?>
<freeagent>
    <vat-return>
        <url>https://api.freeagent.com/v2/vat_returns/2023-07-31</url>
        <period-ends-on type="date">2023-07-31</period-ends-on>
        <period-starts-on type="date">2023-05-01</period-starts-on>
        <payments type="array">
            <payment>
                <label>Payment Due</label>
                <amount-due type="decimal">5450.91</amount-due>
                <due-on type="date">2023-09-07</due-on>
                <status>unpaid</status>
            </payment>
        </payments>
        <filing-due-on type="date">2023-09-07</filing-due-on>
        <filing-status>unfiled</filing-status>
        <breakdown>
            <title>VAT Return 01 May 23 to 31 Jul 23</title>
            <rows type="array">
                <row>
                    <box-number type="integer">1</box-number>
                    <key>vatDueSales</key>
                    <value type="decimal">9658.63</value>
                    <title>VAT due on sales and other outputs</title>
                </row>
                <row>
                    <box-number type="integer">2</box-number>
                    <key>vatDueAcquisitions</key>
                    <value type="decimal">0.0</value>
                    <title>VAT due on acquisitions from other EC Member States</title>
                </row>
                <row>
                    <box-number type="integer">3</box-number>
                    <key>totalVatDue</key>
                    <value type="decimal">9658.63</value>
                    <title>Total VAT due</title>
                </row>
                <row>
                    <box-number type="integer">4</box-number>
                    <key>vatReclaimedCurrPeriod</key>
                    <value type="decimal">4207.72</value>
                    <title>VAT reclaimed on purchases and other inputs (including acquisitions from the EC)</title>
                </row>
                <row>
                    <box-number type="integer">5</box-number>
                    <key>netVatDue</key>
                    <value type="decimal">5450.91</value>
                    <title>Net VAT to be paid to Customs or reclaimed by you</title>
                </row>
                <row>
                    <box-number type="integer">6</box-number>
                    <key>totalValueSalesExVAT</key>
                    <value type="decimal">48293.0</value>
                    <title>Total value of sales and all other outputs excluding any VAT</title>
                </row>
                <row>
                    <box-number type="integer">7</box-number>
                    <key>totalValuePurchasesExVAT</key>
                    <value type="decimal">21039.0</value>
                    <title>Total value of purchases and all other inputs excluding any VAT</title>
                </row>
                <row>
                    <box-number type="integer">8</box-number>
                    <key>totalValueGoodsSuppliedExVAT</key>
                    <value type="decimal">0.0</value>
                    <title>Total value of all supplies of goods and related costs, excluding any VAT, to other EC Member States</title>
                </row>
                <row>
                    <box-number type="integer">9</box-number>
                    <key>totalValueGoodsAcquiredExVAT</key>
                    <value type="decimal">0.0</value>
                    <title>Total value of all acquisitions of goods and related costs, excluding any VAT, from other EC Member States</title>
                </row>
            </rows>
        </breakdown>
    </vat-return>
</freeagent>
Show as JSON

Mark a VAT Return Payment as Paid

PUT https://api.freeagent.com/v2/vat_returns/:period_ends_on/payments/:payment_date/mark_as_paid

Response

Status: 200 OK
{
    "vat_return": {
        "url": "https://api.freeagent.com/v2/vat_returns/2023-07-31",
        "period_ends_on": "2023-07-31",
        "period_starts_on": "2023-05-01",
        "payments": [
            {
                "label": "Payment Due",
                "amount_due": "5450.91",
                "due_on": "2023-09-07",
                "status": "marked_as_paid"
            }
        ],
        "filing_due_on": "2023-09-07",
        "filing_status": "filed",
        "filed_at": "2023-10-10T10:32:49.000+00:00",
        "filed_reference": "00000000001",
        "breakdown": {
            "title": "VAT Return 01 May 23 to 31 Jul 23",
            "rows": [
                {
                    "title": "VAT due on sales and other outputs",
                    "value": "9658.63",
                    "key": "vatDueSales",
                    "box_number": 1
                },
                {
                    "title": "VAT due on acquisitions from other EC Member States",
                    "value": "0.0",
                    "key": "vatDueAcquisitions",
                    "box_number": 2
                },
                {
                    "title": "Total VAT due",
                    "value": "9658.63",
                    "key": "totalVatDue",
                    "box_number": 3
                },
                {
                    "title": "VAT reclaimed on purchases and other inputs (including acquisitions from the EC)",
                    "value": "4207.72",
                    "key": "vatReclaimedCurrPeriod",
                    "box_number": 4
                },
                {
                    "title": "Net VAT to be paid to Customs or reclaimed by you",
                    "value": "5450.91",
                    "key": "netVatDue",
                    "box_number": 5
                },
                {
                    "title": "Total value of sales and all other outputs excluding any VAT",
                    "value": "48293.0",
                    "key": "totalValueSalesExVAT",
                    "box_number": 6
                },
                {
                    "title": "Total value of purchases and all other inputs excluding any VAT",
                    "value": "21039.0",
                    "key": "totalValuePurchasesExVAT",
                    "box_number": 7
                },
                {
                    "title": "Total value of all supplies of goods and related costs, excluding any VAT, to other EC Member States",
                    "value": "0.0",
                    "key": "totalValueGoodsSuppliedExVAT",
                    "box_number": 8
                },
                {
                    "title": "Total value of all acquisitions of goods and related costs, excluding any VAT, from other EC Member States",
                    "value": "0.0",
                    "key": "totalValueGoodsAcquiredExVAT",
                    "box_number": 9
                }
            ]
        }
    }
}
Show as XML
<?xml version="1.0" encoding="UTF-8"?>
<freeagent>
    <vat-return>
        <url>https://api.freeagent.com/v2/vat_returns/2023-07-31</url>
        <period-ends-on type="date">2023-07-31</period-ends-on>
        <period-starts-on type="date">2023-05-01</period-starts-on>
        <payments type="array">
            <payment>
                <label>Payment Due</label>
                <amount-due type="decimal">5450.91</amount-due>
                <due-on type="date">2023-09-07</due-on>
                <status>marked_as_paid</status>
            </payment>
        </payments>
        <filing-due-on type="date">2023-09-07</filing-due-on>
        <filing-status>filed</filing-status>
        <filed-at type="dateTime">2023-10-10T10:32:49+00:00</filed-at>
        <filed-reference>00000000001</filed-reference>
        <breakdown>
            <title>VAT Return 01 May 23 to 31 Jul 23</title>
            <rows type="array">
                <row>
                    <box-number type="integer">1</box-number>
                    <key>vatDueSales</key>
                    <value type="decimal">9658.63</value>
                    <title>VAT due on sales and other outputs</title>
                </row>
                <row>
                    <box-number type="integer">2</box-number>
                    <key>vatDueAcquisitions</key>
                    <value type="decimal">0.0</value>
                    <title>VAT due on acquisitions from other EC Member States</title>
                </row>
                <row>
                    <box-number type="integer">3</box-number>
                    <key>totalVatDue</key>
                    <value type="decimal">9658.63</value>
                    <title>Total VAT due</title>
                </row>
                <row>
                    <box-number type="integer">4</box-number>
                    <key>vatReclaimedCurrPeriod</key>
                    <value type="decimal">4207.72</value>
                    <title>VAT reclaimed on purchases and other inputs (including acquisitions from the EC)</title>
                </row>
                <row>
                    <box-number type="integer">5</box-number>
                    <key>netVatDue</key>
                    <value type="decimal">5450.91</value>
                    <title>Net VAT to be paid to Customs or reclaimed by you</title>
                </row>
                <row>
                    <box-number type="integer">6</box-number>
                    <key>totalValueSalesExVAT</key>
                    <value type="decimal">48293.0</value>
                    <title>Total value of sales and all other outputs excluding any VAT</title>
                </row>
                <row>
                    <box-number type="integer">7</box-number>
                    <key>totalValuePurchasesExVAT</key>
                    <value type="decimal">21039.0</value>
                    <title>Total value of purchases and all other inputs excluding any VAT</title>
                </row>
                <row>
                    <box-number type="integer">8</box-number>
                    <key>totalValueGoodsSuppliedExVAT</key>
                    <value type="decimal">0.0</value>
                    <title>Total value of all supplies of goods and related costs, excluding any VAT, to other EC Member States</title>
                </row>
                <row>
                    <box-number type="integer">9</box-number>
                    <key>totalValueGoodsAcquiredExVAT</key>
                    <value type="decimal">0.0</value>
                    <title>Total value of all acquisitions of goods and related costs, excluding any VAT, from other EC Member States</title>
                </row>
            </rows>
        </breakdown>
    </vat-return>
</freeagent>
Show as JSON

Mark a VAT Return Payment as Unpaid

PUT https://api.freeagent.com/v2/vat_returns/:period_ends_on/payments/:payment_date/mark_as_unpaid

Response

Status: 200 OK
{
    "vat_return": {
        "url": "https://api.freeagent.com/v2/vat_returns/2023-07-31",
        "period_ends_on": "2023-07-31",
        "period_starts_on": "2023-05-01",
        "payments": [
            {
                "label": "Payment Due",
                "amount_due": "5450.91",
                "due_on": "2023-09-07",
                "status": "unpaid"
            }
        ],
        "filing_due_on": "2023-09-07",
        "filing_status": "filed",
        "filed_at": "2023-10-10T10:32:49.000+00:00",
        "filed_reference": "00000000001",
        "breakdown": {
            "title": "VAT Return 01 May 23 to 31 Jul 23",
            "rows": [
                {
                    "title": "VAT due on sales and other outputs",
                    "value": "9658.63",
                    "key": "vatDueSales",
                    "box_number": 1
                },
                {
                    "title": "VAT due on acquisitions from other EC Member States",
                    "value": "0.0",
                    "key": "vatDueAcquisitions",
                    "box_number": 2
                },
                {
                    "title": "Total VAT due",
                    "value": "9658.63",
                    "key": "totalVatDue",
                    "box_number": 3
                },
                {
                    "title": "VAT reclaimed on purchases and other inputs (including acquisitions from the EC)",
                    "value": "4207.72",
                    "key": "vatReclaimedCurrPeriod",
                    "box_number": 4
                },
                {
                    "title": "Net VAT to be paid to Customs or reclaimed by you",
                    "value": "5450.91",
                    "key": "netVatDue",
                    "box_number": 5
                },
                {
                    "title": "Total value of sales and all other outputs excluding any VAT",
                    "value": "48293.0",
                    "key": "totalValueSalesExVAT",
                    "box_number": 6
                },
                {
                    "title": "Total value of purchases and all other inputs excluding any VAT",
                    "value": "21039.0",
                    "key": "totalValuePurchasesExVAT",
                    "box_number": 7
                },
                {
                    "title": "Total value of all supplies of goods and related costs, excluding any VAT, to other EC Member States",
                    "value": "0.0",
                    "key": "totalValueGoodsSuppliedExVAT",
                    "box_number": 8
                },
                {
                    "title": "Total value of all acquisitions of goods and related costs, excluding any VAT, from other EC Member States",
                    "value": "0.0",
                    "key": "totalValueGoodsAcquiredExVAT",
                    "box_number": 9
                }
            ]
        }
    }
}
Show as XML
<?xml version="1.0" encoding="UTF-8"?>
<freeagent>
    <vat-return>
        <url>https://api.freeagent.com/v2/vat_returns/2023-07-31</url>
        <period-ends-on type="date">2023-07-31</period-ends-on>
        <period-starts-on type="date">2023-05-01</period-starts-on>
        <payments type="array">
            <payment>
                <label>Payment Due</label>
                <amount-due type="decimal">5450.91</amount-due>
                <due-on type="date">2023-09-07</due-on>
                <status>unpaid</status>
            </payment>
        </payments>
        <filing-due-on type="date">2023-09-07</filing-due-on>
        <filing-status>filed</filing-status>
        <filed-at type="dateTime">2023-10-10T10:32:49+00:00</filed-at>
        <filed-reference>00000000001</filed-reference>
        <breakdown>
            <title>VAT Return 01 May 23 to 31 Jul 23</title>
            <rows type="array">
                <row>
                    <box-number type="integer">1</box-number>
                    <key>vatDueSales</key>
                    <value type="decimal">9658.63</value>
                    <title>VAT due on sales and other outputs</title>
                </row>
                <row>
                    <box-number type="integer">2</box-number>
                    <key>vatDueAcquisitions</key>
                    <value type="decimal">0.0</value>
                    <title>VAT due on acquisitions from other EC Member States</title>
                </row>
                <row>
                    <box-number type="integer">3</box-number>
                    <key>totalVatDue</key>
                    <value type="decimal">9658.63</value>
                    <title>Total VAT due</title>
                </row>
                <row>
                    <box-number type="integer">4</box-number>
                    <key>vatReclaimedCurrPeriod</key>
                    <value type="decimal">4207.72</value>
                    <title>VAT reclaimed on purchases and other inputs (including acquisitions from the EC)</title>
                </row>
                <row>
                    <box-number type="integer">5</box-number>
                    <key>netVatDue</key>
                    <value type="decimal">5450.91</value>
                    <title>Net VAT to be paid to Customs or reclaimed by you</title>
                </row>
                <row>
                    <box-number type="integer">6</box-number>
                    <key>totalValueSalesExVAT</key>
                    <value type="decimal">48293.0</value>
                    <title>Total value of sales and all other outputs excluding any VAT</title>
                </row>
                <row>
                    <box-number type="integer">7</box-number>
                    <key>totalValuePurchasesExVAT</key>
                    <value type="decimal">21039.0</value>
                    <title>Total value of purchases and all other inputs excluding any VAT</title>
                </row>
                <row>
                    <box-number type="integer">8</box-number>
                    <key>totalValueGoodsSuppliedExVAT</key>
                    <value type="decimal">0.0</value>
                    <title>Total value of all supplies of goods and related costs, excluding any VAT, to other EC Member States</title>
                </row>
                <row>
                    <box-number type="integer">9</box-number>
                    <key>totalValueGoodsAcquiredExVAT</key>
                    <value type="decimal">0.0</value>
                    <title>Total value of all acquisitions of goods and related costs, excluding any VAT, from other EC Member States</title>
                </row>
            </rows>
        </breakdown>
    </vat-return>
</freeagent>
Show as JSON