Skip to main content

Receive Payment APIs

Receive Payment will be under the sell module. You will be able to generate receipt for the payment made by the customer. The record would be saved and can be viewed from Payments Received in Transaction Records.

If you receive a payment (either full or partial payment) from a customer or make a payment to a vendor without making reference to a specific invoice this can be treated as a payment on account.

PaymentDto helps you to receive new payment, retrieve a particular payment, update payment, or retrieve a list of payments.

More about Receive Payment API documentation

API


Search Payment

Get receive payments by filter criteria. More about search payment

Description:
  • Allows you to retrieve a list of all receive payments.
  • Allows you to retrieve specific receive payments based on it's filter criteria.

GET

/v1/payments/receive

Request URL

More about update payment

Parameters
NameLocated inDescriptionRequiredSchema
customfieldquerycustomfieldNostring
limitquerylimitNointeger
pagequerypageNointeger
queryqueryqueryNostring
searchquerysearchNostring
sortquerysortNostring
sortDirquerysortDirNostring
Responses
CodeDescriptionSchema
200Receive Payment's have been fetched successfully.ReceivePaymentDto
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Receive Payment

Receive a new payment. More about receive payment

Description:
  • Allows you to receive a new payment.

POST

/v1/payments/receive

Request URL

More about update payment

Parameters
NameLocated inDescriptionRequiredSchema
receivePaymentDtobodyreceivePaymentDtoYesReceivePaymentDto
Responses
CodeDescriptionSchema
200OKReceivePaymentDto
201Payment has been done successfully.ReceivePaymentDto
400Payment failed because of insufficient data.
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

Update Payment

Update recieve payment information. More about update payment

Description:
  • Allows you to update a specific recieve payment information.

PUT

/v1/payments/receive/{id}

Request URL

More about update payment

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
receivePaymentDtobodyreceivePaymentDtoYesReceivePaymentDto
Responses
CodeDescriptionSchema
200Payment has been updated successfully.ReceivePaymentDto
201Created
401Unauthorized
403Forbidden
404Payment with id not found.
Security
Security SchemaScopes
Authorizationglobal

receive-payment-controller

Receive Payment APIs.

/v1/payments/receive

DELETE

Summary

Delete payment.

Description

API to delete payment.

Parameters
NameLocated inDescriptionRequiredSchema
codesbodycodesYes[ string ]
Responses
CodeDescriptionSchema
200OKResponseEntity
204Payment has been deleted successfully.ResponseEntity
401Unauthorized
403Forbidden
404Payment with id not found.
Security
Security SchemaScopes
Authorizationglobal

/v1/payments/receive/bulk

POST

Summary

Receive payment.

Description

API to receive a new payment.

Parameters
NameLocated inDescriptionRequiredSchema
receivePaymentDtosbodyreceivePaymentDtosYes[ ReceivePaymentDto ]
Responses
CodeDescription
200OK
201Payment has been done successfully.
400Payment failed because of insufficient data.
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/payments/receive/bulk-pay

POST

Summary

Receive bulk payment.

Description

API to receive a new bulk payment.

Parameters
NameLocated inDescriptionRequiredSchema
receiveBulkPaymentDtobodyreceiveBulkPaymentDtoYesReceiveBulkPaymentDto«ReceivePaymentResponseDto,ReceivePaymentItemResponseDto»
Responses
CodeDescriptionSchema
200OKReceiveBulkPaymentDto
201Payment has been done successfully.ReceiveBulkPaymentDto
400Payment failed because of insufficient data.
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/payments/receive/bulk-pay/{code}

DELETE

Summary

Delete bulk payment.

Description

API to delete bulk payment.

Parameters
NameLocated inDescriptionRequiredSchema
codepathcodeYesstring
Responses
CodeDescriptionSchema
200OKResponseEntity
204Bulk payment has been deleted successfully.ResponseEntity
401Unauthorized
403Forbidden
404Payment with id not found.
Security
Security SchemaScopes
Authorizationglobal

/v1/payments/receive/contact-due-amount

POST

Summary

Fetch Due amounts by contact codes

Description

API to fetch due amounts of contacts.

Parameters
NameLocated inDescriptionRequiredSchema
contactCodesbodycontactCodesYes[ string ]
Responses
CodeDescriptionSchema
200Due amounts fetched successfully[ DueAmountResponse ]
201Created
401Unauthorized
403Forbidden
404Due amounts fetched failed
Security
Security SchemaScopes
Authorizationglobal

/v1/payments/receive/deposit/advance-payments-by-contact

GET

Summary

Get Advance Payment amounts by code.

Description

API to get Advance Payment amount by contact.

Parameters
NameLocated inDescriptionRequiredSchema
contactCodequerycontactCodeNostring
Responses
CodeDescriptionSchema
200Deposit details fetched successfully.DepositInformation
401Unauthorized
403Forbidden
404Deposit not found.
Security
Security SchemaScopes
Authorizationglobal

/v1/payments/receive/deposit/code/{code}/details

GET

Summary

Get Deposit details by code.

Description

API to get Deposit details by code.

Parameters
NameLocated inDescriptionRequiredSchema
codepathcodeYesstring
Responses
CodeDescriptionSchema
200Deposit details fetched successfully.DepositInformation
401Unauthorized
403Forbidden
404Deposit not found.
Security
Security SchemaScopes
Authorizationglobal

/v1/payments/receive/deposits/import

POST

Summary

Create multiple deposits via import

Description

API to create deposits via import.

Parameters
NameLocated inDescriptionRequiredSchema
receivePaymentDtosbodyreceivePaymentDtosYes[ ReceivePaymentDto ]
Responses
CodeDescription
200OK
201Payment has been done successfully.
400Payment failed because of insufficient data.
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/payments/receive/import-adv-opening

POST

Summary

Create multiple opening advance payment via import

Description

API to create opening advance payment via import.

Parameters
NameLocated inDescriptionRequiredSchema
openingAdvpaymentRequestsbodyopeningAdvpaymentRequestsYes[ ReceivePaymentDto ]
Responses
CodeDescriptionSchema
200OKBulkApiResponse
201Opening advance payment imported successfully.BulkApiResponse
400Failed to import opening advance payment.
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/payments/receive/import-get-paid

POST

Summary

Import Get Paid.

Description

API to import get paid.

Parameters
NameLocated inDescriptionRequiredSchema
receivePaymentDtosbodyreceivePaymentDtosYes[ ReceivePaymentDto ]
Responses
CodeDescriptionSchema
200OKBulkApiResponse
201Payment has been done successfully.BulkApiResponse
400Payment failed because of insufficient data.
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/payments/receive/knock-off

PUT

Summary

Deposit-AdvancePayment knock-off and update its due amount

Description

API to update due amount for Deposit-AdvancePayment while knocking off with other documents

Parameters
NameLocated inDescriptionRequiredSchema
knockOffRequestsbodyknockOffRequestsYes[ KnockOffRequest ]
Responses
CodeDescription
200Due amounts updated successfully.
201Created
401Unauthorized
403Forbidden
404Deposit-AdvancePayment entry not found.
Security
Security SchemaScopes
Authorizationglobal

/v1/payments/receive/reconcile

POST

Summary

Reconcile transactions

Description

API to reconcile transactions

Parameters
NameLocated inDescriptionRequiredSchema
receiptCodesbodyreceiptCodesYes[ string ]
Responses
CodeDescriptionSchema
200Transactions reconciled successfully.ResponseEntity
201Created
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/payments/receive/tax/count

POST

Summary

Get Receive Payment count for tax

Description

API to fetch Receive Payment count for tax

Parameters
NameLocated inDescriptionRequiredSchema
taxCodesbodytaxCodesYes[ string ]
Responses
CodeDescriptionSchema
200Tax Receive Payment count has been fetched.object
201Created
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/payments/receive/taxmapping

POST

Summary

API to map taxlist to item entity for old transactions

Description

API to map taxlist to item entity for old transactions

Responses
CodeDescription
200Tax mapping for existing records done successfully.
201Created
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/payments/receive/undeposits

GET

Summary

Fetch Un-Deposited Receive Payments

Description

API to fetch Un-Deposited Receive payments.

Parameters
NameLocated inDescriptionRequiredSchema
customfieldquerycustomfieldNostring
limitquerylimitNointeger
pagequerypageNointeger
queryqueryqueryNostring
searchquerysearchNostring
sortquerysortNostring
sortDirquerysortDirNostring
Responses
CodeDescriptionSchema
200Un-Deposited Payment's have been fetched successfully.ReceivePaymentDto
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/payments/receive/unreconcile

POST

Summary

Unreconcile transactions

Description

API to unreconcile transactions

Parameters
NameLocated inDescriptionRequiredSchema
receiptCodesbodyreceiptCodesYes[ string ]
Responses
CodeDescriptionSchema
200Transactions unreconciled successfully.ResponseEntity
201Created
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/payments/receive/unreconciled

GET

Summary

Get unreconciled receipts/deposits

Description

API to get unreconciled receipts/deposits.

Parameters
NameLocated inDescriptionRequiredSchema
accountCodequeryaccountCodeYesstring
amountqueryamountNonumber
documentDatequerydocumentDateNodateTime
statementDatequerystatementDateNodateTime
Responses
CodeDescriptionSchema
200Unreconciled receipts/deposits fetched successfully.ReconcileTransactionResponse
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/payments/receive/update-knock-off

POST

Summary

Update knock off information

Description

Api to update knock off information

Parameters
NameLocated inDescriptionRequiredSchema
knockOffInfosbodyknockOffInfosYesobject
Responses
CodeDescription
200Knock off information updated successfully.
201Created
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/payments/receive/{code}

DELETE

Summary

Delete payment.

Description

API to delete payment.

Parameters
NameLocated inDescriptionRequiredSchema
codepathcodeYesstring
Responses
CodeDescriptionSchema
200OKResponseEntity
204Payment has been deleted successfully.ResponseEntity
401Unauthorized
403Forbidden
404Payment with id not found.
Security
Security SchemaScopes
Authorizationglobal

receive-payment-controller-indonesia

Receive Payment Indonesia APIs.

/v1/payments/receive/id

GET

Summary

Fetch Receive Payments

Description

API to fetch existing make payments.

Parameters
NameLocated inDescriptionRequiredSchema
customfieldquerycustomfieldNostring
limitquerylimitNointeger
pagequerypageNointeger
queryqueryqueryNostring
searchquerysearchNostring
sortquerysortNostring
sortDirquerysortDirNostring
Responses
CodeDescriptionSchema
200Receive Payment's have been fetched successfully.ReceivePaymentDtoIndonesia
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

POST

Summary

Receive payment.

Description

API to receive a new payment.

Parameters
NameLocated inDescriptionRequiredSchema
receivePaymentDtobodyreceivePaymentDtoYesReceivePaymentDtoIndonesia
Responses
CodeDescriptionSchema
200OKReceivePaymentDtoIndonesia
201Payment has been done successfully.ReceivePaymentDtoIndonesia
400Payment failed because of insufficient data.
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

DELETE

Summary

Delete payment.

Description

API to delete payment.

Parameters
NameLocated inDescriptionRequiredSchema
codesbodycodesYes[ string ]
Responses
CodeDescriptionSchema
200OKResponseEntity
204Payment has been deleted successfully.ResponseEntity
401Unauthorized
403Forbidden
404Payment with id not found.
Security
Security SchemaScopes
Authorizationglobal

/v1/payments/receive/id/bank-deposit

DELETE

Summary

Delete Bank Deposit

Description

API to Delete Bank Deposit

Parameters
NameLocated inDescriptionRequiredSchema
receivePaymentCodequeryreceivePaymentCodeYesstring
Responses
CodeDescription
200OK
204Bank Deposit have been deleted successfully
401Unauthorized
403Forbidden
Security
Security SchemaScopes
Authorizationglobal

/v1/payments/receive/id/bulk-pay

POST

Summary

Receive bulk payment.

Description

API to receive a new bulk payment.

Parameters
NameLocated inDescriptionRequiredSchema
receiveBulkPaymentDtobodyreceiveBulkPaymentDtoYesReceiveBulkPaymentDto«ReceivePaymentResponseDtoIndonesia,ReceivePaymentItemResponseDtoIndonesia»
Responses
CodeDescriptionSchema
200OKReceiveBulkPaymentDto
201Payment has been done successfully.ReceiveBulkPaymentDto
400Payment failed because of insufficient data.
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/payments/receive/id/deposits

GET

Summary

Fetch Deposits

Description

API to fetch existing deposits.

Parameters
NameLocated inDescriptionRequiredSchema
contactNamequerycontactNameNostring
customfieldquerycustomfieldNostring
docTypequerydocTypeNostring
includeUndepositedFundsqueryincludeUndepositedFundsNoboolean
limitquerylimitNointeger
pagequerypageNointeger
paymentDatequerypaymentDateNodateTime
queryqueryqueryNostring
searchquerysearchNostring
sortquerysortNostring
sortDirquerysortDirNostring
Responses
CodeDescriptionSchema
200Deposits have been fetched successfully.ReceivePaymentDto
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/payments/receive/id/knock-off

PUT

Summary

Deposit-AdvancePayment knock-off and update its due amount

Description

API to update due amount for Deposit-AdvancePayment while knocking off with other documents

Parameters
NameLocated inDescriptionRequiredSchema
knockOffRequestsbodyknockOffRequestsYes[ KnockOffRequest ]
Responses
CodeDescription
200Due amounts updated successfully.
201Created
401Unauthorized
403Forbidden
404Deposit-AdvancePayment entry not found.
Security
Security SchemaScopes
Authorizationglobal

/v1/payments/receive/id/reconcile

POST

Summary

Reconcile transactions

Description

API to reconcile transactions

Parameters
NameLocated inDescriptionRequiredSchema
receiptCodesbodyreceiptCodesYes[ string ]
Responses
CodeDescriptionSchema
200Transactions reconciled successfully.ResponseEntity
201Created
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/payments/receive/id/unreconciled

GET

Summary

Get unreconciled receipts/deposits

Description

API to get unreconciled receipts/deposits.

Parameters
NameLocated inDescriptionRequiredSchema
accountCodequeryaccountCodeYesstring
amountqueryamountNonumber
documentDatequerydocumentDateNodateTime
statementDatequerystatementDateNodateTime
Responses
CodeDescriptionSchema
200Unreconciled receipts/deposits fetched successfully.ReconcileTransactionResponse
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/payments/receive/id/{code}

DELETE

Summary

Delete payment.

Description

API to delete payment.

Parameters
NameLocated inDescriptionRequiredSchema
codepathcodeYesstring
Responses
CodeDescriptionSchema
200OKResponseEntity
204Payment has been deleted successfully.ResponseEntity
401Unauthorized
403Forbidden
404Payment with id not found.
Security
Security SchemaScopes
Authorizationglobal

/v1/payments/receive/id/{id}

PUT

Summary

Update payment.

Description

API to update existing payment.

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
receivePaymentDtobodyreceivePaymentDtoYesReceivePaymentDtoIndonesia
Responses
CodeDescriptionSchema
200Payment has been updated successfully.ReceivePaymentDtoIndonesia
201Created
401Unauthorized
403Forbidden
404Payment with id not found.
Security
Security SchemaScopes
Authorizationglobal

receive-payment-controller-israel

Receive Payment Israel APIs.

/v1/payments/receive/il

GET

Summary

Fetch Receive Payments

Description

API to fetch existing make payments.

Parameters
NameLocated inDescriptionRequiredSchema
customfieldquerycustomfieldNostring
limitquerylimitNointeger
pagequerypageNointeger
queryqueryqueryNostring
searchquerysearchNostring
sortquerysortNostring
sortDirquerysortDirNostring
Responses
CodeDescriptionSchema
200Receive Payment's have been fetched successfully.ReceivePaymentDtoIsrael
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

POST

Summary

Receive payment.

Description

API to receive a new payment.

Parameters
NameLocated inDescriptionRequiredSchema
receivePaymentDtobodyreceivePaymentDtoYesReceivePaymentDtoIsrael
Responses
CodeDescriptionSchema
200OKReceivePaymentDtoIsrael
201Payment has been done successfully.ReceivePaymentDtoIsrael
400Payment failed because of insufficient data.
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

DELETE

Summary

Delete payment.

Description

API to delete payment.

Parameters
NameLocated inDescriptionRequiredSchema
codesbodycodesYes[ string ]
Responses
CodeDescriptionSchema
200OKResponseEntity
204Payment has been deleted successfully.ResponseEntity
401Unauthorized
403Forbidden
404Payment with id not found.
Security
Security SchemaScopes
Authorizationglobal

/v1/payments/receive/il/bank-deposit

DELETE

Summary

Delete Bank Deposit

Description

API to Delete Bank Deposit

Parameters
NameLocated inDescriptionRequiredSchema
receivePaymentCodequeryreceivePaymentCodeYesstring
Responses
CodeDescription
200OK
204Bank Deposit have been deleted successfully
401Unauthorized
403Forbidden
Security
Security SchemaScopes
Authorizationglobal

/v1/payments/receive/il/bulk-pay

POST

Summary

Receive bulk payment.

Description

API to receive a new bulk payment.

Parameters
NameLocated inDescriptionRequiredSchema
receiveBulkPaymentDtobodyreceiveBulkPaymentDtoYesReceiveBulkPaymentDto«ReceivePaymentResponseDtoIsrael,ReceivePaymentItemResponseDtoIsrael»
Responses
CodeDescriptionSchema
200OKReceiveBulkPaymentDto
201Payment has been done successfully.ReceiveBulkPaymentDto
400Payment failed because of insufficient data.
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/payments/receive/il/deposits

GET

Summary

Fetch Deposits

Description

API to fetch existing deposits.

Parameters
NameLocated inDescriptionRequiredSchema
contactNamequerycontactNameNostring
customfieldquerycustomfieldNostring
docTypequerydocTypeNostring
includeUndepositedFundsqueryincludeUndepositedFundsNoboolean
limitquerylimitNointeger
pagequerypageNointeger
paymentDatequerypaymentDateNodateTime
queryqueryqueryNostring
searchquerysearchNostring
sortquerysortNostring
sortDirquerysortDirNostring
Responses
CodeDescriptionSchema
200Deposits have been fetched successfully.ReceivePaymentDto
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/payments/receive/il/knock-off

PUT

Summary

Deposit-AdvancePayment knock-off and update its due amount

Description

API to update due amount for Deposit-AdvancePayment while knocking off with other documents

Parameters
NameLocated inDescriptionRequiredSchema
knockOffRequestsbodyknockOffRequestsYes[ KnockOffRequest ]
Responses
CodeDescription
200Due amounts updated successfully.
201Created
401Unauthorized
403Forbidden
404Deposit-AdvancePayment entry not found.
Security
Security SchemaScopes
Authorizationglobal

/v1/payments/receive/il/reconcile

POST

Summary

Reconcile transactions

Description

API to reconcile transactions

Parameters
NameLocated inDescriptionRequiredSchema
receiptCodesbodyreceiptCodesYes[ string ]
Responses
CodeDescriptionSchema
200Transactions reconciled successfully.ResponseEntity
201Created
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/payments/receive/il/unreconciled

GET

Summary

Get unreconciled receipts/deposits

Description

API to get unreconciled receipts/deposits.

Parameters
NameLocated inDescriptionRequiredSchema
accountCodequeryaccountCodeYesstring
amountqueryamountNonumber
documentDatequerydocumentDateNodateTime
statementDatequerystatementDateNodateTime
Responses
CodeDescriptionSchema
200Unreconciled receipts/deposits fetched successfully.ReconcileTransactionResponse
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/payments/receive/il/{code}

DELETE

Summary

Delete payment.

Description

API to delete payment.

Parameters
NameLocated inDescriptionRequiredSchema
codepathcodeYesstring
Responses
CodeDescriptionSchema
200OKResponseEntity
204Payment has been deleted successfully.ResponseEntity
401Unauthorized
403Forbidden
404Payment with id not found.
Security
Security SchemaScopes
Authorizationglobal

/v1/payments/receive/il/{id}

PUT

Summary

Update payment.

Description

API to update existing payment.

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
receivePaymentDtobodyreceivePaymentDtoYesReceivePaymentDtoIsrael
Responses
CodeDescriptionSchema
200Payment has been updated successfully.ReceivePaymentDtoIsrael
201Created
401Unauthorized
403Forbidden
404Payment with id not found.
Security
Security SchemaScopes
Authorizationglobal

receive-payment-controller-india

Receive Payment India APIs.

/v1/payments/receive/in

GET

Summary

Fetch Receive Payments

Description

API to fetch existing make payments.

Parameters
NameLocated inDescriptionRequiredSchema
customfieldquerycustomfieldNostring
limitquerylimitNointeger
pagequerypageNointeger
queryqueryqueryNostring
searchquerysearchNostring
sortquerysortNostring
sortDirquerysortDirNostring
Responses
CodeDescriptionSchema
200Receive Payment's have been fetched successfully.ReceivePaymentDtoIndia
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

POST

Summary

Receive payment.

Description

API to receive a new payment.

Parameters
NameLocated inDescriptionRequiredSchema
receivePaymentDtobodyreceivePaymentDtoYesReceivePaymentDtoIndia
Responses
CodeDescriptionSchema
200OKReceivePaymentDtoIndia
201Payment has been done successfully.ReceivePaymentDtoIndia
400Payment failed because of insufficient data.
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

DELETE

Summary

Delete payment.

Description

API to delete payment.

Parameters
NameLocated inDescriptionRequiredSchema
codesbodycodesYes[ string ]
Responses
CodeDescriptionSchema
200OKResponseEntity
204Payment has been deleted successfully.ResponseEntity
401Unauthorized
403Forbidden
404Payment with id not found.
Security
Security SchemaScopes
Authorizationglobal

/v1/payments/receive/in/bank-deposit

DELETE

Summary

Delete Bank Deposit

Description

API to Delete Bank Deposit

Parameters
NameLocated inDescriptionRequiredSchema
receivePaymentCodequeryreceivePaymentCodeYesstring
Responses
CodeDescription
200OK
204Bank Deposit have been deleted successfully
401Unauthorized
403Forbidden
Security
Security SchemaScopes
Authorizationglobal

/v1/payments/receive/in/bulk-pay

POST

Summary

Receive bulk payment.

Description

API to receive a new bulk payment.

Parameters
NameLocated inDescriptionRequiredSchema
receiveBulkPaymentDtobodyreceiveBulkPaymentDtoYesReceiveBulkPaymentDto«ReceivePaymentResponseDtoIndia,ReceivePaymentItemResponseDtoIndia»
Responses
CodeDescriptionSchema
200OKReceiveBulkPaymentDto
201Payment has been done successfully.ReceiveBulkPaymentDto
400Payment failed because of insufficient data.
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/payments/receive/in/deposit

