RArailz
Invoice
Invoice Payments

POST /invoices/payments

Changed on

Creates an individual invoice payment for a business.

Request

  • Base URL
    https://api.railz.ai
  • Auth
    HTTP bearer

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."
  }
}

Changes

  • 1383b9a47ac9Revision changes
    • info

      api tag Invoice added

  • 5cdfae3fa1faRevision changes
    • breaking

      the / request property format changed from date-time to date

    • breaking

      the response property ///// became optional for the status

    • breaking

      the response property ///// became optional for the status

    • breaking

      the response property /////// became optional for the status

    • breaking

      the response's property format changed from uuid to no format for status

    • warning

      added the new byod enum value to the response property for the response status

    • warning

      added the new dynamics365Finance enum value to the response property for the response status

    • warning

      added the new dynamicsBusinessCentral enum value to the response property for the response status

    • warning

      added the new freshbooks enum value to the response property for the response status

    • warning

      added the new myob enum value to the response property for the response status

    • warning

      added the new oracleNetsuite enum value to the response property for the response status

    • warning

      added the new quickbooks enum value to the response property for the response status

    • warning

      added the new quickbooksDesktop enum value to the response property for the response status

    • warning

      added the new sageBusinessCloud enum value to the response property for the response status

    • warning

      added the new sageIntacct enum value to the response property for the response status

    • warning

      added the new wave enum value to the response property for the response status

    • warning

      added the new xero enum value to the response property for the response status

    • warning

      added the new zohoBooks enum value to the response property for the response status

    • info

      the request property / became optional

    • info

      the request property / became optional

    • info

      the request property /// became optional

    • info

      request property /// deprecated

    • info

      added the new byod enum value to the request property /

    • info

      added the new dynamics365Finance enum value to the request property /

    • info

      added the new zohoBooks enum value to the request property /

    • info

      the / request property format was generalized from uuid to no format

    • info

      response property data/allOf[PushInvoicePayment]/lines/items/invoiceRef deprecated