Create, update and get info about your account.
InvoiceXpress API (2.0.0)
Endpoints for managing Accounts, Invoices, Estimates, and organization data in InvoiceXpress.
Welcome to our API v2 in JSON
If you're reading this, let me guess, you need to issue invoices but don't want to lose focus from building a great solution and writing amazing code. Did we cover your scenario? Ok, great. Let's do this.
Quick Start
Reference tables for Portuguese VAT (IVA) exemptions, payment mechanism codes used for partial payments, and accepted countries when creating a client or an account.
Authentication
In order to authenticate a user through our API, an API key must be used. All API endpoints are available via HTTPS. HTTP access is denied. Each API key authenticates a user inside an account, and it's composed by arbitrary characters.
This key must be passed on the query string in each HTTPS request to authenticate the user. Although all endpoints are accessed through HTTPS, please keep this token as secure as possible in order to avoid third party's to access your InvoiceXpress data.
We strongly recommend you re-generate your API Key from time to time.
Example:
https://ACCOUNT_NAME.app.invoicexpress.com/invoices.json?api_key=API_KEY
You can find your ACCOUNT_NAME and API_KEY here: https://www.app.invoicexpress.com/users/api
On POST and PUT requests do not forget to specify on the Header:
Content-Type: application/json
IVA exemption codes
| Code | Description on the Invoice | Where does it apply? |
|---|---|---|
| M01 | Artigo 16.°, n.° 6 do CIVA | Artigo 16.°, n.° 6, alíneas a) a d) do CIVA |
| M02 | Artigo 6.° do Decreto-Lei n.° 198/90, de 19 de junho | Artigo 6.° do Decreto-Lei n.° 198/90, de 19 de junho |
| M04 | Isento artigo 13.° do CIVA | Artigo 13.° do CIVA |
| M05 | Isento artigo 14.° do CIVA | Artigo 14.° do CIVA |
| M06 | Isento artigo 15.° do CIVA | Artigo 15.° do CIVA |
| M07 | Isento artigo 9.° do CIVA | Artigo 9.° do CIVA |
| M09 | IVA – não confere direito a dedução | Artigo 62.° alínea b) do CIVA |
| M10 | IVA – regime de isenção | Artigo 57.° do CIVA |
| M11 | Regime particular do tabaco | Decreto-Lei n.° 346/85, de 23 de agosto |
| M12 | Regime da margem de lucro – Agências de viagens | Decreto-Lei n.° 221/85, de 3 de julho |
| M13 | Regime da margem de lucro – Bens em segunda mão | Decreto-Lei n.° 199/96, de 18 de outubro |
| M14 | Regime da margem de lucro – Objetos de arte | Decreto-Lei n.° 199/96, de 18 de outubro |
| M15 | Regime da margem de lucro – Objetos de coleção e antiguidades | Decreto-Lei n.° 199/96, de 18 de outubro |
| M16 | Isento artigo 14.° do RITI | Artigo 14.° do RITI |
| M19 | Outras isenções | Isenções temporárias determinadas em diploma próprio |
| M20 | IVA – regime forfetário | Artigo 59.°-D n.°2 do CIVA |
| M21 | IVA – não confere direito à dedução (ou expressão similar) | Artigo 72.° n.° 4 do CIVA |
| M25 | Mercadorias à consignação | Artigo 38.° n.° 1 alínea a) |
| M30 | IVA – autoliquidação | Artigo 2.° n.° 1 alínea i) do CIVA |
| M31 | IVA – autoliquidação | Artigo 2.° n.° 1 alínea j) do CIVA |
| M32 | IVA – autoliquidação | Artigo 2.° n.° 1 alínea I) do CIVA |
| M33 | IVA – autoliquidação | Artigo 2.° n.° 1 alínea m) do CIVA |
| M40 | IVA – autoliquidação | Artigo 6.° n.° 6 alínea a) do CIVA, a contrário |
| M41 | IVA – autoliquidação | Artigo 8.° n.° 3 do RITI |
| M42 | IVA – autoliquidação | Decreto-Lei n.° 21/2007, de 29 de janeiro |
| M43 | IVA – autoliquidação | Decreto-Lei n.° 362/99, de 16 de setembro |
| M99 | Não sujeito ou não tributado | Outras situações de não liquidação do imposto (Exemplos: artigo 2.°, n.° 2 ; artigo 3.°, n.°s 4, 6 e 7; artigo 4.°, n.° 5, todos do CIVA) |
Payment mechanisms
This list shows the possible values for the payment mechanism when doing a partial payment:
- CC: Credit card
- CD: Debit card
- CH: Bank check
- CO: Check or voucher
- CS: Current account balance compensation
- DE: e-Cash
- LC: Commercial paper
- MB: Multibanco payment references
- NU: Cash
- OU: Other methods not mentioned here
- PR: Exchange of properties
- TB: Bank transfer or authorized direct debit
- TR: Restaurant ticket
Country list
This list shows the countries accepted when creating a client or an account:
- Portugal
- Ireland
- UK
- Canada
- United States
- Afghanistan
- Albania
- Algeria
- American Samoa
- Andorra
- Angola
- Anguilla
- Antigua and Barbuda
- Argentina
- Armenia
- Aruba
- Australia
- Austria
- Azerbaijan
- Bahamas
- Bahrain
- Bangladesh
- Barbados
- Belarus
- Belgium
- Belize
- Benin
- Bermuda
- Bhutan
- Bolivia
- Bosnia-Herzegovina
- Botswana
- Brazil
- British Indian Ocean Territory
- Brunei
- Bulgaria
- Burkina Faso
- Burma
- Burundi
- Cambodia
- Cameroon
- Canton and Enderbury Islands
- Cape Verde
- Cayman Islands
- Central African Republic
- Chad
- Chile
- China
- Christmas Island
- Cocos (Keeling) Islands
- Colombia
- Comoros
- Congo
- Congo, Democratic Republic
- Cook Islands
- Costa Rica
- Côte d’Ivoire
- Croatia
- Cuba
- Curaçao
- Cyprus
- Czech Republic
- Denmark
- Djibouti
- Dominica
- Dominican Republic
- Dronning Maud Land
- East Timor
- Ecuador
- Egypt
- El Salvador
- Equatorial Guinea
- Eritrea
- Estonia
- Ethiopia
- Faeroe Islands (Føroyar)
- Falkland Islands
- Fiji
- Finland
- France
- French Guiana
- French Polynesia
- Gabon
- Gambia
- Georgia
- Germany
- Ghana
- Gibraltar
- Great Britain
- Greece
- Greenland
- Grenada
- Guadeloupe
- Guam
- Guatemala
- Guernsey
- Guinea-Bissau
- Guinea
- Guyana
- Haiti
- Heard and McDonald Islands
- Honduras
- Hong Kong
- Hungary
- Iceland
- India
- Indonesia
- International Monetary Fund
- Iran
- Iraq
- Isle of Man
- Israel
- Italy
- Ivory Coast
- Jamaica
- Japan
- Jersey
- Johnston Island
- Jordan
- Kampuchea
- Kazakhstan
- Kenya
- Kiribati
- Korea, North
- Korea, South
- Kuwait
- Kyrgyzstan
- Laos
- Latvia
- Lebanon
- Lesotho
- Liberia
- Libya
- Liechtenstein
- Lithuania
- Luxembourg
- Macau
- Macedonia (Former Yug. Rep.)
- Madagascar
- Malawi
- Malaysia
- Maldives
- Mali
- Malta
- Marshall Islands
- Martinique
- Mauritania
- Mauritius
- Mayotte
- Micronesia
- Midway Islands
- Mexico
- Moldova
- Monaco
- Mongolia
- Montenegro
- Montserrat
- Morocco
- Mozambique
- Myanmar
- Nauru
- Namibia
- Nepal
- Netherlands Antilles
- Netherlands
- New Caledonia
- New Zealand
- Nicaragua
- Niger
- Nigeria
- Niue
- Norfolk Island
- Northern Mariana Islands
- Norway
- Oman
- Pakistan
- Palau
- Palestine
- Panama
- Papua New Guinea
- Paraguay
- Peru
- Philippines
- Pitcairn Island
- Poland
- Puerto Rico
- Qatar
- Reunion
- Romania
- Russia
- Rwanda
- Samoa (Western)
- Samoa (America)
- San Marino
- São Tomé and Príncipe
- Saudi Arabia
- Sénégal
- Serbia
- Seychelles
- Sierra Leone
- Singapore
- Slovakia
- Slovenia
- Solomon Islands
- Somalia
- South Africa
- Spain
- Sri Lanka
- St. Helena
- St. Kitts and Nevis
- St. Lucia
- St. Vincent and the Grenadines
- Sudan
- Suriname
- Svalbard and Jan Mayen Islands
- Swaziland
- Sweden
- Switzerland
- Syria
- Tahiti
- Taiwan
- Tajikistan
- Tanzania
- Thailand
- Timor-Leste
- Togo
- Trinidad and Tobago
- Tunisia
- Turkey
- Turkmenistan
- Turks and Caicos Islands
- Tuvalu
- Uganda
- Ukraine
- United Arab Emirates
- Upper Volta
- Uruguay
- Uzbekistan
- Vanuatu
- Vatican
- Venezuela
- Vietnam
- Virgin Islands
- Wake Island
- Wallis and Futuna Islands
- Western Sahara
- Western Samoa
- Yemen
- Zaïre
- Zambia
- Zimbabwe
Taxes country codes
| Country | Code |
|---|---|
| Portugal – Continental | PT |
| Portugal – Açores | PT-AC |
| Portugal – Madeira | PT-MA |
| Afghanistan | AF |
| Åland Islands | AX |
| Albania | AL |
| Algeria | DZ |
| American Samoa | AS |
| Andorra | AD |
| Angola | AO |
| Anguilla | AI |
| Antarctica | AQ |
| Antigua and Barbuda | AG |
| Argentina | AR |
| Armenia | AM |
| Aruba | AW |
| Australia | AU |
| Austria | AT |
| Azerbaijan | AZ |
| Bahamas | BS |
| Bahrain | BH |
| Bangladesh | BD |
| Barbados | BB |
| Belarus | BY |
| Belgium | BE |
| Belize | BZ |
| Benin | BJ |
| Bermuda | BM |
| Bhutan | BT |
| Bolivia | BO |
| Bosnia-Herzegovina | BA |
| Botswana | BW |
| Bouvet Island | BV |
| Brazil | BR |
| British Indian Ocean Territory | IO |
| Brunei | BN |
| Bulgaria | BG |
| Burkina Faso | BF |
| Burma | MM |
| Burundi | BI |
| Cambodia | KH |
| Cameroon | CM |
| Canada | CA |
| Canton and Enderbury Islands | KI |
| Cape Verde | CV |
| Cayman Islands | KY |
| Central African Republic | CF |
| Chad | TD |
| Chile | CL |
| China | CN |
| Christmas Island | CX |
| Cocos (Keeling) Islands | CC |
| Colombia | CO |
| Comoros | KM |
| Congo | CG |
| Congo, Democratic Republic | CD |
| Cook Islands | CK |
| Costa Rica | CR |
| Côte d’Ivoire | CI |
| Croatia | HR |
| Cuba | CU |
| Cyprus | CY |
| Czech Republic | CZ |
| Denmark | DK |
| Djibouti | DJ |
| Dominica | DM |
| Dominican Republic | DO |
| Dronning Maud Land | AQ |
| East Timor | TL |
| Ecuador | EC |
| Egypt | EG |
| El Salvador | SV |
| Equatorial Guinea | GQ |
| Eritrea | ER |
| Estonia | EE |
| Ethiopia | ET |
| Falkland Islands | FK |
| Faroe Islands | FO |
| Fiji | FJ |
| Finland | FI |
| France | FR |
| French Guiana | GF |
| French Polynesia | PF |
| French Southern Territories | TF |
| Gabon | GA |
| Gambia | GM |
| Georgia | GE |
| Germany | DE |
| Ghana | GH |
| Gibraltar | GI |
| Greece | GR |
| Greenland | GL |
| Grenada | GD |
| Guadeloupe | GP |
| Guam | GU |
| Guatemala | GT |
| Guernsey | GG |
| Guinea | GN |
| Guinea-Bissau | GW |
| Guyana | GY |
| Haiti | HT |
| Heard and McDonald Islands | HM |
| Holy See (Vatican City State) | VA |
| Honduras | HN |
| Hong Kong | HK |
| Hungary | HU |
| Iceland | IS |
| India | IN |
| Indonesia | ID |
| Iran | IR |
| Iraq | IQ |
| Ireland | IE |
| Isle of Man | IM |
| Israel | IL |
| Italy | IT |
| Ivory Coast | CI |
| Jamaica | JM |
| Japan | JP |
| Jersey | JE |
| Johnston Island | UM |
| Jordan | JO |
| Kampuchea | KH |
| Kazakhstan | KZ |
| Kenya | KE |
| Kiribati | KI |
| Korea, North | KP |
| Korea, South | KR |
| Kuwait | KW |
| Kyrgyzstan | KG |
| Laos | LA |
| Latvia | LV |
| Lebanon | LB |
| Lesotho | LS |
| Liberia | LR |
| Libya | LY |
| Liechtenstein | LI |
| Lithuania | LT |
| Luxembourg | LU |
| Macau | MO |
| Macedonia | MK |
| Madagascar | MG |
| Malawi | MW |
| Malaysia | MY |
| Maldives | MV |
| Mali | ML |
| Malta | MT |
| Marshall Islands | MH |
| Martinique | MQ |
| Mauritania | MR |
| Mauritius | MU |
| Mayotte | YT |
| Mexico | MX |
| Micronesia | FM |
| Midway Islands | UM |
| Moldova | MD |
| Monaco | MC |
| Mongolia | MN |
| Montenegro | ME |
| Montserrat | MS |
| Morocco | MA |
| Mozambique | MZ |
| Myanmar | MM |
| Namibia | NA |
| Nauru | NR |
| Nepal | NP |
| Netherlands | NL |
| Netherlands Antilles | AN |
| New Caledonia | NC |
| New Zealand | NZ |
| Nicaragua | NI |
| Niger | NE |
| Nigeria | NG |
| Niue | NU |
| Norfolk Island | NF |
| Northern Mariana Islands | MP |
| Norway | NO |
| Oman | OM |
| Pakistan | PK |
| Palau | PW |
| Palestine | PS |
| Panama | PA |
| Papua New Guinea | PG |
| Paraguay | PY |
| Peru | PE |
| Philippines | PH |
| Pitcairn Island | PN |
| Poland | PL |
| Puerto Rico | PR |
| Qatar | QA |
| Reunion | RE |
| Romania | RO |
| Russia | RU |
| Russian Federation | RU |
| Rwanda | RW |
| Saint Barthélemy | BL |
| St. Helena | SH |
| St. Kitts and Nevis | KN |
| St. Lucia | LC |
| Saint Martin | MF |
| Saint Pierre And Miquelon | PM |
| St. Vincent and the Grenadines | VC |
| Samoa (America) | AS |
| Samoa (Western) | WS |
| San Marino | SM |
| São Tomé and Príncipe | ST |
| Saudi Arabia | SA |
| Sénégal | SN |
| Serbia | RS |
| Seychelles | SC |
| Sierra Leone | SL |
| Singapore | SG |
| Slovakia | SK |
| Slovenia | SI |
| Solomon Islands | SB |
| Somalia | SO |
| South Africa | ZA |
| South Georgia And The South Sandwich Islands | GS |
| Spain | ES |
| Sri Lanka | LK |
| Sudan | SD |
| Suriname | SR |
| Svalbard and Jan Mayen Islands | SJ |
| Swaziland | SZ |
| Sweden | SE |
| Switzerland | CH |
| Syria | SY |
| Tahiti | PF |
| Taiwan | TW |
| Tajikistan | TJ |
| Tanzania | TZ |
| Thailand | TH |
| Timor-Leste | TL |
| Togo | TG |
| Tokelau | TK |
| Tonga | TO |
| Trinidad and Tobago | TT |
| Tunisia | TN |
| Turkey | TR |
| Turkmenistan | TM |
| Turks and Caicos Islands | TC |
| Tuvalu | TV |
| Uganda | UG |
| Ukraine | UA |
| United Arab Emirates | AE |
| United Kingdom | GB |
| Upper Volta | BF |
| United States | US |
| United States Minor Outlying Islands | UM |
| Uruguay | UY |
| Uzbekistan | UZ |
| Vanuatu | VU |
| Vatican | VA |
| Venezuela | VE |
| Vietnam | VN |
| Virgin Islands | VG |
| Virgin Islands, U.S. | VI |
| Wake Island | UM |
| Wallis and Futuna Islands | WF |
| Western Sahara | EH |
| Western Samoa | WS |
| Yemen | YE |
| Zaïre | CD |
| Zambia | ZM |
| Zimbabwe | ZW |
Currency codes
| Name | Symbol | Code |
|---|---|---|
| Euro | € | EUR |
| Pound sterling | £ | GBP |
| Canadian dollar | C$ | CAD |
| U.S. dollar | $ | USD |
| Afghan afghani | ؋ | AFN |
| Albanian lek | L | ALL |
| Algerian dinar | د.ج | DZD |
| Angolan kwanza | Kz | AOA |
| Argentine peso | $ | ARS |
| Armenian dram | դր. | AMD |
| Aruban florin | ƒ | AWG |
| Australian dollar | A$ | AUD |
| Azerbaijani manat | ¤ | AZN |
| Bahamian dollar | $ | BSD |
| Bahraini dinar | ب.د | BHD |
| Bangladeshi taka | ¤ | BDT |
| Barbadian dollar | $ | BBD |
| Belarusian ruble | Br | BYR |
| Belize dollar | $ | BZD |
| Bermudian dollar | $ | BMD |
| Bhutanese ngultrum | ¤ | BTN |
| Bolivian boliviano | Bs. | BOB |
| Bosnia & Herzegovina mark | KM | BAM |
| Botswana pula | P | BWP |
| Brazilian real | R$ | BRL |
| Brunei dollar | $ | BND |
| Bulgarian lev | лв | BGN |
| Burundian franc | Fr | BIF |
| Cambodian riel | ¤ | KHR |
| Cape Verdean escudo | Esc | CVE |
| Cayman Islands dollar | $ | KYD |
| Central African CFA franc | Fr | XAF |
| CFP franc | Fr | XPF |
| Chilean peso | $ | CLP |
| Chinese yuan | ¥ | CNY |
| Colombian peso | $ | COP |
| Comorian franc | Fr | KMF |
| Congolese franc | Fr | CDF |
| Costa Rican colón | ₡ | CRC |
| Croatian kuna | kn | HRK |
| Cuban convertible peso | $ | CUC |
| Cuban peso | $ | CUP |
| Czech koruna | Kč | CZK |
| Danish krone | kr. | DKK |
| Djiboutian franc | Fr | DJF |
| Dominican peso | $ | DOP |
| East Caribbean dollar | $ | XCD |
| Egyptian pound | ج.م | EGP |
| Eritrean nakfa | Nfk | ERN |
| Estonian kroon | KR | EEK |
| Ethiopian birr | ¤ | ETB |
| Falkland Islands pound | £ | FKP |
| Fijian dollar | $ | FJD |
| Gambian dalasi | D | GMD |
| Georgian lari | ლ | GEL |
| Ghanaian cedi | ₵ | GHS |
| Gibraltar pound | £ | GIP |
| Guatemalan quetzal | Q | GTQ |
| Guinean franc | Fr | GNF |
| Guyanese dollar | $ | GYD |
| Haitian gourde | G | HTG |
| Honduran lempira | L | HNL |
| Hong Kong dollar | $ | HKD |
| Hungarian forint | Ft | HUF |
| Icelandic króna | kr | ISK |
| Indian rupee | Rs | INR |
| Indonesian rupiah | Rp | IDR |
| Iranian rial | ﷼ | IRR |
| Iraqi dinar | ع.د | IQD |
| Israeli new sheqel | ₪ | ILS |
| Jamaican dollar | $ | JMD |
| Japanese yen | ¥ | JPY |
| Jordanian dinar | د.ا | JOD |
| Kazakhstani tenge | 〒 | KZT |
| Kenyan shilling | Sh | KES |
| Kuwaiti dinar | د.ك | KWD |
| Kyrgyzstani som | ¤ | KGS |
| Lao kip | ₭ | LAK |
| Latvian lats | Ls | LVL |
| Lebanese pound | ل.ل | LBP |
| Lesotho loti | L | LSL |
| Liberian dollar | $ | LRD |
| Libyan dinar | ل.د | LYD |
| Lithuanian litas | Lt | LTL |
| Macanese pataca | P | MOP |
| Macedonian denar | ден | MKD |
| Malagasy ariary | ¤ | MGA |
| Malawian kwacha | MK | MWK |
| Malaysian ringgit | RM | MYR |
| Maldivian rufiyaa | Rf | MVR |
| Mauritanian ouguiya | UM | MRO |
| Mauritian rupee | ₨ | MUR |
| Mexican peso | $ | MXN |
| Moldovan leu | L | MDL |
| Mongolian tögrög | ₮ | MNT |
| Moroccan dirham | د.م. | MAD |
| Mozambican metical | MT | MZN |
| Myanma kyat | Ks | MMK |
| Namibian dollar | $ | NAD |
| Nepalese rupee | ₨ | NPR |
| Netherlands Antillean guilder | ƒ | ANG |
| New Taiwan dollar | $ | TWD |
| New Zealand dollar | $ | NZD |
| Nicaraguan córdoba | C$ | NIO |
| Nigerian naira | ₦ | NGN |
| North Korean won | ₩ | KPW |
| Norwegian krone | kr | NOK |
| Omani rial | ر.ع. | OMR |
| Pakistani rupee | ₨ | PKR |
| Papua New Guinean kina | K | PGK |
| Paraguayan guaraní | ₲ | PYG |
| Peruvian nuevo sol | S/ | PEN |
| Philippine peso | ₱ | PHP |
| Polish złoty | zł | PLN |
| Qatari riyal | ر.ق | QAR |
| Romanian leu | lei | RON |
| Russian ruble | ₽ | RUB |
| Rwandan franc | Fr | RWF |
| Saint Helena pound | £ | SHP |
| Samoan tālā | T | WST |
| São Tomé and Príncipe dobra | Db | STN |
| Saudi riyal | ر.س | SAR |
| Serbian dinar | дин. | RSD |
| Seychellois rupee | ₨ | SCR |
| Sierra Leonean leone | Le | SLL |
| Singapore dollar | $ | SGD |
| Solomon Islands dollar | $ | SBD |
| Somali shilling | Sh | SOS |
| South African rand | R | ZAR |
| South Korean won | ₩ | KRW |
| Sri Lankan rupee | Rs | LKR |
| Sudanese pound | ج.س. | SDG |
| Surinamese dollar | $ | SRD |
| Swazi lilangeni | L | SZL |
| Swedish krona | kr | SEK |
| Swiss franc | Fr | CHF |
| Syrian pound | ل.س. | SYP |
| Tajikistani somoni | ЅМ | TJS |
| Tanzanian shilling | Sh | TZS |
| Thai baht | ฿ | THB |
| Tongan paʻanga | T$ | TOP |
| Trinidad and Tobago dollar | $ | TTD |
| Tunisian dinar | د.ت | TND |
| Turkish lira | ₺ | TRY |
| Turkmenistan manat | m | TMT |
| Ugandan shilling | Sh | UGX |
| Ukrainian hryvnia | ₴ | UAH |
| United Arab Emirates dirham | د.إ | AED |
| Uruguayan peso | $ | UYU |
| Uzbekistani so'm | ¤ | UZS |
| Vanuatu vatu | Vt | VUV |
| Venezuelan bolívar | Bs. | VES |
| Vietnamese đồng | ₫ | VND |
| West African CFA franc | Fr | XOF |
| Yemeni rial | ﷼ | YER |
| Zambian kwacha | ZK | ZMW |
| Zimbabwean dollar | $ | ZWL |
Request limits
You can perform up to 780 requests per minute for each Account. If you exceed this limit, you'll get a 429 Too Many Requests response for subsequent requests.
We recommend you handle 429 responses so your integration retries requests automatically.
- Production Serverhttps://your-account.app.invoicexpress.com/invoices.json
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://your-account.app.invoicexpress.com/invoices.json?api_key=YOUR_API_KEY%2CYOUR_API_KEY_HERE&type%5B%5D=Invoice&status%5B%5D=sent&non_archived=true&archived=true&text=string&reference=string&date%5Bfrom%5D=string&date%5Bto%5D=string&due_date%5Bfrom%5D=string&due_date%5Bto%5D=string&total_before_taxes%5Bfrom%5D=0&total_before_taxes%5Bto%5D=0&page=0&per_page=0'SUCCESS
Creates a new quote, proforma or fees_note.
- ABCD1234-1 (or similar) - Unique document identifier to the Tax Authority, when the sequence is registered.
- N/D - The document's sequence is relevant for ATCUD but is not registered in the Tax Authority.
- N/A - The document's sequence is not relevant for ATCUD and is not registered in the Tax Authority.
{ "invoices": [ { … } ], "pagination": { "total_entries": 50, "per_page": 20, "current_page": 1, "total_pages": 3 } }
Request
Creates a new invoice, simplified_invoice, invoice_receipt, credit_note or debit_note.
This method also allows to create a new client and/or new items in the same request with the following behavior:
- If the client name does not exist, a new one is created.
- If items do not exist with the given names, new ones will be created.
- If item name already exists, the item is updated with the new values.
Regarding item taxes, if the tax name is not found, the default tax is applyed to that item. Portuguese accounts should also send the IVA exemption reason if the invoice contains exempt items (IVA 0%).
Note: Simplified Invoices are only available in Portugal.
Invoice Body
Client Details.
- Production Serverhttps://your-account.app.invoicexpress.com/{invoices-type}.json
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://your-account.app.invoicexpress.com/{invoices-type}.json?api_key=YOUR_API_KEY%2CYOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"invoice": {
"date": "22/11/2025",
"due_date": "22/12/2025",
"reference": "PO-999",
"observations": "Services rendered",
"retention": "0",
"tax_exemption": "M00",
"sequence_id": "123456",
"manual_sequence_number": "string",
"client": {
"name": "Client A",
"code": "CLI-001",
"email": "client@mail.com",
"address": "Street A",
"city": "Lisbon",
"postal_code": "1000-100",
"fiscal_id": "500999888",
"country": "Portugal",
"website": "www.client-a.com",
"phone": "912345678",
"fax": "212345678",
"observations": "VIP Client"
},
"items": [
{
"name": "Consulting",
"description": "IT Services",
"unit_price": 50,
"quantity": 2,
"unit": "hour",
"discount": 0,
"tax": {
"name": "IVA23"
}
}
],
"mb_reference": "1",
"owner_invoice_id": 1049,
"tax_exemption_reason": "M00",
"currency_code": "USD",
"rate": "1.10",
"plugin_id": "plugin_123",
"global_discount": {
"value_type": "percentage",
"value": 10
}
},
"proprietary_uid": "uuid-123"
}'SUCCESS
Creates a new quote, proforma or fees_note.
- ABCD1234-1 (or similar) - Unique document identifier to the Tax Authority, when the sequence is registered.
- N/D - The document's sequence is relevant for ATCUD but is not registered in the Tax Authority.
- N/A - The document's sequence is not relevant for ATCUD and is not registered in the Tax Authority.
{ "invoice": { "id": 2137287, "status": "final", "archived": false, "type": "Invoice", "sequence_number": "6/G", "inverted_sequence_number": "G/6", "atcud": "ABCD1234-6", "sequence_id": "12345", "tax_exemption": "M01", "date": "04/08/2016", "due_date": "19/08/2016", "reference": "ref123", "observations": "Observations", "retention": "0", "permalink": "https://www.app.invoicexpress.com/documents/...", "saft_hash": "J4ay", "sum": 24.39, "discount": 0, "before_taxes": 24.39, "taxes": 5.61, "total": 30, "currency": "Euro", "client": { … }, "items": [ … ], "mb_reference": { … } } }
- Production Serverhttps://your-account.app.invoicexpress.com/{invoices-type}/{document-id}.json
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://your-account.app.invoicexpress.com/{invoices-type}/1050.json?api_key=YOUR_API_KEY%2CYOUR_API_KEY_HERE'SUCCESS
Creates a new quote, proforma or fees_note.
- ABCD1234-1 (or similar) - Unique document identifier to the Tax Authority, when the sequence is registered.
- N/D - The document's sequence is relevant for ATCUD but is not registered in the Tax Authority.
- N/A - The document's sequence is not relevant for ATCUD and is not registered in the Tax Authority.
{ "invoice": { "id": 2137287, "status": "final", "archived": false, "type": "Invoice", "sequence_number": "6/G", "inverted_sequence_number": "G/6", "atcud": "ABCD1234-6", "sequence_id": "12345", "tax_exemption": "M01", "date": "04/08/2016", "due_date": "19/08/2016", "reference": "ref123", "observations": "Observations", "retention": "0", "permalink": "https://www.app.invoicexpress.com/documents/...", "saft_hash": "J4ay", "sum": 24.39, "discount": 0, "before_taxes": 24.39, "taxes": 5.61, "total": 30, "currency": "Euro", "client": { … }, "items": [ … ], "mb_reference": { … } } }
Request
Updates a new invoice, simplified_invoice, invoice_receipt, credit_note or debit_note.
This method also allows to create a new client and/or new items in the same request with the following behavior:
- If the client name does not exist, a new one is created.
- If items do not exist with the given names, new ones will be created.
- If item name already exists, the item is updated with the new values.
Regarding item taxes, if the tax name is not found, the default tax is applyed to that item. Portuguese accounts should also send the IVA exemption reason if the invoice contains exempt items (IVA 0%).
Note: Simplified Invoices are only available in Portugal.
The type of the invoice document.
Invoice Body
Client Details.
- Production Serverhttps://your-account.app.invoicexpress.com/{invoices-type}/{document-id}.json
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://your-account.app.invoicexpress.com/{invoices-type}/1050.json?api_key=YOUR_API_KEY%2CYOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"invoice": {
"date": "22/11/2025",
"due_date": "22/12/2025",
"reference": "PO-999",
"observations": "Services rendered",
"retention": "0",
"tax_exemption": "M00",
"sequence_id": "123456",
"manual_sequence_number": "string",
"client": {
"name": "Client A",
"code": "CLI-001",
"email": "client@mail.com",
"address": "Street A",
"city": "Lisbon",
"postal_code": "1000-100",
"fiscal_id": "500999888",
"country": "Portugal",
"website": "www.client-a.com",
"phone": "912345678",
"fax": "212345678",
"observations": "VIP Client"
},
"items": [
{
"name": "Consulting",
"description": "IT Services",
"unit_price": 50,
"quantity": 2,
"unit": "hour",
"discount": 0,
"tax": {
"name": "IVA23"
}
}
],
"mb_reference": "1",
"owner_invoice_id": 1049,
"tax_exemption_reason": "M00",
"currency_code": "USD",
"rate": "1.10",
"plugin_id": "plugin_123",
"global_discount": {
"value_type": "percentage",
"value": 10
}
}
}'SUCCESS
Creates a new quote, proforma or fees_note.
- ABCD1234-1 (or similar) - Unique document identifier to the Tax Authority, when the sequence is registered.
- N/D - The document's sequence is relevant for ATCUD but is not registered in the Tax Authority.
- N/A - The document's sequence is not relevant for ATCUD and is not registered in the Tax Authority.
{ "invoice": { "id": 2137287, "status": "final", "archived": false, "type": "Invoice", "sequence_number": "6/G", "inverted_sequence_number": "G/6", "atcud": "ABCD1234-6", "sequence_id": "12345", "tax_exemption": "M01", "date": "04/08/2016", "due_date": "19/08/2016", "reference": "ref123", "observations": "Observations", "retention": "0", "permalink": "https://www.app.invoicexpress.com/documents/...", "saft_hash": "J4ay", "sum": 24.39, "discount": 0, "before_taxes": 24.39, "taxes": 5.61, "total": 30, "currency": "Euro", "client": { … }, "items": [ … ], "mb_reference": { … } } }
Request
Changes the state of invoice documents.
| From | To | State on Request Body | Notes |
|---|---|---|---|
| draft | final | finalized | All documents. |
| draft | settled | finalized | Only invoice_receipt. |
| draft | deleted | deleted | All documents. |
| final | canceled | canceled | All documents. |
| settled | canceled | canceled | Only invoice_receipt. |
| final | settled | settled | All documents. |
| settled | final | unsettled | Only credit_note and debit_note. |
The type of the invoice document.
- Production Serverhttps://your-account.app.invoicexpress.com/{invoices-type}/{document-id}/change-state.json
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://your-account.app.invoicexpress.com/{invoices-type}/1050/change-state.json?api_key=YOUR_API_KEY%2CYOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"invoice": {
"state": "finalized",
"message": "Wrong value"
}
}'SUCCESS
Creates a new quote, proforma or fees_note.
- ABCD1234-1 (or similar) - Unique document identifier to the Tax Authority, when the sequence is registered.
- N/D - The document's sequence is relevant for ATCUD but is not registered in the Tax Authority.
- N/A - The document's sequence is not relevant for ATCUD and is not registered in the Tax Authority.
{ "invoice": { "id": 2137287, "status": "final", "archived": false, "type": "Invoice", "sequence_number": "6/G", "inverted_sequence_number": "G/6", "atcud": "ABCD1234-6", "sequence_id": "12345", "tax_exemption": "M01", "date": "04/08/2016", "due_date": "19/08/2016", "reference": "ref123", "observations": "Observations", "retention": "0", "permalink": "https://www.app.invoicexpress.com/documents/...", "saft_hash": "J4ay", "sum": 24.39, "discount": 0, "before_taxes": 24.39, "taxes": 5.61, "total": 30, "currency": "Euro", "client": { … }, "items": [ … ], "mb_reference": { … } } }
The type of the invoice document.
- Production Serverhttps://your-account.app.invoicexpress.com/{invoices-type}/{document-id}/email-document.json
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://your-account.app.invoicexpress.com/{invoices-type}/1050/email-document.json?api_key=YOUR_API_KEY%2CYOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"message": {
"client": {
"email": "dest@mail.com",
"save": "1"
},
"subject": "Invoice",
"body": "Attached.",
"cc": "cc@mail.com",
"bcc": "bcc@mail.com",
"logo": "1"
}
}'- Production Serverhttps://your-account.app.invoicexpress.com/api/pdf/{document-id}.json
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://your-account.app.invoicexpress.com/api/pdf/1050.json?api_key=YOUR_API_KEY%2CYOUR_API_KEY_HERE&second_copy=false'{ "output": { "pdfUrl": "url.pdf" } }
- Production Serverhttps://your-account.app.invoicexpress.com/api/qr_codes/{document-id}.json
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://your-account.app.invoicexpress.com/api/qr_codes/1050.json?api_key=YOUR_API_KEY%2CYOUR_API_KEY_HERE'{ "qr_code": { "url": "url.png" } }
- Production Serverhttps://your-account.app.invoicexpress.com/documents/{document-id}/partial_payments.json
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://your-account.app.invoicexpress.com/documents/1050/partial_payments.json?api_key=YOUR_API_KEY%2CYOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"partial_payment": {
"amount": 10,
"payment_mechanism": "TB",
"note": "Transfer",
"serie": "string",
"payment_date": "22/11/2025"
}
}'SUCCESS
Creates a new quote, proforma or fees_note.
- ABCD1234-1 (or similar) - Unique document identifier to the Tax Authority, when the sequence is registered.
- N/D - The document's sequence is relevant for ATCUD but is not registered in the Tax Authority.
- N/A - The document's sequence is not relevant for ATCUD and is not registered in the Tax Authority.
{ "receipt": { "id": 2137287, "status": "final", "archived": false, "type": "Invoice", "sequence_number": "6/G", "inverted_sequence_number": "G/6", "atcud": "ABCD1234-6", "sequence_id": "12345", "tax_exemption": "M01", "date": "04/08/2016", "due_date": "19/08/2016", "reference": "ref123", "observations": "Observations", "retention": "0", "permalink": "https://www.app.invoicexpress.com/documents/...", "saft_hash": "J4ay", "sum": 24.39, "discount": 0, "before_taxes": 24.39, "taxes": 5.61, "total": 30, "currency": "Euro", "client": { … }, "items": [ … ], "mb_reference": { … } } }
- Production Serverhttps://your-account.app.invoicexpress.com/receipts/{receipt-id}/change-state.json
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://your-account.app.invoicexpress.com/receipts/42/change-state.json?api_key=YOUR_API_KEY%2CYOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"receipt": {
"state": "canceled",
"message": "Error"
}
}'{ "receipt": { "id": 2137287, "status": "final", "archived": false, "type": "Invoice", "sequence_number": "6/G", "inverted_sequence_number": "G/6", "atcud": "ABCD1234-6", "sequence_id": "12345", "tax_exemption": "M01", "date": "04/08/2016", "due_date": "19/08/2016", "reference": "ref123", "observations": "Observations", "retention": "0", "permalink": "https://www.app.invoicexpress.com/documents/...", "saft_hash": "J4ay", "sum": 24.39, "discount": 0, "before_taxes": 24.39, "taxes": 5.61, "total": 30, "currency": "Euro", "client": { … }, "items": [ … ], "mb_reference": { … } } }