POST

Summary

Make deposit entry

Description

API to make deposit entry.

Parameters
NameLocated inDescriptionRequiredSchema
receivePaymentDtobodyreceivePaymentDtoYesReceivePaymentDtoIndia
Responses
CodeDescriptionSchema
200OKReceivePaymentDto
201Deposit has been done successfully.ReceivePaymentDto
400Deposit failed because of insufficient data.
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/payments/receive/in/deposits

GET

Summary

Fetch Deposits

Description

API to fetch existing deposits.

Parameters
NameLocated inDescriptionRequiredSchema
contactNamequerycontactNameNostring
customfieldquerycustomfieldNostring
docTypequerydocTypeNostring
includeUndepositedFundsqueryincludeUndepositedFundsNoboolean
limitquerylimitNointeger
pagequerypageNointeger
paymentDatequerypaymentDateNodateTime
queryqueryqueryNostring
searchquerysearchNostring
sortquerysortNostring
sortDirquerysortDirNostring
Responses
CodeDescriptionSchema
200Deposits have been fetched successfully.ReceivePaymentDto
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/payments/receive/in/import-get-paid

POST

Summary

Import Get Paid.

Description

API to import get paid.

Parameters
NameLocated inDescriptionRequiredSchema
receivePaymentDtosbodyreceivePaymentDtosYes[ ReceivePaymentDtoIndia ]
Responses
CodeDescriptionSchema
200OKBulkApiResponse
201Payment has been done successfully.BulkApiResponse
400Payment failed because of insufficient data.
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/payments/receive/in/reconcile

POST

Summary

Reconcile transactions

Description

API to reconcile transactions

Parameters
NameLocated inDescriptionRequiredSchema
receiptCodesbodyreceiptCodesYes[ string ]
Responses
CodeDescriptionSchema
200Transactions reconciled successfully.ResponseEntity
201Created
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/payments/receive/in/unreconciled

GET

Summary

Get unreconciled receipts/deposits

Description

API to get unreconciled receipts/deposits.

Parameters
NameLocated inDescriptionRequiredSchema
accountCodequeryaccountCodeYesstring
amountqueryamountNonumber
documentDatequerydocumentDateNodateTime
statementDatequerystatementDateNodateTime
Responses
CodeDescriptionSchema
200Unreconciled receipts/deposits fetched successfully.ReconcileTransactionResponse
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/payments/receive/in/{code}

DELETE

Summary

Delete payment.

Description

API to delete payment.

Parameters
NameLocated inDescriptionRequiredSchema
codepathcodeYesstring
Responses
CodeDescriptionSchema
200OKResponseEntity
204Payment has been deleted successfully.ResponseEntity
401Unauthorized
403Forbidden
404Payment with id not found.
Security
Security SchemaScopes
Authorizationglobal

/v1/payments/receive/in/{id}

PUT

Summary

Update payment.

Description

API to update existing payment.

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
receivePaymentDtobodyreceivePaymentDtoYesReceivePaymentDtoIndia
Responses
CodeDescriptionSchema
200Payment has been updated successfully.ReceivePaymentDtoIndia
201Created
401Unauthorized
403Forbidden
404Payment with id not found.
Security
Security SchemaScopes
Authorizationglobal

receive-payment-controller-philippines

Receive Payment Philippines APIs.

/v1/payments/receive/ph

GET

Summary

Fetch Receive Payments

Description

API to fetch existing make payments.

Parameters
NameLocated inDescriptionRequiredSchema
customfieldquerycustomfieldNostring
limitquerylimitNointeger
pagequerypageNointeger
queryqueryqueryNostring
searchquerysearchNostring
sortquerysortNostring
sortDirquerysortDirNostring
Responses
CodeDescriptionSchema
200Receive Payment's have been fetched successfully.ReceivePaymentDtoPhilippines
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

POST

Summary

Receive payment.

Description

API to receive a new payment.

Parameters
NameLocated inDescriptionRequiredSchema
receivePaymentDtobodyreceivePaymentDtoYesReceivePaymentDtoPhilippines
Responses
CodeDescriptionSchema
200OKReceivePaymentDtoPhilippines
201Payment has been done successfully.ReceivePaymentDtoPhilippines
400Payment failed because of insufficient data.
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

DELETE

Summary

Delete payment.

Description

API to delete payment.

Parameters
NameLocated inDescriptionRequiredSchema
codesbodycodesYes[ string ]
Responses
CodeDescriptionSchema
200OKResponseEntity
204Payment has been deleted successfully.ResponseEntity
401Unauthorized
403Forbidden
404Payment with id not found.
Security
Security SchemaScopes
Authorizationglobal

/v1/payments/receive/ph/bank-deposit

DELETE

Summary

Delete Bank Deposit

Description

API to Delete Bank Deposit

Parameters
NameLocated inDescriptionRequiredSchema
receivePaymentCodequeryreceivePaymentCodeYesstring
Responses
CodeDescription
200OK
204Bank Deposit have been deleted successfully
401Unauthorized
403Forbidden
Security
Security SchemaScopes
Authorizationglobal

/v1/payments/receive/ph/bulk-pay

POST

Summary

Receive bulk payment.

Description

API to receive a new bulk payment.

Parameters
NameLocated inDescriptionRequiredSchema
receiveBulkPaymentDtobodyreceiveBulkPaymentDtoYesReceiveBulkPaymentDto«ReceivePaymentResponseDtoPhilippines,ReceivePaymentItemResponseDtoPhilippines»
Responses
CodeDescriptionSchema
200OKReceiveBulkPaymentDto
201Payment has been done successfully.ReceiveBulkPaymentDto
400Payment failed because of insufficient data.
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/payments/receive/ph/deposits

GET

Summary

Fetch Deposits

Description

API to fetch existing deposits.

Parameters
NameLocated inDescriptionRequiredSchema
contactNamequerycontactNameNostring
customfieldquerycustomfieldNostring
docTypequerydocTypeNostring
includeUndepositedFundsqueryincludeUndepositedFundsNoboolean
limitquerylimitNointeger
pagequerypageNointeger
paymentDatequerypaymentDateNodateTime
queryqueryqueryNostring
searchquerysearchNostring
sortquerysortNostring
sortDirquerysortDirNostring
Responses
CodeDescriptionSchema
200Deposits have been fetched successfully.ReceivePaymentDto
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/payments/receive/ph/knock-off

PUT

Summary

Deposit-AdvancePayment knock-off and update its due amount

Description

API to update due amount for Deposit-AdvancePayment while knocking off with other documents

Parameters
NameLocated inDescriptionRequiredSchema
knockOffRequestsbodyknockOffRequestsYes[ KnockOffRequest ]
Responses
CodeDescription
200Due amounts updated successfully.
201Created
401Unauthorized
403Forbidden
404Deposit-AdvancePayment entry not found.
Security
Security SchemaScopes
Authorizationglobal

/v1/payments/receive/ph/reconcile

POST

Summary

Reconcile transactions

Description

API to reconcile transactions

Parameters
NameLocated inDescriptionRequiredSchema
receiptCodesbodyreceiptCodesYes[ string ]
Responses
CodeDescriptionSchema
200Transactions reconciled successfully.ResponseEntity
201Created
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/payments/receive/ph/unreconciled

GET

Summary

Get unreconciled receipts/deposits

Description

API to get unreconciled receipts/deposits.

Parameters
NameLocated inDescriptionRequiredSchema
accountCodequeryaccountCodeYesstring
amountqueryamountNonumber
documentDatequerydocumentDateNodateTime
statementDatequerystatementDateNodateTime
Responses
CodeDescriptionSchema
200Unreconciled receipts/deposits fetched successfully.ReconcileTransactionResponse
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

/v1/payments/receive/ph/{code}

DELETE

Summary

Delete payment.

Description

API to delete payment.

Parameters
NameLocated inDescriptionRequiredSchema
codepathcodeYesstring
Responses
CodeDescriptionSchema
200OKResponseEntity
204Payment has been deleted successfully.ResponseEntity
401Unauthorized
403Forbidden
404Payment with id not found.
Security
Security SchemaScopes
Authorizationglobal

/v1/payments/receive/ph/{id}

PUT

Summary

Update payment.

Description

API to update existing payment.

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
receivePaymentDtobodyreceivePaymentDtoYesReceivePaymentDtoPhilippines
Responses
CodeDescriptionSchema
200Payment has been updated successfully.ReceivePaymentDtoPhilippines
201Created
401Unauthorized
403Forbidden
404Payment with id not found.
Security
Security SchemaScopes
Authorizationglobal

data-correction-controller

Data Correction Controller

/v1/payments/datacorrect/mappedinvoices

GET

Summary

getPaymentForInvoices

Parameters
NameLocated inDescriptionRequiredSchema
invoicequeryinvoiceNostring
Responses
CodeDescriptionSchema
200OK[ MakePaymentDto ]
401Unauthorized
403Forbidden
404Not Found
Security
Security SchemaScopes
Authorizationglobal

payment-integration-controller

Payment Integration APIs.

/v1/payments/integrations/configured-payment-accounts

GET

Summary

Get connected payment accounts.

Description

API to get connected payment accounts.

Parameters
NameLocated inDescriptionRequiredSchema
documentCurrencyquerydocumentCurrencyYesstring
Responses
CodeDescriptionSchema
200Connected payment accounts fetched successfully.object
401Unauthorized
403Forbidden
404Connected payment accounts not found.
Security
Security SchemaScopes
Authorizationglobal

POST

Summary

Get payment link for document

Description

API to get payment link for document.

Parameters
NameLocated inDescriptionRequiredSchema
paymentLinkRequestDtobodypaymentLinkRequestDtoYesPaymentLinkRequestDto
Responses
CodeDescriptionSchema
200Getting payment link successfully.object
201Created
401Unauthorized
403Forbidden
404Getting payment link failed.
Security
Security SchemaScopes
Authorizationglobal

Models

AbstractMakePaymentItemDto

NameTypeDescriptionRequired
accountNamestringAccount name.
Example: "Bank"
No
customField[ CustomFieldItem ]List of custom fieldsNo
descriptionstringDescription of document.
Example: "General ledger for account."
No
documentCodestringDocument code.
Example: "AC-001"
No
documentSequenceCodestringDocument Sequence code.
Example: "AC-001"
No
documentTypestringDocument type.
Example: "General Ledger"
No
exchangeRatenumberExchange rate.
Example: 0.01891562
No
isTdsApplicableAccountbooleanNo
isTdsApplicableContactbooleanNo
paymentAmountnumberPayment amount.
Example: 10.5
No
taxAmountnumberTax amount.
Example: 0.7
No
taxCodestringTax code.
Example: "GST@7"
No
taxList[ TaxMappingDto ]No
tdsAccountstringTds Account Code
Example: "AC-0000011"
No
tdsAmountnumberTDS Amount
Example: 100
No
tdsInfoIndiaTdsInfoIndiaPre-Payment TDS detailsNo
tdsRatenumberTDS Rate
Example: 10.1
No

AbstractMakePaymentResponseDto«AbstractMakePaymentItemDto»

NameTypeDescriptionRequired
accountCodePayFromstringAccount code.
Example: "AC-001"
No
accountNamestringAccount name.
Example: "Bank"
No
amountnumberPayment amount.
Example: 10
No
amountDuenumberPayment amount Due.
Example: 10
No
attachmentIds[ integer ]list of attachment id's for this orderNo
bankRuleIdlongRule id if the document has been created by a Bank RuleNo
contactCodestringContact code.
Example: 19425
No
contactNamestringContact name.
Example: "ABC PTE LTD"
No
currencystringCurrency code.
Enum: "AFN", "ALL", "DZD", "AOA", "ARS", "AMD", "AWG", "AZN", "BSD", "BHD", "BDT", "BBD", "BYN", "BZD", "BMD", "BTN", "BOB", "BAM", "BRL", "BND", "BGN", "BIF", "KHR", "CAD", "CVE", "KYD", "CLP", "CNY", "COP", "KMF", "CDF", "CRC", "CZK", "HRK", "CUC", "DJF", "DOP", "EGP", "ERN", "ETB", "FKP", "FJD", "XAF", "GMD", "GEL", "GHS", "GIP", "DKK", "GTQ", "GNF", "GYD", "HTG", "HNL", "HKD", "HUF", "ISK", "INR", "IDR", "IRR", "IQD", "JMD", "JPY", "JOD", "KZT", "KES", "KWD", "KGS", "LAK", "LBP", "LSL", "LRD", "LYD", "MOP", "MKD", "MGA", "MWK", "MYR", "MVR", "MRO", "MUR", "MXN", "MDL", "MNT", "MZN", "MMK", "NAD", "NPR", "NIO", "NGN", "KPW", "OMR", "PKR", "ILS", "PAB", "PGK", "PYG", "PEN", "PHP", "PLN", "QAR", "RON", "RUB", "RWF", "SHP", "XCD", "WST", "STD", "SAR", "RSD", "SCR", "SLL", "SGD", "ANG", "SBD", "SOS", "ZAR", "KRW", "SSP", "EUR", "LKR", "SDG", "SRD", "NOK", "SZL", "SEK", "CHF", "SYP", "TWD", "TJS", "TZS", "THB", "XOF", "NZD", "TOP", "TTD", "TND", "TRY", "TMT", "AUD", "UGX", "UAH", "AED", "GBP", "USD", "UYU", "UZS", "VUV", "VEF", "VND", "XPF", "MAD", "YER", "ZMW", "BWP", "CNH"
Example: "SGD"
No
customField[ CustomFieldItem ]List of custom fieldsNo
customerTypeIndiastringIndia Compliance filed
Enum: "EXPORT_WO_PAY", "EXPORT_W_PAY", "NA", "SEZ_WO_PAY", "SEZ_W_PAY"
Example: "SEZ (WPAY)"
No
documentDatedateTimeDocument date.
Example: "2019-09-27"
No
errors[ string ]List of validation error messagesNo
exchangeRatenumberExchange rate.
Example: 0.01891562
No
gstExchangeRatenumberGST Exchange rate if tax residency currency is different than base currency
Example: 1
No
gstInstringNo
gstTreatmentIndiastringIndia Compliance filed
Enum: "REGISTERED_BUSINESS_REGULAR=Registered Business - Regular", "REGISTERED_BUSINESS_COMPOSITION=Registered Business - Composition", "UNREGISTERED_BUSINESS=Unregistered Business", "CUSTOMER=Consumer", "OVERSEAS=Overseas", "SPECIAL_ECONOMIC_ZONE=Special Economic Zone", "DEEMED_EXPORT=Deemed Export"
Example: "REGISTERED_BUSINESS_REGULAR"
No
interCompanybooleanTrue if it is between inter companies
Example: true
No
isTdsPaymentIndiabooleanNo
knockoffInfo[ KnockOffInfo ]No
makePaymentFeeDtoList[ MakePaymentFeeDto ]Transaction fee pertaining to the made paymentNo
makePaymentItemDtoList[ AbstractMakePaymentItemDto ]Make payment items information.No
makePaymentRecurringDtoMakePaymentRecurringDtoRecurring payment details.No
memostringMemo text.
Example: "Sales quotation"
No
nextPaymentDatedateTimeNext payment date.
Example: "2019-09-27"
No
openingbooleanOpening Document
Example: false
No
paymentTypestringType of payment.
Enum: "CHEQUE", "CASH", "BANK_TRANSFER", "CARD", "OTHERS"
Example: "BANK_TRANSFER"
No
reconciledbooleanWhether the current payment is reconciled or not.No
recurringActivatedbooleanRecurring payment activated for payment.
Example: false
No
recurringPaymentbooleanRecurring payment enable/disable for payment.
Example: false
No
referenceDatedateTimeDate of Bank Transfer/cheque.
Example: "2019-09-27"
No
referenceNumberstringReference number of Bank Transfer/cheque.
Example: "CH001"
No
statusstringPrint Status
Enum: "PRINT_SUCCESS", "PRINT_FAILURE", "NOT_PRINTED"
Example: "NOT_PRINTED"
No
tdsPaymentInfoIndiaTDSPaymentInfoIndiaTDS Payment detailsNo
tdsProcessedFlagbooleanTDS Processed Flag
Example: false
No
unitPriceGstInclusivebooleanPrice is GST inclusive
Example: false
No
vendorTypeIndiastringIndia Compliance filed
Enum: "IMPORT", "NA", "SEZ_W_PAY", "SEZ_WO_PAY"
Example: "EXPORT (WOPAY)"
No

AbstractReceivePaymentItemDto

NameTypeDescriptionRequired
accountNamestringAccount name.
Example: "Bank"
No
customField[ CustomFieldItem ]List of custom fieldsNo
descriptionstringDescription of document.
Example: "General ledger for account."
No
documentCodestringDocument code.
Example: "AC-001"
No
documentSequenceCodestringDocument Sequence code.
Example: "AC-001"
No
documentTypestringDocument type.
Example: "General Ledger"
No
exchangeRatenumberExchange rate.
Example: 0.01891562
No
isTdsApplicableAccountbooleanNo
isTdsApplicableContactbooleanNo
paymentAmountnumberPayment amount.
Example: 10.5
No
taxAmountnumberTax amount.
Example: 0.7
No
taxCodestringTax code.
Example: "GST@7"
No
taxList[ TaxMappingDto ]No
tdsInfoIndiaTdsInfoIndiaPre-Payment TDS detailsNo

AbstractReceivePaymentResponseDto«AbstractReceivePaymentItemDto»

NameTypeDescriptionRequired
accountCodePayTostringAccount code.
Example: "AC-001"
No
accountNamestringAccount name.
Example: "Bank"
No
amountnumberPayment amount.
Example: 10
No
amountDuenumberPayment amount Due.
Example: 10
No
attachmentIds[ integer ]list of attachment id's for this orderNo
bankRuleIdlongRule id if the document has been created by a Bank RuleNo
billToAddressBill to addressNo
contactCodestringContact code.
Example: 19425
No
contactNamestringContact name.
Example: "ABC PTE LTD"
No
currencystringCurrency code.
Enum: "AFN", "ALL", "DZD", "AOA", "ARS", "AMD", "AWG", "AZN", "BSD", "BHD", "BDT", "BBD", "BYN", "BZD", "BMD", "BTN", "BOB", "BAM", "BRL", "BND", "BGN", "BIF", "KHR", "CAD", "CVE", "KYD", "CLP", "CNY", "COP", "KMF", "CDF", "CRC", "CZK", "HRK", "CUC", "DJF", "DOP", "EGP", "ERN", "ETB", "FKP", "FJD", "XAF", "GMD", "GEL", "GHS", "GIP", "DKK", "GTQ", "GNF", "GYD", "HTG", "HNL", "HKD", "HUF", "ISK", "INR", "IDR", "IRR", "IQD", "JMD", "JPY", "JOD", "KZT", "KES", "KWD", "KGS", "LAK", "LBP", "LSL", "LRD", "LYD", "MOP", "MKD", "MGA", "MWK", "MYR", "MVR", "MRO", "MUR", "MXN", "MDL", "MNT", "MZN", "MMK", "NAD", "NPR", "NIO", "NGN", "KPW", "OMR", "PKR", "ILS", "PAB", "PGK", "PYG", "PEN", "PHP", "PLN", "QAR", "RON", "RUB", "RWF", "SHP", "XCD", "WST", "STD", "SAR", "RSD", "SCR", "SLL", "SGD", "ANG", "SBD", "SOS", "ZAR", "KRW", "SSP", "EUR", "LKR", "SDG", "SRD", "NOK", "SZL", "SEK", "CHF", "SYP", "TWD", "TJS", "TZS", "THB", "XOF", "NZD", "TOP", "TTD", "TND", "TRY", "TMT", "AUD", "UGX", "UAH", "AED", "GBP", "USD", "UYU", "UZS", "VUV", "VEF", "VND", "XPF", "MAD", "YER", "ZMW", "BWP", "CNH"
Example: "SGD"
No
customField[ CustomFieldItem ]List of custom fieldsNo
customerTypeIndiastringIndia Compliance filed
Enum: "EXPORT_WO_PAY", "EXPORT_W_PAY", "NA", "SEZ_WO_PAY", "SEZ_W_PAY"
Example: "SEZ (WPAY)"
No
documentDatedateTimeDocument date.
Example: "2019-09-27"
No
errors[ string ]List of validation error messagesNo
exchangeRatenumberExchange rate.
Example: 0.01891562
No
gstExchangeRatenumberGST Exchange rate if tax residency currency is different than base currency
Example: 1
No
gstInstringNo
gstTreatmentIndiastringIndia Compliance filed
Enum: "REGISTERED_BUSINESS_REGULAR=Registered Business - Regular", "REGISTERED_BUSINESS_COMPOSITION=Registered Business - Composition", "UNREGISTERED_BUSINESS=Unregistered Business", "CUSTOMER=Consumer", "OVERSEAS=Overseas", "SPECIAL_ECONOMIC_ZONE=Special Economic Zone", "DEEMED_EXPORT=Deemed Export"
Example: "REGISTERED_BUSINESS_REGULAR"
No
interCompanybooleanTrue if it is between inter companies
Example: true
No
isUnDepositedPaymentbooleanWhether the current payment is un-deposited or not.No
journalEntryBankTransferRequestDtoJournalEntryBankTransferRequestDtoBank Transfer Request DTO for Journal EntryNo
knockoffInfo[ KnockOffInfo ]No
memostringMemo text.
Example: "Sales quotation"
No
openingbooleanOpening Document
Example: false
No
paymentTypestringType of payment.
Enum: "CHEQUE", "CASH", "BANK_TRANSFER", "CARD", "OTHERS"
Example: "BANK_TRANSFER"
No
receivePaymentFeeDtoList[ ReceivePaymentFeeDto ]Transaction fee pertaining to the received paymentNo
receivePaymentItemDtoList[ AbstractReceivePaymentItemDto ]Receive payment items information.No
reconciledbooleanWhether the current payment is reconciled or not.No
referenceDatedateTimeDate of Bank Transfer/cheque.
Example: "2019-09-27"
No
referenceNumberstringReference number of Bank Transfer/cheque.
Example: "CH001"
No
sentEmailbooleanSend Customer Email
Example: false
No
shipFromAddressShip from addressNo
shipToAddressShip to addressNo
unDepositedEntriesReconciled[ UnDepositedEntriesReconciled ]Reconciled un-deposited entriesNo
unitPriceGstInclusivebooleanPrice is GST inclusive
Example: false
No
vendorTypeIndiastringIndia Compliance filed
Enum: "IMPORT", "NA", "SEZ_W_PAY", "SEZ_WO_PAY"
Example: "EXPORT (WOPAY)"
No

