Sign in
latestOpenAPI 3.0.02026-08-10233809957.8 KB

5cdfae3fa1fa

Invoice Payments

Creates an individual invoice payment for a business.

post/invoices/payments

Request body

Example request

{
  "connection": {
    "businessName": "Railz",
    "serviceName": "quickbooks"
  },
  "data": {
    "accountRef": "132",
    "customerRef": "250",
    "invoiceRef": "250",
    "totalAmount": 200.5,
    "currency": "CAD",
    "currencyRate": 1.13,
    "lines": [
      {
        "invoiceRef": "3n2",
        "memo": "Sample memo for transaction"
      }
    ],
    "date": "2021-03-29",
    "memo": "Invoice payment memo."
  }
}

Response

pushCommunicationIdstring required
requestedOnstring date-time required
status'success' | 'failed' | 'pending' required
businessNamestring required
serviceName'freshbooks' | 'quickbooks' | 'quickbooksDesktop' | 'xero' | 'oracleNetsuite' | 'sageBusinessCloud' | 'sageIntacct' | 'dynamicsBusinessCentral' | 'dynamics365Finance' | 'wave' | 'myob' | 'zohoBooks' | 'byod' required

Example response

{
  "pushCommunicationId": "60473b57f0cdd1683ca71f60",
  "requestedOn": "2021-03-09T08:15:22.035Z",
  "status": "pending",
  "businessName": "Railz",
  "serviceName": "quickbooks",
  "data": {
    "accountRef": "132",
    "customerRef": "250",
    "invoiceRef": "250",
    "totalAmount": 200.5,
    "currency": "CAD",
    "currencyRate": 1.13,
    "lines": [
      {
        "invoiceRef": "3n2",
        "memo": "Sample memo for transaction"
      }
    ],
    "date": "2021-03-29",
    "memo": "Invoice payment memo."
  }
}