Reports

The firstFilePath field indicates the full file path for the first file in the set. The 0001 at the end represent the file number, and so using the fileCount all files can be referenced using the firstFilePath

For the example below, the 1st file would be at the following path:

/reports/tax_notice/tax_notices_2024-10-01_2023-10-31_0001.zip

And the last file would be at:

/reports/tax_notice/tax_notices_2024-10-01_2023-10-31_0010.zip

Tax Notices

POST

Notifies that a batch of tax notices are ready.

Body

{
  "messageId": "18fed079-477c-4844-a8f5-2c0075c5136f",
  "messageType": "TAX_NOTICES_READY",
  "messageTime": "2024-11-01T01:24:03.102Z",
  "message": {
    "reportStartPeriod": "2024-10-01",
    "reportEndPeriod": "2024-10-31",
    "firstFilePath": "/reports/tax_notice/tax_notices_2024-10-01_2023-10-31_0001.zip",
    "fileCount": 10
  }
}

Statements

POST

Notifies that a batch of statements are ready

Body

{
  "messageId": "18fed079-477c-4844-a8f5-2c0075c5136f",
  "messageType": "STATEMENTS_READY",
  "messageTime": "2024-11-01T01:24:03.102Z",
  "message": {
    "reportStartPeriod": "2024-10-01",
    "reportEndPeriod": "2024-10-31",
    "firstFilePath": "/reports/statements/statements_2024-10-01_2023-10-31_0001.zip",
    "fileCount": 10
  }
}