Contact APIs

A contact is a consumer of the product or service which is offered by your business. You can create, update and retrieve contacts by using API.

ContactDto help you to create a new contact, update a particular contact, retrieve contact, or get the list of all contacts.

More about Contact API documentation

API

---

Search Contact

Get contacts by filter criteria. More about search contact

Description:

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

GET

/v1/contacts

Request URL

More about search contact

Parameters

Name	Located in	Description	Required	Schema
includeOpeningAmounts	query	includeOpeningAmounts	No	boolean
includeOweAmounts	query	includeOweAmounts	No	boolean
limit	query	limit	No	integer
page	query	page	No	integer
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	Contact's information have been fetched successfully.	ContactDto
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

---

Create Contact

Create a new Contact. More about create contact

Description:

• Allows you to create new contact.

POST

/v1/contacts

More about create contact

Parameters

Name	Located in	Description	Required	Schema
contactDto	body	contactDto	Yes	ContactDto

Responses

Code	Description	Schema
200	OK	ContactDto
201	Contact has been created successfully.	ContactDto
400	Contact creation failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

---

Retrieve Contact by ID

Get contact by id. More about retrieve contact by id

Description:

• Allows you to retrieve an existing contact details by it's id.

GET

Contacts {id}

More about retrieve contact by id

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description	Schema
200	Contact's information have been fetched successfully.	ContactDto
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

---

Retrieve Contact by Code

Get contact by code. More about retrieve contact by code

Description:

• Allows you to retrieve an existing contact by code.

GET

Contacts code/{code}

More about retrieve contact by code

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Contact's information have been fetched successfully.	ContactDto
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

---

Update Contact

Update contact information. More about update contact

Description:

• Allows you to update an existing contact information.

PUT

Contacts {id}

More about update contact

Parameters

Name	Located in	Description	Required	Schema
contactDto	body	contactDto	Yes	ContactDto
id	path	id	Yes	long

Responses

Code	Description	Schema
200	Contact has been updated successfully.	ContactDto
201	Created
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

---

Delete Contact

DELETE

Contacts {id}

Summary

Delete a contact

Description

Api to delete contact

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description
200	OK
204	Contact has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

---

Change Contacts Status

PATCH

Contacts codes/status

Summary

Change contact status in bulk

Description

Change contact status in bulk

Parameters

Name	Located in	Description	Required	Schema
contactCodes	body	contactCodes	Yes	[ string ]
status	query	status	Yes	string

Responses

Code	Description
200	Bulk status update done successfully
204	No Content
401	Unauthorized
403	Forbidden

Security

Security Schema	Scopes
Authorization	global

---

Get Contacts Summary

GET

Contacts summary

Summary

Get contact summary

Description

API to get contact summary.

Responses

Code	Description	Schema
200	Contacts summary have been fetched	ContactSummaryDto
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

---

Bulk Delete Contacts

DELETE

Contacts bulk-delete

Summary

Delete contacts

Description

API to delete contacts in bulk.

Parameters

Name	Located in	Description	Required	Schema
contactIds	body	contactIds	Yes	[ long ]

Responses

Code	Description	Schema
200	OK	ResponseEntity
204	Contact has been deleted successfully.	ResponseEntity
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

---

Get Withholding Taxes for a Contact

GET

Contacts il/withholdingTaxGroup

Summary

Get Withholding Tax Group.

Description

API to get Withholding Tax Group.

Parameters

Name	Located in	Description	Required	Schema
limit	query	limit	No	integer
page	query	page	No	integer
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	Withholding Tax Group has been fetched successfully.	WithHoldingTaxPaymentGroupIsraelDto
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

---

Get Contact TDS Deductee Info

GET

Contacts in/tds-deductee

Summary

Get TDS Deductee info of a Contact.

Description

Get TDS Deductee info of a Contact.

Parameters

Name	Located in	Description	Required	Schema
limit	query	limit	No	integer
page	query	page	No	integer
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string

Responses

Code	Description	Schema
200	Fetched TDS Deductee successfully.	TdsDeducteeResponse
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

---

Get Payment Terms

GET

Contacts paymentTerms

Summary

Get Payment Terms.

Description

API to get Payment Terms.

Parameters

Name	Located in	Description	Required	Schema
limit	query	limit	No	integer
page	query	page	No	integer
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	Payment term has been fetched successfully.	PaymentTermResponseDto
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

---

bank-details-controller

Bank Info APIs.

Bankdetails

GET

Summary

Fetch Bank Info

Description

API to fetch existing contact Bank Details

Parameters

Name	Located in	Description	Required	Schema
limit	query	limit	No	integer
page	query	page	No	integer
query	query	query	No	string
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string
type	query	type	Yes	string

Responses

Code	Description	Schema
200	Bank information have been fetched successfully.	BankDetailsDto
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create Bank Info.

Description

API to create new bank info.

Parameters

Name	Located in	Description	Required	Schema
bankDetailsDto	body	bankDetailsDto	Yes	BankDetailsDto

Responses

Code	Description	Schema
200	OK	BankDetailsDto
201	Bank Info has been created successfully.	BankDetailsDto
400	Bank Info creation failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Bankdetails/{id}

PUT

Summary

Update Bank Info.

Description

API to update existing bank info.

Parameters

Name	Located in	Description	Required	Schema
bankDetailsDto	body	bankDetailsDto	Yes	BankDetailsDto
id	path	id	Yes	long

Responses

Code	Description	Schema
200	Bank Info has been updated successfully.	BankDetailsDto
201	Created
401	Unauthorized
403	Forbidden
404	Bank info with id not found.

Security

Security Schema	Scopes
Authorization	global

---

sg-controller

SG Controller

/v1/contact/sg-uen/{uen}

GET

Summary

Check UEN

Description

Check UEN

Parameters

Name	Located in	Description	Required	Schema
uen	path	uen	Yes	string

Responses

Code	Description	Schema
200	UEN is registered for PEPPOL	boolean
401	Unauthorized
403	Forbidden
404	UEN is not registered for PEPPOL

Security

Security Schema	Scopes
Authorization	global

---

Contacts brief

GET

Summary

get contacts export

Description

request get contacts export by tenant and status.

Responses