AccountDto

NameTypeDescriptionRequired
accountCodestringAccount code
Example: "SA"
No
accountGroupstringAccount groupNo
accountGroupIdstringAccount groupNo
accountNaturestringAccount Nature
Example: "ASSET"
No
accountSubGroupstringAccount groupNo
accountSubGroupNamestringAccount groupNo
balancenumberBalance Amount
Example: 999.99
No
balanceInAccountCurrencynumberBalance Amount in Account Currency
Example: 999.99
No
codestringAccount codeNo
currencystringAccount CurrencyNo
customField[ CustomFieldItem ]List of custom fieldsNo
descriptionstringAccount Description
Example: "Savings account"
No
exchangeRatenumberBase to Foreign Exchange Rate
Example: 1
No
idlongAccount ID.
Example: 1
No
isCreditCardbooleanIs account is credit card account or not
Example: false
No
isDefaultbooleanDefault Account Status
Example: true
No
isSubAccountbooleanFlag to confirm Subaccount
Example: false
No
isTdsApplicablebooleanIs TDS applicable or not
Example: false
No
isUndepositedFundAccountbooleanAccount is Undeposited fund account or not
Example: true
No
namestringAccount Name
Example: "Savings account"
No
natureOfIncomePaymentstringNature of income payment
Example: "Interest on Securities"
No
openingBalancenumberOpening Balance Amount in Base currency
Example: 999.99
No
openingBalanceCdTypestringOpening balance Credit/Debit Type
Example: "DEBIT"
No
openingBalanceEditablebooleanAccount Opening Balance editable or not
Example: true
No
openingBalanceInAccountCurrencynumberOpening Balance Amount in Account currency
Example: 999.99
No
parentlongParent AccountId
Example: 2431252
No
parentNamestringParent Name
Example: 2431252
No
statusstringAccount Status
Example: "ACTIVE"
No
taxCodestringAccount TaxNo
totalBalancenumberSummation of Opening Balance and Balance
Example: 999.99
No
totalBalanceInAccountCurrencynumberSummation of Opening Balance and Balance in Account Currency
Example: 999.99
No
totalCOABalancenumberSummation of Opening Balance and Balance with Nature
Example: 999.99
No
totalCOABalanceInAccountCurrencynumberSummation of Opening Balance and Balance with Nature in Account Currency
Example: 999.99
No
usedChequeNumbersstringUsed Cheque Series
Example: "301,302"
No

AdditionalCharges

NameTypeDescriptionRequired
additionalChargeAmountnumberNo
additionalChargeTaxAmountnumberNo
additionalChargesDetails[ AdditionalChargesDetails ]No
globalDiscountGlobalDiscountDetailsNo
globalDiscounts[ GlobalDiscountDetails ]No

AdditionalChargesDetails

NameTypeDescriptionRequired
additionalChargestringNo
additionalChargeAccountCodestringNo
addtionalChargeTaxstringNo
addtionalChargeTaxCodestringNo
apportionFlagbooleanNo
apportionValuestringEnum: "APPORTION_MANUAL", "APPORTION_ON_QTY", "APPORTION_ON_VALUE"No
cgstnumberNo
chargeAmountnumberNo
igstnumberNo
includeInReportbooleanNo
isPercentbooleanNo
isPreChargebooleanNo
percentnumberNo
sgstnumberNo
taxAmountnumberNo

Address

NameTypeDescriptionRequired
address1stringAddress line 1
Example: "218, Robinson Road"
No
address2stringAddress line 2
Example: "Downtown"
No
citystringCity
Example: "C001"
No
contactNamestringcontact name for address
Example: "John Smith"
No
countrystringCountry
Example: "C001"
No
destinationOfSupplystringstate in India
Example: "Maharashtra"
No
placeOfSupplystringstate in India
Example: "Punjab"
No
postalCodestringPostal Code
Example: 123456
No
preferredbooleanIs this a default address?
Example: true
No
statestringState
Example: "CS001"
No

AdvancePaymentContactResponseDto

NameTypeDescriptionRequired
contactCodestringNo
contactNamestringNo
dueAmountnumberNo
totalAmountnumberNo
usedAmountnumberNo

AdvancedTrackingMetaDto

NameTypeDescriptionRequired
acquiredCostnumberAcquired cost of the entire serial or batch
Example: 1
No
advancedTrackingReturnedAdvancedTrackingReturnedNo
batchSizedoubleSerial Number or Batch size
Example: 1
Yes
batchSizeAvailableForReturndoubleHow much of the batch or serial is fulfilled
Example: 1
Yes
batchSizeFulfilleddoubleHow much of the batch or serial is fulfilled
Example: 1
Yes
batchSizeReturneddoubleHow much of the batch or serial is returned
Example: 1
Yes
batchSizeReturnedPurchasedoubleHow much of the batch or serial is returned
Example: 1
Yes
binCodestringbin code
Example: "BIN-00001"
Yes
binNamestringbin Name
Example: "Bin 1"
Yes
expiryDatedateTimeExpiry date. Date Format is dd-mm-yyyy. Applicable when AdvancedTrackingType is Batch
Example: "01-01-2020"
No
idlongNo
manufacturingDatedateTimeManufacturing date. Date Format is dd-mm-yyyy. Applicable when AdvancedTrackingType is Batch
Example: "01-01-2020"
No
productVariantCodestringProduct code
Example: "P-001"
Yes
rackCodestringRack code
Example: "RACK-00001"
Yes
rackNamestringRack Name
Example: "Rack 1"
Yes
reservedQuantitydoubleReserved Serial Number or Batch size
Example: 1
No
reservedQuantityFulfilleddoubleFulfilled reserved serial number or batch size
Example: 1
Yes
rowCodestringRow code
Example: "ROW-00001"
Yes
rowNamestringRow Name
Example: "Row 1"
Yes
sequencelongSequence number
Example: 1
No
serialBatchNumberstringSerial Number or Batch Number
Example: "BATCH-001"
Yes
subSequencelongSubsequence number
Example: 1
No
warehouseCodestringPrimary Warehouse
Example: "WH-0000001"
No
warehouseNamestringPrimary Warehouse
Example: "warehouse name"
No

AdvancedTrackingReturned

NameTypeDescriptionRequired
batchSizeReturneddoubleNo
batchSizeReturnedPurchasedoubleNo
returnsByDoc[ AdvancedTrackingReturnedByDoc ]No

AdvancedTrackingReturnedByDoc

NameTypeDescriptionRequired
documentCodestringNo
qtyReturneddoubleNo
returnTypestringEnum: "SALES_RETURN", "PURCHASE_RETURN"No
transactionRefCodestringNo

AmortizationDocumentItemDetails

NameTypeDescriptionRequired
deferralAccountCodestringNo
endDatedateTimeNo
startDatedateTimeNo
templateCodestringNo

AssetGroupResponse

NameTypeDescriptionRequired
activebooleanIs Asset Group active?
Example: true
No
assetAccountCodestringAsset Account Code
Example: "AC-0000001"
No
assetAccountDisplayCodestringAsset Account Display Code
Example: "Acc00001"
No
assetAccountNamestringAsset Account Name
Example: "Computer Equipment Asset Account"
No
assetAccumulatedAccountCodestringAsset Accumulated Account Code
Example: "AC-0000002"
No
assetAccumulatedAccountDisplayCodestringAsset Accumulated Account Display Code
Example: "Acc00002"
No
assetAccumulatedAccountNamestringAsset Accumulated Account Name
Example: "Computer Equipment Accumulated Account"
No
decliningFactornumberDeclining Factor
Example: 1
No
depreciationConventionstringDepreciation Convention
Enum: "FULL_MONTH", "ACTUAL_DATE"
Example: "FULL_MONTH"
No
depreciationExpenseAccountCodestringDepreciation Expense Account Code
Example: "AC-0000003"
No
depreciationExpenseAccountDisplayCodestringDepreciation Expense Account Display Code
Example: "Acc00003"
No
depreciationExpenseAccountNamestringDepreciation Expense Account Name
Example: "Computer Equipment Depreciation Account"
No
depreciationMethodstringDepreciation Method
Enum: "NO_DEPRECIATION", "STRAIGHT_LINE", "DECLINING_BALANCE", "INSTANT_ASSET_WRITE_OFF"
Example: "STRAIGHT_LINE"
No
depreciationRatenumberDepreciation Rate
Example: 1
No
effectiveLifenumberEffective Life
Example: 2
No
hsnOrSacCodestringHSN or SAC Code
Example: "011"
No
idlongId
Example: 1
No
namestringAsset Group Name
Example: "IT Hardware"
No
purchaseTaxCodestringGST Tax Code
Example: "TX-0000003"
No
uqcIndiastringUQC
Example: "BAGS"
No
viewOnlybooleanIs Asset Group view-only?
Example: true
No
writeOffAccountCodestringWrite off Account Code
Example: "AC-0000002"
No

AssetRequest

NameTypeDescriptionRequired
assetGroupIdlongAsset Group Id
Example: 1
No
currencystringCurrency
Example: "USD"
No
decliningFactornumberDeclining Factor
Example: 2.5
No
depreciationConventionstringDepreciation Convention
Enum: "FULL_MONTH", "ACTUAL_DATE"
Example: "FULL_MONTH"
No
depreciationMethodstringDepreciation Method
Enum: "NO_DEPRECIATION", "STRAIGHT_LINE", "DECLINING_BALANCE", "INSTANT_ASSET_WRITE_OFF"
Example: "STRAIGHT_LINE"
No
depreciationRatenumberDepreciation Rate
Example: 66.66
No
depreciationStartDatedateTimeDepreciation Start Date
Example: "20-06-2019"
No
depreciationThresholdnumberDepreciation Threshold
Example: 8765.43
No
descriptionstringAsset Description
Example: "Computer for developers"
No
discountnumberNo
discountInPercentbooleanNo
documentCodestringNo
documentItemCodestringNo
documentSequenceCodestringDocument Sequence Code
Example: "FA-0000001"
No
documentTypestringNo
effectiveLifenumberEffective Life
Example: 1.5
No
errors[ string ]No
expenseBillCodestringExpense Bill Code
Example: "BUY-0000001"
No
idlongId
Example: 1
No
installationDatedateTimeInstallation Date
Example: "20-06-2019"
No
namestringAsset Name
Example: "Computer"
No
openingAccumulatedDepreciationnumberOpening Accumulated Depreciation
Example: 1234.56
No
openingAssetbooleanIs this an Opening Asset
Example: false
No
profitLossAccountCodestringProfit/Loss Account Code
Example: "AC-0000001"
No
purchaseDatedateTimePurchase Date
Example: "20-06-2019"
No
purchaseInvoiceIdlongNo
purchaseInvoiceRequestPurchaseInvoiceRequestNo
purchasePricenumberPurchase Price
Example: 9999.99
No
residualValuenumberResidual Value
Example: 1234.56
No
salesIncomeAccountCodestringSales/Income Account Code
Example: "AC-0000001"
No
sequenceFormatstringDocument Sequence Format
Example: "FA-0000000"
No
serialNumberstringSerial Number
Example: "ABCD123456"
No
taxAmountnumberNo
taxCodestringNo
totalAmountnumberNo
warehousestringWarehouse Code
Example: "WH-0000001"
No
warrantyEndDatestringWarranty End Date
Example: "01-11-2024"
No
warrantyStartDatestringWarranty Start Date
Example: "01-11-2023"
No

AttachmentsResponse

NameTypeDescriptionRequired
attachmentDatedateTimeNo
attachmentFileNamestringNo
attachmentIdlongNo
attachmentSizestringNo

AttributeDetails

NameTypeDescriptionRequired
idlongAttribute ID
Example: "Id"
No
namestringAttribute Name
Example: "Colour"
No
values[ string ]Attribute valuesNo

BarcodeDetails

NameTypeDescriptionRequired
barcodeFieldstringNo
hideBarcodeLabelbooleanNo

BomAdditionalCostDto

NameTypeDescriptionRequired
bomMetaDetailsIdlongid of bomMetaDetailsId
Example: 1234
No
bomMetaNamestringBOM Meta Name
Example: "DEFAULT"
No
labelstringName of manufacturing service
Example: "Labour charges"
No
pricenumberQuantity of product in bom
Example: 10.5
No

BomMetaDetailsDto

NameTypeDescriptionRequired
activebooleanbom meta details status
Example: true
No
bomAddCostConfiguration[ BomAdditionalCostDto ]Bom additional cost informationNo
bomOperationsConfiguration[ BomOperationDto ]Bom Operations informationNo
bomProductCostDetails[ BomProductCostDetails ]JSON object for custom fields
Example: {"field1":"value1","field2":"value2"}
No
bomProductsConfiguration[ BomMetaDto ]Bom Products informationNo
codestringbom meta details code
Example: "code"
No
deletedbooleanbom meta details delete status
Example: true
No
idlongid of bom meta details
Example: 1234
No
isDefaultbooleanbom default
Example: true
No
namestringbom meta details name
Example: "bom meta name"
No
productIdstringid of bom product
Example: 1234
No

BomMetaDto

NameTypeDescriptionRequired
bomMetaDetailsIdlongid of bomMetaDetailsId
Example: 1234
No
bomMetaNamestringBOM Meta Name
Example: "DEFAULT"
No
bomProductSubstitutesDetails[ ProductSubstitutesDetails ]No
costnumberCost of product in bom
Example: 10.5
No
itemIdlongid of item in bom
Example: 1234
No
itemNamestringProduct Name
Example: "Apple"
Yes
produceProductTypestringProduce Product type
Enum: "NONE", "SCRAP", "COPRODUCT"
Example: "SCRAP"
Yes
productCodestringNo
quantitynumberQuantity of product in bom
Example: 10.5
No
stockUomlongNo

BomOperationDto

NameTypeDescriptionRequired
bomMetaDetailsIdlongid of bomMetaDetailsId
Example: 1234
No
bomMetaNamestringBOM Meta Name
Example: "DEFAULT"
No
costPerHournumberCost of operation in bom
Example: 10.5
No
fixedRatenumberCost of operation in bom
Example: 10.5
No
operationIdlongid of operation in bom
Example: 1234
No
operationNamestringOperation Name
Example: "Apple"
Yes
totalCostnumberCost of operation in bom
Example: 10.5
No

BomProductCostDetails

NameTypeDescriptionRequired
operationCostnumberOperation Cost
Example: 15
No
rawMaterialCostnumberRaw material cost
Example: 20
No
totalCostnumberTotal cost
Example: 35
No

BulkApiResponse

NameTypeDescriptionRequired
failure[ object ]No
statusCodeintegerNo
success[ object ]No

BulkApiResponse«MakePaymentResponseDto»

NameTypeDescriptionRequired
failure[ MakePaymentResponseDto ]No
statusCodeintegerNo
success[ MakePaymentResponseDto ]No

BulkApiResponse«ReceivePaymentResponseDtoIndia»

NameTypeDescriptionRequired
failure[ ReceivePaymentResponseDtoIndia ]No
statusCodeintegerNo
success[ ReceivePaymentResponseDtoIndia ]No

BulkApiResponse«ReceivePaymentResponseDto»

NameTypeDescriptionRequired
failure[ ReceivePaymentResponseDto ]No
statusCodeintegerNo
success[ ReceivePaymentResponseDto ]No

BulkPaymentItem

NameTypeDescriptionRequired
amountnumberNo
documentCodestringNo

ChequeNoGenerateDto

NameTypeDescriptionRequired
chequeNumberStartlongNo
documentCodesstringNo

ChequeStatusDto

NameTypeDescriptionRequired
documentCodestringNo
printStatusstringEnum: "PRINT_SUCCESS", "PRINT_FAILURE", "NOT_PRINTED"No

ContactDto

NameTypeDescriptionRequired
attentionTostringthe contact name in govt agency
Example: "Peter Parker"
No
autoChargebooleanAuto payment charge
Example: false
No
billingAddress[ Address ]List of Billing Address.No
businessUnitstringindicates the contact is govt agency
Example: "CAA01 - Cvl Avtn Authrty of Singapore"
No
contactMasterIdstring (uuid)contact master id
Example: "2df7a5c1-3305-498d-8d01-aa92c42d19d2"
No
contactNumberstringContact number
Example: "+65999999999"
No
creditLimitnumberCredit Limit
Example: 100
No
creditLimitInBaseCurrencynumberCredit Limit In Org Currency
Example: 100
No
currencyCodestringCurrency code
Enum: "AFN", "ALL", "DZD", "AOA", "ARS", "AMD", "AWG", "AZN", "BSD", "BHD", "BDT", "BBD", "BYN", "BZD", "BMD", "BTN", "BOB", "BAM", "BRL", "BND", "BGN", "BIF", "KHR", "CAD", "CVE", "KYD", "CLP", "CNY", "COP", "KMF", "CDF", "CRC", "CZK", "HRK", "CUC", "DJF", "DOP", "EGP", "ERN", "ETB", "FKP", "FJD", "XAF", "GMD", "GEL", "GHS", "GIP", "DKK", "GTQ", "GNF", "GYD", "HTG", "HNL", "HKD", "HUF", "ISK", "INR", "IDR", "IRR", "IQD", "JMD", "JPY", "JOD", "KZT", "KES", "KWD", "KGS", "LAK", "LBP", "LSL", "LRD", "LYD", "MOP", "MKD", "MGA", "MWK", "MYR", "MVR", "MRO", "MUR", "MXN", "MDL", "MNT", "MZN", "MMK", "NAD", "NPR", "NIO", "NGN", "KPW", "OMR", "PKR", "ILS", "PAB", "PGK", "PYG", "PEN", "PHP", "PLN", "QAR", "RON", "RUB", "RWF", "SHP", "XCD", "WST", "STD", "SAR", "RSD", "SCR", "SLL", "SGD", "ANG", "SBD", "SOS", "ZAR", "KRW", "SSP", "EUR", "LKR", "SDG", "SRD", "NOK", "SZL", "SEK", "CHF", "SYP", "TWD", "TJS", "TZS", "THB", "XOF", "NZD", "TOP", "TTD", "TND", "TRY", "TMT", "AUD", "UGX", "UAH", "AED", "GBP", "USD", "UYU", "UZS", "VUV", "VEF", "VND", "XPF", "MAD", "YER", "ZMW", "BWP", "CNH"
Example: "SGD"
No
customField[ CustomFieldItem ]JSON object for custom fields
Example: {"field1":"value1","field2":"value2"}
No
documentSequenceCodestringContact Sequence code
Example: "C-0000001"
No
emailIdstringcontact email address
Example: "myinfo@domain.com"
No
extCompanyNamestringthe company name from external app
Example: "QuickBook"
No
intercompanyTypestringContact Type either parent or subsidiary
Enum: "PARENT", "SUBSIDIARY"
Example: "PARENT/SUBSIDIARY"
No
invoiceCreditLimitTypestringInvoice Credit Limit Type
Enum: "IGNORE", "WARN", "BLOCK"
Example: "IGNORE"
No
invoicesobjectNo
isAccountNumberFlagbooleanindicates if user is sending account number or code
Example: true
No
isCreditLimitApplicablebooleanContact credit limit applicable
Example: true
No
isIncludeCurrentInvoicebooleanInclude Current Invoice
Example: true
No
isIncludeCurrentQuotationbooleanInclude Current Quotation
Example: true
No
isIncludeCurrentSalesOrderbooleanInclude Current Sales Order
Example: false
No
namestringContact name
Example: "Sam"
No
payableAccountCodestringPayable account code
Example: "AC002"
No
paymentTermCodestringPayment term code
Example: "Net 0"
No
peppolIdstringPeppol ID
Example: "u000:11::11293"
No
purchasePriceLists[ long ]Set of Purchase price lists
Example: [123,456]
No
quotationCreditLimitTypestringQuotation Credit Limit Type
Enum: "IGNORE", "WARN", "BLOCK"
Example: "IGNORE"
No
receivableAccountCodestringReceivable account code
Example: "AC001"
No
salesOrderCreditLimitTypestringSales Order Credit Limit Type
Enum: "IGNORE", "WARN", "BLOCK"
Example: "IGNORE"
No
salesPriceLists[ long ]Set of Sales price lists
Example: [123,456]
No
sequenceFormatstringSequence Format
Example: 1
No
shippingAddress[ Address ]List of Shipping Address.No
singaporeGovtbooleanindicates the contact is govt agency
Example: true
No
taxExemptedbooleanDenotes if customer is tax exempted
Example: true
No
taxExemptionNostringGenerated tax exemption number
Example: "234s-few3-2422"
No
taxExemptionReasonstringTax exemption reason
Example: "Resale, Federal Agency"
No
taxNumberstringTax number
Example: 123456
No
uenstringContact UEN
Example: "DHJEUK"
No

ContactInfo

NameTypeDescriptionRequired
addressstringAddress
Example: "Raffles Place 1"
No
namestringCustomer name
Example: "ABC Pte Ltd"
Yes
peppolIdstringPeppol ID
Example: "u000:1109:uen"
No

CustomFieldItem

NameTypeDescriptionRequired
idlongDimension Id
Example: 11567
No
labelstringCustom Field Name
Example: "Label"
Yes
modulestringSupported ModulesNo
valueobjectDimension Value
Example: "XYZ"
No

DepositDto

