The Invoice object

The Invoice object represents an itemized record of goods and/or services sold to a customer or bought from a vendor.

Represents a Bill when the Invoice type is ACCOUNTS_PAYABLE. References an Invoice when the Invoice type is ACCOUNTS_RECEIVABLE.

idstringOptionalformat: "uuid"

remote_idstring or nullOptional

The third-party API ID of the matching object.

created_atdatetimeOptional

The datetime that this object was created by Merge.

modified_atdatetimeOptional

The datetime that this object was modified by Merge.

typeenum or nullOptional

Whether the invoice is an accounts receivable or accounts payable. If type is ACCOUNTS_PAYABLE, the invoice is a bill. If type is ACCOUNTS_RECEIVABLE, it is an invoice.

ACCOUNTS_RECEIVABLE - ACCOUNTS_RECEIVABLE
ACCOUNTS_PAYABLE - ACCOUNTS_PAYABLE

Allowed values:

contactstring or nullOptionalformat: "uuid"

The invoice's contact.

numberstring or nullOptional

The invoice's number.

issue_datedatetime or nullOptional

The invoice's issue date.

due_datedatetime or nullOptional

The invoice's due date.

paid_on_datedatetime or nullOptional

The invoice's paid date.

memostring or nullOptional

The invoice's private note.

companystring or nullOptionalformat: "uuid"

The company the invoice belongs to.

employeestring or nullOptionalformat: "uuid"

The employee this overall transaction relates to.

currencyenum or nullOptional

The invoice’s currency.

