Skip to main content
POST
Sync An Invoice

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

amount_due
integer
required

The amount to be paid on invoice, in the currency's smallest unit. (e.g. 10.00 USD -> 1000)

currency
enum<string>
required

The invoice's currency code (e.g. USD).

Available options:
ADP,
AED,
AFA,
AFN,
ALK,
ALL,
AMD,
ANG,
AOA,
AOK,
AON,
AOR,
ARA,
ARL,
ARM,
ARP,
ARS,
ATS,
AUD,
AWG,
AZM,
AZN,
BAD,
BAM,
BAN,
BBD,
BDT,
BEC,
BEF,
BEL,
BGL,
BGM,
BGN,
BGO,
BHD,
BIF,
BMD,
BND,
BOB,
BOL,
BOP,
BOV,
BRB,
BRC,
BRE,
BRL,
BRN,
BRR,
BRZ,
BSD,
BTN,
BUK,
BWP,
BYB,
BYN,
BYR,
BZD,
CAD,
CDF,
CHE,
CHF,
CHW,
CLE,
CLF,
CLP,
CNH,
CNX,
CNY,
COP,
COU,
CRC,
CSD,
CSK,
CUC,
CUP,
CVE,
CYP,
CZK,
DDM,
DEM,
DJF,
DKK,
DOP,
DZD,
ECS,
ECV,
EEK,
EGP,
ERN,
ESA,
ESB,
ESP,
ETB,
EUR,
FIM,
FJD,
FKP,
FRF,
GBP,
GEK,
GEL,
GHC,
GHS,
GIP,
GMD,
GNF,
GNS,
GQE,
GRD,
GTQ,
GWE,
GWP,
GYD,
HKD,
HNL,
HRD,
HRK,
HTG,
HUF,
IDR,
IEP,
ILP,
ILR,
ILS,
INR,
IQD,
IRR,
ISJ,
ISK,
ITL,
JMD,
JOD,
JPY,
KES,
KGS,
KHR,
KMF,
KPW,
KRH,
KRO,
KRW,
KWD,
KYD,
KZT,
LAK,
LBP,
LKR,
LRD,
LSL,
LTL,
LTT,
LUC,
LUF,
LUL,
LVL,
LVR,
LYD,
MAD,
MAF,
MCF,
MDC,
MDL,
MGA,
MGF,
MKD,
MKN,
MLF,
MMK,
MNT,
MOP,
MRO,
MRU,
MTL,
MTP,
MUR,
MVP,
MVR,
MWK,
MXN,
MXP,
MXV,
MYR,
MZE,
MZM,
MZN,
NAD,
NGN,
NIC,
NIO,
NLG,
NOK,
NPR,
NZD,
OMR,
PAB,
PEI,
PEN,
PES,
PGK,
PHP,
PKR,
PLN,
PLZ,
PTE,
PYG,
QAR,
RHD,
ROL,
RON,
RSD,
RUB,
RUR,
RWF,
SAR,
SBD,
SCR,
SDD,
SDG,
SDP,
SEK,
SGD,
SHP,
SIT,
SKK,
SLE,
SLL,
SOS,
SRD,
SRG,
SSP,
STD,
STN,
SUR,
SVC,
SYP,
SZL,
THB,
TJR,
TJS,
TMM,
TMT,
TND,
TOP,
TPE,
TRL,
TRY,
TTD,
TWD,
TZS,
UAH,
UAK,
UGS,
UGX,
USD,
USN,
USS,
UYI,
UYP,
UYU,
UYW,
UZS,
VEB,
VED,
VEF,
VES,
VND,
VNN,
VUV,
WST,
XAF,
XAG,
XAU,
XBA,
XBB,
XBC,
XBD,
XCD,
XCG,
XDR,
XEU,
XFO,
XFU,
XOF,
XPD,
XPF,
XPT,
XRE,
XSU,
XTS,
XUA,
XXX,
YDD,
YER,
YUD,
YUM,
YUN,
YUR,
ZAL,
ZAR,
ZMK,
ZMW,
ZRN,
ZRZ,
ZWD,
ZWL,
ZWR
Maximum string length: 3
object
string
required
remote_id
string
required

