Scribd
Upload
6 views6 pages

Frontend Guide

The document outlines the API specifications for VAT Payment and Registration services, including endpoints for submitting payments and registration requests, as well as retrieving records. It provides details on request headers, body formats, and expected responses for both successful and unsuccessful operations. The VAT Payment API allows for payment submissions and retrieval of payment records, while the VAT Registration API facilitates new registration requests and approvals with unique acknowledgment numbers.

Uploaded by

Anirban Sarkar
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
6 views6 pages

Frontend Guide

The document outlines the API specifications for VAT Payment and Registration services, including endpoints for submitting payments and registration requests, as well as retrieving records. It provides details on request headers, body formats, and expected responses for both successful and unsuccessful operations. The VAT Payment API allows for payment submissions and retrieval of payment records, while the VAT Registration API facilitates new registration requests and approvals with unique acknowledgment numbers.

Uploaded by

Anirban Sarkar
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd

VAT Payment API Documenta on

Base URL

h p://[Link]

POST /payments

Descrip on: Submit a new VAT payment record.

Request Headers

Content-Type: applica on/json

Request Body (JSON)

" n": "12345678901",

"suspenseName": "Rahul Verma",

"regType": "Regular",

"paymentWith": "Net Banking",

"ackNo": "ACK123456789",

"amountToBePaid": 750.00,

"headOfAccount": "0045-00-800-03-01",

"paidTowards": "Penalty",

"mode": "Net Banking",

"courtFeeNo": "CF123456",

"paymentDate": "2025-07-01",

"micrCode": "998877665",

"remarks": "Paid with interest",

"amount": 750.00,

"interest": 50.00,

"penalty": 100.00

Successful Response (Status: 200 OK)

"paymentId": 3,
" n": "12345678901",

"suspenseName": "Rahul Verma",

"regType": "Regular",

"paymentWith": "Net Banking",

"ackNo": "ACK123456789",

"amountToBePaid": 750.00,

"headOfAccount": "0045-00-800-03-01",

"paidTowards": "Penalty",

"mode": "Net Banking",

"courtFeeNo": "CF123456",

"paymentDate": "2025-07-01",

"micrCode": "998877665",

"remarks": "Paid with interest",

"amount": 750.00,

"interest": 50.00,

"penalty": 100.00,

" mestamp": "2025-07-09T[Link].784414",

"createdAt": "2025-07-09T[Link].784353"

GET /payments

Descrip on: Retrieve all payment records.

Response (Status: 200 OK)

"paymentId": 1,

" n": "55566677799",

"suspenseName": "Kamalesh Chak",

"regType": "Voluntary",

"paymentWith": "UPI",

"ackNo": "ACK555666777",
"amountToBePaid": 500.00,

"headOfAccount": "0045-00-800-03-00",

"paidTowards": "Late Fee",

"mode": "UPI",

"courtFeeNo": "CF556677",

"paymentDate": "2025-06-01",

"micrCode": "112233445",

"remarks": "Cleared with no dues",

"amount": 500.00,

"interest": 0.00,

"penalty": 0.00,

" mestamp": "2025-07-02T[Link].22759",

"createdAt": "2025-07-02T[Link].22759"

},

"paymentId": 2,

" n": "55566677799",

"suspenseName": "Deep Saha",

"regType": "Voluntary",

"paymentWith": "UPI",

"ackNo": "ACK555666777",

"amountToBePaid": 500.00,

"headOfAccount": "0045-00-800-03-00",

"paidTowards": "Late Fee",

"mode": "UPI",

"courtFeeNo": "CF556677",

"paymentDate": "2025-06-01",

"micrCode": "112233445",

"remarks": "Cleared with no dues",

"amount": 500.00,

"interest": 0.00,
"penalty": 0.00,

" mestamp": "2025-07-01T[Link].834969",

"createdAt": "2025-07-01T[Link].834897"

},

"paymentId": 3,

" n": "12345678901",

"suspenseName": "Rahul Verma",

"regType": "Regular",

"paymentWith": "Net Banking",

"ackNo": "ACK123456789",

"amountToBePaid": 750.00,

"headOfAccount": "0045-00-800-03-01",

"paidTowards": "Penalty",

"mode": "Net Banking",

"courtFeeNo": "CF123456",

"paymentDate": "2025-07-01",

"micrCode": "998877665",

"remarks": "Paid with interest",

"amount": 750.00,

"interest": 50.00,

"penalty": 100.00,

" mestamp": "2025-07-09T[Link].784414",

"createdAt": "2025-07-09T[Link].784353"

]
VAT Registra on API Documenta on
Base URL

h ps://vat-registra [Link]

POST /api/registra on

Descrip on: Submit a new VAT registra on request.

Request Headers

Content-Type: applica on/json

Request Body (JSON)

"userId": 205,

"dateOfVisit": "2025-07-06",

"registra onType": "New",

"applicantName": "Arjun Das",

"tradeName": "Das Logis cs",

"status": "approved",

"inspectorReportFileUrl": "h ps://[Link]/inspector2_report_20000102.pdf"

Successful Response (Status: 200 OK)

"ackNumber": 20000001,

"userId": 205,

"dateOfVisit": "2025-07-06",

"registra onType": "New",

"applicantName": "Arjun Das",

"tradeName": "Das Logis cs",

"status": "approved",

"inspectorReportFileUrl": "h ps://[Link]/inspector2_report_20000102.pdf",

"createdAt": "2025-07-09T[Link].009965755Z",

" n": null


}

ackNumber is system-generated and unique


n will remain null un l approved

GET /api/registra on/{ackNumber}

Descrip on: Get the registra on record by acknowledgement number.

Sample URL

/api/registra on/20000001

Response

"ackNumber": 20000001,

"userId": 205,

"dateOfVisit": "2025-07-06",

"registra onType": "New",

"applicantName": "Arjun Das",

"tradeName": "Das Logis cs",

"status": "approved",

"inspectorReportFileUrl": "h ps://[Link]/inspector2_report_20000102.pdf",

"createdAt": "2025-07-09T[Link].009965755Z",

" n": null

PUT /api/registra on/{ackNumber}/approval

Descrip on: Approve a registra on and assign a TIN number.

Sample URL

/api/registra on/20000001/approval

Response

"newTin": "TIN1752086896847",

"success": true

You might also like