PVA Compliance SOAP API Endpoints

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 SubscriberCustomer VAT Registered inEndpoint
Based in UKUKCan use existing SOAP API endpoint with EC = 0 and OutsideEC = 0
OrUse new endpoint with TradeBorderType = Domestic
Based in UKEC member stateCan use existing SOAP API endpoint with EC = 1 and OutsideEC = 0

Or

Use new endpoint with TradeBorderType = EC

Based in UKOutside 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 IrelandEC member stateBreaking 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 SubscriberSupplier VAT Registered inEndpoint
Based in UKUKCan use existing SOAP API endpoint with EC = 0
OrUse new endpoint with TradeBorderType = Domestic
Based in UKEC member stateCan use existing SOAP API endpoint with EC = 1

Or

Use new endpoint with TradeBorderType = EC

Based in UKOutside of the EC (i.e. rest of the world)Breaking change.

Use new endpoint with TradeBorderType = ROW

Based in Northern IrelandEC member stateBreaking 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 endpointsPVA Compliant SOAP API endpoints*Description
GetCustomerGetCustomer2GET Customer with Trade Border Type to comply with Postponed VAT Accounting following Brexit transition. Trade Border Type values: Domestic, EC, ROW, NIEU.
GetCustomerByEmailGetCustomerByEmail2GET Customer by email with Trade Border Type to comply with Postponed VAT Accounting following Brexit transition. Trade Border Type values: Domestic, EC, ROW, NIEU.
GetCustomerByIDGetCustomerByID2GET 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.
GetCustomersGetCustomers2GET Customers with Trade Border Type to comply with Postponed VAT Accounting following Brexit transition. Trade Border Type values: Domestic, EC, ROW, NIEU.
GetCustomersByPostcodeGetCustomersByPostcode2GET 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.
GetCustomersModifiedSinceGetCustomersModifiedSince2GET 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.
GetSupplierGetSupplier2GET Supplier with Trade Border Type to comply with Postponed VAT Accounting following Brexit transition. Trade Border Type values: Domestic, EC, ROW, NIEU.
GetSupplierByIDGetSupplierByID2GET 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.
GetSuppliersGetSuppliers2GET Suppliers with Trade Border Type to comply with Postponed VAT Accounting following Brexit transition. Trade Border Type values: Domestic, EC, ROW, NIEU.
InsertCustomerInsertCustomer2INSERT Customer with Trade Border Type to comply with Postponed VAT Accounting following Brexit transition. Trade Border Type values: Domestic, EC, ROW, NIEU.
InsertSupplierInsertSupplier2INSERT Supplier with Trade Border Type to comply with Postponed VAT Accounting following Brexit transition. Trade Border Type values: Domestic, EC, ROW, NIEU.
SearchCustomerByCustTextSearchCustomerByCustText2SEARCH 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.
UpdateCustomerUpdateCustomer2UPDATE Customer with Trade Border Type to comply with Postponed VAT Accounting following Brexit transition. Trade Border Type values: Domestic, EC, ROW, NIEU.
UpdateSupplierUpdateSupplier2UPDATE 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 endpointsPVA Compliant SOAP API endpoints*Description
GetCustomerGetCustomer2GET Customer with Trade Border Type to comply with Postponed VAT Accounting following Brexit transition. Trade Border Type values: Domestic, EC, ROW, NIEU.
GetCustomerByIDGetCustomerByID2GET 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.
GetCustomersGetCustomers2GET Customers with Trade Border Type to comply with Postponed VAT Accounting following Brexit transition. Trade Border Type values: Domestic, EC, ROW, NIEU.
GetCustomersByPostcodeGetCustomersByPostcode2GET 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.
GetSupplierGetSupplier2GET Supplier with Trade Border Type to comply with Postponed VAT Accounting following Brexit transition. Trade Border Type values: Domestic, EC, ROW, NIEU.
GetSupplierByIDGetSupplierByID2GET 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.
GetSuppliersGetSuppliers2GET Suppliers with Trade Border Type to comply with Postponed VAT Accounting following Brexit transition. Trade Border Type values: Domestic, EC, ROW, NIEU.
InsertCustomerInsertCustomer2INSERT Customer with Trade Border Type to comply with Postponed VAT Accounting following Brexit transition. Trade Border Type values: Domestic, EC, ROW, NIEU.
InsertSupplierInsertSupplier2INSERT Supplier with Trade Border Type to comply with Postponed VAT Accounting following Brexit transition. Trade Border Type values: Domestic, EC, ROW, NIEU.

 

See how KashFlow works with your business and your books