Docs Home

/ /

Facturas

Docs Home

/ /

Obtén una factura de la organización

URL base: https://cloud.mongodb.com/api/public/v1.0

Resource

GET /orgs/{ORG-ID}/invoices/{INVOICE-ID}

Parámetros de ruta de solicitud

Nombre	Tipo	Descripción
`ORG-ID`	string	Identificador único de la organización.
`INVOICE-ID`	string	Identificador único de la factura. Los cargos normalmente se publican al día siguiente.

Parámetros de Solicitud Query

Los siguientes parámetros de query son opcionales:

Nombre	Tipo	Necesidad	Descripción	predeterminado
Num. de pág.	Número	Opcional	Entero basado en uno que devuelve una subsección de resultados.	`1`
elementosPorPágina	Número	Opcional	Número de elementos a devolver por página, hasta un máximo de 500.	`100`
bonito	booleano	Opcional	Indicador que indica si el cuerpo de la respuesta debe estar en un prettyprint formato.	`false`
envelope	booleano	Opcional	Bandera que indica si se debe o no envolver la respuesta en un sobre. Algunos clientes de 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. Para los endpoints que devuelven una lista de resultados, el objeto `content` es un sobre. Cloud Manager añade el campo `status` al cuerpo de la respuesta.	`false`
backupJobsEnabledOnly	booleano	Opcional	Indicador que indica si se deben excluir los demonios que no están habilitados para hacer copias de seguridad de bases de datos de la respuesta. Establece esto en `false` para incluir las configuraciones del demonio con la bandera `backupJobsEnabled` establecida en `false`.	`true`

Parámetros del cuerpo de la solicitud

Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.

Respuesta

Si configuras el elemento de query envelope en true, la respuesta estará envuelta en el objeto content.

La respuesta HTTP retorna un documento JSON que incluye los siguientes objetos:

Nombre

Tipo

Descripción

amountBilledCents

Número

Cantidad facturada en esta factura, calculada como subtotalCents + salesTaxCents - startingBalanceCents

amountPaidCents

Número

Cantidad pagada por esta factura.

created

string

Marca de tiempo en formato de fecha y hora ISO 8601 en UTC cuando se creó esta factura.

creditsCents

Número

Cantidad acreditada por MongoDB, en centavos de dólar estadounidenses.

endDate

string

Marca de tiempo en formato de fecha y hora ISO 8601 en UTC cuando finalizó el período de facturación de esta factura.

groupId

string

Identificador único del proyecto con el que se asocia la factura. No aparece en todas las facturas.

id

string

Identificador único de esta factura.

lineItems

objeto arreglo

Partidas individuales en la factura. Esta información también se encuentra en la sección Usage Details de la página de facturas en la interfaz de usuario de Cloud Manager.

Cada objeto en el arreglo incluye los siguientes campos:

Item

Descripción

clusterName

El nombre del clúster que incurrió en el cargo

created

Marca de tiempo en formato de fecha y hora ISO 8601 en UTC cuando se registró el elemento de línea en la factura.

endDate

Marca de tiempo en formato de fecha y hora ISO 8601 en UTC cuando finalizó el período al que se aplica el elemento de línea.

discountCents

Cantidad descontada en centavos de dólar estadounidense. Se muestra cuando es aplicable.

groupId

ID del proyecto con el que se asocia el elemento de línea.

note

Nota sobre el concepto individual.

percentDiscount

Porcentaje de descuento. Se muestra cuando es aplicable.

quantity

Número de unidades del ítem de línea (por ejemplo: GB, horas, etc.).

replicaSetName

Nombre del set de réplicas con el que está asociado el detalle de línea.

sku

Descripción del item da linha. Pode ser el tipo de instancia, una tasa de soporte, seguridad avanzada, etc.

startDate

Marca de tiempo en formato de fecha y hora ISO 8601 en UTC cuando comenzó el período al que se aplica el elemento de línea.

totalPriceCents

Precio total para el artículo de línea, en centavos de USD. Igual a

 unitPriceDollars * quantity * 100

unitPriceDollars

Costo del ítem, en dólares.

links

objeto arreglo

Uno o más enlaces a subrecursos y/o recursos relacionados. Los tipos de relación entre las URLs se explican en la Especificación de Enlace Web.

orgId

string

Identificador único para la organización que recibió esta factura.

payments

objeto arreglo

Pagos aplicados a la factura. Los objetos en el arreglo payments incluyen los siguientes campos:

Campo

Descripción

amountBilledCents

El monto de la factura, en centavos de USD.

amountPaidCents

La cantidad que el cliente pagó, en centavos de USD.

created

Marca de tiempo en formato de fecha y hora ISO 8601 en UTC de la fecha en que se registró el pago.

id

Identificador único del pago.

salesTaxCents

Importe del impuesto sobre las ventas pagado, en centavos de dólar estadounidense.

statusName

Estado del pago.

Estado	Descripción
`CANCELLED`	El pago ha sido cancelado.
`FAILED`	El intento de cobrar a la tarjeta de crédito falló.
`FORGIVEN`	El pago fue creado, pero posteriormente fue perdonado.
`NEW`	El pago se ha creado, pero no se ha intentado realizar un cargo en la tarjeta de crédito.
`PAID`	El pago fue exitoso.