NameTypeDescriptionRequired
accountCodePayTostringNo
accountNamestringNo
amountnumberNo
amountDuenumberNo
attachmentIds[ integer ]No
codestringNo
contactCodestringNo
contactCustomField[ CustomFieldItem ]No
contactNamestringNo
currencystringEnum: "AFN", "ALL", "DZD", "AOA", "ARS", "AMD", "AWG", "AZN", "BSD", "BHD", "BDT", "BBD", "BYN", "BZD", "BMD", "BTN", "BOB", "BAM", "BRL", "BND", "BGN", "BIF", "KHR", "CAD", "CVE", "KYD", "CLP", "CNY", "COP", "KMF", "CDF", "CRC", "CZK", "HRK", "CUC", "DJF", "DOP", "EGP", "ERN", "ETB", "FKP", "FJD", "XAF", "GMD", "GEL", "GHS", "GIP", "DKK", "GTQ", "GNF", "GYD", "HTG", "HNL", "HKD", "HUF", "ISK", "INR", "IDR", "IRR", "IQD", "JMD", "JPY", "JOD", "KZT", "KES", "KWD", "KGS", "LAK", "LBP", "LSL", "LRD", "LYD", "MOP", "MKD", "MGA", "MWK", "MYR", "MVR", "MRO", "MUR", "MXN", "MDL", "MNT", "MZN", "MMK", "NAD", "NPR", "NIO", "NGN", "KPW", "OMR", "PKR", "ILS", "PAB", "PGK", "PYG", "PEN", "PHP", "PLN", "QAR", "RON", "RUB", "RWF", "SHP", "XCD", "WST", "STD", "SAR", "RSD", "SCR", "SLL", "SGD", "ANG", "SBD", "SOS", "ZAR", "KRW", "SSP", "EUR", "LKR", "SDG", "SRD", "NOK", "SZL", "SEK", "CHF", "SYP", "TWD", "TJS", "TZS", "THB", "XOF", "NZD", "TOP", "TTD", "TND", "TRY", "TMT", "AUD", "UGX", "UAH", "AED", "GBP", "USD", "UYU", "UZS", "VUV", "VEF", "VND", "XPF", "MAD", "YER", "ZMW", "BWP", "CNH"No
customField[ CustomFieldItem ]No
documentDatestringNo
exchangeRatenumberNo
gstExchangeRatenumberNo
idlongNo
interCompanybooleanNo
isUnDepositedPaymentbooleanNo
jeCodestringNo
memostringNo
openingbooleanNo
paymentTypestringEnum: "CHEQUE", "CASH", "BANK_TRANSFER", "CARD", "OTHERS"No
receivePaymentFeeDtoList[ ReceivePaymentFeeDto ]No
receivePaymentItemDtoList[ ReceivePaymentItemDto ]No
referenceDatestringNo
referenceNumberstringNo
subTotalnumberNo
taxnumberNo
tenantIdlongNo
unitPriceGstInclusivebooleanNo
whtApplicablebooleanNo
whtInfoIsraelWhtInfoIsraelNo

DepositInformation

NameTypeDescriptionRequired
accountCodePayTostringAccount code.
Example: "AC-001"
No
accountNamestringAccount name.
Example: "Bank"
No
amountnumberPayment amount.
Example: 10
No
amountDuenumberPayment amount Due.
Example: 10
No
attachmentIds[ integer ]list of attachment id's for this orderNo
bankRuleIdlongRule id if the document has been created by a Bank RuleNo
billToAddressBill to addressNo
contactCodestringContact code.
Example: 19425
No
contactDtoContactDtoNo
contactNamestringContact name.
Example: "ABC PTE LTD"
No
currencystringCurrency code.
Enum: "AFN", "ALL", "DZD", "AOA", "ARS", "AMD", "AWG", "AZN", "BSD", "BHD", "BDT", "BBD", "BYN", "BZD", "BMD", "BTN", "BOB", "BAM", "BRL", "BND", "BGN", "BIF", "KHR", "CAD", "CVE", "KYD", "CLP", "CNY", "COP", "KMF", "CDF", "CRC", "CZK", "HRK", "CUC", "DJF", "DOP", "EGP", "ERN", "ETB", "FKP", "FJD", "XAF", "GMD", "GEL", "GHS", "GIP", "DKK", "GTQ", "GNF", "GYD", "HTG", "HNL", "HKD", "HUF", "ISK", "INR", "IDR", "IRR", "IQD", "JMD", "JPY", "JOD", "KZT", "KES", "KWD", "KGS", "LAK", "LBP", "LSL", "LRD", "LYD", "MOP", "MKD", "MGA", "MWK", "MYR", "MVR", "MRO", "MUR", "MXN", "MDL", "MNT", "MZN", "MMK", "NAD", "NPR", "NIO", "NGN", "KPW", "OMR", "PKR", "ILS", "PAB", "PGK", "PYG", "PEN", "PHP", "PLN", "QAR", "RON", "RUB", "RWF", "SHP", "XCD", "WST", "STD", "SAR", "RSD", "SCR", "SLL", "SGD", "ANG", "SBD", "SOS", "ZAR", "KRW", "SSP", "EUR", "LKR", "SDG", "SRD", "NOK", "SZL", "SEK", "CHF", "SYP", "TWD", "TJS", "TZS", "THB", "XOF", "NZD", "TOP", "TTD", "TND", "TRY", "TMT", "AUD", "UGX", "UAH", "AED", "GBP", "USD", "UYU", "UZS", "VUV", "VEF", "VND", "XPF", "MAD", "YER", "ZMW", "BWP", "CNH"
Example: "SGD"
No
customField[ CustomFieldItem ]List of custom fieldsNo
customerTypeIndiastringIndia Compliance filed
Enum: "EXPORT_WO_PAY", "EXPORT_W_PAY", "NA", "SEZ_WO_PAY", "SEZ_W_PAY"
Example: "SEZ (WPAY)"
No
documentDatedateTimeDocument date.
Example: "2019-09-27"
No
errors[ string ]List of validation error messagesNo
exchangeRatenumberExchange rate.
Example: 0.01891562
No
gstExchangeRatenumberGST Exchange rate if tax residency currency is different than base currency
Example: 1
No
gstInstringNo
gstTreatmentIndiastringIndia Compliance filed
Enum: "REGISTERED_BUSINESS_REGULAR=Registered Business - Regular", "REGISTERED_BUSINESS_COMPOSITION=Registered Business - Composition", "UNREGISTERED_BUSINESS=Unregistered Business", "CUSTOMER=Consumer", "OVERSEAS=Overseas", "SPECIAL_ECONOMIC_ZONE=Special Economic Zone", "DEEMED_EXPORT=Deemed Export"
Example: "REGISTERED_BUSINESS_REGULAR"
No
interCompanybooleanTrue if it is between inter companies
Example: true
No
isUnDepositedPaymentbooleanWhether the current payment is un-deposited or not.No
journalEntryBankTransferRequestDtoJournalEntryBankTransferRequestDtoBank Transfer Request DTO for Journal EntryNo
knockoffInfo[ KnockOffInfo ]No
memostringMemo text.
Example: "Sales quotation"
No
openingbooleanOpening Document
Example: false
No
paymentTypestringType of payment.
Enum: "CHEQUE", "CASH", "BANK_TRANSFER", "CARD", "OTHERS"
Example: "BANK_TRANSFER"
No
receivePaymentFeeDtoList[ ReceivePaymentFeeDto ]Transaction fee pertaining to the received paymentNo
receivePaymentItemDtoList[ DepositItemInformation ]Receive payment items information.No
reconciledbooleanWhether the current payment is reconciled or not.No
referenceDatedateTimeDate of Bank Transfer/cheque.
Example: "2019-09-27"
No
referenceNumberstringReference number of Bank Transfer/cheque.
Example: "CH001"
No
sentEmailbooleanSend Customer Email
Example: false
No
shipFromAddressShip from addressNo
shipToAddressShip to addressNo
tdsAccountCodestringTDS account code
Example: "AC-007"
No
tdsAmountnumberTDS amount
Example: 10
No
unDepositedEntriesReconciled[ UnDepositedEntriesReconciled ]Reconciled un-deposited entriesNo
unitPriceGstInclusivebooleanPrice is GST inclusive
Example: false
No
vendorTypeIndiastringIndia Compliance filed
Enum: "IMPORT", "NA", "SEZ_W_PAY", "SEZ_WO_PAY"
Example: "EXPORT (WOPAY)"
No
whtApplicablebooleanWHT Applicable for Receipt
Example: true
No

DepositItemInformation

NameTypeDescriptionRequired
accountNamestringAccount name.
Example: "Bank"
No
customField[ CustomFieldItem ]List of custom fieldsNo
descriptionstringDescription of document.
Example: "General ledger for account."
No
documentCodestringDocument code.
Example: "AC-001"
No
documentSequenceCodestringDocument Sequence code.
Example: "AC-001"
No
documentTypestringDocument type.
Example: "General Ledger"
No
exchangeRatenumberExchange rate.
Example: 0.01891562
No
isTdsApplicableAccountbooleanNo
isTdsApplicableContactbooleanNo
paymentAmountnumberPayment amount.
Example: 10.5
No
taxAmountnumberTax amount.
Example: 0.7
No
taxCodestringTax code.
Example: "GST@7"
No
taxDtoTaxDtoNo
taxList[ TaxMappingDto ]No
tdsInfoIndiaTdsInfoIndiaPre-Payment TDS detailsNo

DocumentInfo

NameTypeDescriptionRequired
documentCodestringDocument Code.
Example: "QO-0000001"
No
documentCreatedDatedateTimePurchase creation date
Example: "2023-01-01T00:00:00.000+0000"
No
documentSequenceCodestringPurchase Order Code
Example: "0000001"
No
documentTypestringType of document.
Enum: "QUOTATION", "PURCHASE_ORDER", "SALES_ORDER", "PURCHASE_INVOICE", "SALES_INVOICE", "MAKE_PAYMENT", "RECEIVE_PAYMENT", "JOURNAL_ENTRY", "BANK_TRANSFER", "CREDIT_NOTE", "DEBIT_NOTE", "EXPENSE", "EXPENSE_PREPAYMENT", "DEPOSIT", "DEPOSIT_ADVPAYMENT", "CONTRA_ADJUSTMENT", "GOODS_RECEIPT", "FULFILLMENT", "PICKLIST", "PACKLIST", "SHIPLIST", "PAYSLIP", "PAYROLL_CHECK", "CHEQUE", "SALES_RETURN", "PURCHASE_RETURN", "STOCK_ADJUSTMENT", "STOCK_TRANSFER", "WORK_ORDER", "FIXED_ASSET", "PURCHASE_REQUEST", "PURCHASE_REQUEST_FOR_QUOTES", "SUPPLIER_QUOTES", "E_WAY_BILL_SUMMARY", "E_WAY_BILL_DETAIL", "JOB_WORK_OUT_ORDER", "JOB_WORK_OUT_TRANSFER", "QC_DOCUMENT", "WIP_PRODUCTION", "STOCK_REQUEST", "STOCK_ISSUE", "FORECAST"
Example: "QUOTATION"
No

DocumentUOMSchemaDefinition

NameTypeDescriptionRequired
namestringUOM Schema Name
Example: "UNIT"
No
schemaIdlongUOM Schema Id
Example: 1
No
sinkConversionFactornumber10
Example: 10
No
sinkUOMlong2
Example: 2
No
sourceConversionFactornumber1
Example: 1
No
sourceUOMlong4
Example: 4
No
uidstringUOM Schema Definition Id
Example: 1
No

DueAmountResponse

NameTypeDescriptionRequired
amountnumberNo
namestringNo

ExpenseDto

NameTypeDescriptionRequired
accountCodePayFromstringNo
accountNamestringNo
amountnumberNo
amountDuenumberNo
attachmentIds[ integer ]No
codestringNo
contactCodestringNo
contactCustomField[ CustomFieldItem ]No
contactNamestringNo
currencystringEnum: "AFN", "ALL", "DZD", "AOA", "ARS", "AMD", "AWG", "AZN", "BSD", "BHD", "BDT", "BBD", "BYN", "BZD", "BMD", "BTN", "BOB", "BAM", "BRL", "BND", "BGN", "BIF", "KHR", "CAD", "CVE", "KYD", "CLP", "CNY", "COP", "KMF", "CDF", "CRC", "CZK", "HRK", "CUC", "DJF", "DOP", "EGP", "ERN", "ETB", "FKP", "FJD", "XAF", "GMD", "GEL", "GHS", "GIP", "DKK", "GTQ", "GNF", "GYD", "HTG", "HNL", "HKD", "HUF", "ISK", "INR", "IDR", "IRR", "IQD", "JMD", "JPY", "JOD", "KZT", "KES", "KWD", "KGS", "LAK", "LBP", "LSL", "LRD", "LYD", "MOP", "MKD", "MGA", "MWK", "MYR", "MVR", "MRO", "MUR", "MXN", "MDL", "MNT", "MZN", "MMK", "NAD", "NPR", "NIO", "NGN", "KPW", "OMR", "PKR", "ILS", "PAB", "PGK", "PYG", "PEN", "PHP", "PLN", "QAR", "RON", "RUB", "RWF", "SHP", "XCD", "WST", "STD", "SAR", "RSD", "SCR", "SLL", "SGD", "ANG", "SBD", "SOS", "ZAR", "KRW", "SSP", "EUR", "LKR", "SDG", "SRD", "NOK", "SZL", "SEK", "CHF", "SYP", "TWD", "TJS", "TZS", "THB", "XOF", "NZD", "TOP", "TTD", "TND", "TRY", "TMT", "AUD", "UGX", "UAH", "AED", "GBP", "USD", "UYU", "UZS", "VUV", "VEF", "VND", "XPF", "MAD", "YER", "ZMW", "BWP", "CNH"No
customField[ CustomFieldItem ]No
documentDatestringNo
exchangeRatenumberNo
gstExchangeRatenumberNo
idlongNo
interCompanybooleanNo
isTdsPaymentIndiabooleanNo
jeCodestringNo
makePaymentItemDtoList[ MakePaymentItemDto ]No
memostringNo
openingbooleanNo
paymentTypestringEnum: "CHEQUE", "CASH", "BANK_TRANSFER", "CARD", "OTHERS"No
printStatusstringEnum: "PRINT_SUCCESS", "PRINT_FAILURE", "NOT_PRINTED"No
referenceDatestringNo
referenceNumberstringNo
subTotalnumberNo
taxnumberNo
tdsPaymentInfoIndiaTDSPaymentInfoIndiaNo
tdsProcessedFlagbooleanNo
tenantIdlongNo
unitPriceGstInclusivebooleanNo
whtInfoIsraelWhtInfoIsraelNo

ExpenseInformation

NameTypeDescriptionRequired
accountCodePayFromstringAccount code.
Example: "AC-001"
No
accountNamestringAccount name.
Example: "Bank"
No
amountnumberPayment amount.
Example: 10
No
amountDuenumberPayment amount Due.
Example: 10
No
attachmentIds[ integer ]list of attachment id's for this orderNo
bankRuleIdlongRule id if the document has been created by a Bank RuleNo
contactCodestringContact code.
Example: 19425
No
contactDtoContactDtoNo
contactNamestringContact name.
Example: "ABC PTE LTD"
No
currencystringCurrency code.
Enum: "AFN", "ALL", "DZD", "AOA", "ARS", "AMD", "AWG", "AZN", "BSD", "BHD", "BDT", "BBD", "BYN", "BZD", "BMD", "BTN", "BOB", "BAM", "BRL", "BND", "BGN", "BIF", "KHR", "CAD", "CVE", "KYD", "CLP", "CNY", "COP", "KMF", "CDF", "CRC", "CZK", "HRK", "CUC", "DJF", "DOP", "EGP", "ERN", "ETB", "FKP", "FJD", "XAF", "GMD", "GEL", "GHS", "GIP", "DKK", "GTQ", "GNF", "GYD", "HTG", "HNL", "HKD", "HUF", "ISK", "INR", "IDR", "IRR", "IQD", "JMD", "JPY", "JOD", "KZT", "KES", "KWD", "KGS", "LAK", "LBP", "LSL", "LRD", "LYD", "MOP", "MKD", "MGA", "MWK", "MYR", "MVR", "MRO", "MUR", "MXN", "MDL", "MNT", "MZN", "MMK", "NAD", "NPR", "NIO", "NGN", "KPW", "OMR", "PKR", "ILS", "PAB", "PGK", "PYG", "PEN", "PHP", "PLN", "QAR", "RON", "RUB", "RWF", "SHP", "XCD", "WST", "STD", "SAR", "RSD", "SCR", "SLL", "SGD", "ANG", "SBD", "SOS", "ZAR", "KRW", "SSP", "EUR", "LKR", "SDG", "SRD", "NOK", "SZL", "SEK", "CHF", "SYP", "TWD", "TJS", "TZS", "THB", "XOF", "NZD", "TOP", "TTD", "TND", "TRY", "TMT", "AUD", "UGX", "UAH", "AED", "GBP", "USD", "UYU", "UZS", "VUV", "VEF", "VND", "XPF", "MAD", "YER", "ZMW", "BWP", "CNH"
Example: "SGD"
No
customField[ CustomFieldItem ]List of custom fieldsNo
customerTypeIndiastringIndia Compliance filed
Enum: "EXPORT_WO_PAY", "EXPORT_W_PAY", "NA", "SEZ_WO_PAY", "SEZ_W_PAY"
Example: "SEZ (WPAY)"
No
documentDatedateTimeDocument date.
Example: "2019-09-27"
No
errors[ string ]List of validation error messagesNo
exchangeRatenumberExchange rate.
Example: 0.01891562
No
gstExchangeRatenumberGST Exchange rate if tax residency currency is different than base currency
Example: 1
No
gstInstringNo
gstTreatmentIndiastringIndia Compliance filed
Enum: "REGISTERED_BUSINESS_REGULAR=Registered Business - Regular", "REGISTERED_BUSINESS_COMPOSITION=Registered Business - Composition", "UNREGISTERED_BUSINESS=Unregistered Business", "CUSTOMER=Consumer", "OVERSEAS=Overseas", "SPECIAL_ECONOMIC_ZONE=Special Economic Zone", "DEEMED_EXPORT=Deemed Export"
Example: "REGISTERED_BUSINESS_REGULAR"
No
interCompanybooleanTrue if it is between inter companies
Example: true
No
isTdsPaymentIndiabooleanNo
knockoffInfo[ KnockOffInfo ]No
makePaymentFeeDtoList[ MakePaymentFeeDto ]Transaction fee pertaining to the made paymentNo
makePaymentItemDtoList[ ExpenseItemInformation ]Make payment items information.No
makePaymentRecurringDtoMakePaymentRecurringDtoRecurring payment details.No
memostringMemo text.
Example: "Sales quotation"
No
nextPaymentDatedateTimeNext payment date.
Example: "2019-09-27"
No
openingbooleanOpening Document
Example: false
No
paymentTypestringType of payment.
Enum: "CHEQUE", "CASH", "BANK_TRANSFER", "CARD", "OTHERS"
Example: "BANK_TRANSFER"
No
reconciledbooleanWhether the current payment is reconciled or not.No
recurringActivatedbooleanRecurring payment activated for payment.
Example: false
No
recurringPaymentbooleanRecurring payment enable/disable for payment.
Example: false
No
referenceDatedateTimeDate of Bank Transfer/cheque.
Example: "2019-09-27"
No
referenceNumberstringReference number of Bank Transfer/cheque.
Example: "CH001"
No
statusstringPrint Status
Enum: "PRINT_SUCCESS", "PRINT_FAILURE", "NOT_PRINTED"
Example: "NOT_PRINTED"
No
tdsPaymentInfoIndiaTDSPaymentInfoIndiaTDS Payment detailsNo
tdsProcessedFlagbooleanTDS Processed Flag
Example: false
No
unitPriceGstInclusivebooleanPrice is GST inclusive
Example: false
No
vendorTypeIndiastringIndia Compliance filed
Enum: "IMPORT", "NA", "SEZ_W_PAY", "SEZ_WO_PAY"
Example: "EXPORT (WOPAY)"
No
whtApplicablebooleanWHT Applicable for make payment
Example: true
No

ExpenseItemInformation

NameTypeDescriptionRequired
accountNamestringAccount name.
Example: "Bank"
No
customField[ CustomFieldItem ]List of custom fieldsNo
descriptionstringDescription of document.
Example: "General ledger for account."
No
documentCodestringDocument code.
Example: "AC-001"
No
documentSequenceCodestringDocument Sequence code.
Example: "AC-001"
No
documentTypestringDocument type.
Example: "General Ledger"
No
exchangeRatenumberExchange rate.
Example: 0.01891562
No
isTdsApplicableAccountbooleanNo
isTdsApplicableContactbooleanNo
paymentAmountnumberPayment amount.
Example: 10.5
No
taxAmountnumberTax amount.
Example: 0.7
No
taxCodestringTax code.
Example: "GST@7"
No
taxDtoTaxDtoNo
taxList[ TaxMappingDto ]No
tdsAccountstringTds Account Code
Example: "AC-0000011"
No
tdsAmountnumberTDS Amount
Example: 100
No
tdsInfoIndiaTdsInfoIndiaPre-Payment TDS detailsNo
tdsRatenumberTDS Rate
Example: 10.1
No

ExportDocumentRequest

NameTypeDescriptionRequired
categoryNamestringQUOTE,INVOICE etc
Example: "QUOTE"
Yes
customTemplatebooleanInvoice Custom Template flag
Example: false
No
documentCodestringDocument system number , could be invoice number, quotation number etc.
Example: "00001"
No
documentNumberstringDocument number , could be invoice number, quotation number etc.
Example: "00001"
No
documentTypestringEnum: "QUOTATION", "PURCHASE_ORDER", "SALES_ORDER", "PURCHASE_INVOICE", "SALES_INVOICE", "MAKE_PAYMENT", "RECEIVE_PAYMENT", "JOURNAL_ENTRY", "BANK_TRANSFER", "CREDIT_NOTE", "DEBIT_NOTE", "EXPENSE", "EXPENSE_PREPAYMENT", "DEPOSIT", "DEPOSIT_ADVPAYMENT", "CONTRA_ADJUSTMENT", "GOODS_RECEIPT", "FULFILLMENT", "PICKLIST", "PACKLIST", "SHIPLIST", "PAYSLIP", "PAYROLL_CHECK", "CHEQUE", "SALES_RETURN", "PURCHASE_RETURN", "STOCK_ADJUSTMENT", "STOCK_TRANSFER", "WORK_ORDER", "FIXED_ASSET", "PURCHASE_REQUEST", "PURCHASE_REQUEST_FOR_QUOTES", "SUPPLIER_QUOTES", "E_WAY_BILL_SUMMARY", "E_WAY_BILL_DETAIL", "JOB_WORK_OUT_ORDER", "JOB_WORK_OUT_TRANSFER", "QC_DOCUMENT", "WIP_PRODUCTION", "STOCK_REQUEST", "STOCK_ISSUE", "FORECAST"No
fileNamestringFile name of the template
Example: "QUOTE.DOCX"
No
headers[ Map«string,object» ]No
moduleNamestringERP,CRM,HRMS
Example: "ERP"
Yes
skipDocumentTemplateMappingbooleanSkip document template mapping
Example: false
No
templateIdlongTemplate id
Example: 12
No

GlobalDiscountDetails

NameTypeDescriptionRequired
accountCodestringNo
amountnumberNo
isPercentbooleanNo
isSubTotalOnlybooleanNo
namestringNo
percentnumberNo

InventoryDto