XUA - ADB Unit of Account
AFN - Afghan Afghani
AFA - Afghan Afghani (1927–2002)
ALL - Albanian Lek
ALK - Albanian Lek (1946–1965)
DZD - Algerian Dinar
ADP - Andorran Peseta
AOA - Angolan Kwanza
AOK - Angolan Kwanza (1977–1991)
AON - Angolan New Kwanza (1990–2000)
AOR - Angolan Readjusted Kwanza (1995–1999)
ARA - Argentine Austral
ARS - Argentine Peso
ARM - Argentine Peso (1881–1970)
ARP - Argentine Peso (1983–1985)
ARL - Argentine Peso Ley (1970–1983)
AMD - Armenian Dram
AWG - Aruban Florin
AUD - Australian Dollar
ATS - Austrian Schilling
AZN - Azerbaijani Manat
AZM - Azerbaijani Manat (1993–2006)
BSD - Bahamian Dollar
BHD - Bahraini Dinar
BDT - Bangladeshi Taka
BBD - Barbadian Dollar
BYN - Belarusian Ruble
BYB - Belarusian Ruble (1994–1999)
BYR - Belarusian Ruble (2000–2016)
BEF - Belgian Franc
BEC - Belgian Franc (convertible)
BEL - Belgian Franc (financial)
BZD - Belize Dollar
BMD - Bermudan Dollar
BTN - Bhutanese Ngultrum
BOB - Bolivian Boliviano
BOL - Bolivian Boliviano (1863–1963)
BOV - Bolivian Mvdol
BOP - Bolivian Peso
BAM - Bosnia-Herzegovina Convertible Mark
BAD - Bosnia-Herzegovina Dinar (1992–1994)
BAN - Bosnia-Herzegovina New Dinar (1994–1997)
BWP - Botswanan Pula
BRC - Brazilian Cruzado (1986–1989)
BRZ - Brazilian Cruzeiro (1942–1967)
BRE - Brazilian Cruzeiro (1990–1993)
BRR - Brazilian Cruzeiro (1993–1994)
BRN - Brazilian New Cruzado (1989–1990)
BRB - Brazilian New Cruzeiro (1967–1986)
BRL - Brazilian Real
GBP - British Pound
BND - Brunei Dollar
BGL - Bulgarian Hard Lev
BGN - Bulgarian Lev
BGO - Bulgarian Lev (1879–1952)
BGM - Bulgarian Socialist Lev
BUK - Burmese Kyat
BIF - Burundian Franc
XPF - CFP Franc
KHR - Cambodian Riel
CAD - Canadian Dollar
CVE - Cape Verdean Escudo
KYD - Cayman Islands Dollar
XAF - Central African CFA Franc
CLE - Chilean Escudo
CLP - Chilean Peso
CLF - Chilean Unit of Account (UF)
CNX - Chinese People’s Bank Dollar
CNY - Chinese Yuan
CNH - Chinese Yuan (offshore)
COP - Colombian Peso
COU - Colombian Real Value Unit
KMF - Comorian Franc
CDF - Congolese Franc
CRC - Costa Rican Colón
HRD - Croatian Dinar
HRK - Croatian Kuna
CUC - Cuban Convertible Peso
CUP - Cuban Peso
CYP - Cypriot Pound
CZK - Czech Koruna
CSK - Czechoslovak Hard Koruna
DKK - Danish Krone
DJF - Djiboutian Franc
DOP - Dominican Peso
NLG - Dutch Guilder
XCD - East Caribbean Dollar
DDM - East German Mark
ECS - Ecuadorian Sucre
ECV - Ecuadorian Unit of Constant Value
EGP - Egyptian Pound
GQE - Equatorial Guinean Ekwele
ERN - Eritrean Nakfa
EEK - Estonian Kroon
ETB - Ethiopian Birr
EUR - Euro
XBA - European Composite Unit
XEU - European Currency Unit
XBB - European Monetary Unit
XBC - European Unit of Account (XBC)
XBD - European Unit of Account (XBD)
FKP - Falkland Islands Pound
FJD - Fijian Dollar
FIM - Finnish Markka
FRF - French Franc
XFO - French Gold Franc
XFU - French UIC-Franc
GMD - Gambian Dalasi
GEK - Georgian Kupon Larit
GEL - Georgian Lari
DEM - German Mark
GHS - Ghanaian Cedi
GHC - Ghanaian Cedi (1979–2007)
GIP - Gibraltar Pound
XAU - Gold
GRD - Greek Drachma
GTQ - Guatemalan Quetzal
GWP - Guinea-Bissau Peso
GNF - Guinean Franc
GNS - Guinean Syli
GYD - Guyanaese Dollar
HTG - Haitian Gourde
HNL - Honduran Lempira
HKD - Hong Kong Dollar
HUF - Hungarian Forint
IMP - IMP
ISK - Icelandic Króna
ISJ - Icelandic Króna (1918–1981)
INR - Indian Rupee
IDR - Indonesian Rupiah
IRR - Iranian Rial
IQD - Iraqi Dinar
IEP - Irish Pound
ILS - Israeli New Shekel
ILP - Israeli Pound
ILR - Israeli Shekel (1980–1985)
ITL - Italian Lira
JMD - Jamaican Dollar
JPY - Japanese Yen
JOD - Jordanian Dinar
KZT - Kazakhstani Tenge
KES - Kenyan Shilling
KWD - Kuwaiti Dinar
KGS - Kyrgystani Som
LAK - Laotian Kip
LVL - Latvian Lats
LVR - Latvian Ruble
LBP - Lebanese Pound
LSL - Lesotho Loti
LRD - Liberian Dollar
LYD - Libyan Dinar
LTL - Lithuanian Litas
LTT - Lithuanian Talonas
LUL - Luxembourg Financial Franc
LUC - Luxembourgian Convertible Franc
LUF - Luxembourgian Franc
MOP - Macanese Pataca
MKD - Macedonian Denar
MKN - Macedonian Denar (1992–1993)
MGA - Malagasy Ariary
MGF - Malagasy Franc
MWK - Malawian Kwacha
MYR - Malaysian Ringgit
MVR - Maldivian Rufiyaa
MVP - Maldivian Rupee (1947–1981)
MLF - Malian Franc
MTL - Maltese Lira
MTP - Maltese Pound
MRU - Mauritanian Ouguiya
MRO - Mauritanian Ouguiya (1973–2017)
MUR - Mauritian Rupee
MXV - Mexican Investment Unit
MXN - Mexican Peso
MXP - Mexican Silver Peso (1861–1992)
MDC - Moldovan Cupon
MDL - Moldovan Leu
MCF - Monegasque Franc
MNT - Mongolian Tugrik
MAD - Moroccan Dirham
MAF - Moroccan Franc
MZE - Mozambican Escudo
MZN - Mozambican Metical
MZM - Mozambican Metical (1980–2006)
MMK - Myanmar Kyat
NAD - Namibian Dollar
NPR - Nepalese Rupee
ANG - Netherlands Antillean Guilder
TWD - New Taiwan Dollar
NZD - New Zealand Dollar
NIO - Nicaraguan Córdoba
NIC - Nicaraguan Córdoba (1988–1991)
NGN - Nigerian Naira
KPW - North Korean Won
NOK - Norwegian Krone
OMR - Omani Rial
PKR - Pakistani Rupee
XPD - Palladium
PAB - Panamanian Balboa
PGK - Papua New Guinean Kina
PYG - Paraguayan Guarani
PEI - Peruvian Inti
PEN - Peruvian Sol
PES - Peruvian Sol (1863–1965)
PHP - Philippine Peso
XPT - Platinum
PLN - Polish Zloty
PLZ - Polish Zloty (1950–1995)
PTE - Portuguese Escudo
GWE - Portuguese Guinea Escudo
QAR - Qatari Rial
XRE - RINET Funds
RHD - Rhodesian Dollar
RON - Romanian Leu
ROL - Romanian Leu (1952–2006)
RUB - Russian Ruble
RUR - Russian Ruble (1991–1998)
RWF - Rwandan Franc
SVC - Salvadoran Colón
WST - Samoan Tala
SAR - Saudi Riyal
RSD - Serbian Dinar
CSD - Serbian Dinar (2002–2006)
SCR - Seychellois Rupee
SLL - Sierra Leonean Leone
XAG - Silver
SGD - Singapore Dollar
SKK - Slovak Koruna
SIT - Slovenian Tolar
SBD - Solomon Islands Dollar
SOS - Somali Shilling
ZAR - South African Rand
ZAL - South African Rand (financial)
KRH - South Korean Hwan (1953–1962)
KRW - South Korean Won
KRO - South Korean Won (1945–1953)
SSP - South Sudanese Pound
SUR - Soviet Rouble
ESP - Spanish Peseta
ESA - Spanish Peseta (A account)
ESB - Spanish Peseta (convertible account)
XDR - Special Drawing Rights
LKR - Sri Lankan Rupee
SHP - St. Helena Pound
XSU - Sucre
SDD - Sudanese Dinar (1992–2007)
SDG - Sudanese Pound
SDP - Sudanese Pound (1957–1998)
SRD - Surinamese Dollar
SRG - Surinamese Guilder
SZL - Swazi Lilangeni
SEK - Swedish Krona
CHF - Swiss Franc
SYP - Syrian Pound
STN - São Tomé & Príncipe Dobra
STD - São Tomé & Príncipe Dobra (1977–2017)
TVD - TVD
TJR - Tajikistani Ruble
TJS - Tajikistani Somoni
TZS - Tanzanian Shilling
XTS - Testing Currency Code
THB - Thai Baht
XXX - The codes assigned for transactions where no currency is involved
TPE - Timorese Escudo
TOP - Tongan Paʻanga
TTD - Trinidad & Tobago Dollar
TND - Tunisian Dinar
TRY - Turkish Lira
TRL - Turkish Lira (1922–2005)
TMT - Turkmenistani Manat
TMM - Turkmenistani Manat (1993–2009)
USD - US Dollar
USN - US Dollar (Next day)
USS - US Dollar (Same day)
UGX - Ugandan Shilling
UGS - Ugandan Shilling (1966–1987)
UAH - Ukrainian Hryvnia
UAK - Ukrainian Karbovanets
AED - United Arab Emirates Dirham
UYW - Uruguayan Nominal Wage Index Unit
UYU - Uruguayan Peso
UYP - Uruguayan Peso (1975–1993)
UYI - Uruguayan Peso (Indexed Units)
UZS - Uzbekistani Som
VUV - Vanuatu Vatu
VES - Venezuelan Bolívar
VEB - Venezuelan Bolívar (1871–2008)
VEF - Venezuelan Bolívar (2008–2018)
VND - Vietnamese Dong
VNN - Vietnamese Dong (1978–1985)
CHE - WIR Euro
CHW - WIR Franc
XOF - West African CFA Franc
YDD - Yemeni Dinar
YER - Yemeni Rial
YUN - Yugoslavian Convertible Dinar (1990–1992)
YUD - Yugoslavian Hard Dinar (1966–1990)
YUM - Yugoslavian New Dinar (1994–2002)
YUR - Yugoslavian Reformed Dinar (1992–1993)
ZWN - ZWN
ZRN - Zairean New Zaire (1993–1998)
ZRZ - Zairean Zaire (1971–1993)
ZMW - Zambian Kwacha
ZMK - Zambian Kwacha (1968–2012)
ZWD - Zimbabwean Dollar (1980–2008)
ZWR - Zimbabwean Dollar (2008)
ZWL - Zimbabwean Dollar (2009)

