Devolver todos los artículos de línea para una factura por ID de factura

Obtener /api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/lineItems:search

Consulta el lineItems de la factura especificada y devuelve el resultado en JSON. Una cadena hexadecimal única (24) identifica la factura.

Parámetros de ruta

  • orgId string Requerido

    Cadena 24hexadecimal única que identifica la organización que contiene sus proyectos. Utilice el /orgs punto de conexión para recuperar todas las organizaciones a las que el usuario autenticado tiene acceso.

    El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.

  • invoiceId string Requerido

    Cadena única de dígitos hexadecimales 24que identifica la factura enviada a la organización especificada. Los cargos suelen contabilizarse al día siguiente.

    El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.

Parámetros de consulta

  • envolvente booleano

    Indicador que indica si la aplicación encapsula la respuesta en un objeto JSON envelope. Algunos clientes de la API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, configure envelope=true en la consulta. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como encapsulado. La aplicación añade el parámetro de estado al cuerpo de la respuesta.

    El valor predeterminado es false.

  • artículos por página entero

    Número de elementos que la respuesta devuelve por página.

    El valor mínimo es 1, el valor máximo es 500. El valor predeterminado es 100.

  • número de página entero

    Número de la página que muestra el conjunto actual del total de objetos que devuelve la respuesta.

    El valor mínimo es 1. El valor por defecto es 1.

application/vnd.atlas.2024-08-05+json

Cuerpo Requerido

Parámetros de filtro para la consulta lineItems. Envíe una solicitud con un cuerpo JSON vacío para recuperar todas las líneas de un invoiceID sin aplicar ningún filtro.

  • filtros Objeto

    Cuerpo de solicitud que contiene varios campos para filtrar partidas como parte de ciertas queries de Detalles de uso de facturas.

    Ocultar atributos de los filtros Mostrar atributos de filtros Objeto
    • billEndDate cadena(fecha)

      La fecha de inicio de la facturación inclusiva para el filtro de detalles de uso.

    • Fecha de inicio de la factura cadena(fecha)

      La fecha de inicio de la facturación inclusiva para el filtro de detalles de uso.

    • identificadores de clúster array[string]

      La lista de identificaciones de clúster únicas que se incluirán en el filtro Detalles de uso.

      El formato de cada uno debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.

    • ID de grupo array[string]

      La lista de grupos que se incluirán en el filtro Detalles de uso.

      El formato de cada uno debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.

    • incluir artículos de línea de cero centavos booleano

      Si se deben incluir partidas con valor de cero centavos.

    • Servicios sku array[string]

      La lista de proyectos que se incluirán en la consulta del Explorador de costos.

      Los valores son Atlas, Clusters, Storage, Serverless Instances, Backup, Data Transfer, BI Connector, Premium Features, Atlas Data Federation, Atlas Stream Processing, App Services, Charts, Cloud Manager, Cloud Manager Standard/Premium, Legacy Backup, AI Models, Automated Embedding, Flex Consulting, Support, Credits, DSC Compute o DSC Storage.

    • usageEndDate cadena(fecha)

      La fecha de inicio de la facturación inclusiva para el filtro de detalles de uso.

    • fecha de inicio de uso cadena(fecha)

      La fecha de inicio de uso inclusivo para el filtro de detalles de uso.

  • campo de clasificación string

    Especificar el campo usado para determinar cómo ordenar los resultados de la query. Por defecto, la fecha de facturación.

    Los valores son USAGE_DATES, BILL_DATES o TOTAL_PRICE_CENTS.

  • sortOrder string

    Especifique el orden de clasificación (ascendente/descendente) utilizado para ordenar los resultados de la consulta. El valor predeterminado es descendente.

    Los valores son ASCENDING o DESCENDING.

