Forms/Due

Description: Fetch all the Due forms for a specific DueFrom to DueTo period for the Due Forms.

API Name: /Forms/Due

HTTP Method: GET

HTTP Status Codes:

HTTP Status Codes Description
1 200 Ok
2 204 No Content
3 400 Bad Request
4 500 Internal Server Error 
/// OK [200]
{
  "Data": {
      "Result": [{
              "LocationId": "null",
              "LFEId": "145287",
              "ReportingYear": "2022",
              "FormName": "Sales, Use and Hotel Occupancy Tax",
              "Country": "US",
              "ReportingPeriodFromDate": "2022-05-01T00:00:00",
              "ReportingPeriodToDate": "2022-05-31T00:00:00",
              "DueDate": "2022-06-20T00:00:00",
              "State":"PA",
              "TaxFormID":"PA_ST3",
              "TaxAuthorityName": "PENNSYLVANIA DEPARTMENT OF REVENUE",
              "TaxAuthorityId": "6845",
              "FilingMethod": Paper,
              "ReportingPeriodText": "Monthly"
              },
              {
              "LocationId": "L1",
              "LFEId": "145287",
              "ReportingYear": "2022",
              "FormName": "Sales & Use Tax Form",
              "Country": "US",
              "ReportingPeriodFromDate": "2022-04-01T00:00:00",
              "ReportingPeriodToDate": "2022-06-30T00:00:00",
              "DueDate": "2022-07-31T00:00:00",
              "State":"NC",
              "TaxFormID":"NC_E500",
              "TaxAuthorityName": "NORTH CAROLINA DEPARTMENT OF REVENUE",
              "TaxAuthorityId": "3126",
              "FilingMethod": WebUpload,
              "ReportingPeriodText": "Q2 2022"
              }
      ]
  },
  "Status": "OK",
  "Errors": null
 }

/// No Content example [204]
/// For this case, only the http status code 204 will be returned.

Bad Request example [400]

    {
       "Data": null,
       "Status": "Failure",
       "Errors": [{
               "Code": "",
               "Message": "",
               "Detail": null,
               "Type": null,
               "TraceId": null,
               "ValidationErrors": [{
                       "Field": "Month or Year",
                       "Code": 400,
                       "Message": "Month or Year should be positive integer."
                   }
               ]
           }
       ]
    }

Internal Server Error example [500]  
{
       "Data": null,
       "Status": "Failure",
       "Errors": [
           {
               "Code": "1001",
               "Message": "Some error message from server",
               "Detail": null,
               "Type": null,
               "TraceId": "d0ce45e6-df15-4a04-aaa8-c1c762c6828c",
               "ValidationErrors": []
           }
       ]
}

API Request

Request Parameter DataType Validations Mandatory Description
1 DueFrom N Date range for which forms are fetched
2 DueTo N The period range for which the forms are due to
3 LFEId N Lfeid of the client

DueForGenerationRequest

Response Parameter DataType Validations Mandatory Description
1 FromDate string MM/YYYY N
2 ToDate string MM/YYYY N

API Response

Response Parameter DataType Description
1 LocationId string (50) Location
2 ReportingYear int Request year
3 FormName string (100) Name of Individual Form
4 Country string (2) Code of the country
5 ReportingPeriodFromDate datetime Initial date period
6 ReportingPeriodToDate datetime Final date period
7 State string (2) Code of state
8 TaxFormID string (50) Tax Form ID
9 TaxAuthorityName string (200) Authority name
10 TaxAuthorityId int Authority ID
11 FilingMethod string (100) FilingMethod description
12 ReportingPeriod string (20) Reporting Period
13 DueDate datetime Due Date of form

FilingMethod Values

  1. Server to Server,
  2. EFile(default),
  3. Web Upload,
  4. Paper filing

Case 1. Get forms Due for a specific period

1. Considerer you want to get information for a specific period 01-01-2023 to 02-01-2023 2. User requires two more inputs passed as header viz. UserId and LFEId. These values must be encrypted in base64 format. So, user has to convert the actual values into base64 encrypted values.

3. To execute the API request, user requires bearer token as well as an authorization. If user do not hold the bearer token, then user do not have permission to execute the API request.

4. Fill the parameters DueFrom and DueTo with a valid format date MM/YYYY

5. When user execute the valid API request, he gets the response in following format: 

/// OK [200]
{
  "Data": {
      "Result": [{
              "LocationId": "null",
              "LFEId": "145287",
              "ReportingYear": "2022",
              "FormName": "Sales, Use and Hotel Occupancy Tax",
              "Country": "US",
              "ReportingPeriodFromDate": "2022-05-01T00:00:00",
              "ReportingPeriodToDate": "2022-05-31T00:00:00",
              "DueDate": "2022-06-20T00:00:00",
              "State":"PA",
              "TaxFormID":"PA_ST3",
              "TaxAuthorityName": "PENNSYLVANIA DEPARTMENT OF REVENUE",
              "TaxAuthorityId": "6845",
              "FilingMethod": Paper,
              "ReportingPeriodText": "Monthly"
              }
      ]
  },
  "Status": "OK",
  "Errors": null
 }

Case 2. Get forms Due for one month

1. Considerer you want to get information for a specific month. The request should be: 01-01-2023 to 01-01-2023.

2. User requires two more inputs passed as header viz. UserId and LFEId. These values must be encrypted in base64 format. So, user has to convert the actual values into base64 encrypted values.

3. To execute the API request, user requires bearer token as well as an authorization. If user do not hold the bearer token, then user do not have permission to execute the API request.

4. Fill the parameters DueFrom and DueTo with a valid format date MM/YYYY

5. When user execute the valid API request, he gets the response in following format: 

/// OK [200]
{
  "Data": {
      "Result": [{
              "LocationId": "null",
              "LFEId": "145287",
              "ReportingYear": "2022",
              "FormName": "Sales, Use and Hotel Occupancy Tax",
              "Country": "US",
              "ReportingPeriodFromDate": "2022-05-01T00:00:00",
              "ReportingPeriodToDate": "2022-05-31T00:00:00",
              "DueDate": "2022-06-20T00:00:00",
              "State":"PA",
              "TaxFormID":"PA_ST3",
              "TaxAuthorityName": "PENNSYLVANIA DEPARTMENT OF REVENUE",
              "TaxAuthorityId": "6845",
              "FilingMethod": Paper,
              "ReportingPeriodText": "Monthly"
              }
      ]
  },
  "Status": "OK",
  "Errors": null
 }

Case 3. Try to obtain information with a period of more than one year

1. Considerer you want to get information for a specific period 01-01-2022 to 02-01-2023

2. User requires two more inputs passed as header viz. UserId and LFEId. These values must be encrypted in base64 format. So, user has to convert the actual values into base64 encrypted values.

3. To execute the API request, user requires bearer token as well as an authorization. If user do not hold the bearer token, then user do not have permission to execute the API request.

4. Fill the parameters DueFrom and DueTo with a valid format date MM/YYYY

5. When user execute the API request, he gets the response in following format: 

Bad Request example [400]

    {
       "Data": null,
       "Status": "Failure",
       "Errors": [{
               "Code": "",
               "Message": "",
               "Detail": null,
               "Type": null,
               "TraceId": null,
               "ValidationErrors": [{
                       "Field": "DueTo",
                       "Code": 400,
                       "Message": "Max date range supported is 1 year."
                   }
               ]
           }
       ]
    }