To ensure ongoing compliance with postponed VAT accounting (PVA), KashFlow has introduced some new SOAP API endpoints. The changes to the SOAP API endpoints are summarised below.
Customer SOAP API Endpoint Changes
In the existing endpoints there are two properties related to trade border type of customers:
- EC (can have value 0 or 1)
- OutsideEC (can have value 0 or 1)
With the new endpoints these properties have been replaced with a single property TradeBorderType that can have one of the following values:
- Domestic (i.e. VAT registered in the UK)
- EC (i.e. VAT registered in an EC member state)
- ROW (i.e. VAT registered outside EC member state in other words rest of the world)
- NIEU (i.e. VAT registered in EC member state and KashFlow subscriber is based in Northern Ireland)
| KashFlow Subscriber | Customer VAT Registered in | Endpoint |
| Based in UK | UK | Can use existing SOAP API endpoint with EC = 0 and OutsideEC = 0 OrUse new endpoint with TradeBorderType = Domestic |
| Based in UK | EC member state | Can use existing SOAP API endpoint with EC = 1 and OutsideEC = 0 Or Use new endpoint with TradeBorderType = EC |
| Based in UK | Outside of the EC (i.e. rest of the world) | Can use existing SOAP API endpoint with EC = 0 and OutsideEC = 1 Or Use new endpoint with TradeBorderType = ROW |
| Based in Northern Ireland | EC member state | Breaking change. Use new endpoint with TradeBorderType = NIEU |
Supplier SOAP API Endpoint Changes
In the existing endpoints there is only one property related to trade border type of suppliers:
- EC (can have value 0 or 1)
With the new endpoints the EC property has been replaced with TradeBorderType that can have one of the following values:
- Domestic (i.e. VAT registered in the UK)
- EC (i.e. VAT registered in an EC member state)
- ROW (i.e. VAT registered outside EC member state in other words rest of the world)
- NIEU (i.e. VAT registered in EC member state and KashFlow subscriber is based in Northern Ireland)
| KashFlow Subscriber | Supplier VAT Registered in | Endpoint |
| Based in UK | UK | Can use existing SOAP API endpoint with EC = 0 OrUse new endpoint with TradeBorderType = Domestic |
| Based in UK | EC member state | Can use existing SOAP API endpoint with EC = 1 Or Use new endpoint with TradeBorderType = EC |
| Based in UK | Outside of the EC (i.e. rest of the world) | Breaking change. Use new endpoint with TradeBorderType = ROW |
| Based in Northern Ireland | EC member state | Breaking change. Use new endpoint with TradeBorderType = NIEU |
Please see the table below for a complete list of the existing API’s and their PVA compliant versions.
* Please note these PVA Compliant SOAP API endpoints will only work following updates which are planned to take place on Tuesday 29th December 2020.
These API endpoints should be used to CREATE, EDIT and GET customer/supplier data:
| Existing SOAP API endpoints | PVA Compliant SOAP API endpoints* | Description |
| GetCustomer | GetCustomer2 | GET Customer with Trade Border Type to comply with Postponed VAT Accounting following Brexit transition. Trade Border Type values: Domestic, EC, ROW, NIEU. |
| GetCustomerByEmail | GetCustomerByEmail2 | GET Customer by email with Trade Border Type to comply with Postponed VAT Accounting following Brexit transition. Trade Border Type values: Domestic, EC, ROW, NIEU. |
| GetCustomerByID | GetCustomerByID2 | GET Customer by Customer ID with Trade Border Type to comply with Postponed VAT Accounting following Brexit transition. Trade Border Type values: Domestic, EC, ROW, NIEU. |
| GetCustomers | GetCustomers2 | GET Customers with Trade Border Type to comply with Postponed VAT Accounting following Brexit transition. Trade Border Type values: Domestic, EC, ROW, NIEU. |
| GetCustomersByPostcode | GetCustomersByPostcode2 | GET Customers by Post Code with Trade Border Type to comply with Postponed VAT Accounting following Brexit transition. Trade Border Type values: Domestic, EC, ROW, NIEU. |
| GetCustomersModifiedSince | GetCustomersModifiedSince2 | GET Customers by Modified Since with Trade Border Type to comply with Postponed VAT Accounting following Brexit transition. Trade Border Type values: Domestic, EC, ROW, NIEU. |
| GetSupplier | GetSupplier2 | GET Supplier with Trade Border Type to comply with Postponed VAT Accounting following Brexit transition. Trade Border Type values: Domestic, EC, ROW, NIEU. |
| GetSupplierByID | GetSupplierByID2 | GET Supplier by Supplier ID with Trade Border Type to comply with Postponed VAT Accounting following Brexit transition. Trade Border Type values: Domestic, EC, ROW, NIEU. |
| GetSuppliers | GetSuppliers2 | GET Suppliers with Trade Border Type to comply with Postponed VAT Accounting following Brexit transition. Trade Border Type values: Domestic, EC, ROW, NIEU. |
| InsertCustomer | InsertCustomer2 | INSERT Customer with Trade Border Type to comply with Postponed VAT Accounting following Brexit transition. Trade Border Type values: Domestic, EC, ROW, NIEU. |
| InsertSupplier | InsertSupplier2 | INSERT Supplier with Trade Border Type to comply with Postponed VAT Accounting following Brexit transition. Trade Border Type values: Domestic, EC, ROW, NIEU. |
| SearchCustomerByCustText | SearchCustomerByCustText2 | SEARCH Customer by Customer Text with Trade Border Type to comply with Postponed VAT Accounting following Brexit transition. Trade Border Type values: Domestic, EC, ROW, NIEU. |
| UpdateCustomer | UpdateCustomer2 | UPDATE Customer with Trade Border Type to comply with Postponed VAT Accounting following Brexit transition. Trade Border Type values: Domestic, EC, ROW, NIEU. |
| UpdateSupplier | UpdateSupplier2 | UPDATE Supplier with Trade Border Type to comply with Postponed VAT Accounting following Brexit transition. Trade Border Type values: Domestic, EC, ROW, NIEU. |
These API endpoints should be used by Partners to CREATE, EDIT and GET customer/supplier data for their client’s account:
| Existing SOAP API endpoints | PVA Compliant SOAP API endpoints* | Description |
| GetCustomer | GetCustomer2 | GET Customer with Trade Border Type to comply with Postponed VAT Accounting following Brexit transition. Trade Border Type values: Domestic, EC, ROW, NIEU. |
| GetCustomerByID | GetCustomerByID2 | GET Customer by Customer ID with Trade Border Type to comply with Postponed VAT Accounting following Brexit transition. Trade Border Type values: Domestic, EC, ROW, NIEU. |
| GetCustomers | GetCustomers2 | GET Customers with Trade Border Type to comply with Postponed VAT Accounting following Brexit transition. Trade Border Type values: Domestic, EC, ROW, NIEU. |
| GetCustomersByPostcode | GetCustomersByPostcode2 | GET Customers by Post Code with Trade Border Type to comply with Postponed VAT Accounting following Brexit transition. Trade Border Type values: Domestic, EC, ROW, NIEU. |
| GetSupplier | GetSupplier2 | GET Supplier with Trade Border Type to comply with Postponed VAT Accounting following Brexit transition. Trade Border Type values: Domestic, EC, ROW, NIEU. |
| GetSupplierByID | GetSupplierByID2 | GET Supplier by Supplier ID with Trade Border Type to comply with Postponed VAT Accounting following Brexit transition. Trade Border Type values: Domestic, EC, ROW, NIEU. |
| GetSuppliers | GetSuppliers2 | GET Suppliers with Trade Border Type to comply with Postponed VAT Accounting following Brexit transition. Trade Border Type values: Domestic, EC, ROW, NIEU. |
| InsertCustomer | InsertCustomer2 | INSERT Customer with Trade Border Type to comply with Postponed VAT Accounting following Brexit transition. Trade Border Type values: Domestic, EC, ROW, NIEU. |
| InsertSupplier | InsertSupplier2 | INSERT Supplier with Trade Border Type to comply with Postponed VAT Accounting following Brexit transition. Trade Border Type values: Domestic, EC, ROW, NIEU. |