Invoices
The Invoice
object represents an itemized record of goods and/or services sold to a customer.
If type = accounts_payable Invoice
is a bill, if type = accounts_receivable it's an invoice.
The Invoice object
Properties
remote_data
RemoteData[]type
EnumACCOUNTS_RECEIVABLE
, ACCOUNTS_PAYABLE
, or - in cases where there is no clear mapping - the original value passed through.contact
Stringnumber
Stringissue_date
Stringdue_date
Stringpaid_on_date
Stringmemo
Stringcompany
Stringcurrency
EnumXUA
, AFN
, AFA
, ALL
, ALK
, DZD
, ADP
, AOA
, AOK
, AON
, AOR
, ARA
, ARS
, ARM
, ARP
, ARL
, AMD
, AWG
, AUD
, ATS
, AZN
, AZM
, BSD
, BHD
, BDT
, BBD
, BYN
, BYB
, BYR
, BEF
, BEC
, BEL
, BZD
, BMD
, BTN
, BOB
, BOL
, BOV
, BOP
, BAM
, BAD
, BAN
, BWP
, BRC
, BRZ
, BRE
, BRR
, BRN
, BRB
, BRL
, GBP
, BND
, BGL
, BGN
, BGO
, BGM
, BUK
, BIF
, XPF
, KHR
, CAD
, CVE
, KYD
, XAF
, CLE
, CLP
, CLF
, CNX
, CNY
, CNH
, COP
, COU
, KMF
, CDF
, CRC
, HRD
, HRK
, CUC
, CUP
, CYP
, CZK
, CSK
, DKK
, DJF
, DOP
, NLG
, XCD
, DDM
, ECS
, ECV
, EGP
, GQE
, ERN
, EEK
, ETB
, EUR
, XBA
, XEU
, XBB
, XBC
, XBD
, FKP
, FJD
, FIM
, FRF
, XFO
, XFU
, GMD
, GEK
, GEL
, DEM
, GHS
, GHC
, GIP
, XAU
, GRD
, GTQ
, GWP
, GNF
, GNS
, GYD
, HTG
, HNL
, HKD
, HUF
, IMP
, ISK
, ISJ
, INR
, IDR
, IRR
, IQD
, IEP
, ILS
, ILP
, ILR
, ITL
, JMD
, JPY
, JOD
, KZT
, KES
, KWD
, KGS
, LAK
, LVL
, LVR
, LBP
, LSL
, LRD
, LYD
, LTL
, LTT
, LUL
, LUC
, LUF
, MOP
, MKD
, MKN
, MGA
, MGF
, MWK
, MYR
, MVR
, MVP
, MLF
, MTL
, MTP
, MRU
, MRO
, MUR
, MXV
, MXN
, MXP
, MDC
, MDL
, MCF
, MNT
, MAD
, MAF
, MZE
, MZN
, MZM
, MMK
, NAD
, NPR
, ANG
, TWD
, NZD
, NIO
, NIC
, NGN
, KPW
, NOK
, OMR
, PKR
, XPD
, PAB
, PGK
, PYG
, PEI
, PEN
, PES
, PHP
, XPT
, PLN
, PLZ
, PTE
, GWE
, QAR
, XRE
, RHD
, RON
, ROL
, RUB
, RUR
, RWF
, SVC
, WST
, SAR
, RSD
, CSD
, SCR
, SLL
, XAG
, SGD
, SKK
, SIT
, SBD
, SOS
, ZAR
, ZAL
, KRH
, KRW
, KRO
, SSP
, SUR
, ESP
, ESA
, ESB
, XDR
, LKR
, SHP
, XSU
, SDD
, SDG
, SDP
, SRD
, SRG
, SZL
, SEK
, CHF
, SYP
, STN
, STD
, TVD
, TJR
, TJS
, TZS
, XTS
, THB
, XXX
, TPE
, TOP
, TTD
, TND
, TRY
, TRL
, TMT
, TMM
, USD
, USN
, USS
, UGX
, UGS
, UAH
, UAK
, AED
, UYW
, UYU
, UYP
, UYI
, UZS
, VUV
, VES
, VEB
, VEF
, VND
, VNN
, CHE
, CHW
, XOF
, YDD
, YER
, YUN
, YUD
, YUM
, YUR
, ZWN
, ZRN
, ZRZ
, ZMW
, ZMK
, ZWD
, ZWR
, ZWL
, or - in cases where there is no clear mapping - the original value passed through.exchange_rate
Stringtotal_discount
Numbersub_total
Numbertotal_tax_amount
Numbertotal_amount
Numberbalance
Numberremote_updated_at
Stringpayments
ArrayPayment
object IDs.line_items
InvoiceLineItem[]The InvoiceLineItem object
InvoiceLineItem
object represents an itemized record of goods and/or services sold to a customer. If type = accounts_payable, invoice is a bill, if type = accounts_receivable it's an invoice.{"description": "Pickleball lessons","unit_price": 50,"quantity": 1,"total_amount": 50,"currency": "USD","exchange_rate": "2.9","item": "5b3c1341-a20f-4e51-b72c-f3830a16c97b","account": "cd0f32d4-a493-11ec-b909-0242ac120002","tracking_category": "b38c59b0-a9d7-4740-b1ee-5436c6751e3d","tracking_categories": ["b38c59b0-a9d7-4740-b1ee-5436c6751e3d","9b840d2-686a-465a-8a8e-7b028498f8e4","a47e11b6-c73b-4a0c-be31-130fc48177fa"],"company": "595c8f97-2ac4-45b7-b000-41bdf43240b5","id": "022a2bef-57e5-4def-8ed2-7c41bd9a5ed8","remote_id": "8765432","field_mappings": {"organization_defined_targets": {"custom_key": "custom_value"},"linked_account_defined_targets": {"custom_key": "custom_value"}}}
Properties
description
Stringunit_price
Numberquantity
Numbertotal_amount
Numbercurrency
EnumXUA
, AFN
, AFA
, ALL
, ALK
, DZD
, ADP
, AOA
, AOK
, AON
, AOR
, ARA
, ARS
, ARM
, ARP
, ARL
, AMD
, AWG
, AUD
, ATS
, AZN
, AZM
, BSD
, BHD
, BDT
, BBD
, BYN
, BYB
, BYR
, BEF
, BEC
, BEL
, BZD
, BMD
, BTN
, BOB
, BOL
, BOV
, BOP
, BAM
, BAD
, BAN
, BWP
, BRC
, BRZ
, BRE
, BRR
, BRN
, BRB
, BRL
, GBP
, BND
, BGL
, BGN
, BGO
, BGM
, BUK
, BIF
, XPF
, KHR
, CAD
, CVE
, KYD
, XAF
, CLE
, CLP
, CLF
, CNX
, CNY
, CNH
, COP
, COU
, KMF
, CDF
, CRC
, HRD
, HRK
, CUC
, CUP
, CYP
, CZK
, CSK
, DKK
, DJF
, DOP
, NLG
, XCD
, DDM
, ECS
, ECV
, EGP
, GQE
, ERN
, EEK
, ETB
, EUR
, XBA
, XEU
, XBB
, XBC
, XBD
, FKP
, FJD
, FIM
, FRF
, XFO
, XFU
, GMD
, GEK
, GEL
, DEM
, GHS
, GHC
, GIP
, XAU
, GRD
, GTQ
, GWP
, GNF
, GNS
, GYD
, HTG
, HNL
, HKD
, HUF
, IMP
, ISK
, ISJ
, INR
, IDR
, IRR
, IQD
, IEP
, ILS
, ILP
, ILR
, ITL
, JMD
, JPY
, JOD
, KZT
, KES
, KWD
, KGS
, LAK
, LVL
, LVR
, LBP
, LSL
, LRD
, LYD
, LTL
, LTT
, LUL
, LUC
, LUF
, MOP
, MKD
, MKN
, MGA
, MGF
, MWK
, MYR
, MVR
, MVP
, MLF
, MTL
, MTP
, MRU
, MRO
, MUR
, MXV
, MXN
, MXP
, MDC
, MDL
, MCF
, MNT
, MAD
, MAF
, MZE
, MZN
, MZM
, MMK
, NAD
, NPR
, ANG
, TWD
, NZD
, NIO
, NIC
, NGN
, KPW
, NOK
, OMR
, PKR
, XPD
, PAB
, PGK
, PYG
, PEI
, PEN
, PES
, PHP
, XPT
, PLN
, PLZ
, PTE
, GWE
, QAR
, XRE
, RHD
, RON
, ROL
, RUB
, RUR
, RWF
, SVC
, WST
, SAR
, RSD
, CSD
, SCR
, SLL
, XAG
, SGD
, SKK
, SIT
, SBD
, SOS
, ZAR
, ZAL
, KRH
, KRW
, KRO
, SSP
, SUR
, ESP
, ESA
, ESB
, XDR
, LKR
, SHP
, XSU
, SDD
, SDG
, SDP
, SRD
, SRG
, SZL
, SEK
, CHF
, SYP
, STN
, STD
, TVD
, TJR
, TJS
, TZS
, XTS
, THB
, XXX
, TPE
, TOP
, TTD
, TND
, TRY
, TRL
, TMT
, TMM
, USD
, USN
, USS
, UGX
, UGS
, UAH
, UAK
, AED
, UYW
, UYU
, UYP
, UYI
, UZS
, VUV
, VES
, VEB
, VEF
, VND
, VNN
, CHE
, CHW
, XOF
, YDD
, YER
, YUN
, YUD
, YUM
, YUR
, ZWN
, ZRN
, ZRZ
, ZMW
, ZMK
, ZWD
, ZWR
, ZWL
, or - in cases where there is no clear mapping - the original value passed through.exchange_rate
Stringitem
Stringaccount
Stringtracking_category
Stringtracking_categories
Arraycompany
Stringid
Stringremote_id
Stringfield_mappings
Objectremote_was_deleted
Booleanid
Stringremote_id
Stringfield_mappings
Object{"remote_data": [{"path": "/actions","data": ["Varies by platform"]}],"type": "ACCOUNTS_RECEIVABLE","contact": "022a2bef-57e5-4def-8ed2-7c41bd9a5ed8","number": "AIQ12546","issue_date": "2020-03-31T00:00:00Z","due_date": "2020-04-15T00:00:00Z","paid_on_date": "2020-04-01T00:00:00Z","memo": "Weekly Payment","company": "595c8f97-2ac4-45b7-b000-41bdf43240b5","currency": "USD","exchange_rate": "2.9","total_discount": 0,"sub_total": 100,"total_tax_amount": 5,"total_amount": 105,"balance": 105,"remote_updated_at": "2020-04-01T00:00:00Z","payments": ["b26fd49a-cbae-470a-a8f8-bcbc119e0390"],"line_items": [{"id": "022a2bef-57e5-4def-8ed2-7c41bd9a5ed8","remote_id": "8765432","description": "Pickleball lessons","unit_price": 50,"quantity": 2,"total_amount": 100,"item": "5b3c1341-a20f-4e51-b72c-f3830a16c97b","account": "cd0f32d4-a493-11ec-b909-0242ac120002","remote_data": [{"path": "/actions","data": ["Varies by platform"]}]}],"remote_was_deleted": true,"id": "9871b4a9-f5d2-4f3b-a66b-dfedbed42c46","remote_id": "990110","field_mappings": {"organization_defined_targets": {"custom_key": "custom_value"},"linked_account_defined_targets": {"custom_key": "custom_value"}}}
/invoices
Returns a list of Invoice
objects.
Header Parameters
Authorization
StringX-Account-Token
StringQuery & Path Parameters
company_id
Stringcontact_id
Stringcreated_after
Stringcreated_before
Stringcursor
Stringexpand
Stringinclude_deleted_data
Booleaninclude_remote_data
Booleanmodified_after
Stringmodified_before
Stringpage_size
Integerremote_fields
Stringremote_id
Stringshow_enum_origins
Stringtype
String{"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw","previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ","results": [{"remote_data": [{"path": "/actions","data": ["Varies by platform"]}],"type": "ACCOUNTS_RECEIVABLE","contact": "022a2bef-57e5-4def-8ed2-7c41bd9a5ed8","number": "AIQ12546","issue_date": "2020-03-31T00:00:00Z","due_date": "2020-04-15T00:00:00Z","paid_on_date": "2020-04-01T00:00:00Z","memo": "Weekly Payment","company": "595c8f97-2ac4-45b7-b000-41bdf43240b5","currency": "USD","exchange_rate": "2.9","total_discount": 0,"sub_total": 100,"total_tax_amount": 5,"total_amount": 105,"balance": 105,"remote_updated_at": "2020-04-01T00:00:00Z","payments": ["b26fd49a-cbae-470a-a8f8-bcbc119e0390"],"line_items": [{"id": "022a2bef-57e5-4def-8ed2-7c41bd9a5ed8","remote_id": "8765432","description": "Pickleball lessons","unit_price": 50,"quantity": 2,"total_amount": 100,"item": "5b3c1341-a20f-4e51-b72c-f3830a16c97b","account": "cd0f32d4-a493-11ec-b909-0242ac120002","remote_data": [{"path": "/actions","data": ["Varies by platform"]}]}],"remote_was_deleted": true,"id": "9871b4a9-f5d2-4f3b-a66b-dfedbed42c46","remote_id": "990110","field_mappings": {"organization_defined_targets": {"custom_key": "custom_value"},"linked_account_defined_targets": {"custom_key": "custom_value"}}}]}

