Get invoice details

BILL-generated ID of the invoice. The value begins with 00e.

Set as true if the invoice is archived

Invoice record status.

When recordStatus is ACTIVE, archived is set as false. For any other recordStatus value, archived is set as true.

User-generated invoice number. This value can be your chosen number scheme.

If you do not set this field, invoiceNumber is auto-generated.

Invoice creation date. This value is in the yyyy-MM-dd format.

If you do not set this field, invoiceDate is set as the date when the invoice is created.

Invoice due date. The value is in the yyyy-MM-dd format.

If you do not set this field, dueDate is set as the date when the invoice is created.

BILL-generated ID of the customer. The value begins with 0cu.

Name of the customer the invoice is issued to.

Invoice total amount

Invoice due amount. The value is calculated by subtracting any applied credits (creditAmount), scheduled payment (scheduledAmount), and cleared payment from totalAmount.

Invoice scheduled amount. The value is set as the customer payment amount that is pending clearance.

Credit amount applied to the invoice.

When a credit amount is applied to an invoice, the invoice status is set as PARTIAL_PAYMENT or PAID_IN_FULL depending on the invoice totalAmount.

Invoice status.

Invoice exchange rate

BILL-generated ID of the user that created the invoice. The value begins with 006.

Invoice created time

Invoice updated time

BILL-generated ID of the chart of accounts for the invoice payment. The value begins with 0ca.

BILL-generated ID of the SALES_TAX item. The value begins with 0ii. The tax rate is applied to all the invoice line items set as taxable.

Invoice sales tax amount. The value is set based on salesTaxItemId.

Invoice sales tax percentage. The value is set based on salesTaxItemId.

Set as true if the card payment option is enabled for the invoice

BILL-generated ID of the invoice PDF. The value begins with att.

The invoice PDF is sent as an email attachment when you send an invoice to a customer. The invoice PDF also appears when the customer clicks the invoice payment link to complete the invoice payment.

Reason the invoice is not eligible for financing. This field is empty when the invoice is eligible or the reason is not available.

• INACTIVE: Invoice is inactive.
• PAID_BY_CUSTOMER: Invoice was paid by the customer.
• ALREADY_FINANCED_OR_SCHEDULED_TO_FINANCE: Invoice was already financed or is scheduled for automatic financing.
• ALREADY_FINANCED: Invoice was already financed and can't be financed again.
• AWAITING_CUSTOMER_ACCEPTANCE: Your customer hasn't accepted the invoice yet. When they do, we'll determine eligibility
• INSUFFICIENT_CREDIT: You don't have enough available credit.
• BELOW_MINIMUM_AMOUNT: Invoice doesn't meet the required minimum amount.
• UNABLE_TO_FINANCE: Unable to finance this invoice at this time.
• DUE_DATE_NOT_ELIGIBLE: Due date is later than Invoice Financing allows.
• NO_LONGER_ELIGIBLE: Invoice is no longer eligible for financing.
• PAST_DUE_BALANCE_REPAY_CURRENT_AMOUNT_DUE: You have a past due balance. To finance more invoices, repay the current amount due.
• APPLICATION_NOT_APPROVED: We're unable to approve your Invoice Financing application at this time.
• AMOUNT_INCREASED_NOT_APPROVED: Invoice amount was increased after it was sent and your customer hasn't approved it. You can revert the invoice to the original amount or wait for the customer to approve the new amount.
• AUTO_FINANCING_SCHEDULED: Invoice is scheduled for automatic financing.
• FINANCING_IN_PROGRESS: Invoice is already in the process of being financed.
• ELIGIBILITY_UNKNOWN_CONTACT_SUPPORT: Unable to identify the financing eligibility of this invoice. Contact support directly for more information.
• BANK_ACCOUNT_WAITING_PERIOD_OR_MFA_NOT_ENABLED: Bank account is either new and has a 7 day waiting period or you need to setup MFA to ensure your account is protected.
• UNDEFINED: Unable to identify the financing eligibility of this invoice. Contact support directly for more information.