v1

latestOpenAPI 3.0.3Apache 2.02026-07-13121230447.8 KB

Payments

create payments

post/payments

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