NameTypeDescriptionRequired
availableQuantitydoubleAvailable quantity
Example: 100
No
binCodestringbin code
Example: "BIN-00001"
Yes
binNamestringbin name
Example: "BIN-NAME"
No
costOfGoodsSoldAccountCodestringCost of goods sold account code
Example: "A-10231"
Yes
inventoryAccountCodestringInventory account code
Example: "A-10232"
Yes
inventoryAccountNamestringInventory account name
Example: "Inventory Account"
Yes
landedCostWeightnumberLanded cost weight value
Example: 10.5
No
openingQuantitydoubleOpening quantity
Example: 10
No
openingValuationdoubleOpening valuation
Example: 100.4
No
rackCodestringRack code
Example: "RACK-00001"
Yes
rackNamestringRack name
Example: "RACK-NAME"
No
reservedQuantitydoubleReserved quantity
Example: 100
No
rowCodestringRow code
Example: "ROW-00001"
Yes
rowNamestringRow name
Example: "ROW-NAME"
No
stockAdjustmentAccountCodestringStock adjustment account code
Example: "A-10234"
Yes
warehouseCodestringWarehouse code
Example: "WH-00001"
Yes
wipInventoryAccountCodestringWIP Inventory account code
Example: "A-10233"
Yes

InventoryWarehouseDetails

NameTypeDescriptionRequired
availableQuantitynumberAvailable quantity
Example: 100
No
openingQuantitynumberOpening quantity
Example: 10
No
openingValuationnumberOpening Valuation
Example: 1000
No
warehouseCodestringWarehouse code
Example: "WH-00001"
Yes

InvoiceResponseInfo

NameTypeDescriptionRequired
currencystringNo
documentCodestringdocument code
Example: "SI-0000041"
No
documentSequenceCodestringDocument Sequence Code
Example: "00000001"
No
dueAmountnumberdue amount
Example: 46
No
exchangeRatenumberNo
idlongID
Example: 43
No
invoiceDatedateTimeinvoice date
Example: "2018-10-01"
No
invoiceDueDatedateTimeinvoice due date
Example: "2018-10-01"
No
memostringmemo
Example: "test"
No
purchaseOrderRefNostringContact PO reference number
Example: "CPO001"
No
statusstringEnum: "OPEN", "DRAFT", "CLOSED"No
supplierInvoiceNostringContact supplier invoice number
Example: "CSI001"
No
taxAmountnumberTotal Amount
Example: 1
No
totalAmountnumbertotal amount
Example: 46
No
totalAmountInBaseCurrencynumbertotal amount in base currency
Example: 46
No
typestringsale invoice or purchase invoice
Example: "sale_invoice"
No

ItemQtyFulfilledByDoc

NameTypeDescriptionRequired
fulfillmentIdstringNo
siAmountnumberNo

JELineItemMetaData

NameTypeDescriptionRequired
baseAmountnumberBase amount for tax calculation
Example: 200
No
contactNamestringContact Name
Example: "Abacus Limited"
No
taxCodestringTax Code
Example: "TX-0000001"
No
taxNamestringTax Name
Example: "GST(BL)@7.00%"
No
taxPercentnumberTax Percent
Example: 7
No
taxSequencestringTax Sequence
Example: "GST(BL)@7.00%"
No

JournalEntryBankTransferRequestDto

NameTypeDescriptionRequired
amountnumberamount
Example: 1
No
bankToBaseExchangeRatenumberIf From bank is in foreign currency and To bank in another or same foreign currency
Example: 1
No
chequeDatedateTimedate pattern dd-MM-yyyyNo
chequePrintedbooleancheque printed
Example: false
No
contactCodestringJE Contact Id
Example: 1
No
currencystringcurrency ID
Example: "SGD"
Yes
currencyExchangeRatenumberJE Currency Exchange Rate
Example: 1
No
customField[ CustomFieldItem ]List of custom fieldsNo
documentCodestringJE Document Number
Example: "PI0001"
No
documentSequenceCodestringPurchase Order Code
Example: "0000001"
No
fromAccountlongfrom account
Example: 1
No
generateCNDNbooleanGenerate CN DN for JE
Example: false
No
idlongJournal Entry ID
Example: 1
No
includeGSTReportbooleanInclude JE in GST Report
Example: true
No
jeCodestringJE Number
Example: "JE-0000001"
No
jeDatedateTimedate pattern dd-MM-yyyy
Example: "06-11-2019"
Yes
journalEntryRecurringDtoJournalEntryRecurringDtoJournal Entry Recurring Meta DataNo
lineItems[ JournalEntryLineItemsDto ]Journal Entry Line ItemsYes
memostringJE Memo
Example: "memo"
No
nextJEDatedateTimedate pattern dd-MM-yyyy
Example: "16-11-2019"
Yes
openingbooleanOpening
Example: false
No
parentJeIdlongParent JE IDNo
paymentMethodstringpayment method
Example: 1
No
recurringActivatedbooleanRecurring JE Status
Example: false
No
recurringJEbooleanRecurring JE
Example: false
No
toAccountlongto account
Example: 1
No
transferDatedateTimedate pattern dd-MM-yyyyYes
transferNumberstringtransfer number
Example: 1
No
transferTypestringBANK_TRANSFERNo
typestringJE Type
Example: "NORMAL_JE"
No

JournalEntryLineItemsDto

NameTypeDescriptionRequired
accountCodestringAccount Id
Example: 1
No
accountNamestringAccount Name
Example: "Deskera"
No
amountnumberamount
Example: 0
No
amountInDocumentCurrencynumberamount in document currency
Example: 0
No
cdTypestringCredit Debit Type
Example: "DEBIT"
No
cfieldobjectNo
customField[ CustomFieldItem ]List of custom fieldsNo
descriptionstringJE Line Items Description
Example: "credit description"
No
gstTypeIndiastringGST type
Enum: "CGST", "SGST", "IGST", "CESS"
Example: "IGST"
No
idlongJournal Entry Line Items ID
Example: 1
No
jeLineItemMetaDataJELineItemMetaDataJE line items metadataNo

JournalEntryRecurringDto

NameTypeDescriptionRequired
jeRecurringCountintegerJournal Entry Recurring Count
Example: 1
No
journalEntryIDlongJournal Entry Id
Example: 1
No
memo[ RecurringJournalEntryMemo ]Journal entry memoNo
recurrenceEndDatedateTimeYes
recurrenceFrequencystringJournal Entry Recurrence Frequency
Example: "WEEK"
No
recurrenceTypeintegerJournal Entry Recurrence
Example: 1
No

KnockOffInfo

NameTypeDescriptionRequired
amountnumberNo
bulkData[ BulkPaymentItem ]No
contraDocumentCodestringNo
currencystringNo
documentCodestringNo
documentDatedateTimeNo
documentOrderintegerNo
documentTypestringEnum: "QUOTATION", "PURCHASE_ORDER", "SALES_ORDER", "PURCHASE_INVOICE", "SALES_INVOICE", "MAKE_PAYMENT", "RECEIVE_PAYMENT", "JOURNAL_ENTRY", "BANK_TRANSFER", "CREDIT_NOTE", "DEBIT_NOTE", "EXPENSE", "EXPENSE_PREPAYMENT", "DEPOSIT", "DEPOSIT_ADVPAYMENT", "CONTRA_ADJUSTMENT", "GOODS_RECEIPT", "FULFILLMENT", "PICKLIST", "PACKLIST", "SHIPLIST", "PAYSLIP", "PAYROLL_CHECK", "CHEQUE", "SALES_RETURN", "PURCHASE_RETURN", "STOCK_ADJUSTMENT", "STOCK_TRANSFER", "WORK_ORDER", "FIXED_ASSET", "PURCHASE_REQUEST", "PURCHASE_REQUEST_FOR_QUOTES", "SUPPLIER_QUOTES", "E_WAY_BILL_SUMMARY", "E_WAY_BILL_DETAIL", "JOB_WORK_OUT_ORDER", "JOB_WORK_OUT_TRANSFER", "QC_DOCUMENT", "WIP_PRODUCTION", "STOCK_REQUEST", "STOCK_ISSUE", "FORECAST"No
exchangeRatenumberNo
linkedDocumentSequencestringNo
linkedWhileCreatingNotebooleanNo
uidstring (uuid)No
whtAmountnumberNo

KnockOffRequest

NameTypeDescriptionRequired
amountnumberAmount
Example: 100
No
currencystringCurrency Code
Enum: "AFN", "ALL", "DZD", "AOA", "ARS", "AMD", "AWG", "AZN", "BSD", "BHD", "BDT", "BBD", "BYN", "BZD", "BMD", "BTN", "BOB", "BAM", "BRL", "BND", "BGN", "BIF", "KHR", "CAD", "CVE", "KYD", "CLP", "CNY", "COP", "KMF", "CDF", "CRC", "CZK", "HRK", "CUC", "DJF", "DOP", "EGP", "ERN", "ETB", "FKP", "FJD", "XAF", "GMD", "GEL", "GHS", "GIP", "DKK", "GTQ", "GNF", "GYD", "HTG", "HNL", "HKD", "HUF", "ISK", "INR", "IDR", "IRR", "IQD", "JMD", "JPY", "JOD", "KZT", "KES", "KWD", "KGS", "LAK", "LBP", "LSL", "LRD", "LYD", "MOP", "MKD", "MGA", "MWK", "MYR", "MVR", "MRO", "MUR", "MXN", "MDL", "MNT", "MZN", "MMK", "NAD", "NPR", "NIO", "NGN", "KPW", "OMR", "PKR", "ILS", "PAB", "PGK", "PYG", "PEN", "PHP", "PLN", "QAR", "RON", "RUB", "RWF", "SHP", "XCD", "WST", "STD", "SAR", "RSD", "SCR", "SLL", "SGD", "ANG", "SBD", "SOS", "ZAR", "KRW", "SSP", "EUR", "LKR", "SDG", "SRD", "NOK", "SZL", "SEK", "CHF", "SYP", "TWD", "TJS", "TZS", "THB", "XOF", "NZD", "TOP", "TTD", "TND", "TRY", "TMT", "AUD", "UGX", "UAH", "AED", "GBP", "USD", "UYU", "UZS", "VUV", "VEF", "VND", "XPF", "MAD", "YER", "ZMW", "BWP", "CNH"
Example: "SGD"
Yes
documentCodestringUnique system generated document code
Example: "SI-0000001"
No
documentTypestringType of document.
Enum: "QUOTATION", "PURCHASE_ORDER", "SALES_ORDER", "PURCHASE_INVOICE", "SALES_INVOICE", "MAKE_PAYMENT", "RECEIVE_PAYMENT", "JOURNAL_ENTRY", "BANK_TRANSFER", "CREDIT_NOTE", "DEBIT_NOTE", "EXPENSE", "EXPENSE_PREPAYMENT", "DEPOSIT", "DEPOSIT_ADVPAYMENT", "CONTRA_ADJUSTMENT", "GOODS_RECEIPT", "FULFILLMENT", "PICKLIST", "PACKLIST", "SHIPLIST", "PAYSLIP", "PAYROLL_CHECK", "CHEQUE", "SALES_RETURN", "PURCHASE_RETURN", "STOCK_ADJUSTMENT", "STOCK_TRANSFER", "WORK_ORDER", "FIXED_ASSET", "PURCHASE_REQUEST", "PURCHASE_REQUEST_FOR_QUOTES", "SUPPLIER_QUOTES", "E_WAY_BILL_SUMMARY", "E_WAY_BILL_DETAIL", "JOB_WORK_OUT_ORDER", "JOB_WORK_OUT_TRANSFER", "QC_DOCUMENT", "WIP_PRODUCTION", "STOCK_REQUEST", "STOCK_ISSUE", "FORECAST"
Example: "SALES_INVOICE"
No
exchangeRatenumberCurrency Exchange Rate
Example: 1
No
knockOffDatedateTimeKnock off Date with pattern dd-mm-yyyy
Example: "06-11-2019"
Yes
linkedDocumentSequencestringDocument Sequence Code
Example: "SI-0000001"
No
paymentCodestringUnique system generated payment/receipt code
Example: "MP-0000001"
No
uidstring (uuid)No

LandedCostCategory

NameTypeDescriptionRequired
allocationTypestringEnum: "QUANTITY", "VALUE", "WEIGHT", "MANUAL", "CUSTOM_DUTY"No
namestringNo

LandedCostDetails

NameTypeDescriptionRequired
allocationTypestringEnum: "QUANTITY", "VALUE", "WEIGHT", "MANUAL", "CUSTOM_DUTY"No
categoryNamestringNo
landedCostCategorystringNo
productDetails[ LandedCostProductDetails ]No

LandedCostProductDetails

NameTypeDescriptionRequired
allocatedCostnumberNo
customDutyAndOtherChargesnumberNo
gstRatestringNo
hsncodestringNo
igstnumberNo
productstringNo
productIdstringNo
quantitynumberNo
taxableValueForCustomDutynumberNo
taxableValueForIGSTnumberNo
totalAmountnumberNo
unitPricenumberNo

MakeBulkPaymentDto

NameTypeDescriptionRequired
amountnumberPayment amount
Example: 100
No
amountInBaseCurrencynumberPayment amount in Base Currency
Example: 100
No
codestringSequence code
Example: "MBP-0000001"
No
contactCodestringContact code.
Example: "C-0000001"
No
contactNamestringContact name.
Example: "ABC PTE LTD"
No
currencystringCurrency
Enum: "AFN", "ALL", "DZD", "AOA", "ARS", "AMD", "AWG", "AZN", "BSD", "BHD", "BDT", "BBD", "BYN", "BZD", "BMD", "BTN", "BOB", "BAM", "BRL", "BND", "BGN", "BIF", "KHR", "CAD", "CVE", "KYD", "CLP", "CNY", "COP", "KMF", "CDF", "CRC", "CZK", "HRK", "CUC", "DJF", "DOP", "EGP", "ERN", "ETB", "FKP", "FJD", "XAF", "GMD", "GEL", "GHS", "GIP", "DKK", "GTQ", "GNF", "GYD", "HTG", "HNL", "HKD", "HUF", "ISK", "INR", "IDR", "IRR", "IQD", "JMD", "JPY", "JOD", "KZT", "KES", "KWD", "KGS", "LAK", "LBP", "LSL", "LRD", "LYD", "MOP", "MKD", "MGA", "MWK", "MYR", "MVR", "MRO", "MUR", "MXN", "MDL", "MNT", "MZN", "MMK", "NAD", "NPR", "NIO", "NGN", "KPW", "OMR", "PKR", "ILS", "PAB", "PGK", "PYG", "PEN", "PHP", "PLN", "QAR", "RON", "RUB", "RWF", "SHP", "XCD", "WST", "STD", "SAR", "RSD", "SCR", "SLL", "SGD", "ANG", "SBD", "SOS", "ZAR", "KRW", "SSP", "EUR", "LKR", "SDG", "SRD", "NOK", "SZL", "SEK", "CHF", "SYP", "TWD", "TJS", "TZS", "THB", "XOF", "NZD", "TOP", "TTD", "TND", "TRY", "TMT", "AUD", "UGX", "UAH", "AED", "GBP", "USD", "UYU", "UZS", "VUV", "VEF", "VND", "XPF", "MAD", "YER", "ZMW", "BWP", "CNH"
Example: "SGD"
No
documentDatedateTimePayment Date
Example: "25-10-2019"
No
exchangeRatenumberExchange Rate
Example: 1
No
idlongNo
makePaymentFeeDtoList[ MakePaymentFeeDto ]Transaction fee pertaining to the made paymentNo
makePaymentList[ AbstractMakePaymentResponseDto«AbstractMakePaymentItemDto» ]List of make payments
Example: []
No

MakeBulkPaymentDto«MakePaymentResponseDto,MakePaymentItemResponseDto»

NameTypeDescriptionRequired
amountnumberPayment amount
Example: 100
No
amountInBaseCurrencynumberPayment amount in Base Currency
Example: 100
No
codestringSequence code
Example: "MBP-0000001"
No
contactCodestringContact code.
Example: "C-0000001"
No
contactNamestringContact name.
Example: "ABC PTE LTD"
No
currencystringCurrency
Enum: "AFN", "ALL", "DZD", "AOA", "ARS", "AMD", "AWG", "AZN", "BSD", "BHD", "BDT", "BBD", "BYN", "BZD", "BMD", "BTN", "BOB", "BAM", "BRL", "BND", "BGN", "BIF", "KHR", "CAD", "CVE", "KYD", "CLP", "CNY", "COP", "KMF", "CDF", "CRC", "CZK", "HRK", "CUC", "DJF", "DOP", "EGP", "ERN", "ETB", "FKP", "FJD", "XAF", "GMD", "GEL", "GHS", "GIP", "DKK", "GTQ", "GNF", "GYD", "HTG", "HNL", "HKD", "HUF", "ISK", "INR", "IDR", "IRR", "IQD", "JMD", "JPY", "JOD", "KZT", "KES", "KWD", "KGS", "LAK", "LBP", "LSL", "LRD", "LYD", "MOP", "MKD", "MGA", "MWK", "MYR", "MVR", "MRO", "MUR", "MXN", "MDL", "MNT", "MZN", "MMK", "NAD", "NPR", "NIO", "NGN", "KPW", "OMR", "PKR", "ILS", "PAB", "PGK", "PYG", "PEN", "PHP", "PLN", "QAR", "RON", "RUB", "RWF", "SHP", "XCD", "WST", "STD", "SAR", "RSD", "SCR", "SLL", "SGD", "ANG", "SBD", "SOS", "ZAR", "KRW", "SSP", "EUR", "LKR", "SDG", "SRD", "NOK", "SZL", "SEK", "CHF", "SYP", "TWD", "TJS", "TZS", "THB", "XOF", "NZD", "TOP", "TTD", "TND", "TRY", "TMT", "AUD", "UGX", "UAH", "AED", "GBP", "USD", "UYU", "UZS", "VUV", "VEF", "VND", "XPF", "MAD", "YER", "ZMW", "BWP", "CNH"
Example: "SGD"
No
documentDatedateTimePayment Date
Example: "25-10-2019"
No
exchangeRatenumberExchange Rate
Example: 1
No
idlongNo
makePaymentFeeDtoList[ MakePaymentFeeDto ]Transaction fee pertaining to the made paymentNo
makePaymentList[ MakePaymentResponseDto ]List of make payments
Example: []
No

MakeBulkPaymentDto«MakePaymentResponseDtoIndia,MakePaymentItemResponseDtoIndia»

NameTypeDescriptionRequired
amountnumberPayment amount
Example: 100
No
amountInBaseCurrencynumberPayment amount in Base Currency
Example: 100
No
codestringSequence code
Example: "MBP-0000001"
No
contactCodestringContact code.
Example: "C-0000001"
No
contactNamestringContact name.
Example: "ABC PTE LTD"
No
currencystringCurrency
Enum: "AFN", "ALL", "DZD", "AOA", "ARS", "AMD", "AWG", "AZN", "BSD", "BHD", "BDT", "BBD", "BYN", "BZD", "BMD", "BTN", "BOB", "BAM", "BRL", "BND", "BGN", "BIF", "KHR", "CAD", "CVE", "KYD", "CLP", "CNY", "COP", "KMF", "CDF", "CRC", "CZK", "HRK", "CUC", "DJF", "DOP", "EGP", "ERN", "ETB", "FKP", "FJD", "XAF", "GMD", "GEL", "GHS", "GIP", "DKK", "GTQ", "GNF", "GYD", "HTG", "HNL", "HKD", "HUF", "ISK", "INR", "IDR", "IRR", "IQD", "JMD", "JPY", "JOD", "KZT", "KES", "KWD", "KGS", "LAK", "LBP", "LSL", "LRD", "LYD", "MOP", "MKD", "MGA", "MWK", "MYR", "MVR", "MRO", "MUR", "MXN", "MDL", "MNT", "MZN", "MMK", "NAD", "NPR", "NIO", "NGN", "KPW", "OMR", "PKR", "ILS", "PAB", "PGK", "PYG", "PEN", "PHP", "PLN", "QAR", "RON", "RUB", "RWF", "SHP", "XCD", "WST", "STD", "SAR", "RSD", "SCR", "SLL", "SGD", "ANG", "SBD", "SOS", "ZAR", "KRW", "SSP", "EUR", "LKR", "SDG", "SRD", "NOK", "SZL", "SEK", "CHF", "SYP", "TWD", "TJS", "TZS", "THB", "XOF", "NZD", "TOP", "TTD", "TND", "TRY", "TMT", "AUD", "UGX", "UAH", "AED", "GBP", "USD", "UYU", "UZS", "VUV", "VEF", "VND", "XPF", "MAD", "YER", "ZMW", "BWP", "CNH"
Example: "SGD"
No
documentDatedateTimePayment Date
Example: "25-10-2019"
No
exchangeRatenumberExchange Rate
Example: 1
No
idlongNo
makePaymentFeeDtoList[ MakePaymentFeeDto ]Transaction fee pertaining to the made paymentNo
makePaymentList[ MakePaymentResponseDtoIndia ]List of make payments
Example: []
No

MakeBulkPaymentDto«MakePaymentResponseDtoIndonesia,MakePaymentItemResponseDtoIndonesia»

NameTypeDescriptionRequired
amountnumberPayment amount
Example: 100
No
amountInBaseCurrencynumberPayment amount in Base Currency
Example: 100
No
codestringSequence code
Example: "MBP-0000001"
No
contactCodestringContact code.
Example: "C-0000001"
No
contactNamestringContact name.
Example: "ABC PTE LTD"
No
currencystringCurrency
Enum: "AFN", "ALL", "DZD", "AOA", "ARS", "AMD", "AWG", "AZN", "BSD", "BHD", "BDT", "BBD", "BYN", "BZD", "BMD", "BTN", "BOB", "BAM", "BRL", "BND", "BGN", "BIF", "KHR", "CAD", "CVE", "KYD", "CLP", "CNY", "COP", "KMF", "CDF", "CRC", "CZK", "HRK", "CUC", "DJF", "DOP", "EGP", "ERN", "ETB", "FKP", "FJD", "XAF", "GMD", "GEL", "GHS", "GIP", "DKK", "GTQ", "GNF", "GYD", "HTG", "HNL", "HKD", "HUF", "ISK", "INR", "IDR", "IRR", "IQD", "JMD", "JPY", "JOD", "KZT", "KES", "KWD", "KGS", "LAK", "LBP", "LSL", "LRD", "LYD", "MOP", "MKD", "MGA", "MWK", "MYR", "MVR", "MRO", "MUR", "MXN", "MDL", "MNT", "MZN", "MMK", "NAD", "NPR", "NIO", "NGN", "KPW", "OMR", "PKR", "ILS", "PAB", "PGK", "PYG", "PEN", "PHP", "PLN", "QAR", "RON", "RUB", "RWF", "SHP", "XCD", "WST", "STD", "SAR", "RSD", "SCR", "SLL", "SGD", "ANG", "SBD", "SOS", "ZAR", "KRW", "SSP", "EUR", "LKR", "SDG", "SRD", "NOK", "SZL", "SEK", "CHF", "SYP", "TWD", "TJS", "TZS", "THB", "XOF", "NZD", "TOP", "TTD", "TND", "TRY", "TMT", "AUD", "UGX", "UAH", "AED", "GBP", "USD", "UYU", "UZS", "VUV", "VEF", "VND", "XPF", "MAD", "YER", "ZMW", "BWP", "CNH"
Example: "SGD"
No
documentDatedateTimePayment Date
Example: "25-10-2019"
No
exchangeRatenumberExchange Rate
Example: 1
No
idlongNo
makePaymentFeeDtoList[ MakePaymentFeeDto ]Transaction fee pertaining to the made paymentNo
makePaymentList[ MakePaymentResponseDtoIndonesia ]List of make payments
Example: []
No