The invoice's third party API ID.

total_amount
integer
required

The total amount of the invoice, including tax and allowances, in the currency's smallest unit. (e.g. 10.00 USD -> 1000)

id
string
Maximum string length: 32
amount_paid
integer

The invoice's total amount paid, in the currency's smallest unit. (e.g. 10.00 USD -> 1000)

assignee
object
billing_address
object
billing_address_id
integer | null
billing_email
string | null
Maximum string length: 255
calls
object[]
created_at
string<date-time>
custom_fields
any
due_date
string<date-time> | null

The invoice's due date.

emails
object[]
in_dispute
boolean

Whether an invoice is in dispute. If it is, we exclude it from any outreach.

is_issued_email_sent
boolean

Whether the email to notify the customer that the invoice has been issued was sent.

issued_at
string<date-time> | null

The invoice's issue date.

last_outreach_at
string<date-time> | null

The last date outreach was sent for this invoice.

last_outreach_channel
enum<string> | null

The last channel outreach was sent in for this invoice (phone or email).

Available options:
email,
call,
null
Maximum string length: 5
last_outreach_to
string | null

The last recipient of outreach that was sent for this invoice (email address or phone number).

last_synced_at
string<date-time> | null
line_items
object[]
linked_integration
object
marked_uncollectible_at
string<date-time> | null

The date the invoice was marked uncollectible.

memo
string | null

A memo visible to the invoice's end user.

modified_at
string<date-time> | null
number
string | null

A unique, identifying string that appears on emails sent to the customer for this invoice.

order_number
string | null

Unique identifier assigned to a purchase by a seller.

paid_at
string<date-time> | null

The date the invoice was paid.

partner
object
partner_id
string | null

The id of the customer this invoice is issued to.

Maximum string length: 32
payments
object[]
pdf
any
pdf_id
string | null
Maximum string length: 32
period_end_date
string<date-time> | null

End of the usage period during which invoice items were added to this invoice.

period_start_date
string<date-time> | null

Start of the usage period during which invoice items were added to this invoice.

private_note
string | null

The invoice's organization-private note.

promised_to_pay_date
string<date> | null

The date the customer has promised to pay the invoice.

purchase_order_number
string | null

Unique identifier assigned to a purchase order by a buyer.

remote_created_at
string<date-time> | null

When the third party's entry was created.

remote_invoice_pdf
string | null

The url to the invoice's third party pdf.

remote_metadata
unknown
remote_modified_at
string<date-time> | null

When the third party's entry was updated.

remote_partner_id
string | null

The invoice's partner's third party id.

remote_payment_portal_url
string | null

The invoice's third party payment url.

remote_payment_status
enum<string> | null

Status of payment on this invoice. NOTE: Source of this status could be different from the source of remote_status, and could be out of sync with it. It is currently controlled Stripe webhooks that receive partner portal session events. If payment was initiated and failed, remote_payment_status should be set to None.

Available options:
processing,
completed,
null
Maximum string length: 10
remote_status
string | null

The invoice's third party status.

requires_line_item_sync
boolean
shipping_address
object
shipping_address_id
integer | null
status
any
subtotal
integer

The total amount of the invoice, tax exclusive, in the currency's smallest unit. (e.g. 10.00 USD -> 1000)

sync_status
enum<string>

The sync status for this entity.

Available options:
partial,
syncing,
synced,
failed
Maximum string length: 7
total_discount
integer

The total discounts applied to the invoice, in the currency's smallest unit. (e.g. 10.00 USD -> 1000)

total_tax
integer

The total tax applied to the invoice, in the currency's smallest unit. (e.g. 10.00 USD -> 1000)

type
enum<string>

Whether the invoice is a PAYABLE (Accounts Payable) or RECEIVABLE (Accounts Receivable).

Available options:
payable,
receivable
Maximum string length: 10
voided_at
string<date-time> | null

The date the invoice was voided.