v1

latestOpenAPI 3.1.02026-07-241660500.9 KB

Create Invoice

post/v3/invoice

Query parameters

echoboolean

Return Response

Request body

merchantIdinteger required

The identification number of the merchant's account in the MX Merchant system.

isClick2PayEnabledboolean

allowCreditCardboolean

True means invoice can be paid with a credit card.

statusstring

Status of the invoice: Unpaid, Paid, Cancelled

termsstring

dueDatestring date

Date the invoice is due to be paid.

purchaseOrderNumberstring

memostring

A field where a memo can be contained.

orderIdstring

Response

200

idinteger

merchantIdinteger

typestring

receiptNumberstring

accessCodestring

invoiceNumberinteger

isTaxExemptboolean

quantitystring

saleQuantitystring

returnQuantitystring

returnStatusstring

netQuantitystring

totalAmountstring

taxAmountstring

subTotalAmountstring

discountAmountstring

balancestring

paidAmountstring

dueDatestring

createdstring

purchaseOrderNumberstring

invoiceDatestring

sourceTypestring

shippingLineItemsobject[]

discountsobject[]

taxesobject[]

masterCardSecureCodestring

statusstring

paymentsobject[]

barCodestring

allowCreditCardboolean

isShippingSameAsBillingboolean

orderIdinteger

legacyboolean

Example response

