Get invoices

get https://sandbox.hurdlr.com/rest/v5/invoicing/invoices

Get all invoices for the authenticated user

time	status	user agent
Retrieving recent requests…

Loading…

Response

Response body

object

data

array of objects

The list of entities

data

object

sendEmail

boolean

Whether an email of the invoice will be sent to client

int64

Invoice id of draft invoice to finalize and send

apiInvoiceId

string

Id of the invoice record in your DB

clientId

int64

Client id for this invoice

date

The creation date of the invoice

name

string

Name of the invoice

invoiceNo

int32

Invoice number

invoicePrefix

string

The prefix of the name of the invoice

totalAmount

number

The total amount of the invoice

discountAmount

number

The total dollar amount to be discounted (you can provide a discountAmount or a discountPercent, but not both, as it affects the format of the invoice)

discountPercent

number

The total percent to be discounted (you can provide a discountAmount or a discountPercent, but not both, as it affects the format of the invoice)

term

string

enum

Invoice term for the invoice

DUE_NOW NET_10 NET_15 NET_30 NET_60 OTHER

dueDate

date

The due date of the invoice

string

The email to send the invoice to

ccEmails

array of strings

List of emails to be cc'ed on the invoice email

ccEmails

bccEmails

array of strings

List of emails to be cc'ed on the invoice email

bccEmails

personalNote

string

An optional personal note to add to the invoice

frequency

string

enum

Invoice frequency

ONE_TIME WEEKLY BI_WEEKLY MONTHLY YEARLY AFTER_TWO_MINS

status

string

enum

Status of the invoice

OPEN CLOSED CANCELLED DRAFT REFUNDED SCHEDULED

emailStatus

string

enum

Status of the email of the invoice

SUCCESS FAILURE_TOKEN_INVALIDATED FAILURE_TOKEN_POSSIBLY_EXPIRED FAILURE_INVOICE_NOT_FOUND FAILURE_OTHER SENDING NOT_SENT FAILURE_BOUNCED WARNING_AUTO_RESPONSE

sentDate

date

Date the invoice was sent

lastViewedDate

date

The last date the client viewed the invoice

reminderSchedule

array of strings

enum

List of payment reminder frequencies for this invoice

ON_DUE_DATE THREE_DAYS_AFTER_DUE_DATE EVERY_SEVEN_DAYS_AFTER_DUE_DATE AFTER_TWO_MINS

reminderSchedule

lastCreatedRecurringInvoice

date

Date of the last created recurring invoice

parentId

int64

Id of parent for recurring invoices

isRecurringParent

boolean

Whether this invoice is a recurring parent

refundStatus

string

enum

Status of the refund corresponding to this invoice

PENDING SUCCEEDED FAILED UNKNOWN

invoicePaymentUrl

string

URL at which the client can pay this invoice

emailErrors

object

Email errors incurred for this invoice

Has additional fields

acceptCash

boolean

Whether the client can pay by cash/check. At least one of acceptCash, acceptCredit, or acceptACH must be true.

acceptCredit

boolean

Whether the client can pay by debit/credit card. At least one of acceptCredit, acceptCash, or acceptACH must be true.

acceptACH

boolean

If set to true, the client can pay by cash/check. At least one of acceptCredit or acceptCash or acceptACH must be set to true.

customData

object

Custom JSON in which you can store any data with max length of 2000 characters

Has additional fields

payments

array of objects

An array of Invoice Payments associated with this invoice. Only populated if includePayments is set to true.

payments

object

int64

Id of the payment, required when updating an existing payment

invoiceId

int64

required

Id of the invoice to pay

bankTransferId

int64

Id of the bank transfer (bank deposit) that this payment was reconciled against

apiName

string

enum

Name of the API that this payment originated from

THIRD_PARTY_PAYMENTS STRIPE USER_ENTRY

apiPaymentId

string

Id of the payment in your DB (or from your payment processor)

apiAccountNo

string

Mask of the user's bank account, often the last 4 digits of the account number

apiAccountName

string

Display name for the bank account from which this income originated

apiInstitutionId

string

Name or id of the institution from which this transaction originated

bankAccountId

int64

required

id of the user's bank account

bankDescription

string

Transaction description, similar to what will show on the user's bank statement

grossPaymentAmount

number

The total amount to apply to the invoice, required for third-party payments

feePaymentAmount

number

The service fee to process the payment (subtracted out of the grossPaymentAmount)

amountApplied

number

Total amount applied towards the invoice

paymentSource

string

Display name for the payment

date

Date of the payment

status

string

enum

Status of the payment, required for third-party payments

PROCESSED CANCELED REFUNDED PENDING FAILED INACTIVE

reviewStatus

string

enum

Review status of the expense

PARTNER_REVIEW_REQUIRED USER_REVIEW_REQUIRED ACCOUNTANT_REVIEW_REQUIRED RECONCILIATION_STAGED RECONCILED RECONCILIATION_DISCREPANCY ADJUSTMENT_USER_REVIEW_REQUIRED ADJUSTMENT_ACCOUNTANT_REVIEW_REQUIRED ADJUSTMENT_RECONCILIATION_STAGED

receiptUrl

string

Url at which the receipt can be accessed

errorMessage

string

Further detail or reasoning describing the status of the payment for FAILED, CANCELLED, REFUNDED, or INACTIVE invoices

customData

object

Custom JSON in which you can store any data with max length of 2000 characters

Has additional fields

balance

number

Remaining balance left to be paid on the invoice. Only populated if includePayments is set to true.

amountPaid

number

The total amount of payments on the invoice. Only populated if includePayments is set to true.

pendingAmountPaid

number

The total amount of pending payments on the invoice. Only populated if includePayments is set to true.

apiName

string

enum

Name of the API from which this invoice originated

USER_ENTRY QBO XERO PARTNER_IMPLEMENTATION

lastUpdatedDate

date-time

Date filter - to be used in your subsequent request

cursor

string

Cursor to be used in your subsequent paginated request. Only populated if there are more pages available.

deletedIds

array of int32s

Ids of entities that no longer match the request's filter criteria since the request's lastUpdatedDate

deletedIds

Language

Credentials

OAuth2

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://sandbox.hurdlr.com/rest/v5/invoicing/invoices \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200successful operation