Partilhar via


Billing Accounts - List

Lista as contas de cobrança às quais um usuário tem acesso.

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts?api-version=2024-04-01
GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts?includeAll={includeAll}&includeAllWithoutBillingProfiles={includeAllWithoutBillingProfiles}&includeDeleted={includeDeleted}&includePendingAgreement={includePendingAgreement}&includeResellee={includeResellee}&legalOwnerTID={legalOwnerTID}&legalOwnerOID={legalOwnerOID}&api-version=2024-04-01&filter={filter}&expand={expand}&top={top}&skip={skip}&search={search}

Parâmetros do URI

Name Em Necessário Tipo Description
api-version
query True

string

A versão da API a ser usada com a solicitação do cliente. A versão atual é 2024-04-01.

expand
query

string

Expandir é permitido para SoldTo e EnrollmentDetails/PONumber.

filter
query

string

A opção de consulta de filtro permite que os clientes filtrem uma coleção de recursos que são endereçados por uma URL de solicitação.

includeAll
query

boolean

Quando verdadeiros, os resultados incluirão Contas de cobrança nas quais o usuário não tem uma atribuição de função direta se o usuário tiver uma das seguintes funções do AAD: Administrador Global, Leitor Global, Administrador de Cobrança.

includeAllWithoutBillingProfiles
query

boolean

Quando verdadeiro, os resultados incluirão Contas de Cobrança que não serão totalmente criadas se o usuário tiver uma das seguintes funções do AAD: Administrador Global, Leitor Global, Administrador de Cobrança.

includeDeleted
query

boolean

Quando verdadeiro, os resultados incluirão todas as contas de faturamento em um estado excluído.

includePendingAgreement
query

boolean

Inclui contas de cobrança com contrato pendente de assinatura ao qual o usuário tem acesso.

includeResellee
query

boolean

Inclui a conta de cobrança do cliente do Contrato de Parceiro Microsoft ao qual o usuário tem acesso.

legalOwnerOID
query

string

Deve ser combinado com legalOwnerTID, os resultados incluirão apenas Contas de Faturamento para quem é legalmente responsável pelas Contas de Faturamento. Opcional.

legalOwnerTID
query

string

Deve ser combinado com legalOwnerOID, os resultados incluirão apenas Contas de Faturamento para quem é legalmente responsável pelas Contas de Faturamento. Opcional.

search
query

string

A opção de consulta de pesquisa permite que os clientes solicitem itens dentro de uma coleção correspondente a uma expressão de pesquisa de texto livre. A pesquisa só é suportada para campos de cadeia de caracteres.

skip
query

integer

int64

A opção ignorar consulta solicita o número de itens na coleção consultada que devem ser ignorados e não incluídos no resultado.

top
query

integer

int64

A opção de consulta superior solicita que o número de itens na coleção consultada seja incluído no resultado. O valor máximo suportado para o topo é 50.

Respostas

Name Tipo Description
200 OK

BillingAccountListResult

A lista de contas de cobrança.

Other Status Codes

ErrorResponse

Resposta de erro descrevendo por que a operação falhou.

Exemplos

BillingAccountForLegacyAccountDetails
BillingAccountsList
BillingAccountsListWithExpandForPONumber

BillingAccountForLegacyAccountDetails

Pedido de amostra

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts?api-version=2024-04-01

Resposta da amostra

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/20000000-0000-0000-0000-000000000001",
      "name": "20000000-0000-0000-0000-000000000001",
      "properties": {
        "accountStatus": "Active",
        "accountType": "Individual",
        "agreementType": "MicrosoftOnlineServicesProgram",
        "displayName": "Individual Account 2",
        "hasReadAccess": true,
        "notificationEmailAddress": "individual@domain.com"
      },
      "type": "Microsoft.Billing/billingAccounts"
    }
  ]
}

BillingAccountsList

Pedido de amostra

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts?api-version=2024-04-01

