CheckVATWhitelistStatus

This function gets status of VAT taxpayer for current or specified date. Function return status string or JSON with fields:

• IsSuccess,
• ErrorMessage,
• Date,
• NIP,
• AccountNumberNRB,
• Status,
• StatusString.

Available „StatusString” and „Status” values:

• NoDataForDay = -1,
• NotFound = 0,
• Active = 1,
• Exempt = 2.

If the fourth argument is not set then function returns value of „StatusString” or „Error” string if something went wrong. If date is not specified then current date is used. If status is equal to „NoDataForDay” then you should call function FindVATWhitelistMostSuitableDate() to check day for which data are available.

For some more information you can visit this page: Weryfikacja kontrahenta w Wykazie Podatnika VAT

Syntax

CheckVATWhitelistStatus("nip", "bankAccountNumber")

CheckVATWhitelistStatus("nip", "bankAccountNumber", "date")

CheckVATWhitelistStatus("nip", "bankAccountNumber", "date", "returnAsJSON"

Function arguments

• nip – (String) NIP number containing 10 digits. For increased readibility can be specified in format like 123-456-78-90
• bankAccountNumber – (String) Bank account number in NRB format which contains 26 digits, other characters will be ignored
• date – (DateNoTime) [Optional] Date in the past to check if needed. Can be date or string with format yyyyMMdd
• returnAsJSON – (Boolean) [Optional] If value equals to „true” then function returns json instead of status

Return value

This function returns String.

Examples

Example 1:
Gets status string based on NIP number and bank account number.

CheckVATWhitelistStatus("1234567890", "12345678901234567890123456")

Example 2:
Gets status string based on NIP number and bank account number for specified date. Date must have format „yyyyMMdd”. If date format is different then function throws error.

CheckVATWhitelistStatus("1234567890", "12345678901234567890123456", "20200101")

Example 3:
Gets status JSON based on values in specified fields and display status string in specified field. In this case the result is the same as usual because if fourth parameter is omitted then „StatusString” is returned.

json=CheckVATWhitelistStatus([nip], [bankAccount], [date], "true")
[status]=JsonPath(json, "StatusString")

Example 4:
In this case get status for date returned from FindVATWhitelistMostSuitableDate() function.

date=FindVATWhitelistMostSuitableDate();
CheckVATWhitelistStatus([nip], [nrb], date);