MX Invoice
With MX™ Invoice, invoicing your customers is now integrated and effortless. Simply select a customer, enter the line item detail and click send.
Sending invoices and receiving payments have never been easier. The option to accept credit card payments on a sent invoice makes collecting funds fast and hassle-free. Your customer is e-mailed a link to view their invoice and given the option to pay with their credit card. The payment is then automatically collected and your customer receives an e-mailed receipt at the time of payment.
Create Invoice
POST: https://sandbox.api.mxmerchant.com/checkout/v3/invoice?echo=true
{
"created": "2020-10-14T18:39:51.806Z",
"invoiceDate": "2020-10-14T18:39:51.806Z",
"merchantId": 000000000,
"status": "Unpaid",
"isClick2PayEnabled": true,
"allowCreditCard": true,
"allowACH": false,
"terms": "OnReceipt",
"dueDate": "2020-10-14T18:39:51.806Z",
"purchases": [
{
"id": -1,
"productName": "Product 1",
"price": 1,
"quantity": 1,
"discount": 0,
"tax": [],
"totalAmount": "1",
"taxCategory": {
"name": "No Tax",
"code": "No Tax",
"id": -1,
"display": "0.000 % - No Tax",
"taxes": [],
"taxRate": 0,
"showTaxes": false,
"noTaxes": false
},
"isPanelOpen": false,
"applicableDiscounts": [
{
"name": "No Discount",
"selected": true
},
{
"merchantId": 000000000,
"dba": "Merchant DBA Name",
"discountType": "Item",
"discountRateType": "Amount",
"discountApplicationType": "Automatic",
"name": "discount test",
"rate": "20",
"code": "DA4C9CG8VD25JJG8",
"isExclusive": false,
"isApprovalRequired": false,
"created": "2020-09-10T13:15:51.44Z",
"modified": "2020-09-10T13:15:51.44Z",
"tags": [],
"discountId": 10000000004126,
"selected": false
}
],
"taxCategories": [
{
"id": -1,
"display": "0.000 % - No Tax",
"code": "No Tax",
"isSelected": "true",
"taxes": []
},
{
"id": 2584,
"display": "7.000 % - Georgia",
"code": "Georgia",
"isSelected": "false",
"taxes": [
{
"id": 5913,
"name": "georgia",
"description": "georgia tax",
"rate": "0.07",
"created": "2020-08-26T15:49:14Z",
"modified": "2020-08-26T16:16:20.42Z",
"taxCategories": [
{
"id": 2584,
"name": "Georgia",
"code": "Georgia",
"created": "2020-08-26T16:07:58.45Z",
"modified": "2020-10-14T18:17:17.037Z",
"isPrimary": false,
"primaryExists": false,
"recordCount": 0
}
],
"display": "7.000 % - georgia",
"taxCode": "Georgia",
"taxCategoryId": 2584
}
]
}
],
"chunkedTaxData": [
[
{
"id": -1,
"display": "0.000 % - No Tax",
"code": "No Tax",
"isSelected": "true",
"taxes": []
}
],
[
{
"id": 2584,
"display": "7.000 % - Georgia",
"code": "Georgia",
"isSelected": "false",
"taxes": [
{
"id": 5913,
"name": "georgia",
"description": "georgia tax",
"rate": "0.07",
"created": "2020-08-26T15:49:14Z",
"modified": "2020-08-26T16:16:20.42Z",
"taxCategories": [
{
"id": 2584,
"name": "Georgia",
"code": "Georgia",
"created": "2020-08-26T16:07:58.45Z",
"modified": "2020-10-14T18:17:17.037Z",
"isPrimary": false,
"primaryExists": false,
"recordCount": 0
}
],
"display": "7.000 % - georgia",
"taxCode": "Georgia",
"taxCategoryId": 2584
}
]
}
]
],
"applicableTaxCategories": [
{
"id": -1,
"display": "0.000 % - No Tax",
"code": "No Tax",
"isSelected": "true",
"taxes": []
},
{
"id": 2584,
"display": "7.000 % - Georgia",
"code": "Georgia",
"isSelected": "false",
"taxes": [
{
"id": 5913,
"name": "georgia",
"description": "georgia tax",
"rate": "0.07",
"created": "2020-08-26T15:49:14Z",
"modified": "2020-08-26T16:16:20.42Z",
"taxCategories": [
{
"id": 2584,
"name": "Georgia",
"code": "Georgia",
"created": "2020-08-26T16:07:58.45Z",
"modified": "2020-10-14T18:17:17.037Z",
"isPrimary": false,
"primaryExists": false,
"recordCount": 0
}
],
"display": "7.000 % - georgia",
"taxCode": "Georgia",
"taxCategoryId": 2584
}
]
}
],
"initials": "P1",
"description": "Product 1 Description",
"taxes": [],
"discounts": [],
"priceError": false,
"taxAmount": "0",
"subTotalAmount": "1",
"discountAmount": "0",
"priceDiscountAmount": "0"
},
{
"id": -2,
"productName": "Product 2",
"price": 2,
"quantity": 1,
"discount": 0,
"tax": [],
"totalAmount": "0",
"taxCategory": {
"id": 2584,
"name": "Georgia",
"code": "Georgia",
"created": "2020-08-26T16:07:58.45Z",
"modified": "2020-10-14T18:17:17.037Z",
"associatedTaxNames": "georgia",
"associatedTaxIds": "5913",
"totalTax": "0.070000000",
"isPrimary": true,
"primaryExists": true,
"recordCount": 1,
"taxes": [
{
"id": 5913,
"name": "georgia",
"description": "georgia tax",
"rate": "0.07",
"created": "2020-08-26T15:49:14Z",
"modified": "2020-08-26T16:16:20.42Z",
"taxCategories": [
{
"id": 2584,
"name": "Georgia",
"code": "Georgia",
"created": "2020-08-26T16:07:58.45Z",
"modified": "2020-10-14T18:17:17.037Z",
"isPrimary": false,
"primaryExists": false,
"recordCount": 0
}
],
"display": "7.000 % - georgia",
"taxCode": "Georgia",
"taxCategoryId": 2584
}
],
"display": "7.000 % - Georgia",
"taxRate": 0.07,
"showTaxes": false,
"noTaxes": false
},
"isPanelOpen": true,
"applicableDiscounts": [
{
"name": "No Discount",
"selected": false
},
{
"merchantId": 000000000,
"dba": "Merchant DBA Name",
"discountType": "Item",
"discountRateType": "Amount",
"discountApplicationType": "Automatic",
"name": "discount test",
"rate": "20",
"code": "DA4C9CG8VD25JJG8",
"isExclusive": false,
"isApprovalRequired": false,
"created": "2020-09-10T13:15:51.44Z",
"modified": "2020-09-10T13:15:51.44Z",
"tags": [],
"discountId": 10000000004126,
"selected": true
}
],
"taxCategories": [
{
"id": -1,
"display": "0.000 % - No Tax",
"code": "No Tax",
"isSelected": "false",
"taxes": []
},
{
"id": 2584,
"display": "7.000 % - Georgia",
"code": "Georgia",
"isSelected": "true",
"taxes": [
{
"id": 5913,
"name": "georgia",
"description": "georgia tax",
"rate": "0.07",
"created": "2020-08-26T15:49:14Z",
"modified": "2020-08-26T16:16:20.42Z",
"taxCategories": [
{
"id": 2584,
"name": "Georgia",
"code": "Georgia",
"created": "2020-08-26T16:07:58.45Z",
"modified": "2020-10-14T18:17:17.037Z",
"isPrimary": false,
"primaryExists": false,
"recordCount": 0
}
],
"display": "7.000 % - georgia",
"taxCode": "Georgia",
"taxCategoryId": 2584
}
],
"showTaxes": true
}
],
"chunkedTaxData": [
[
{
"id": -1,
"display": "0.000 % - No Tax",
"code": "No Tax",
"isSelected": "false",
"taxes": []
}
],
[
{
"id": 2584,
"display": "7.000 % - Georgia",
"code": "Georgia",
"isSelected": "true",
"taxes": [
{
"id": 5913,
"name": "georgia",
"description": "georgia tax",
"rate": "0.07",
"created": "2020-08-26T15:49:14Z",
"modified": "2020-08-26T16:16:20.42Z",
"taxCategories": [
{
"id": 2584,
"name": "Georgia",
"code": "Georgia",
"created": "2020-08-26T16:07:58.45Z",
"modified": "2020-10-14T18:17:17.037Z",
"isPrimary": false,
"primaryExists": false,
"recordCount": 0
}
],
"display": "7.000 % - georgia",
"taxCode": "Georgia",
"taxCategoryId": 2584
}
],
"showTaxes": true
}
]
],
"applicableTaxCategories": [
{
"id": -1,
"display": "0.000 % - No Tax",
"code": "No Tax",
"isSelected": "false",
"taxes": []
},
{
"id": 2584,
"display": "7.000 % - Georgia",
"code": "Georgia",
"isSelected": "true",
"taxes": [
{
"id": 5913,
"name": "georgia",
"description": "georgia tax",
"rate": "0.07",
"created": "2020-08-26T15:49:14Z",
"modified": "2020-08-26T16:16:20.42Z",
"taxCategories": [
{
"id": 2584,
"name": "Georgia",
"code": "Georgia",
"created": "2020-08-26T16:07:58.45Z",
"modified": "2020-10-14T18:17:17.037Z",
"isPrimary": false,
"primaryExists": false,
"recordCount": 0
}
],
"display": "7.000 % - georgia",
"taxCode": "Georgia",
"taxCategoryId": 2584
}
],
"showTaxes": true
}
],
"description": "Product 2 Description",
"initials": "P2",
"taxes": [
{
"id": 5913,
"name": "georgia",
"description": "georgia tax",
"rate": "0.07",
"created": "2020-08-26T15:49:14Z",
"modified": "2020-08-26T16:16:20.42Z",
"taxCategories": [
{
"id": 2584,
"name": "Georgia",
"code": "Georgia",
"created": "2020-08-26T16:07:58.45Z",
"modified": "2020-10-14T18:17:17.037Z",
"isPrimary": false,
"primaryExists": false,
"recordCount": 0
}
],
"display": "7.000 % - georgia",
"taxCode": "Georgia",
"taxCategoryId": 2584
}
],
"discounts": [
{
"merchantId": 000000000,
"dba": "Merchant DBA Name",
"discountType": "Item",
"discountRateType": "Amount",
"discountApplicationType": "Automatic",
"name": "discount test",
"rate": "20",
"code": "DA4C9CG8VD25JJG8",
"isExclusive": false,
"isApprovalRequired": false,
"created": "2020-09-10T13:15:51.44Z",
"modified": "2020-09-10T13:15:51.44Z",
"tags": [],
"discountId": 10000000004126,
"selected": true
}
],
"priceError": false,
"taxAmount": "0",
"subTotalAmount": "0",
"discountAmount": "2",
"priceDiscountAmount": "2",
"taxRate": 0.07
}
],
"shippingAddress": {
"id": 10000000572963,
"address1": "100 Sunshine Ave",
"city": "Sunshine",
"state": "GA",
"zip": "32234",
"country": "US",
"created": "2020-02-07T15:18:40.833Z",
"isDefault": true
},
"billingAddress": {
"id": 10000000572963,
"address1": "100 Sunshine Ave",
"city": "Sunshine",
"state": "GA",
"zip": "32234",
"country": "US",
"created": "2020-02-07T15:18:40.833Z",
"isDefault": true
},
"customer": {
"id": 10000000761534,
"created": "2020-02-07T15:16:43.167Z",
"name": "John Doe",
"firstName": "John",
"lastName": "Doe",
"customerNumber": "01",
"primaryContact": "[email protected]",
"isTaxExempt": false,
"email": "[email protected]",
"phone": "",
"mobile": "7703982938"
},
"isTaxExempt": false,
"totalAmount": "1",
"discountAmount": "0",
"taxAmount": "0",
"balance": "1",
"subTotalAmount": "1",
"quantity": 2,
"memo": "Memo Field",
"taxes": [],
"shippingLineItems": []
}
Response
{
"id": 239998,
"merchantId": 000000000,
"type": "Sale",
"receiptNumber": "PTFOO01174PV",
"accessCode": "FVF745",
"invoiceNumber": 1047,
"isTaxExempt": false,
"memo": "Memo Field",
"quantity": "2",
"saleQuantity": "2",
"returnQuantity": "0",
"returnStatus": "None",
"netQuantity": "2",
"totalAmount": "1",
"taxAmount": "0",
"subTotalAmount": "1",
"discountAmount": "0",
"balance": "1",
"paidAmount": "0",
"dueDate": "2020-10-14T04:00:00Z",
"created": "2020-10-14T18:42:15.143Z",
"invoiceDate": "2020-10-14T04:00:00Z",
"sourceType": "MXM",
"purchases": [
{
"id": 56839,
"productName": "Product 1",
"description": "Product 1 Description",
"quantity": 1,
"quantityReturned": 0,
"price": "1",
"discountAmount": "0",
"priceDiscountAmount": "0",
"subTotalAmount": "1",
"taxRate": "0",
"taxAmount": "0",
"totalAmount": "1",
"trackingNumber": 0,
"created": "2020-10-14T18:42:15.173Z"
},
{
"id": 56840,
"productName": "Product 2",
"description": "Product 2 Description",
"quantity": 1,
"quantityReturned": 0,
"price": "2",
"discountAmount": "2",
"priceDiscountAmount": "2",
"subTotalAmount": "0",
"taxRate": "0.07",
"taxAmount": "0",
"totalAmount": "0",
"trackingNumber": 0,
"created": "2020-10-14T18:42:15.173Z",
"taxes": [
{
"id": 5913,
"name": "georgia",
"rate": "0.07",
"taxCode": "Georgia",
"taxAmount": "0"
}
],
"discounts": [
{
"id": 37428,
"discountType": "Item",
"discountRateType": "Amount",
"name": "discount test",
"rate": "20",
"amount": "2",
"code": "DA4C9CG8VD25JJG8",
"tags": [],
"products": [],
"collections": [],
"discountId": 10000000004126
}
]
}
],
"taxes": [
{
"id": 5913,
"name": "georgia",
"rate": "0.07",
"taxAmount": "0"
}
],
"customer": {
"id": 10000000761534,
"name": "John Doe",
"email": "[email protected]",
"mobile": "7703982938"
},
"billingAddress": {
"address1": "100 Sunshine Ave",
"city": "Sunshine",
"state": "GA",
"zip": "32234",
"country": "US"
},
"shippingAddress": {
"address1": "100 Sunshine Ave",
"city": "Sunshine",
"state": "GA",
"zip": "32234",
"country": "US"
},
"masterCardSecureCode": "0",
"status": "Unpaid",
"terms": "OnReceipt",
"barCode": "iVBORw0KGgoAAAANSUhEUgAAAKoAAAAgCAYAAACCXeM8AAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAatSURBVHhe7ZLBiiw5EAPn/396ljQVEBYyGJ/2wQQ0DklZt/75/eOPf4D1R/35+Vk/PHHHre9bPjkZvJuXW+92w+bdDvTecge21uFA3zp7ZnvbhnTvt9nuzIsDXd5kTgc63/Diw7J2aLYPvlvft3xyMng3L7fe7YbNux3oveUObK3Dgb519sz2tg3p3m+z3ZkXB7q8yZwOdL7hxYdl7dBsH3y3vm/55GTwbl5uvdsNm3c70HvLHdhahwN96+yZ7W0b0r3fZrszLw50eZM5Heh8w4sPy9qh2T74bn3f8snJ4N283Hq3GzbvdqD3ljuwtQ4H+tbZM9vbNqR7v812Z14c6PImczrQ+YYXH5a1Q7N98N36vuWTk8G7ebn1bjds3u1A7y13YGsdDvSts2e2t21I936b7c68ONDlTeZ0oPMNLz4sa4dm++C79X3LJyeDd/Ny691u2Lzbgd5b7sDWOhzoW2fPbG/bkO79NtudeXGgy5vM6UDnG158WNYOzfbBd+v7lk9OBu/m5da73bB5twO9t9yBrXU40LfOntnetiHd+222O/PiQJc3mdOBzje8+LCsHZrtg+/W9y2fnAzezcutd7th824Hem+5A1vrcKBvnT2zvW1DuvfbbHfmxYEubzKnA51vePFhWTs02wffre9bPjkZvJuXW+92w+bdDvTecge21uFA3zp7ZnvbhnTvt9nuzIsDXd5kTgc63/Diw7J2aLYPvlvft3xyMng3L7fe7YbNux3oveUObK3Dgb519sz2tg3p3m+z3ZkXB7q8yZwOdL7hxYdl7dBsH3y3vm/55GTwbl5uvdsNm3c70HvLHdhahwN96+yZ7W0b0r3fZrszLw50eZM5Heh8w4sPy9qh2T74bn3f8snJ4N283Hq3GzbvdqD3ljuwtQ4H+tbZM9vbNqR7v812Z14c6PImczrQ+YYXH5a1Q7N98N36vuWTk8G7ebn1bjds3u1A7y13YGsdDvSts2e2t21I936b7c68ONDlTeZ0oPMNLz4sa4dm++C79X3LJyeDd/Ny691u2Lzbgd5b7sDWOhzoW2fPbG/bkO79NtudeXGgy5vM6UDnG158WNYOzfbBd+v7lk9OBu/m5da73bB5twO9t9yBrXU40LfOntnetiHd+222O/PiQJc3mdOBzje8+LCsHZrtg+/W9y2fnAzezcutd7th824Hem+5A1vrcKBvnT2zvW1DuvfbbHfmxYEubzKnA51vePFhWTs02wffre9bPjkZvJuXW+92w+bdDvTecge21uFA3zp7ZnvbhnTvt9nuzIsDXd5kTgc63/Diw7J2aLYPvlvft3xyMng3L7fe7YbNux3oveUObK3Dgb519sz2tg3p3m+z3ZkXB7q8yZwOdL7hxYdl7dBsH3y3vm/55GTwbl5uvdsNm3c70HvLHdhahwN96+yZ7W0b0r3fZrszLw50eZM5Heh8w4sPy9qh2T74bn3f8snJ4N283Hq3GzbvdqD3ljuwtQ4H+tbZM9vbNqR7v812Z14c6PImczrQ+YYXH5a1Q7N98N36vuWTk8G7ebn1bjds3u1A7y13YGsdDvSts2e2t21I936b7c68ONDlTeZ0oPMNLz4sa4dm++C79X3LJyeDd/Ny691u2Lzbgd5b7sDWOhzoW2fPbG/bkO79NtudeXGgy5vM6UDnG158WNYOzfbBd+v7lk9OBu/m5da73bB5twO9t9yBrXU40LfOntnetiHd+222O/PiQJc3mdOBzje8+LCsHZrtg+/W9y2fnAzezcutd7th824Hem+5A1vrcKBvnT2zvW1DuvfbbHfmxYEubzKnA51vePFhWTs02wffre9bPjkZvJuXW+92w+bdDvTecge21uFA3zp7ZnvbhnTvt9nuzIsDXd5kTgc63/Diw7J2aLYPvlvft3xyMng3L7fe7YbNux3oveUObK3Dgb519sz2tg3p3m+z3ZkXB7q8yZwOdL7hxYdl7dBsH3y3vm/55GTwbl5uvdsNm3c70HvLHdhahwN96+yZ7W0b0r3fZrszLw50eZM5Heh8w4sPy9qh2T74bn3f8snJ4N283Hq3GzbvdqD3ljuwtQ4H+tbZM9vbNqR7v812Z14c6PImczrQ+YYXH5a1Q7N98N36vuWTk8G7ebn1bjds3u1A7y13YGsdDvSts2e2t21I936b7c68ONDlTeZ0oPMNLz4sa4dm++C79X3LJyeDd/Ny691u2Lzbgd5b7sDWOhzoW2fPbG/bkO79NtudeXGgy5vM6UDnG1582L/644//Jb+//wFObg++cwJRZAAAAABJRU5ErkJggg==",
"allowCreditCard": true,
"allowACH": false,
"isShippingSameAsBilling": false,
"legacy": false
}
Send Invoice Receipt
Getting Tax and Tax Category Information
You man need to retrieve tax and tax category information in order to set up an invoice. If you do not have the tax Id, you can perform a GET and retrieve the tax Id and the tax category Id.
GET: https://api.mxmerchant.com/checkout/v3/tax?merchantId={{merchantId}}
{
"records": [
{
"id": 5913, // Tax Id
"name": "georgia",
"description": "georgia tax",
"rate": "0.07",
"created": "2020-08-26T15:49:14Z",
"modified": "2020-08-26T16:16:20.42Z",
"taxCategories": [
{
"id": 2584, // Tax Category Id
"name": "Georgia",
"code": "Georgia",
"created": "2020-08-26T16:07:58.45Z",
"modified": "2020-10-14T18:17:17.037Z",
"isPrimary": false,
"primaryExists": false,
"recordCount": 0
}
]
}
],
"recordCount": 1
}
Additional Resources
Videos
- MX Invoice - Activation: Instruction Video
Updated 6 days ago