Resposta da amostra

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
      "name": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
      "properties": {
        "accountStatus": "Active",
        "accountType": "Business",
        "accountSubType": "Enterprise",
        "agreementType": "MicrosoftCustomerAgreement",
        "displayName": "Premier Business Account",
        "hasReadAccess": true,
        "primaryBillingTenantId": "20000000-0000-0000-0000-000000000001"
      },
      "type": "Microsoft.Billing/billingAccounts",
      "systemData": {
        "createdAt": "2023-01-04T22:39:34.2606750Z",
        "lastModifiedAt": "2023-01-05T22:39:34.2606750Z"
      }
    },
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/20000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
      "name": "20000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
      "properties": {
        "accountStatus": "Active",
        "accountType": "Business",
        "accountSubType": "Professional",
        "agreementType": "MicrosoftCustomerAgreement",
        "displayName": "Standard Business Account",
        "hasReadAccess": true,
        "primaryBillingTenantId": "20000000-0000-0000-0000-000000000001"
      },
      "type": "Microsoft.Billing/billingAccounts",
      "systemData": {
        "createdAt": "2023-01-04T22:39:34.2606750Z",
        "lastModifiedAt": "2023-01-05T22:39:34.2606750Z"
      }
    },
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/30000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
      "name": "30000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
      "properties": {
        "accountStatus": "Active",
        "accountType": "Individual",
        "accountSubType": "Individual",
        "agreementType": "MicrosoftCustomerAgreement",
        "displayName": "Individual Account",
        "hasReadAccess": true,
        "primaryBillingTenantId": "20000000-0000-0000-0000-000000000001"
      },
      "type": "Microsoft.Billing/billingAccounts",
      "systemData": {
        "createdAt": "2023-01-04T22:39:34.2606750Z",
        "lastModifiedAt": "2023-01-05T22:39:34.2606750Z"
      }
    },
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/40000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
      "name": "40000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
      "properties": {
        "accountStatus": "Active",
        "accountType": "Business",
        "accountSubType": "Enterprise",
        "agreementType": "MicrosoftPartnerAgreement",
        "displayName": "Premier Business Account",
        "hasReadAccess": true,
        "primaryBillingTenantId": "20000000-0000-0000-0000-000000000001"
      },
      "type": "Microsoft.Billing/billingAccounts",
      "systemData": {
        "createdAt": "2023-01-04T22:39:34.2606750Z",
        "lastModifiedAt": "2023-01-05T22:39:34.2606750Z"
      }
    }
  ]
}

BillingAccountsListWithExpandForPONumber

Pedido de amostra

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts?api-version=2024-04-01&expand=soldTo,enrollmentDetails/poNumber

Resposta da amostra

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/6564892",
      "name": "6564892",
      "properties": {
        "accountStatus": "Active",
        "accountType": "Enterprise",
        "accountSubType": "None",
        "agreementType": "EnterpriseAgreement",
        "displayName": "Enterprise Account",
        "enrollmentDetails": {
          "startDate": "2018-05-01T17:32:28Z",
          "endDate": "2019-05-31T17:32:28Z",
          "currency": "USD",
          "channel": "EaDirect",
          "language": "en",
          "countryCode": "US",
          "billingCycle": "Monthly",
          "extendedTermOption": "Opted-Out",
          "supportLevel": "Standard",
          "supportCoverage": "1/26/2021 - 6/30/2021",
          "cloud": "Azure Commercial",
          "poNumber": "poNumber123"
        },
        "hasReadAccess": true,
        "soldTo": {
          "addressLine1": "Test Address",
          "city": "City",
          "companyName": "Enterprise Company",
          "country": "US",
          "postalCode": "00000-1111",
          "region": "WA"
        }
      },
      "type": "Microsoft.Billing/billingAccounts",
      "systemData": {
        "createdAt": "2023-01-04T22:39:34.2606750Z",
        "lastModifiedAt": "2023-01-05T22:39:34.2606750Z"
      }
    }
  ]
}

Definições

Name Description
AccountStatus

O status atual da conta de cobrança.

AccountSubType

O nível da conta.

AccountType

O tipo de cliente.

AgreementType

O tipo de acordo.

BillingAccount

Uma conta de faturação.

BillingAccountListResult

Um contêiner para uma lista de recursos

BillingAccountProperties

Uma conta de faturação.

BillingAccountStatusReasonCode

Motivo para o status da conta de faturamento especificado.

BillingRelationshipType

Identifica as relações de faturamento representadas por uma conta de faturamento. A relação de cobrança pode ser entre a Microsoft, o cliente e/ou um terceiro.

createdByType

O tipo de identidade que criou o recurso.

EnrollmentDetails

As propriedades de uma inscrição.

ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta de erro

ExtendedTermOption

A extensão da conta de faturação optada pela empresa.

IndirectRelationshipInfo

Identifica o perfil de faturamento vinculado a outro perfil de faturamento no movimento de compra indireta.

MarkupStatus

Status de marcação da inscrição, aplicável apenas para inscrições indiretas.

ProvisioningState

O estado de provisionamento do recurso durante uma operação de longa duração.

RegistrationNumber

Descreve o número de registro da organização vinculado à conta de cobrança.

SoldTo

O endereço do indivíduo ou organização responsável pela conta de cobrança.

SupportLevel

A oferta de nível de suporte associada a uma inscrição.

systemData

Metadados referentes à criação e última modificação do recurso.

TaxIdentifier

Um identificador fiscal para a conta de cobrança.

TaxIdentifierStatus

O status do identificador de imposto.

TaxIdentifierType

O tipo do identificador de imposto.

AccountStatus

O status atual da conta de cobrança.

Name Tipo Description
Active

string

Deleted

string

Disabled

string

