Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Invoice

Package version

interface

An interface representing Invoice. An invoice resource can be used download a PDF version of an invoice.

extends

Resource

Hierarchy

Index

Properties

Optional billingPeriodIds

billingPeriodIds: string[]
member

{string[]} [billingPeriodIds] Array of billing perdiod ids that the invoice is attributed to. NOTE: This property will not be serialized. It can only be populated by the server.

Optional downloadUrl

downloadUrl: DownloadUrl
member

{DownloadUrl} [downloadUrl] A secure link to download the PDF version of an invoice. The link will cease to work after its expiry time is reached.

Optional id

id: undefined | string
member

{string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional invoicePeriodEndDate

invoicePeriodEndDate: Date
member

{Date} [invoicePeriodEndDate] The end of the date range covered by the invoice. NOTE: This property will not be serialized. It can only be populated by the server.

Optional invoicePeriodStartDate

invoicePeriodStartDate: Date
member

{Date} [invoicePeriodStartDate] The start of the date range covered by the invoice. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string
member

{string} [name] Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional type

type: undefined | string
member

{string} [type] Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

Generated using TypeDoc