Split sales invoice payment

PUT /api-v1/sales-invoice/{invoiceId}/payment/{paymentId}/split

Headers

TARGET-ORGANIZATION-ID integer(int32)

ID of organization, for which the operation must be performed
WEAL-TOKEN string Required

API token (can be retrieved from account settings)

Path parameters

invoiceId integer Required

invoiceId
paymentId integer Required

paymentId

Body Required

payment

bankCharges string
lossOnDebtors string
paidAmount string
receivableByAccountId integer
requestedAmount string
valueDate string

Responses

200

OK
Hide response attributes Show response attributes object
- data object
  
  Additional properties are allowed.
- error object
  
  Additional properties are allowed.
  
  Hide error attributes Show error attributes object
  
  errorCode string
  
  Values are NO_ERROR, NOT_IMPLEMENTED_YET, CONTACT_NOT_FOUND, FIELD_REQUIRED, VALIDATION_ERROR, DUPLICATION_ERROR, UNIQUE_CONSTRAINT_VIOLATION, WRONG_PASSWORD_FORMAT, WRONG_PASSWORD, ACTION_DENIED, NOT_FOUND, EXPECTED_ONE_FILE, UNIQUE_VIOLATION, CONTENT_EMPTY, INVALID_TYPE, CONVERSION_ERROR, FILE_PARSE_EXCEPTION, or IN_USE.
  
  errorDetailValues array[object]
  
  Hide errorDetailValues attributes Show errorDetailValues attributes object
  
  data string
  
  errorCode string
  
  fieldName string
  
  isSevere boolean
- valid boolean
400

400 Bad Request
401

401 Unauthorized
403

403 Access Denied
404

404 Not Found
500

500 Internal Server Error

PUT /api-v1/sales-invoice/{invoiceId}/payment/{paymentId}/split

curl \
 -X PUT http://10.10.10.132/api-v1/sales-invoice/{invoiceId}/payment/{paymentId}/split \
 -H "TARGET-ORGANIZATION-ID: 42" \
 -H "WEAL-TOKEN: string" \
 -d '{"bankCharges":"string","lossOnDebtors":"string","paidAmount":"string","receivableByAccountId":42,"requestedAmount":"string","valueDate":"string"}'

Request examples

# Headers
TARGET-ORGANIZATION-ID: 42
WEAL-TOKEN: string

# Payload
{
  "bankCharges": "string",
  "lossOnDebtors": "string",
  "paidAmount": "string",
  "receivableByAccountId": 42,
  "requestedAmount": "string",
  "valueDate": "string"
}

Response examples (200)

{
  "data": {},
  "error": {
    "errorCode": "NO_ERROR",
    "errorDetailValues": [
      {
        "data": "string",
        "errorCode": "string",
        "fieldName": "string",
        "isSevere": true
      }
    ]
  },
  "valid": true
}