Skip to content

Properties

idstring
required·

Unique identifier for the invoice

balancestring

Balance amount to be paid

created_atstring · date-time

Date and time when the invoice was created

currencystring

Currency of the invoice

customerobject
created_atstring · date-time

Date and time when the customer was created

emailstring

Email of the customer

idstring

Unique identifier for the customer

namestring

Name of the customer

phonestring

Phone number of the customer

updated_atstring · date-time

Date and time when the customer was last updated

due_datestring · date-time

Due date of the invoice

exchange_ratenumber

Exchange rate of the currency of the invoice

is_recurringboolean

Whether the invoice is recurring or not

issue_datestring · date-time

Date of the invoice

line_itemsobject[]

List of line items associated with the invoice

currencystring

The currency of the line item

descriptionstring

The description of the line item

exchange_ratenumber

The exchange rate of the currency for the line item

idstring

The unique identifier for line item

itemstring

The ID of the item

namestring

The name of the line item

quantitynumber

The quantity of the line item

tax_amountstring

The tax amount of the line item

tax_ratestring

The ID of the tax rate

total_line_amountstring

The total line amount of the line item.

typestring

The type of the line item

unit_pricestring

The unit price of the line item

memostring

Memo of the invoice

numberstring

Invoice number

paid_on_datestring · date-time

Date when the invoice was paid or marked as paid

paymentsobject[]

List of payments associated with the invoice

amountstring

Amount of the payment

created_atstring · date-time

Date and time when the payment was created

currencystring

Currency of the payment

exchange_ratenumber

Exchange rate of the currency of the payment

idstring

Unique identifier for the payment

methodstring

Payment method used for the payment. In case there is no clear mapping, the raw payment method is passed.

Possible values:
cardbank_transfercashcheckpaypalwalletwire_transfer
statusstring

Status of the payment. In case there is no clear mapping, the raw status is passed.

Possible values:
pendingauthorizedpaidpartialrefundedvoidedcancelledunknown
updated_atstring · date-time

Date and time when the payment was last updated

remote_dataRecord<string, any>

Raw data returned from the remote API call.

statusstring

Status of the invoice. In case there is no clear mapping, the raw status is passed.

Possible values:
pendingpaidfailedcancelledrefundeddraft
sub_totalstring

Sub total of the invoice

subscription_idstring

Unique identifier for the subscription associated with the invoice

total_discountstring

Total discount applied to the invoice

total_tax_amountstring

Total tax amount of the invoice

transaction_feestring

Transaction fee on a payment

updated_atstring · date-time

Date and time when the invoice was last updated