MakeBulkPaymentDto«MakePaymentResponseDtoIsrael,MakePaymentItemResponseDtoIsrael»

NameTypeDescriptionRequired
amountnumberPayment amount
Example: 100
No
amountInBaseCurrencynumberPayment amount in Base Currency
Example: 100
No
codestringSequence code
Example: "MBP-0000001"
No
contactCodestringContact code.
Example: "C-0000001"
No
contactNamestringContact name.
Example: "ABC PTE LTD"
No
currencystringCurrency
Enum: "AFN", "ALL", "DZD", "AOA", "ARS", "AMD", "AWG", "AZN", "BSD", "BHD", "BDT", "BBD", "BYN", "BZD", "BMD", "BTN", "BOB", "BAM", "BRL", "BND", "BGN", "BIF", "KHR", "CAD", "CVE", "KYD", "CLP", "CNY", "COP", "KMF", "CDF", "CRC", "CZK", "HRK", "CUC", "DJF", "DOP", "EGP", "ERN", "ETB", "FKP", "FJD", "XAF", "GMD", "GEL", "GHS", "GIP", "DKK", "GTQ", "GNF", "GYD", "HTG", "HNL", "HKD", "HUF", "ISK", "INR", "IDR", "IRR", "IQD", "JMD", "JPY", "JOD", "KZT", "KES", "KWD", "KGS", "LAK", "LBP", "LSL", "LRD", "LYD", "MOP", "MKD", "MGA", "MWK", "MYR", "MVR", "MRO", "MUR", "MXN", "MDL", "MNT", "MZN", "MMK", "NAD", "NPR", "NIO", "NGN", "KPW", "OMR", "PKR", "ILS", "PAB", "PGK", "PYG", "PEN", "PHP", "PLN", "QAR", "RON", "RUB", "RWF", "SHP", "XCD", "WST", "STD", "SAR", "RSD", "SCR", "SLL", "SGD", "ANG", "SBD", "SOS", "ZAR", "KRW", "SSP", "EUR", "LKR", "SDG", "SRD", "NOK", "SZL", "SEK", "CHF", "SYP", "TWD", "TJS", "TZS", "THB", "XOF", "NZD", "TOP", "TTD", "TND", "TRY", "TMT", "AUD", "UGX", "UAH", "AED", "GBP", "USD", "UYU", "UZS", "VUV", "VEF", "VND", "XPF", "MAD", "YER", "ZMW", "BWP", "CNH"
Example: "SGD"
No
documentDatedateTimePayment Date
Example: "25-10-2019"
No
exchangeRatenumberExchange Rate
Example: 1
No
idlongNo
makePaymentFeeDtoList[ MakePaymentFeeDto ]Transaction fee pertaining to the made paymentNo
makePaymentList[ MakePaymentResponseDtoIsrael ]List of make payments
Example: []
No

MakeBulkPaymentDto«MakePaymentResponseDtoPhilippines,MakePaymentItemResponseDtoPhilippines»

NameTypeDescriptionRequired
amountnumberPayment amount
Example: 100
No
amountInBaseCurrencynumberPayment amount in Base Currency
Example: 100
No
codestringSequence code
Example: "MBP-0000001"
No
contactCodestringContact code.
Example: "C-0000001"
No
contactNamestringContact name.
Example: "ABC PTE LTD"
No
currencystringCurrency
Enum: "AFN", "ALL", "DZD", "AOA", "ARS", "AMD", "AWG", "AZN", "BSD", "BHD", "BDT", "BBD", "BYN", "BZD", "BMD", "BTN", "BOB", "BAM", "BRL", "BND", "BGN", "BIF", "KHR", "CAD", "CVE", "KYD", "CLP", "CNY", "COP", "KMF", "CDF", "CRC", "CZK", "HRK", "CUC", "DJF", "DOP", "EGP", "ERN", "ETB", "FKP", "FJD", "XAF", "GMD", "GEL", "GHS", "GIP", "DKK", "GTQ", "GNF", "GYD", "HTG", "HNL", "HKD", "HUF", "ISK", "INR", "IDR", "IRR", "IQD", "JMD", "JPY", "JOD", "KZT", "KES", "KWD", "KGS", "LAK", "LBP", "LSL", "LRD", "LYD", "MOP", "MKD", "MGA", "MWK", "MYR", "MVR", "MRO", "MUR", "MXN", "MDL", "MNT", "MZN", "MMK", "NAD", "NPR", "NIO", "NGN", "KPW", "OMR", "PKR", "ILS", "PAB", "PGK", "PYG", "PEN", "PHP", "PLN", "QAR", "RON", "RUB", "RWF", "SHP", "XCD", "WST", "STD", "SAR", "RSD", "SCR", "SLL", "SGD", "ANG", "SBD", "SOS", "ZAR", "KRW", "SSP", "EUR", "LKR", "SDG", "SRD", "NOK", "SZL", "SEK", "CHF", "SYP", "TWD", "TJS", "TZS", "THB", "XOF", "NZD", "TOP", "TTD", "TND", "TRY", "TMT", "AUD", "UGX", "UAH", "AED", "GBP", "USD", "UYU", "UZS", "VUV", "VEF", "VND", "XPF", "MAD", "YER", "ZMW", "BWP", "CNH"
Example: "SGD"
No
documentDatedateTimePayment Date
Example: "25-10-2019"
No
exchangeRatenumberExchange Rate
Example: 1
No
idlongNo
makePaymentFeeDtoList[ MakePaymentFeeDto ]Transaction fee pertaining to the made paymentNo
makePaymentList[ MakePaymentResponseDtoPhilippines ]List of make payments
Example: []
No

MakePaymentDto

NameTypeDescriptionRequired
accountCodePayFromstringAccount code.
Example: "AC-001"
No
accountNamestringAccount name.
Example: "Bank"
No
amountnumberPayment amount.
Example: 10
No
amountDuenumberPayment amount Due.
Example: 10
No
attachmentIds[ integer ]list of attachment id's for this orderNo
bankRuleIdlongRule id if the document has been created by a Bank RuleNo
contactCodestringContact code.
Example: 19425
No
contactNamestringContact name.
Example: "ABC PTE LTD"
No
currencystringCurrency code.
Enum: "AFN", "ALL", "DZD", "AOA", "ARS", "AMD", "AWG", "AZN", "BSD", "BHD", "BDT", "BBD", "BYN", "BZD", "BMD", "BTN", "BOB", "BAM", "BRL", "BND", "BGN", "BIF", "KHR", "CAD", "CVE", "KYD", "CLP", "CNY", "COP", "KMF", "CDF", "CRC", "CZK", "HRK", "CUC", "DJF", "DOP", "EGP", "ERN", "ETB", "FKP", "FJD", "XAF", "GMD", "GEL", "GHS", "GIP", "DKK", "GTQ", "GNF", "GYD", "HTG", "HNL", "HKD", "HUF", "ISK", "INR", "IDR", "IRR", "IQD", "JMD", "JPY", "JOD", "KZT", "KES", "KWD", "KGS", "LAK", "LBP", "LSL", "LRD", "LYD", "MOP", "MKD", "MGA", "MWK", "MYR", "MVR", "MRO", "MUR", "MXN", "MDL", "MNT", "MZN", "MMK", "NAD", "NPR", "NIO", "NGN", "KPW", "OMR", "PKR", "ILS", "PAB", "PGK", "PYG", "PEN", "PHP", "PLN", "QAR", "RON", "RUB", "RWF", "SHP", "XCD", "WST", "STD", "SAR", "RSD", "SCR", "SLL", "SGD", "ANG", "SBD", "SOS", "ZAR", "KRW", "SSP", "EUR", "LKR", "SDG", "SRD", "NOK", "SZL", "SEK", "CHF", "SYP", "TWD", "TJS", "TZS", "THB", "XOF", "NZD", "TOP", "TTD", "TND", "TRY", "TMT", "AUD", "UGX", "UAH", "AED", "GBP", "USD", "UYU", "UZS", "VUV", "VEF", "VND", "XPF", "MAD", "YER", "ZMW", "BWP", "CNH"
Example: "SGD"
No
customField[ CustomFieldItem ]List of custom fieldsNo
customerTypeIndiastringIndia Compliance filed
Enum: "EXPORT_WO_PAY", "EXPORT_W_PAY", "NA", "SEZ_WO_PAY", "SEZ_W_PAY"
Example: "SEZ (WPAY)"
No
documentDatedateTimeDocument date.
Example: "2019-09-27"
No
errors[ string ]List of validation error messagesNo
exchangeRatenumberExchange rate.
Example: 0.01891562
No
gstExchangeRatenumberGST Exchange rate if tax residency currency is different than base currency
Example: 1
No
gstInstringNo
gstTreatmentIndiastringIndia Compliance filed
Enum: "REGISTERED_BUSINESS_REGULAR=Registered Business - Regular", "REGISTERED_BUSINESS_COMPOSITION=Registered Business - Composition", "UNREGISTERED_BUSINESS=Unregistered Business", "CUSTOMER=Consumer", "OVERSEAS=Overseas", "SPECIAL_ECONOMIC_ZONE=Special Economic Zone", "DEEMED_EXPORT=Deemed Export"
Example: "REGISTERED_BUSINESS_REGULAR"
No
interCompanybooleanTrue if it is between inter companies
Example: true
No
isTdsPaymentIndiabooleanNo
knockoffInfo[ KnockOffInfo ]No
makePaymentFeeDtoList[ MakePaymentFeeDto ]Transaction fee pertaining to the made paymentNo
makePaymentItemDtoList[ MakePaymentItemDto ]Make payment items information.No
makePaymentRecurringDtoMakePaymentRecurringDtoRecurring payment details.No
memostringMemo text.
Example: "Sales quotation"
No
nextPaymentDatedateTimeNext payment date.
Example: "2019-09-27"
No
openingbooleanOpening Document
Example: false
No
paymentTypestringType of payment.
Enum: "CHEQUE", "CASH", "BANK_TRANSFER", "CARD", "OTHERS"
Example: "BANK_TRANSFER"
No
purchaseInvoicePurchaseInvoiceResponseNo
reconciledbooleanWhether the current payment is reconciled or not.No
recurringActivatedbooleanRecurring payment activated for payment.
Example: false
No
recurringPaymentbooleanRecurring payment enable/disable for payment.
Example: false
No
referenceDatedateTimeDate of Bank Transfer/cheque.
Example: "2019-09-27"
No
referenceNumberstringReference number of Bank Transfer/cheque.
Example: "CH001"
No
statusstringEnum: "PRINT_SUCCESS", "PRINT_FAILURE", "NOT_PRINTED"No
tdsPaymentInfoIndiaTDSPaymentInfoIndiaTDS Payment detailsNo
tdsProcessedFlagbooleanTDS Processed Flag
Example: false
No
unitPriceGstInclusivebooleanPrice is GST inclusive
Example: false
No
vendorTypeIndiastringIndia Compliance filed
Enum: "IMPORT", "NA", "SEZ_W_PAY", "SEZ_WO_PAY"
Example: "EXPORT (WOPAY)"
No

MakePaymentDtoIndia

NameTypeDescriptionRequired
accountCodePayFromstringAccount code.
Example: "AC-001"
No
accountNamestringAccount name.
Example: "Bank"
No
amountnumberPayment amount.
Example: 10
No
amountDuenumberPayment amount Due.
Example: 10
No
attachmentIds[ integer ]list of attachment id's for this orderNo
bankRuleIdlongRule id if the document has been created by a Bank RuleNo
contactCodestringContact code.
Example: 19425
No
contactNamestringContact name.
Example: "ABC PTE LTD"
No
currencystringCurrency code.
Enum: "AFN", "ALL", "DZD", "AOA", "ARS", "AMD", "AWG", "AZN", "BSD", "BHD", "BDT", "BBD", "BYN", "BZD", "BMD", "BTN", "BOB", "BAM", "BRL", "BND", "BGN", "BIF", "KHR", "CAD", "CVE", "KYD", "CLP", "CNY", "COP", "KMF", "CDF", "CRC", "CZK", "HRK", "CUC", "DJF", "DOP", "EGP", "ERN", "ETB", "FKP", "FJD", "XAF", "GMD", "GEL", "GHS", "GIP", "DKK", "GTQ", "GNF", "GYD", "HTG", "HNL", "HKD", "HUF", "ISK", "INR", "IDR", "IRR", "IQD", "JMD", "JPY", "JOD", "KZT", "KES", "KWD", "KGS", "LAK", "LBP", "LSL", "LRD", "LYD", "MOP", "MKD", "MGA", "MWK", "MYR", "MVR", "MRO", "MUR", "MXN", "MDL", "MNT", "MZN", "MMK", "NAD", "NPR", "NIO", "NGN", "KPW", "OMR", "PKR", "ILS", "PAB", "PGK", "PYG", "PEN", "PHP", "PLN", "QAR", "RON", "RUB", "RWF", "SHP", "XCD", "WST", "STD", "SAR", "RSD", "SCR", "SLL", "SGD", "ANG", "SBD", "SOS", "ZAR", "KRW", "SSP", "EUR", "LKR", "SDG", "SRD", "NOK", "SZL", "SEK", "CHF", "SYP", "TWD", "TJS", "TZS", "THB", "XOF", "NZD", "TOP", "TTD", "TND", "TRY", "TMT", "AUD", "UGX", "UAH", "AED", "GBP", "USD", "UYU", "UZS", "VUV", "VEF", "VND", "XPF", "MAD", "YER", "ZMW", "BWP", "CNH"
Example: "SGD"
No
customField[ CustomFieldItem ]List of custom fieldsNo
customerTypeIndiastringIndia Compliance filed
Enum: "EXPORT_WO_PAY", "EXPORT_W_PAY", "NA", "SEZ_WO_PAY", "SEZ_W_PAY"
Example: "SEZ (WPAY)"
No
documentDatedateTimeDocument date.
Example: "2019-09-27"
No
errors[ string ]List of validation error messagesNo
exchangeRatenumberExchange rate.
Example: 0.01891562
No
gstExchangeRatenumberGST Exchange rate if tax residency currency is different than base currency
Example: 1
No
gstInstringNo
gstTreatmentIndiastringIndia Compliance filed
Enum: "REGISTERED_BUSINESS_REGULAR=Registered Business - Regular", "REGISTERED_BUSINESS_COMPOSITION=Registered Business - Composition", "UNREGISTERED_BUSINESS=Unregistered Business", "CUSTOMER=Consumer", "OVERSEAS=Overseas", "SPECIAL_ECONOMIC_ZONE=Special Economic Zone", "DEEMED_EXPORT=Deemed Export"
Example: "REGISTERED_BUSINESS_REGULAR"
No
interCompanybooleanTrue if it is between inter companies
Example: true
No
isTdsPaymentIndiabooleanNo
knockoffInfo[ KnockOffInfo ]No
makePaymentFeeDtoList[ MakePaymentFeeDto ]Transaction fee pertaining to the made paymentNo
makePaymentItemDtoList[ MakePaymentItemDtoIndia ]Make payment items information.No
makePaymentRecurringDtoMakePaymentRecurringDtoRecurring payment details.No
memostringMemo text.
Example: "Sales quotation"
No
nextPaymentDatedateTimeNext payment date.
Example: "2019-09-27"
No
openingbooleanOpening Document
Example: false
No
paymentTypestringType of payment.
Enum: "CHEQUE", "CASH", "BANK_TRANSFER", "CARD", "OTHERS"
Example: "BANK_TRANSFER"
No
reconciledbooleanWhether the current payment is reconciled or not.No
recurringActivatedbooleanRecurring payment activated for payment.
Example: false
No
recurringPaymentbooleanRecurring payment enable/disable for payment.
Example: false
No
referenceDatedateTimeDate of Bank Transfer/cheque.
Example: "2019-09-27"
No
referenceNumberstringReference number of Bank Transfer/cheque.
Example: "CH001"
No
statusstringPrint Status
Enum: "PRINT_SUCCESS", "PRINT_FAILURE", "NOT_PRINTED"
Example: "NOT_PRINTED"
No
tdsPaymentInfoIndiaTDSPaymentInfoIndiaTDS Payment detailsNo
tdsProcessedFlagbooleanTDS Processed Flag
Example: false
No
unitPriceGstInclusivebooleanPrice is GST inclusive
Example: false
No
vendorTypeIndiastringIndia Compliance filed
Enum: "IMPORT", "NA", "SEZ_W_PAY", "SEZ_WO_PAY"
Example: "EXPORT (WOPAY)"
No

MakePaymentDtoIndonesia

NameTypeDescriptionRequired
accountCodePayFromstringAccount code.
Example: "AC-001"
No
accountNamestringAccount name.
Example: "Bank"
No
amountnumberPayment amount.
Example: 10
No
amountDuenumberPayment amount Due.
Example: 10
No
attachmentIds[ integer ]list of attachment id's for this orderNo
bankRuleIdlongRule id if the document has been created by a Bank RuleNo
contactCodestringContact code.
Example: 19425
No
contactNamestringContact name.
Example: "ABC PTE LTD"
No
currencystringCurrency code.
Enum: "AFN", "ALL", "DZD", "AOA", "ARS", "AMD", "AWG", "AZN", "BSD", "BHD", "BDT", "BBD", "BYN", "BZD", "BMD", "BTN", "BOB", "BAM", "BRL", "BND", "BGN", "BIF", "KHR", "CAD", "CVE", "KYD", "CLP", "CNY", "COP", "KMF", "CDF", "CRC", "CZK", "HRK", "CUC", "DJF", "DOP", "EGP", "ERN", "ETB", "FKP", "FJD", "XAF", "GMD", "GEL", "GHS", "GIP", "DKK", "GTQ", "GNF", "GYD", "HTG", "HNL", "HKD", "HUF", "ISK", "INR", "IDR", "IRR", "IQD", "JMD", "JPY", "JOD", "KZT", "KES", "KWD", "KGS", "LAK", "LBP", "LSL", "LRD", "LYD", "MOP", "MKD", "MGA", "MWK", "MYR", "MVR", "MRO", "MUR", "MXN", "MDL", "MNT", "MZN", "MMK", "NAD", "NPR", "NIO", "NGN", "KPW", "OMR", "PKR", "ILS", "PAB", "PGK", "PYG", "PEN", "PHP", "PLN", "QAR", "RON", "RUB", "RWF", "SHP", "XCD", "WST", "STD", "SAR", "RSD", "SCR", "SLL", "SGD", "ANG", "SBD", "SOS", "ZAR", "KRW", "SSP", "EUR", "LKR", "SDG", "SRD", "NOK", "SZL", "SEK", "CHF", "SYP", "TWD", "TJS", "TZS", "THB", "XOF", "NZD", "TOP", "TTD", "TND", "TRY", "TMT", "AUD", "UGX", "UAH", "AED", "GBP", "USD", "UYU", "UZS", "VUV", "VEF", "VND", "XPF", "MAD", "YER", "ZMW", "BWP", "CNH"
Example: "SGD"
No
customField[ CustomFieldItem ]List of custom fieldsNo
customerTypeIndiastringIndia Compliance filed
Enum: "EXPORT_WO_PAY", "EXPORT_W_PAY", "NA", "SEZ_WO_PAY", "SEZ_W_PAY"
Example: "SEZ (WPAY)"
No
documentDatedateTimeDocument date.
Example: "2019-09-27"
No
errors[ string ]List of validation error messagesNo
exchangeRatenumberExchange rate.
Example: 0.01891562
No
gstExchangeRatenumberGST Exchange rate if tax residency currency is different than base currency
Example: 1
No
gstInstringNo
gstTreatmentIndiastringIndia Compliance filed
Enum: "REGISTERED_BUSINESS_REGULAR=Registered Business - Regular", "REGISTERED_BUSINESS_COMPOSITION=Registered Business - Composition", "UNREGISTERED_BUSINESS=Unregistered Business", "CUSTOMER=Consumer", "OVERSEAS=Overseas", "SPECIAL_ECONOMIC_ZONE=Special Economic Zone", "DEEMED_EXPORT=Deemed Export"
Example: "REGISTERED_BUSINESS_REGULAR"
No
interCompanybooleanTrue if it is between inter companies
Example: true
No
isTdsPaymentIndiabooleanNo
knockoffInfo[ KnockOffInfo ]No
makePaymentFeeDtoList[ MakePaymentFeeDto ]Transaction fee pertaining to the made paymentNo
makePaymentItemDtoList[ MakePaymentItemDtoIndonesia ]Make payment items information.No
makePaymentRecurringDtoMakePaymentRecurringDtoRecurring payment details.No
memostringMemo text.
Example: "Sales quotation"
No
nextPaymentDatedateTimeNext payment date.
Example: "2019-09-27"
No
openingbooleanOpening Document
Example: false
No
paymentTypestringType of payment.
Enum: "CHEQUE", "CASH", "BANK_TRANSFER", "CARD", "OTHERS"
Example: "BANK_TRANSFER"
No
reconciledbooleanWhether the current payment is reconciled or not.No
recurringActivatedbooleanRecurring payment activated for payment.
Example: false
No
recurringPaymentbooleanRecurring payment enable/disable for payment.
Example: false
No
referenceDatedateTimeDate of Bank Transfer/cheque.
Example: "2019-09-27"
No
referenceNumberstringReference number of Bank Transfer/cheque.
Example: "CH001"
No
statusstringPrint Status
Enum: "PRINT_SUCCESS", "PRINT_FAILURE", "NOT_PRINTED"
Example: "NOT_PRINTED"
No
tdsPaymentInfoIndiaTDSPaymentInfoIndiaTDS Payment detailsNo
tdsProcessedFlagbooleanTDS Processed Flag
Example: false
No
unitPriceGstInclusivebooleanPrice is GST inclusive
Example: false
No
vendorTypeIndiastringIndia Compliance filed
Enum: "IMPORT", "NA", "SEZ_W_PAY", "SEZ_WO_PAY"
Example: "EXPORT (WOPAY)"
No
whtApplicablebooleanWHT Applicable for make payment
Example: true
No

