TOtogaihq
Payments

create payments

Changed on

create payments

post/payments

Request

Request body

descriptionstring

A brief description of the payment

notesstring

A detailed note about the payment

accountIdstring required
currencystring required
totalAmountnumber required

Example request

{
  "description": "Payment for Invoice inv.234.23afv",
  "notes": "Payment for purchase of credits",
  "accountId": "ACC001",
  "lineItemRecords": [
    {
      "togaiId": "inv.234.12efwe"
    }
  ],
  "currency": "USD"
}

Response

Response for POST payments requests

idstring required
descriptionstring
notesstring
accountIdstring required
totalAmountnumber required
currencystring required
versionnumber required
createdBystring required
createdAtstring date-time required

Example response

{
  "id": "pay.w123rwe.1231",
  "accountId": "ACC001",
  "lineItemRecords": [
    {
      "togaiId": "inv.234.12efwe"
    }
  ]
}

Changes

  • f22fc08442b7Revision changes
    • info

      the response property became required for the status

  • ea9c4628bfdbRevision changes
    • breaking

      removed the enum value CHECK of the request property /

    • warning

      added the new CHEQUE enum value to the / response property for the response status

    • info

      added the new CHEQUE enum value to the request property /

    • info

      removed the CHECK enum value from the / response property for the response status