Clear Books
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_items
InvoiceLineItem[]description
stringunit_price
numberquantity
numberbalance
Numbercurrency
Enumdue_date
Stringissue_date
Stringnumber
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringtotal_amount
Numbertotal_tax_amount
Numbertype
Enum
FreeAgent
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_items
InvoiceLineItem[]description
stringunit_price
numberquantity
numbertotal_amount
numberaccount
stringremote_id
stringbalance
Numbercontact
Stringcurrency
Enumdue_date
Stringissue_date
Stringmemo
Stringnumber
Stringpaid_on_date
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringtotal_amount
Numbertype
Enum
FreshBooks
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_items
InvoiceLineItem[]description
stringunit_price
numberquantity
numbertotal_amount
numberremote_id
stringbalance
Numbercontact
Stringcurrency
Enumdue_date
Stringissue_date
Stringnumber
Stringpaid_on_date
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtotal_amount
Numbertotal_discount
Number
Microsoft Dynamics 365 Business Central
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_items
InvoiceLineItem[]description
stringunit_price
numberquantity
numbertotal_amount
numberitem
stringaccount
stringremote_id
stringcontact
Stringcurrency
Enumdue_date
Stringissue_date
Stringnumber
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringtotal_amount
Numbertotal_discount
Numbertotal_tax_amount
Numbertype
Enum
Moneybird
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_items
InvoiceLineItem[]description
stringunit_price
numberquantity
numbertotal_amount
numberitem
stringaccount
stringremote_id
stringbalance
Numbercontact
Stringcurrency
Enumdue_date
Stringissue_date
Stringpaid_on_date
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringtotal_amount
Numbertotal_discount
Numbertype
Enum
NetSuite
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_items
InvoiceLineItem[]description
stringunit_price
numberquantity
numbertotal_amount
numberexchange_rate
stringitem
stringaccount
stringtracking_category
stringtracking_categories
arrayremote_id
stringbalance
Numbercompany
Stringcontact
Stringcurrency
Enumdue_date
Stringexchange_rate
Stringissue_date
Stringmemo
Stringnumber
Stringpaid_on_date
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringsub_total
Numbertotal_amount
Numbertype
Enum
QuickBooks Online
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_items
InvoiceLineItem[]description
stringunit_price
numberquantity
numbertotal_amount
numberitem
stringaccount
stringtracking_category
stringremote_id
stringbalance
Numbercontact
Stringcurrency
Enumdue_date
Stringexchange_rate
Stringissue_date
Stringmemo
Stringnumber
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringtotal_amount
Numbertotal_tax_amount
Numbertype
Enum
Sage Business Cloud Accounting
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_items
InvoiceLineItem[]description
stringunit_price
numberquantity
numbertotal_amount
numberitem
stringremote_id
stringbalance
Numbercontact
Stringcurrency
Enumdue_date
Stringissue_date
Stringnumber
Stringpaid_on_date
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringsub_total
Numbertotal_amount
Numbertotal_discount
Numbertotal_tax_amount
Numbertype
Enum
Sage Intacct
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_items
InvoiceLineItem[]description
stringtotal_amount
numberitem
stringaccount
stringtracking_category
stringremote_id
stringbalance
Numbercontact
Stringcurrency
Enumdue_date
Stringissue_date
Stringmemo
Stringnumber
Stringpaid_on_date
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringtotal_amount
Numbertype
Enum
Wave Financial
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_items
InvoiceLineItem[]description
stringunit_price
numberquantity
numbertotal_amount
numberitem
stringaccount
stringbalance
Numbercontact
Stringcurrency
Enumdue_date
Stringissue_date
Stringmemo
Stringnumber
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringsub_total
Numbertotal_amount
Numbertotal_discount
Numbertotal_tax_amount
Numbertype
Enum
Xero
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_items
InvoiceLineItem[]description
stringunit_price
numberquantity
numbertotal_amount
numberitem
stringaccount
stringtracking_category
stringremote_id
stringbalance
Numbercontact
Stringcurrency
Enumdue_date
Stringissue_date
Stringnumber
Stringpaid_on_date
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringsub_total
Numbertotal_amount
Numbertotal_discount
Numbertotal_tax_amount
Numbertype
Enum
Zoho Books
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_items
InvoiceLineItem[]description
stringunit_price
numberquantity
numbertotal_amount
numberitem
stringaccount
stringremote_id
stringbalance
Numbercontact
Stringcurrency
Enumdue_date
Stringissue_date
Stringmemo
Stringnumber
Stringpaid_on_date
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringsub_total
Numbertotal_amount
Numbertotal_discount
Numbertotal_tax_amount
Numbertype
Enum/invoices
Creates an Invoice
object with the given values.
Header Parameters
Authorization
StringX-Account-Token
StringQuery & Path Parameters
is_debug_mode
Booleanrun_async
BooleanBody Parameters
model
ObjectModel Parameters
type
EnumACCOUNTS_RECEIVABLE
, ACCOUNTS_PAYABLE
.contact
Stringid
field in the Contact table.number
Stringissue_date
Stringdue_date
Stringpaid_on_date
Stringmemo
Stringcompany
Stringid
field in the CompanyInfo table.currency
EnumXUA
, AFN
, AFA
, ALL
, ALK
, DZD
, ADP
, AOA
, AOK
, AON
, AOR
, ARA
, ARS
, ARM
, ARP
, ARL
, AMD
, AWG
, AUD
, ATS
, AZN
, AZM
, BSD
, BHD
, BDT
, BBD
, BYN
, BYB
, BYR
, BEF
, BEC
, BEL
, BZD
, BMD
, BTN
, BOB
, BOL
, BOV
, BOP
, BAM
, BAD
, BAN
, BWP
, BRC
, BRZ
, BRE
, BRR
, BRN
, BRB
, BRL
, GBP
, BND
, BGL
, BGN
, BGO
, BGM
, BUK
, BIF
, XPF
, KHR
, CAD
, CVE
, KYD
, XAF
, CLE
, CLP
, CLF
, CNX
, CNY
, CNH
, COP
, COU
, KMF
, CDF
, CRC
, HRD
, HRK
, CUC
, CUP
, CYP
, CZK
, CSK
, DKK
, DJF
, DOP
, NLG
, XCD
, DDM
, ECS
, ECV
, EGP
, GQE
, ERN
, EEK
, ETB
, EUR
, XBA
, XEU
, XBB
, XBC
, XBD
, FKP
, FJD
, FIM
, FRF
, XFO
, XFU
, GMD
, GEK
, GEL
, DEM
, GHS
, GHC
, GIP
, XAU
, GRD
, GTQ
, GWP
, GNF
, GNS
, GYD
, HTG
, HNL
, HKD
, HUF
, IMP
, ISK
, ISJ
, INR
, IDR
, IRR
, IQD
, IEP
, ILS
, ILP
, ILR
, ITL
, JMD
, JPY
, JOD
, KZT
, KES
, KWD
, KGS
, LAK
, LVL
, LVR
, LBP
, LSL
, LRD
, LYD
, LTL
, LTT
, LUL
, LUC
, LUF
, MOP
, MKD
, MKN
, MGA
, MGF
, MWK
, MYR
, MVR
, MVP
, MLF
, MTL
, MTP
, MRU
, MRO
, MUR
, MXV
, MXN
, MXP
, MDC
, MDL
, MCF
, MNT
, MAD
, MAF
, MZE
, MZN
, MZM
, MMK
, NAD
, NPR
, ANG
, TWD
, NZD
, NIO
, NIC
, NGN
, KPW
, NOK
, OMR
, PKR
, XPD
, PAB
, PGK
, PYG
, PEI
, PEN
, PES
, PHP
, XPT
, PLN
, PLZ
, PTE
, GWE
, QAR
, XRE
, RHD
, RON
, ROL
, RUB
, RUR
, RWF
, SVC
, WST
, SAR
, RSD
, CSD
, SCR
, SLL
, XAG
, SGD
, SKK
, SIT
, SBD
, SOS
, ZAR
, ZAL
, KRH
, KRW
, KRO
, SSP
, SUR
, ESP
, ESA
, ESB
, XDR
, LKR
, SHP
, XSU
, SDD
, SDG
, SDP
, SRD
, SRG
, SZL
, SEK
, CHF
, SYP
, STN
, STD
, TVD
, TJR
, TJS
, TZS
, XTS
, THB
, XXX
, TPE
, TOP
, TTD
, TND
, TRY
, TRL
, TMT
, TMM
, USD
, USN
, USS
, UGX
, UGS
, UAH
, UAK
, AED
, UYW
, UYU
, UYP
, UYI
, UZS
, VUV
, VES
, VEB
, VEF
, VND
, VNN
, CHE
, CHW
, XOF
, YDD
, YER
, YUN
, YUD
, YUM
, YUR
, ZWN
, ZRN
, ZRZ
, ZMW
, ZMK
, ZWD
, ZWR
, ZWL
.exchange_rate
Stringtotal_discount
Numbersub_total
Numbertotal_tax_amount
Numbertotal_amount
Numberbalance
Numberpayments
ArrayPayment
object IDs.line_items
Arrayintegration_params
Objectlinked_account_params
Object{"model": {"type": "ACCOUNTS_RECEIVABLE","contact": "022a2bef-57e5-4def-8ed2-7c41bd9a5ed8","number": "AIQ12546","issue_date": "2020-03-31T00:00:00Z","due_date": "2020-04-15T00:00:00Z","paid_on_date": "2020-04-01T00:00:00Z","memo": "Weekly Payment","company": "595c8f97-2ac4-45b7-b000-41bdf43240b5","currency": "USD","exchange_rate": "2.9","total_discount": 0,"sub_total": 100,"total_tax_amount": 5,"total_amount": 105,"balance": 105,"payments": ["b26fd49a-cbae-470a-a8f8-bcbc119e0390"],"line_items": [{"id": "022a2bef-57e5-4def-8ed2-7c41bd9a5ed8","remote_id": "8765432","description": "Pickleball lessons","unit_price": 50,"quantity": 2,"total_amount": 100,"item": "5b3c1341-a20f-4e51-b72c-f3830a16c97b","account": "cd0f32d4-a493-11ec-b909-0242ac120002","remote_data": [{"path": "/actions","data": ["Varies by platform"]}]}]}}
{"model": {"remote_data": [{"path": "/actions","data": ["Varies by platform"]}],"type": "ACCOUNTS_RECEIVABLE","contact": "022a2bef-57e5-4def-8ed2-7c41bd9a5ed8","number": "AIQ12546","issue_date": "2020-03-31T00:00:00Z","due_date": "2020-04-15T00:00:00Z","paid_on_date": "2020-04-01T00:00:00Z","memo": "Weekly Payment","company": "595c8f97-2ac4-45b7-b000-41bdf43240b5","currency": "USD","exchange_rate": "2.9","total_discount": 0,"sub_total": 100,"total_tax_amount": 5,"total_amount": 105,"balance": 105,"remote_updated_at": "2020-04-01T00:00:00Z","payments": ["b26fd49a-cbae-470a-a8f8-bcbc119e0390"],"line_items": [{"id": "022a2bef-57e5-4def-8ed2-7c41bd9a5ed8","remote_id": "8765432","description": "Pickleball lessons","unit_price": 50,"quantity": 2,"total_amount": 100,"item": "5b3c1341-a20f-4e51-b72c-f3830a16c97b","account": "cd0f32d4-a493-11ec-b909-0242ac120002","remote_data": [{"path": "/actions","data": ["Varies by platform"]}]}],"remote_was_deleted": true,"id": "9871b4a9-f5d2-4f3b-a66b-dfedbed42c46","remote_id": "990110","field_mappings": {"organization_defined_targets": {"custom_key": "custom_value"},"linked_account_defined_targets": {"custom_key": "custom_value"}}},"warnings": [{"source": {"pointer": "/age"},"title": "Unrecognized Field","detail": "An unrecognized field, age, was passed in with request data.","problem_type": "UNRECOGNIZED_FIELD"}],"errors": [{"source": {"pointer": "/model/custom_fields"},"title": "Missing Required Field","detail": "custom_fields is a required field on model.","problem_type": "MISSING_REQUIRED_FIELD"}],"logs": [{"log_id": "99433219-8017-4acd-bb3c-ceb23d663832","dashboard_view": "https://app.merge.dev/logs/99433219-8017-4acd-bb3c-ceb23d663832","log_summary": {"url": "https://harvest.greenhouse.io/v1/candidates/","method": "POST","status_code": 200}}]}