{
  "id": 260774,
  "merchantId": 516167953,
  "type": "Sale",
  "receiptNumber": "PTO6900CTU1Q",
  "accessCode": "OMGDES",
  "invoiceNumber": 1044,
  "quantity": "1",
  "saleQuantity": "1",
  "returnQuantity": "0",
  "returnStatus": "None",
  "netQuantity": "1",
  "totalAmount": "-5.28",
  "taxAmount": "0",
  "subTotalAmount": "0.69",
  "discountAmount": "0",
  "balance": "-5.28",
  "paidAmount": "0",
  "dueDate": "2022-02-28T05:00:00Z",
  "created": "2022-02-25T14:08:50.37Z",
  "purchaseOrderNumber": "351134",
  "invoiceDate": "2022-02-25T05:00:00Z",
  "sourceType": "MXM",
  "purchases": [
    {
      "id": 78629,
      "productName": "Test",
      "quantity": 1,
      "price": "0.69",
      "discountAmount": "10.42",
      "priceDiscountAmount": "0",
      "subTotalAmount": "0.69",
      "taxAmount": "0",
      "totalAmount": "0.69",
      "created": "2022-02-25T14:08:50.387Z",
      "originalId": 661319
    }
  ],
  "customer": {
    "id": 10000000803145
  },
  "billingAddress": {
    "address1": "2001 Westside Parkway",
    "city": "Alpharetta",
    "state": "GA",
    "zip": "30013"
  },
  "shippingAddress": {
    "address1": "2001 Westside Parkway",
    "city": "Alpharetta",
    "state": "GA",
    "zip": "30013"
  },
  "masterCardSecureCode": "0",
  "status": "Draft",
  "barCode": "iVBORw0KGgoAAAANSUhEUgAAAKoAAAAgCAYAAACCXeM8AAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAbkSURBVHhe7ZJBiixJFMP6/pfuwUkKlMYR6z/QgiLlZ8eufn7/+ON/wPNH/fn5eX544xtb71c+ORncm96fPJDdQ3fBu3UPdNzsod29PdjDytyWk6F7+y1Dd8G53dC5v/m6mbXhi4fH1tB8Hrxb71c+ORncm96fPJDdQ3fBu3UPdNzsod29PdjDytyWk6F7+y1Dd8G53dC5v/m6mbXhi4fH1tB8Hrxb71c+ORncm96fPJDdQ3fBu3UPdNzsod29PdjDytyWk6F7+y1Dd8G53dC5v/m6mbXhi4fH1tB8Hrxb71c+ORncm96fPJDdQ3fBu3UPdNzsod29PdjDytyWk6F7+y1Dd8G53dC5v/m6mbXhi4fH1tB8Hrxb71c+ORncm96fPJDdQ3fBu3UPdNzsod29PdjDytyWk6F7+y1Dd8G53dC5v/m6mbXhi4fH1tB8Hrxb71c+ORncm96fPJDdQ3fBu3UPdNzsod29PdjDytyWk6F7+y1Dd8G53dC5v/m6mbXhi4fH1tB8Hrxb71c+ORncm96fPJDdQ3fBu3UPdNzsod29PdjDytyWk6F7+y1Dd8G53dC5v/m6mbXhi4fH1tB8Hrxb71c+ORncm96fPJDdQ3fBu3UPdNzsod29PdjDytyWk6F7+y1Dd8G53dC5v/m6mbXhi4fH1tB8Hrxb71c+ORncm96fPJDdQ3fBu3UPdNzsod29PdjDytyWk6F7+y1Dd8G53dC5v/m6mbXhi4fH1tB8Hrxb71c+ORncm96fPJDdQ3fBu3UPdNzsod29PdjDytyWk6F7+y1Dd8G53dC5v/m6mbXhi4fH1tB8Hrxb71c+ORncm96fPJDdQ3fBu3UPdNzsod29PdjDytyWk6F7+y1Dd8G53dC5v/m6mbXhi4fH1tB8Hrxb71c+ORncm96fPJDdQ3fBu3UPdNzsod29PdjDytyWk6F7+y1Dd8G53dC5v/m6mbXhi4fH1tB8Hrxb71c+ORncm96fPJDdQ3fBu3UPdNzsod29PdjDytyWk6F7+y1Dd8G53dC5v/m6mbXhi4fH1tB8Hrxb71c+ORncm96fPJDdQ3fBu3UPdNzsod29PdjDytyWk6F7+y1Dd8G53dC5v/m6mbXhi4fH1tB8Hrxb71c+ORncm96fPJDdQ3fBu3UPdNzsod29PdjDytyWk6F7+y1Dd8G53dC5v/m6mbXhi4fH1tB8Hrxb71c+ORncm96fPJDdQ3fBu3UPdNzsod29PdjDytyWk6F7+y1Dd8G53dC5v/m6mbXhi4fH1tB8Hrxb71c+ORncm96fPJDdQ3fBu3UPdNzsod29PdjDytyWk6F7+y1Dd8G53dC5v/m6mbXhi4fH1tB8Hrxb71c+ORncm96fPJDdQ3fBu3UPdNzsod29PdjDytyWk6F7+y1Dd8G53dC5v/m6mbXhi4fH1tB8Hrxb71c+ORncm96fPJDdQ3fBu3UPdNzsod29PdjDytyWk6F7+y1Dd8G53dC5v/m6mbXhi4fH1tB8Hrxb71c+ORncm96fPJDdQ3fBu3UPdNzsod29PdjDytyWk6F7+y1Dd8G53dC5v/m6mbXhi4fH1tB8Hrxb71c+ORncm96fPJDdQ3fBu3UPdNzsod29PdjDytyWk6F7+y1Dd8G53dC5v/m6mbXhi4fH1tB8Hrxb71c+ORncm96fPJDdQ3fBu3UPdNzsod29PdjDytyWk6F7+y1Dd8G53dC5v/m6mbXhi4fH1tB8Hrxb71c+ORncm96fPJDdQ3fBu3UPdNzsod29PdjDytyWk6F7+y1Dd8G53dC5v/m6mbXhi4fH1tB8Hrxb71c+ORncm96fPJDdQ3fBu3UPdNzsod29PdjDytyWk6F7+y1Dd8G53dC5v/m6mbXhi4fH1tB8Hrxb71c+ORncm96fPJDdQ3fBu3UPdNzsod29PdjDytyWk6F7+y1Dd8G53dC5v/m6mbXhi4fH1tB8Hrxb71c+ORncm96fPJDdQ3fBu3UPdNzsod29PdjDytyWk6F7+y1Dd8G53dC5v/m6mbXhi4fH1tB8Hrxb71c+ORncm96fPJDdQ3fBu3UPdNzsod29PdjDytyWk6F7+y1Dd8G53dC5v/m6mbXhi4fH1tB8Hrxb71c+ORncm96fPJDdQ3fBu3UPdNzsod29PdjDytyWk6F7+y1Dd8G53dC5v/m6mbXhi4fH1tB8Hrxb71c+ORncm96fPJDdQ3fBu3UPdNzsod29PdjDytyWk6F7+y1Dd8G53dC5v/m6mbXhi4fH1tB8Hrxb71c+ORncm96fPJDdQ3fBu3UPdNzsod29PdjDytyWk6F7+y1Dd8G53dC5v/m6mbXhi4fvqz/++Cf5/f0PvHPDCro6gWcAAAAASUVORK5CYII=",
  "allowCreditCard": true,
  "orderId": 351134
}