Get an invoice

id

string

required

Identifier of invoice

Maximum length: 50

status

enum<string>

required

Status of the invoice

Available options:

DRAFT,

DUE,

PAID,

VOID,

UN_COLLECTIBLE,

REFUND_INITIATED,

REFUND_COMPLETED,

MERGED,

PARTIALLY_PAID

invoiceClass

enum<string>

required

Represents the class of entity( INVOICE/ORDER/BILLABLE)

Available options:

INVOICE,

ORDER,

BILLABLE

invoiceType

enum<string>

required

Represents the type of entity(STANDARD/AD_HOC/COMPOSITE)

Available options:

STANDARD,

AD_HOC,

CUSTOM,

COMPOSITE,

STANDARD_ADVANCED,

ADHOC_ADVANCED

invoiceDate

string

required

Invoice date of the invoice

updatedAt

string

required

totalAmount

number

required

paidAmount

number

required

netTermDays

integer

required

Number of days from the invoice date after which an invoice is considered overdue.

customerId

string

ownerId

string

pricePlanId

string

usageInfo

object[]

usageInfo.id

string

usageInfo.description

string

required

usageInfo.type

enum<string>

required

Type of the line item

GRAND_TOTAL_AMOUNT: Sum of all total amount of individual invoices in a grouped(composite) invoice
TOTAL_AMOUNT: Total revenue of the invoice
NET_AMOUNT: Net revenue of the invoice ( Gross revenue - Discounts )
GROSS_AMOUNT: Gross revenue of the invoice
PRICE_PLAN_AMOUNT: SUB_TOTAL_AMOUNT + true up amount
SUB_TOTAL_AMOUNT: Sum of all rate card revenues
TRUE_UP_AMOUNT: Minimum commitment - SUB_TOTAL_AMOUNT (Always positive)
TOTAL_USAGE: List of all the usage meter usages
USAGE_METER_USAGE: Usage of an usage meter
USAGE_RATE_CARD_AMOUNT: Revenue generated from usage rate card
USAGE_RATE_CARD_SLAB_AMOUNT: Revenue generated from usage rate card slab
FIXED_FEE_RATE_CARD_AMOUNT: Revenue generated from fixed fee rate card
CREDIT_GRANT_RATE_CARD_AMOUNT: : Revenue generated from credit grant rate card
BILLING_ENTITLEMENT_RATE_CARD_AMOUNT: Revenue generated from billing entitlement rate card
ENTITLEMENT_OVERAGE_RATE_CARD_AMOUNT: : Revenue generated from entitlement overage rate card
ENTITLEMENT_OVERAGE_RATE_CARD_SLAB_AMOUNT: Revenue generated from entitlement overage rate card slab
LICENSE_RATE_CARD_AMOUNT: Revenue generated from license rate card
TOTAL_CREDITS: Sum of all credit amounts
SUB_CREDITS: Granted credit value
TOTAL_ADVANCED_FEES: Sum of all advanced fee revenue
ADVANCED_FIXED_FEE: Revenue generated from advanced fixed fee rate card
ADVANCED_LICENSE_RATE_CARD_AMOUNT: Revenue generated from advanced license rate card
ADVANCED_BILLING_ENTITLEMENT_RATE_CARD_AMOUNT: Revenue generated from advanced billing entitlement rate card
ADVANCED_CREDIT_GRANT_RATE_CARD_AMOUNT: Revenue generated from advanced credit grant rate card
TOTAL_MISCELLANEOUS_CHARGES: Net revenue of all MISCELLANEOUS_CHARGE
MISCELLANEOUS_CHARGE: Custom amount added to a DRAFT invoice
TOTAL_PURCHASE_AMOUNT: Net revenue all rate cards in a purchase plan
CUSTOM_AMOUNT: Custom amount added a DRAFT invoice
CUSTOM_TAG: User defined tags given to each rate card
TOTAL_PRICING_RULE_ADDITION_AMOUNT: Sum of all line items added by applying pricing rules
PRICING_RULE_ADDITION_AMOUNT: Amount added to invoice as a result of applying a pricing rule
PRICING_RULE_REVENUE_UPDATE_AMOUNT: Difference in revenue(value) obtained as a result of applying a pricing rule
PRICING_RULE_USAGE_UPDATE_AMOUNT: Difference in usage(quantity) obtained as a result of applying a pricing rule
RATE_CONFIG_ADJUSTMENT_AMOUNT: Difference in revenue obtained as a result of applying rate config['minimumRate', 'maximumRate'] at rate card level

Available options:

TOTAL_USAGE,

USAGE_METER_USAGE,

GRAND_TOTAL_AMOUNT,

TOTAL_AMOUNT,

NET_AMOUNT,

GROSS_AMOUNT,

SUB_TOTAL_AMOUNT,

PRICE_PLAN_AMOUNT,

FIXED_FEE_RATE_CARD_AMOUNT,

CREDIT_GRANT_RATE_CARD_AMOUNT,

BILLING_ENTITLEMENT_RATE_CARD_AMOUNT,

ENTITLEMENT_OVERAGE_RATE_CARD_AMOUNT,

ENTITLEMENT_OVERAGE_RATE_CARD_SLAB_AMOUNT,

LICENSE_RATE_CARD_AMOUNT,

USAGE_CYCLE_AMOUNT,

LICENSE_RATE_CARD_SLAB_AMOUNT,

USAGE_RATE_CARD_AMOUNT,

USAGE_RATE_CARD_SLAB_AMOUNT,

TOTAL_CREDITS,

SUB_CREDITS,

TOTAL_ADVANCED_FEES,

ADVANCED_FIXED_FEE,

ADVANCED_LICENSE_RATE_CARD_AMOUNT,

ADVANCED_BILLING_ENTITLEMENT_RATE_CARD_AMOUNT,

ADVANCED_CREDIT_GRANT_RATE_CARD_AMOUNT,

TOTAL_MISCELLANEOUS_CHARGES,

MISCELLANEOUS_CHARGE,

TRUE_UP_AMOUNT,

TOTAL_PURCHASE_AMOUNT,

CUSTOM_AMOUNT,

CUSTOM_TAG,

TOTAL_PRICING_RULE_ADDITION_AMOUNT,

PRICING_RULE_ADDITION_AMOUNT,

PRICING_RULE_REVENUE_UPDATE_AMOUNT,

PRICING_RULE_USAGE_UPDATE_AMOUNT,

RATE_CONFIG_ADJUSTMENT_AMOUNT,

TOTAL_TAX_AMOUNT,

TAX_AMOUNT,

PROXY_AMOUNT

usageInfo.valuePerQuantity

number

usageInfo.quantity

number

usageInfo.units

string

usageInfo.value

number

required

usageInfo.metadata

object

revenueInfo

object

revenueInfo.description

string

required

revenueInfo.type

enum<string>

required

Type of the line item

GRAND_TOTAL_AMOUNT: Sum of all total amount of individual invoices in a grouped(composite) invoice
TOTAL_AMOUNT: Total revenue of the invoice
NET_AMOUNT: Net revenue of the invoice ( Gross revenue - Discounts )
GROSS_AMOUNT: Gross revenue of the invoice
PRICE_PLAN_AMOUNT: SUB_TOTAL_AMOUNT + true up amount
SUB_TOTAL_AMOUNT: Sum of all rate card revenues
TRUE_UP_AMOUNT: Minimum commitment - SUB_TOTAL_AMOUNT (Always positive)
TOTAL_USAGE: List of all the usage meter usages
USAGE_METER_USAGE: Usage of an usage meter
USAGE_RATE_CARD_AMOUNT: Revenue generated from usage rate card
USAGE_RATE_CARD_SLAB_AMOUNT: Revenue generated from usage rate card slab
FIXED_FEE_RATE_CARD_AMOUNT: Revenue generated from fixed fee rate card
CREDIT_GRANT_RATE_CARD_AMOUNT: : Revenue generated from credit grant rate card
BILLING_ENTITLEMENT_RATE_CARD_AMOUNT: Revenue generated from billing entitlement rate card
ENTITLEMENT_OVERAGE_RATE_CARD_AMOUNT: : Revenue generated from entitlement overage rate card
ENTITLEMENT_OVERAGE_RATE_CARD_SLAB_AMOUNT: Revenue generated from entitlement overage rate card slab
LICENSE_RATE_CARD_AMOUNT: Revenue generated from license rate card
TOTAL_CREDITS: Sum of all credit amounts
SUB_CREDITS: Granted credit value
TOTAL_ADVANCED_FEES: Sum of all advanced fee revenue
ADVANCED_FIXED_FEE: Revenue generated from advanced fixed fee rate card
ADVANCED_LICENSE_RATE_CARD_AMOUNT: Revenue generated from advanced license rate card
ADVANCED_BILLING_ENTITLEMENT_RATE_CARD_AMOUNT: Revenue generated from advanced billing entitlement rate card
ADVANCED_CREDIT_GRANT_RATE_CARD_AMOUNT: Revenue generated from advanced credit grant rate card
TOTAL_MISCELLANEOUS_CHARGES: Net revenue of all MISCELLANEOUS_CHARGE
MISCELLANEOUS_CHARGE: Custom amount added to a DRAFT invoice
TOTAL_PURCHASE_AMOUNT: Net revenue all rate cards in a purchase plan
CUSTOM_AMOUNT: Custom amount added a DRAFT invoice
CUSTOM_TAG: User defined tags given to each rate card
TOTAL_PRICING_RULE_ADDITION_AMOUNT: Sum of all line items added by applying pricing rules
PRICING_RULE_ADDITION_AMOUNT: Amount added to invoice as a result of applying a pricing rule
PRICING_RULE_REVENUE_UPDATE_AMOUNT: Difference in revenue(value) obtained as a result of applying a pricing rule
PRICING_RULE_USAGE_UPDATE_AMOUNT: Difference in usage(quantity) obtained as a result of applying a pricing rule
RATE_CONFIG_ADJUSTMENT_AMOUNT: Difference in revenue obtained as a result of applying rate config['minimumRate', 'maximumRate'] at rate card level

Available options:

TOTAL_USAGE,

USAGE_METER_USAGE,

GRAND_TOTAL_AMOUNT,

TOTAL_AMOUNT,

NET_AMOUNT,

GROSS_AMOUNT,

SUB_TOTAL_AMOUNT,

PRICE_PLAN_AMOUNT,

FIXED_FEE_RATE_CARD_AMOUNT,

CREDIT_GRANT_RATE_CARD_AMOUNT,

BILLING_ENTITLEMENT_RATE_CARD_AMOUNT,

ENTITLEMENT_OVERAGE_RATE_CARD_AMOUNT,

ENTITLEMENT_OVERAGE_RATE_CARD_SLAB_AMOUNT,

LICENSE_RATE_CARD_AMOUNT,

USAGE_CYCLE_AMOUNT,

LICENSE_RATE_CARD_SLAB_AMOUNT,

USAGE_RATE_CARD_AMOUNT,

USAGE_RATE_CARD_SLAB_AMOUNT,

TOTAL_CREDITS,

SUB_CREDITS,

TOTAL_ADVANCED_FEES,

ADVANCED_FIXED_FEE,

ADVANCED_LICENSE_RATE_CARD_AMOUNT,

ADVANCED_BILLING_ENTITLEMENT_RATE_CARD_AMOUNT,

ADVANCED_CREDIT_GRANT_RATE_CARD_AMOUNT,

TOTAL_MISCELLANEOUS_CHARGES,

MISCELLANEOUS_CHARGE,

TRUE_UP_AMOUNT,

TOTAL_PURCHASE_AMOUNT,

CUSTOM_AMOUNT,

CUSTOM_TAG,

TOTAL_PRICING_RULE_ADDITION_AMOUNT,

PRICING_RULE_ADDITION_AMOUNT,

PRICING_RULE_REVENUE_UPDATE_AMOUNT,

PRICING_RULE_USAGE_UPDATE_AMOUNT,

RATE_CONFIG_ADJUSTMENT_AMOUNT,

TOTAL_TAX_AMOUNT,

TAX_AMOUNT,

PROXY_AMOUNT

revenueInfo.value

number

required

revenueInfo.id

string

revenueInfo.valuePerQuantity

number

revenueInfo.quantity

number

revenueInfo.units

string

revenueInfo.metadata

object

invoiceDetails

object

invoiceDetails.customer

object

invoiceDetails.account

object

invoiceDetails.pricePlanName

string

invoiceDetails.invoiceGroup

object

invoiceDetails.organization

object

invoiceDetails.logoUrl

string

finalizingStatus

enum<string>

Available options:

FINALIZING,

FINALIZED

autoAdvance

boolean

startDate

string

Start date of the invoice

endDate

string

End date of the invoice

endDateInclusive

string

Inclusive end date of the invoice

dueDate

string

Due date of the invoice

generatedAt

string

metadata

object

info

object[]

sequenceId

string

Sequence id of the invoice

pdfUrl

string

Download URL of the pdf file corresponding to the invoice

Introduction

APIs

Authorizations

Path Parameters

Response