Code	Description	Schema
200	get contacts export successful.	[ ContactDto ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts brief-details

GET

Summary

get contacts export

Description

request get contacts export by tenant and status.

Responses

Code	Description	Schema
200	get contacts export successful.	[ ContactDto ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts businessunits

GET

Summary

Fetch Govt's Business units

Description

API to fetch existing contacts.

Parameters

Name	Located in	Description	Required	Schema
limit	query	limit	No	integer
page	query	page	No	integer
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	Contact's information have been fetched successfully.	ContactDto
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts codes

POST

Summary

Fetch contacts by list of codes.

Description

API to fetch existing contact by code.

Parameters

Name	Located in	Description	Required	Schema
codes	body	codes	Yes	[ string ]

Responses

Code	Description	Schema
200	Contact's information have been fetched successfully.	[ ContactDto ]
201	Created
401	Unauthorized
403	Forbidden
404	No contacts found with provided codes

Security

Security Schema	Scopes
Authorization	global

Contacts contactmasters

POST

Summary

Fetch contacts by list of contact master ids.

Description

API to Fetch contacts by list of contact master ids.

Parameters

Name	Located in	Description	Required	Schema
contactMasterIds	body	contactMasterIds	Yes	[ string (uuid) ]

Responses

Code	Description	Schema
200	Contact's information have been fetched successfully.	[ ContactDto ]
201	Created
401	Unauthorized
403	Forbidden
404	No contacts found with provided contact masters

Security

Security Schema	Scopes
Authorization	global

Contacts custom-fields

GET

Summary

Get custom field is used or not

Description

API to Get custom field is used or not

Parameters

Name	Located in	Description	Required	Schema
customCode	query	customCode	Yes	string

Responses

Code	Description	Schema
200	Custom fields status fetched successfully	boolean
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts details

POST

Summary

getContactDetails

Parameters

Name	Located in	Description	Required	Schema
contactCodes	body	contactCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	OK	[ ContactDetails ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts detailsbyaccount/{accountCode}

GET

Summary

Fetch contact details by account code

Description

Fetch contact details by account code used as receivable or payable account

Parameters

Name	Located in	Description	Required	Schema
accountCode	path	accountCode	Yes	string

Responses

Code	Description	Schema
200	OK	[ ContactDetails ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts detailsbyids

POST

Summary

getContactDetailsByIds

Parameters

Name	Located in	Description	Required	Schema
contactIds	body	contactIds	Yes	[ string ]

Responses

Code	Description	Schema
200	OK	[ ContactDetails ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts detailsbyseqcodes

POST

Summary

getContactDetailsBySeqCodes

Parameters

Name	Located in	Description	Required	Schema
contactCodes	body	contactCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	OK	[ ContactDetails ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts import

POST

Summary

Contact.

Description

API to create new contact.

Parameters

Name	Located in	Description	Required	Schema
contactDtos	body	contactDtos	Yes	[ ContactDto ]

Responses

Code	Description	Schema
200	OK	[ object ]
201	Contacts are imported successfully.	[ object ]
400	Contact creation failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts info

POST

Summary

Fetch contact details by codes

Description

Fetch contact details by codes

Parameters

Name	Located in	Description	Required	Schema
codes	body	codes	Yes	[ string ]

Responses

Code	Description	Schema
200	OK	[ ContactInformation ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts names

POST

Summary

Fetch contacts by list of names.

Description

API to fetch existing contact by names.

Parameters

Name	Located in	Description	Required	Schema
names	body	names	Yes	[ string ]

Responses

Code	Description	Schema
200	Contact's information have been fetched successfully.	[ ContactDto ]
201	Created
401	Unauthorized
403	Forbidden
404	No contacts found with provided names

Security

Security Schema	Scopes
Authorization	global

Contacts proxyzapier

POST

Summary

Api proxy for Zapier service

Description

Api proxy for Zapier service

Parameters

Name	Located in	Description	Required	Schema
requestDto	body	requestDto	Yes	ZapierRequestDto

Responses

Code	Description	Schema
200	OK	ZapierResponseDto
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts updateattribute/{code}

PATCH

Summary

Update contact attributes.

Description

API to update attributes of existing contact.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string
contactAttributeUpdateDto	body	contactAttributeUpdateDto	Yes	ContactAttributeUpdateDto

Responses

Code	Description	Schema
200	Contact attributes has been updated successfully.	ContactDto
204	No Content
401	Unauthorized
403	Forbidden
404	Contact with code not found.

Security

Security Schema	Scopes
Authorization	global

Contacts {id}

GET

Summary

Fetch contact by id.

Description

API to fetch existing contact by it's id.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description	Schema
200	Contact's information have been fetched successfully.	ContactDto
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

PUT

Summary

Update contact.

Description

API to update existing contact.

Parameters

Name	Located in	Description	Required	Schema
contactDto	body	contactDto	Yes	ContactDto
id	path	id	Yes	long

Responses

Code	Description	Schema
200	Contact has been updated successfully.	ContactDto
201	Created
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

---

PATCH

Summary

Update contact attributes.

Description

API to update attributes of existing contact.

Parameters

Name	Located in	Description	Required	Schema
contactAttributeUpdateDto	body	contactAttributeUpdateDto	Yes	ContactAttributeUpdateDto
id	path	id	Yes	long

Responses

Code	Description	Schema
200	Contact attributes has been updated successfully.	ContactDto
204	No Content
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

Contacts {tenantId}

POST

Summary

Create demo Contacts.

Description

API to create demo contacts.

Parameters

Name	Located in	Description	Required	Schema
country	query	country	No	string
tenantId	path	tenantId	Yes	long

Responses

Code	Description
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

---

contact-uae-controller

Contact APIs for UAE.

Contacts ae

GET

Summary

Fetch contacts

Description

API to fetch existing contacts.

Parameters

Name	Located in	Description	Required	Schema
customfield	query	customfield	No	string
includeOpeningAmounts	query	includeOpeningAmounts	No	boolean
includeOweAmounts	query	includeOweAmounts	No	boolean
limit	query	limit	No	integer
page	query	page	No	integer
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	Contact's information have been fetched successfully.	ContactUaeDto
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

v1/contacts/ae

Description

API to create new contact.

Parameters

Name	Located in	Description	Required	Schema
contactDto	body	contactDto	Yes	ContactUaeDto

Responses

Code	Description	Schema
200	OK	ContactDto
201	Contact has been created successfully.	ContactDto
400	Contact creation failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts ae/brief

GET

Summary

get contacts export

Description

request get contacts export by tenant and status.

Responses

Code	Description	Schema
200	get contacts export successful.	[ ContactUaeDto ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts ae/code/{code}

GET

Summary

Fetch contact by code.

Description

API to fetch existing contact by code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Contact's information have been fetched successfully.	ContactUaeDto
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

Contacts ae/codes

POST

Summary

Fetch contacts by list of codes.

Description

API to fetch existing contact by code.

Parameters

Name	Located in	Description	Required	Schema
codes	body	codes	Yes	[ string ]

Responses

Code	Description	Schema
200	Contact's information have been fetched successfully.	[ ContactUaeDto ]
201	Created
401	Unauthorized
403	Forbidden
404	No contacts found with provided codes

Security

Security Schema	Scopes
Authorization	global

Contacts ae/codes/status

PATCH

Summary

Bulk status update

Description

Bulk status update

Parameters

Name	Located in	Description	Required	Schema
contactCodes	body	contactCodes	Yes	[ string ]
status	query	status	Yes	string

Responses

Code	Description
200	Bulk status update done successfully
204	No Content
401	Unauthorized
403	Forbidden

Security

Security Schema	Scopes
Authorization	global

Contacts ae/details

POST

Summary

getContactDetails

Parameters

Name	Located in	Description	Required	Schema
contactCodes	body	contactCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	OK	[ ContactDetails ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts ae/import

POST

Summary

Contact.

Description

API to create new contact.

Parameters

Name	Located in	Description	Required	Schema
contactDtos	body	contactDtos	Yes	[ ContactUaeDto ]

Responses

Code	Description	Schema
200	OK	[ object ]
201	Contacts are imported successfully.	[ object ]
400	Contact creation failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts ae/names

POST

Summary

Fetch contacts by list of names.

Description

API to fetch existing contact by names.

Parameters

Name	Located in	Description	Required	Schema
names	body	names	Yes	[ string ]

Responses

Code	Description	Schema
200	Contact's information have been fetched successfully.	[ ContactUaeDto ]
201	Created
401	Unauthorized
403	Forbidden
404	No contacts found with provided names

Security

Security Schema	Scopes
Authorization	global

Contacts ae/{id}

GET

Summary

Fetch contact by id.

Description

API to fetch existing contact by it's id.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description	Schema
200	Contact's information have been fetched successfully.	ContactUaeDto
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

PUT

Summary

Update contact.

Description

API to update existing contact.

Parameters

Name	Located in	Description	Required	Schema
contactDto	body	contactDto	Yes	ContactUaeDto
id	path	id	Yes	long

Responses

Code	Description	Schema
200	Contact has been updated successfully.	ContactUaeDto
201	Created
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete contacts

Description

Api to delete contact

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description
200	OK
204	Contact has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update contact attributes.

Description

API to update attributes of existing contact.

Parameters

Name	Located in	Description	Required	Schema
contactAttributeUpdateDto	body	contactAttributeUpdateDto	Yes	ContactAttributeUpdateDto
id	path	id	Yes	long

Responses

Code	Description	Schema
200	Contact attributes has been updated successfully.	ContactUaeDto
204	No Content
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

---

contact-australia-controller

Contact APIs for Australia.

Contacts au

GET

Summary

Fetch contacts

Description

API to fetch existing contacts.

Parameters

Name	Located in	Description	Required	Schema
customfield	query	customfield	No	string
includeOpeningAmounts	query	includeOpeningAmounts	No	boolean
includeOweAmounts	query	includeOweAmounts	No	boolean
limit	query	limit	No	integer
page	query	page	No	integer
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	Contact's information have been fetched successfully.	ContactAustraliaDto
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Contact.

Description

API to create new contact.

Parameters

Name	Located in	Description	Required	Schema
contactDto	body	contactDto	Yes	ContactAustraliaDto

Responses

Code	Description	Schema
200	OK	ContactAustraliaDto
201	Contact has been created successfully.	ContactAustraliaDto
400	Contact creation failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts au/brief

GET

Summary

get contacts export

Description

request get contacts export by tenant and status.

Responses

Code	Description	Schema
200	get contacts export successful.	[ ContactAustraliaDto ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts au/businessunits

GET

Summary

Fetch Govt's Business units

Description

API to fetch existing contacts.

Parameters

Name	Located in	Description	Required	Schema
limit	query	limit	No	integer
page	query	page	No	integer
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	Contact's information have been fetched successfully.	ContactAustraliaDto
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts au/code/{code}

GET

Summary

Fetch contact by code.

Description

API to fetch existing contact by code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Contact's information have been fetched successfully.	ContactAustraliaDto
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

Contacts au/codes

POST

Summary

Fetch contacts by list of codes.

Description

API to fetch existing contact by code.

Parameters

Name	Located in	Description	Required	Schema
codes	body	codes	Yes	[ string ]

Responses

Code	Description	Schema
200	Contact's information have been fetched successfully.	[ ContactAustraliaDto ]
201	Created
401	Unauthorized
403	Forbidden
404	No contacts found with provided codes

Security

Security Schema	Scopes
Authorization	global

Contacts au/codes/status

PATCH

Summary

Bulk status update

Description

Bulk status update

Parameters

Name	Located in	Description	Required	Schema
contactCodes	body	contactCodes	Yes	[ string ]
status	query	status	Yes	string

Responses

Code	Description
200	Bulk status update done successfully
204	No Content
401	Unauthorized
403	Forbidden

Security

Security Schema	Scopes
Authorization	global

Contacts au/custom-fields

GET

Summary

Get custom field is used or not

Description

API to Get custom field is used or not

Parameters

Name	Located in	Description	Required	Schema
customCode	query	customCode	Yes	string

Responses

Code	Description	Schema
200	Custom fields status fetched successfully	boolean
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts au/details

POST

Summary

getContactDetails

Parameters

Name	Located in	Description	Required	Schema
contactCodes	body	contactCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	OK	[ ContactDetails ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts au/detailsbyaccount/{accountCode}

GET

Summary

Fetch contact details by account code

Description

Fetch contact details by account code used as receivable or payable account

Parameters

Name	Located in	Description	Required	Schema
accountCode	path	accountCode	Yes	string

Responses

Code	Description	Schema
200	OK	[ ContactDetails ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts au/detailsbyseqcodes

POST

Summary

getContactDetailsBySeqCodes

Parameters

Name	Located in	Description	Required	Schema
contactCodes	body	contactCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	OK	[ ContactDetails ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts au/import

POST

Summary

Contact.

Description

API to create new contact.

Parameters

Name	Located in	Description	Required	Schema
contactDtos	body	contactDtos	Yes	[ ContactAustraliaDto ]

Responses

Code	Description	Schema
200	OK	[ object ]
201	Contacts are imported successfully.	[ object ]
400	Contact creation failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts au/info

POST

Summary

Fetch contact details by codes

Description

Fetch contact details by codes

Parameters

Name	Located in	Description	Required	Schema
codes	body	codes	Yes	[ string ]

Responses

Code	Description	Schema
200	OK	[ ContactInformation ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts au/names

POST

Summary

Fetch contacts by list of names.

Description

API to fetch existing contact by names.

Parameters

Name	Located in	Description	Required	Schema
names	body	names	Yes	[ string ]

Responses

Code	Description	Schema
200	Contact's information have been fetched successfully.	[ ContactAustraliaDto ]
201	Created
401	Unauthorized
403	Forbidden
404	No contacts found with provided names

Security

Security Schema	Scopes
Authorization	global

Contacts au/{id}

GET

Summary

Fetch contact by id.

Description

API to fetch existing contact by it's id.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description	Schema
200	Contact's information have been fetched successfully.	ContactAustraliaDto
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

PUT

Summary

Update contact.

Description

API to update existing contact.

Parameters

Name	Located in	Description	Required	Schema
contactDto	body	contactDto	Yes	ContactAustraliaDto
id	path	id	Yes	long

Responses

Code	Description	Schema
200	Contact has been updated successfully.	ContactAustraliaDto
201	Created
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete contacts

Description

Api to delete contact

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description
200	OK
204	Contact has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update contact attributes.

Description

API to update attributes of existing contact.

Parameters

Name	Located in	Description	Required	Schema
contactAttributeUpdateDto	body	contactAttributeUpdateDto	Yes	ContactAttributeUpdateDto
id	path	id	Yes	long

Responses

Code	Description	Schema
200	Contact attributes has been updated successfully.	ContactAustraliaDto
204	No Content
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

Contacts au/{tenantId}

POST

Summary

Create demo Contacts.

Description

API to create demo contacts.

Parameters

Name	Located in	Description	Required	Schema
country	query	country	No	string
tenantId	path	tenantId	Yes	long

Responses

Code	Description
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

---

contact-be-controller

Contact APIs for Belgium.

Contacts be

GET

Summary

Fetch contacts

Description

API to fetch existing contacts.

Parameters

Name	Located in	Description	Required	Schema
customfield	query	customfield	No	string
includeOpeningAmounts	query	includeOpeningAmounts	No	boolean
includeOweAmounts	query	includeOweAmounts	No	boolean
limit	query	limit	No	integer
page	query	page	No	integer
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	Contact's information have been fetched successfully.	ContactBEDto
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Contact.

Description

API to create new contact.

Parameters

Name	Located in	Description	Required	Schema
contactDto	body	contactDto	Yes	ContactBEDto

Responses

Code	Description	Schema
200	OK	ContactBEDto
201	Contact has been created successfully.	ContactBEDto
400	Contact creation failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts be/brief

GET

Summary

get contacts export

Description

request get contacts export by tenant and status.

Responses

Code	Description	Schema
200	get contacts export successful.	[ ContactBEDto ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts be/businessunits

GET

Summary

Fetch Govt's Business units

Description

API to fetch existing contacts.

Parameters

Name	Located in	Description	Required	Schema
limit	query	limit	No	integer
page	query	page	No	integer
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	Contact's information have been fetched successfully.	ContactBEDto
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts be/code/{code}

GET

Summary

Fetch contact by code.

Description

API to fetch existing contact by code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Contact's information have been fetched successfully.	ContactBEDto
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

Contacts be/codes

POST

Summary

Fetch contacts by list of codes.

Description

API to fetch existing contact by code.

Parameters

Name	Located in	Description	Required	Schema
codes	body	codes	Yes	[ string ]

Responses

Code	Description	Schema
200	Contact's information have been fetched successfully.	[ ContactBEDto ]
201	Created
401	Unauthorized
403	Forbidden
404	No contacts found with provided codes

Security

Security Schema	Scopes
Authorization	global

Contacts be/codes/status

PATCH

Summary

Bulk status update

Description

Bulk status update

Parameters

Name	Located in	Description	Required	Schema
contactCodes	body	contactCodes	Yes	[ string ]
status	query	status	Yes	string

Responses

Code	Description
200	Bulk status update done successfully
204	No Content
401	Unauthorized
403	Forbidden

Security

Security Schema	Scopes
Authorization	global

Contacts be/custom-fields

GET

Summary

Get custom field is used or not

Description

API to Get custom field is used or not

Parameters

Name	Located in	Description	Required	Schema
customCode	query	customCode	Yes	string

Responses

Code	Description	Schema
200	Custom fields status fetched successfully	boolean
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts be/details

POST

Summary

getContactDetails

Parameters

Name	Located in	Description	Required	Schema
contactCodes	body	contactCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	OK	[ ContactDetails ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts be/detailsbyaccount/{accountCode}

GET

Summary

Fetch contact details by account code

Description

Fetch contact details by account code used as receivable or payable account

Parameters

Name	Located in	Description	Required	Schema
accountCode	path	accountCode	Yes	string

Responses

Code	Description	Schema
200	OK	[ ContactDetails ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts be/detailsbyseqcodes

POST

Summary

getContactDetailsBySeqCodes

Parameters

Name	Located in	Description	Required	Schema
contactCodes	body	contactCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	OK	[ ContactDetails ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts be/import

POST

Summary

Contact.

Description

API to create new contact.

Parameters

Name	Located in	Description	Required	Schema
contactDtos	body	contactDtos	Yes	[ ContactBEDto ]

Responses

Code	Description	Schema
200	OK	[ object ]
201	Contacts are imported successfully.	[ object ]
400	Contact creation failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts be/info

POST

Summary

Fetch contact details by codes

Description

Fetch contact details by codes

Parameters

Name	Located in	Description	Required	Schema
codes	body	codes	Yes	[ string ]

Responses

Code	Description	Schema
200	OK	[ ContactInformation ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts be/names

POST

Summary

Fetch contacts by list of names.

Description

API to fetch existing contact by names.

Parameters

Name	Located in	Description	Required	Schema
names	body	names	Yes	[ string ]

Responses

Code	Description	Schema
200	Contact's information have been fetched successfully.	[ ContactBEDto ]
201	Created
401	Unauthorized
403	Forbidden
404	No contacts found with provided names

Security

Security Schema	Scopes
Authorization	global

Contacts be/{id}

GET

Summary

Fetch contact by id.

Description

API to fetch existing contact by it's id.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description	Schema
200	Contact's information have been fetched successfully.	ContactBEDto
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

PUT

Summary

Update contact.

Description

API to update existing contact.

Parameters

Name	Located in	Description	Required	Schema
contactDto	body	contactDto	Yes	ContactBEDto
id	path	id	Yes	long

Responses

Code	Description	Schema
200	Contact has been updated successfully.	ContactBEDto
201	Created
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete contacts

Description

Api to delete contact

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description
200	OK
204	Contact has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update contact attributes.

Description

API to update attributes of existing contact.

Parameters

Name	Located in	Description	Required	Schema
contactAttributeUpdateDto	body	contactAttributeUpdateDto	Yes	ContactAttributeUpdateDto
id	path	id	Yes	long

Responses

Code	Description	Schema
200	Contact attributes has been updated successfully.	ContactBEDto
204	No Content
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

Contacts be/{tenantId}

POST

Summary

Create demo Contacts.

Description

API to create demo contacts.

Parameters

Name	Located in	Description	Required	Schema
country	query	country	No	string
tenantId	path	tenantId	Yes	long

Responses

Code	Description
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

---

contact-canada-controller

Contact APIs for Canada.

Contacts ca

GET

Summary

Fetch contacts

Description

API to fetch existing contacts.

Parameters

Name	Located in	Description	Required	Schema
customfield	query	customfield	No	string
includeOpeningAmounts	query	includeOpeningAmounts	No	boolean
includeOweAmounts	query	includeOweAmounts	No	boolean
limit	query	limit	No	integer
page	query	page	No	integer
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	Contact's information have been fetched successfully.	ContactCanadaDto
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Contact.

Description

API to create new contact.

Parameters

Name	Located in	Description	Required	Schema
contactDto	body	contactDto	Yes	ContactCanadaDto

Responses

Code	Description	Schema
200	OK	ContactCanadaDto
201	Contact has been created successfully.	ContactCanadaDto
400	Contact creation failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts ca/brief

GET

Summary

get contacts export

Description

request get contacts export by tenant and status.

Responses

Code	Description	Schema
200	get contacts export successful.	[ ContactCanadaDto ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts ca/businessunits

GET

Summary

Fetch Govt's Business units

Description

API to fetch existing contacts.

Parameters

Name	Located in	Description	Required	Schema
limit	query	limit	No	integer
page	query	page	No	integer
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	Contact's information have been fetched successfully.	ContactCanadaDto
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts ca/code/{code}

GET

Summary

Fetch contact by code.

Description

API to fetch existing contact by code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Contact's information have been fetched successfully.	ContactCanadaDto
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

Contacts ca/codes

POST

Summary

Fetch contacts by list of codes.

Description

API to fetch existing contact by code.

Parameters

Name	Located in	Description	Required	Schema
codes	body	codes	Yes	[ string ]

Responses

Code	Description	Schema
200	Contact's information have been fetched successfully.	[ ContactCanadaDto ]
201	Created
401	Unauthorized
403	Forbidden
404	No contacts found with provided codes

Security

Security Schema	Scopes
Authorization	global

Contacts ca/codes/status

PATCH

Summary

Bulk status update

Description

Bulk status update

Parameters

Name	Located in	Description	Required	Schema
contactCodes	body	contactCodes	Yes	[ string ]
status	query	status	Yes	string

Responses

Code	Description
200	Bulk status update done successfully
204	No Content
401	Unauthorized
403	Forbidden

Security

Security Schema	Scopes
Authorization	global

Contacts ca/custom-fields

GET

Summary

Get custom field is used or not

Description

API to Get custom field is used or not

Parameters

Name	Located in	Description	Required	Schema
customCode	query	customCode	Yes	string

Responses

Code	Description	Schema
200	Custom fields status fetched successfully	boolean
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts ca/details

POST

Summary

getContactDetails

Parameters

Name	Located in	Description	Required	Schema
contactCodes	body	contactCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	OK	[ ContactDetails ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts ca/detailsbyaccount/{accountCode}

GET

Summary

Fetch contact details by account code

Description

Fetch contact details by account code used as receivable or payable account

Parameters

Name	Located in	Description	Required	Schema
accountCode	path	accountCode	Yes	string

Responses

Code	Description	Schema
200	OK	[ ContactDetails ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts ca/detailsbyseqcodes

POST

Summary

getContactDetailsBySeqCodes

Parameters

Name	Located in	Description	Required	Schema
contactCodes	body	contactCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	OK	[ ContactDetails ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts ca/import

POST

Summary

Contact.

Description

API to create new contact.

Parameters

Name	Located in	Description	Required	Schema
contactDtos	body	contactDtos	Yes	[ ContactCanadaDto ]

Responses

Code	Description	Schema
200	OK	[ object ]
201	Contacts are imported successfully.	[ object ]
400	Contact creation failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts ca/info

POST

Summary

Fetch contact details by codes

Description

Fetch contact details by codes

Parameters

Name	Located in	Description	Required	Schema
codes	body	codes	Yes	[ string ]

Responses

Code	Description	Schema
200	OK	[ ContactInformation ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts ca/names

POST

Summary

Fetch contacts by list of names.

Description

API to fetch existing contact by names.

Parameters

Name	Located in	Description	Required	Schema
names	body	names	Yes	[ string ]

Responses

Code	Description	Schema
200	Contact's information have been fetched successfully.	[ ContactCanadaDto ]
201	Created
401	Unauthorized
403	Forbidden
404	No contacts found with provided names

Security

Security Schema	Scopes
Authorization	global

Contacts ca/{id}

GET

Summary

Fetch contact by id.

Description

API to fetch existing contact by it's id.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description	Schema
200	Contact's information have been fetched successfully.	ContactCanadaDto
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

PUT

Summary

Update contact.

Description

API to update existing contact.

Parameters

Name	Located in	Description	Required	Schema
contactDto	body	contactDto	Yes	ContactCanadaDto
id	path	id	Yes	long

Responses

Code	Description	Schema
200	Contact has been updated successfully.	ContactCanadaDto
201	Created
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete contacts

Description

Api to delete contact

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description
200	OK
204	Contact has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update contact attributes.

Description

API to update attributes of existing contact.

Parameters

Name	Located in	Description	Required	Schema
contactAttributeUpdateDto	body	contactAttributeUpdateDto	Yes	ContactAttributeUpdateDto
id	path	id	Yes	long

Responses

Code	Description	Schema
200	Contact attributes has been updated successfully.	ContactCanadaDto
204	No Content
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

Contacts ca/{tenantId}

POST

Summary

Create demo Contacts.

Description

API to create demo contacts.

Parameters

Name	Located in	Description	Required	Schema
country	query	country	No	string
tenantId	path	tenantId	Yes	long

Responses

Code	Description
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

---

contact-germany-controller

Contact APIs for Germany.

Contacts de

GET

Summary

Fetch contacts

Description

API to fetch existing contacts.

Parameters

Name	Located in	Description	Required	Schema
customfield	query	customfield	No	string
includeOpeningAmounts	query	includeOpeningAmounts	No	boolean
includeOweAmounts	query	includeOweAmounts	No	boolean
limit	query	limit	No	integer
page	query	page	No	integer
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	Contact's information have been fetched successfully.	ContactGermanyDto
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Contact.

Description

API to create new contact.

Parameters

Name	Located in	Description	Required	Schema
contactDto	body	contactDto	Yes	ContactGermanyDto

Responses

Code	Description	Schema
200	OK	ContactGermanyDto
201	Contact has been created successfully.	ContactGermanyDto
400	Contact creation failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts de/brief

GET

Summary

get contacts export

Description

request get contacts export by tenant and status.

Responses

Code	Description	Schema
200	get contacts export successful.	[ ContactGermanyDto ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts de/businessunits

GET

Summary

Fetch Govt's Business units

Description

API to fetch existing contacts.

Parameters

Name	Located in	Description	Required	Schema
limit	query	limit	No	integer
page	query	page	No	integer
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	Contact's information have been fetched successfully.	ContactGermanyDto
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts de/code/{code}

GET

Summary

Fetch contact by code.

Description

API to fetch existing contact by code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Contact's information have been fetched successfully.	ContactGermanyDto
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

Contacts de/codes

POST

Summary

Fetch contacts by list of codes.

Description

API to fetch existing contact by code.

Parameters

Name	Located in	Description	Required	Schema
codes	body	codes	Yes	[ string ]

Responses

Code	Description	Schema
200	Contact's information have been fetched successfully.	[ ContactGermanyDto ]
201	Created
401	Unauthorized
403	Forbidden
404	No contacts found with provided codes

Security

Security Schema	Scopes
Authorization	global

Contacts de/codes/status

PATCH

Summary

Bulk status update

Description

Bulk status update

Parameters

Name	Located in	Description	Required	Schema
contactCodes	body	contactCodes	Yes	[ string ]
status	query	status	Yes	string

Responses

Code	Description
200	Bulk status update done successfully
204	No Content
401	Unauthorized
403	Forbidden

Security

Security Schema	Scopes
Authorization	global

Contacts de/custom-fields

GET

Summary

Get custom field is used or not

Description

API to Get custom field is used or not

Parameters

Name	Located in	Description	Required	Schema
customCode	query	customCode	Yes	string

Responses

Code	Description	Schema
200	Custom fields status fetched successfully	boolean
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts de/details

POST

Summary

getContactDetails

Parameters

Name	Located in	Description	Required	Schema
contactCodes	body	contactCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	OK	[ ContactDetails ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts de/detailsbyaccount/{accountCode}

GET

Summary

Fetch contact details by account code

Description

Fetch contact details by account code used as receivable or payable account

Parameters

Name	Located in	Description	Required	Schema
accountCode	path	accountCode	Yes	string

Responses

Code	Description	Schema
200	OK	[ ContactDetails ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts de/detailsbyseqcodes

POST

Summary

getContactDetailsBySeqCodes

Parameters

Name	Located in	Description	Required	Schema
contactCodes	body	contactCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	OK	[ ContactDetails ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts de/import

POST

Summary

Contact.

Description

API to create new contact.

Parameters

Name	Located in	Description	Required	Schema
contactDtos	body	contactDtos	Yes	[ ContactGermanyDto ]

Responses

Code	Description	Schema
200	OK	[ object ]
201	Contacts are imported successfully.	[ object ]
400	Contact creation failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts de/info

POST

Summary

Fetch contact details by codes

Description

Fetch contact details by codes

Parameters

Name	Located in	Description	Required	Schema
codes	body	codes	Yes	[ string ]

Responses

Code	Description	Schema
200	OK	[ ContactInformation ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts de/names

POST

Summary

Fetch contacts by list of names.

Description

API to fetch existing contact by names.

Parameters

Name	Located in	Description	Required	Schema
names	body	names	Yes	[ string ]

Responses

Code	Description	Schema
200	Contact's information have been fetched successfully.	[ ContactGermanyDto ]
201	Created
401	Unauthorized
403	Forbidden
404	No contacts found with provided names

Security

Security Schema	Scopes
Authorization	global

Contacts de/{id}

GET

Summary

Fetch contact by id.

Description

API to fetch existing contact by it's id.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description	Schema
200	Contact's information have been fetched successfully.	ContactGermanyDto
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

PUT

Summary

Update contact.

Description

API to update existing contact.

Parameters

Name	Located in	Description	Required	Schema
contactDto	body	contactDto	Yes	ContactGermanyDto
id	path	id	Yes	long

Responses

Code	Description	Schema
200	Contact has been updated successfully.	ContactGermanyDto
201	Created
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete contacts

Description

Api to delete contact

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description
200	OK
204	Contact has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update contact attributes.

Description

API to update attributes of existing contact.

Parameters

Name	Located in	Description	Required	Schema
contactAttributeUpdateDto	body	contactAttributeUpdateDto	Yes	ContactAttributeUpdateDto
id	path	id	Yes	long

Responses

Code	Description	Schema
200	Contact attributes has been updated successfully.	ContactGermanyDto
204	No Content
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

Contacts de/{tenantId}

POST

Summary

Create demo Contacts.

Description

API to create demo contacts.

Parameters

Name	Located in	Description	Required	Schema
country	query	country	No	string
tenantId	path	tenantId	Yes	long

Responses

Code	Description
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

---

migration-controller

Contact APIs.

Contacts docseqcodemigration

POST

Summary

Contact.

Description

API to create new contact.

Responses

Code	Description	Schema
200	OK	ContactDto
201	Contact has been created successfully.	ContactDto
400	Contact creation failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

---

contact-indonesia-controller

Contact APIs for Indonesia.

Contacts id

GET

Summary

Fetch contacts

Description

API to fetch existing contacts.

Parameters

Name	Located in	Description	Required	Schema
customfield	query	customfield	No	string
includeOpeningAmounts	query	includeOpeningAmounts	No	boolean
includeOweAmounts	query	includeOweAmounts	No	boolean
limit	query	limit	No	integer
page	query	page	No	integer
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	Contact's information have been fetched successfully.	ContactIndonesiaDto
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

v1/contacts/id

Description

API to create new contact.

Parameters

Name	Located in	Description	Required	Schema
contactDto	body	contactDto	Yes	ContactIndonesiaDto

Responses

Code	Description	Schema
200	OK	ContactDto
201	Contact has been created successfully.	ContactDto
400	Contact creation failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts id/code/{code}

GET

Summary

Fetch contact by code.

Description

API to fetch existing contact by code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Contact's information have been fetched successfully.	ContactIndonesiaDto
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

Contacts id/codes

POST

Summary

Fetch contacts by list of codes.

Description

API to fetch existing contact by code.

Parameters

Name	Located in	Description	Required	Schema
codes	body	codes	Yes	[ string ]

Responses

Code	Description	Schema
200	Contact's information have been fetched successfully.	[ ContactIndonesiaDto ]
201	Created
401	Unauthorized
403	Forbidden
404	No contacts found with provided codes

Security

Security Schema	Scopes
Authorization	global

Contacts id/codes/status

PATCH

Summary

Bulk status update

Description

Bulk status update

Parameters

Name	Located in	Description	Required	Schema
contactCodes	body	contactCodes	Yes	[ string ]
status	query	status	Yes	string

Responses

Code	Description
200	Bulk status update done successfully
204	No Content
401	Unauthorized
403	Forbidden

Security

Security Schema	Scopes
Authorization	global

Contacts id/details

POST

Summary

getContactDetails

Parameters

Name	Located in	Description	Required	Schema
contactCodes	body	contactCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	OK	[ ContactDetails ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts id/import

POST

Summary

Contact.

Description

API to create new contact.

Parameters

Name	Located in	Description	Required	Schema
contactDtos	body	contactDtos	Yes	[ ContactIndonesiaDto ]

Responses

Code	Description	Schema
200	OK	[ object ]
201	Contacts are imported successfully.	[ object ]
400	Contact creation failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts id/names

POST

Summary

Fetch contacts by list of names.

Description

API to fetch existing contact by names.

Parameters

Name	Located in	Description	Required	Schema
names	body	names	Yes	[ string ]

Responses

Code	Description	Schema
200	Contact's information have been fetched successfully.	[ ContactIndonesiaDto ]
201	Created
401	Unauthorized
403	Forbidden
404	No contacts found with provided names

Security

Security Schema	Scopes
Authorization	global

Contacts id/{id}

GET

Summary

Fetch contact by id.

Description

API to fetch existing contact by it's id.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description	Schema
200	Contact's information have been fetched successfully.	ContactIndonesiaDto
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

PUT

Summary

Update contact.

Description

API to update existing contact.

Parameters

Name	Located in	Description	Required	Schema
contactDto	body	contactDto	Yes	ContactIndonesiaDto
id	path	id	Yes	long

Responses

Code	Description	Schema
200	Contact has been updated successfully.	ContactIndonesiaDto
201	Created
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete contacts

Description

Api to delete contact

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description
200	OK
204	Contact has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update contact attributes.

Description

API to update attributes of existing contact.

Parameters

Name	Located in	Description	Required	Schema
contactAttributeUpdateDto	body	contactAttributeUpdateDto	Yes	ContactAttributeUpdateDto
id	path	id	Yes	long

Responses

Code	Description	Schema
200	Contact attributes has been updated successfully.	ContactIndonesiaDto
204	No Content
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

---

contact-israel-controller

Contact APIs for Israel.

Contacts il

GET

Summary

Fetch contacts

Description

API to fetch existing contacts.

Parameters

Name	Located in	Description	Required	Schema
customfield	query	customfield	No	string
includeOpeningAmounts	query	includeOpeningAmounts	No	boolean
includeOweAmounts	query	includeOweAmounts	No	boolean
limit	query	limit	No	integer
page	query	page	No	integer
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	Contact's information have been fetched successfully.	ContactIsraelDto
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

v1/contacts/ph

Description

API to create new contact.

Parameters

Name	Located in	Description	Required	Schema
contactDto	body	contactDto	Yes	ContactIsraelDto

Responses

Code	Description	Schema
200	OK	ContactDto
201	Contact has been created successfully.	ContactDto
400	Contact creation failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts il/brief

GET

Summary

get contacts export

Description

request get contacts export by tenant and status.

Responses

Code	Description	Schema
200	get contacts export successful.	[ ContactIsraelDto ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts il/bulk-delete

DELETE

Summary

Delete contacts

Description

Api to delete contacts in bulk

Parameters

Name	Located in	Description	Required	Schema
contactIds	body	contactIds	Yes	[ long ]

Responses

Code	Description	Schema
200	OK	ResponseEntity
204	Contact has been deleted successfully.	ResponseEntity
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

Contacts il/code/{code}

GET

Summary

Fetch contact by code.

Description

API to fetch existing contact by code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Contact's information have been fetched successfully.	ContactIsraelDto
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

Contacts il/codes

POST

Summary

Fetch contacts by list of codes.

Description

API to fetch existing contact by code.

Parameters

Name	Located in	Description	Required	Schema
codes	body	codes	Yes	[ string ]

Responses

Code	Description	Schema
200	Contact's information have been fetched successfully.	[ ContactIsraelDto ]
201	Created
401	Unauthorized
403	Forbidden
404	No contacts found with provided codes

Security

Security Schema	Scopes
Authorization	global

Contacts il/codes/status

PATCH

Summary

Bulk status update

Description

Bulk status update

Parameters

Name	Located in	Description	Required	Schema
contactCodes	body	contactCodes	Yes	[ string ]
status	query	status	Yes	string

Responses

Code	Description
200	Bulk status update done successfully
204	No Content
401	Unauthorized
403	Forbidden

Security

Security Schema	Scopes
Authorization	global

Contacts il/details

POST

Summary

getContactDetails

Parameters

Name	Located in	Description	Required	Schema
contactCodes	body	contactCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	OK	[ ContactDetails ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts il/import

POST

Summary

Contact.

Description

API to create new contact.

Parameters

Name	Located in	Description	Required	Schema
contactDtos	body	contactDtos	Yes	[ ContactIsraelDto ]

Responses

Code	Description	Schema
200	OK	[ object ]
201	Contacts are imported successfully.	[ object ]
400	Contact creation failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts il/names

POST

Summary

Fetch contacts by list of names.

Description

API to fetch existing contact by names.

Parameters

Name	Located in	Description	Required	Schema
names	body	names	Yes	[ string ]

Responses

Code	Description	Schema
200	Contact's information have been fetched successfully.	[ ContactIsraelDto ]
201	Created
401	Unauthorized
403	Forbidden
404	No contacts found with provided names

Security

Security Schema	Scopes
Authorization	global

Contacts il/{id}

GET

Summary

Fetch contact by id.

Description

API to fetch existing contact by it's id.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description	Schema
200	Contact's information have been fetched successfully.	ContactIsraelDto
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

PUT

Summary

Update contact.

Description

API to update existing contact.

Parameters

Name	Located in	Description	Required	Schema
contactDto	body	contactDto	Yes	ContactIsraelDto
id	path	id	Yes	long

Responses

Code	Description	Schema
200	Contact has been updated successfully.	ContactIsraelDto
201	Created
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete contacts

Description

Api to delete contact

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description
200	OK
204	Contact has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update contact attributes.

Description

API to update attributes of existing contact.

Parameters

Name	Located in	Description	Required	Schema
contactAttributeUpdateDto	body	contactAttributeUpdateDto	Yes	ContactAttributeUpdateDto
id	path	id	Yes	long

Responses

Code	Description	Schema
200	Contact attributes has been updated successfully.	ContactIsraelDto
204	No Content
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

---

with-holding-tax-payment-group-israel-controller

Withholding Tax Group APIs.

POST

Summary

Create Withholding Tax Group.

Description

API to Create Withholding Tax Group.

Parameters

Name	Located in	Description	Required	Schema
withHoldingTaxGroupRequest	body	withHoldingTaxGroupRequest	Yes	WithHoldingTaxPaymentGroupRequest

Responses

Code	Description	Schema
200	OK	WithHoldingTaxPaymentGroupIsraelDto
201	Withholding Tax Group has been updated successfully.	WithHoldingTaxPaymentGroupIsraelDto
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts il/withholdingTaxGroup/all

GET

Summary

Fetch Withholding Tax Group.

Description

API to Fetch Withholding Tax Group.

Responses

Code	Description	Schema
200	Withholding Tax Group has been fetched successfully.	WithHoldingTaxPaymentGroupIsraelDto
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts il/withholdingTaxGroup/{id}

GET

Summary

Get Withholding Tax Group by Id.

Description

API to Get Withholding Tax Group by Id.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description	Schema
200	Withholding Tax Group has been fetched successfully.	WithHoldingTaxPaymentGroupIsraelDto
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

PUT

Summary

Update Withholding Tax Group.

Description

API to Update Withholding Tax Group.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
withHoldingTaxGroupRequest	body	withHoldingTaxGroupRequest	Yes	WithHoldingTaxPaymentGroupRequest

Responses

Code	Description	Schema
200	Withholding Tax Group has been update successfully.	WithHoldingTaxPaymentGroupIsraelDto
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete Withholding Tax Group.

Description

API to Delete Withholding Tax Group.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description	Schema
200	Withholding Tax Group has been deleted successfully.	WithHoldingTaxPaymentGroupIsraelDto
204	No Content
401	Unauthorized
403	Forbidden

Security

Security Schema	Scopes
Authorization	global

---

contact-india-controller

Contact APIs for India.

Contacts in

GET

Summary

Fetch contacts

Description

API to fetch existing contacts.

Parameters

Name	Located in	Description	Required	Schema
customfield	query	customfield	No	string
includeOpeningAmounts	query	includeOpeningAmounts	No	boolean
includeOweAmounts	query	includeOweAmounts	No	boolean
limit	query	limit	No	integer
page	query	page	No	integer
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	Contact's information have been fetched successfully.	ContactIndiaDto
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

v1/contacts/in

Description

API to create new contact.

Parameters

Name	Located in	Description	Required	Schema
contactDto	body	contactDto	Yes	ContactIndiaDto

Responses

Code	Description	Schema
200	OK	ContactIndiaDto
201	Contact has been created successfully.	ContactIndiaDto
400	Contact creation failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts in/brief

GET

Summary

get contacts export

Description

request get contacts export by tenant and status.

Responses

Code	Description	Schema
200	get contacts export successful.	[ ContactIndiaDto ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts in/code/{code}

GET

Summary

Fetch contact by code.

Description

API to fetch existing contact by code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Contact's information have been fetched successfully.	ContactIndiaDto
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

Contacts in/codes

POST

Summary

Fetch contacts by list of codes.

Description

API to fetch existing contact by code.

Parameters

Name	Located in	Description	Required	Schema
codes	body	codes	Yes	[ string ]

Responses

Code	Description	Schema
200	Contact's information have been fetched successfully.	[ ContactIndiaDto ]
201	Created
401	Unauthorized
403	Forbidden
404	No contacts found with provided codes

Security

Security Schema	Scopes
Authorization	global

Contacts in/codes/status

PATCH

Summary

Bulk status update

Description

Bulk status update

Parameters

Name	Located in	Description	Required	Schema
contactCodes	body	contactCodes	Yes	[ string ]
status	query	status	Yes	string

Responses

Code	Description
200	Bulk status update done successfully
204	No Content
401	Unauthorized
403	Forbidden

Security

Security Schema	Scopes
Authorization	global

Contacts in/details

POST

Summary

getContactDetails

Parameters

Name	Located in	Description	Required	Schema
contactCodes	body	contactCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	OK	[ ContactDetails ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts in/import

POST

Summary

Contact.

Description

API to create new contact.

Parameters

Name	Located in	Description	Required	Schema
contactDtos	body	contactDtos	Yes	[ ContactIndiaDto ]

Responses

Code	Description	Schema
200	OK	[ object ]
201	Contacts are imported successfully.	[ object ]
400	Contact creation failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts in/names

POST

Summary

Fetch contacts by list of names.

Description

API to fetch existing contact by names.

Parameters

Name	Located in	Description	Required	Schema
names	body	names	Yes	[ string ]

Responses

Code	Description	Schema
200	Contact's information have been fetched successfully.	[ ContactIndiaDto ]
201	Created
401	Unauthorized
403	Forbidden
404	No contacts found with provided names

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create India Compliance TDS Deductee.

Description

Create India Compliance TDS Deductee.

Parameters

Name	Located in	Description	Required	Schema
tdsDeducteeIndiaRequest	body	tdsDeducteeIndiaRequest	Yes	TdsDeducteeIndiaRequest

Responses

Code	Description	Schema
200	OK	TdsDeducteeResponse
201	TDS Deductee created successfully.	TdsDeducteeResponse
400	TDS Deductee creation failed.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

PUT

Summary

Update India Compliance TDS Deductee.

Description

Update India Compliance TDS Deductee.

Parameters

Name	Located in	Description	Required	Schema
tdsDeducteeIndiaRequest	body	tdsDeducteeIndiaRequest	Yes	TdsDeducteeIndiaRequest

Responses

Code	Description	Schema
200	OK	TdsDeducteeResponse
201	TDS Deductee updated successfully.	TdsDeducteeResponse
400	TDS Deductee updation failed.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete TDS Deductee.

Description

Delete TDS Deductee.

Parameters

Name	Located in	Description	Required	Schema
types	body	types	Yes	[ string ]

Responses

Code	Description	Schema
200	OK	ResponseEntity
204	TDS Deductee has been deleted successfully.	ResponseEntity
401	Unauthorized
403	Forbidden
404	TDS deductee with type %s not found.

Security

Security Schema	Scopes
Authorization	global

Contacts in/tds-rate

GET

Summary

Get TDS rates.

Description

Get TDS rates.

Parameters

Name	Located in	Description	Required	Schema
limit	query	limit	No	integer
page	query	page	No	integer
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string

Responses

Code	Description	Schema
200	Fetched TDS rates successfully.	TdsRateResponse
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create India Compliance TDS Rate.

Description

Create India Compliance TDS Rate.

Parameters

Name	Located in	Description	Required	Schema
tdsRateIndiaRequest	body	tdsRateIndiaRequest	Yes	TdsRateIndiaRequest

Responses

Code	Description	Schema
200	OK	TdsRateResponse
201	TDS rate created successfully.	TdsRateResponse
400	TDS rate creation failed.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

PUT

Summary

Update India Compliance TDS rate.

Description

Update India Compliance TDS rate.

Parameters

Name	Located in	Description	Required	Schema
tdsRateIndiaRequest	body	tdsRateIndiaRequest	Yes	TdsRateIndiaRequest

Responses

Code	Description	Schema
200	OK	TdsRateResponse
201	TDS rate updated successfully.	TdsRateResponse
400	TDS rate updation failed.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete TDS rate.

Description

Delete TDS rate.

Parameters

Name	Located in	Description	Required	Schema
ids	body	ids	Yes	[ long ]

Responses

Code	Description	Schema
200	OK	ResponseEntity
204	TDS rate has been deleted successfully.	ResponseEntity
401	Unauthorized
403	Forbidden
404	TDS rate with id %d not found.

Security

Security Schema	Scopes
Authorization	global

Contacts in/tds-rate-detail

GET

Summary

fetch tds rate by nature of payment

Description

api to fetch tds rate by nature of payment

Parameters

Name	Located in	Description	Required	Schema
deducteeType	query		No	string
documentDate	query		No	string
natureOfPayment	query		No	string
resident	query		No	boolean

Responses

Code	Description	Schema
200	tds rate fetched successfully	TdsRateIndiaResponse
401	Unauthorized
403	Forbidden
404	not able to find tds rate

Security

Security Schema	Scopes
Authorization	global

Contacts in/tds-rate-details

POST

Summary

fetch tds rate by nature of payment

Description

api to fetch tds rate by nature of payment

Parameters

Name	Located in	Description	Required	Schema
tdsRateRequest	body	tdsRateRequest	Yes	TdsRateRequest

Responses

Code	Description	Schema
200	tds rate fetched successfully	TdsRateIndiaResponse
201	Created
401	Unauthorized
403	Forbidden
404	not able to find tds rate

Security

Security Schema	Scopes
Authorization	global

Contacts in/{id}

GET

Summary

Fetch contact by id.

Description

API to fetch existing contact by it's id.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description	Schema
200	Contact's information have been fetched successfully.	ContactIndiaDto
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

PUT

Summary

Update contact.

Description

API to update existing contact.

Parameters

Name	Located in	Description	Required	Schema
contactDto	body	contactDto	Yes	ContactIndiaDto
id	path	id	Yes	long

Responses

Code	Description	Schema
200	Contact has been updated successfully.	ContactIndiaDto
201	Created
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete contacts

Description

Api to delete contact

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description
200	OK
204	Contact has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update contact attributes.

Description

API to update attributes of existing contact.

Parameters

Name	Located in	Description	Required	Schema
contactAttributeUpdateDto	body	contactAttributeUpdateDto	Yes	ContactAttributeUpdateDto
id	path	id	Yes	long

Responses

Code	Description	Schema
200	Contact attributes has been updated successfully.	ContactIndiaDto
204	No Content
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

---

contact-malaysia-controller

Contact APIs for Malaysia.

Contacts my

GET

Summary

Fetch contacts

Description

API to fetch existing contacts.

Parameters

Name	Located in	Description	Required	Schema
customfield	query	customfield	No	string
includeOpeningAmounts	query	includeOpeningAmounts	No	boolean
includeOweAmounts	query	includeOweAmounts	No	boolean
limit	query	limit	No	integer
page	query	page	No	integer
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	Contact's information have been fetched successfully.	ContactMalaysiaDto
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

v1/contacts/my

Description

API to create new contact.

Parameters

Name	Located in	Description	Required	Schema
contactDto	body	contactDto	Yes	ContactMalaysiaDto

Responses

Code	Description	Schema
200	OK	ContactDto
201	Contact has been created successfully.	ContactDto
400	Contact creation failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts my/brief

GET

Summary

get contacts export

Description

request get contacts export by tenant and status.

Responses

Code	Description	Schema
200	get contacts export successful.	[ ContactMalaysiaDto ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts my/code/{code}

GET

Summary

Fetch contact by code.

Description

API to fetch existing contact by code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Contact's information have been fetched successfully.	ContactMalaysiaDto
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

Contacts my/codes

POST

Summary

Fetch contacts by list of codes.

Description

API to fetch existing contact by code.

Parameters

Name	Located in	Description	Required	Schema
codes	body	codes	Yes	[ string ]

Responses

Code	Description	Schema
200	Contact's information have been fetched successfully.	[ ContactMalaysiaDto ]
201	Created
401	Unauthorized
403	Forbidden
404	No contacts found with provided codes

Security

Security Schema	Scopes
Authorization	global

Contacts my/codes/status

PATCH

Summary

Bulk status update

Description

Bulk status update

Parameters

Name	Located in	Description	Required	Schema
contactCodes	body	contactCodes	Yes	[ string ]
status	query	status	Yes	string

Responses

Code	Description
200	Bulk status update done successfully
204	No Content
401	Unauthorized
403	Forbidden

Security

Security Schema	Scopes
Authorization	global

Contacts my/details

POST

Summary

getContactDetails

Parameters

Name	Located in	Description	Required	Schema
contactCodes	body	contactCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	OK	[ ContactDetails ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts my/import

POST

Summary

Contact.

Description

API to create new contact.

Parameters

Name	Located in	Description	Required	Schema
contactDtos	body	contactDtos	Yes	[ ContactMalaysiaDto ]

Responses

Code	Description	Schema
200	OK	[ object ]
201	Contacts are imported successfully.	[ object ]
400	Contact creation failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts my/names

POST

Summary

Fetch contacts by list of names.

Description

API to fetch existing contact by names.

Parameters

Name	Located in	Description	Required	Schema
names	body	names	Yes	[ string ]

Responses

Code	Description	Schema
200	Contact's information have been fetched successfully.	[ ContactMalaysiaDto ]
201	Created
401	Unauthorized
403	Forbidden
404	No contacts found with provided names

Security

Security Schema	Scopes
Authorization	global

Contacts my/{id}

GET

Summary

Fetch contact by id.

Description

API to fetch existing contact by it's id.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description	Schema
200	Contact's information have been fetched successfully.	ContactMalaysiaDto
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

PUT

Summary

Update contact.

Description

API to update existing contact.

Parameters

Name	Located in	Description	Required	Schema
contactDto	body	contactDto	Yes	ContactMalaysiaDto
id	path	id	Yes	long

Responses

Code	Description	Schema
200	Contact has been updated successfully.	ContactMalaysiaDto
201	Created
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete contacts

Description

Api to delete contact

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description
200	OK
204	Contact has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update contact attributes.

Description

API to update attributes of existing contact.

Parameters

Name	Located in	Description	Required	Schema
contactAttributeUpdateDto	body	contactAttributeUpdateDto	Yes	ContactAttributeUpdateDto
id	path	id	Yes	long

Responses

Code	Description	Schema
200	Contact attributes has been updated successfully.	ContactMalaysiaDto
204	No Content
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

---

contact-nl-controller

Contact APIs for Netherlands.

Contacts nl

GET

Summary

Fetch contacts

Description

API to fetch existing contacts.

Parameters

Name	Located in	Description	Required	Schema
customfield	query	customfield	No	string
includeOpeningAmounts	query	includeOpeningAmounts	No	boolean
includeOweAmounts	query	includeOweAmounts	No	boolean
limit	query	limit	No	integer
page	query	page	No	integer
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	Contact's information have been fetched successfully.	ContactNLDto
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Contact.

Description

API to create new contact.

Parameters

Name	Located in	Description	Required	Schema
contactDto	body	contactDto	Yes	ContactNLDto

Responses

Code	Description	Schema
200	OK	ContactNLDto
201	Contact has been created successfully.	ContactNLDto
400	Contact creation failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts nl/brief

GET

Summary

get contacts export

Description

request get contacts export by tenant and status.

Responses

Code	Description	Schema
200	get contacts export successful.	[ ContactNLDto ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts nl/businessunits

GET

Summary

Fetch Govt's Business units

Description

API to fetch existing contacts.

Parameters

Name	Located in	Description	Required	Schema
limit	query	limit	No	integer
page	query	page	No	integer
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	Contact's information have been fetched successfully.	ContactNLDto
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts nl/code/{code}

GET

Summary

Fetch contact by code.

Description

API to fetch existing contact by code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Contact's information have been fetched successfully.	ContactNLDto
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

Contacts nl/codes

POST

Summary

Fetch contacts by list of codes.

Description

API to fetch existing contact by code.

Parameters

Name	Located in	Description	Required	Schema
codes	body	codes	Yes	[ string ]

Responses

Code	Description	Schema
200	Contact's information have been fetched successfully.	[ ContactNLDto ]
201	Created
401	Unauthorized
403	Forbidden
404	No contacts found with provided codes

Security

Security Schema	Scopes
Authorization	global

Contacts nl/codes/status

PATCH

Summary

Bulk status update

Description

Bulk status update

Parameters

Name	Located in	Description	Required	Schema
contactCodes	body	contactCodes	Yes	[ string ]
status	query	status	Yes	string

Responses

Code	Description
200	Bulk status update done successfully
204	No Content
401	Unauthorized
403	Forbidden

Security

Security Schema	Scopes
Authorization	global

Contacts nl/custom-fields

GET

Summary

Get custom field is used or not

Description

API to Get custom field is used or not

Parameters

Name	Located in	Description	Required	Schema
customCode	query	customCode	Yes	string

Responses

Code	Description	Schema
200	Custom fields status fetched successfully	boolean
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts nl/details

POST

Summary

getContactDetails

Parameters

Name	Located in	Description	Required	Schema
contactCodes	body	contactCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	OK	[ ContactDetails ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts nl/detailsbyaccount/{accountCode}

GET

Summary

Fetch contact details by account code

Description

Fetch contact details by account code used as receivable or payable account

Parameters

Name	Located in	Description	Required	Schema
accountCode	path	accountCode	Yes	string

Responses

Code	Description	Schema
200	OK	[ ContactDetails ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts nl/detailsbyseqcodes

POST

Summary

getContactDetailsBySeqCodes

Parameters

Name	Located in	Description	Required	Schema
contactCodes	body	contactCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	OK	[ ContactDetails ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts nl/import

POST

Summary

Contact.

Description

API to create new contact.

Parameters

Name	Located in	Description	Required	Schema
contactDtos	body	contactDtos	Yes	[ ContactNLDto ]

Responses

Code	Description	Schema
200	OK	[ object ]
201	Contacts are imported successfully.	[ object ]
400	Contact creation failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts nl/info

POST

Summary

Fetch contact details by codes

Description

Fetch contact details by codes

Parameters

Name	Located in	Description	Required	Schema
codes	body	codes	Yes	[ string ]

Responses

Code	Description	Schema
200	OK	[ ContactInformation ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts nl/names

POST

Summary

Fetch contacts by list of names.

Description

API to fetch existing contact by names.

Parameters

Name	Located in	Description	Required	Schema
names	body	names	Yes	[ string ]

Responses

Code	Description	Schema
200	Contact's information have been fetched successfully.	[ ContactNLDto ]
201	Created
401	Unauthorized
403	Forbidden
404	No contacts found with provided names

Security

Security Schema	Scopes
Authorization	global

Contacts nl/{id}

GET

Summary

Fetch contact by id.

Description

API to fetch existing contact by it's id.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description	Schema
200	Contact's information have been fetched successfully.	ContactNLDto
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

PUT

Summary

Update contact.

Description

API to update existing contact.

Parameters

Name	Located in	Description	Required	Schema
contactDto	body	contactDto	Yes	ContactNLDto
id	path	id	Yes	long

Responses

Code	Description	Schema
200	Contact has been updated successfully.	ContactNLDto
201	Created
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete contacts

Description

Api to delete contact

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description
200	OK
204	Contact has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update contact attributes.

Description

API to update attributes of existing contact.

Parameters

Name	Located in	Description	Required	Schema
contactAttributeUpdateDto	body	contactAttributeUpdateDto	Yes	ContactAttributeUpdateDto
id	path	id	Yes	long

Responses

Code	Description	Schema
200	Contact attributes has been updated successfully.	ContactNLDto
204	No Content
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

Contacts nl/{tenantId}

POST

Summary

Create demo Contacts.

Description

API to create demo contacts.

Parameters

Name	Located in	Description	Required	Schema
country	query	country	No	string
tenantId	path	tenantId	Yes	long

Responses

Code	Description
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

---

contact-nz-controller

Contact APIs for New Zealand.

Contacts nz

GET

Summary

Fetch contacts

Description

API to fetch existing contacts.

Parameters

Name	Located in	Description	Required	Schema
customfield	query	customfield	No	string
includeOpeningAmounts	query	includeOpeningAmounts	No	boolean
includeOweAmounts	query	includeOweAmounts	No	boolean
limit	query	limit	No	integer
page	query	page	No	integer
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	Contact's information have been fetched successfully.	ContactNZDto
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Contact.

Description

API to create new contact.

Parameters

Name	Located in	Description	Required	Schema
contactDto	body	contactDto	Yes	ContactNZDto

Responses

Code	Description	Schema
200	OK	ContactNZDto
201	Contact has been created successfully.	ContactNZDto
400	Contact creation failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts nz/brief

GET

Summary

get contacts export

Description

request get contacts export by tenant and status.

Responses

Code	Description	Schema
200	get contacts export successful.	[ ContactNZDto ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts nz/businessunits

GET

Summary

Fetch Govt's Business units

Description

API to fetch existing contacts.

Parameters

Name	Located in	Description	Required	Schema
limit	query	limit	No	integer
page	query	page	No	integer
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	Contact's information have been fetched successfully.	ContactNZDto
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts nz/code/{code}

GET

Summary

Fetch contact by code.

Description

API to fetch existing contact by code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Contact's information have been fetched successfully.	ContactNZDto
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

Contacts nz/codes

POST

Summary

Fetch contacts by list of codes.

Description

API to fetch existing contact by code.

Parameters

Name	Located in	Description	Required	Schema
codes	body	codes	Yes	[ string ]

Responses

Code	Description	Schema
200	Contact's information have been fetched successfully.	[ ContactNZDto ]
201	Created
401	Unauthorized
403	Forbidden
404	No contacts found with provided codes

Security

Security Schema	Scopes
Authorization	global

Contacts nz/codes/status

PATCH

Summary

Bulk status update

Description

Bulk status update

Parameters

Name	Located in	Description	Required	Schema
contactCodes	body	contactCodes	Yes	[ string ]
status	query	status	Yes	string

Responses

Code	Description
200	Bulk status update done successfully
204	No Content
401	Unauthorized
403	Forbidden

Security

Security Schema	Scopes
Authorization	global

Contacts nz/custom-fields

GET

Summary

Get custom field is used or not

Description

API to Get custom field is used or not

Parameters

Name	Located in	Description	Required	Schema
customCode	query	customCode	Yes	string

Responses

Code	Description	Schema
200	Custom fields status fetched successfully	boolean
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts nz/details

POST

Summary

getContactDetails

Parameters

Name	Located in	Description	Required	Schema
contactCodes	body	contactCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	OK	[ ContactDetails ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts nz/detailsbyaccount/{accountCode}

GET

Summary

Fetch contact details by account code

Description

Fetch contact details by account code used as receivable or payable account

Parameters

Name	Located in	Description	Required	Schema
accountCode	path	accountCode	Yes	string

Responses

Code	Description	Schema
200	OK	[ ContactDetails ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts nz/detailsbyseqcodes

POST

Summary

getContactDetailsBySeqCodes

Parameters

Name	Located in	Description	Required	Schema
contactCodes	body	contactCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	OK	[ ContactDetails ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts nz/import

POST

Summary

Contact.

Description

API to create new contact.

Parameters

Name	Located in	Description	Required	Schema
contactDtos	body	contactDtos	Yes	[ ContactNZDto ]

Responses

Code	Description	Schema
200	OK	[ object ]
201	Contacts are imported successfully.	[ object ]
400	Contact creation failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts nz/info

POST

Summary

Fetch contact details by codes

Description

Fetch contact details by codes

Parameters

Name	Located in	Description	Required	Schema
codes	body	codes	Yes	[ string ]

Responses

Code	Description	Schema
200	OK	[ ContactInformation ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts nz/names

POST

Summary

Fetch contacts by list of names.

Description

API to fetch existing contact by names.

Parameters

Name	Located in	Description	Required	Schema
names	body	names	Yes	[ string ]

Responses

Code	Description	Schema
200	Contact's information have been fetched successfully.	[ ContactNZDto ]
201	Created
401	Unauthorized
403	Forbidden
404	No contacts found with provided names

Security

Security Schema	Scopes
Authorization	global

Contacts nz/{id}

GET

Summary

Fetch contact by id.

Description

API to fetch existing contact by it's id.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description	Schema
200	Contact's information have been fetched successfully.	ContactNZDto
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

PUT

Summary

Update contact.

Description

API to update existing contact.

Parameters

Name	Located in	Description	Required	Schema
contactDto	body	contactDto	Yes	ContactNZDto
id	path	id	Yes	long

Responses

Code	Description	Schema
200	Contact has been updated successfully.	ContactNZDto
201	Created
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete contacts

Description

Api to delete contact

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description
200	OK
204	Contact has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update contact attributes.

Description

API to update attributes of existing contact.

Parameters

Name	Located in	Description	Required	Schema
contactAttributeUpdateDto	body	contactAttributeUpdateDto	Yes	ContactAttributeUpdateDto
id	path	id	Yes	long

Responses

Code	Description	Schema
200	Contact attributes has been updated successfully.	ContactNZDto
204	No Content
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

Contacts nz/{tenantId}

POST

Summary

Create demo Contacts.

Description

API to create demo contacts.

Parameters

Name	Located in	Description	Required	Schema
country	query	country	No	string
tenantId	path	tenantId	Yes	long

Responses

Code	Description
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

---

payment-term-controller

Payment Term APIs.

POST

Summary

Create Payment Term.

Description

API to Create Payment Term.

Parameters

Name	Located in	Description	Required	Schema
paymentTermRequestDto	body	paymentTermRequestDto	Yes	PaymentTermRequestDto

Responses

Code	Description	Schema
200	OK	PaymentTermResponseDto
201	Payment term has been updated successfully.	PaymentTermResponseDto
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

PUT

Summary

Delete Payment Term.

Description

API to Delete Payment Term.

Parameters

Name	Located in	Description	Required	Schema
id	query	id	Yes	long
paymentTermRequestDto	body	paymentTermRequestDto	Yes	PaymentTermRequestDto

Responses

Code	Description	Schema
200	Payment term has been deleted successfully.	PaymentTermResponseDto
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete Payment Term.

Description

API to Delete Payment Term.

Parameters

Name	Located in	Description	Required	Schema
id	query	id	Yes	long

Responses

Code	Description	Schema
200	Payment term has been deleted successfully.	PaymentTermResponseDto
204	No Content
401	Unauthorized
403	Forbidden

Security

Security Schema	Scopes
Authorization	global

Contacts paymentTerms/list

GET

Summary

Fetch Payment Term.

Description

API to Fetch Payment Term.

Responses

Code	Description	Schema
200	Payment term has been fetched successfully.	PaymentTermResponseDto
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts paymentTerms/termIds

POST

Summary

Get Payment Term Details.

Description

API to Get Payment Term Details.

Parameters

Name	Located in	Description	Required	Schema
termIds	body	termIds	Yes	[ long ]

Responses

Code	Description	Schema
200	Payment term Details fetched successfully.	PaymentTermResponseDto
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

---

contact-philippines-controller

Contact APIs for Philippines.

Contacts ph

GET

Summary

Fetch contacts

Description

API to fetch existing contacts.

Parameters

Name	Located in	Description	Required	Schema
customfield	query	customfield	No	string
includeOpeningAmounts	query	includeOpeningAmounts	No	boolean
includeOweAmounts	query	includeOweAmounts	No	boolean
limit	query	limit	No	integer
page	query	page	No	integer
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	Contact's information have been fetched successfully.	ContactPhilippinesDto
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

v1/contacts/ph

Description

API to create new contact.

Parameters

Name	Located in	Description	Required	Schema
contactDto	body	contactDto	Yes	ContactPhilippinesDto

Responses

Code	Description	Schema
200	OK	ContactDto
201	Contact has been created successfully.	ContactDto
400	Contact creation failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts ph/code/{code}

GET

Summary

Fetch contact by code.

Description

API to fetch existing contact by code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Contact's information have been fetched successfully.	ContactPhilippinesDto
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

Contacts ph/codes

POST

Summary

Fetch contacts by list of codes.

Description

API to fetch existing contact by code.

Parameters

Name	Located in	Description	Required	Schema
codes	body	codes	Yes	[ string ]

Responses

Code	Description	Schema
200	Contact's information have been fetched successfully.	[ ContactPhilippinesDto ]
201	Created
401	Unauthorized
403	Forbidden
404	No contacts found with provided codes

Security

Security Schema	Scopes
Authorization	global

Contacts ph/codes/status

PATCH

Summary

Bulk status update

Description

Bulk status update

Parameters

Name	Located in	Description	Required	Schema
contactCodes	body	contactCodes	Yes	[ string ]
status	query	status	Yes	string

Responses

Code	Description
200	Bulk status update done successfully
204	No Content
401	Unauthorized
403	Forbidden

Security

Security Schema	Scopes
Authorization	global

Contacts ph/details

POST

Summary

getContactDetails

Parameters

Name	Located in	Description	Required	Schema
contactCodes	body	contactCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	OK	[ ContactDetails ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts ph/import

POST

Summary

Contact.

Description

API to create new contact.

Parameters

Name	Located in	Description	Required	Schema
contactDtos	body	contactDtos	Yes	[ ContactPhilippinesDto ]

Responses

Code	Description	Schema
200	OK	[ object ]
201	Contacts are imported successfully.	[ object ]
400	Contact creation failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts ph/names

POST

Summary

Fetch contacts by list of names.

Description

API to fetch existing contact by names.

Parameters

Name	Located in	Description	Required	Schema
names	body	names	Yes	[ string ]

Responses

Code	Description	Schema
200	Contact's information have been fetched successfully.	[ ContactPhilippinesDto ]
201	Created
401	Unauthorized
403	Forbidden
404	No contacts found with provided names

Security

Security Schema	Scopes
Authorization	global

Contacts ph/{id}

GET

Summary

Fetch contact by id.

Description

API to fetch existing contact by it's id.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description	Schema
200	Contact's information have been fetched successfully.	ContactPhilippinesDto
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

PUT

Summary

Update contact.

Description

API to update existing contact.

Parameters

Name	Located in	Description	Required	Schema
contactDto	body	contactDto	Yes	ContactPhilippinesDto
id	path	id	Yes	long

Responses

Code	Description	Schema
200	Contact has been updated successfully.	ContactPhilippinesDto
201	Created
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete contacts

Description

Api to delete contact

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description
200	OK
204	Contact has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update contact attributes.

Description

API to update attributes of existing contact.

Parameters

Name	Located in	Description	Required	Schema
contactAttributeUpdateDto	body	contactAttributeUpdateDto	Yes	ContactAttributeUpdateDto
id	path	id	Yes	long

Responses

Code	Description	Schema
200	Contact attributes has been updated successfully.	ContactPhilippinesDto
204	No Content
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

---

contact-sa-controller

Contact APIs for Saudi Arabia.

Contacts sa

GET

Summary

Fetch contacts

Description

API to fetch existing contacts.

Parameters

Name	Located in	Description	Required	Schema
customfield	query	customfield	No	string
includeOpeningAmounts	query	includeOpeningAmounts	No	boolean
includeOweAmounts	query	includeOweAmounts	No	boolean
limit	query	limit	No	integer
page	query	page	No	integer
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	Contact's information have been fetched successfully.	ContactSADto
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Contact.

Description

API to create new contact.

Parameters

Name	Located in	Description	Required	Schema
contactDto	body	contactDto	Yes	ContactSADto

Responses

Code	Description	Schema
200	OK	ContactSADto
201	Contact has been created successfully.	ContactSADto
400	Contact creation failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts sa/brief

GET

Summary

get contacts export

Description

request get contacts export by tenant and status.

Responses

Code	Description	Schema
200	get contacts export successful.	[ ContactSADto ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts sa/businessunits

GET

Summary

Fetch Govt's Business units

Description

API to fetch existing contacts.

Parameters

Name	Located in	Description	Required	Schema
limit	query	limit	No	integer
page	query	page	No	integer
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	Contact's information have been fetched successfully.	ContactSADto
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts sa/code/{code}

GET

Summary

Fetch contact by code.

Description

API to fetch existing contact by code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Contact's information have been fetched successfully.	ContactSADto
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

Contacts sa/codes

POST

Summary

Fetch contacts by list of codes.

Description

API to fetch existing contact by code.

Parameters

Name	Located in	Description	Required	Schema
codes	body	codes	Yes	[ string ]

Responses

Code	Description	Schema
200	Contact's information have been fetched successfully.	[ ContactSADto ]
201	Created
401	Unauthorized
403	Forbidden
404	No contacts found with provided codes

Security

Security Schema	Scopes
Authorization	global

Contacts sa/codes/status

PATCH

Summary

Bulk status update

Description

Bulk status update

Parameters

Name	Located in	Description	Required	Schema
contactCodes	body	contactCodes	Yes	[ string ]
status	query	status	Yes	string

Responses

Code	Description
200	Bulk status update done successfully
204	No Content
401	Unauthorized
403	Forbidden

Security

Security Schema	Scopes
Authorization	global

Contacts sa/custom-fields

GET

Summary

Get custom field is used or not

Description

API to Get custom field is used or not

Parameters

Name	Located in	Description	Required	Schema
customCode	query	customCode	Yes	string

Responses

Code	Description	Schema
200	Custom fields status fetched successfully	boolean
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts sa/details

POST

Summary

getContactDetails

Parameters

Name	Located in	Description	Required	Schema
contactCodes	body	contactCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	OK	[ ContactDetails ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts sa/detailsbyaccount/{accountCode}

GET

Summary

Fetch contact details by account code

Description

Fetch contact details by account code used as receivable or payable account

Parameters

Name	Located in	Description	Required	Schema
accountCode	path	accountCode	Yes	string

Responses

Code	Description	Schema
200	OK	[ ContactDetails ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts sa/detailsbyseqcodes

POST

Summary

getContactDetailsBySeqCodes

Parameters

Name	Located in	Description	Required	Schema
contactCodes	body	contactCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	OK	[ ContactDetails ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts sa/import

POST

Summary

Contact.

Description

API to create new contact.

Parameters

Name	Located in	Description	Required	Schema
contactDtos	body	contactDtos	Yes	[ ContactSADto ]

Responses

Code	Description	Schema
200	OK	[ object ]
201	Contacts are imported successfully.	[ object ]
400	Contact creation failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts sa/info

POST

Summary

Fetch contact details by codes

Description

Fetch contact details by codes

Parameters

Name	Located in	Description	Required	Schema
codes	body	codes	Yes	[ string ]

Responses

Code	Description	Schema
200	OK	[ ContactInformation ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts sa/names

POST

Summary

Fetch contacts by list of names.

Description

API to fetch existing contact by names.

Parameters

Name	Located in	Description	Required	Schema
names	body	names	Yes	[ string ]

Responses

Code	Description	Schema
200	Contact's information have been fetched successfully.	[ ContactSADto ]
201	Created
401	Unauthorized
403	Forbidden
404	No contacts found with provided names

Security

Security Schema	Scopes
Authorization	global

Contacts sa/{id}

GET

Summary

Fetch contact by id.

Description

API to fetch existing contact by it's id.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description	Schema
200	Contact's information have been fetched successfully.	ContactSADto
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

PUT

Summary

Update contact.

Description

API to update existing contact.

Parameters

Name	Located in	Description	Required	Schema
contactDto	body	contactDto	Yes	ContactSADto
id	path	id	Yes	long

Responses

Code	Description	Schema
200	Contact has been updated successfully.	ContactSADto
201	Created
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete contacts

Description

Api to delete contact

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description
200	OK
204	Contact has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update contact attributes.

Description

API to update attributes of existing contact.

Parameters

Name	Located in	Description	Required	Schema
contactAttributeUpdateDto	body	contactAttributeUpdateDto	Yes	ContactAttributeUpdateDto
id	path	id	Yes	long

Responses

Code	Description	Schema
200	Contact attributes has been updated successfully.	ContactSADto
204	No Content
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

Contacts sa/{tenantId}

POST

Summary

Create demo Contacts.

Description

API to create demo contacts.

Parameters

Name	Located in	Description	Required	Schema
country	query	country	No	string
tenantId	path	tenantId	Yes	long

Responses

Code	Description
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

---

contact-uk-controller

Contact APIs for UK.

Contacts uk

GET

Summary

Fetch contacts

Description

API to fetch existing contacts.

Parameters

Name	Located in	Description	Required	Schema
customfield	query	customfield	No	string
includeOpeningAmounts	query	includeOpeningAmounts	No	boolean
includeOweAmounts	query	includeOweAmounts	No	boolean
limit	query	limit	No	integer
page	query	page	No	integer
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	Contact's information have been fetched successfully.	ContactUKDto
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Contact.

Description

API to create new contact.

Parameters

Name	Located in	Description	Required	Schema
contactDto	body	contactDto	Yes	ContactUKDto

Responses

Code	Description	Schema
200	OK	ContactUKDto
201	Contact has been created successfully.	ContactUKDto
400	Contact creation failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts uk/brief

GET

Summary

get contacts export

Description

request get contacts export by tenant and status.

Responses

Code	Description	Schema
200	get contacts export successful.	[ ContactUKDto ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts uk/businessunits

GET

Summary

Fetch Govt's Business units

Description

API to fetch existing contacts.

Parameters

Name	Located in	Description	Required	Schema
limit	query	limit	No	integer
page	query	page	No	integer
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	Contact's information have been fetched successfully.	ContactUKDto
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts uk/code/{code}

GET

Summary

Fetch contact by code.

Description

API to fetch existing contact by code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Contact's information have been fetched successfully.	ContactUKDto
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

Contacts uk/codes

POST

Summary

Fetch contacts by list of codes.

Description

API to fetch existing contact by code.

Parameters

Name	Located in	Description	Required	Schema
codes	body	codes	Yes	[ string ]

Responses

Code	Description	Schema
200	Contact's information have been fetched successfully.	[ ContactUKDto ]
201	Created
401	Unauthorized
403	Forbidden
404	No contacts found with provided codes

Security

Security Schema	Scopes
Authorization	global

Contacts uk/codes/status

PATCH

Summary

Bulk status update

Description

Bulk status update

Parameters

Name	Located in	Description	Required	Schema
contactCodes	body	contactCodes	Yes	[ string ]
status	query	status	Yes	string

Responses

Code	Description
200	Bulk status update done successfully
204	No Content
401	Unauthorized
403	Forbidden

Security

Security Schema	Scopes
Authorization	global

Contacts uk/custom-fields

GET

Summary

Get custom field is used or not

Description

API to Get custom field is used or not

Parameters

Name	Located in	Description	Required	Schema
customCode	query	customCode	Yes	string

Responses

Code	Description	Schema
200	Custom fields status fetched successfully	boolean
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts uk/details

POST

Summary

getContactDetails

Parameters

Name	Located in	Description	Required	Schema
contactCodes	body	contactCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	OK	[ ContactDetails ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts uk/detailsbyaccount/{accountCode}

GET

Summary

Fetch contact details by account code

Description

Fetch contact details by account code used as receivable or payable account

Parameters

Name	Located in	Description	Required	Schema
accountCode	path	accountCode	Yes	string

Responses

Code	Description	Schema
200	OK	[ ContactDetails ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts uk/detailsbyseqcodes

POST

Summary

getContactDetailsBySeqCodes

Parameters

Name	Located in	Description	Required	Schema
contactCodes	body	contactCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	OK	[ ContactDetails ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts uk/import

POST

Summary

Contact.

Description

API to create new contact.

Parameters

Name	Located in	Description	Required	Schema
contactDtos	body	contactDtos	Yes	[ ContactUKDto ]

Responses

Code	Description	Schema
200	OK	[ object ]
201	Contacts are imported successfully.	[ object ]
400	Contact creation failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts uk/info

POST

Summary

Fetch contact details by codes

Description

Fetch contact details by codes

Parameters

Name	Located in	Description	Required	Schema
codes	body	codes	Yes	[ string ]

Responses

Code	Description	Schema
200	OK	[ ContactInformation ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Contacts uk/names

POST

Summary

Fetch contacts by list of names.

Description

API to fetch existing contact by names.

Parameters

Name	Located in	Description	Required	Schema
names	body	names	Yes	[ string ]

Responses

Code	Description	Schema
200	Contact's information have been fetched successfully.	[ ContactUKDto ]
201	Created
401	Unauthorized
403	Forbidden
404	No contacts found with provided names

Security

Security Schema	Scopes
Authorization	global

Contacts uk/{id}

GET

Summary

Fetch contact by id.

Description

API to fetch existing contact by it's id.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description	Schema
200	Contact's information have been fetched successfully.	ContactUKDto
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

PUT

Summary

Update contact.

Description

API to update existing contact.

Parameters

Name	Located in	Description	Required	Schema
contactDto	body	contactDto	Yes	ContactUKDto
id	path	id	Yes	long

Responses

Code	Description	Schema
200	Contact has been updated successfully.	ContactUKDto
201	Created
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete contacts

Description

Api to delete contact

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description
200	OK
204	Contact has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update contact attributes.

Description

API to update attributes of existing contact.

Parameters

Name	Located in	Description	Required	Schema
contactAttributeUpdateDto	body	contactAttributeUpdateDto	Yes	ContactAttributeUpdateDto
id	path	id	Yes	long

Responses

Code	Description	Schema
200	Contact attributes has been updated successfully.	ContactUKDto
204	No Content
401	Unauthorized
403	Forbidden
404	Contact with id not found.

Security

Security Schema	Scopes
Authorization	global

Contacts uk/{tenantId}

POST

Summary

Create demo Contacts.

Description

API to create demo contacts.

Parameters

Name	Located in	Description	Required	Schema
country	query	country	No	string
tenantId	path	tenantId	Yes	long

Responses

Code	Description
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

---

Models

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
countryCode	string	Country code Example: "SG"	No
customFields	[ CustomFieldItem ]	List of custom fields	No
destinationOfSupply	string	state in India Example: "Maharashtra"	No
emailId	string	Email address Example: "john.smith@example.com"	No
mobileCountryCode	string	Country code of the mobile number Example: "+65"	No
mobileNumber	string	Mobile number Example: "98765432"	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
stateCode	string	State code Example: "MH"	No

BankDetailsDto

Name	Type	Description	Required
accountNumber	string	Contact bank account number Example: "Test"	Yes
bankName	string	Contact bank name Example: "Test"	Yes
code	string	Unique code assigned to the bank detail record Example: "BD-0000001"	No
contactCode	string	Contact Code. Example: "C-000001"	No
id	long	Unique identifier for the bank detail record Example: 1	No
isDefault	boolean	Contact bank default flag Example: false	No
isTenantBank	boolean	Flag to determine whether this Bank details is for Tenant or Contact. Example: false	No

BankDetailsIsrael

Name	Type	Description	Required
bankAccountNumber	string		No
bankCode	string		No
bankIbanCode	string		No
bankName	string		No
bankSwiftCode	string		No
branchAddress	string		No
branchName	string		No
branchNumber	string		No

BulkApiResponse

Name	Type	Description	Required
failure	[ object ]		No
statusCode	integer		No
success	[ object ]		No

BusinessUnitDto

Name	Type	Description	Required
businessUnitName	string	businessUnit name Example: "AUD01 - Auditor-General's Office"	No

ContactAttributeUpdateDto

Name	Type	Description	Required
billingAddress	[ Address ]	List of Billing Address.	No
customField	[ CustomFieldItem ]	List of custom fields	No
customer	boolean	Is customer? Example: true	No
shippingAddress	[ Address ]	List of Shipping Address.	No
status	string	Contact status Enum: "ACTIVE", "INACTIVE" Example: "INACTIVE"	No
vendor	boolean	Is vendor? Example: false	No

ContactAustraliaDto

Name	Type	Description	Required
australianBusinessNo	string	Australian Business No Example: 12345	No
australianCompanyNo	string	Australian Company No Example: 12345	No
billingAddress	[ Address ]	List of Billing Address.	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
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
isParentCompany	boolean	Is Parent company Example: false	No
isSubsidiaryCompany	boolean	Is Subsidiary company 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
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

ContactBEDto

Name	Type	Description	Required
beDefaultPurchaseTaxRate	string	Example: "TAX"	No
beDefaultSalesTaxRate	string	Example: "TAX"	No
beEnterpriseNo	string	Enterprise Number Example: "111-111-111"	No
beVatIdentificationNo	string	VAT Identification Number Example: "111-111-111"	No
billingAddress	[ Address ]	List of Billing Address.	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
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
isParentCompany	boolean	Is Parent company Example: false	No
isSubsidiaryCompany	boolean	Is Subsidiary company 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
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

ContactCanadaDto

Name	Type	Description	Required
billingAddress	[ Address ]	List of Billing Address.	No
canadianBusinessNo	string	Canadian Business No Example: 12345	No
canadianDefaultPurchaseTaxRate	string	Example: 12345	No
canadianDefaultSalesTaxRate	string	Example: 12345	No
canadianGstNo	string	Canadian GST No Example: 12345	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
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
isParentCompany	boolean	Is Parent company Example: false	No
isSubsidiaryCompany	boolean	Is Subsidiary company 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
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

ContactDetailInfo

Name	Type	Description	Required
contactNumber	string	Contact number Example: "Sam"	No
emailId	string	Contact email Example: "johndoe@deskera.com"	No
id	long		No
name	string	Contact name Example: "Sam"	No
source	string	Source Example: "BOOKS"	No
sourceId	string	Source id Example: "Sam"	No

ContactDetails

Name	Type	Description	Required
code	string		No
documentSeqCode	string		No
name	string		No

ContactDto

Name	Type	Description	Required
additionalPaymentInfo	object	Additional payment information for the contact	No
attachmentsWithLink	[ object ]	Attachment details including download links	No
attentionTo	string	the contact name in govt agency Example: "Peter Parker"	No
autoCharge	boolean	Has the value true if auto payment charge is enabled or false otherwise Example: false	No
avalaraCustomerCode	string	Avalara customer code	No
billingAddress	[ Address ]	List of Billing Address.	No
businessUnit	string	indicates the contact is govt agency Example: "CAA01 - Cvl Avtn Authrty of Singapore"	No
code	string	Unique code assigned to the contact Example: "C-0000001"	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
customer	boolean	Has the value true if the contact is customer or false if the contact is not customer.	No
customField	[ CustomFieldItem ]	JSON object for custom fields Example: {"field1":"value1","field2":"value2"}	No
deleted	boolean	Has the value true if the contact is deleted or false if the contact is not deleted.	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
id	long	Unique identifier for the contact Example: 1	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
is1099Eligible	boolean	Has the value true if the contact is 1099 eligible or false otherwise	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
isParentCompany	boolean	Is Parent company Example: false	No
isSubsidiaryCompany	boolean	Is Subsidiary company Example: false	No
name	string	Contact name Example: "Sam"	No
otherEmails	string	Other email addresses for the contact	No
payableAccountCode	string	Payable account code Example: "AC002"	No
paymentTerm	string	Payment term of the contact	No
paymentTermCode	string	Payment term code Example: "Net 0"	No
peppolId	string	Peppol ID Example: "u000:11::11293"	No
products	[ object ]	List of vendor products associated with the contact	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
salesPersonMaster	[ object ]	List of sales persons associated with the contact	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
status	string	Contact status Enum: "ACTIVE", "INACTIVE" Example: "ACTIVE"	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
tenantId	long	Tenant id to whom contact is associated with	No
theyOweYou	number	Amount owed by others for the contact	No
totalBillAmount	number	Payable account opening amount	No
totalNetAmount	number	Receivable account opening amount	No
uen	string	Contact UEN Example: "DHJEUK"	No
vendor	boolean	Has the value true if the contact is vendor or false if the contact is not vendor.	No
youOweThem	number	Amount that the contact owes to others	No

ContactEmailDto

Name	Type	Description	Required
code	string	Contact Code Example: "C-0000001"	No
email	string	Contact Email Example: "contact@abc.def"	No

ContactGermanyDto

Name	Type	Description	Required
billingAddress	[ Address ]	List of Billing Address.	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
germanyBusinessCompanyNo	string	Germany Business registration No Example: 12345	No
germanyDefaultPurchaseTaxRate	string	Example: 12345	No
germanyDefaultSalesTaxRate	string	Example: 12345	No
germanyVatIdentificationNo	string	Germany vat identification No Example: 12345	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
isParentCompany	boolean	Is Parent company Example: false	No
isSubsidiaryCompany	boolean	Is Subsidiary company 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
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

ContactIndiaDto

Name	Type	Description	Required
billingAddress	[ Address ]	List of Billing Address.	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
customerType	string	Customer Type Enum: "EXPORT_WO_PAY", "EXPORT_W_PAY", "NA", "SEZ_WO_PAY", "SEZ_W_PAY" Example: "NA"	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
gstTreatment	string	GST treatment 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: "UnregisteredBusiness"	No
gstin	string	Contact GSTIN Example: "21AONPM8088Q211"	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
isParentCompany	boolean	Is Parent company Example: false	No
isSubsidiaryCompany	boolean	Is Subsidiary company Example: false	No
name	string	Contact name Example: "Sam"	No
pan	string	Contact PAN Example: "AONPM8088Q"	No
payableAccountCode	string	Payable account code Example: "AC002"	No
paymentTermCode	string	Payment term code Example: "Net 0"	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
resident	boolean	Is resident? Example: true	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
tdsInfoIndia	ContactIndiaTdsInfo		No
tdsSectionToTdsRateId	long	Contact TDS Section to Tds Rate Id Example: 1213454	No
vendorType	string	Vendor Type Enum: "IMPORT", "NA", "SEZ_W_PAY", "SEZ_WO_PAY" Example: "NA"	No

ContactIndiaTdsInfo

Name	Type	Description	Required
considerThresholdLimit	boolean	Consider Exemption Limit can be a check box field Example: true	No
deducteeCode	string	Deductee Type Example: "Artificial Juridicial Person"	No
deducteeType	string	Deductee Type Example: "Artificial Juridicial Person"	No
deductionApplicable	boolean	This field can be visible only if PAN number is mentioned. Example: true	No
dttaApplicable	boolean		No
dttaFromDate	dateTime		No
dttaToDate	dateTime		No
higherRate	integer	Percentage value and can be visible only if PAN number is not mentioned. Example: 5	No
noDeductionFromDate	dateTime	Start date field visible only if deductionApplicable field is true Example: "01-01-2020"	No
noDeductionReason	string	Choose reason only if deductionApplicable field is true. Example: "TDS not to be made till the Basic Exemption is reached"	No
noDeductionRefNo	string	Alphanumeric field and visible only if deductionApplicable field is true. Example: "AAAAABBBB1100"	No
noDeductionTdsRate	integer	Special rate override with TDS Rate setting and will be visible only if deductionApplicable field is true Example: 5	No
noDeductionToDate	dateTime	End date field visible only if deductionApplicable field is true Example: "31-12-2020"	No
nonDeductionApplicable	boolean	This field can be visible only if PAN number is mentioned. Example: true	No
specialRate	integer		No
tan	string	Contact TAN Example: "AAAA99999A"	No

ContactIndonesiaDto

Name	Type	Description	Required
billingAddress	[ Address ]	List of Billing Address.	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
isParentCompany	boolean	Is Parent company Example: false	No
isSubsidiaryCompany	boolean	Is Subsidiary company Example: false	No
name	string	Contact name Example: "Sam"	No
nikNumber	long	NIK No Example: 123456789012345	No
npwpNumber	long	NPWP No Example: 123456789012345	No
payableAccountCode	string	Payable account code Example: "AC002"	No
paymentTermCode	string	Payment term code Example: "Net 0"	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
residentStatusIndonesia	boolean	Resident Status Example: true	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
taxTypeCustomer	string	Tax Types Customer Enum: "TAX_CODE_CUSTOMER_01", "TAX_CODE_CUSTOMER_02", "TAX_CODE_CUSTOMER_03", "TAX_CODE_CUSTOMER_04", "TAX_CODE_CUSTOMER_05", "TAX_CODE_CUSTOMER_06", "TAX_CODE_CUSTOMER_07", "TAX_CODE_CUSTOMER_08" Example: "TAX_CODE_CUSTOMER_01"	No
taxTypeVendor	string	Tax Types Vendor Enum: "TAX_CODE_VENDOR_01", "TAX_CODE_VENDOR_02", "TAX_CODE_VENDOR_03", "TAX_CODE_VENDOR_04", "TAX_CODE_VENDOR_05", "TAX_CODE_VENDOR_06", "TAX_CODE_VENDOR_07", "TAX_CODE_VENDOR_08" Example: "TAX_CODE_VENDOR_01"	No

ContactInformation

Name	Type	Description	Required
beVatIdentificationNo	string	VAT Identification No Example: 123456789012345	No
billingAddress	[ Address ]	List of Billing Address.	No
birClassPhilippines	string	BIR class determines the type of business Example: "Services"	No
businessRegNo	string	Contact Business Registration No Example: "W10-0108-000000021"	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
customerType	string	Customer Type Enum: "EXPORT_WO_PAY", "EXPORT_W_PAY", "NA", "SEZ_WO_PAY", "SEZ_W_PAY" Example: "NA"	No
customerTypeMalaysia	string	Customer Type Enum: "NONE", "EXPORT", "SPECIAL_AREA", "DESIGNATED_AREA", "EXEMPTED_UNDER_SCHEDULE_A", "EXEMPTED_UNDER_SCHEDULE_B", "EXEMPTED_UNDER_SCHEDULE_C1_C2", "EXEMPTED_UNDER_SCHEDULE_C3_C4", "EXEMPTED_UNDER_SCHEDULE_C5" Example: "NONE(None)"	No
customerTypePhilippines	string	Customer Type Enum: "NORMAL_CORPORATE=Normal(Corporate)", "NORMAL_INDIVIDUAL=Normal(Individual)", "ZERO_RATED_CORPORATE=Zero rated(Corporate)", "ZERO_RATED_INDIVIDUAL=Zero Rated (Individual)", "NORMAL=Normal", "GOVERNMENT=Government" Example: "Normal(Corporate)"	No
deVatIdentificationNo	string	VAT Identification No Example: 123456789012345	No
documentSequenceCode	string	Contact Sequence code Example: "C-0000001"	No
emailId	string	contact email address Example: "myinfo@domain.com"	No
exemptionCertificateMalaysia	boolean	Exemption certificate Example: true	No
exemptionCriterialMalaysia	string	Exemption criteria Enum: "NONE", "ZERO_RATED", "EXEMPTED_ZERO" Example: "NONE(None)"	No
gstTreatment	string	GST treatment 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: "UnregisteredBusiness"	No
gstin	string	Contact GSTIN Example: "21AONPM8088Q211"	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
isParentCompany	boolean	Is Parent company Example: false	No
isSubsidiaryCompany	boolean	Is Subsidiary company Example: false	No
name	string	Contact name Example: "Sam"	No
nikNumber	long	NIK No Example: 123456789012345	No
nlVatIdentificationNo	string	VAT Identification No Example: 123456789012345	No
npwpNumber	long	NPWP No Example: 123456789012345	No
pan	string	Contact PAN Example: "AONPM8088Q"	No
payableAccountCode	string	Payable account code Example: "AC002"	No
paymentTermCode	string	Payment term code Example: "Net 0"	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
resident	boolean	Is resident? Example: true	No
residentStatusIndonesia	boolean	Resident Status Example: true	No
saArabicDetails	ContactSAArabicDto	Contact details in Arabic for Saudi Arabia	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
salesTaxRegNo	string	Contact Sales Tax Registration No Example: "W10-0108-000000021"	No
sequenceFormat	string	Sequence Format Example: 1	No
serviceTaxRegNo	string	Contact Service Tax Registration No Example: "W10-0108-000000021"	No
shippingAddress	[ Address ]	List of Shipping Address.	No
taxExempted	boolean		No
taxExemptionNo	string		No
taxExemptionReason	string		No
taxTreatment	string	Tax Treatment Enum: "VAT_Registered", "Non_VAT_Registered", "GCC_VAT_Registered", "GCC_Non_VAT_Registered", "Non_GCC", "VAT_Registered_Designated_Zone", "Non_VAT_Registered_Designated_Zone" Example: "VAT_Registered"	No
taxTypeCustomer	string	Tax Types Customer Enum: "TAX_CODE_CUSTOMER_01", "TAX_CODE_CUSTOMER_02", "TAX_CODE_CUSTOMER_03", "TAX_CODE_CUSTOMER_04", "TAX_CODE_CUSTOMER_05", "TAX_CODE_CUSTOMER_06", "TAX_CODE_CUSTOMER_07", "TAX_CODE_CUSTOMER_08" Example: "TAX_CODE_CUSTOMER_01"	No
taxTypeVendor	string	Tax Types Vendor Enum: "TAX_CODE_VENDOR_01", "TAX_CODE_VENDOR_02", "TAX_CODE_VENDOR_03", "TAX_CODE_VENDOR_04", "TAX_CODE_VENDOR_05", "TAX_CODE_VENDOR_06", "TAX_CODE_VENDOR_07", "TAX_CODE_VENDOR_08" Example: "TAX_CODE_VENDOR_01"	No
tdsApplicableIndia	boolean		No
tdsInfoIndia	ContactIndiaTdsInfo		No
tdsSectionToTdsRateId	long	Contact TDS Section to Tds Rate Id Example: 1213454	No
vatExemptionReasonPhilippines	string	Philippines specific Contact VAT Exemption Reason Example: "Reason"	No
vatNoPhilippines	string	Philippines specific Contact VAT No. Example: "012-345-678-910"	No
vatRegistrationNo	string	VAT Registration No Example: 123456789012345	No
vatStatusPhilippines	string	Philippines specific Contact VAT Status Example: "Input VAT"	No
vendorType	string	Vendor Type Enum: "IMPORT", "NA", "SEZ_W_PAY", "SEZ_WO_PAY" Example: "NA"	No
vendorTypeMalaysia	string	Vendor Type Enum: "NONE", "SALES_TAX_EXEMPTION", "MANUFACTURED_EXEMPTION", "PERFORMED_EXEMPTION" Example: "NONE(None)"	No
vendorTypePhilippines	string	Vendor Type Enum: "NORMAL_CORPORATE=Normal(Corporate)", "NORMAL_INDIVIDUAL=Normal(Individual)", "ZERO_RATED_CORPORATE=Zero rated(Corporate)", "ZERO_RATED_INDIVIDUAL=Zero Rated (Individual)", "GOVERNMENT=Government", "NORMAL=Normal", "IMPORT=Import" Example: "Normal(Corporate)"	No
whtApplicablePhilippines	boolean	Make Contact as WHT applicable Example: true	No
whtBusinessPhilippines	string	BIR class determines the type of business Example: "Individual"	No

ContactIsraelDto

Name	Type	Description	Required
assessingOfficerNumberIsrael	string	Enum: "ASSESSING_OFFICER_NUMBER_01", "ASSESSING_OFFICER_NUMBER_02", "ASSESSING_OFFICER_NUMBER_04", "ASSESSING_OFFICER_NUMBER_05", "ASSESSING_OFFICER_NUMBER_06", "ASSESSING_OFFICER_NUMBER_07", "ASSESSING_OFFICER_NUMBER_10", "ASSESSING_OFFICER_NUMBER_17", "ASSESSING_OFFICER_NUMBER_21", "ASSESSING_OFFICER_NUMBER_23", "ASSESSING_OFFICER_NUMBER_24", "ASSESSING_OFFICER_NUMBER_25", "ASSESSING_OFFICER_NUMBER_26", "ASSESSING_OFFICER_NUMBER_30", "ASSESSING_OFFICER_NUMBER_31", "ASSESSING_OFFICER_NUMBER_22", "ASSESSING_OFFICER_NUMBER_34", "ASSESSING_OFFICER_NUMBER_35", "ASSESSING_OFFICER_NUMBER_37", "ASSESSING_OFFICER_NUMBER_38", "ASSESSING_OFFICER_NUMBER_39", "ASSESSING_OFFICER_NUMBER_41", "ASSESSING_OFFICER_NUMBER_50", "ASSESSING_OFFICER_NUMBER_51", "ASSESSING_OFFICER_NUMBER_52", "ASSESSING_OFFICER_NUMBER_45", "ASSESSING_OFFICER_NUMBER_43", "ASSESSING_OFFICER_NUMBER_18"	No
billingAddress	[ Address ]	List of Billing Address.	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
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
isIncludedTaxReportingAtSourceIsrael	boolean		No
isParentCompany	boolean	Is Parent company Example: false	No
isSelfInvoicingIsrael	boolean		No
isSubsidiaryCompany	boolean	Is Subsidiary company Example: false	No
israelBankDetails	[ BankDetailsIsrael ]		No
israelGlobalBankDetails	[ GlobalBankDetailsIsrael ]		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
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
taxCertificateValidityDateIsrael	date		No
taxNumber	string	Tax number Example: 123456	No
taxPayerIdIsrael	string		No
typeOfCompanyIsrael	string	Enum: "INDEPENDENT", "COMPANY", "A_RESIDENT_OF_THE_PALESTINIAN_AUTHORITY", "AUTHORIZED_DEALER", "FOREIGN_RESIDENT", "INTERNATIONAL_COMPANY"	No
whtApplicableIsrael	boolean	Make Contact as WHT applicable Example: true	No
withHoldingCertificatesIsrael	[ WithHoldingCertificateIsrael ]		No
withHoldingTaxPaymentGroupIsraelId	long		No
withHoldingTaxTypeIsraelId	long		No

ContactMalaysiaDto

Name	Type	Description	Required
billingAddress	[ Address ]	List of Billing Address.	No
businessRegNo	string	Contact Business Registration No Example: "W10-0108-000000021"	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
customerTypeMalaysia	string	Customer Type Enum: "NONE", "EXPORT", "SPECIAL_AREA", "DESIGNATED_AREA", "EXEMPTED_UNDER_SCHEDULE_A", "EXEMPTED_UNDER_SCHEDULE_B", "EXEMPTED_UNDER_SCHEDULE_C1_C2", "EXEMPTED_UNDER_SCHEDULE_C3_C4", "EXEMPTED_UNDER_SCHEDULE_C5" Example: "NONE(None)"	No
documentSequenceCode	string	Contact Sequence code Example: "C-0000001"	No
emailId	string	contact email address Example: "myinfo@domain.com"	No
exemptionCertificateMalaysia	boolean	Exemption certificate Example: true	No
exemptionCriterialMalaysia	string	Exemption criteria Enum: "NONE", "ZERO_RATED", "EXEMPTED_ZERO" Example: "NONE(None)"	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
isParentCompany	boolean	Is Parent company Example: false	No
isSubsidiaryCompany	boolean	Is Subsidiary company 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

ContactSummaryDto

Name	Type	Description	Required
total	integer	Total number of contacts Example: 0	No
customer	integer	Number of contacts that are customers Example: 0	No
vendor	integer	Number of contacts that are vendors Example: 0	No

PaymentTermResponseDto

Name	Type	Description	Required
id	long	Unique identifier for the payment term Example: 1	No
termDays	long	Number of days for the payment term Example: 30	No
termName	string	Name of the payment term Example: "Net 30"	No
systemGenerated	boolean	Has the value true if the payment term is system generated or false otherwise Example: false	No