data-and-reporting-sdk
Version:
Data And Reporting product consists of API's which provides details of transaction and invoice informations about shell cards. The Shell Card Transaction and Invoice API is REST-based and employs Basic authentication in Version 1 and Oauth authentication
195 lines • 9.88 kB
TypeScript
/**
* Shell Data & Reporting APIsLib
*
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
*/
import { ApiResponse, RequestOptions } from '../core.js';
import { EIDDocumentResponse } from '../models/eIDDocumentResponse.js';
import { EIDDownloadRequest } from '../models/eIDDownloadRequest.js';
import { EIDSearchRequest } from '../models/eIDSearchRequest.js';
import { InvoiceDatesRequest } from '../models/invoiceDatesRequest.js';
import { InvoiceDatesResponseData } from '../models/invoiceDatesResponseData.js';
import { InvoiceDownloadRequest } from '../models/invoiceDownloadRequest.js';
import { InvoiceSearchRequest } from '../models/invoiceSearchRequest.js';
import { InvoiceSearchResponse } from '../models/invoiceSearchResponse.js';
import { InvoiceSummaryRequest } from '../models/invoiceSummaryRequest.js';
import { InvoiceSummaryResponse } from '../models/invoiceSummaryResponse.js';
import { SearchDocumentsRequest } from '../models/searchDocumentsRequest.js';
import { SearchDocumentsResponse } from '../models/searchDocumentsResponse.js';
import { SearchStatementOfAccountRequest } from '../models/searchStatementOfAccountRequest.js';
import { SearchStatementOfAccountResponse } from '../models/searchStatementOfAccountResponse.js';
import { StatementOfAccountRequest } from '../models/statementOfAccountRequest.js';
import { StatementOfAccountResponse } from '../models/statementOfAccountResponse.js';
import { BaseController } from './baseController.js';
export declare class InvoiceController extends BaseController {
/**
* This API allows to search invoice data in the Shell Card Platform. It provides flexible search
* criteria in the request body and supports paging.
*
*
*
* This API will also query the relevant invoice documents list and return a reference number that can
* be used to download invoice documents (PDF and Proofing elements in a zip file).
*
*
*
* #### Supported operations
*
* * Search invoices by account
*
* * Search invoices by invoice type or invoice status
*
* * Search invoices by invoice id or number
*
* * Search invoices by invoiced country
*
* * Search invoices including einvoices
*
* * Search invoices by summary document
*
* * Search invoices by statement of account
*
* * Search invoices by fixed and custom date periods
*
* @param requestId Mandatory UUID (according to RFC 4122 standards) for requests
* and responses. This will be played back in the response from
* the request.
* @param body Invoice Search RequestBody
* @return Response from the API call
*/
invoiceSearch(requestId: string, body?: InvoiceSearchRequest, requestOptions?: RequestOptions): Promise<ApiResponse<InvoiceSearchResponse>>;
/**
* This API returns the high level summary of invoices that match the given search criteria. The same
* search criteria as the endpoint `/v1/invoice/search` is supported with the exception of paging
* related parameters.
*
*
*
*
*
* #### Supported operations
*
* * Search invoices by account
*
* * Search invoices by invoice type or invoice status
*
* * Search invoices by invoice id or number
*
* * Search invoices by invoiced country
*
* * Search invoices including einvoices
*
* * Search invoices by summary document
*
* * Search invoices by statement of account
*
* * Search invoices by fixed and custom date periods
*
* @param requestId Mandatory UUID (according to RFC 4122 standards) for requests
* and responses. This will be played back in the response from
* the request.
* @param body Invoice Search RequestBody
* @return Response from the API call
*/
invoiceSummary(requestId: string, body?: InvoiceSummaryRequest, requestOptions?: RequestOptions): Promise<ApiResponse<InvoiceSummaryResponse>>;
/**
* This API allows querying the details of the latest statement of account (SOA) generated for a given
* Payer.
*
*
*
* The endpoint supports querying SOA documents by various input parameters specified in the request
* body.
*
*
*
* #### Supported operations
*
* * Search invoice SOA by payer and account
*
* * Search invoice SOA including monthly trend (last 13 months invocie trend summary)
*
* * Search invoice SOA including past SOAs
*
* * Search invoice SOA including due/overdue documents
*
* * Search invoice SOA including invoice summary
*
* @param requestId Mandatory UUID (according to RFC 4122 standards) for
* requests and responses. This will be played back in the
* response from the request.
* @param body StatementOfAccount RequestBody
* @return Response from the API call
*/
statementOfAccount(requestId: string, body?: StatementOfAccountRequest, requestOptions?: RequestOptions): Promise<ApiResponse<StatementOfAccountResponse>>;
/**
* - This API will return the list of Invoice Dates and Numbers for the given date range. If the dates
* are not provided then it will fetch the data for past 13 months.
*
* @param requestId Mandatory UUID (according to RFC 4122 standards) for requests
* and responses. This will be played back in the response from the
* request.
* @param body StatementOfAccount RequestBody
* @return Response from the API call
*/
dates(requestId: string, body?: InvoiceDatesRequest, requestOptions?: RequestOptions): Promise<ApiResponse<InvoiceDatesResponseData>>;
/**
* - This API will allow querying of SOA from different systems
*
* @param requestId Mandatory UUID (according to RFC 4122 standards)
* for requests and responses. This will be played back
* in the response from the request.
* @param body searchstatementofaccount RequestBody
* @return Response from the API call
*/
searchStatementOfAccount(requestId: string, body?: SearchStatementOfAccountRequest, requestOptions?: RequestOptions): Promise<ApiResponse<SearchStatementOfAccountResponse>>;
/**
* - This API allows querying the details of all invoices successfully uploaded to the Worldline
* invoice repository and file reference numbers for downloading.
*
* @param requestId Mandatory UUID (according to RFC 4122 standards) for
* requests and responses. This will be played back in the
* response from the request.
* @param body SearchDocuments RequestBody
* @return Response from the API call
*/
searchDocuments(requestId: string, body?: SearchDocumentsRequest, requestOptions?: RequestOptions): Promise<ApiResponse<SearchDocumentsResponse>>;
/**
* - This API provides the functionality needed for the screen “EID FILES” in the web interface. It
* allows retrieving a list of EIDs based on search criteria.
*
* @param requestId Mandatory UUID (according to RFC 4122 standards) for requests and
* responses. This will be played back in the response from the
* request.
* @param body EIDSearch RequestBody
* @return Response from the API call
*/
eidSearch(requestId: string, body?: EIDSearchRequest, requestOptions?: RequestOptions): Promise<ApiResponse<EIDDocumentResponse>>;
/**
* - This API downloads Invoice Documents i.e., ZIP file with Invoice PDF file and Proofing Elements in
* XML format from invoice repository.
*
* @param requestId Mandatory UUID (according to RFC 4122 standards) for
* requests and responses. This will be played back in the
* response from the request.
* @param body Invoice Download RequestBody
* @return Response from the API call
*/
download(requestId: string, body?: InvoiceDownloadRequest, requestOptions?: RequestOptions): Promise<ApiResponse<NodeJS.ReadableStream | Blob>>;
/**
* - This service allows downloading one or more EID documents and the corresponding signature material
* (where applicable) in one single request
*
* - The number of EID that can be downloaded at once is limited to 100 documents.
*
*
*
* @param requestId Mandatory UUID (according to RFC 4122 standards) for requests
* and responses. This will be played back in the response from the
* request.
* @param body EIDInvoice Download RequestBody
* @return Response from the API call
*/
eidDownload(requestId: string, body?: EIDDownloadRequest, requestOptions?: RequestOptions): Promise<ApiResponse<NodeJS.ReadableStream | Blob>>;
}
//# sourceMappingURL=invoiceController.d.ts.map