Class InvoicesApi

InvoicesApi - object-oriented interface

Hierarchy (View Summary)

BaseAPI
- InvoicesApi
  - InvoicesApiClient

Index

Constructors

constructor

new InvoicesApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): InvoicesApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns InvoicesApi
Inherited from BaseAPI.constructor
- Defined in api-model/base.ts:39

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: Configuration | undefined

Methods

createGovernmentInvoice

createGovernmentInvoice(
requestParameters: InvoicesApiCreateGovernmentInvoiceRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}, any>>
Submit an asynchronous request to create a government invoice.
Parameters
- requestParameters: InvoicesApiCreateGovernmentInvoiceRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}, any>>

Throws
- Defined in api-model/api/invoices-api.ts:1068

createInvoicesExport

createInvoicesExport(
requestParameters: InvoicesApiCreateInvoicesExportRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ExportInvoicesResponse, any, {}, any>>
Creates an invoice export request.
Parameters
- requestParameters: InvoicesApiCreateInvoicesExportRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ExportInvoicesResponse, any, {}, any>>

Throws
- Defined in api-model/api/invoices-api.ts:1078

getGovernmentInvoiceDocument

getGovernmentInvoiceDocument(
requestParameters: InvoicesApiGetGovernmentInvoiceDocumentRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<GovtInvoiceDocumentResponse, any, {}, any>>
Retrieve the URL of an invoice document.
Parameters
- requestParameters: InvoicesApiGetGovernmentInvoiceDocumentRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GovtInvoiceDocumentResponse, any, {}, any>>

Throws
- Defined in api-model/api/invoices-api.ts:1088

getGovernmentInvoiceStatus

getGovernmentInvoiceStatus(
requestParameters: InvoicesApiGetGovernmentInvoiceStatusRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<GovernmentInvoiceStatusResponse, any, {}, any>>
Retrieve the status of an invoice generation request.
Parameters
- requestParameters: InvoicesApiGetGovernmentInvoiceStatusRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GovernmentInvoiceStatusResponse, any, {}, any>>

Throws
- Defined in api-model/api/invoices-api.ts:1098

getInvoice

getInvoice(
requestParameters: InvoicesApiGetInvoiceRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<GetInvoiceResponse, any, {}, any>>
Returns invoice data for the specified invoice. This operation returns only a subset of the invoices data; refer to the response definition to get all the possible attributes. To get the full invoice, use the createInvoicesExport operation to start an export request.
Parameters
- requestParameters: InvoicesApiGetInvoiceRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GetInvoiceResponse, any, {}, any>>

Throws
- Defined in api-model/api/invoices-api.ts:1108

getInvoices

getInvoices(
requestParameters: InvoicesApiGetInvoicesRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<GetInvoicesResponse, any, {}, any>>
Returns invoice details for the invoices that match the filters that you specify.
Parameters
- requestParameters: InvoicesApiGetInvoicesRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GetInvoicesResponse, any, {}, any>>

Throws
- Defined in api-model/api/invoices-api.ts:1118

getInvoicesAttributes

getInvoicesAttributes(
requestParameters: InvoicesApiGetInvoicesAttributesRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<GetInvoicesAttributesResponse, any, {}, any>>
Returns marketplace-dependent schemas and their respective set of possible values.
Parameters
- requestParameters: InvoicesApiGetInvoicesAttributesRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GetInvoicesAttributesResponse, any, {}, any>>

Throws
- Defined in api-model/api/invoices-api.ts:1128

getInvoicesDocument

getInvoicesDocument(
requestParameters: InvoicesApiGetInvoicesDocumentRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<GetInvoicesDocumentResponse, any, {}, any>>
Returns the invoice document's ID and URL. Use the URL to download the ZIP file, which contains the invoices from the corresponding createInvoicesExport request.
Parameters
- requestParameters: InvoicesApiGetInvoicesDocumentRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GetInvoicesDocumentResponse, any, {}, any>>

Throws
- Defined in api-model/api/invoices-api.ts:1138

getInvoicesExport

getInvoicesExport(
requestParameters: InvoicesApiGetInvoicesExportRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<GetInvoicesExportResponse, any, {}, any>>
Returns invoice export details (including the exportDocumentId, if available) for the export that you specify.
Parameters
- requestParameters: InvoicesApiGetInvoicesExportRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GetInvoicesExportResponse, any, {}, any>>

Throws
- Defined in api-model/api/invoices-api.ts:1148

getInvoicesExports

getInvoicesExports(
requestParameters: InvoicesApiGetInvoicesExportsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<GetInvoicesExportsResponse, any, {}, any>>
Returns invoice exports details for exports that match the filters that you specify.
Parameters
- requestParameters: InvoicesApiGetInvoicesExportsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GetInvoicesExportsResponse, any, {}, any>>

Throws
- Defined in api-model/api/invoices-api.ts:1158

Class InvoicesApi

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns InvoicesApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

createGovernmentInvoice

Parameters

Returns Promise<AxiosResponse<void, any, {}, any>>

Throws

createInvoicesExport

Parameters

Returns Promise<AxiosResponse<ExportInvoicesResponse, any, {}, any>>

Throws

getGovernmentInvoiceDocument

Parameters

Returns Promise<AxiosResponse<GovtInvoiceDocumentResponse, any, {}, any>>

Throws

getGovernmentInvoiceStatus

Parameters

Returns Promise<AxiosResponse<GovernmentInvoiceStatusResponse, any, {}, any>>

Throws

getInvoice

Parameters

Returns Promise<AxiosResponse<GetInvoiceResponse, any, {}, any>>

Throws

getInvoices

Parameters

Returns Promise<AxiosResponse<GetInvoicesResponse, any, {}, any>>

Throws

getInvoicesAttributes

Parameters

Returns Promise<AxiosResponse<GetInvoicesAttributesResponse, any, {}, any>>

Throws

getInvoicesDocument

Parameters

Returns Promise<AxiosResponse<GetInvoicesDocumentResponse, any, {}, any>>

Throws

getInvoicesExport

Parameters

Returns Promise<AxiosResponse<GetInvoicesExportResponse, any, {}, any>>

Throws

getInvoicesExports

Parameters

Returns Promise<AxiosResponse<GetInvoicesExportsResponse, any, {}, any>>

Throws

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration