GET
/
invoices
/
{invoice_id}

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

invoice_id
string
required

Response

200 - application/json

Structure of 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[]
revenueInfo
object
invoiceDetails
object
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

List invoicesList pricing rule logs