Deposit APIs

You will be able to make a Deposit entry for payments received not related to an Invoice. It is a special case of Receive Payments APIs

More about Deposit API documentation

API

---

Search Deposits

Get Deposits by filter criteria. More about search deposits

Description:

• Allows you to retrieve a list of all deposits.
• Allows you to retrieve a list of deposits based on it's filter criteria.

GET

/v1/payments/receive/deposits

Request URL

Deposit API documentation

Parameters

Name	Located in	Description	Required	Schema
contactName	query	contactName	No	string
customfield	query	customfield	No	string
docType	query	docType	No	string
includeUndepositedFunds	query	includeUndepositedFunds	No	boolean
limit	query	limit	No	integer
page	query	page	No	integer
paymentDate	query	paymentDate	No	dateTime
query	query	query	No	string
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string

Responses

Code	Description	Schema
200	Deposits have been fetched successfully.	ReceivePaymentDto
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

---

Create / Update Deposit

Make a new deposit entry. More about create deposits

Description:

• Allows you to make a new deposit.
• including the id parameter will update existing deposit

POST

/v1/payments/receive/deposit

Deposit API documentation

Parameters

Code	Description	Schema
200	OK	ReceivePaymentDto
201	Deposit has been done successfully.	ReceivePaymentDto
400	Deposit failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Responses

Code	Description	Schema
200	OK	ReceivePaymentDto
201	Payment has been done successfully.	ReceivePaymentDto
400	Payment failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

---

Create / Update Deposit with Tax Group

Make a new deposit entry with tax group. More about deposit with tax group

Description:

• Allows you to make a new deposit.
• including the id parameter will update existing deposit

POST

/v1/payments/receive/taxgroupdeposit

Deposit API documentation

Parameters

Name	Located in	Description	Required	Schema
receivePaymentDto	body	receivePaymentDto	Yes	ReceivePaymentDto

Responses

Code	Description	Schema
200	OK	ReceivePaymentDto
201	Payment has been done successfully.	ReceivePaymentDto
400	Payment failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

---

Delete Deposit

Delete deposit information.

Description:

• Allows you to delete deposit information.

DELETE

/v1/payments/receive/{code}

Request URL

Deposit API documentation

Parameters

Name	Located in	Description	Required	Schema
receivePaymentCode	query	receivePaymentCode	Yes	string

Responses

Code	Description	Schema
204	Deposit has been updated successfully.
401	Unauthorized
403	Forbidden
404	Payment with code not found.

Security

Security Schema	Scopes
Authorization	global

Models

---

ReceivePaymentDto

Name	Type	Description	Required
accountCodePayTo	string	Account code. Example: "AC-001"	No
accountName	string	Account name. Example: "Bank"	No
amount	number	Payment amount. Example: 10	No
amountDue	number	Payment amount Due. Example: 10	No
attachmentIds	[ integer ]	list of attachment id's for this order	No
bankRuleId	long	Rule id if the document has been created by a Bank Rule	No
billTo	Address	Bill to address	No
contactCode	string	Contact code. Example: 19425	No
contactName	string	Contact name. Example: "ABC PTE LTD"	No
currency	string	Currency 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 fields	No
customerTypeIndia	string	India Compliance filed Enum: "EXPORT_WO_PAY", "EXPORT_W_PAY", "NA", "SEZ_WO_PAY", "SEZ_W_PAY" Example: "SEZ (WPAY)"	No
documentDate	dateTime	Document date. Example: "2019-09-27"	No
errors	[ string ]	List of validation error messages	No
exchangeRate	number	Exchange rate. Example: 0.01891562	No
gstExchangeRate	number	GST Exchange rate if tax residency currency is different than base currency Example: 1	No
gstIn	string		No
gstTreatmentIndia	string	India 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
interCompany	boolean	True if it is between inter companies Example: true	No
isUnDepositedPayment	boolean	Whether the current payment is un-deposited or not.	No
journalEntryBankTransferRequestDto	JournalEntryBankTransferRequestDto	Bank Transfer Request DTO for Journal Entry	No
knockoffInfo	[ KnockOffInfo ]		No
memo	string	Memo text. Example: "Sales quotation"	No
opening	boolean	Opening Document Example: false	No
paymentType	string	Type of payment. Enum: "CHEQUE", "CASH", "BANK_TRANSFER", "CARD", "OTHERS" Example: "BANK_TRANSFER"	No
receivePaymentFeeDtoList	[ ReceivePaymentFeeDto ]	Transaction fee pertaining to the received payment	No
receivePaymentItemDtoList	[ ReceivePaymentItemDto ]	Receive payment items information.	No
reconciled	boolean	Whether the current payment is reconciled or not.	No
referenceDate	dateTime	Date of Bank Transfer/cheque. Example: "2019-09-27"	No
referenceNumber	string	Reference number of Bank Transfer/cheque. Example: "CH001"	No
salesInvoice	SalesInvoiceResponse		No
sentEmail	boolean	Send Customer Email Example: false	No
shipFrom	Address	Ship from address	No
shipTo	Address	Ship to address	No
unDepositedEntriesReconciled	[ UnDepositedEntriesReconciled ]	Reconciled un-deposited entries	No
unitPriceGstInclusive	boolean	Price is GST inclusive Example: false	No
vendorTypeIndia	string	India Compliance filed Enum: "IMPORT", "NA", "SEZ_W_PAY", "SEZ_WO_PAY" Example: "EXPORT (WOPAY)"	No

Address

Name	Type	Description	Required
address1	string	Address line 1 Example: "218, Robinson Road"	No
address2	string	Address line 2 Example: "Downtown"	No
city	string	City Example: "C001"	No
contactName	string	contact name for address Example: "John Smith"	No
country	string	Country Example: "C001"	No
destinationOfSupply	string	state in India Example: "Maharashtra"	No
placeOfSupply	string	state in India Example: "Punjab"	No
postalCode	string	Postal Code Example: 123456	No
preferred	boolean	Is this a default address? Example: true	No
state	string	State Example: "CS001"	No

ReceivePaymentFeeDto

Name	Type	Description	Required
ReceivePaymentFeeDto	object

ReceivePaymentDto

Name	Type	Description	Required
accountCodePayTo	string	Account code. Example: "AC-001"	No
accountName	string	Account name. Example: "Bank"	No
amount	number	Payment amount. Example: 10	No
amountDue	number	Payment amount Due. Example: 10	No
attachmentIds	[ integer ]	list of attachment id's for this order	No
bankRuleId	long	Rule id if the document has been created by a Bank Rule	No
billTo	Address	Bill to address	No
contactCode	string	Contact code. Example: 19425	No
contactName	string	Contact name. Example: "ABC PTE LTD"	No
currency	string	Currency 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 fields	No
customerTypeIndia	string	India Compliance filed Enum: "EXPORT_WO_PAY", "EXPORT_W_PAY", "NA", "SEZ_WO_PAY", "SEZ_W_PAY" Example: "SEZ (WPAY)"	No
documentDate	dateTime	Document date. Example: "2019-09-27"	No
errors	[ string ]	List of validation error messages	No
exchangeRate	number	Exchange rate. Example: 0.01891562	No
gstExchangeRate	number	GST Exchange rate if tax residency currency is different than base currency Example: 1	No
gstIn	string		No
gstTreatmentIndia	string	India 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
interCompany	boolean	True if it is between inter companies Example: true	No
isUnDepositedPayment	boolean	Whether the current payment is un-deposited or not.	No
journalEntryBankTransferRequestDto	JournalEntryBankTransferRequestDto	Bank Transfer Request DTO for Journal Entry	No
knockoffInfo	[ KnockOffInfo ]		No
memo	string	Memo text. Example: "Sales quotation"	No
opening	boolean	Opening Document Example: false	No
paymentType	string	Type of payment. Enum: "CHEQUE", "CASH", "BANK_TRANSFER", "CARD", "OTHERS" Example: "BANK_TRANSFER"	No
receivePaymentFeeDtoList	[ ReceivePaymentFeeDto ]	Transaction fee pertaining to the received payment	No
receivePaymentItemDtoList	[ ReceivePaymentItemDto ]	Receive payment items information.	No
reconciled	boolean	Whether the current payment is reconciled or not.	No
referenceDate	dateTime	Date of Bank Transfer/cheque. Example: "2019-09-27"	No
referenceNumber	string	Reference number of Bank Transfer/cheque. Example: "CH001"	No
salesInvoice	SalesInvoiceResponse		No
sentEmail	boolean	Send Customer Email Example: false	No
shipFrom	Address	Ship from address	No
shipTo	Address	Ship to address	No
unDepositedEntriesReconciled	[ UnDepositedEntriesReconciled ]	Reconciled un-deposited entries	No
unitPriceGstInclusive	boolean	Price is GST inclusive Example: false	No
vendorTypeIndia	string	India Compliance filed Enum: "IMPORT", "NA", "SEZ_W_PAY", "SEZ_WO_PAY" Example: "EXPORT (WOPAY)"	No

SalesInvoiceResponse

Name	Type	Description	Required
attachmentIds	[ integer ]		No
attachments	[ string ]	File attachments	No
backOrder	boolean	Backorder flag to indicate if backorder created	No
billTo	Address	Bill to address	No
contact	ContactInfo	Contact details	Yes
contactCode	string	Contact Code	Yes
contactDto	ContactDto	Contact Details	Yes
currency	string	Currency	Yes
documentSequenceCode	string	Sales invoice Sequence Code	No
draft	boolean	Sales invoice drafted	No
dropShip	boolean	Drop Ship flag to indicate if purchase invoice is created for drop ship	No
dueAmount	number	Amount Due	No
exchangeRate	number	Exchange rate	No
fulfillmentStatus	string	Sales invoice fulfillment status	No
fulfillmentType	string	Fulfillment type: NONE, DEFAULT, PICK_PACK_SHIP, DROP_SHIP	No
id	long	Sales invoice id	No
journalEntryCode	string	Journal Entry Code	No
memo	string	Memo	No
openingDocumentNumber	string	Customer opening document number	No
openingInvoice	boolean	True if opening invoice	No
paymentStatus	string	Sales invoice payment status	No
purchaseOrderRefNo	string	Contact PO reference number	No
recurring	boolean	True if Invoice is recurring.	No
recurringActivated	boolean	True if Invoice recurrence is active.	No
salesInvoiceCode	string	Sales invoice code	No
salesInvoiceDate	string	Sales Invoice date	Yes
salesInvoiceDueDate	string	Sales Invoice due date	Yes
salesInvoiceItems	[ SalesInvoiceItemDetails ]	Sales invoice item details	No
shipByDate	string	Ship by date	No
shipFrom	Address	Ship from address	No
shipTo	Address	Ship to address	No
status	string	Invoice status	No
taxAmount	number	Tax amount	No
totalAmount	number	Total amount	No
totalAmountInBaseCurrency	number	Total amount in base currency	No
unitPriceGstInclusive	boolean	Unit price is GST inclusive	No
warehouseCode	string	Warehouse Code	No
withheldAmount	number	Withheld Amount	No

ContactInfo

Name	Type	Description	Required
address	string	Address Example: "Raffles Place 1"	No
name	string	Customer name Example: "ABC Pte Ltd"	Yes
peppolId	string	Peppol ID Example: "u000:1109:uen"	No

ContactDto

Name	Type	Description	Required
attentionTo	string	the contact name in govt agency Example: "Peter Parker"	No
autoCharge	boolean	Auto payment charge Example: false	No
billingAddress	[ Address ]	List of Billing Address.	No
businessUnit	string	indicates the contact is govt agency Example: "CAA01 - Cvl Avtn Authrty of Singapore"	No
contactMasterId	string (uuid)	contact master id Example: "2df7a5c1-3305-498d-8d01-aa92c42d19d2"	No
contactNumber	string	Contact number Example: "+65999999999"	No
creditLimit	number	Credit Limit Example: 100	No
creditLimitInBaseCurrency	number	Credit Limit In Org Currency Example: 100	No
currencyCode	string	Currency 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
documentSequenceCode	string	Contact Sequence code Example: "C-0000001"	No
emailId	string	contact email address Example: "myinfo@domain.com"	No
extCompanyName	string	the company name from external app Example: "QuickBook"	No
intercompanyType	string	Contact Type either parent or subsidiary Enum: "PARENT", "SUBSIDIARY" Example: "PARENT/SUBSIDIARY"	No
invoiceCreditLimitType	string	Invoice Credit Limit Type Enum: "IGNORE", "WARN", "BLOCK" Example: "IGNORE"	No
invoices	object		No
isAccountNumberFlag	boolean	indicates if user is sending account number or code Example: true	No
isCreditLimitApplicable	boolean	Contact credit limit applicable Example: true	No
isIncludeCurrentInvoice	boolean	Include Current Invoice Example: true	No
isIncludeCurrentQuotation	boolean	Include Current Quotation Example: true	No
isIncludeCurrentSalesOrder	boolean	Include Current Sales Order Example: false	No
name	string	Contact name Example: "Sam"	No
payableAccountCode	string	Payable account code Example: "AC002"	No
paymentTermCode	string	Payment term code Example: "Net 0"	No
peppolId	string	Peppol ID Example: "u000:11::11293"	No
purchasePriceLists	[ long ]	Set of Purchase price lists Example: [123,456]	No
quotationCreditLimitType	string	Quotation Credit Limit Type Enum: "IGNORE", "WARN", "BLOCK" Example: "IGNORE"	No
receivableAccountCode	string	Receivable account code Example: "AC001"	No
salesOrderCreditLimitType	string	Sales Order Credit Limit Type Enum: "IGNORE", "WARN", "BLOCK" Example: "IGNORE"	No
salesPriceLists	[ long ]	Set of Sales price lists Example: [123,456]	No
sequenceFormat	string	Sequence Format Example: 1	No
shippingAddress	[ Address ]	List of Shipping Address.	No
singaporeGovt	boolean	indicates the contact is govt agency Example: true	No
taxExempted	boolean	Denotes if customer is tax exempted Example: true	No
taxExemptionNo	string	Generated tax exemption number Example: "234s-few3-2422"	No
taxExemptionReason	string	Tax exemption reason Example: "Resale, Federal Agency"	No
taxNumber	string	Tax number Example: 123456	No
uen	string	Contact UEN Example: "DHJEUK"	No

SalesInvoiceItemDetails

Name	Type	Description	Required
allocationType	string	Allocation Type Example: "NORMAL"	No
availableQuantity	number	Total available quantity Example: 3	No
basePrice	number	Revenue Base price Example: 120	No
customField	[ CustomFieldItem ]	List of custom fields	No
discount	number	Discount Example: 2	No
discountInPercent	boolean	Discount in percentage Example: true	No
documentSequenceCode	string	Product Document Sequence Code Example: "P-0000001"	Yes
documentUOMSchemaDefinition	DocumentUOMSchemaDefinition	Document UOM Schema Definition Example: 2	Yes
documentUom	long	Document UOM id Example: 2	Yes
errors	[ string ]	List of validation error messages	No
fulfillmentByDoc	[ ItemQtyFulfilledByDoc ]	Item Qty fulfilled by Fulfillment Doc Example: []	No
id	long	ID Example: 2	No
invoiceLineNumber	string	Invoice Line Number Example: "ABSCDDSD1212"	No
isPartialInvoice	boolean	Whether the Sales Invoice is a partial invoice Example: false	No
itemFulfillmentStatus	string	Item Fulfillment Status Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED" Example: "UNFULFILLED"	No
lineNumber	integer	Line Number Example: 1	No
linkedQuoteItem	long	Quote Item linked to invoice item Example: "QO-001"	No
linkedQuoteItemCode	string	Linked quote item code Example: "QO-002"	No
product	ProductResponse	Product Response Example: "product"	No
productCode	string	Product code Example: "P00001"	Yes
productDescription	string	Product description Example: "Apple watch"	No
productOrder	integer	Product view order Example: 1	No
productQuantity	number	Product quantity Example: 2	Yes
quantityFulfilled	number	quantity fulfilled Example: 10	No
quantityFulfilledByFlowover	number	Total Quantity Fulfilled By Flowover	Yes
quantityFulfilledByUser	number	Total Quantity Fulfilled By User	Yes
reservedQuantitiesData	[ ReservedQuantityData ]	Reserved quantity data Example: []	No
revRecDocumentItemDetails	RevRecDocumentItemDetails	Item Revenue Details Example: "revRecDocumentItemDetails"	No
salesInvoiceItemCode	string	Sales Invoice Item Code Example: "SII-000001"	No
tax	TaxDto	Tax details Example: "taxDto"	No
taxAmount	number	Tax amount Example: 0.5	No
taxCode	string	Tax code Example: "GST7"	No
totalAmount	number	Total amount Example: 2.3	Yes
type	string	Product type Enum: "TRACKED", "NONTRACKED" Example: "TRACKED"	Yes
unitPrice	number	Product unit price Example: 0.7	Yes
uomQuantity	number	uom quantity Example: 2	Yes
uomUnitPrice	number	UOM Unit price Example: 2.3	Yes
updatedPartialQuantity	number	partial invoice updated quantity Example: 10	No

TaxMappingDto

Name	Type	Description	Required
additionalTaxIn	boolean		No
id	long		No
taxAmount	number		No
taxApplyTo	string		No
taxCode	string		No
taxId	number		No
taxName	string		No
taxRate	number		No
taxSeqCode	string		No
taxType	string		No
taxableAmount	number		No