MakePaymentDtoIsrael

NameTypeDescriptionRequired
accountCodePayFromstringAccount code.
Example: "AC-001"
No
accountNamestringAccount name.
Example: "Bank"
No
amountnumberPayment amount.
Example: 10
No
amountDuenumberPayment amount Due.
Example: 10
No
attachmentIds[ integer ]list of attachment id's for this orderNo
bankRuleIdlongRule id if the document has been created by a Bank RuleNo
contactCodestringContact code.
Example: 19425
No
contactNamestringContact name.
Example: "ABC PTE LTD"
No
currencystringCurrency code.
Enum: "AFN", "ALL", "DZD", "AOA", "ARS", "AMD", "AWG", "AZN", "BSD", "BHD", "BDT", "BBD", "BYN", "BZD", "BMD", "BTN", "BOB", "BAM", "BRL", "BND", "BGN", "BIF", "KHR", "CAD", "CVE", "KYD", "CLP", "CNY", "COP", "KMF", "CDF", "CRC", "CZK", "HRK", "CUC", "DJF", "DOP", "EGP", "ERN", "ETB", "FKP", "FJD", "XAF", "GMD", "GEL", "GHS", "GIP", "DKK", "GTQ", "GNF", "GYD", "HTG", "HNL", "HKD", "HUF", "ISK", "INR", "IDR", "IRR", "IQD", "JMD", "JPY", "JOD", "KZT", "KES", "KWD", "KGS", "LAK", "LBP", "LSL", "LRD", "LYD", "MOP", "MKD", "MGA", "MWK", "MYR", "MVR", "MRO", "MUR", "MXN", "MDL", "MNT", "MZN", "MMK", "NAD", "NPR", "NIO", "NGN", "KPW", "OMR", "PKR", "ILS", "PAB", "PGK", "PYG", "PEN", "PHP", "PLN", "QAR", "RON", "RUB", "RWF", "SHP", "XCD", "WST", "STD", "SAR", "RSD", "SCR", "SLL", "SGD", "ANG", "SBD", "SOS", "ZAR", "KRW", "SSP", "EUR", "LKR", "SDG", "SRD", "NOK", "SZL", "SEK", "CHF", "SYP", "TWD", "TJS", "TZS", "THB", "XOF", "NZD", "TOP", "TTD", "TND", "TRY", "TMT", "AUD", "UGX", "UAH", "AED", "GBP", "USD", "UYU", "UZS", "VUV", "VEF", "VND", "XPF", "MAD", "YER", "ZMW", "BWP", "CNH"
Example: "SGD"
No
customField[ CustomFieldItem ]List of custom fieldsNo
customerTypeIndiastringIndia Compliance filed
Enum: "EXPORT_WO_PAY", "EXPORT_W_PAY", "NA", "SEZ_WO_PAY", "SEZ_W_PAY"
Example: "SEZ (WPAY)"
No
documentDatedateTimeDocument date.
Example: "2019-09-27"
No
errors[ string ]List of validation error messagesNo
exchangeRatenumberExchange rate.
Example: 0.01891562
No
gstExchangeRatenumberGST Exchange rate if tax residency currency is different than base currency
Example: 1
No
gstInstringNo
gstTreatmentIndiastringIndia Compliance filed
Enum: "REGISTERED_BUSINESS_REGULAR=Registered Business - Regular", "REGISTERED_BUSINESS_COMPOSITION=Registered Business - Composition", "UNREGISTERED_BUSINESS=Unregistered Business", "CUSTOMER=Consumer", "OVERSEAS=Overseas", "SPECIAL_ECONOMIC_ZONE=Special Economic Zone", "DEEMED_EXPORT=Deemed Export"
Example: "REGISTERED_BUSINESS_REGULAR"
No
interCompanybooleanTrue if it is between inter companies
Example: true
No
isTdsPaymentIndiabooleanNo
knockoffInfo[ KnockOffInfo ]No
makePaymentFeeDtoList[ MakePaymentFeeDto ]Transaction fee pertaining to the made paymentNo
makePaymentItemDtoList[ MakePaymentItemDtoIsrael ]Make payment items information.No
makePaymentRecurringDtoMakePaymentRecurringDtoRecurring payment details.No
memostringMemo text.
Example: "Sales quotation"
No
nextPaymentDatedateTimeNext payment date.
Example: "2019-09-27"
No
openingbooleanOpening Document
Example: false
No
paymentTypestringType of payment.
Enum: "CHEQUE", "CASH", "BANK_TRANSFER", "CARD", "OTHERS"
Example: "BANK_TRANSFER"
No
reconciledbooleanWhether the current payment is reconciled or not.No
recurringActivatedbooleanRecurring payment activated for payment.
Example: false
No
recurringPaymentbooleanRecurring payment enable/disable for payment.
Example: false
No
referenceDatedateTimeDate of Bank Transfer/cheque.
Example: "2019-09-27"
No
referenceNumberstringReference number of Bank Transfer/cheque.
Example: "CH001"
No
statusstringPrint Status
Enum: "PRINT_SUCCESS", "PRINT_FAILURE", "NOT_PRINTED"
Example: "NOT_PRINTED"
No
tdsPaymentInfoIndiaTDSPaymentInfoIndiaTDS Payment detailsNo
tdsProcessedFlagbooleanTDS Processed Flag
Example: false
No
unitPriceGstInclusivebooleanPrice is GST inclusive
Example: false
No
vendorTypeIndiastringIndia Compliance filed
Enum: "IMPORT", "NA", "SEZ_W_PAY", "SEZ_WO_PAY"
Example: "EXPORT (WOPAY)"
No
whtApplicablebooleanWHT Applicable for make payment
Example: true
No
whtInfoIsraelWhtInfoIsraelWHT info for make paymentNo

MakePaymentDtoPhilippines

NameTypeDescriptionRequired
accountCodePayFromstringAccount code.
Example: "AC-001"
No
accountNamestringAccount name.
Example: "Bank"
No
amountnumberPayment amount.
Example: 10
No
amountDuenumberPayment amount Due.
Example: 10
No
attachmentIds[ integer ]list of attachment id's for this orderNo
bankRuleIdlongRule id if the document has been created by a Bank RuleNo
contactCodestringContact code.
Example: 19425
No
contactNamestringContact name.
Example: "ABC PTE LTD"
No
currencystringCurrency code.
Enum: "AFN", "ALL", "DZD", "AOA", "ARS", "AMD", "AWG", "AZN", "BSD", "BHD", "BDT", "BBD", "BYN", "BZD", "BMD", "BTN", "BOB", "BAM", "BRL", "BND", "BGN", "BIF", "KHR", "CAD", "CVE", "KYD", "CLP", "CNY", "COP", "KMF", "CDF", "CRC", "CZK", "HRK", "CUC", "DJF", "DOP", "EGP", "ERN", "ETB", "FKP", "FJD", "XAF", "GMD", "GEL", "GHS", "GIP", "DKK", "GTQ", "GNF", "GYD", "HTG", "HNL", "HKD", "HUF", "ISK", "INR", "IDR", "IRR", "IQD", "JMD", "JPY", "JOD", "KZT", "KES", "KWD", "KGS", "LAK", "LBP", "LSL", "LRD", "LYD", "MOP", "MKD", "MGA", "MWK", "MYR", "MVR", "MRO", "MUR", "MXN", "MDL", "MNT", "MZN", "MMK", "NAD", "NPR", "NIO", "NGN", "KPW", "OMR", "PKR", "ILS", "PAB", "PGK", "PYG", "PEN", "PHP", "PLN", "QAR", "RON", "RUB", "RWF", "SHP", "XCD", "WST", "STD", "SAR", "RSD", "SCR", "SLL", "SGD", "ANG", "SBD", "SOS", "ZAR", "KRW", "SSP", "EUR", "LKR", "SDG", "SRD", "NOK", "SZL", "SEK", "CHF", "SYP", "TWD", "TJS", "TZS", "THB", "XOF", "NZD", "TOP", "TTD", "TND", "TRY", "TMT", "AUD", "UGX", "UAH", "AED", "GBP", "USD", "UYU", "UZS", "VUV", "VEF", "VND", "XPF", "MAD", "YER", "ZMW", "BWP", "CNH"
Example: "SGD"
No
customField[ CustomFieldItem ]List of custom fieldsNo
customerTypeIndiastringIndia Compliance filed
Enum: "EXPORT_WO_PAY", "EXPORT_W_PAY", "NA", "SEZ_WO_PAY", "SEZ_W_PAY"
Example: "SEZ (WPAY)"
No
documentDatedateTimeDocument date.
Example: "2019-09-27"
No
errors[ string ]List of validation error messagesNo
exchangeRatenumberExchange rate.
Example: 0.01891562
No
gstExchangeRatenumberGST Exchange rate if tax residency currency is different than base currency
Example: 1
No
gstInstringNo
gstTreatmentIndiastringIndia Compliance filed
Enum: "REGISTERED_BUSINESS_REGULAR=Registered Business - Regular", "REGISTERED_BUSINESS_COMPOSITION=Registered Business - Composition", "UNREGISTERED_BUSINESS=Unregistered Business", "CUSTOMER=Consumer", "OVERSEAS=Overseas", "SPECIAL_ECONOMIC_ZONE=Special Economic Zone", "DEEMED_EXPORT=Deemed Export"
Example: "REGISTERED_BUSINESS_REGULAR"
No
interCompanybooleanTrue if it is between inter companies
Example: true
No
isTdsPaymentIndiabooleanNo
knockoffInfo[ KnockOffInfo ]No
makePaymentFeeDtoList[ MakePaymentFeeDto ]Transaction fee pertaining to the made paymentNo
makePaymentItemDtoList[ MakePaymentItemDtoPhilippines ]Make payment items information.No
makePaymentRecurringDtoMakePaymentRecurringDtoRecurring payment details.No
memostringMemo text.
Example: "Sales quotation"
No
nextPaymentDatedateTimeNext payment date.
Example: "2019-09-27"
No
openingbooleanOpening Document
Example: false
No
paymentTypestringType of payment.
Enum: "CHEQUE", "CASH", "BANK_TRANSFER", "CARD", "OTHERS"
Example: "BANK_TRANSFER"
No
reconciledbooleanWhether the current payment is reconciled or not.No
recurringActivatedbooleanRecurring payment activated for payment.
Example: false
No
recurringPaymentbooleanRecurring payment enable/disable for payment.
Example: false
No
referenceDatedateTimeDate of Bank Transfer/cheque.
Example: "2019-09-27"
No
referenceNumberstringReference number of Bank Transfer/cheque.
Example: "CH001"
No
statusstringPrint Status
Enum: "PRINT_SUCCESS", "PRINT_FAILURE", "NOT_PRINTED"
Example: "NOT_PRINTED"
No
tdsPaymentInfoIndiaTDSPaymentInfoIndiaTDS Payment detailsNo
tdsProcessedFlagbooleanTDS Processed Flag
Example: false
No
unitPriceGstInclusivebooleanPrice is GST inclusive
Example: false
No
vendorTypeIndiastringIndia Compliance filed
Enum: "IMPORT", "NA", "SEZ_W_PAY", "SEZ_WO_PAY"
Example: "EXPORT (WOPAY)"
No
whtApplicablebooleanWHT Applicable for make payment
Example: true
No

MakePaymentFeeDto

NameTypeDescriptionRequired
MakePaymentFeeDtoobject

MakePaymentItemDto

NameTypeDescriptionRequired
accountNamestringAccount name.
Example: "Bank"
No
customField[ CustomFieldItem ]List of custom fieldsNo
descriptionstringDescription of document.
Example: "General ledger for account."
No
documentCodestringDocument code.
Example: "AC-001"
No
documentSequenceCodestringDocument Sequence code.
Example: "AC-001"
No
documentTypestringDocument type.
Example: "General Ledger"
No
exchangeRatenumberExchange rate.
Example: 0.01891562
No
isTdsApplicableAccountbooleanNo
isTdsApplicableContactbooleanNo
paymentAmountnumberPayment amount.
Example: 10.5
No
taxAmountnumberTax amount.
Example: 0.7
No
taxCodestringTax code.
Example: "GST@7"
No
taxList[ TaxMappingDto ]No
tdsAccountstringTds Account Code
Example: "AC-0000011"
No
tdsAmountnumberTDS Amount
Example: 100
No
tdsInfoIndiaTdsInfoIndiaPre-Payment TDS detailsNo
tdsRatenumberTDS Rate
Example: 10.1
No

MakePaymentItemDtoIndia

NameTypeDescriptionRequired
accountNamestringAccount name.
Example: "Bank"
No
customField[ CustomFieldItem ]List of custom fieldsNo
descriptionstringDescription of document.
Example: "General ledger for account."
No
documentCodestringDocument code.
Example: "AC-001"
No
documentSequenceCodestringDocument Sequence code.
Example: "AC-001"
No
documentTypestringDocument type.
Example: "General Ledger"
No
exchangeRatenumberExchange rate.
Example: 0.01891562
No
isTdsApplicableAccountbooleanNo
isTdsApplicableContactbooleanNo
paymentAmountnumberPayment amount.
Example: 10.5
No
taxAmountnumberTax amount.
Example: 0.7
No
taxCodestringTax code.
Example: "GST@7"
No
taxList[ TaxMappingDto ]No
tdsAccountstringTds Account Code
Example: "AC-0000011"
No
tdsAmountnumberTDS Amount
Example: 100
No
tdsInfoIndiaTdsInfoIndiaPre-Payment TDS detailsNo
tdsRatenumberTDS Rate
Example: 10.1
No

MakePaymentItemDtoIndonesia

NameTypeDescriptionRequired
accountNamestringAccount name.
Example: "Bank"
No
customField[ CustomFieldItem ]List of custom fieldsNo
descriptionstringDescription of document.
Example: "General ledger for account."
No
documentCodestringDocument code.
Example: "AC-001"
No
documentSequenceCodestringDocument Sequence code.
Example: "AC-001"
No
documentTypestringDocument type.
Example: "General Ledger"
No
exchangeRatenumberExchange rate.
Example: 0.01891562
No
isTdsApplicableAccountbooleanNo
isTdsApplicableContactbooleanNo
paymentAmountnumberPayment amount.
Example: 10.5
No
taxAmountnumberTax amount.
Example: 0.7
No
taxCodestringTax code.
Example: "GST@7"
No
taxList[ TaxMappingDto ]No
tdsAccountstringTds Account Code
Example: "AC-0000011"
No
tdsAmountnumberTDS Amount
Example: 100
No
tdsInfoIndiaTdsInfoIndiaPre-Payment TDS detailsNo
tdsRatenumberTDS Rate
Example: 10.1
No

MakePaymentItemDtoIsrael

NameTypeDescriptionRequired
accountNamestringAccount name.
Example: "Bank"
No
customField[ CustomFieldItem ]List of custom fieldsNo
descriptionstringDescription of document.
Example: "General ledger for account."
No
documentCodestringDocument code.
Example: "AC-001"
No
documentSequenceCodestringDocument Sequence code.
Example: "AC-001"
No
documentTypestringDocument type.
Example: "General Ledger"
No
exchangeRatenumberExchange rate.
Example: 0.01891562
No
isTdsApplicableAccountbooleanNo
isTdsApplicableContactbooleanNo
paymentAmountnumberPayment amount.
Example: 10.5
No
taxAmountnumberTax amount.
Example: 0.7
No
taxCodestringTax code.
Example: "GST@7"
No
taxList[ TaxMappingDto ]No
tdsAccountstringTds Account Code
Example: "AC-0000011"
No
tdsAmountnumberTDS Amount
Example: 100
No
tdsInfoIndiaTdsInfoIndiaPre-Payment TDS detailsNo
tdsRatenumberTDS Rate
Example: 10.1
No

MakePaymentItemDtoPhilippines

NameTypeDescriptionRequired
accountNamestringAccount name.
Example: "Bank"
No
customField[ CustomFieldItem ]List of custom fieldsNo
descriptionstringDescription of document.
Example: "General ledger for account."
No
documentCodestringDocument code.
Example: "AC-001"
No
documentSequenceCodestringDocument Sequence code.
Example: "AC-001"
No
documentTypestringDocument type.
Example: "General Ledger"
No
exchangeRatenumberExchange rate.
Example: 0.01891562
No
isTdsApplicableAccountbooleanNo
isTdsApplicableContactbooleanNo
paymentAmountnumberPayment amount.
Example: 10.5
No
taxAmountnumberTax amount.
Example: 0.7
No
taxCodestringTax code.
Example: "GST@7"
No
taxList[ TaxMappingDto ]No
tdsAccountstringTds Account Code
Example: "AC-0000011"
No
tdsAmountnumberTDS Amount
Example: 100
No
tdsInfoIndiaTdsInfoIndiaPre-Payment TDS detailsNo
tdsRatenumberTDS Rate
Example: 10.1
No

MakePaymentItemResponseDto

NameTypeDescriptionRequired
accountNamestringAccount name.
Example: "Bank"
No
customField[ CustomFieldItem ]List of custom fieldsNo
descriptionstringDescription of document.
Example: "General ledger for account."
No
documentCodestringDocument code.
Example: "AC-001"
No
documentSequenceCodestringDocument Sequence code.
Example: "AC-001"
No
documentTypestringDocument type.
Example: "General Ledger"
No
exchangeRatenumberExchange rate.
Example: 0.01891562
No
isTdsApplicableAccountbooleanNo
isTdsApplicableContactbooleanNo
paymentAmountnumberPayment amount.
Example: 10.5
No
taxAmountnumberTax amount.
Example: 0.7
No
taxCodestringTax code.
Example: "GST@7"
No
taxList[ TaxMappingDto ]No
tdsAccountstringTds Account Code
Example: "AC-0000011"
No
tdsAmountnumberTDS Amount
Example: 100
No
tdsInfoIndiaTdsInfoIndiaPre-Payment TDS detailsNo
tdsRatenumberTDS Rate
Example: 10.1
No

MakePaymentItemResponseDtoIndia

NameTypeDescriptionRequired
accountNamestringAccount name.
Example: "Bank"
No
customField[ CustomFieldItem ]List of custom fieldsNo
descriptionstringDescription of document.
Example: "General ledger for account."
No
documentCodestringDocument code.
Example: "AC-001"
No
documentSequenceCodestringDocument Sequence code.
Example: "AC-001"
No
documentTypestringDocument type.
Example: "General Ledger"
No
exchangeRatenumberExchange rate.
Example: 0.01891562
No
isTdsApplicableAccountbooleanNo
isTdsApplicableContactbooleanNo
paymentAmountnumberPayment amount.
Example: 10.5
No
taxAmountnumberTax amount.
Example: 0.7
No
taxCodestringTax code.
Example: "GST@7"
No
taxList[ TaxMappingDto ]No
tdsAccountstringTds Account Code
Example: "AC-0000011"
No
tdsAmountnumberTDS Amount
Example: 100
No
tdsInfoIndiaTdsInfoIndiaPre-Payment TDS detailsNo
tdsRatenumberTDS Rate
Example: 10.1
No

MakePaymentItemResponseDtoIndonesia

NameTypeDescriptionRequired
accountNamestringAccount name.
Example: "Bank"
No
customField[ CustomFieldItem ]List of custom fieldsNo
descriptionstringDescription of document.
Example: "General ledger for account."
No
documentCodestringDocument code.
Example: "AC-001"
No
documentSequenceCodestringDocument Sequence code.
Example: "AC-001"
No
documentTypestringDocument type.
Example: "General Ledger"
No
exchangeRatenumberExchange rate.
Example: 0.01891562
No
isTdsApplicableAccountbooleanNo
isTdsApplicableContactbooleanNo
paymentAmountnumberPayment amount.
Example: 10.5
No
taxAmountnumberTax amount.
Example: 0.7
No
taxCodestringTax code.
Example: "GST@7"
No
taxList[ TaxMappingDto ]No
tdsAccountstringTds Account Code
Example: "AC-0000011"
No
tdsAmountnumberTDS Amount
Example: 100
No
tdsInfoIndiaTdsInfoIndiaPre-Payment TDS detailsNo
tdsRatenumberTDS Rate
Example: 10.1
No
whtRateInfo[ WHTRateInfo ]Line items - WHT Rates information.
Example: [{"accountCode":"AC-001","productCode":"P-001","whtAmount":20,"rate":2,"whtSectionToWhtRateId":100}]
No

MakePaymentItemResponseDtoIsrael

NameTypeDescriptionRequired
accountNamestringAccount name.
Example: "Bank"
No
customField[ CustomFieldItem ]List of custom fieldsNo
descriptionstringDescription of document.
Example: "General ledger for account."
No
documentCodestringDocument code.
Example: "AC-001"
No
documentSequenceCodestringDocument Sequence code.
Example: "AC-001"
No
documentTypestringDocument type.
Example: "General Ledger"
No
exchangeRatenumberExchange rate.
Example: 0.01891562
No
isTdsApplicableAccountbooleanNo
isTdsApplicableContactbooleanNo
paymentAmountnumberPayment amount.
Example: 10.5
No
taxAmountnumberTax amount.
Example: 0.7
No
taxCodestringTax code.
Example: "GST@7"
No
taxList[ TaxMappingDto ]No
tdsAccountstringTds Account Code
Example: "AC-0000011"
No
tdsAmountnumberTDS Amount
Example: 100
No
tdsInfoIndiaTdsInfoIndiaPre-Payment TDS detailsNo
tdsRatenumberTDS Rate
Example: 10.1
No

MakePaymentItemResponseDtoPhilippines

