POST v1/company/{companyId}/payments

Post new payment for an expense

Request Information

URI Parameters

NameDescriptionTypeAdditional information
companyId

Company id

decimal number

Required

Body Parameters

Payment detail object

AppPaymentMasterRequest
NameDescriptionTypeAdditional information
Id

Payment id

decimal number

None.

AccountId

Account id (Cash/Bank Account)

decimal number

Required

ExpenseId

Payment id

decimal number

Required

VDate

Payment date

date

Required

Matching regular expression pattern: (19|20)[0-9]{2}[-](0[1-9]|1[012])[-](0[1-9]|[12][0-9]|3[01])

Description

Payment description/referance

string

Required

Amount

Payment amount

decimal number

Required

CurrencyId

Currency id

integer

Required

CurrencyRate

Currency conversion rate

decimal number

Required

IsFullyPaid

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "Id": 1.0,
  "AccountId": 2.0,
  "ExpenseId": 3.0,
  "VDate": "2025-04-22T15:37:56.3779992+01:00",
  "Description": "sample string 5",
  "Amount": 6.0,
  "CurrencyId": 7,
  "CurrencyRate": 8.0,
  "IsFullyPaid": true
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'AppPaymentMasterRequest'.

Response Information

Resource Description

ApiResponseOfAppPaymentMasterModel
NameDescriptionTypeAdditional information
Result

AppPaymentMasterModel

None.

Status

boolean

None.

Message

string

None.

Errors

Errors occures while processing request

Collection of ApiError

None.

Response Formats

application/json, text/json

Sample:
{
  "Result": {
    "Id": 1.0,
    "AccountId": 2.0,
    "ContactId": 3.0,
    "ContactName": "sample string 5",
    "VNo": "sample string 6",
    "VDate": "2025-04-22",
    "Description": "sample string 8",
    "Amount": 9.0,
    "Items": [
      {
        "Id": 1.0,
        "ExpenseId": 3.0,
        "VNo": "sample string 4",
        "Amount": 5.0
      },
      {
        "Id": 1.0,
        "ExpenseId": 3.0,
        "VNo": "sample string 4",
        "Amount": 5.0
      }
    ]
  },
  "Status": true,
  "Message": "sample string 2",
  "Errors": [
    {
      "Number": 1,
      "Message": "sample string 2",
      "Exception": {
        "ClassName": "System.Exception",
        "Message": null,
        "Data": null,
        "InnerException": null,
        "HelpURL": "sample string 1",
        "StackTraceString": null,
        "RemoteStackTraceString": null,
        "RemoteStackIndex": 0,
        "ExceptionMethod": null,
        "HResult": 3,
        "Source": "sample string 2",
        "WatsonBuckets": null
      }
    },
    {
      "Number": 1,
      "Message": "sample string 2",
      "Exception": {
        "ClassName": "System.Exception",
        "Message": null,
        "Data": null,
        "InnerException": null,
        "HelpURL": "sample string 1",
        "StackTraceString": null,
        "RemoteStackTraceString": null,
        "RemoteStackIndex": 0,
        "ExceptionMethod": null,
        "HResult": 3,
        "Source": "sample string 2",
        "WatsonBuckets": null
      }
    }
  ]
}