subtotalCents

Suma de todos los conceptos positivos en la factura, en centavos de dólares estadounidenses (USD).

updated

Marca de tiempo en formato de fecha y hora ISO 8601 en UTC que indica la última vez que se actualizó el objeto.

refunds

objeto arreglo

Reembolsos emitidos para la factura. Los objetos en el arreglo refunds incluyen los siguientes campos:

Campo	Descripción
`amountCents`	El importe del reembolso, en céntimos de dólares estadounidenses.
`created`	Marca de tiempo en formato de fecha y hora ISO 8601 en UTC de la fecha en que se registró el reembolso.
`reason`	Razón del reembolso.
`paymentId`	Identificador único del pago.

salesTaxCents

Número

Cantidad de impuestos cobrados sobre subtotalCents.

startDate

string

Marca de tiempo en formato de fecha y hora ISO 8601 en UTC de la fecha de inicio de esta factura.

statusName

string

Estado de esta factura. Los valores aceptados son:

Estado	Descripción
`CLOSED`	Se han finalizado todos los cargos del ciclo de suscripción, el saldo es superior a cero y al cliente aún no se le ha cobrado.
`FAILED`	No se pudo realizar el cobro a la tarjeta de crédito por el monto adeudado.
`FORGIVEN`	Se ha cobrado al cliente, pero se ha perdonado el cargo.
`FREE`	El monto resultó ser cero, por lo que no se cobra al cliente.
`PAID`	Los fondos han sido transferidos a MongoDB, Inc.
`PENDING`	Incluye cargos para el ciclo de suscripción actual. Un cliente nunca debe tener más de una factura en este estado.
`PREPAID`	El cliente tiene un plan prepago, por lo que no se le cobra nada.

subtotalCents

Número

Suma de todas las partidas de facturas positivas en centavos de USD.

updated

string

Marca de tiempo en formato de fecha y hora ISO 8601 en UTC cuando se actualizó por última vez la factura.

Solicitud de ejemplo

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
 --header "Accept: application/json" \
 --include \
 --request GET "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/invoices/{INVOICE-ID}"

Respuesta de ejemplo

Nota

En la siguiente respuesta de ejemplo, el arreglo lineItems se ha truncado para facilitar su visualización.

{
  "amountBilledCents" : 240,
  "amountPaidCents" : 240,
  "created" : "2018-04-01T06:14:31Z",
  "endDate" : "2018-05-01T00:00:00Z",
  "id" : "{INVOICE-ID}",
  "lineItems" : [ {
    "clusterName" : "{CLUSTER-NAME}",
    "created" : "2018-05-01T04:05:31Z",
    "endDate" : "2018-05-01T00:00:00Z",
    "groupId" : "{PROJECT-ID}",
    "quantity" : 72.0,
    "replicaSetName": "rs0",
    "sku" : "CLOUD_MANAGER_BASIC",
    "startDate" : "2018-04-30T00:00:00Z",
    "totalPriceCents" : 0,
    "unitPriceDollars" : 0.0
  }, {
    "clusterName" : "{CLUSTER-NAME}",
    "created" : "2018-04-30T04:05:19Z",
    "endDate" : "2018-04-30T00:00:00Z",
    "groupId" : "{PROJECT-ID}",
    "quantity" : 72.0,
    "replicaSetName": "rs0",
    "sku" : "CLOUD_MANAGER_BASIC",
    "startDate" : "2018-04-29T00:00:00Z",
    "totalPriceCents" : 0,
    "unitPriceDollars" : 0.0
  },
  ... ,
  {
    "clusterName" : "{CLUSTER-NAME}",
    "created" : "2018-04-02T06:05:07Z",
    "endDate" : "2018-04-02T00:00:00Z",
    "groupId" : "{PROJECT-ID}",
    "quantity" : 72.0,
    "replicaSetName": "rs0",
    "sku" : "CLOUD_MANAGER_BASIC",
    "startDate" : "2018-04-01T00:00:00Z",
    "totalPriceCents" : 0,
    "unitPriceDollars" : 0.0
  } ],
  "links" : [ {
    "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}",
    "rel" : "http://mms.mongodb.com/org"
  }, {
    "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/invoices/{INVOICE-ID}",
    "rel" : "self"
  } ],
  "orgId" : "{ORG-ID}",
  "payments" : [ {
    "amountBilledCents" : 240,
    "amountPaidCents" : 240,
    "created" : "2018-05-01T04:05:14Z",
    "id" : "{PAYMENT-ID}",
    "salesTaxCents" : 19,
    "statusName" : "PAID",
    "subtotalCents" : 221,
    "updated" : "2018-05-01T07:00:46Z"
  } ],
  "refunds" : [ ],
  "salesTaxCents" : 19,
  "startDate" : "2018-04-01T00:00:00Z",
  "startingBalanceCents" : 0,
  "statusName" : "PAID",
  "subtotalCents" : 221,
  "updated" : "2018-05-01T07:00:46Z"

Volver

Obtener todo

Obtener factura pendiente