Microsoft Dynamics 365 Business Central
Merge supports Passthrough Requests to this platform's API
Supported POST Body Parameters
contact
Stringcurrency
Enumdue_date
Stringissue_date
Stringnumber
Stringremote_id
Stringremote_updated_at
Stringtotal_amount
Numbertotal_discount
Numbertotal_tax_amount
Numbertype
EnumAdditional POST Parameters
integration_params
Objectcompany_id
String
NetSuite
Merge supports Passthrough Requests to this platform's API
Supported POST Body Parameters
balance
Numbercontact
Stringcurrency
Enumdue_date
Stringissue_date
Stringmemo
Stringnumber
Stringpaid_on_date
Stringremote_id
Stringremote_updated_at
Stringsub_total
Numbertotal_amount
Numbertotal_discount
Numbertotal_tax_amount
Numbertype
EnumAdditional POST Parameters
company
String
QuickBooks Online
Merge supports Passthrough Requests to this platform's API
Supported POST Body Parameters
balance
Numbercontact
Stringcurrency
Enumdue_date
Stringissue_date
Stringnumber
Stringpaid_on_date
Stringremote_id
Stringremote_updated_at
Stringtotal_amount
Numbertype
EnumAdditional POST Parameters
line_items
String
Xero
Merge supports Passthrough Requests to this platform's API
Supported POST Body Parameters
balance
Numbercontact
Stringcurrency
Enumdue_date
Stringexchange_rate
Stringissue_date
Stringnumber
Stringremote_id
Stringremote_updated_at
Stringsub_total
Numbertotal_amount
Numbertotal_tax_amount
Numbertype
EnumAdditional POST Parameters
line_items
Objectaccount
String
FreeAgent