NameTypeDescriptionRequired
accountNamestringAccount name.
Example: "Bank"
No
customField[ CustomFieldItem ]List of custom fieldsNo
descriptionstringDescription of document.
Example: "General ledger for account."
No
documentCodestringDocument code.
Example: "AC-001"
No
documentSequenceCodestringDocument Sequence code.
Example: "AC-001"
No
documentTypestringDocument type.
Example: "General Ledger"
No
exchangeRatenumberExchange rate.
Example: 0.01891562
No
isTdsApplicableAccountbooleanNo
isTdsApplicableContactbooleanNo
paymentAmountnumberPayment amount.
Example: 10.5
No
taxAmountnumberTax amount.
Example: 0.7
No
taxCodestringTax code.
Example: "GST@7"
No
taxList[ TaxMappingDto ]No
tdsAccountstringTds Account Code
Example: "AC-0000011"
No
tdsAmountnumberTDS Amount
Example: 100
No
tdsInfoIndiaTdsInfoIndiaPre-Payment TDS detailsNo
tdsRatenumberTDS Rate
Example: 10.1
No
whtRateInfo[ WHTRateInfo ]Line items - WHT Rates information.
Example: [{"accountCode":"AC-001","productCode":"P-001","whtAmount":20,"rate":2,"whtSectionToWhtRateId":100}]
No

MakePaymentRecurringDto

NameTypeDescriptionRequired
paymentMemoPaymentMemoRecurring payment memo.
Example: "payment memo"
No
recurringEndDatedateTimeRecurring payment end date.
Example: "2019-09-27"
No
recurringFrequencyintegerRecurring frequency.
Example: 1
No
recurringPaymentCountintegerRecurring payment count.
Example: 2
No
recurringTypestringRecurring type.
Enum: "DAYS", "WEEK", "MONTH"
Example: "WEEK"
No

MakePaymentResponseDto

NameTypeDescriptionRequired
accountCodePayFromstringAccount code.
Example: "AC-001"
No
accountNamestringAccount name.
Example: "Bank"
No
amountnumberPayment amount.
Example: 10
No
amountDuenumberPayment amount Due.
Example: 10
No
attachmentIds[ integer ]list of attachment id's for this orderNo
bankRuleIdlongRule id if the document has been created by a Bank RuleNo
contactCodestringContact code.
Example: 19425
No
contactNamestringContact name.
Example: "ABC PTE LTD"
No
currencystringCurrency code.
Enum: "AFN", "ALL", "DZD", "AOA", "ARS", "AMD", "AWG", "AZN", "BSD", "BHD", "BDT", "BBD", "BYN", "BZD", "BMD", "BTN", "BOB", "BAM", "BRL", "BND", "BGN", "BIF", "KHR", "CAD", "CVE", "KYD", "CLP", "CNY", "COP", "KMF", "CDF", "CRC", "CZK", "HRK", "CUC", "DJF", "DOP", "EGP", "ERN", "ETB", "FKP", "FJD", "XAF", "GMD", "GEL", "GHS", "GIP", "DKK", "GTQ", "GNF", "GYD", "HTG", "HNL", "HKD", "HUF", "ISK", "INR", "IDR", "IRR", "IQD", "JMD", "JPY", "JOD", "KZT", "KES", "KWD", "KGS", "LAK", "LBP", "LSL", "LRD", "LYD", "MOP", "MKD", "MGA", "MWK", "MYR", "MVR", "MRO", "MUR", "MXN", "MDL", "MNT", "MZN", "MMK", "NAD", "NPR", "NIO", "NGN", "KPW", "OMR", "PKR", "ILS", "PAB", "PGK", "PYG", "PEN", "PHP", "PLN", "QAR", "RON", "RUB", "RWF", "SHP", "XCD", "WST", "STD", "SAR", "RSD", "SCR", "SLL", "SGD", "ANG", "SBD", "SOS", "ZAR", "KRW", "SSP", "EUR", "LKR", "SDG", "SRD", "NOK", "SZL", "SEK", "CHF", "SYP", "TWD", "TJS", "TZS", "THB", "XOF", "NZD", "TOP", "TTD", "TND", "TRY", "TMT", "AUD", "UGX", "UAH", "AED", "GBP", "USD", "UYU", "UZS", "VUV", "VEF", "VND", "XPF", "MAD", "YER", "ZMW", "BWP", "CNH"
Example: "SGD"
No
customField[ CustomFieldItem ]List of custom fieldsNo
customerTypeIndiastringIndia Compliance filed
Enum: "EXPORT_WO_PAY", "EXPORT_W_PAY", "NA", "SEZ_WO_PAY", "SEZ_W_PAY"
Example: "SEZ (WPAY)"
No
documentDatedateTimeDocument date.
Example: "2019-09-27"
No
errors[ string ]List of validation error messagesNo
exchangeRatenumberExchange rate.
Example: 0.01891562
No
gstExchangeRatenumberGST Exchange rate if tax residency currency is different than base currency
Example: 1
No
gstInstringNo
gstTreatmentIndiastringIndia Compliance filed
Enum: "REGISTERED_BUSINESS_REGULAR=Registered Business - Regular", "REGISTERED_BUSINESS_COMPOSITION=Registered Business - Composition", "UNREGISTERED_BUSINESS=Unregistered Business", "CUSTOMER=Consumer", "OVERSEAS=Overseas", "SPECIAL_ECONOMIC_ZONE=Special Economic Zone", "DEEMED_EXPORT=Deemed Export"
Example: "REGISTERED_BUSINESS_REGULAR"
No
interCompanybooleanTrue if it is between inter companies
Example: true
No
isTdsPaymentIndiabooleanNo
knockoffInfo[ KnockOffInfo ]No
makePaymentFeeDtoList[ MakePaymentFeeDto ]Transaction fee pertaining to the made paymentNo
makePaymentItemDtoList[ MakePaymentItemResponseDto ]Make payment items information.No
makePaymentRecurringDtoMakePaymentRecurringDtoRecurring payment details.No
memostringMemo text.
Example: "Sales quotation"
No
nextPaymentDatedateTimeNext payment date.
Example: "2019-09-27"
No
openingbooleanOpening Document
Example: false
No
paymentTypestringType of payment.
Enum: "CHEQUE", "CASH", "BANK_TRANSFER", "CARD", "OTHERS"
Example: "BANK_TRANSFER"
No
reconciledbooleanWhether the current payment is reconciled or not.No
recurringActivatedbooleanRecurring payment activated for payment.
Example: false
No
recurringPaymentbooleanRecurring payment enable/disable for payment.
Example: false
No
referenceDatedateTimeDate of Bank Transfer/cheque.
Example: "2019-09-27"
No
referenceNumberstringReference number of Bank Transfer/cheque.
Example: "CH001"
No
statusstringPrint Status
Enum: "PRINT_SUCCESS", "PRINT_FAILURE", "NOT_PRINTED"
Example: "NOT_PRINTED"
No
tdsPaymentInfoIndiaTDSPaymentInfoIndiaTDS Payment detailsNo
tdsProcessedFlagbooleanTDS Processed Flag
Example: false
No
unitPriceGstInclusivebooleanPrice is GST inclusive
Example: false
No
vendorTypeIndiastringIndia Compliance filed
Enum: "IMPORT", "NA", "SEZ_W_PAY", "SEZ_WO_PAY"
Example: "EXPORT (WOPAY)"
No
whtApplicablebooleanNo

MakePaymentResponseDtoIndia

NameTypeDescriptionRequired
accountCodePayFromstringAccount code.
Example: "AC-001"
No
accountNamestringAccount name.
Example: "Bank"
No
amountnumberPayment amount.
Example: 10
No
amountDuenumberPayment amount Due.
Example: 10
No
attachmentIds[ integer ]list of attachment id's for this orderNo
bankRuleIdlongRule id if the document has been created by a Bank RuleNo
contactCodestringContact code.
Example: 19425
No
contactNamestringContact name.
Example: "ABC PTE LTD"
No
currencystringCurrency code.
Enum: "AFN", "ALL", "DZD", "AOA", "ARS", "AMD", "AWG", "AZN", "BSD", "BHD", "BDT", "BBD", "BYN", "BZD", "BMD", "BTN", "BOB", "BAM", "BRL", "BND", "BGN", "BIF", "KHR", "CAD", "CVE", "KYD", "CLP", "CNY", "COP", "KMF", "CDF", "CRC", "CZK", "HRK", "CUC", "DJF", "DOP", "EGP", "ERN", "ETB", "FKP", "FJD", "XAF", "GMD", "GEL", "GHS", "GIP", "DKK", "GTQ", "GNF", "GYD", "HTG", "HNL", "HKD", "HUF", "ISK", "INR", "IDR", "IRR", "IQD", "JMD", "JPY", "JOD", "KZT", "KES", "KWD", "KGS", "LAK", "LBP", "LSL", "LRD", "LYD", "MOP", "MKD", "MGA", "MWK", "MYR", "MVR", "MRO", "MUR", "MXN", "MDL", "MNT", "MZN", "MMK", "NAD", "NPR", "NIO", "NGN", "KPW", "OMR", "PKR", "ILS", "PAB", "PGK", "PYG", "PEN", "PHP", "PLN", "QAR", "RON", "RUB", "RWF", "SHP", "XCD", "WST", "STD", "SAR", "RSD", "SCR", "SLL", "SGD", "ANG", "SBD", "SOS", "ZAR", "KRW", "SSP", "EUR", "LKR", "SDG", "SRD", "NOK", "SZL", "SEK", "CHF", "SYP", "TWD", "TJS", "TZS", "THB", "XOF", "NZD", "TOP", "TTD", "TND", "TRY", "TMT", "AUD", "UGX", "UAH", "AED", "GBP", "USD", "UYU", "UZS", "VUV", "VEF", "VND", "XPF", "MAD", "YER", "ZMW", "BWP", "CNH"
Example: "SGD"
No
customField[ CustomFieldItem ]List of custom fieldsNo
customerTypeIndiastringIndia Compliance filed
Enum: "EXPORT_WO_PAY", "EXPORT_W_PAY", "NA", "SEZ_WO_PAY", "SEZ_W_PAY"
Example: "SEZ (WPAY)"
No
documentDatedateTimeDocument date.
Example: "2019-09-27"
No
errors[ string ]List of validation error messagesNo
exchangeRatenumberExchange rate.
Example: 0.01891562
No
gstExchangeRatenumberGST Exchange rate if tax residency currency is different than base currency
Example: 1
No
gstInstringNo
gstTreatmentIndiastringIndia Compliance filed
Enum: "REGISTERED_BUSINESS_REGULAR=Registered Business - Regular", "REGISTERED_BUSINESS_COMPOSITION=Registered Business - Composition", "UNREGISTERED_BUSINESS=Unregistered Business", "CUSTOMER=Consumer", "OVERSEAS=Overseas", "SPECIAL_ECONOMIC_ZONE=Special Economic Zone", "DEEMED_EXPORT=Deemed Export"
Example: "REGISTERED_BUSINESS_REGULAR"
No
interCompanybooleanTrue if it is between inter companies
Example: true
No
isTdsPaymentIndiabooleanNo
knockoffInfo[ KnockOffInfo ]No
makePaymentFeeDtoList[ MakePaymentFeeDto ]Transaction fee pertaining to the made paymentNo
makePaymentItemDtoList[ MakePaymentItemResponseDtoIndia ]Make payment items information.No
makePaymentRecurringDtoMakePaymentRecurringDtoRecurring payment details.No
memostringMemo text.
Example: "Sales quotation"
No
nextPaymentDatedateTimeNext payment date.
Example: "2019-09-27"
No
openingbooleanOpening Document
Example: false
No
paymentTypestringType of payment.
Enum: "CHEQUE", "CASH", "BANK_TRANSFER", "CARD", "OTHERS"
Example: "BANK_TRANSFER"
No
reconciledbooleanWhether the current payment is reconciled or not.No
recurringActivatedbooleanRecurring payment activated for payment.
Example: false
No
recurringPaymentbooleanRecurring payment enable/disable for payment.
Example: false
No
referenceDatedateTimeDate of Bank Transfer/cheque.
Example: "2019-09-27"
No
referenceNumberstringReference number of Bank Transfer/cheque.
Example: "CH001"
No
statusstringPrint Status
Enum: "PRINT_SUCCESS", "PRINT_FAILURE", "NOT_PRINTED"
Example: "NOT_PRINTED"
No
tdsPaymentInfoIndiaTDSPaymentInfoIndiaTDS Payment detailsNo
tdsProcessedFlagbooleanTDS Processed Flag
Example: false
No
unitPriceGstInclusivebooleanPrice is GST inclusive
Example: false
No
vendorTypeIndiastringIndia Compliance filed
Enum: "IMPORT", "NA", "SEZ_W_PAY", "SEZ_WO_PAY"
Example: "EXPORT (WOPAY)"
No

MakePaymentResponseDtoIndonesia

NameTypeDescriptionRequired
accountCodePayFromstringAccount code.
Example: "AC-001"
No
accountNamestringAccount name.
Example: "Bank"
No
amountnumberPayment amount.
Example: 10
No
amountDuenumberPayment amount Due.
Example: 10
No
attachmentIds[ integer ]list of attachment id's for this orderNo
bankRuleIdlongRule id if the document has been created by a Bank RuleNo
contactCodestringContact code.
Example: 19425
No
contactNamestringContact name.
Example: "ABC PTE LTD"
No
currencystringCurrency code.
Enum: "AFN", "ALL", "DZD", "AOA", "ARS", "AMD", "AWG", "AZN", "BSD", "BHD", "BDT", "BBD", "BYN", "BZD", "BMD", "BTN", "BOB", "BAM", "BRL", "BND", "BGN", "BIF", "KHR", "CAD", "CVE", "KYD", "CLP", "CNY", "COP", "KMF", "CDF", "CRC", "CZK", "HRK", "CUC", "DJF", "DOP", "EGP", "ERN", "ETB", "FKP", "FJD", "XAF", "GMD", "GEL", "GHS", "GIP", "DKK", "GTQ", "GNF", "GYD", "HTG", "HNL", "HKD", "HUF", "ISK", "INR", "IDR", "IRR", "IQD", "JMD", "JPY", "JOD", "KZT", "KES", "KWD", "KGS", "LAK", "LBP", "LSL", "LRD", "LYD", "MOP", "MKD", "MGA", "MWK", "MYR", "MVR", "MRO", "MUR", "MXN", "MDL", "MNT", "MZN", "MMK", "NAD", "NPR", "NIO", "NGN", "KPW", "OMR", "PKR", "ILS", "PAB", "PGK", "PYG", "PEN", "PHP", "PLN", "QAR", "RON", "RUB", "RWF", "SHP", "XCD", "WST", "STD", "SAR", "RSD", "SCR", "SLL", "SGD", "ANG", "SBD", "SOS", "ZAR", "KRW", "SSP", "EUR", "LKR", "SDG", "SRD", "NOK", "SZL", "SEK", "CHF", "SYP", "TWD", "TJS", "TZS", "THB", "XOF", "NZD", "TOP", "TTD", "TND", "TRY", "TMT", "AUD", "UGX", "UAH", "AED", "GBP", "USD", "UYU", "UZS", "VUV", "VEF", "VND", "XPF", "MAD", "YER", "ZMW", "BWP", "CNH"
Example: "SGD"
No
customField[ CustomFieldItem ]List of custom fieldsNo
customerTypeIndiastringIndia Compliance filed
Enum: "EXPORT_WO_PAY", "EXPORT_W_PAY", "NA", "SEZ_WO_PAY", "SEZ_W_PAY"
Example: "SEZ (WPAY)"
No
documentDatedateTimeDocument date.
Example: "2019-09-27"
No
errors[ string ]List of validation error messagesNo
exchangeRatenumberExchange rate.
Example: 0.01891562
No
gstExchangeRatenumberGST Exchange rate if tax residency currency is different than base currency
Example: 1
No
gstInstringNo
gstTreatmentIndiastringIndia Compliance filed
Enum: "REGISTERED_BUSINESS_REGULAR=Registered Business - Regular", "REGISTERED_BUSINESS_COMPOSITION=Registered Business - Composition", "UNREGISTERED_BUSINESS=Unregistered Business", "CUSTOMER=Consumer", "OVERSEAS=Overseas", "SPECIAL_ECONOMIC_ZONE=Special Economic Zone", "DEEMED_EXPORT=Deemed Export"
Example: "REGISTERED_BUSINESS_REGULAR"
No
interCompanybooleanTrue if it is between inter companies
Example: true
No
isTdsPaymentIndiabooleanNo
knockoffInfo[ KnockOffInfo ]No
makePaymentFeeDtoList[ MakePaymentFeeDto ]Transaction fee pertaining to the made paymentNo
makePaymentItemDtoList[ MakePaymentItemResponseDtoIndonesia ]Make payment items information.No
makePaymentRecurringDtoMakePaymentRecurringDtoRecurring payment details.No
memostringMemo text.
Example: "Sales quotation"
No
nextPaymentDatedateTimeNext payment date.
Example: "2019-09-27"
No
openingbooleanOpening Document
Example: false
No
paymentTypestringType of payment.
Enum: "CHEQUE", "CASH", "BANK_TRANSFER", "CARD", "OTHERS"
Example: "BANK_TRANSFER"
No
reconciledbooleanWhether the current payment is reconciled or not.No
recurringActivatedbooleanRecurring payment activated for payment.
Example: false
No
recurringPaymentbooleanRecurring payment enable/disable for payment.
Example: false
No
referenceDatedateTimeDate of Bank Transfer/cheque.
Example: "2019-09-27"
No
referenceNumberstringReference number of Bank Transfer/cheque.
Example: "CH001"
No
statusstringPrint Status
Enum: "PRINT_SUCCESS", "PRINT_FAILURE", "NOT_PRINTED"
Example: "NOT_PRINTED"
No
tdsPaymentInfoIndiaTDSPaymentInfoIndiaTDS Payment detailsNo
tdsProcessedFlagbooleanTDS Processed Flag
Example: false
No
unitPriceGstInclusivebooleanPrice is GST inclusive
Example: false
No
vendorTypeIndiastringIndia Compliance filed
Enum: "IMPORT", "NA", "SEZ_W_PAY", "SEZ_WO_PAY"
Example: "EXPORT (WOPAY)"
No
whtApplicablebooleanExample: trueNo

MakePaymentResponseDtoIsrael

NameTypeDescriptionRequired
accountCodePayFromstringAccount code.
Example: "AC-001"
No
accountNamestringAccount name.
Example: "Bank"
No
amountnumberPayment amount.
Example: 10
No
amountDuenumberPayment amount Due.
Example: 10
No
attachmentIds[ integer ]list of attachment id's for this orderNo
bankRuleIdlongRule id if the document has been created by a Bank RuleNo
contactCodestringContact code.
Example: 19425
No
contactNamestringContact name.
Example: "ABC PTE LTD"
No
currencystringCurrency code.
Enum: "AFN", "ALL", "DZD", "AOA", "ARS", "AMD", "AWG", "AZN", "BSD", "BHD", "BDT", "BBD", "BYN", "BZD", "BMD", "BTN", "BOB", "BAM", "BRL", "BND", "BGN", "BIF", "KHR", "CAD", "CVE", "KYD", "CLP", "CNY", "COP", "KMF", "CDF", "CRC", "CZK", "HRK", "CUC", "DJF", "DOP", "EGP", "ERN", "ETB", "FKP", "FJD", "XAF", "GMD", "GEL", "GHS", "GIP", "DKK", "GTQ", "GNF", "GYD", "HTG", "HNL", "HKD", "HUF", "ISK", "INR", "IDR", "IRR", "IQD", "JMD", "JPY", "JOD", "KZT", "KES", "KWD", "KGS", "LAK", "LBP", "LSL", "LRD", "LYD", "MOP", "MKD", "MGA", "MWK", "MYR", "MVR", "MRO", "MUR", "MXN", "MDL", "MNT", "MZN", "MMK", "NAD", "NPR", "NIO", "NGN", "KPW", "OMR", "PKR", "ILS", "PAB", "PGK", "PYG", "PEN", "PHP", "PLN", "QAR", "RON", "RUB", "RWF", "SHP", "XCD", "WST", "STD", "SAR", "RSD", "SCR", "SLL", "SGD", "ANG", "SBD", "SOS", "ZAR", "KRW", "SSP", "EUR", "LKR", "SDG", "SRD", "NOK", "SZL", "SEK", "CHF", "SYP", "TWD", "TJS", "TZS", "THB", "XOF", "NZD", "TOP", "TTD", "TND", "TRY", "TMT", "AUD", "UGX", "UAH", "AED", "GBP", "USD", "UYU", "UZS", "VUV", "VEF", "VND", "XPF", "MAD", "YER", "ZMW", "BWP", "CNH"
Example: "SGD"
No
customField[ CustomFieldItem ]List of custom fieldsNo
customerTypeIndiastringIndia Compliance filed
Enum: "EXPORT_WO_PAY", "EXPORT_W_PAY", "NA", "SEZ_WO_PAY", "SEZ_W_PAY"
Example: "SEZ (WPAY)"
No
documentDatedateTimeDocument date.
Example: "2019-09-27"
No
errors[ string ]List of validation error messagesNo
exchangeRatenumberExchange rate.
Example: 0.01891562
No
gstExchangeRatenumberGST Exchange rate if tax residency currency is different than base currency
Example: 1
No
gstInstringNo
gstTreatmentIndiastringIndia Compliance filed
Enum: "REGISTERED_BUSINESS_REGULAR=Registered Business - Regular", "REGISTERED_BUSINESS_COMPOSITION=Registered Business - Composition", "UNREGISTERED_BUSINESS=Unregistered Business", "CUSTOMER=Consumer", "OVERSEAS=Overseas", "SPECIAL_ECONOMIC_ZONE=Special Economic Zone", "DEEMED_EXPORT=Deemed Export"
Example: "REGISTERED_BUSINESS_REGULAR"
No
interCompanybooleanTrue if it is between inter companies
Example: true
No
isTdsPaymentIndiabooleanNo
knockoffInfo[ KnockOffInfo ]No
makePaymentFeeDtoList[ MakePaymentFeeDto ]Transaction fee pertaining to the made paymentNo
makePaymentItemDtoList[ MakePaymentItemResponseDtoIsrael ]Make payment items information.No
makePaymentRecurringDtoMakePaymentRecurringDtoRecurring payment details.No
memostringMemo text.
Example: "Sales quotation"
No
nextPaymentDatedateTimeNext payment date.
Example: "2019-09-27"
No
openingbooleanOpening Document
Example: false
No
paymentTypestringType of payment.
Enum: "CHEQUE", "CASH", "BANK_TRANSFER", "CARD", "OTHERS"
Example: "BANK_TRANSFER"
No
reconciledbooleanWhether the current payment is reconciled or not.No
recurringActivatedbooleanRecurring payment activated for payment.
Example: false
No
recurringPaymentbooleanRecurring payment enable/disable for payment.
Example: false
No
referenceDatedateTimeDate of