Skip to main content
GET
Get Invoice Payment Promises

Authorizations

Authorization
string
header
required

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

Path Parameters

invoice_id
string
required

Response

Successful Response

id
string
required
created_at
string<date-time>
required
promised_to_pay_date
string<date> | null
required
source
enum<string> | null
required
Available options:
email,
call,
sms,
user,
integration_sync
partner_id
string | null
required
invoice_id
string | null
required
email_id
string | null
required
call_id
string | null
required
sms_id
string | null
required
sms_thread_id
string | null
required
created_by_user_id
string | null
required
extracted_invoice_number
string | null
required
payment_type
enum<string> | null
required
Available options:
ach,
wire,
check,
other
sent_date
string<date> | null
required
amount
string<decimal> | null
required
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
currency
string | null
required
is_calculated
boolean
required
is_promised_date_updated
boolean
required
agent_confidence_score
integer | null
required
agent_confidence_reason
string | null
required
agent_uncertainties
string[]
required
agent_error_code
string | null
required