FreshBooks

Sage Intacct
/invoices/{id}
Returns an Invoice
object with the given id
.
Header Parameters
Authorization
StringX-Account-Token
StringQuery & Path Parameters
expand
Stringid
Stringinclude_remote_data
Booleanremote_fields
Stringshow_enum_origins
String{"remote_data": [{"path": "/actions","data": ["Varies by platform"]}],"type": "ACCOUNTS_RECEIVABLE","contact": "022a2bef-57e5-4def-8ed2-7c41bd9a5ed8","number": "AIQ12546","issue_date": "2020-03-31T00:00:00Z","due_date": "2020-04-15T00:00:00Z","paid_on_date": "2020-04-01T00:00:00Z","memo": "Weekly Payment","company": "595c8f97-2ac4-45b7-b000-41bdf43240b5","currency": "USD","exchange_rate": "2.9","total_discount": 0,"sub_total": 100,"total_tax_amount": 5,"total_amount": 105,"balance": 105,"remote_updated_at": "2020-04-01T00:00:00Z","payments": ["b26fd49a-cbae-470a-a8f8-bcbc119e0390"],"line_items": [{"id": "022a2bef-57e5-4def-8ed2-7c41bd9a5ed8","remote_id": "8765432","description": "Pickleball lessons","unit_price": 50,"quantity": 2,"total_amount": 100,"item": "5b3c1341-a20f-4e51-b72c-f3830a16c97b","account": "cd0f32d4-a493-11ec-b909-0242ac120002","remote_data": [{"path": "/actions","data": ["Varies by platform"]}]}],"remote_was_deleted": true,"id": "9871b4a9-f5d2-4f3b-a66b-dfedbed42c46","remote_id": "990110","field_mappings": {"organization_defined_targets": {"custom_key": "custom_value"},"linked_account_defined_targets": {"custom_key": "custom_value"}}}

Clear Books
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_items
InvoiceLineItem[]description
stringunit_price
numberquantity
numberbalance
Numbercurrency
Enumdue_date
Stringissue_date
Stringnumber
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringtotal_amount
Numbertotal_tax_amount
Numbertype
Enum
FreeAgent
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_items
InvoiceLineItem[]description
stringunit_price
numberquantity
numbertotal_amount
numberaccount
stringremote_id
stringbalance
Numbercontact
Stringcurrency
Enumdue_date
Stringissue_date
Stringmemo
Stringnumber
Stringpaid_on_date
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringtotal_amount
Numbertype
Enum
FreshBooks
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_items
InvoiceLineItem[]description
stringunit_price
numberquantity
numbertotal_amount
numberremote_id
stringbalance
Numbercontact
Stringcurrency
Enumdue_date
Stringissue_date
Stringnumber
Stringpaid_on_date
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtotal_amount
Numbertotal_discount
Number
Microsoft Dynamics 365 Business Central
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
line_items
InvoiceLineItem[]description
stringunit_price
numberquantity
numbertotal_amount
numberitem
string