API de conciliación de facturas facturadas v2 (GA)
Artigo
Se aplica a: Centro de partners (no disponible en la nube soberana)
Nuestra nueva API asincrónica ofrece una manera más rápida y eficaz de acceder a los datos de facturación y conciliación a través de blobs de Azure. En lugar de mantener abierta una conexión durante horas o procesar lotes de 2000 elementos de línea, ahora puede simplificar el flujo de trabajo, reducir la carga del servidor y mejorar los tiempos de procesamiento de datos.
La nueva API de conciliación de facturas facturadas de comercio usa técnicas avanzadas, como la clave de valet y los patrones asincrónicos de solicitud-respuesta . El patrón de clave de valet admite el acceso seguro a los recursos sin compartir credenciales, mientras que el patrón asincrónico de solicitud-respuesta permite una comunicación eficaz entre sistemas.
Esta API proporciona un token de firma de acceso compartido (SAS) que puede usar para acceder a todos los atributos o a un subconjunto de los datos de conciliación de facturas facturados. Este token mejora la seguridad al conceder acceso a tiempo limitado y ofrece flexibilidad en la administración de permisos de acceso a datos.
Al adoptar nuestras API optimizadas, puede lograr resultados más rápidos con menos esfuerzo, simplificar el acceso a los datos y mejorar la eficacia general. Adopte estas herramientas para simplificar el flujo de trabajo y administrar los permisos de forma más eficaz.
Permitir que la aplicación acceda de forma segura a los datos de facturación de asociados
Para permitir que la aplicación acceda a los datos de facturación de asociados, siga este vínculo y familiarícese con los conceptos básicos de autenticación y autorización de para Microsoft Graph. Este paso es fundamental, ya que garantiza que la aplicación pueda acceder de forma segura a los datos necesarios.
Registra tu aplicación y asigna el permiso PartnerBilling.Read.All
Puede asignar el permiso "PartnerBilling.Read.All" mediante Azure Portal o el Centro de administración de Microsoft Entra. Al completar estos pasos, ayudará a asegurarse de que la aplicación tiene el acceso necesario a los datos de facturación de asociados. A continuación, se indica cómo puede hacerlo.
Registre la aplicación en la página principal de Microsoft Entra en la sección Registros de aplicaciones.
Conceda el permiso necesario en la página Aplicación de Microsoft Entra. En la sección de permisos de API, seleccione Agregar un permiso y elija el ámbito PartnerBilling.Read.All.
Más información sobre los puntos de conexión de API clave
Para ayudarle a recuperar los nuevos elementos de línea de conciliación de factura comercial facturados de forma asincrónica, ofrecemos dos puntos de conexión de API clave. Estos puntos de conexión le ayudan a administrar eficazmente el proceso de conciliación de facturas. Siga esta guía simplificada para empezar a trabajar rápidamente.
Uso del punto de conexión de conciliación de facturación facturado
En primer lugar, use esta API para capturar nuevos elementos de línea de conciliación de facturas facturadas de comercio . Al realizar una solicitud, recibirá un estado HTTP 202 y un encabezado de ubicación con una dirección URL. Sondee esta dirección URL con regularidad hasta que obtenga un estado correcto y una dirección URL de manifiesto.
Uso del punto de conexión de estado de la operación
A continuación, siga comprobando el estado de la operación llamando a esta API a intervalos regulares. Si los datos no están listos, la respuesta incluye un encabezado Retry-After que indica cuánto tiempo debe esperar antes de volver a intentarlo. Una vez completada la operación, recibirá un recurso manifiesto con un vínculo de carpeta de almacenamiento para descargar los datos de uso. La respuesta segmenta los archivos para mejorar el rendimiento y permitir el paralelismo de E/S.
Revisión del diagrama de secuencia
Este es un diagrama de secuencia que muestra los pasos para descargar nuevos datos de conciliación de facturas comerciales.
Siga las acciones del usuario en secuencia para obtener los datos de conciliación de facturas.
Esta es la secuencia de acciones del usuario para obtener los datos de conciliación de facturas:
Elija "full" para todos los atributos o "básico" para un conjunto limitado. Si no se especifica, "full" es el valor predeterminado. Consulte la lista de atributos en esta sección. Opcional.
invoiceId
True
Cadena
Un identificador único para cada factura. Necesario.
Encabezados de solicitud
Solicite encabezados para la API mediante los pasos que se enumeran en Procedimientos recomendados para usar Microsoft Graph. Al seguir estas instrucciones, se garantiza la confiabilidad y la compatibilidad con la aplicación. Su atención a los detalles de este paso es fundamental para una integración sin problemas y un rendimiento óptimo.
Normalmente, la API responde con un estado HTTP 202. También puede encontrar otros estados en función de las solicitudes. Estos estados se enumeran en la sección Estados de respuesta de api estándar .
Código
Descripción
202 – Aceptado
Se aceptó la solicitud. Para comprobar el estado de la solicitud, consulte la dirección URL proporcionada en el encabezado de ubicación.
Comprobación del estado de la solicitud
Para realizar un seguimiento del estado de una solicitud, asegúrese de recibir una respuesta HTTP 200 que es un código de estado estándar que indica "correcto" o "error." Si se ejecuta correctamente, encontrará la dirección URL del manifiesto en el atributo "resourceLocation". Este atributo proporciona un punto de conexión para acceder a la información necesaria.
Obtener el estado de la operación
Recupera el estado de una solicitud.
Solicitud a la API
HTTP
GET <https://graph.microsoft.com/v1.0/reports/partners/billing/operations/9ab9cb54-d07f-4f52-9ea6-a09d7de52c14>
Parámetros de solicitud
Nombre
Incluir en
Obligatorio
Type
Descripción
operationId
URI de solicitud
True
Cadena
Identificador único para comprobar el estado de la solicitud. Necesario.
Encabezado de solicitud
Solicite encabezados para la API mediante los pasos que se enumeran en Procedimientos recomendados para usar Microsoft Graph. Al seguir estas instrucciones, se garantiza la confiabilidad y la compatibilidad con la aplicación. Su atención a los detalles de este paso es fundamental para una integración sin problemas y un rendimiento óptimo.
Cuerpo de la solicitud
N/A.
Estado de respuesta
Además de los estados HTTP estándar enumerados en los estados de respuesta de la API estándar, la API también puede devolver el siguiente estado HTTP:
Código
Descripción
410 – Desaparecido
El vínculo de manifiesto expira después de una hora establecida. Para obtener de nuevo el vínculo del manifiesto, envíe una nueva solicitud.
Carga de respuesta
La carga de respuesta de la API incluye los siguientes atributos:
Atributo
Obligatorio
Descripción
id
True
Un identificador único para cada respuesta Necesario.
status
True
Valores y acciones: obligatorio. no iniciado: espere la duración especificada en el encabezado "Retry-After" y, a continuación, realice otra llamada para comprobar el estado. running: espere la duración especificada en el encabezado "Retry-After" y luego realice otra llamada para comprobar el estado. correcto: los datos están listos. Recupere la carga del manifiesto mediante el URI especificado en resourceLocation. failed: la operación no se pudo realizar de forma permanente. Reinícielo.
createdDateTime
True
Hora a la que se realizó la solicitud. Necesario.
lastActionDateTime
True
La última vez que cambió el estado. Necesario.
resourceLocation
False
Identificador URI de la carga del manifiesto. Opcional.
error
False
Detalles sobre los errores, proporcionados en formato JSON. Opcional. Atributos incluidos: message: Descripción del error. code: el tipo de error.
Objeto de ubicación de recursos
Atributo
Descripción
id
Identificador único del manifiesto.
schemaVersion
Versión del esquema del manifiesto.
dataFormat
Formato del archivo de datos de facturación. compressedJSON: formato de datos donde cada blob es un archivo comprimido que contiene datos en formato de líneas JSON . Para recuperar los datos de cada blob, descomprima.
createdDateTime
Fecha y hora en que se creó el archivo de manifiesto.
eTag
Versión de los datos del manifiesto. Se genera un nuevo valor cada vez que se produce un cambio en la información de facturación.
partnerTenantId
Id. de Microsoft Entra del inquilino del asociado.
rootDirectory
Directorio raíz del archivo.
sasToken
Token de SAS (firma de acceso compartido) que le permite leer todos los archivos del directorio.
partitionType
Divide los datos en varios blobs en función del atributo partitionValue . El sistema divide las particiones que superan el número admitido. De forma predeterminada, los datos se particionan en función del número de elementos de línea del archivo. Evite codificar los recuentos de elementos de línea o los tamaños de archivo, ya que podrían cambiar.
blobCount
Número total de archivos para este identificador de inquilino del asociado.
blobs
Matriz JSON de objetos "blob" que contienen los detalles del archivo para el identificador de inquilino del asociado.
objeto de blob
Objeto que contiene los detalles siguientes: name y partitionValue
nombre
Nombre del blob.
partitionValue
Partición que contiene el archivo. La partición grande se divide en varios archivos en función de determinados criterios, como el tamaño del archivo o el número de registros, con cada archivo conteniendo el mismo "partitionValue".
Solicitud a la API
HTTP
GET <https://graph.microsoft.com/v1.0/reports/partners/billing/operations/9ab9cb54-d07f-4f52-9ea6-a09d7de52c14>
Respuesta de la API
La respuesta recomienda esperar 10 segundos antes de intentarlo de nuevo cuando los datos siguen procesando.
Descarga de los elementos de línea de conciliación de facturas facturados desde Azure Blob Storage
En primer lugar, debe obtener el token de firma de acceso compartido (SAS) y la ubicación de Blob Storage. Puede encontrar estos detalles en las propiedades sasToken y rootDirectory de la respuesta de la API de carga del manifiesto. A continuación, para descargar y descomprimir el archivo de blob, use la SDK o herramienta de Azure Storage. Está en el formato JSONLines .
Suxestión
Asegúrese de consultar nuestro código de ejemplo de . Muestra cómo descargar y descomprimir el archivo de blob de Azure en la base de datos local.
Estados de respuesta de API estándar
Es posible que obtenga los siguientes estados HTTP de la respuesta de la API:
Código
Descripción
400: Solicitud incorrecta
Falta la solicitud o contiene datos incorrectos. Compruebe el cuerpo de la respuesta para obtener los detalles del error.
401 - No autorizado
Se requiere autenticación antes de realizar la primera llamada. Autentíquese con el servicio de API del asociado.
403 - Prohibido
No tiene la autorización necesaria para realizar la solicitud.
404 – Not Found
Los recursos solicitados no están disponibles con los parámetros de entrada proporcionados.
410 – Desaparecido
El vínculo del manifiesto ya no es válido ni activo. Envíe una nueva solicitud.
500: Error interno del servidor
La API o sus dependencias no pueden cumplir la solicitud en este momento. Vuelva a intentarlo más tarde.
5000: sin datos disponibles
El sistema no tiene datos para los parámetros de entrada proporcionados.
Atributos de elemento de línea de conciliación de facturas facturadas
Para comparar los atributos devueltos por la API de conciliación de facturas facturadas para los conjuntos de atributos "completos" o "básicos", consulte esta tabla.
Para obtener más información sobre estos atributos y sus significados, consulte Uso del archivo de conciliación.
Atributo
Completo
Básico
PartnerId
sí
sí
CustomerId
sí
sí
CustomerName
sí
sí
CustomerDomainName
sí
no
CustomerCountry
sí
no
InvoiceNumber
sí
sí
MpnId
sí
no
Tier2MpnId
sí
sí
OrderId
sí
sí
OrderDate
sí
sí
ProductId
sí
sí
SkuId
sí
sí
AvailabilityId
sí
sí
SkuName
sí
no
ProductName
sí
sí
ChargeType
sí
sí
UnitPrice
sí
sí
Cantidad
sí
no
Subtotal
sí
sí
TaxTotal
sí
sí
Total
sí
sí
Moneda
sí
sí
PriceAdjustmentDescription
sí
sí
PublisherName
sí
sí
PublisherId
sí
no
SubscriptionDescription
sí
no
SubscriptionId
sí
sí
ChargeStartDate
sí
sí
ChargeEndDate
sí
sí
TermAndBillingCycle
sí
sí
EffectiveUnitPrice
sí
sí
UnitType
sí
no
AlternateId
sí
no
BillableQuantity
sí
sí
BillingFrequency
sí
no
PricingCurrency
sí
sí
PCToBCExchangeRate
sí
sí
PCToBCExchangeRateDate
sí
no
MeterDescription
sí
no
ReservationOrderId
sí
sí
CreditReasonCode
sí
sí
SubscriptionStartDate
sí
sí
SubscriptionEndDate
sí
sí
ReferenceId
sí
sí
ProductQualifiers
sí
no
PromotionId
sí
sí
ProductCategory
sí
sí
Importante
Tome nota de estos cambios al pasar de API v1 a la v2.
Cada nombre de atributo comienza ahora con una letramayúsculas para mantener la coherencia con el archivo y mejorar la legibilidad.
Obtención del código de ejemplo de API
Para usar esta API, consulte el vínculo siguiente, que incluye código de ejemplo de C#.
Sie analysieren und übersetzen finanzielle Geschäftsanforderungen in Prozesse und Lösungen, die branchenspezifische empfohlene Praktiken implementieren.