Respuestas

  • 200 application/vnd.atlas.2024-08-05+json

    Vale

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • resultados matriz[objeto]

      Lista de documentos devueltos que MongoDB nube proporciona al completar esta solicitud.

      Ocultar atributos de resultados Mostrar atributos de resultados Objeto
      • Fecha de factura cadena(fecha-hora)

        Fecha de facturación de la partida. Este parámetro expresa su valor en el formato de marca de tiempo ISO 8601 en UTC.

      • nombre del clúster string

        Clúster asociado con la partida presupuestaria.

      • Descripción string

        Descripción del artículo de línea, que puede incluir el nombre del SKU y otra información de identificación.

      • ID de grupo string

        Identificación del grupo asociado con la línea del artículo.

        El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.

      • cantidad número(doble)

        Cantidad de artículo de línea en unidades asociadas con SKU.

      • PrecioTotalCentavos integer(int64)

        Precio * cantidad en unidades aplicables, expresada como un número entero de centavos.

      • PrecioUnitario en Dólares número(doble)

        Precio en unidades asociadas al SKU para la línea de artículo.

      • fecha de uso cadena(fecha-hora)

        Fecha de uso de la línea de pedido. Este parámetro expresa su valor en el formato de marca de tiempo ISO 8601 en UTC.

    • recuento total integer(int32)

      Número total de documentos disponibles. MongoDB Cloud omite este valor si includeCount se establece en false. El número total es una estimación y puede no ser exacto.

      El valor mínimo es 0.

  • 400 aplicación/json

    Solicitud incorrecta.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecto.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos matriz[objeto]

        Describe todas las violaciones en una solicitud de cliente.

        Ocultar atributos de campos Mostrar atributos de campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros matriz[objeto]

      Parámetros utilizados para dar más información sobre el error.

    • razón string

      Se devolvió un mensaje de error de aplicación con este error.

  • 401 aplicación/json

    No autorizado.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecto.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos matriz[objeto]

        Describe todas las violaciones en una solicitud de cliente.

        Ocultar atributos de campos Mostrar atributos de campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros matriz[objeto]

      Parámetros utilizados para dar más información sobre el error.

    • razón string

      Se devolvió un mensaje de error de aplicación con este error.

  • 403 aplicación/json

    Forbidden.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecto.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos matriz[objeto]

        Describe todas las violaciones en una solicitud de cliente.

        Ocultar atributos de campos Mostrar atributos de campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros matriz[objeto]

      Parámetros utilizados para dar más información sobre el error.

    • razón string

      Se devolvió un mensaje de error de aplicación con este error.

  • 404 aplicación/json

    No se encontró.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecto.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos matriz[objeto]

        Describe todas las violaciones en una solicitud de cliente.

        Ocultar atributos de campos Mostrar atributos de campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros matriz[objeto]

      Parámetros utilizados para dar más información sobre el error.

    • razón string

      Se devolvió un mensaje de error de aplicación con este error.

  • 500 aplicación/json

    Error Interno del Servidor.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecto.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos matriz[objeto]

        Describe todas las violaciones en una solicitud de cliente.

        Ocultar atributos de campos Mostrar atributos de campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros matriz[objeto]

      Parámetros utilizados para dar más información sobre el error.

    • razón string

      Se devolvió un mensaje de error de aplicación con este error.

OBTENER /api/atlas/v2/orgs/{orgId}/facturas/{invoiceId}/lineItems:search
atlas api invoices searchInvoiceLineItems --help
import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20241023001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
	client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.SearchOrgInvoiceLineItemsApiParams{}
	sdkResp, httpResp, err := client.InvoicesApi.
		SearchOrgInvoiceLineItemsWithParams(ctx, params).
		Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2024-10-23+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/lineItems:search?pretty=true"
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2024-10-23+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/lineItems:search?pretty=true"
Solicitar ejemplos
{
  "filters": {
    "billEndDate": "2026-05-04",
    "billStartDate": "2026-05-04",
    "clusterIds": [
      "32b6e34b3d91647abb20e7b8"
    ],
    "groupIds": [
      "32b6e34b3d91647abb20e7b8"
    ],
    "includeZeroCentLineItems": true,
    "skuServices": [
      "Atlas"
    ],
    "usageEndDate": "2026-05-04",
    "usageStartDate": "2026-05-04"
  },
  "sortField": "USAGE_DATES",
  "sortOrder": "ASCENDING"
}
Ejemplos de respuestas (200)
{
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "results": [
    {
      "billDate": "2026-05-04T09:42:00Z",
      "clusterName": "string",
      "description": "string",
      "groupId": "32b6e34b3d91647abb20e7b8",
      "quantity": 42.0,
      "totalPriceCents": 42,
      "unitPriceDollars": 42.0,
      "usageDate": "2026-05-04T09:42:00Z"
    }
  ],
  "totalCount": 42
}
Ejemplos de respuestas (400)
{
  "error": 400,
  "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  "reason": "Bad Request",
  "errorCode": "VALIDATION_ERROR"
}
Ejemplos de respuestas (401)
{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}
Ejemplos de respuestas (403)
{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}
Ejemplos de respuestas (404)
{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}
Ejemplos de respuestas (500)
{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}