Guía de casos de uso de la API de facturas v2024-06-19

Aprenda a usar la API de facturas.

Versión de API: 2024-06-19

¿Qué es la API de facturas?

You can use the Selling Partner API for Invoices to retrieve and manage a variety of invoice-related operations that can help selling partners manage their bookkeeping.

Importante

Esta API solo puede recuperar Facturas de FBA brasileñas. No puedes usar esta API para ningún otro tipo de factura.

Características principales

  • Busca facturas por sus atributos
  • Exportación y descarga de facturas

Terminología

  • Sefaz: Administración Tributaria del Estado de Brasil (Secretaria da Fazenda).

Tutorial: Exportación de archivos de facturas

Obtén información sobre cómo exportar y descargar archivos de facturas.

Requisitos

Para completar este tutorial, debes tener lo siguiente:

  • Authorization from the selling partner for whom you are making calls. For more information, refer to Authorizing Selling Partner API applications.
  • La función de facturación fiscal asignada a tu perfil de desarrollador.
  • La función de facturación fiscal seleccionada en la página de registro de la aplicación para su aplicación.

Paso 1. Crea una exportación de facturas

Call the createInvoicesExport operation and specify the marketplace, date range, and any optional parameters you want to include.

Si la solicitud tiene éxito, la respuesta incluye un exportId valor.

Parámetros de texto

NombreDescripciónObligatorio
marketplaceIdLas facturas devueltas coinciden con la plataforma que especifiques.
Tipo: cadena
dateStartThe earliest invoice creation date for invoices that you want to include in the response. Dates are in ISO 8601 format.
Type: string (date)
No
dateEndThe latest invoice creation date for invoices that you want to include in the response. Dates are in ISO 8601 format.
Type: string (date)
No

Sugerencia

Para reducir el tiempo de procesamiento de las exportaciones, utilice intervalos de fechas cortos para dateStart y dateEnd. El rango óptimo es un día.

Ejemplo de solicitud

POST https://sellingpartnerapi-na.amazon.com/invoices/v1/exports?marketplaceId=A2Q3Y263D00KWC&dateStart=2024-07-09T00:00:00Z&dateEnd=2024-07-10T00:00:00Z

Respuesta

NombreDescripción
exportIdEl identificador de exportación.
Tipo: cadena

Ejemplo de respuesta

{ "exportId": "4bdd8293-0cd7-4208-bed5-78b2c6ecefef" }

Paso 2. Verifique que el proceso de exportación esté completo

Periodically call the getInvoicesExport operation--passing the exportId value that you received in Step 1--until processing is complete (processingStatus is CANCELLED, DONE, or FATAL). At this point, the response includes an exportDocumentId value if invoice data is available.

Parámetros de ruta

NombreDescripciónObligatorio
exportIdEl identificador de la exportación.
Tipo: cadena

Ejemplo de solicitud

GET https://sellingpartnerapi-na.amazon.com/invoices/v1/exports/4bdd8293-0cd7-4208-bed5-78b2c6ecefef

Respuesta

NombreDescripción
errorMessageCuando se produce un error en la generación de la exportación, este atributo contiene una descripción del error.
Tipo: cadena
exportDocumentIdsUna lista con los identificadores de cada documento de exportación.
Tipo: matriz
exportIdEl identificador de exportación.
Tipo: cadena
generateExportFinishedLa fecha y la hora en que finalizó la generación de la exportación, en formato de fecha y hora ISO 8601.
Tipo: cadena
generateExportStartedLa fecha y la hora en que se inició la generación de la exportación, en formato de fecha y hora ISO 8601.
Tipo: cadena
statusEl estado de procesamiento.
Tipo: enum (REQUESTED, PROCESSING, DONE, ERROR)

Ejemplo de respuesta

{ "export": { "errorMessage": "", "exportDocumentIds": [ "18c598f5-75db-4c1a-bd3e-4c64b36781c5" ], "exportId": "4bdd8293-0cd7-4208-bed5-78b2c6ecefef", "generateExportFinished": "2024-07-10T16:00:00.000Z", "generateExportStarted": "2024-07-10T15:00:00.000Z", "status": "DONE" } }

Paso 3. Obtenga la URL del documento de facturación

Call the getInvoicesDocument operation, passing the exportDocumentId value from Step 2.

La respuesta contiene una URL prefirmada que puedes usar para acceder a la exportación de facturas. Si el contenido está comprimido, se proporciona el algoritmo de compresión. La URL caduca a los 30 segundos.

Parámetros de ruta

NombreDescripciónObligatorio
invoicesDocumentIdEl identificador del documento de exportación.
Tipo: cadena

Ejemplo de solicitud

GET https://sellingpartnerapi-na.amazon.com/invoices/v1/documents/18c598f5-75db-4c1a-bd3e-4c64b36781c5

Respuesta

NombreDescripción
invoicesDocumentIdEl identificador del documento de exportación.
Tipo: cadena
invoicesDocumentUrlUna URL prefirmada que puedes usar para descargar las facturas (en formato ZIP).
Tipo: cadena

Ejemplo de respuesta

{ "exportDocumentId": "18c598f5-75db-4c1a-bd3e-4c64b36781c5", "url": "https://d34o8swod1owfl.cloudfront.net/SampleResult%2BKey%3DSample%2BINITVEC%3D58+fa+bf+a7+08+11+95+0f+c1+a8+c6+e0+d5+6f+ae+c8" }

¿Te ha ayudado esta página?