@sp-api-sdk/invoices-api-2024-06-19 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +97 -0
- package/dist/cjs/index.js +19 -0
- package/dist/cjs/src/api-model/api/invoices-api.js +610 -0
- package/dist/cjs/src/api-model/api.js +30 -0
- package/dist/cjs/src/api-model/base.js +71 -0
- package/dist/cjs/src/api-model/common.js +145 -0
- package/dist/cjs/src/api-model/configuration.js +99 -0
- package/dist/cjs/src/api-model/index.js +32 -0
- package/dist/cjs/src/api-model/models/attribute-option.js +15 -0
- package/dist/cjs/src/api-model/models/error-list.js +15 -0
- package/dist/cjs/src/api-model/models/export-invoices-request.js +15 -0
- package/dist/cjs/src/api-model/models/export-invoices-response.js +15 -0
- package/dist/cjs/src/api-model/models/export-status.js +27 -0
- package/dist/cjs/src/api-model/models/export.js +15 -0
- package/dist/cjs/src/api-model/models/file-format.js +24 -0
- package/dist/cjs/src/api-model/models/get-invoice-response.js +15 -0
- package/dist/cjs/src/api-model/models/get-invoices-attributes-response.js +15 -0
- package/dist/cjs/src/api-model/models/get-invoices-document-response.js +15 -0
- package/dist/cjs/src/api-model/models/get-invoices-export-response.js +15 -0
- package/dist/cjs/src/api-model/models/get-invoices-exports-response.js +15 -0
- package/dist/cjs/src/api-model/models/get-invoices-response.js +15 -0
- package/dist/cjs/src/api-model/models/index.js +34 -0
- package/dist/cjs/src/api-model/models/invoice.js +15 -0
- package/dist/cjs/src/api-model/models/invoices-attributes.js +15 -0
- package/dist/cjs/src/api-model/models/invoices-document.js +15 -0
- package/dist/cjs/src/api-model/models/model-error.js +15 -0
- package/dist/cjs/src/api-model/models/transaction-identifier.js +15 -0
- package/dist/cjs/src/client.js +63 -0
- package/dist/es/index.js +3 -0
- package/dist/es/src/api-model/api/invoices-api.js +600 -0
- package/dist/es/src/api-model/api.js +14 -0
- package/dist/es/src/api-model/base.js +63 -0
- package/dist/es/src/api-model/common.js +133 -0
- package/dist/es/src/api-model/configuration.js +95 -0
- package/dist/es/src/api-model/index.js +16 -0
- package/dist/es/src/api-model/models/attribute-option.js +14 -0
- package/dist/es/src/api-model/models/error-list.js +14 -0
- package/dist/es/src/api-model/models/export-invoices-request.js +14 -0
- package/dist/es/src/api-model/models/export-invoices-response.js +14 -0
- package/dist/es/src/api-model/models/export-status.js +24 -0
- package/dist/es/src/api-model/models/export.js +14 -0
- package/dist/es/src/api-model/models/file-format.js +21 -0
- package/dist/es/src/api-model/models/get-invoice-response.js +14 -0
- package/dist/es/src/api-model/models/get-invoices-attributes-response.js +14 -0
- package/dist/es/src/api-model/models/get-invoices-document-response.js +14 -0
- package/dist/es/src/api-model/models/get-invoices-export-response.js +14 -0
- package/dist/es/src/api-model/models/get-invoices-exports-response.js +14 -0
- package/dist/es/src/api-model/models/get-invoices-response.js +14 -0
- package/dist/es/src/api-model/models/index.js +18 -0
- package/dist/es/src/api-model/models/invoice.js +14 -0
- package/dist/es/src/api-model/models/invoices-attributes.js +14 -0
- package/dist/es/src/api-model/models/invoices-document.js +14 -0
- package/dist/es/src/api-model/models/model-error.js +14 -0
- package/dist/es/src/api-model/models/transaction-identifier.js +14 -0
- package/dist/es/src/client.js +59 -0
- package/dist/types/index.d.ts +3 -0
- package/dist/types/src/api-model/api/invoices-api.d.ts +520 -0
- package/dist/types/src/api-model/api.d.ts +12 -0
- package/dist/types/src/api-model/base.d.ts +66 -0
- package/dist/types/src/api-model/common.d.ts +65 -0
- package/dist/types/src/api-model/configuration.d.ts +91 -0
- package/dist/types/src/api-model/index.d.ts +14 -0
- package/dist/types/src/api-model/models/attribute-option.d.ts +30 -0
- package/dist/types/src/api-model/models/error-list.d.ts +24 -0
- package/dist/types/src/api-model/models/export-invoices-request.d.ts +80 -0
- package/dist/types/src/api-model/models/export-invoices-response.d.ts +24 -0
- package/dist/types/src/api-model/models/export-status.d.ts +23 -0
- package/dist/types/src/api-model/models/export.d.ts +55 -0
- package/dist/types/src/api-model/models/file-format.d.ts +20 -0
- package/dist/types/src/api-model/models/get-invoice-response.d.ts +25 -0
- package/dist/types/src/api-model/models/get-invoices-attributes-response.d.ts +25 -0
- package/dist/types/src/api-model/models/get-invoices-document-response.d.ts +25 -0
- package/dist/types/src/api-model/models/get-invoices-export-response.d.ts +25 -0
- package/dist/types/src/api-model/models/get-invoices-exports-response.d.ts +31 -0
- package/dist/types/src/api-model/models/get-invoices-response.d.ts +31 -0
- package/dist/types/src/api-model/models/index.d.ts +18 -0
- package/dist/types/src/api-model/models/invoice.d.ts +79 -0
- package/dist/types/src/api-model/models/invoices-attributes.d.ts +43 -0
- package/dist/types/src/api-model/models/invoices-document.d.ts +30 -0
- package/dist/types/src/api-model/models/model-error.d.ts +36 -0
- package/dist/types/src/api-model/models/transaction-identifier.d.ts +30 -0
- package/dist/types/src/client.d.ts +6 -0
- package/package.json +44 -0
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
import { createAxiosInstance } from '@sp-api-sdk/common';
|
|
2
|
+
import { Configuration, InvoicesApi } from './api-model';
|
|
3
|
+
export const clientRateLimits = [
|
|
4
|
+
{
|
|
5
|
+
method: 'get',
|
|
6
|
+
// eslint-disable-next-line prefer-regex-literals
|
|
7
|
+
urlRegex: new RegExp('^/tax/invoices/2024-06-19/attributes$'),
|
|
8
|
+
rate: 1,
|
|
9
|
+
burst: 1,
|
|
10
|
+
},
|
|
11
|
+
{
|
|
12
|
+
method: 'get',
|
|
13
|
+
// eslint-disable-next-line prefer-regex-literals
|
|
14
|
+
urlRegex: new RegExp('^/tax/invoices/2024-06-19/documents/[^/]*$'),
|
|
15
|
+
rate: 0.0167,
|
|
16
|
+
burst: 1,
|
|
17
|
+
},
|
|
18
|
+
{
|
|
19
|
+
method: 'post',
|
|
20
|
+
// eslint-disable-next-line prefer-regex-literals
|
|
21
|
+
urlRegex: new RegExp('^/tax/invoices/2024-06-19/exports$'),
|
|
22
|
+
rate: 0.167,
|
|
23
|
+
burst: 1,
|
|
24
|
+
},
|
|
25
|
+
{
|
|
26
|
+
method: 'get',
|
|
27
|
+
// eslint-disable-next-line prefer-regex-literals
|
|
28
|
+
urlRegex: new RegExp('^/tax/invoices/2024-06-19/exports$'),
|
|
29
|
+
rate: 0.1,
|
|
30
|
+
burst: 20,
|
|
31
|
+
},
|
|
32
|
+
{
|
|
33
|
+
method: 'get',
|
|
34
|
+
// eslint-disable-next-line prefer-regex-literals
|
|
35
|
+
urlRegex: new RegExp('^/tax/invoices/2024-06-19/exports/[^/]*$'),
|
|
36
|
+
rate: 2,
|
|
37
|
+
burst: 15,
|
|
38
|
+
},
|
|
39
|
+
{
|
|
40
|
+
method: 'get',
|
|
41
|
+
// eslint-disable-next-line prefer-regex-literals
|
|
42
|
+
urlRegex: new RegExp('^/tax/invoices/2024-06-19/invoices$'),
|
|
43
|
+
rate: 0.1,
|
|
44
|
+
burst: 20,
|
|
45
|
+
},
|
|
46
|
+
{
|
|
47
|
+
method: 'get',
|
|
48
|
+
// eslint-disable-next-line prefer-regex-literals
|
|
49
|
+
urlRegex: new RegExp('^/tax/invoices/2024-06-19/invoices/[^/]*$'),
|
|
50
|
+
rate: 2,
|
|
51
|
+
burst: 15,
|
|
52
|
+
},
|
|
53
|
+
];
|
|
54
|
+
export class InvoicesApiClient extends InvoicesApi {
|
|
55
|
+
constructor(configuration) {
|
|
56
|
+
const { axios, endpoint } = createAxiosInstance(configuration, clientRateLimits);
|
|
57
|
+
super(new Configuration(), endpoint, axios);
|
|
58
|
+
}
|
|
59
|
+
}
|
|
@@ -0,0 +1,520 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The Selling Partner API for Invoices.
|
|
3
|
+
* Use the Selling Partner API for Invoices to retrieve and manage invoice-related operations, which can help selling partners manage their bookkeeping processes.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2024-06-19
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { Configuration } from '../configuration';
|
|
13
|
+
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
|
+
import globalAxios from 'axios';
|
|
15
|
+
import { type RequestArgs, BaseAPI } from '../base';
|
|
16
|
+
import type { ExportInvoicesRequest } from '../models';
|
|
17
|
+
import type { ExportInvoicesResponse } from '../models';
|
|
18
|
+
import type { GetInvoiceResponse } from '../models';
|
|
19
|
+
import type { GetInvoicesAttributesResponse } from '../models';
|
|
20
|
+
import type { GetInvoicesDocumentResponse } from '../models';
|
|
21
|
+
import type { GetInvoicesExportResponse } from '../models';
|
|
22
|
+
import type { GetInvoicesExportsResponse } from '../models';
|
|
23
|
+
import type { GetInvoicesResponse } from '../models';
|
|
24
|
+
/**
|
|
25
|
+
* InvoicesApi - axios parameter creator
|
|
26
|
+
* @export
|
|
27
|
+
*/
|
|
28
|
+
export declare const InvoicesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
29
|
+
/**
|
|
30
|
+
* Creates an invoice export request. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.167 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
31
|
+
* @param {ExportInvoicesRequest} body Information required to create the export request.
|
|
32
|
+
* @param {*} [options] Override http request option.
|
|
33
|
+
* @throws {RequiredError}
|
|
34
|
+
*/
|
|
35
|
+
createInvoicesExport: (body: ExportInvoicesRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
36
|
+
/**
|
|
37
|
+
* 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. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
38
|
+
* @param {string} marketplaceId The marketplace from which you want the invoice.
|
|
39
|
+
* @param {string} invoiceId The invoice identifier.
|
|
40
|
+
* @param {*} [options] Override http request option.
|
|
41
|
+
* @throws {RequiredError}
|
|
42
|
+
*/
|
|
43
|
+
getInvoice: (marketplaceId: string, invoiceId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
44
|
+
/**
|
|
45
|
+
* Returns invoice details for the invoices that match the filters that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.1 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
46
|
+
* @param {string} marketplaceId The response includes only the invoices that match the specified marketplace.
|
|
47
|
+
* @param {string} [transactionIdentifierName] The name of the transaction identifier filter. If you provide a value for this field, you must also provide a value for the `transactionIdentifierId` field.Use the `getInvoicesAttributes` operation to check `transactionIdentifierName` options.
|
|
48
|
+
* @param {number} [pageSize] The maximum number of invoices you want to return in a single call. Minimum: 1 Maximum: 200
|
|
49
|
+
* @param {string} [dateEnd] The latest invoice creation date for invoices that you want to include in the response. Dates are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The default is the current date-time.
|
|
50
|
+
* @param {string} [transactionType] The marketplace-specific classification of the transaction type for which the invoice was created. Use the `getInvoicesAttributes` operation to check `transactionType` options.
|
|
51
|
+
* @param {string} [transactionIdentifierId] The ID of the transaction identifier filter. If you provide a value for this field, you must also provide a value for the `transactionIdentifierName` field.
|
|
52
|
+
* @param {string} [dateStart] The earliest invoice creation date for invoices that you want to include in the response. Dates are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The default is 24 hours prior to the time of the request.
|
|
53
|
+
* @param {string} [series] Return invoices with the specified series number.
|
|
54
|
+
* @param {string} [nextToken] The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
|
|
55
|
+
* @param {GetInvoicesSortOrderEnum} [sortOrder] Sort the invoices in the response in ascending or descending order.
|
|
56
|
+
* @param {string} [invoiceType] The marketplace-specific classification of the invoice type. Use the `getInvoicesAttributes` operation to check `invoiceType` options.
|
|
57
|
+
* @param {Array<string>} [statuses] A list of statuses that you can use to filter invoices. Use the `getInvoicesAttributes` operation to check invoice status options. Min count: 1
|
|
58
|
+
* @param {string} [externalInvoiceId] Return invoices that match this external ID. This is typically the Government Invoice ID.
|
|
59
|
+
* @param {GetInvoicesSortByEnum} [sortBy] The attribute by which you want to sort the invoices in the response.
|
|
60
|
+
* @param {*} [options] Override http request option.
|
|
61
|
+
* @throws {RequiredError}
|
|
62
|
+
*/
|
|
63
|
+
getInvoices: (marketplaceId: string, transactionIdentifierName?: string, pageSize?: number, dateEnd?: string, transactionType?: string, transactionIdentifierId?: string, dateStart?: string, series?: string, nextToken?: string, sortOrder?: GetInvoicesSortOrderEnum, invoiceType?: string, statuses?: Array<string>, externalInvoiceId?: string, sortBy?: GetInvoicesSortByEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
64
|
+
/**
|
|
65
|
+
* Returns marketplace-dependent schemas and their respective set of possible values. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
66
|
+
* @param {string} marketplaceId The marketplace identifier.
|
|
67
|
+
* @param {*} [options] Override http request option.
|
|
68
|
+
* @throws {RequiredError}
|
|
69
|
+
*/
|
|
70
|
+
getInvoicesAttributes: (marketplaceId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
71
|
+
/**
|
|
72
|
+
* 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. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
73
|
+
* @param {string} invoicesDocumentId The export document identifier.
|
|
74
|
+
* @param {*} [options] Override http request option.
|
|
75
|
+
* @throws {RequiredError}
|
|
76
|
+
*/
|
|
77
|
+
getInvoicesDocument: (invoicesDocumentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
78
|
+
/**
|
|
79
|
+
* Returns invoice export details (including the `exportDocumentId`, if available) for the export that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
80
|
+
* @param {string} exportId The unique identifier for the export.
|
|
81
|
+
* @param {*} [options] Override http request option.
|
|
82
|
+
* @throws {RequiredError}
|
|
83
|
+
*/
|
|
84
|
+
getInvoicesExport: (exportId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
85
|
+
/**
|
|
86
|
+
* Returns invoice exports details for exports that match the filters that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.1 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
87
|
+
* @param {string} marketplaceId The returned exports match the specified marketplace.
|
|
88
|
+
* @param {string} [dateStart] The earliest export creation date and time for exports that you want to include in the response. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The default is 30 days ago.
|
|
89
|
+
* @param {string} [nextToken] The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
|
|
90
|
+
* @param {number} [pageSize] The maximum number of invoices to return in a single call. Minimum: 1 Maximum: 100
|
|
91
|
+
* @param {string} [dateEnd] The latest export creation date and time for exports that you want to include in the response. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The default value is the time of the request.
|
|
92
|
+
* @param {GetInvoicesExportsStatusEnum} [status] Return exports matching the status specified.
|
|
93
|
+
* @param {*} [options] Override http request option.
|
|
94
|
+
* @throws {RequiredError}
|
|
95
|
+
*/
|
|
96
|
+
getInvoicesExports: (marketplaceId: string, dateStart?: string, nextToken?: string, pageSize?: number, dateEnd?: string, status?: GetInvoicesExportsStatusEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
97
|
+
};
|
|
98
|
+
/**
|
|
99
|
+
* InvoicesApi - functional programming interface
|
|
100
|
+
* @export
|
|
101
|
+
*/
|
|
102
|
+
export declare const InvoicesApiFp: (configuration?: Configuration) => {
|
|
103
|
+
/**
|
|
104
|
+
* Creates an invoice export request. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.167 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
105
|
+
* @param {ExportInvoicesRequest} body Information required to create the export request.
|
|
106
|
+
* @param {*} [options] Override http request option.
|
|
107
|
+
* @throws {RequiredError}
|
|
108
|
+
*/
|
|
109
|
+
createInvoicesExport(body: ExportInvoicesRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExportInvoicesResponse>>;
|
|
110
|
+
/**
|
|
111
|
+
* 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. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
112
|
+
* @param {string} marketplaceId The marketplace from which you want the invoice.
|
|
113
|
+
* @param {string} invoiceId The invoice identifier.
|
|
114
|
+
* @param {*} [options] Override http request option.
|
|
115
|
+
* @throws {RequiredError}
|
|
116
|
+
*/
|
|
117
|
+
getInvoice(marketplaceId: string, invoiceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetInvoiceResponse>>;
|
|
118
|
+
/**
|
|
119
|
+
* Returns invoice details for the invoices that match the filters that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.1 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
120
|
+
* @param {string} marketplaceId The response includes only the invoices that match the specified marketplace.
|
|
121
|
+
* @param {string} [transactionIdentifierName] The name of the transaction identifier filter. If you provide a value for this field, you must also provide a value for the `transactionIdentifierId` field.Use the `getInvoicesAttributes` operation to check `transactionIdentifierName` options.
|
|
122
|
+
* @param {number} [pageSize] The maximum number of invoices you want to return in a single call. Minimum: 1 Maximum: 200
|
|
123
|
+
* @param {string} [dateEnd] The latest invoice creation date for invoices that you want to include in the response. Dates are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The default is the current date-time.
|
|
124
|
+
* @param {string} [transactionType] The marketplace-specific classification of the transaction type for which the invoice was created. Use the `getInvoicesAttributes` operation to check `transactionType` options.
|
|
125
|
+
* @param {string} [transactionIdentifierId] The ID of the transaction identifier filter. If you provide a value for this field, you must also provide a value for the `transactionIdentifierName` field.
|
|
126
|
+
* @param {string} [dateStart] The earliest invoice creation date for invoices that you want to include in the response. Dates are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The default is 24 hours prior to the time of the request.
|
|
127
|
+
* @param {string} [series] Return invoices with the specified series number.
|
|
128
|
+
* @param {string} [nextToken] The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
|
|
129
|
+
* @param {GetInvoicesSortOrderEnum} [sortOrder] Sort the invoices in the response in ascending or descending order.
|
|
130
|
+
* @param {string} [invoiceType] The marketplace-specific classification of the invoice type. Use the `getInvoicesAttributes` operation to check `invoiceType` options.
|
|
131
|
+
* @param {Array<string>} [statuses] A list of statuses that you can use to filter invoices. Use the `getInvoicesAttributes` operation to check invoice status options. Min count: 1
|
|
132
|
+
* @param {string} [externalInvoiceId] Return invoices that match this external ID. This is typically the Government Invoice ID.
|
|
133
|
+
* @param {GetInvoicesSortByEnum} [sortBy] The attribute by which you want to sort the invoices in the response.
|
|
134
|
+
* @param {*} [options] Override http request option.
|
|
135
|
+
* @throws {RequiredError}
|
|
136
|
+
*/
|
|
137
|
+
getInvoices(marketplaceId: string, transactionIdentifierName?: string, pageSize?: number, dateEnd?: string, transactionType?: string, transactionIdentifierId?: string, dateStart?: string, series?: string, nextToken?: string, sortOrder?: GetInvoicesSortOrderEnum, invoiceType?: string, statuses?: Array<string>, externalInvoiceId?: string, sortBy?: GetInvoicesSortByEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetInvoicesResponse>>;
|
|
138
|
+
/**
|
|
139
|
+
* Returns marketplace-dependent schemas and their respective set of possible values. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
140
|
+
* @param {string} marketplaceId The marketplace identifier.
|
|
141
|
+
* @param {*} [options] Override http request option.
|
|
142
|
+
* @throws {RequiredError}
|
|
143
|
+
*/
|
|
144
|
+
getInvoicesAttributes(marketplaceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetInvoicesAttributesResponse>>;
|
|
145
|
+
/**
|
|
146
|
+
* 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. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
147
|
+
* @param {string} invoicesDocumentId The export document identifier.
|
|
148
|
+
* @param {*} [options] Override http request option.
|
|
149
|
+
* @throws {RequiredError}
|
|
150
|
+
*/
|
|
151
|
+
getInvoicesDocument(invoicesDocumentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetInvoicesDocumentResponse>>;
|
|
152
|
+
/**
|
|
153
|
+
* Returns invoice export details (including the `exportDocumentId`, if available) for the export that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
154
|
+
* @param {string} exportId The unique identifier for the export.
|
|
155
|
+
* @param {*} [options] Override http request option.
|
|
156
|
+
* @throws {RequiredError}
|
|
157
|
+
*/
|
|
158
|
+
getInvoicesExport(exportId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetInvoicesExportResponse>>;
|
|
159
|
+
/**
|
|
160
|
+
* Returns invoice exports details for exports that match the filters that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.1 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
161
|
+
* @param {string} marketplaceId The returned exports match the specified marketplace.
|
|
162
|
+
* @param {string} [dateStart] The earliest export creation date and time for exports that you want to include in the response. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The default is 30 days ago.
|
|
163
|
+
* @param {string} [nextToken] The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
|
|
164
|
+
* @param {number} [pageSize] The maximum number of invoices to return in a single call. Minimum: 1 Maximum: 100
|
|
165
|
+
* @param {string} [dateEnd] The latest export creation date and time for exports that you want to include in the response. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The default value is the time of the request.
|
|
166
|
+
* @param {GetInvoicesExportsStatusEnum} [status] Return exports matching the status specified.
|
|
167
|
+
* @param {*} [options] Override http request option.
|
|
168
|
+
* @throws {RequiredError}
|
|
169
|
+
*/
|
|
170
|
+
getInvoicesExports(marketplaceId: string, dateStart?: string, nextToken?: string, pageSize?: number, dateEnd?: string, status?: GetInvoicesExportsStatusEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetInvoicesExportsResponse>>;
|
|
171
|
+
};
|
|
172
|
+
/**
|
|
173
|
+
* InvoicesApi - factory interface
|
|
174
|
+
* @export
|
|
175
|
+
*/
|
|
176
|
+
export declare const InvoicesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
177
|
+
/**
|
|
178
|
+
* Creates an invoice export request. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.167 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
179
|
+
* @param {InvoicesApiCreateInvoicesExportRequest} requestParameters Request parameters.
|
|
180
|
+
* @param {*} [options] Override http request option.
|
|
181
|
+
* @throws {RequiredError}
|
|
182
|
+
*/
|
|
183
|
+
createInvoicesExport(requestParameters: InvoicesApiCreateInvoicesExportRequest, options?: RawAxiosRequestConfig): AxiosPromise<ExportInvoicesResponse>;
|
|
184
|
+
/**
|
|
185
|
+
* 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. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
186
|
+
* @param {InvoicesApiGetInvoiceRequest} requestParameters Request parameters.
|
|
187
|
+
* @param {*} [options] Override http request option.
|
|
188
|
+
* @throws {RequiredError}
|
|
189
|
+
*/
|
|
190
|
+
getInvoice(requestParameters: InvoicesApiGetInvoiceRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetInvoiceResponse>;
|
|
191
|
+
/**
|
|
192
|
+
* Returns invoice details for the invoices that match the filters that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.1 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
193
|
+
* @param {InvoicesApiGetInvoicesRequest} requestParameters Request parameters.
|
|
194
|
+
* @param {*} [options] Override http request option.
|
|
195
|
+
* @throws {RequiredError}
|
|
196
|
+
*/
|
|
197
|
+
getInvoices(requestParameters: InvoicesApiGetInvoicesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetInvoicesResponse>;
|
|
198
|
+
/**
|
|
199
|
+
* Returns marketplace-dependent schemas and their respective set of possible values. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
200
|
+
* @param {InvoicesApiGetInvoicesAttributesRequest} requestParameters Request parameters.
|
|
201
|
+
* @param {*} [options] Override http request option.
|
|
202
|
+
* @throws {RequiredError}
|
|
203
|
+
*/
|
|
204
|
+
getInvoicesAttributes(requestParameters: InvoicesApiGetInvoicesAttributesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetInvoicesAttributesResponse>;
|
|
205
|
+
/**
|
|
206
|
+
* 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. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
207
|
+
* @param {InvoicesApiGetInvoicesDocumentRequest} requestParameters Request parameters.
|
|
208
|
+
* @param {*} [options] Override http request option.
|
|
209
|
+
* @throws {RequiredError}
|
|
210
|
+
*/
|
|
211
|
+
getInvoicesDocument(requestParameters: InvoicesApiGetInvoicesDocumentRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetInvoicesDocumentResponse>;
|
|
212
|
+
/**
|
|
213
|
+
* Returns invoice export details (including the `exportDocumentId`, if available) for the export that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
214
|
+
* @param {InvoicesApiGetInvoicesExportRequest} requestParameters Request parameters.
|
|
215
|
+
* @param {*} [options] Override http request option.
|
|
216
|
+
* @throws {RequiredError}
|
|
217
|
+
*/
|
|
218
|
+
getInvoicesExport(requestParameters: InvoicesApiGetInvoicesExportRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetInvoicesExportResponse>;
|
|
219
|
+
/**
|
|
220
|
+
* Returns invoice exports details for exports that match the filters that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.1 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
221
|
+
* @param {InvoicesApiGetInvoicesExportsRequest} requestParameters Request parameters.
|
|
222
|
+
* @param {*} [options] Override http request option.
|
|
223
|
+
* @throws {RequiredError}
|
|
224
|
+
*/
|
|
225
|
+
getInvoicesExports(requestParameters: InvoicesApiGetInvoicesExportsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetInvoicesExportsResponse>;
|
|
226
|
+
};
|
|
227
|
+
/**
|
|
228
|
+
* Request parameters for createInvoicesExport operation in InvoicesApi.
|
|
229
|
+
* @export
|
|
230
|
+
* @interface InvoicesApiCreateInvoicesExportRequest
|
|
231
|
+
*/
|
|
232
|
+
export interface InvoicesApiCreateInvoicesExportRequest {
|
|
233
|
+
/**
|
|
234
|
+
* Information required to create the export request.
|
|
235
|
+
* @type {ExportInvoicesRequest}
|
|
236
|
+
* @memberof InvoicesApiCreateInvoicesExport
|
|
237
|
+
*/
|
|
238
|
+
readonly body: ExportInvoicesRequest;
|
|
239
|
+
}
|
|
240
|
+
/**
|
|
241
|
+
* Request parameters for getInvoice operation in InvoicesApi.
|
|
242
|
+
* @export
|
|
243
|
+
* @interface InvoicesApiGetInvoiceRequest
|
|
244
|
+
*/
|
|
245
|
+
export interface InvoicesApiGetInvoiceRequest {
|
|
246
|
+
/**
|
|
247
|
+
* The marketplace from which you want the invoice.
|
|
248
|
+
* @type {string}
|
|
249
|
+
* @memberof InvoicesApiGetInvoice
|
|
250
|
+
*/
|
|
251
|
+
readonly marketplaceId: string;
|
|
252
|
+
/**
|
|
253
|
+
* The invoice identifier.
|
|
254
|
+
* @type {string}
|
|
255
|
+
* @memberof InvoicesApiGetInvoice
|
|
256
|
+
*/
|
|
257
|
+
readonly invoiceId: string;
|
|
258
|
+
}
|
|
259
|
+
/**
|
|
260
|
+
* Request parameters for getInvoices operation in InvoicesApi.
|
|
261
|
+
* @export
|
|
262
|
+
* @interface InvoicesApiGetInvoicesRequest
|
|
263
|
+
*/
|
|
264
|
+
export interface InvoicesApiGetInvoicesRequest {
|
|
265
|
+
/**
|
|
266
|
+
* The response includes only the invoices that match the specified marketplace.
|
|
267
|
+
* @type {string}
|
|
268
|
+
* @memberof InvoicesApiGetInvoices
|
|
269
|
+
*/
|
|
270
|
+
readonly marketplaceId: string;
|
|
271
|
+
/**
|
|
272
|
+
* The name of the transaction identifier filter. If you provide a value for this field, you must also provide a value for the `transactionIdentifierId` field.Use the `getInvoicesAttributes` operation to check `transactionIdentifierName` options.
|
|
273
|
+
* @type {string}
|
|
274
|
+
* @memberof InvoicesApiGetInvoices
|
|
275
|
+
*/
|
|
276
|
+
readonly transactionIdentifierName?: string;
|
|
277
|
+
/**
|
|
278
|
+
* The maximum number of invoices you want to return in a single call. Minimum: 1 Maximum: 200
|
|
279
|
+
* @type {number}
|
|
280
|
+
* @memberof InvoicesApiGetInvoices
|
|
281
|
+
*/
|
|
282
|
+
readonly pageSize?: number;
|
|
283
|
+
/**
|
|
284
|
+
* The latest invoice creation date for invoices that you want to include in the response. Dates are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The default is the current date-time.
|
|
285
|
+
* @type {string}
|
|
286
|
+
* @memberof InvoicesApiGetInvoices
|
|
287
|
+
*/
|
|
288
|
+
readonly dateEnd?: string;
|
|
289
|
+
/**
|
|
290
|
+
* The marketplace-specific classification of the transaction type for which the invoice was created. Use the `getInvoicesAttributes` operation to check `transactionType` options.
|
|
291
|
+
* @type {string}
|
|
292
|
+
* @memberof InvoicesApiGetInvoices
|
|
293
|
+
*/
|
|
294
|
+
readonly transactionType?: string;
|
|
295
|
+
/**
|
|
296
|
+
* The ID of the transaction identifier filter. If you provide a value for this field, you must also provide a value for the `transactionIdentifierName` field.
|
|
297
|
+
* @type {string}
|
|
298
|
+
* @memberof InvoicesApiGetInvoices
|
|
299
|
+
*/
|
|
300
|
+
readonly transactionIdentifierId?: string;
|
|
301
|
+
/**
|
|
302
|
+
* The earliest invoice creation date for invoices that you want to include in the response. Dates are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The default is 24 hours prior to the time of the request.
|
|
303
|
+
* @type {string}
|
|
304
|
+
* @memberof InvoicesApiGetInvoices
|
|
305
|
+
*/
|
|
306
|
+
readonly dateStart?: string;
|
|
307
|
+
/**
|
|
308
|
+
* Return invoices with the specified series number.
|
|
309
|
+
* @type {string}
|
|
310
|
+
* @memberof InvoicesApiGetInvoices
|
|
311
|
+
*/
|
|
312
|
+
readonly series?: string;
|
|
313
|
+
/**
|
|
314
|
+
* The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
|
|
315
|
+
* @type {string}
|
|
316
|
+
* @memberof InvoicesApiGetInvoices
|
|
317
|
+
*/
|
|
318
|
+
readonly nextToken?: string;
|
|
319
|
+
/**
|
|
320
|
+
* Sort the invoices in the response in ascending or descending order.
|
|
321
|
+
* @type {'DESC' | 'ASC'}
|
|
322
|
+
* @memberof InvoicesApiGetInvoices
|
|
323
|
+
*/
|
|
324
|
+
readonly sortOrder?: GetInvoicesSortOrderEnum;
|
|
325
|
+
/**
|
|
326
|
+
* The marketplace-specific classification of the invoice type. Use the `getInvoicesAttributes` operation to check `invoiceType` options.
|
|
327
|
+
* @type {string}
|
|
328
|
+
* @memberof InvoicesApiGetInvoices
|
|
329
|
+
*/
|
|
330
|
+
readonly invoiceType?: string;
|
|
331
|
+
/**
|
|
332
|
+
* A list of statuses that you can use to filter invoices. Use the `getInvoicesAttributes` operation to check invoice status options. Min count: 1
|
|
333
|
+
* @type {Array<string>}
|
|
334
|
+
* @memberof InvoicesApiGetInvoices
|
|
335
|
+
*/
|
|
336
|
+
readonly statuses?: Array<string>;
|
|
337
|
+
/**
|
|
338
|
+
* Return invoices that match this external ID. This is typically the Government Invoice ID.
|
|
339
|
+
* @type {string}
|
|
340
|
+
* @memberof InvoicesApiGetInvoices
|
|
341
|
+
*/
|
|
342
|
+
readonly externalInvoiceId?: string;
|
|
343
|
+
/**
|
|
344
|
+
* The attribute by which you want to sort the invoices in the response.
|
|
345
|
+
* @type {'START_DATE_TIME'}
|
|
346
|
+
* @memberof InvoicesApiGetInvoices
|
|
347
|
+
*/
|
|
348
|
+
readonly sortBy?: GetInvoicesSortByEnum;
|
|
349
|
+
}
|
|
350
|
+
/**
|
|
351
|
+
* Request parameters for getInvoicesAttributes operation in InvoicesApi.
|
|
352
|
+
* @export
|
|
353
|
+
* @interface InvoicesApiGetInvoicesAttributesRequest
|
|
354
|
+
*/
|
|
355
|
+
export interface InvoicesApiGetInvoicesAttributesRequest {
|
|
356
|
+
/**
|
|
357
|
+
* The marketplace identifier.
|
|
358
|
+
* @type {string}
|
|
359
|
+
* @memberof InvoicesApiGetInvoicesAttributes
|
|
360
|
+
*/
|
|
361
|
+
readonly marketplaceId: string;
|
|
362
|
+
}
|
|
363
|
+
/**
|
|
364
|
+
* Request parameters for getInvoicesDocument operation in InvoicesApi.
|
|
365
|
+
* @export
|
|
366
|
+
* @interface InvoicesApiGetInvoicesDocumentRequest
|
|
367
|
+
*/
|
|
368
|
+
export interface InvoicesApiGetInvoicesDocumentRequest {
|
|
369
|
+
/**
|
|
370
|
+
* The export document identifier.
|
|
371
|
+
* @type {string}
|
|
372
|
+
* @memberof InvoicesApiGetInvoicesDocument
|
|
373
|
+
*/
|
|
374
|
+
readonly invoicesDocumentId: string;
|
|
375
|
+
}
|
|
376
|
+
/**
|
|
377
|
+
* Request parameters for getInvoicesExport operation in InvoicesApi.
|
|
378
|
+
* @export
|
|
379
|
+
* @interface InvoicesApiGetInvoicesExportRequest
|
|
380
|
+
*/
|
|
381
|
+
export interface InvoicesApiGetInvoicesExportRequest {
|
|
382
|
+
/**
|
|
383
|
+
* The unique identifier for the export.
|
|
384
|
+
* @type {string}
|
|
385
|
+
* @memberof InvoicesApiGetInvoicesExport
|
|
386
|
+
*/
|
|
387
|
+
readonly exportId: string;
|
|
388
|
+
}
|
|
389
|
+
/**
|
|
390
|
+
* Request parameters for getInvoicesExports operation in InvoicesApi.
|
|
391
|
+
* @export
|
|
392
|
+
* @interface InvoicesApiGetInvoicesExportsRequest
|
|
393
|
+
*/
|
|
394
|
+
export interface InvoicesApiGetInvoicesExportsRequest {
|
|
395
|
+
/**
|
|
396
|
+
* The returned exports match the specified marketplace.
|
|
397
|
+
* @type {string}
|
|
398
|
+
* @memberof InvoicesApiGetInvoicesExports
|
|
399
|
+
*/
|
|
400
|
+
readonly marketplaceId: string;
|
|
401
|
+
/**
|
|
402
|
+
* The earliest export creation date and time for exports that you want to include in the response. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The default is 30 days ago.
|
|
403
|
+
* @type {string}
|
|
404
|
+
* @memberof InvoicesApiGetInvoicesExports
|
|
405
|
+
*/
|
|
406
|
+
readonly dateStart?: string;
|
|
407
|
+
/**
|
|
408
|
+
* The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
|
|
409
|
+
* @type {string}
|
|
410
|
+
* @memberof InvoicesApiGetInvoicesExports
|
|
411
|
+
*/
|
|
412
|
+
readonly nextToken?: string;
|
|
413
|
+
/**
|
|
414
|
+
* The maximum number of invoices to return in a single call. Minimum: 1 Maximum: 100
|
|
415
|
+
* @type {number}
|
|
416
|
+
* @memberof InvoicesApiGetInvoicesExports
|
|
417
|
+
*/
|
|
418
|
+
readonly pageSize?: number;
|
|
419
|
+
/**
|
|
420
|
+
* The latest export creation date and time for exports that you want to include in the response. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The default value is the time of the request.
|
|
421
|
+
* @type {string}
|
|
422
|
+
* @memberof InvoicesApiGetInvoicesExports
|
|
423
|
+
*/
|
|
424
|
+
readonly dateEnd?: string;
|
|
425
|
+
/**
|
|
426
|
+
* Return exports matching the status specified.
|
|
427
|
+
* @type {'REQUESTED' | 'PROCESSING' | 'DONE' | 'ERROR'}
|
|
428
|
+
* @memberof InvoicesApiGetInvoicesExports
|
|
429
|
+
*/
|
|
430
|
+
readonly status?: GetInvoicesExportsStatusEnum;
|
|
431
|
+
}
|
|
432
|
+
/**
|
|
433
|
+
* InvoicesApi - object-oriented interface
|
|
434
|
+
* @export
|
|
435
|
+
* @class InvoicesApi
|
|
436
|
+
* @extends {BaseAPI}
|
|
437
|
+
*/
|
|
438
|
+
export declare class InvoicesApi extends BaseAPI {
|
|
439
|
+
/**
|
|
440
|
+
* Creates an invoice export request. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.167 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
441
|
+
* @param {InvoicesApiCreateInvoicesExportRequest} requestParameters Request parameters.
|
|
442
|
+
* @param {*} [options] Override http request option.
|
|
443
|
+
* @throws {RequiredError}
|
|
444
|
+
* @memberof InvoicesApi
|
|
445
|
+
*/
|
|
446
|
+
createInvoicesExport(requestParameters: InvoicesApiCreateInvoicesExportRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ExportInvoicesResponse, any>>;
|
|
447
|
+
/**
|
|
448
|
+
* 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. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
449
|
+
* @param {InvoicesApiGetInvoiceRequest} requestParameters Request parameters.
|
|
450
|
+
* @param {*} [options] Override http request option.
|
|
451
|
+
* @throws {RequiredError}
|
|
452
|
+
* @memberof InvoicesApi
|
|
453
|
+
*/
|
|
454
|
+
getInvoice(requestParameters: InvoicesApiGetInvoiceRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetInvoiceResponse, any>>;
|
|
455
|
+
/**
|
|
456
|
+
* Returns invoice details for the invoices that match the filters that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.1 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
457
|
+
* @param {InvoicesApiGetInvoicesRequest} requestParameters Request parameters.
|
|
458
|
+
* @param {*} [options] Override http request option.
|
|
459
|
+
* @throws {RequiredError}
|
|
460
|
+
* @memberof InvoicesApi
|
|
461
|
+
*/
|
|
462
|
+
getInvoices(requestParameters: InvoicesApiGetInvoicesRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetInvoicesResponse, any>>;
|
|
463
|
+
/**
|
|
464
|
+
* Returns marketplace-dependent schemas and their respective set of possible values. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
465
|
+
* @param {InvoicesApiGetInvoicesAttributesRequest} requestParameters Request parameters.
|
|
466
|
+
* @param {*} [options] Override http request option.
|
|
467
|
+
* @throws {RequiredError}
|
|
468
|
+
* @memberof InvoicesApi
|
|
469
|
+
*/
|
|
470
|
+
getInvoicesAttributes(requestParameters: InvoicesApiGetInvoicesAttributesRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetInvoicesAttributesResponse, any>>;
|
|
471
|
+
/**
|
|
472
|
+
* 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. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
473
|
+
* @param {InvoicesApiGetInvoicesDocumentRequest} requestParameters Request parameters.
|
|
474
|
+
* @param {*} [options] Override http request option.
|
|
475
|
+
* @throws {RequiredError}
|
|
476
|
+
* @memberof InvoicesApi
|
|
477
|
+
*/
|
|
478
|
+
getInvoicesDocument(requestParameters: InvoicesApiGetInvoicesDocumentRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetInvoicesDocumentResponse, any>>;
|
|
479
|
+
/**
|
|
480
|
+
* Returns invoice export details (including the `exportDocumentId`, if available) for the export that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
481
|
+
* @param {InvoicesApiGetInvoicesExportRequest} requestParameters Request parameters.
|
|
482
|
+
* @param {*} [options] Override http request option.
|
|
483
|
+
* @throws {RequiredError}
|
|
484
|
+
* @memberof InvoicesApi
|
|
485
|
+
*/
|
|
486
|
+
getInvoicesExport(requestParameters: InvoicesApiGetInvoicesExportRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetInvoicesExportResponse, any>>;
|
|
487
|
+
/**
|
|
488
|
+
* Returns invoice exports details for exports that match the filters that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.1 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
489
|
+
* @param {InvoicesApiGetInvoicesExportsRequest} requestParameters Request parameters.
|
|
490
|
+
* @param {*} [options] Override http request option.
|
|
491
|
+
* @throws {RequiredError}
|
|
492
|
+
* @memberof InvoicesApi
|
|
493
|
+
*/
|
|
494
|
+
getInvoicesExports(requestParameters: InvoicesApiGetInvoicesExportsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetInvoicesExportsResponse, any>>;
|
|
495
|
+
}
|
|
496
|
+
/**
|
|
497
|
+
* @export
|
|
498
|
+
*/
|
|
499
|
+
export declare const GetInvoicesSortOrderEnum: {
|
|
500
|
+
readonly Desc: "DESC";
|
|
501
|
+
readonly Asc: "ASC";
|
|
502
|
+
};
|
|
503
|
+
export type GetInvoicesSortOrderEnum = typeof GetInvoicesSortOrderEnum[keyof typeof GetInvoicesSortOrderEnum];
|
|
504
|
+
/**
|
|
505
|
+
* @export
|
|
506
|
+
*/
|
|
507
|
+
export declare const GetInvoicesSortByEnum: {
|
|
508
|
+
readonly StartDateTime: "START_DATE_TIME";
|
|
509
|
+
};
|
|
510
|
+
export type GetInvoicesSortByEnum = typeof GetInvoicesSortByEnum[keyof typeof GetInvoicesSortByEnum];
|
|
511
|
+
/**
|
|
512
|
+
* @export
|
|
513
|
+
*/
|
|
514
|
+
export declare const GetInvoicesExportsStatusEnum: {
|
|
515
|
+
readonly Requested: "REQUESTED";
|
|
516
|
+
readonly Processing: "PROCESSING";
|
|
517
|
+
readonly Done: "DONE";
|
|
518
|
+
readonly Error: "ERROR";
|
|
519
|
+
};
|
|
520
|
+
export type GetInvoicesExportsStatusEnum = typeof GetInvoicesExportsStatusEnum[keyof typeof GetInvoicesExportsStatusEnum];
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The Selling Partner API for Invoices.
|
|
3
|
+
* Use the Selling Partner API for Invoices to retrieve and manage invoice-related operations, which can help selling partners manage their bookkeeping processes.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2024-06-19
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
export * from './api/invoices-api';
|