exchange_ratestring or nullOptionalformat: "decimal"

The invoice's exchange rate.

payment_termstring or nullOptionalformat: "uuid"

The payment term that applies to this transaction.

total_discountdouble or nullOptional

The total discounts applied to the total cost.

sub_totaldouble or nullOptional

The total amount being paid before taxes.

statusenum or nullOptional

The status of the invoice.

PAID - PAID
DRAFT - DRAFT
SUBMITTED - SUBMITTED
PARTIALLY_PAID - PARTIALLY_PAID
OPEN - OPEN
VOID - VOID

total_tax_amountdouble or nullOptional

The total amount being paid in taxes.

total_amountdouble or nullOptional

The invoice's total amount.

balancedouble or nullOptional

The invoice's remaining balance.

remote_updated_atdatetime or nullOptional

When the third party's invoice entry was updated.

tracking_categorieslist of stringsOptional

accounting_periodstring or nullOptionalformat: "uuid"

The accounting period that the Invoice was generated in.

purchase_orderslist of stringsOptional

sales_orderslist of stringsOptional

paymentslist of stringsOptional

Array of Payment object IDs.

applied_paymentslist of stringsOptional

A list of the Payment Applied to Lines common models related to a given Invoice, Credit Note, or Journal Entry.

line_itemslist of objectsOptional

