Create Receive Payment

Creates a new ReceivePayment in QuickBooks.

Loading API schema for ReceivePayment…

POST/api/v1/receive-payment

curl -X POST "https://api.nx-us.net/api/v1/receive-payment" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-Connection-Id: YOUR_CONNECTION_ID" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "customerId": "<string>"
}'

Response201

{
  "id": "<string>",
  "objectType": "<string>",
  "createdAt": "<date-time>",
  "updatedAt": "<date-time>",
  "revisionNumber": "<string>",
  "transactionDate": "<date>",
  "currency": {
    "id": "<string>",
    "fullname": "<string>"
  },
  "exchangeRate": "<number>",
  "refNumber": "<string>",
  "memo": "<string>",
  "transactionNumber": "<integer>",
  "customer": {
    "id": "<string>",
    "fullname": "<string>"
  },
  "receivablesAccount": {
    "id": "<string>",
    "fullname": "<string>"
  },
  "paymentMethod": {
    "id": "<string>",
    "fullname": "<string>"
  },
  "depositToAccount": {
    "id": "<string>",
    "fullname": "<string>"
  },
  "creditCardTransaction": {
    "request": {
      "number": "<string>",
      "expirationMonth": "123",
      "expirationYear": "123",
      "name": "<string>",
      "sddress": "<string>",
      "postalCode": "<string>",
      "commercialCardCode": "\"Sample text value\"",
      "transactionMode": null,
      "transactionType": null
    },
    "response": {
      "resultCode": "123",
      "resultMessage": "<string>",
      "creditCardTransID": "<string>",
      "merchantAccountNumber": "<string>",
      "authorizationCode": "\"Sample text value\"",
      "avsStreet": null,
      "avsZip": null,
      "cardSecurityCodeMatch": null,
      "reconBatchID": "\"Sample text value\"",
      "paymentGroupingCode": "123",
      "paymentStatus": null,
      "transactionAuthorizationTime": "<date-time>",
      "transactionAuthorizationStamp": "<integer>",
      "clientTransactionId": "<string>"
    }
  },
  "unusedPayment": "<number>",
  "unusedCredits": "<number>",
  "appliedToTransactions": [
    {
      "id": "<string>",
      "objectType": "<string>",
      "type": "<string>",
      "transactionDate": "<date>",
      "refNumber": "<string>",
      "balanceRemaining": "<number>",
      "paymentAmount": "<number>",
      "discountAmount": "<number>",
      "discountAccount": {
        "id": null,
        "fullname": null
      },
      "discountClass": {
        "id": null,
        "fullname": null
      },
      "linkedTransactions": [],
      "appliedCredits": []
    }
  ],
  "amount": "<number>",
  "entity": {
    "id": "<string>",
    "fullname": "<string>"
  },
  "account": {
    "id": "<string>",
    "fullname": "<string>"
  },
  "amountInHomeCurrency": "<string>",
  "hasValidLineItems": "<boolean>",
  "externalId": "<string>",
  "linkedTransactions": [
    {
      "objectType": "<string>",
      "transactionId": "<string>",
      "transactionType": "<string>",
      "transactionDate": "<date>",
      "refNumber": "<string>",
      "linkType": "<string>",
      "amount": "<number>"
    }
  ],
  "expenseLines": [
    {
      "id": "<string>",
      "objectType": "<string>",
      "account": {
        "id": "<string>",
        "fullname": "<string>"
      },
      "amount": "<number>",
      "memo": "<string>",
      "class": {
        "id": "<string>",
        "fullname": "<string>"
      },
      "customer": {
        "id": "<string>",
        "fullname": "<string>"
      },
      "salesRepresentative": {
        "id": "<string>",
        "fullname": "<string>"
      },
      "salesTaxCode": {
        "id": "<string>",
        "fullname": "<string>"
      },
      "taxAmount": "<number>",
      "vendor": {
        "id": "<string>",
        "fullname": "<string>"
      },
      "billableStatus": "NotBillable",
      "customFields": [
        {
          "ownerId": null,
          "name": null,
          "type": null,
          "value": null
        }
      ]
    }
  ],
  "itemLines": [
    {
      "id": "<string>",
      "objectType": "<string>",
      "otherCustomField1": "<string>",
      "otherCustomField2": "<string>",
      "item": {
        "id": "<string>",
        "fullname": "<string>"
      },
      "description": "<string>",
      "quantity": "<number>",
      "cost": "<number>",
      "amount": "<number>",
      "customer": {
        "id": "<string>",
        "fullname": "<string>"
      },
      "class": {
        "id": "<string>",
        "fullname": "<string>"
      },
      "overrideItemAccount": {
        "id": "<string>",
        "fullname": "<string>"
      },
      "billableStatus": "NotBillable",
      "itemGroup": {
        "id": "<string>",
        "fullname": "<string>"
      },
      "unitOfMeasure": "<string>",
      "rate": "<number>",
      "salesTaxCode": {
        "id": "<string>",
        "fullname": "<string>"
      },
      "inventorySite": {
        "id": "<string>",
        "fullname": "<string>"
      },
      "inventorySiteLocation": {
        "id": "<string>",
        "fullname": "<string>"
      },
      "serialNumber": "<string>",
      "lotNumber": "<string>",
      "serviceDate": "<date>",
      "customFields": [
        {
          "ownerId": null,
          "name": null,
          "type": null,
          "value": null
        }
      ]
    }
  ],
  "itemGroupLines": [
    {
      "id": "<string>",
      "objectType": "<string>",
      "itemGroup": {
        "id": "<string>",
        "fullname": "<string>"
      },
      "description": "<string>",
      "quantity": "<number>",
      "totalAmount": "<number>",
      "unitOfMeasure": "<string>",
      "isPrintItemsInGroup": "<boolean>",
      "lines": [
        {
          "id": null,
          "objectType": null,
          "otherCustomField1": null,
          "otherCustomField2": null,
          "item": null,
          "description": null,
          "quantity": null,
          "cost": null,
          "amount": null,
          "customer": null,
          "class": null,
          "overrideItemAccount": null,
          "billableStatus": null,
          "itemGroup": null,
          "unitOfMeasure": null,
          "rate": null,
          "salesTaxCode": null,
          "inventorySite": null,
          "inventorySiteLocation": null,
          "serialNumber": null,
          "lotNumber": null,
          "serviceDate": null,
          "customFields": null
        }
      ],
      "customFields": [
        {
          "ownerId": null,
          "name": null,
          "type": null,
          "value": null
        }
      ]
    }
  ],
  "customFields": [
    {
      "ownerId": "<string>",
      "name": "<string>",
      "type": "<string>",
      "value": "<string>"
    }
  ]
}