Expired

string

Extended

string

New

string

Other

string

Pending

string

Terminated

string

Transferred

string

UnderReview

string

AccountSubType

O nível da conta.

Name Tipo Description
Enterprise

string

Individual

string

None

string

Other

string

Professional

string

AccountType

O tipo de cliente.

Name Tipo Description
Business

string

ClassicPartner

string

Enterprise

string

Individual

string

Internal

string

Other

string

Partner

string

Reseller

string

Tenant

string

AgreementType

O tipo de acordo.

Name Tipo Description
EnterpriseAgreement

string

MicrosoftCustomerAgreement

string

MicrosoftOnlineServicesProgram

string

MicrosoftPartnerAgreement

string

Other

string

BillingAccount

Uma conta de faturação.

Name Tipo Description
id

string

ID de recurso totalmente qualificado para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

name

string

O nome do recurso

properties

BillingAccountProperties

Uma conta de faturação.

systemData

systemData

Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.

tags

object

Dicionário de metadados associados ao recurso. Ele pode não ser preenchido para todos os tipos de recursos. Comprimento máximo de chave/valor suportado de 256 caracteres. Chaves/valor não devem esvaziar valor nem nulo. As chaves não podem conter <> % & \ ? /

type

string

O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

BillingAccountListResult

Um contêiner para uma lista de recursos

Name Tipo Description
nextLink

string

O link (url) para a próxima página de resultados.

value

BillingAccount[]

A lista de recursos.

BillingAccountProperties

Uma conta de faturação.

Name Tipo Description
accountStatus

AccountStatus

O status atual da conta de cobrança.

accountStatusReasonCode

BillingAccountStatusReasonCode

Motivo para o status da conta de faturamento especificado.

accountSubType

AccountSubType

O nível da conta.

accountType

AccountType

O tipo de cliente.

agreementType

AgreementType

O tipo de acordo.

billingRelationshipTypes

BillingRelationshipType[]

Identifica as relações de faturamento representadas por uma conta de faturamento. A relação de cobrança pode ser entre a Microsoft, o cliente e/ou um terceiro.

displayName

string

O nome da conta de cobrança.

enrollmentDetails

EnrollmentDetails

As propriedades de uma inscrição.

hasNoBillingProfiles

boolean

Indica se a conta de cobrança tem ou não perfis de cobrança.

hasReadAccess

boolean

Indica se o usuário tem acesso de leitura à conta de cobrança.

notificationEmailAddress

string

Endereço de e-mail de notificação para conta herdada. Disponível para o tipo de contrato Programa Microsoft Online Services.

primaryBillingTenantId

string

O inquilino que foi utilizado para configurar a conta de faturação. Por padrão, apenas os usuários desse locatário podem obter atribuições de função na conta de cobrança e todas as compras são provisionadas nesse locatário.

provisioningState

ProvisioningState

O estado de provisionamento do recurso durante uma operação de longa duração.

qualifications

string[]

Qualificações para a definição de preços de uma conta de faturação. Os valores podem ser Comerciais, Educacionais, Beneficentes ou Governamentais.

registrationNumber

RegistrationNumber

Descreve o número de registro da organização vinculado à conta de cobrança.

soldTo

SoldTo

O endereço do indivíduo ou organização responsável pela conta de cobrança.

taxIds

TaxIdentifier[]

Uma lista de identificadores fiscais para a conta de cobrança.

BillingAccountStatusReasonCode

Motivo para o status da conta de faturamento especificado.

Name Tipo Description
Expired

string

ManuallyTerminated

string

Other

string

TerminateProcessing

string

Transferred

string

UnusualActivity

string

BillingRelationshipType

Identifica as relações de faturamento representadas por uma conta de faturamento. A relação de cobrança pode ser entre a Microsoft, o cliente e/ou um terceiro.

Name Tipo Description
CSPCustomer

string

CSPPartner

string

Direct

string

IndirectCustomer

string

IndirectPartner

string

Other

string

createdByType

O tipo de identidade que criou o recurso.

Name Tipo Description
Application

string

Key

string

ManagedIdentity

string

User

string

EnrollmentDetails

As propriedades de uma inscrição.

Name Tipo Description
billingCycle

string

O ciclo de faturamento da inscrição.

channel

string

O tipo de canal da inscrição.

cloud

string

A nuvem da inscrição.

countryCode

string

O código do país da inscrição.

currency

string

A moeda de cobrança da inscrição.

endDate

string

A data final da inscrição.

extendedTermOption

ExtendedTermOption

A extensão da conta de faturação optada pela empresa.

indirectRelationshipInfo

IndirectRelationshipInfo

As propriedades de uma inscrição que são aplicáveis apenas para inscrições indiretas.

invoiceRecipient

string

O contato que recebe as faturas da inscrição.

language

string

O idioma para a inscrição.

markupStatus