applied_credit_noteslist of objectsOptional

CreditNoteApplyLines applied to the Invoice.

applied_vendor_creditslist of objectsOptional

VendorCreditApplyLines applied to the Invoice.

inclusive_of_taxboolean or nullOptional

If the transaction is inclusive or exclusive of tax. True if inclusive, False if exclusive.

remote_was_deletedbooleanOptional

Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.

field_mappingsobject or nullOptional

remote_datalist of objects or nullOptional

remote_fieldslist of objectsOptional

1	{
2	"id": "string",
3	"remote_id": "string",
4	"created_at": "2023-01-01T00:00:00Z",
5	"modified_at": "2023-01-01T00:00:00Z",
6	"type": "ACCOUNTS_RECEIVABLE",
7	"contact": "string",
8	"number": "string",
9	"issue_date": "2023-01-01T00:00:00Z",
10	"due_date": "2023-01-01T00:00:00Z",
11	"paid_on_date": "2023-01-01T00:00:00Z",
12	"memo": "string",
13	"company": "string",
14	"employee": "string",
15	"currency": "XUA",
16	"exchange_rate": "string",
17	"payment_term": "string",
18	"total_discount": 1,
19	"sub_total": 1,
20	"status": "PAID",
21	"total_tax_amount": 1,
22	"total_amount": 1,
23	"balance": 1,
24	"remote_updated_at": "2023-01-01T00:00:00Z",
25	"tracking_categories": [
26	"string"
27	],
28	"accounting_period": "string",
29	"purchase_orders": [
30	"string"
31	],
32	"sales_orders": [
33	"string"
34	],
35	"payments": [
36	"string"
37	],
38	"applied_payments": [
39	"string"
40	],
41	"line_items": [
42	{
43	"id": "string",
44	"remote_id": "string",
45	"created_at": "2023-01-01T00:00:00Z",
46	"modified_at": "2023-01-01T00:00:00Z",
47	"description": "string",
48	"unit_price": 1,
49	"quantity": 1,
50	"total_amount": 1,
51	"employee": "string",
52	"project": "string",
53	"contact": "string",
54	"currency": "XUA",
55	"exchange_rate": "string",
56	"item": "string",
57	"account": "string",
58	"tax_rate": "string",
59	"tracking_category": "string",
60	"tracking_categories": [
61	"string"
62	],
63	"company": "string",
64	"remote_was_deleted": true,
65	"field_mappings": {},
66	"remote_fields": [
67	{
68	"remote_field_class": {
69	"id": "string",
70	"display_name": "string",
71	"remote_key_name": "string",
72	"description": "string",
73	"is_custom": true,
74	"is_common_model_field": true,
75	"is_required": true,
76	"field_type": "string",
77	"field_format": "string",
78	"field_choices": [
79	"string"
80	],
81	"item_schema": {
82	"item_type": "string",
83	"item_format": "string",
84	"item_choices": [
85	"string"
86	]
87	}
88	},
89	"value": {
90	"string": {}
91	}
92	}
93	]
94	}
95	],
96	"applied_credit_notes": [
97	{
98	"remote_id": "string",
99	"created_at": "2023-01-01T00:00:00Z",
100	"modified_at": "2023-01-01T00:00:00Z",
101	"credit_note": "string",
102	"applied_date": "2023-01-01T00:00:00Z",
103	"applied_amount": "string",
104	"remote_was_deleted": true
105	}
106	],
107	"applied_vendor_credits": [
108	{
109	"remote_id": "string",
110	"created_at": "2023-01-01T00:00:00Z",
111	"modified_at": "2023-01-01T00:00:00Z",
112	"vendor_credit": "string",
113	"applied_date": "2023-01-01T00:00:00Z",
114	"applied_amount": "string",
115	"remote_was_deleted": true
116	}
117	],
118	"inclusive_of_tax": true,
119	"remote_was_deleted": true,
120	"field_mappings": {},
121	"remote_data": [
122	{
123	"path": "string",
124	"data": {}
125	}
126	],
127	"remote_fields": [
128	{
129	"remote_field_class": {
130	"id": "string",
131	"display_name": "string",
132	"remote_key_name": "string",
133	"description": "string",
134	"is_custom": true,
135	"is_common_model_field": true,
136	"is_required": true,
137	"field_type": "string",
138	"field_format": "string",
139	"field_choices": [
140	"string"
141	],
142	"item_schema": {
143	"item_type": "string",
144	"item_format": "string",
145	"item_choices": [
146	"string"
147	]
148	}
149	},
150	"value": {
151	"string": {}
152	}
153	}
154	]
155	}