Function InvoicesApiFp

Returns {
    createGovernmentInvoice(
        body: GovernmentInvoiceRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    createInvoicesExport(
        body: ExportInvoicesRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ExportInvoicesResponse>,
    >;
    getGovernmentInvoiceDocument(
        marketplaceId: string,
        transactionType: string,
        shipmentId: string,
        invoiceType: string,
        inboundPlanId?: string,
        fileFormat?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GovtInvoiceDocumentResponse>,
    >;
    getGovernmentInvoiceStatus(
        marketplaceId: string,
        transactionType: string,
        shipmentId: string,
        invoiceType: string,
        inboundPlanId?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GovernmentInvoiceStatusResponse>,
    >;
    getInvoice(
        marketplaceId: string,
        invoiceId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetInvoiceResponse>,
    >;
    getInvoices(
        marketplaceId: string,
        transactionIdentifierName?: string,
        pageSize?: number,
        dateEnd?: string,
        transactionType?: string,
        transactionIdentifierId?: string,
        dateStart?: string,
        series?: string,
        nextToken?: string,
        sortOrder?: GetInvoicesSortOrderEnum,
        invoiceType?: string,
        statuses?: string[],
        externalInvoiceId?: string,
        sortBy?: "START_DATE_TIME",
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetInvoicesResponse>,
    >;
    getInvoicesAttributes(
        marketplaceId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetInvoicesAttributesResponse>,
    >;
    getInvoicesDocument(
        invoicesDocumentId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetInvoicesDocumentResponse>,
    >;
    getInvoicesExport(
        exportId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetInvoicesExportResponse>,
    >;
    getInvoicesExports(
        marketplaceId: string,
        dateStart?: string,
        nextToken?: string,
        pageSize?: number,
        dateEnd?: string,
        status?: GetInvoicesExportsStatusEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetInvoicesExportsResponse>,
    >;
}

• createGovernmentInvoice: function

  • createGovernmentInvoice(
        body: GovernmentInvoiceRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Submits an asynchronous government invoice creation request. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 1 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

    Parameters

    • body: GovernmentInvoiceRequest

      Information required to create the government invoice.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Throws

• createInvoicesExport: function

  • createInvoicesExport(
        body: ExportInvoicesRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ExportInvoicesResponse>,
    >

    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.

    Parameters

    • body: ExportInvoicesRequest

      Information required to create the export request.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ExportInvoicesResponse>,
    >

    Throws

• getGovernmentInvoiceDocument: function

  • getGovernmentInvoiceDocument(
        marketplaceId: string,
        transactionType: string,
        shipmentId: string,
        invoiceType: string,
        inboundPlanId?: string,
        fileFormat?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GovtInvoiceDocumentResponse>,
    >

    Returns an invoiceDocument object containing an invoiceDocumentUrl . Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 1 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

    Parameters

    • marketplaceId: string

      The invoices returned will match the marketplace that you specify.

    • transactionType: string

      Marketplace specific classification of the transaction type that originated the invoice. Check &#39;transactionType&#39; options using &#39;getInvoicesAttributes&#39; operation.

    • shipmentId: string

      The unique shipment identifier to get an invoice for.

    • invoiceType: string

      Marketplace specific classification of the invoice type. Check &#39;invoiceType&#39; options using &#39;getInvoicesAttributes&#39; operation.

    • OptionalinboundPlanId: string

      The unique InboundPlan identifier in which the shipment is contained and for which the invoice will be created.

    • OptionalfileFormat: string

      Requested file format. Default is XML

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GovtInvoiceDocumentResponse>,
    >

    Throws

• getGovernmentInvoiceStatus: function

  • getGovernmentInvoiceStatus(
        marketplaceId: string,
        transactionType: string,
        shipmentId: string,
        invoiceType: string,
        inboundPlanId?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GovernmentInvoiceStatusResponse>,
    >

    Returns the status of an invoice generation request. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 1 | For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

    Parameters

    • marketplaceId: string

      The invoices status will match the marketplace that you specify.

    • transactionType: string

      Marketplace specific classification of the transaction type that originated the invoice. Check &#39;transactionType&#39; options using &#39;getInvoicesAttributes&#39; operation.

    • shipmentId: string

      The unique shipment identifier to get an invoice for.

    • invoiceType: string

      Marketplace specific classification of the invoice type. Check &#39;invoiceType&#39; options using &#39;getInvoicesAttributes&#39; operation.

    • OptionalinboundPlanId: string

      The unique InboundPlan identifier in which the shipment is contained and for which the invoice will be created.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GovernmentInvoiceStatusResponse>,
    >

    Throws

• getInvoice: function

  • getInvoice(
        marketplaceId: string,
        invoiceId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetInvoiceResponse>,
    >

    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.

    Parameters

    • marketplaceId: string

      The marketplace from which you want the invoice.

    • invoiceId: string

      The invoice identifier.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetInvoiceResponse>,
    >

    Throws

• getInvoices: function

  • getInvoices(
        marketplaceId: string,
        transactionIdentifierName?: string,
        pageSize?: number,
        dateEnd?: string,
        transactionType?: string,
        transactionIdentifierId?: string,
        dateStart?: string,
        series?: string,
        nextToken?: string,
        sortOrder?: GetInvoicesSortOrderEnum,
        invoiceType?: string,
        statuses?: string[],
        externalInvoiceId?: string,
        sortBy?: "START_DATE_TIME",
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetInvoicesResponse>,
    >

    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.

    Parameters

    • marketplaceId: string

      The response includes only the invoices that match the specified marketplace.

    • OptionaltransactionIdentifierName: string

      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.

    • OptionalpageSize: number

      The maximum number of invoices you want to return in a single call. Minimum: 1 Maximum: 200

    • OptionaldateEnd: string

      The latest invoice creation date for invoices that you want to include in the response. Dates are in ISO 8601 date-time format. The default is the current date-time.

    • OptionaltransactionType: string

      The marketplace-specific classification of the transaction type for which the invoice was created. Use the `getInvoicesAttributes` operation to check `transactionType` options.

    • OptionaltransactionIdentifierId: string

      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.

    • OptionaldateStart: string

      The earliest invoice creation date for invoices that you want to include in the response. Dates are in ISO 8601 date-time format. The default is 24 hours prior to the time of the request.

    • Optionalseries: string

      Return invoices with the specified series number.

    • OptionalnextToken: string

      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.

    • OptionalsortOrder: GetInvoicesSortOrderEnum

      Sort the invoices in the response in ascending or descending order.

    • OptionalinvoiceType: string

      The marketplace-specific classification of the invoice type. Use the `getInvoicesAttributes` operation to check `invoiceType` options.

    • Optionalstatuses: string[]

      A list of statuses that you can use to filter invoices. Use the `getInvoicesAttributes` operation to check invoice status options. Min count: 1

    • OptionalexternalInvoiceId: string

      Return invoices that match this external ID. This is typically the Government Invoice ID.

    • OptionalsortBy: "START_DATE_TIME"

      The attribute by which you want to sort the invoices in the response.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetInvoicesResponse>,
    >

    Throws

• getInvoicesAttributes: function

  • getInvoicesAttributes(
        marketplaceId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetInvoicesAttributesResponse>,
    >

    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.

    Parameters

    • marketplaceId: string

      The marketplace identifier.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetInvoicesAttributesResponse>,
    >

    Throws

• getInvoicesDocument: function

  • getInvoicesDocument(
        invoicesDocumentId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetInvoicesDocumentResponse>,
    >

    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.

    Parameters

    • invoicesDocumentId: string

      The export document identifier.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetInvoicesDocumentResponse>,
    >

    Throws

• getInvoicesExport: function

  • getInvoicesExport(
        exportId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetInvoicesExportResponse>,
    >

    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.

    Parameters

    • exportId: string

      The unique identifier for the export.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetInvoicesExportResponse>,
    >

    Throws

• getInvoicesExports: function

  • getInvoicesExports(
        marketplaceId: string,
        dateStart?: string,
        nextToken?: string,
        pageSize?: number,
        dateEnd?: string,
        status?: GetInvoicesExportsStatusEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetInvoicesExportsResponse>,
    >

    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.

    Parameters

    • marketplaceId: string

      The returned exports match the specified marketplace.

    • OptionaldateStart: string

      The earliest export creation date and time for exports that you want to include in the response. Values are in ISO 8601 date-time format. The default is 30 days ago.

    • OptionalnextToken: string

      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.

    • OptionalpageSize: number

      The maximum number of invoices to return in a single call. Minimum: 1 Maximum: 100

    • OptionaldateEnd: string

      The latest export creation date and time for exports that you want to include in the response. Values are in ISO 8601 date-time format. The default value is the time of the request.

    • Optionalstatus: GetInvoicesExportsStatusEnum

      Return exports matching the status specified.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetInvoicesExportsResponse>,
    >

    Throws