Supported Methods

Supported Parameters

GET, POST, PATCH

Id, number, page, pageSize, modTimeStart, modTimeEnd, isDeleted

{
    "ID": "",
    "Customer": {
        "ID": "",
        "FullName": ""
    },
    "CreatedDate": "2021-05-12T20:03:20Z",
    "LastModifiedDate": "2021-05-12T20:03:20Z",
    "Number": "",
    "PaymentMethod": {
        "ID": "",
        "FullName": ""
    },
    "Memo": "",
    "Amount": 0.0,
    "UnappliedAmount": 0.0,
    "Date": "2021-05-12T20:03:20Z",
    "Account": {
        "ID": "",
        "FullName": ""
    },
    "DepositToAccount": {
        "ID": "",
        "FullName": ""
    },
    "LinkedTransactions": [{
        "Number": "",
        "ID": "",
        "Amount": 0.0,
        "Type": "",
        "Credits": [{
            "ID": "",
            "Amount": 0.0
        }],
        "Date": "2021-05-12T20:03:20Z",
        "Discount": {
            "Amount": 0.0,
            "Account": {
                "ID": "",
                "FullName": ""
            },
            "Class": {
                "ID": "",
                "FullName": ""
            }
        }
    }],
    "ExchangeRate": 0.0,
    "AutoApplyPayment": true,
    "CreditCardTransactionInfo": {
        "TransactionType": ""
    },
    "TransactionNumber": 0,
    "DeletedDate": "2021-05-12T20:03:20Z",
    "Currency": {
        "ID": "",
        "FullName": ""
    },
    "TotalAmountInHomeCurrency": 0.0
}

Important Notes

Applying credits to Invoices during Payment Process:

  • Credits are nested within the transaction object inside LinkedTransactions. This is following QBDs format so that you can apply payments across multiple invoices using many credit memos for a many to many relationship.
  • Example: To apply the same credit memo to multiple invoices, you would then supply two invoices in the LinkedTransacations and use the same credit memo for each of the invoice's Credits. If you wanted to use many credit memos for one invoice you would put multiple credit memo ids and amounts in the Credits list.
  • The only limitation is that you need to be aware of the amount open on an invoice (must not exceed in credits) and the amount of credits available on a credit memo.
  • Once a credit amount is applied it can only be removed by deleting a payment, credit memo, or invoice in the QBD UI by a user.
  • If running a process call a subsequent time, the amount applied will increase, not update. So if your payment was including an amount of $10 of credit to apply to an invoice and then you ran another process changing the JSON to be $15 the total amount of that credit would be $25, not $15. You can only add once a credit amount is applied to an invoice.

AutoApplyPayment

  • If a linked transaction is provided in the list, then AutoApplyPayment is set to false, and we attempt to apply it to that linked transaction. Note: If the linked transaction can't be found by the provided ID then the insert fails.
  • If no linked transactions are provided, then AutoApplyPayment is set to true, and they payment is applied to the first open invoice in QuickBooks Desktop.

Did this page help you?