MarkupStatus

Status de marcação da inscrição, aplicável apenas para inscrições indiretas.

poNumber

string

O número da ordem de compra da inscrição.

startDate

string

A data de início da inscrição.

supportCoverage

string

O período de cobertura de suporte para a inscrição.

supportLevel

SupportLevel

A oferta de nível de suporte associada a uma inscrição.

ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.

Name Tipo Description
info

object

As informações adicionais.

type

string

O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Name Tipo Description
additionalInfo

ErrorAdditionalInfo[]

O erro informações adicionais.

code

string

O código de erro.

details

ErrorDetail[]

Os detalhes do erro.

message

string

A mensagem de erro.

target

string

O destino do erro.

ErrorResponse

Resposta de erro

Name Tipo Description
error

ErrorDetail

O objeto de erro.

ExtendedTermOption

A extensão da conta de faturação optada pela empresa.

Name Tipo Description
Opted-In

string

Opted-Out

string

Other

string

IndirectRelationshipInfo

Identifica o perfil de faturamento vinculado a outro perfil de faturamento no movimento de compra indireta.

Name Tipo Description
billingAccountName

string

O nome da conta de faturamento do parceiro ou do cliente para um movimento indireto.

billingProfileName

string

O nome do perfil de faturamento do parceiro ou do cliente para uma movimentação indireta.

displayName

string

O nome de exibição do parceiro ou cliente para um movimento indireto.

MarkupStatus

Status de marcação da inscrição, aplicável apenas para inscrições indiretas.

Name Tipo Description
Disabled

string

Locked

string

Other

string

Preview

string

Published

string

ProvisioningState

O estado de provisionamento do recurso durante uma operação de longa duração.

Name Tipo Description
Canceled

string

Failed

string

New

string

Pending

string

Provisioning

string

Succeeded

string

RegistrationNumber

Descreve o número de registro da organização vinculado à conta de cobrança.

Name Tipo Description
id

string

O número de identificação único da organização associado à conta de faturação.

required

boolean

Identifica se o número de registro é necessário para a conta de cobrança.

type

string[]

Os tipos de número de registo permitidos com base no país da conta de faturação.

SoldTo

O endereço do indivíduo ou organização responsável pela conta de cobrança.

Name Tipo Description
addressLine1

string

Endereço linha 1.

addressLine2

string

Endereço linha 2.

addressLine3

string

Endereço linha 3.

city

string

Cidade do endereço.

companyName

string

Nome da empresa. Opcional para MCA Individual (Pay-as-you-go).

country

string

O código do país utiliza o formato ISO 3166-1 Alpha-2.

district

string

Endereço distrito.

email

string

Endereço de e-mail.

firstName

string

Nome próprio. Opcional para MCA Enterprise.

isValidAddress

boolean

Indica se o endereço está incompleto.

lastName

string

Apelido. Opcional para MCA Enterprise.

middleName

string

Nome do meio.

phoneNumber

string

Número de telefone.

postalCode

string

Código postal.

region

string

Região de endereço.

SupportLevel

A oferta de nível de suporte associada a uma inscrição.

Name Tipo Description
Developer

string

Other

string

Pro-Direct

string

Standard

string

systemData

Metadados referentes à criação e última modificação do recurso.

Name Tipo Description
createdAt

string

O carimbo de data/hora da criação de recursos (UTC).

createdBy

string

A identidade que criou o recurso.

createdByType

createdByType

O tipo de identidade que criou o recurso.

lastModifiedAt

string

O carimbo de data/hora da última modificação do recurso (UTC)

lastModifiedBy

string

A identidade que modificou o recurso pela última vez.

lastModifiedByType

createdByType

O tipo de identidade que modificou o recurso pela última vez.

TaxIdentifier

Um identificador fiscal para a conta de cobrança.

Name Tipo Description
country

string

O país do identificador fiscal.

id

string

A ID do identificador de imposto.

scope

string

O escopo do identificador de imposto.

status

TaxIdentifierStatus

O status do identificador de imposto.

type

TaxIdentifierType

O tipo do identificador de imposto.

TaxIdentifierStatus

O status do identificador de imposto.

Name Tipo Description
Invalid

string

Other

string

Valid

string

TaxIdentifierType

O tipo do identificador de imposto.

Name Tipo Description
BrazilCcmId

string

BrazilCnpjId

string

BrazilCpfId

string

CanadianFederalExempt

string

CanadianProvinceExempt

string

ExternalTaxation

string

IndiaFederalServiceTaxId

string

IndiaFederalTanId

string

IndiaPanId

string

IndiaStateCstId

string

IndiaStateGstINId

string

IndiaStateVatId

string

IntlExempt

string

LoveCode

string

MobileBarCode

string

NationalIdentificationNumber

string

Other

string

PublicSectorId

string

USExempt

string

VatId

string