☰The StavPay API is an Application Programming Interface (API) designed to allow external systems to interact with and retrieve data securely and efficiently.
The API provides resource-oriented endpoints, making it easy to integrate and develop applications.
Resources
Contract
The Contract endpoint offers comprehensive access to contract data, enabling users to retrieve both a paginated list of summaries and the detailed information for a specific contract. When fetching a list, the endpoint supports pagination through limit and cursor parameters, and allows for precise results by filtering and sorting with sort and order options.
For a more in-depth view, a single contract can be retrieved by its unique contractId. This detailed request can be enhanced using the expand parameter to include related data such as accruals, communications, documents, invoices, and services directly within the response.
Invoice
The Invoice endpoint provides comprehensive access to invoice data, allowing users to retrieve both a summarized list and detailed information for a single invoice. To fetch a list, the endpoint supports pagination via limit and cursor parameters. The results can be refined by filtering and sorting.
For an in-depth view, the endpoint can retrieve the full details of a specific invoice when requested with its unique invoiceId.
Vendor
The Vendor endpoint provides comprehensive access to vendor data, allowing users to retrieve both a summarized list of vendors and a detailed profile for a specific vendor. To fetch a list, the endpoint supports pagination through limit and cursor parameters, making it efficient to navigate through large datasets. Results can be filtered by the vendor's active status and sorted using sort and order fields.
For an in-depth view, the endpoint can retrieve the full details of a specific vendor using its vendorId. This detailed request can be further enriched by using the expand parameter to include related data such as documents, paymentDetails, contracts, invoices, configuration, and auditHistory directly in the response.