Method: customers.invoices.list

특정 월의 결제 설정과 연결된 모든 인보이스를 반환합니다.

발생한 오류 목록: AuthenticationError AuthorizationError FieldError HeaderError InternalError InvoiceError QuotaError RequestError

HTTP 요청

GET https://googleads.googleapis.com/v14/customers/{customerId}/invoices

URL은 gRPC 트랜스코딩 구문을 사용합니다.

경로 매개변수

매개변수
customerId

string

필수 항목입니다. 인보이스를 가져올 고객의 ID입니다.

쿼리 매개변수

매개변수
billingSetup

string

필수 항목입니다. 요청된 인보이스의 결제 설정 리소스 이름입니다.

customers/{customerId}/billingSetups/{billing_setup_id}
issueYear

string

필수 항목입니다. 인보이스를 가져올 발행 연도입니다(yyyy 형식). 2019년 이후에 발행된 인보이스만 검색할 수 있습니다.
issueMonth

enum (MonthOfYear)

필수 항목입니다. 인보이스를 가져올 발행 월입니다.

요청 본문

요청 본문은 비어 있어야 합니다.

응답 본문

InvoiceService.ListInvoices의 응답 메시지입니다.

성공할 경우 응답 본문에 다음 구조의 데이터가 포함됩니다.

JSON 표현 
{
  "invoices": [
    {
      object (Invoice)
    }
  ]
}
필드
invoices[]

object (Invoice)

결제 설정 및 기간과 일치하는 인보이스 목록입니다.

승인 범위

다음 OAuth 범위가 필요합니다.

  • https://www.googleapis.com/auth/adwords

자세한 내용은 OAuth 2.0 개요를 참고하세요.

인보이스

인보이스 모든 인보이스 정보는 PDF 인보이스와 일치하도록 스냅샷 처리됩니다. 인보이스 서비스 출시 전의 인보이스의 경우 스냅샷 처리된 정보가 PDF 인보이스와 일치하지 않을 수 있습니다.

JSON 표현 
{
  "resourceName": string,
  "type": enum (InvoiceType),
  "serviceDateRange": {
    object (DateRange)
  },
  "adjustmentsSubtotalAmountMicros": string,
  "adjustmentsTaxAmountMicros": string,
  "adjustmentsTotalAmountMicros": string,
  "regulatoryCostsSubtotalAmountMicros": string,
  "regulatoryCostsTaxAmountMicros": string,
  "regulatoryCostsTotalAmountMicros": string,
  "replacedInvoices": [
    string
  ],
  "accountBudgetSummaries": [
    {
      object (AccountBudgetSummary)
    }
  ],
  "accountSummaries": [
    {
      object (AccountSummary)
    }
  ],
  "id": string,
  "billingSetup": string,
  "paymentsAccountId": string,
  "paymentsProfileId": string,
  "issueDate": string,
  "dueDate": string,
  "currencyCode": string,
  "exportChargeSubtotalAmountMicros": string,
  "exportChargeTaxAmountMicros": string,
  "exportChargeTotalAmountMicros": string,
  "subtotalAmountMicros": string,
  "taxAmountMicros": string,
  "totalAmountMicros": string,
  "correctedInvoice": string,
  "pdfUrl": string
}
필드
resourceName

string

출력 전용. 인보이스의 리소스 이름입니다. 여러 고객이 하나의 인보이스를 공유할 수 있으므로 여러 리소스 이름이 동일한 인보이스를 가리킬 수도 있습니다. 인보이스 리소스 이름의 형식은 다음과 같습니다.

customers/{customerId}/invoices/{invoice_id}
type

enum (InvoiceType)

출력 전용. 인보이스 유형입니다.
serviceDateRange

object (DateRange)

출력 전용. 이 인보이스의 서비스 기간입니다. 종료일도 포함됩니다.
adjustmentsSubtotalAmountMicros

string (int64 format)

출력 전용. 인보이스 수준 조정의 세전 소계 금액(마이크로 단위)입니다.
adjustmentsTaxAmountMicros

string (int64 format)

출력 전용. 인보이스 수준 조정에 대한 세금의 합계(마이크로 단위)입니다.
adjustmentsTotalAmountMicros

string (int64 format)

출력 전용. 인보이스 수준 조정의 총 금액(마이크로 단위)입니다.
regulatoryCostsSubtotalAmountMicros

string (int64 format)

출력 전용. 인보이스 수준 규제 비용의 세전 소계 금액(마이크로 단위)입니다.
regulatoryCostsTaxAmountMicros

string (int64 format)

출력 전용. 인보이스 수준 규제 비용에 대한 세금의 합계(마이크로 단위)입니다.
regulatoryCostsTotalAmountMicros

string (int64 format)

출력 전용. 인보이스 수준 규제 비용의 총금액(마이크로 단위)입니다.
replacedInvoices[]

string

출력 전용. 이 인보이스로 재청구 또는 대체되는 원래 인보이스의 리소스 이름입니다(해당하는 경우). 인보이스 통합으로 인해 교체된 인보이스가 여러 개 있을 수 있습니다. 교체된 인보이스는 동일한 결제 계정에 속하지 않을 수 있습니다. replacedInvoices가 설정되면 correctedInvoice가 설정되지 않습니다. 인보이스 리소스 이름의 형식은 다음과 같습니다.

customers/{customerId}/invoices/{invoice_id}
accountBudgetSummaries[]

object (AccountBudgetSummary)

출력 전용. 이 인보이스와 연결된 요약된 계정 예산 정보의 목록입니다.
accountSummaries[]

object (AccountSummary)

출력 전용. 이 인보이스와 연결된 요약된 계정 정보의 목록입니다.
id

string

출력 전용. 인보이스의 ID입니다. 인보이스 PDF의 '인보이스 번호'로 표시됩니다.
billingSetup

string

출력 전용. 이 인보이스 결제 설정의 리소스 이름입니다.

customers/{customerId}/billingSetups/{billing_setup_id}
paymentsAccountId

string

출력 전용. 결제 설정과 연결된 결제 계정을 식별하는 데 사용되는 16자리 ID입니다(예: '1234-5678-9012-3456'). 인보이스 PDF의 '결제 계정 번호'로 표시됩니다.
paymentsProfileId

string

출력 전용. 결제 설정과 연결된 결제 프로필을 식별하는 데 사용되는 12자리 ID입니다(예: '1234-5678-9012'). 인보이스 PDF의 '결제 ID'로 표시됩니다.
issueDate

string

출력 전용. yyyy-mm-dd 형식의 발행일입니다. 인보이스 PDF에 '발행일' 또는 '인보이스 날짜'로 표시됩니다.
dueDate

string

출력 전용. yyyy-mm-dd 형식으로 된 마감일입니다.
currencyCode

string

출력 전용. 통화 코드입니다. 모든 비용이 이 통화로 반환됩니다. ISO 4217 표준에서 파생된 통화 코드의 하위 집합이 지원됩니다.
exportChargeSubtotalAmountMicros

string (int64 format)

출력 전용. 인보이스 수준 내보내기 요금의 세전 소계 금액(마이크로 단위)입니다.
exportChargeTaxAmountMicros

string (int64 format)

출력 전용. 인보이스 수준 내보내기 요금에 포함된 세금의 합계(마이크로 단위)입니다.
exportChargeTotalAmountMicros

string (int64 format)

출력 전용. 인보이스 수준 내보내기 요금의 총 금액(마이크로 단위)입니다.
subtotalAmountMicros

string (int64 format)

출력 전용. 세전 소계 금액(마이크로 단위)입니다. AccountBudgetSummary 소계 금액과 인보이스.adjustments_subtotal_amount_micros의 합계와 같습니다.
taxAmountMicros

string (int64 format)

출력 전용. 인보이스에 표시된 모든 세금의 합계(단위: 마이크로)입니다. AccountBudgetSummary 세액과 특정 계정 예산과 관련 없는 세금을 더한 합과 같습니다.
totalAmountMicros

string (int64 format)

출력 전용. 총 금액(마이크로 단위)입니다. 이 금액은 인보이스.subtotal_amount_micros, 인보이스.tax_amount_micros, 인보이스.regulatory_costs_subtotal_amount_micros, 인보이스.export_charge_subtotal_amount_micros (V14.1로 시작하는 별도의 항목으로 구분됨)의 합계와 같습니다.
correctedInvoice

string

출력 전용. 이 인보이스로 정정, 취소 또는 취소된 원래 인보이스의 리소스 이름입니다(해당하는 경우). correctedInvoice가 설정되면 replacedInvoices가 설정되지 않습니다. 인보이스 리소스 이름의 형식은 다음과 같습니다.

customers/{customerId}/invoices/{invoice_id}
pdfUrl

string

출력 전용. 인보이스의 PDF 사본 URL입니다. 이 URL로 PDF를 요청하려면 사용자가 OAuth 토큰을 전달해야 합니다.

InvoiceType

가능한 인보이스 유형입니다.

열거형
UNSPECIFIED 지정되지 않음
UNKNOWN 반환 값에만 사용됩니다. 이 버전에서 알 수 없는 값을 나타냅니다.
CREDIT_MEMO 금액이 음수인 인보이스 계정에 크레딧이 제공됩니다.
INVOICE 금액이 양수인 인보이스 계정에 잔액이 부족합니다.

AccountBudgetSummary

요약된 계정 예산 청구 가능 비용을 나타냅니다.

JSON 표현 
{
  "billableActivityDateRange": {
    object (DateRange)
  },
  "invalidActivitySummaries": [
    {
      object (InvalidActivitySummary)
    }
  ],
  "customer": string,
  "customerDescriptiveName": string,
  "accountBudget": string,
  "accountBudgetName": string,
  "purchaseOrderNumber": string,
  "subtotalAmountMicros": string,
  "taxAmountMicros": string,
  "totalAmountMicros": string,
  "servedAmountMicros": string,
  "billedAmountMicros": string,
  "overdeliveryAmountMicros": string,
  "invalidActivityAmountMicros": string
}
필드
billableActivityDateRange

object (DateRange)

출력 전용. 이 인보이스의 서비스 기간 내에 있는 계정 예산의 청구 가능 활동 기간입니다. 종료일도 포함됩니다. 이 시간은 계정 예산의 시작 시간 및 종료 시간과 다를 수 있습니다.
invalidActivitySummaries[]

object (InvalidActivitySummary)

출력 전용. 원래 연결이 있는 무효 활동 크레딧 요약 목록입니다.
customer

string

출력 전용. 이 계정 예산과 연결된 고객의 리소스 이름입니다. 여기에는 고객 ID가 포함되며 인보이스 PDF에 '계정 ID'로 표시됩니다. 고객 리소스 이름의 형식은 다음과 같습니다.

customers/{customerId}
customerDescriptiveName

string

출력 전용. 계정 예산의 고객을 설명하는 이름입니다. 인보이스 PDF에 '계정'으로 표시됩니다.
accountBudget

string

출력 전용. 이 청구 가능 비용과 연결된 계정 예산의 리소스 이름입니다. AccountBudget 리소스 이름의 형식은 다음과 같습니다.

customers/{customerId}/accountBudgets/{account_budget_id}
accountBudgetName

string

출력 전용. 계정 예산의 이름입니다. 인보이스 PDF에 '계정 예산'으로 표시됩니다.
purchaseOrderNumber

string

출력 전용. 계정 예산의 구매주문서 번호입니다. 인보이스 PDF에 '구매주문서'로 표시됩니다.
subtotalAmountMicros

string (int64 format)

출력 전용. 서비스 기간 동안 이 예산에서 발생한 세전 소계 금액(마이크로 단위)입니다.
taxAmountMicros

string (int64 format)

출력 전용. 서비스 기간 동안 이 예산에 해당하는 세액입니다(마이크로 단위).
totalAmountMicros

string (int64 format)

출력 전용. 서비스 기간 동안 이 예산에 발생한 총금액(마이크로 단위)입니다. 이는 계정 예산 소계 금액과 계정 예산 세액의 합계와 같습니다.
servedAmountMicros

string (int64 format)

출력 전용. 서비스 기간 동안 이 예산에서 발생한 세전 게재 금액(마이크로 단위)입니다. 인보이스와 게재 데이터를 조정할 때만 유용합니다.
billedAmountMicros

string (int64 format)

출력 전용. 서비스 기간 동안 이 예산에서 발생한 세전 청구 금액(마이크로 단위)입니다. 여기에는 조정이 반영되지 않습니다.
overdeliveryAmountMicros

string (int64 format)

출력 전용. 서비스 기간 동안 이 예산에서 발생한 세전 초과게재 금액이며 마이크로 (음수 값)로 표시됩니다.
invalidActivityAmountMicros

string (int64 format)

출력 전용. 이전 달 예산에서 발생한 세전 무효 활동 금액이며 단위는 마이크로 (음수 값)입니다.

InvalidActivitySummary

수정할 인보이스의 추가 세부정보가 포함된 인보이스의 무효 활동에 대한 세부정보입니다.

JSON 표현 
{
  "originalMonthOfService": enum (MonthOfYear),
  "originalYearOfService": string,
  "originalInvoiceId": string,
  "originalAccountBudgetName": string,
  "originalPurchaseOrderNumber": string,
  "amountMicros": string
}
필드
originalMonthOfService

enum (MonthOfYear)

출력 전용. 이 무효 활동 크레딧과 관련된 원래 서비스 기간(월)입니다.
originalYearOfService

string

출력 전용. 이 무효 활동 크레딧과 관련된 원래 서비스 기간입니다.
originalInvoiceId

string

출력 전용. 이 무효 활동 크레딧과 관련된 원래 인보이스 번호입니다.
originalAccountBudgetName

string

출력 전용. 이 무효 활동 크레딧과 관련된 원래 계정 예산 이름입니다.
originalPurchaseOrderNumber

string

출력 전용. 이 무효 활동 크레딧과 관련된 원래 구매주문서 번호입니다.
amountMicros

string (int64 format)

출력 전용. 무효 활동 금액(마이크로 단위)입니다.

AccountSummary

계정 수준의 요약 보기를 나타냅니다.

JSON 표현 
{
  "customer": string,
  "billingCorrectionSubtotalAmountMicros": string,
  "billingCorrectionTaxAmountMicros": string,
  "billingCorrectionTotalAmountMicros": string,
  "couponAdjustmentSubtotalAmountMicros": string,
  "couponAdjustmentTaxAmountMicros": string,
  "couponAdjustmentTotalAmountMicros": string,
  "excessCreditAdjustmentSubtotalAmountMicros": string,
  "excessCreditAdjustmentTaxAmountMicros": string,
  "excessCreditAdjustmentTotalAmountMicros": string,
  "regulatoryCostsSubtotalAmountMicros": string,
  "regulatoryCostsTaxAmountMicros": string,
  "regulatoryCostsTotalAmountMicros": string,
  "exportChargeSubtotalAmountMicros": string,
  "exportChargeTaxAmountMicros": string,
  "exportChargeTotalAmountMicros": string,
  "subtotalAmountMicros": string,
  "taxAmountMicros": string,
  "totalAmountMicros": string
}
필드
customer

string

출력 전용. 계정 요약과 연결된 계정입니다.
billingCorrectionSubtotalAmountMicros

string (int64 format)

출력 전용. 세전 결제 조정 소계 금액(마이크로 단위)입니다.
billingCorrectionTaxAmountMicros

string (int64 format)

출력 전용. 결제 수정에 대한 세금(마이크로 단위)입니다.
billingCorrectionTotalAmountMicros

string (int64 format)

출력 전용. 총 결제 수정 금액(마이크로 단위)입니다.
couponAdjustmentSubtotalAmountMicros

string (int64 format)

출력 전용. 세전 쿠폰 조정 소계 금액(마이크로 단위)입니다.
couponAdjustmentTaxAmountMicros

string (int64 format)

출력 전용. 쿠폰 조정에 부과되는 세금(마이크로 단위)입니다.
couponAdjustmentTotalAmountMicros

string (int64 format)

출력 전용. 총 쿠폰 조정 금액(마이크로 단위)입니다.
excessCreditAdjustmentSubtotalAmountMicros

string (int64 format)

출력 전용. 세전 초과 크레딧 조정 소계 금액(마이크로 단위)입니다.
excessCreditAdjustmentTaxAmountMicros

string (int64 format)

출력 전용. 초과 크레딧 조정에 대한 세금(마이크로 단위)입니다.
excessCreditAdjustmentTotalAmountMicros

string (int64 format)

출력 전용. 총 초과 크레딧 조정 금액(마이크로 단위)입니다.
regulatoryCostsSubtotalAmountMicros

string (int64 format)

출력 전용. 세전 규제 비용의 소계 금액(마이크로 단위)입니다.
regulatoryCostsTaxAmountMicros

string (int64 format)

출력 전용. 규제 비용에 부과되는 세금(마이크로 단위)입니다.
regulatoryCostsTotalAmountMicros

string (int64 format)

출력 전용. 총 규제 비용 금액(마이크로 단위)입니다.
exportChargeSubtotalAmountMicros

string (int64 format)

출력 전용. 세전 수출 청구액 소계 금액(마이크로 단위)입니다.
exportChargeTaxAmountMicros

string (int64 format)

출력 전용. 수출 요금에 부과되는 세금(마이크로 단위)입니다.
exportChargeTotalAmountMicros

string (int64 format)

출력 전용. 총 수출 청구 금액(마이크로 단위)입니다.
subtotalAmountMicros

string (int64 format)

출력 전용. 서비스 기간 동안 계정에서 발생한 세전 소계 총액(마이크로 단위)입니다.
taxAmountMicros

string (int64 format)

출력 전용. 서비스 기간 동안 계정에 발생한 총 세액(마이크로 단위)입니다.
totalAmountMicros

string (int64 format)

출력 전용. 서비스 기간 동안 계정에 발생한 총금액(마이크로 단위)입니다. 이는 subtotalAmountMicros 및 taxAmountMicros의 합과 같습니다.