Invoice APIs

An Invoice represents a sales form where the customer pays for a product or service later. In ERP, it will help you to keep track of all your invoices and establish an efficient cash-flow system for your business.

Once, you receive payment from your customer, you will update the information such as the payment type – bank or cash – into the invoice overview. This will helps you to sort out which payment types to focus on and organizes your invoices accordingly.

InvoiceDto helps you to create new invoice, retreive a particular invoice, update a partivular invoice, retrieve a list of all invoices.

More about Invoice API documentation

API

---

Search Invoice

Get invoices by filter criteria.More about search invoice

Description:

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

GET

Invoice sales

More about search invoice

Parameters

Name	Located in	Description	Required	Schema
contactCodes	query	contactCodes	No	string
customfield	query	customfield	No	string
fetchAttachmentDetails	query	fetchAttachmentDetails	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	Sales invoices have been fetched successfully.	SalesInvoiceResponse
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

---

Create Invoice

Create a new invoice. More about create invoice

Description:

• Allows you to create a new invoice.

POST

Invoice sales

More about create invoice

Parameters

Name	Located in	Description	Required	Schema
salesInvoiceRequest	body	salesInvoiceRequest	Yes	SalesInvoiceRequest

Responses

Code	Description	Schema
200	OK	SalesInvoiceResponse
201	Sales invoice has been created successfully.	SalesInvoiceResponse
400	Sales invoice could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

---

Update Invoice

Update invoice information. More about update invoice

Description:

• Allows you to update a specific invoice information.

PUT

Invoice sales/{id}

More about update invoice

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
salesInvoiceRequest	body	salesInvoiceRequest	Yes	SalesInvoiceRequest

Responses

Code	Description	Schema
200	Sales Invoice has been updated successfully.	SalesInvoiceResponse
201	Created
400	Sales invoice draft status cannot be changed after saving
401	Unauthorized
403	Forbidden
404	Sales Invoice with given id not found.

Security

Security Schema	Scopes
Authorization	global

---

Retrieve Invoice

Get invoice by code. More about update invoice

Description:

• Allows you to retrieve an existing invoice details by it's code.

GET

Invoice sales/{code}

More about retrieve invoice

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Sales invoice information has been fetched successfully.	SalesInvoiceResponse
401	Unauthorized
403	Forbidden
404	Sales invoice not found.

Security

Security Schema	Scopes
Authorization	global

---

invoice-controller

Invoice APIs

Invoice analyze-document

POST

Summary

Analyze document image/file

Parameters

Name	Located in	Description	Required	Schema
file	formData	file	Yes	file

Responses

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

Security

Security Schema	Scopes
Authorization	global

Invoice bulk-email

POST

Summary

Send invoices email.

Description

Send invoices as email.

Parameters

Name	Located in	Description	Required	Schema
sendSalesInvoiceEmails	body	sendSalesInvoiceEmails	Yes	[ SendSalesInvoiceEmail ]

Responses

Code	Description
200	Emails sent successfully.
201	Created
400	Unable to send emails.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice contacts

POST

Summary

Get Invoice for contact.

Description

Get Invoice with contact code.

Parameters

Name	Located in	Description	Required	Schema
contactCodes	body	Contact Codes	No	[ string ]

Responses

Code	Description	Schema
200	Get Invoice successfully.	object
201	Created
401	Unauthorized
403	Forbidden
404	Invoice with given contact code not found.

Security

Security Schema	Scopes
Authorization	global

Invoice contacts/due

POST

Summary

Due amount for contacts report.

Description

API to fetch due amount for contacts.

Parameters

Name	Located in	Description	Required	Schema
contactCodes	body	Contact Codes	No	[ string ]

Responses

Code	Description	Schema
200	Due amount for contacts report has been prepared.	object
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice count

GET

Summary

count invoices.

Description

API to count invoices.

Responses

Code	Description	Schema
200	OK	object
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice 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

Invoice demo/{tenantId}

POST

Summary

Create demo invoices.

Description

API to create demo invoices.

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

Invoice email

POST

Summary

Send invoice email.

Description

Send invoice email.

Parameters

Name	Located in	Description	Required	Schema
sendSalesInvoiceEmail	body	sendSalesInvoiceEmail	Yes	SendSalesInvoiceEmail

Responses

Code	Description	Schema
200	Email sent successfully.	SalesInvoiceResponse
201	Created
400	Unable to send email.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice export/{type}

GET

Summary

Get Invoice export.

Description

Get Sales Invoices and Purchase Invoices.

Parameters

Name	Located in	Description	Required	Schema
contactCodes	query	contactCodes	No	string
customfield	query	customfield	No	string
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	path	type	Yes	string

Responses

Code	Description	Schema
200	Get Invoice successfully.	[ InvoiceReportInfo ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice get-doc-seqs

GET

Summary

Get Existing Document Sequence codes

Description

Api to Get Existing Document Sequence codes

Responses

Code	Description	Schema
200	Existing Document Sequence codes fetched successfully	object
400	Failed to fetch Existing Document Sequence codes
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice opening/contact-info

POST

Summary

Populate contact info for sales invoice

Description

Api to populate contact info for sales invoice

Responses

Code	Description	Schema
200	OK	SalesInvoiceResponse
201	Sales invoice contact info has been populated successfully	SalesInvoiceResponse
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice payment-link/{salesInvoiceCode}

GET

Summary

Get/Create payment link for invoice.

Description

Get/Create payment link for invoice.

Parameters

Name	Located in	Description	Required	Schema
salesInvoiceCode	path	salesInvoiceCode	Yes	string

Responses

Code	Description	Schema
200	Invoice payment link fetched successfully.	CustomerInvoiceDto
400	Error getting payment link for invoice.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice product-in-out-qty

GET

Summary

Find invoice data for Product in out qty

Description

API to Find invoice data for Product in out qty

Parameters

Name	Located in	Description	Required	Schema
productCode	query	productCode	Yes	string

Responses

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

Security

Security Schema	Scopes
Authorization	global

---

Get Invoice Tax Report

GET

Invoice sales/us/tax-report

Summary

Sales tax report

Description

Sales tax report API

Parameters

Name	Located in	Description	Required	Schema
basis	query	basis	No	string
export	query	export	No	string
fromDate	query	fromDate	No	dateTime
region	query	region	No	string
toDate	query	toDate	No	dateTime

Responses

Code	Description	Schema
200	USA sales tax report has been calculated successfully.	UsaSalesTaxReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

---

Get Invoices by Contact Code

GET

Invoice {contactCode}

Summary

Get Invoice for contact.

Description

Get Invoice with contact code.

Parameters

Name	Located in	Description	Required	Schema
contactCode	path	contactCode	Yes	string

Responses

Code	Description	Schema
200	Get Invoice successfully.	[ object ]
401	Unauthorized
403	Forbidden
404	Invoice with given contact code not found.

Security

Security Schema	Scopes
Authorization	global

---

india-e-invoice-controller

E-invoice APIs

Invoice in/e-invoice

GET

Summary

get Irn Values

Description

API to get Irn Values

Parameters

Name	Located in	Description	Required	Schema
id	query	id	No	long

Responses

Code	Description	Schema
200	IRN values have been fetched successfully.	string
401	Unauthorized
403	Forbidden
404	IRN Values not found.

Security

Security Schema	Scopes
Authorization	global

---

Get e-Invoice Auth Token

POST

Invoice in/e-invoice/auth-token

Summary

Get auth Token

Description

API to Get auth Token

Parameters

Name	Located in	Description	Required	Schema
irnAuthTokenRequestDto	body	irnAuthTokenRequestDto	No	IrnAuthTokenRequestDto

Responses

Code	Description	Schema
200	Submitting Data is Successful	IrnAuthTokenResponseDto
201	Created
401	Failed to submit data
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice in/e-invoice/cancel-irn-data

POST

Summary

Cancel Irn

Description

API to cancelIrn

Parameters

Name	Located in	Description	Required	Schema
irnRequestDto	body	irnRequestDto	No	IrnRequestCancelDto

Responses

Code	Description	Schema
200	Canceling Data is Successful	EinvoiceInfoIndiaCancel
201	Created
401	Failed to cancel data
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice in/e-invoice/failure-log-report

GET

Summary

eInvoice Failure Log Report

Description

API to get eInvoice failure log report

Parameters

Name	Located in	Description	Required	Schema
customfield	query	customfield	No	string
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	Data have been fetched successfully.	boolean
401	Unauthorized
403	Forbidden
404	E-Invoice failure log report data not found.

Security

Security Schema	Scopes
Authorization	global

Invoice in/e-invoice/irn-data

POST

Summary

Post Irn

Description

API to postIrn

Parameters

Name	Located in	Description	Required	Schema
irnRequestDto	body	irnRequestDto	No	IrnRequestDto

Responses

Code	Description	Schema
200	Submitting Data is Successful	EinvoiceInfoIndia
201	Created
401	Failed to submit data
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice in/e-invoice/irn-data-bulk

POST

Summary

Post Bulk Irn

Description

API to post Bulk Irn

Parameters

Name	Located in	Description	Required	Schema
irnRequestDto	body	irnRequestDto	No	IrnBulkRequestDto

Responses

Code	Description	Schema
200	Submitting Data is Successful	BulkApiResponse
201	Created
401	Failed to submit data
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice in/e-invoice/irn-data-bulk-cancel

POST

Summary

Cancel Bulk Irn

Description

API to Cancel Bulk Irn

Parameters

Name	Located in	Description	Required	Schema
irnRequestDto	body	irnRequestDto	No	IrnRequestBulkCancelDto

Responses

Code	Description	Schema
200	Canceling Data is Successful	BulkApiResponse
201	Created
401	Failed to cancel data
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice in/e-invoice/is-cancel-valid

GET

Summary

check invoice can be canceled or not

Description

API to check invoice can be canceled or not

Parameters

Name	Located in	Description	Required	Schema
id	query	id	No	long

Responses

Code	Description	Schema
200	Data have been fetched successfully.	boolean
401	Unauthorized
403	Forbidden
404	IRN Values not found.

Security

Security Schema	Scopes
Authorization	global

---

eway-controller

Eway Bill India APIs

Invoice in/eway

GET

Summary

Fetch Eway bill for current Tenant

Description

API to get Eway bills for current tenant

Responses

Code	Description	Schema
200	Eway Bill has been fetched successfully.	EwayIndiaResponse
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create Eway bill

Description

API to create Eway bill

Parameters

Name	Located in	Description	Required	Schema
ewayIndiaRequest	body	ewayIndiaRequest	Yes	EwayIndiaRequest

Responses

Code	Description	Schema
200	OK	EwayIndiaResponse
201	Eway bill has been created successfully.	EwayIndiaResponse
400	Eway could not be created due to wrong data
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

---

Get eWay Bill Auth Token

POST

Invoice in/eway/auth-token

Summary

Get auth Token

Description

API to Get auth Token

Parameters

Name	Located in	Description	Required	Schema
irnAuthTokenRequestDto	body	irnAuthTokenRequestDto	No	EWayBillAuthTokenRequestDto

Responses

Code	Description	Schema
200	Submitting Data is Successful	EWayBillAuthTokenResponseDto
201	Created
401	Failed to submit data
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

---

Invoice in/eway/bulk-generate-ewb

POST

Summary

Generate bulk eWay bill

Description

API to generate bulk eWay bill

Parameters

Name	Located in	Description	Required	Schema
bulkEwbRequestDto	body	bulkEwbRequestDto	No	BulkEwbRequestDto

Responses

Code	Description	Schema
200	Submitting Data is Successful	BulkApiResponse
201	Created
401	Failed to submit data
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice in/eway/cancel

PUT

Summary

Cancel Eway bill

Description

API to cancel Eway bill

Parameters

Name	Located in	Description	Required	Schema
salesInvoiceCode	body	salesInvoiceCode	Yes	string

Responses

Code	Description	Schema
200	OK	EwayIndiaResponse
201	Eway bill has been cancelled successfully.	EwayIndiaResponse
400	Eway could not be cancelled due to wrong data
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice in/eway/download

GET

Summary

Export Eway Json for current Tenant

Description

API to export Eway Json for current Tenant

Parameters

Name	Located in	Description	Required	Schema
salesInvoiceCode	query		No	[ string ]

Responses

Code	Description	Schema
200	Export Eway Json for current Tenant is successful	Resource
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice in/eway/ewb-report

GET

Summary

Search Eway Bill

Description

API to search Eway bills.

Parameters

Name	Located in	Description	Required	Schema
fromDate	query	fromDate	No	dateTime
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
toDate	query	toDate	No	dateTime

Responses

Code	Description	Schema
200	Sales invoices have been fetched successfully.	SalesInvoiceResponse
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice in/eway/generate-ewb

POST

Summary

Generate eWay bill

Description

API to generate eWay bill

Parameters

Name	Located in	Description	Required	Schema
ewbRequestDto	body	ewbRequestDto	No	EwbRequestDto

Responses

Code	Description	Schema
200	Submitting Data is Successful	EWayBillInfoIndia
201	Created
401	Failed to submit data
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice in/eway/list/{contactCode}

GET

Summary

Get sales invoice by contact code.

Description

API to fetch sales invoice details by contact code.

Parameters

Name	Located in	Description	Required	Schema
contactCode	path	contactCode	Yes	string

Responses

Code	Description	Schema
200	Sales invoice information has been fetched successfully.	SalesInvoiceResponseIndia
401	Unauthorized
403	Forbidden
404	Sales invoice not found.

Security

Security Schema	Scopes
Authorization	global

Invoice in/eway/search

GET

Summary

Search Eway Bill

Description

API to search Eway bills.

Parameters

Name	Located in	Description	Required	Schema
ewayBillStatus	query	ewayBillStatus	Yes	string
fromDate	query	fromDate	No	dateTime
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
toDate	query	toDate	No	dateTime
transactionType	query	transactionType	Yes	string

Responses

Code	Description	Schema
200	Sales invoices have been fetched successfully.	SalesInvoiceResponse
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice in/eway/update

PUT

Summary

Update Eway bill attributes

Description

API to update Eway bill

Parameters

Name	Located in	Description	Required	Schema
ewayIndiaRequest	body	ewayIndiaRequest	Yes	EwayIndiaRequest

Responses

Code	Description	Schema
200	OK	EwayIndiaResponse
201	Eway bill has been updated successfully.	EwayIndiaResponse
400	Eway could not be updated due to wrong data
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice in/eway/{salesInvoiceCode}

GET

Summary

Fetch Eway bill by Sales Invoice Code

Description

API to get Eway bill by sales invoice code

Parameters

Name	Located in	Description	Required	Schema
salesInvoiceCode	path	salesInvoiceCode	Yes	string

Responses

Code	Description	Schema
200	Eway Bill has been fetched successfully.	EwayIndiaResponse
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

---

payment-milestone-controller

Payment milestone APIs

Invoice paymentmilestone

POST

Summary

Create new Payment milestone.

Description

API to create new Payment milestone.

Parameters

Name	Located in	Description	Required	Schema
paymentMilestoneDetails	body	paymentMilestoneDetails	Yes	[ PaymentMilestoneDetailsRequest ]

Responses

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

Security

Security Schema	Scopes
Authorization	global

Invoice paymentmilestone/byDocumentType

GET

Summary

Get payment milestone by document type.

Description

API to get existing payment milestones.

Parameters

Name	Located in	Description	Required	Schema
documentType	query	documentType	Yes	string
limit	query	limit	No	integer
page	query	page	No	integer
paymentStatus	query	paymentStatus	Yes	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string

Responses

Code	Description	Schema
200	Payment milestone have been fetched successfully.	Page«PaymentMilestoneDetailsResponse»
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice paymentmilestone/details/{documentCode}

GET

Summary

Get payment milestone details by document code and document type.

Description

Payment milestone details have been fetched successfully.

Parameters

Name	Located in	Description	Required	Schema
documentCode	path	documentCode	Yes	string
documentType	query	documentType	Yes	string

Responses

Code	Description	Schema
200	API to get payment milestone details by document code and document type.	[ PaymentMilestoneDetailsResponse ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice paymentmilestone/report/tracker/details

GET

Summary

Get payment milestone tracker details report.

Description

API to payment milestone tracker details report.

Parameters

Name	Located in	Description	Required	Schema
?	query	?	No	string
fromDate	query	fromDate	Yes	dateTime
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string
toDate	query	toDate	Yes	dateTime

Responses

Code	Description	Schema
200	Payment milestone tracker details report have been fetched successfully.	[ PaymentMilestoneTrackerDetailsReport ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice paymentmilestone/report/tracker/summary

GET

Summary

Get payment milestone tracker summary report.

Description

API to payment milestone tracker summary report.

Parameters

Name	Located in	Description	Required	Schema
?	query	?	No	string
fromDate	query	fromDate	Yes	dateTime
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string
toDate	query	toDate	Yes	dateTime

Responses

Code	Description	Schema
200	Payment milestone tracker summary report have been fetched successfully.	[ PaymentMilestoneTrackerSummaryReport ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice paymentmilestone/search

GET

Summary

Search payment milestone.

Description

API to search existing payment milestones.

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 milestone have been fetched successfully.	Page«PaymentMilestoneDetailsResponse»
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice paymentmilestone/{documentCode}

PUT

Summary

Update existing Payment milestone.

Description

API to update existing Payment milestone.

Parameters

Name	Located in	Description	Required	Schema
documentCode	path	documentCode	Yes	string
paymentMilestoneDetails	body	paymentMilestoneDetails	Yes	[ PaymentMilestoneDetailsRequest ]

Responses

Code	Description	Schema
200	Payment milestone has been updated successfully.	PaymentMilestoneDetailsResponse
201	Created
401	Unauthorized
403	Forbidden
404	Payment milestone with code not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete Payment milestone.

Description

API to delete existing Payment milestone.

Parameters

Name	Located in	Description	Required	Schema
documentCode	path	documentCode	Yes	string
documentType	body	documentType	Yes	string

Responses

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

Security

Security Schema	Scopes
Authorization	global

---

purchase-invoice-controller

Purchase Invoice APIs

Invoice purchase

GET

Summary

Search purchase invoices.

Description

API to search purchase invoices.

Parameters

Name	Located in	Description	Required	Schema
customfield	query	customfield	No	string
fetchAttachmentDetails	query	fetchAttachmentDetails	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	Purchase invoices have been fetched successfully.	PurchaseInvoiceResponse
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create purchase invoice

Description

API to create purchase invoice.

Parameters

Name	Located in	Description	Required	Schema
purchaseInvoiceRequest	body	purchaseInvoiceRequest	Yes	PurchaseInvoiceRequest

Responses

Code	Description	Schema
200	OK	PurchaseInvoiceResponse
201	Purchase invoice has been created successfully.	PurchaseInvoiceResponse
400	Purchase invoice could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

PUT

Summary

Update purchase invoice attributes by code.

Description

API to update attributes of existing purchase invoice by code.

Parameters

Name	Located in	Description	Required	Schema
code	query	code	Yes	string
request	body	request	Yes	PurchaseInvoiceUpdateRequest

Responses

Code	Description
200	Purchase invoice attributes has been updated successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Purchase invoice with given code not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete purchase invoices by ids in bulk.

Description

API to delete purchase invoices in bulk.

Parameters

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

Responses

Code	Description	Schema
200	OK	BulkResponse
204	No Content
207	Request processed successfully.	BulkResponse
401	Unauthorized
403	Forbidden
404	Purchase invoices not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/approval-status

POST

Summary

Update approval status

Description

API to update approval status

Parameters

Name	Located in	Description	Required	Schema
approvalStatusRequestDtoList	body	approvalStatusRequestDtoList	Yes	[ ApprovalStatusRequestDto ]

Responses

Code	Description
200	Approval status for Sales documents have been updated successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/asset-group-count/{id}

GET

Summary

Get asset group used count.

Description

Api to get asset group used count.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description	Schema
200	Asset group used count fetched successfully.	integer
401	Unauthorized
403	Forbidden
404	Asset group used count not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/bulk

POST

Summary

Create multiple sales invoice

Description

API to create sales invoice.

Parameters

Name	Located in	Description	Required	Schema
purchaseInvoiceRequests	body	purchaseInvoiceRequests	Yes	[ PurchaseInvoiceRequest ]

Responses

Code	Description	Schema
200	OK	PurchaseInvoiceResponse
201	Sales invoice has been created successfully.	PurchaseInvoiceResponse
400	Sales invoice could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/bulk-delete

DELETE

Summary

Bulk Delete purchase invoices.

Description

API to Bulk Delete purchase invoices.

Parameters

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

Responses

Code	Description	Schema
200	OK	[ BulkDeletePurchaseInvoiceResponse ]
204	Purchase invoice has been deleted successfully.	[ BulkDeletePurchaseInvoiceResponse ]
401	Unauthorized
403	Forbidden
404	Purchase invoice not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/bulk-details

POST

Summary

Purchase invoice details by codes

Description

Purchase invoice details by codes

Parameters

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

Responses

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

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/bulk-update-purchase-invoice

PATCH

Summary

Update purchase invoices

Description

API to Update purchase invoices

Parameters

Name	Located in	Description	Required	Schema
purchaseInvoiceFields	body	purchaseInvoiceFields	Yes	[ Map«string,string» ]

Responses

Code	Description	Schema
200	OK	[ BulkPurchaseInvoiceUpdateResponse ]
204	No Content
207	Purchase invoices updated successfully.	[ BulkPurchaseInvoiceUpdateResponse ]
401	Unauthorized
403	Forbidden
404	Sales Invoice with given id not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/bulk/codes

POST

Summary

Get multiple purchase invoices

Description

API to get purchase invoices.

Parameters

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

Responses

Code	Description	Schema
200	Purchase documents have been fetched successfully.	PurchaseInvoiceResponse
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/code/{code}

GET

Summary

Get purchase invoice by code.

Description

API to fetch purchase invoice details by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase invoice information has been fetched successfully.	PurchaseInvoiceResponse
401	Unauthorized
403	Forbidden
404	Purchase invoice not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/code/{code}/details

GET

Summary

Purchase invoice details by codes

Description

Purchase invoice details by codes

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	OK	PurchaseInvoiceInformation
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/codes

POST

Summary

Get Invoice information by codes.

Description

API to get invoice document information by codes.

Parameters

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

Responses

Code	Description	Schema
200	Invoice documents have been fetched successfully.	[ PurchaseDocument ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/contrabill

POST

Summary

Bill contra adjustment.

Description

API to contra adjustment for bill of contact.

Parameters

Name	Located in	Description	Required	Schema
contraBillDto	body	contraBillDto	Yes	ContraBillDto

Responses

Code	Description	Schema
200	OK	ContraBillDto
201	Contra adjustment for bill has been done successfully.	ContraBillDto
400	Contra adjustment for bill has been failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Bill contra adjustment.

Description

API to contra adjustment for bill of contact.

Parameters

Name	Located in	Description	Required	Schema
contraCode	query	contraCode	Yes	string
salesInvoiceCode	query	salesInvoiceCode	Yes	string

Responses

Code	Description	Schema
200	OK	ContraBillDto
201	Contra adjustment for bill has been done successfully.	ContraBillDto
204	No Content
400	Contra adjustment for bill has been failed because of insufficient data.
401	Unauthorized
403	Forbidden

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/create-recurring

POST

Summary

Create a recurring invoice

Description

API to create a recurring invoice.

Parameters

Name	Located in	Description	Required	Schema
event	body	event	Yes	RecurringJobEvent

Responses

Code	Description	Schema
200	OK	PurchaseInvoiceResponse
201	Recurring invoice created successfully	PurchaseInvoiceResponse
400	Error while creating recurring invoice
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/documentseqcode

POST

Summary

Get purchase invoice by code.

Description

API to fetch purchase invoice details by it's code.

Parameters

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

Responses

Code	Description	Schema
200	Purchase invoice information has been fetched successfully.	PurchaseInvoiceResponse
201	Created
401	Unauthorized
403	Forbidden
404	Purchase invoice not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/draft/trigger

POST

Summary

Create approval status trigger

Description

API to reate approval status trigger

Parameters

Name	Located in	Description	Required	Schema
triggerKafkaRequestDto	body	triggerKafkaRequestDto	Yes	TriggerKafkaRequestDto

Responses

Code	Description
200	Trigger created for approval status
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/due-amount

PUT

Summary

Update due amount for purchase invoices in bulk.

Description

API to update due amount for purchase invoices in bulk.

Parameters

Name	Located in	Description	Required	Schema
invoiceUpdateAmountDueDtoList	body	invoiceUpdateAmountDueDtoList	Yes	[ InvoiceUpdateAmountDueDto ]
revert	query	revert	Yes	boolean

Responses

Code	Description
200	Due amounts updated successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Purchase invoice not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/due-amount-bulk-payment-delete

PUT

Summary

Update due amount for purchase invoices in bulk payment delete.

Description

API to update due amount for purchase invoices in bulk payment delete.

Parameters

Name	Located in	Description	Required	Schema
invoiceUpdateAmountDueDtoList	body	invoiceUpdateAmountDueDtoList	Yes	[ InvoiceUpdateAmountDueDto ]

Responses

Code	Description
200	Due amounts updated successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Purchase invoice not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/es/{contactCode}

GET

Summary

Get Invoice for contact.

Description

Get Invoice with contact code from ES.

Parameters

Name	Located in	Description	Required	Schema
contactCode	path	contactCode	Yes	string

Responses

Code	Description	Schema
200	Get Invoice successfully.	PurchaseInvoiceResponse
401	Unauthorized
403	Forbidden
404	Invoice with given contact code not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/journal

POST

Summary

Recreate Journal Entries for all Purchase Invoices

Description

API to recreate Journal Entries for all Purchase Invoices.

Responses

Code	Description
200	Journal Entries for all Purchase Invoices recreated successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/linked-docs/product-codes

POST

Summary

Get products by code

Description

API to Get products by code.

Parameters

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

Responses

Code	Description	Schema
200	Product information has been fetched successfully.	string
201	Created
401	Unauthorized
403	Forbidden
404	Products not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/linked-order/{code}

GET

Summary

Get purchase invoices linked to an order by code.

Description

API to fetch purchase invoices linked to an order by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase invoices has been fetched successfully.	PurchaseInvoiceResponse
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/linked-orders

POST

Summary

Get purchase invoices linked to an order by code.

Description

API to fetch purchase invoices linked to an order by it's code.

Parameters

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

Responses

Code	Description	Schema
200	Purchase invoices has been fetched successfully.	PurchaseInvoiceResponse
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/linked/status/{code}

PUT

Summary

refreshLinkedPIStatus

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

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

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/notes

DELETE

Summary

Delete sales invoice by id.

Description

API to delete sales invoice details by id.

Parameters

Name	Located in	Description	Required	Schema
code	query	code	Yes	string
invoicecode	query	invoicecode	Yes	string
uid	query	uid	Yes	string (uuid)

Responses

Code	Description
200	OK
204	Sales invoice has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Sales invoice not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/payment

DELETE

Summary

Delete Payment

Description

API to Delete Payment

Parameters

Name	Located in	Description	Required	Schema
paymentCode	query	paymentCode	Yes	string
purchaseInvoiceCode	query	purchaseInvoiceCode	Yes	string
uid	query	uid	No	string (uuid)

Responses

Code	Description	Schema
200	API to Delete Payment	PurchaseInvoiceResponse
204	No Content
401	Unauthorized
403	Forbidden

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/pendingpaymentbillcode

GET

Summary

Get purchase invoice by code for Pending Payment.

Description

API to Get purchase invoice by code for Pending Payment.

Responses

Code	Description	Schema
200	Purchase invoice information has been fetched successfully.	string
401	Unauthorized
403	Forbidden
404	Purchase invoice not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/purchase/receipt

DELETE

Summary

API to Delete Goods Receipt

Description

API to Delete Goods Receipt

Parameters

Name	Located in	Description	Required	Schema
goodsReceiptCode	query	goodsReceiptCode	Yes	string
isBulkDeleted	query	isBulkDeleted	No	boolean
purchaseInvoiceCode	query	purchaseInvoiceCode	Yes	string

Responses

Code	Description	Schema
200	API to Delete Goods Receipt	PurchaseInvoiceResponse
204	No Content
401	Unauthorized
403	Forbidden

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/record-filter

POST

Summary

Create approval status trigger

Description

API to reate approval status trigger

Parameters

Name	Located in	Description	Required	Schema
filterRecord	body	filterRecord	Yes	FilterRecord

Responses

Code	Description	Schema
200	Trigger created for approval status	boolean
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/report/count

POST

Summary

Get purchase invoice count for contacts

Description

API to fetch purchase invoice count for contacts

Parameters

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

Responses

Code	Description	Schema
200	Contact purchase invoice count has been fetched.	object
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/report/overview

GET

Summary

Purchase invoice overview report data.

Description

API to fetch purchase invoice overview report data

Parameters

Name	Located in	Description	Required	Schema
contactCode	query	contactCode	No	string
interval	query	interval	No	string

Responses

Code	Description	Schema
200	Purchase invoice overview report has been prepared.	InvoiceOverviewReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/report/unpaid

GET

Summary

Unpaid purchase invoices report.

Description

API to fetch unpaid purchase invoices

Responses

Code	Description	Schema
200	Unpaid purchase invoices report has been prepared.	DashboardReportData
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/set-recurring

POST

Summary

Set an invoice to recurring

Description

API to set and invoice to recurring.

Parameters

Name	Located in	Description	Required	Schema
setRecurringDto	body	setRecurringDto	Yes	SetRecurringDto

Responses

Code	Description	Schema
200	Invoice set to recur successfully	PurchaseInvoiceResponse
201	Created
400	Error while setting invoice to recur
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/status/{code}

PUT

Summary

refreshPIStatus

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

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

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/stockQuantities

POST

Summary

Get purchase invoice stock quantities

Description

API to get purchase invoice stock quantities

Parameters

Name	Located in	Description	Required	Schema
request	body	request	Yes	StockQuantitiesRequest

Responses

Code	Description	Schema
200	Fetched purchase invoice stock quantities successfully.	StockQuantitiesResponse
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/tax/count

POST

Summary

Get purchase invoice count for tax

Description

API to fetch purchase invoice count for tax

Parameters

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

Responses

Code	Description	Schema
200	Tax purchase invoice count has been fetched.	object
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/unreceived-seq-codes

GET

Summary

Get Unfulfilled purchase invoices codes

Description

Get Unfulfilled purchase invoices codes

Responses

Code	Description	Schema
200	Sales invoice information has been fetched successfully.	[ object ]
401	Unauthorized
403	Forbidden
404	Sales invoice not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/update-knock-off

POST

Summary

Update knock off information

Description

Api to update knock off information

Parameters

Name	Located in	Description	Required	Schema
knockOffInfos	body	knockOffInfos	Yes	object

Responses

Code	Description
200	Knock off information updated successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/{code}

GET

Summary

Get purchase invoice by code.

Description

API to fetch purchase invoice details by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase invoice information has been fetched successfully.	PurchaseInvoiceResponse
401	Unauthorized
403	Forbidden
404	Purchase invoice not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/{code}/asset-details

POST

Summary

Save Assets details for purchase invoice

Description

API to save Assets details for purchase invoice.

Parameters

Name	Located in	Description	Required	Schema
assetRequests	body	assetRequests	Yes	[ AssetRequest ]
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Asset details for purchase invoice saved successfully.	BulkApiResponse
201	Created
401	Unauthorized
403	Forbidden
404	Api to save asset details for purchase invoice failed.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/{id}

PUT

Summary

Update purchase invoice.

Description

API to update existing purchase invoice.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
purchaseInvoiceRequest	body	purchaseInvoiceRequest	Yes	PurchaseInvoiceRequest

Responses

Code	Description	Schema
200	Purchase Invoice has been updated successfully.	PurchaseInvoiceResponse
201	Created
400	Purchase invoice draft status cannot be changed after saving
401	Unauthorized
403	Forbidden
404	Purchase Invoice with given id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete purchase invoice by id.

Description

API to delete purchase invoice details by id.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description
200	OK
204	Purchase invoice has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Purchase invoice not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update purchase invoice memo or attachment

Description

API to update purchase invoice memo or attachment

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
purchaseInvoiceFields	body	purchaseInvoiceFields	Yes	object

Responses

Code	Description	Schema
200	Memo/attachment for purchase invoice updated successfully.	PurchaseInvoiceResponse
204	No Content
401	Unauthorized
403	Forbidden
404	Purchase Invoice with id not found.

Security

Security Schema	Scopes
Authorization	global

---

purchase-invoice-controller-uae

Purchase Invoice APIs for UAE

Invoice purchase/ae

GET

Summary

Search purchase invoices.

Description

API to search purchase invoices.

Parameters

Name	Located in	Description	Required	Schema
customfield	query	customfield	No	string
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	Purchase invoices have been fetched successfully.	PurchaseInvoiceResponseUae
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create purchase invoice

Description

API to create purchase invoice.

Parameters

Name	Located in	Description	Required	Schema
purchaseInvoiceRequest	body	purchaseInvoiceRequest	Yes	PurchaseInvoiceRequestUae

Responses

Code	Description	Schema
200	OK	PurchaseInvoiceResponseUae
201	Purchase invoice has been created successfully.	PurchaseInvoiceResponseUae
400	Purchase invoice could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

PUT

Summary

Update purchase invoice attributes by code.

Description

API to update attributes of existing purchase invoice by code.

Parameters

Name	Located in	Description	Required	Schema
code	query	code	Yes	string
request	body	request	Yes	PurchaseInvoiceUpdateRequest

Responses

Code	Description
200	Purchase invoice attributes has been updated successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Purchase invoice with given code not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete purchase invoices by ids in bulk.

Description

API to delete purchase invoices in bulk.

Parameters

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

Responses

Code	Description	Schema
200	OK	BulkResponse
204	No Content
207	Request processed successfully.	BulkResponse
401	Unauthorized
403	Forbidden
404	Purchase invoices not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/ae/bulk

POST

Summary

Create multiple sales invoice

Description

API to create sales invoice.

Parameters

Name	Located in	Description	Required	Schema
purchaseInvoiceRequests	body	purchaseInvoiceRequests	Yes	[ PurchaseInvoiceRequestUae ]

Responses

Code	Description	Schema
200	OK	PurchaseInvoiceResponseUae
201	Sales invoice has been created successfully.	PurchaseInvoiceResponseUae
400	Sales invoice could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/ae/code/{code}/details

GET

Summary

Purchase invoice details by codes

Description

Purchase invoice details by codes

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	OK	PurchaseInvoiceInformation
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/ae/due-amount

PUT

Summary

Update due amount for purchase invoices in bulk.

Description

API to update due amount for purchase invoices in bulk.

Parameters

Name	Located in	Description	Required	Schema
invoiceUpdateAmountDueDtoList	body	invoiceUpdateAmountDueDtoList	Yes	[ InvoiceUpdateAmountDueDto ]
revert	query	revert	Yes	boolean

Responses

Code	Description
200	Due amounts updated successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Purchase invoice not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/ae/es/{contactCode}

GET

Summary

Get Invoice for contact.

Description

Get Invoice with contact code from ES.

Parameters

Name	Located in	Description	Required	Schema
contactCode	path	contactCode	Yes	string

Responses

Code	Description	Schema
200	Get Invoice successfully.	PurchaseInvoiceResponseUae
401	Unauthorized
403	Forbidden
404	Invoice with given contact code not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/ae/linked-order/{code}

GET

Summary

Get purchase invoices linked to an order by code.

Description

API to fetch purchase invoices linked to an order by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase invoices has been fetched successfully.	PurchaseInvoiceResponseUae
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/ae/report/count

POST

Summary

Get purchase invoice count for contacts

Description

API to fetch purchase invoice count for contacts

Parameters

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

Responses

Code	Description	Schema
200	Contact purchase invoice count has been fetched.	object
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/ae/report/overview

GET

Summary

Purchase invoice overview report data.

Description

API to fetch purchase invoice overview report data

Parameters

Name	Located in	Description	Required	Schema
contactCode	query	contactCode	No	string
interval	query	interval	No	string

Responses

Code	Description	Schema
200	Purchase invoice overview report has been prepared.	InvoiceOverviewReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/ae/report/unpaid

GET

Summary

Unpaid purchase invoices report.

Description

API to fetch unpaid purchase invoices

Responses

Code	Description	Schema
200	Unpaid purchase invoices report has been prepared.	DashboardReportData
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/ae/{code}

GET

Summary

Get purchase invoice by code.

Description

API to fetch purchase invoice details by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase invoice information has been fetched successfully.	PurchaseInvoiceResponseUae
401	Unauthorized
403	Forbidden
404	Purchase invoice not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/ae/{id}

PUT

Summary

Update purchase invoice.

Description

API to update existing purchase invoice.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
purchaseInvoiceRequest	body	purchaseInvoiceRequest	Yes	PurchaseInvoiceRequestUae

Responses

Code	Description	Schema
200	Purchase Invoice has been updated successfully.	PurchaseInvoiceResponseUae
201	Created
400	Purchase invoice draft status cannot be changed after saving
401	Unauthorized
403	Forbidden
404	Purchase Invoice with given id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete purchase invoice by id.

Description

API to delete purchase invoice details by id.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description
200	OK
204	Purchase invoice has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Purchase invoice not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update purchase invoice memo or attachment

Description

API to update purchase invoice memo or attachment

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
purchaseInvoiceFields	body	purchaseInvoiceFields	Yes	object

Responses

Code	Description	Schema
200	Memo/attachment for purchase invoice updated successfully.	PurchaseInvoiceResponseUae
204	No Content
401	Unauthorized
403	Forbidden
404	Purchase Invoice with id not found.

Security

Security Schema	Scopes
Authorization	global

---

purchase-invoice-controller-australia

Purchase Invoice APIs for Australia.

Invoice purchase/au

GET

Summary

Search purchase invoices.

Description

API to search purchase invoices.

Parameters

Name	Located in	Description	Required	Schema
customfield	query	customfield	No	string
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	Purchase invoices have been fetched successfully.	PurchaseInvoiceResponseAustralia
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create purchase invoice

Description

API to create purchase invoice.

Parameters

Name	Located in	Description	Required	Schema
purchaseInvoiceRequest	body	purchaseInvoiceRequest	Yes	PurchaseInvoiceRequestAustralia

Responses

Code	Description	Schema
200	OK	PurchaseInvoiceResponseAustralia
201	Purchase invoice has been created successfully.	PurchaseInvoiceResponseAustralia
400	Purchase invoice could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

PUT

Summary

Update purchase invoice attributes by code.

Description

API to update attributes of existing purchase invoice by code.

Parameters

Name	Located in	Description	Required	Schema
code	query	code	Yes	string
request	body	request	Yes	PurchaseInvoiceUpdateRequest

Responses

Code	Description
200	Purchase invoice attributes has been updated successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Purchase invoice with given code not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete purchase invoices by ids in bulk.

Description

API to delete purchase invoices in bulk.

Parameters

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

Responses

Code	Description	Schema
200	OK	BulkResponse
204	No Content
207	Request processed successfully.	BulkResponse
401	Unauthorized
403	Forbidden
404	Purchase invoices not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/au/bulk

POST

Summary

Create multiple sales invoice

Description

API to create sales invoice.

Parameters

Name	Located in	Description	Required	Schema
purchaseInvoiceRequests	body	purchaseInvoiceRequests	Yes	[ PurchaseInvoiceRequestAustralia ]

Responses

Code	Description	Schema
200	OK	PurchaseInvoiceResponseAustralia
201	Sales invoice has been created successfully.	PurchaseInvoiceResponseAustralia
400	Sales invoice could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/au/code/{code}/details

GET

Summary

Purchase invoice details by codes

Description

Purchase invoice details by codes

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	OK	PurchaseInvoiceInformation
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/au/due-amount

PUT

Summary

Update due amount for purchase invoices in bulk.

Description

API to update due amount for purchase invoices in bulk.

Parameters

Name	Located in	Description	Required	Schema
invoiceUpdateAmountDueDtoList	body	invoiceUpdateAmountDueDtoList	Yes	[ InvoiceUpdateAmountDueDto ]
revert	query	revert	Yes	boolean

Responses

Code	Description
200	Due amounts updated successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Purchase invoice not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/au/es/{contactCode}

GET

Summary

Get Invoice for contact.

Description

Get Invoice with contact code from ES.

Parameters

Name	Located in	Description	Required	Schema
contactCode	path	contactCode	Yes	string

Responses

Code	Description	Schema
200	Get Invoice successfully.	PurchaseInvoiceResponseAustralia
401	Unauthorized
403	Forbidden
404	Invoice with given contact code not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/au/linked-order/{code}

GET

Summary

Get purchase invoices linked to an order by code.

Description

API to fetch purchase invoices linked to an order by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase invoices has been fetched successfully.	PurchaseInvoiceResponseAustralia
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/au/report/count

POST

Summary

Get purchase invoice count for contacts

Description

API to fetch purchase invoice count for contacts

Parameters

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

Responses

Code	Description	Schema
200	Contact purchase invoice count has been fetched.	object
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/au/report/overview

GET

Summary

Purchase invoice overview report data.

Description

API to fetch purchase invoice overview report data

Parameters

Name	Located in	Description	Required	Schema
contactCode	query	contactCode	No	string
interval	query	interval	No	string

Responses

Code	Description	Schema
200	Purchase invoice overview report has been prepared.	InvoiceOverviewReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/au/report/unpaid

GET

Summary

Unpaid purchase invoices report.

Description

API to fetch unpaid purchase invoices

Responses

Code	Description	Schema
200	Unpaid purchase invoices report has been prepared.	DashboardReportData
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/au/{code}

GET

Summary

Get purchase invoice by code.

Description

API to fetch purchase invoice details by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase invoice information has been fetched successfully.	PurchaseInvoiceResponseAustralia
401	Unauthorized
403	Forbidden
404	Purchase invoice not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/au/{id}

PUT

Summary

Update purchase invoice.

Description

API to update existing purchase invoice.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
purchaseInvoiceRequest	body	purchaseInvoiceRequest	Yes	PurchaseInvoiceRequestAustralia

Responses

Code	Description	Schema
200	Purchase Invoice has been updated successfully.	PurchaseInvoiceResponseAustralia
201	Created
400	Purchase invoice draft status cannot be changed after saving
401	Unauthorized
403	Forbidden
404	Purchase Invoice with given id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete purchase invoice by id.

Description

API to delete purchase invoice details by id.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description
200	OK
204	Purchase invoice has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Purchase invoice not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update purchase invoice memo or attachment

Description

API to update purchase invoice memo or attachment

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
purchaseInvoiceFields	body	purchaseInvoiceFields	Yes	object

Responses

Code	Description	Schema
200	Memo/attachment for purchase invoice updated successfully.	PurchaseInvoiceResponseAustralia
204	No Content
401	Unauthorized
403	Forbidden
404	Purchase Invoice with id not found.

Security

Security Schema	Scopes
Authorization	global

---

purchase-invoice-controller-belgium

Purchase Invoice APIs for Belgium

Invoice purchase/be

GET

Summary

Search purchase invoices.

Description

API to search purchase invoices.

Parameters

Name	Located in	Description	Required	Schema
customfield	query	customfield	No	string
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	Purchase invoices have been fetched successfully.	PurchaseInvoiceResponseAustralia
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create purchase invoice

Description

API to create purchase invoice.

Parameters

Name	Located in	Description	Required	Schema
purchaseInvoiceRequest	body	purchaseInvoiceRequest	Yes	PurchaseInvoiceRequestAustralia

Responses

Code	Description	Schema
200	OK	PurchaseInvoiceResponseAustralia
201	Purchase invoice has been created successfully.	PurchaseInvoiceResponseAustralia
400	Purchase invoice could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

PUT

Summary

Update purchase invoice attributes by code.

Description

API to update attributes of existing purchase invoice by code.

Parameters

Name	Located in	Description	Required	Schema
code	query	code	Yes	string
request	body	request	Yes	PurchaseInvoiceUpdateRequest

Responses

Code	Description
200	Purchase invoice attributes has been updated successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Purchase invoice with given code not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete purchase invoices by ids in bulk.

Description

API to delete purchase invoices in bulk.

Parameters

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

Responses

Code	Description	Schema
200	OK	BulkResponse
204	No Content
207	Request processed successfully.	BulkResponse
401	Unauthorized
403	Forbidden
404	Purchase invoices not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/be/bulk

POST

Summary

Create multiple sales invoice

Description

API to create sales invoice.

Parameters

Name	Located in	Description	Required	Schema
purchaseInvoiceRequests	body	purchaseInvoiceRequests	Yes	[ PurchaseInvoiceRequestAustralia ]

Responses

Code	Description	Schema
200	OK	PurchaseInvoiceResponseAustralia
201	Sales invoice has been created successfully.	PurchaseInvoiceResponseAustralia
400	Sales invoice could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/be/code/{code}/details

GET

Summary

Purchase invoice details by codes

Description

Purchase invoice details by codes

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	OK	PurchaseInvoiceInformation
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/be/due-amount

PUT

Summary

Update due amount for purchase invoices in bulk.

Description

API to update due amount for purchase invoices in bulk.

Parameters

Name	Located in	Description	Required	Schema
invoiceUpdateAmountDueDtoList	body	invoiceUpdateAmountDueDtoList	Yes	[ InvoiceUpdateAmountDueDto ]
revert	query	revert	Yes	boolean

Responses

Code	Description
200	Due amounts updated successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Purchase invoice not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/be/es/{contactCode}

GET

Summary

Get Invoice for contact.

Description

Get Invoice with contact code from ES.

Parameters

Name	Located in	Description	Required	Schema
contactCode	path	contactCode	Yes	string

Responses

Code	Description	Schema
200	Get Invoice successfully.	PurchaseInvoiceResponseAustralia
401	Unauthorized
403	Forbidden
404	Invoice with given contact code not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/be/linked-order/{code}

GET

Summary

Get purchase invoices linked to an order by code.

Description

API to fetch purchase invoices linked to an order by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase invoices has been fetched successfully.	PurchaseInvoiceResponseAustralia
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/be/report/count

POST

Summary

Get purchase invoice count for contacts

Description

API to fetch purchase invoice count for contacts

Parameters

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

Responses

Code	Description	Schema
200	Contact purchase invoice count has been fetched.	object
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/be/report/overview

GET

Summary

Purchase invoice overview report data.

Description

API to fetch purchase invoice overview report data

Parameters

Name	Located in	Description	Required	Schema
contactCode	query	contactCode	No	string
interval	query	interval	No	string

Responses

Code	Description	Schema
200	Purchase invoice overview report has been prepared.	InvoiceOverviewReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/be/report/unpaid

GET

Summary

Unpaid purchase invoices report.

Description

API to fetch unpaid purchase invoices

Responses

Code	Description	Schema
200	Unpaid purchase invoices report has been prepared.	DashboardReportData
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/be/{code}

GET

Summary

Get purchase invoice by code.

Description

API to fetch purchase invoice details by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase invoice information has been fetched successfully.	PurchaseInvoiceResponseAustralia
401	Unauthorized
403	Forbidden
404	Purchase invoice not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/be/{id}

PUT

Summary

Update purchase invoice.

Description

API to update existing purchase invoice.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
purchaseInvoiceRequest	body	purchaseInvoiceRequest	Yes	PurchaseInvoiceRequestAustralia

Responses

Code	Description	Schema
200	Purchase Invoice has been updated successfully.	PurchaseInvoiceResponseAustralia
201	Created
400	Purchase invoice draft status cannot be changed after saving
401	Unauthorized
403	Forbidden
404	Purchase Invoice with given id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete purchase invoice by id.

Description

API to delete purchase invoice details by id.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description
200	OK
204	Purchase invoice has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Purchase invoice not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update purchase invoice memo or attachment

Description

API to update purchase invoice memo or attachment

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
purchaseInvoiceFields	body	purchaseInvoiceFields	Yes	object

Responses

Code	Description	Schema
200	Memo/attachment for purchase invoice updated successfully.	PurchaseInvoiceResponseAustralia
204	No Content
401	Unauthorized
403	Forbidden
404	Purchase Invoice with id not found.

Security

Security Schema	Scopes
Authorization	global

---

purchase-invoice-controller-canada

Purchase Invoice APIs for Canada.

Invoice purchase/ca

GET

Summary

Search purchase invoices.

Description

API to search purchase invoices.

Parameters

Name	Located in	Description	Required	Schema
customfield	query	customfield	No	string
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	Purchase invoices have been fetched successfully.	PurchaseInvoiceResponseCanada
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create purchase invoice

Description

API to create purchase invoice.

Parameters

Name	Located in	Description	Required	Schema
purchaseInvoiceRequest	body	purchaseInvoiceRequest	Yes	PurchaseInvoiceRequestCanada

Responses

Code	Description	Schema
200	OK	PurchaseInvoiceResponseCanada
201	Purchase invoice has been created successfully.	PurchaseInvoiceResponseCanada
400	Purchase invoice could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

PUT

Summary

Update purchase invoice attributes by code.

Description

API to update attributes of existing purchase invoice by code.

Parameters

Name	Located in	Description	Required	Schema
code	query	code	Yes	string
request	body	request	Yes	PurchaseInvoiceUpdateRequest

Responses

Code	Description
200	Purchase invoice attributes has been updated successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Purchase invoice with given code not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete purchase invoices by ids in bulk.

Description

API to delete purchase invoices in bulk.

Parameters

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

Responses

Code	Description	Schema
200	OK	BulkResponse
204	No Content
207	Request processed successfully.	BulkResponse
401	Unauthorized
403	Forbidden
404	Purchase invoices not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/ca/bulk

POST

Summary

Create multiple sales invoice

Description

API to create sales invoice.

Parameters

Name	Located in	Description	Required	Schema
purchaseInvoiceRequests	body	purchaseInvoiceRequests	Yes	[ PurchaseInvoiceRequestCanada ]

Responses

Code	Description	Schema
200	OK	PurchaseInvoiceResponseCanada
201	Sales invoice has been created successfully.	PurchaseInvoiceResponseCanada
400	Sales invoice could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/ca/code/{code}/details

GET

Summary

Purchase invoice details by codes

Description

Purchase invoice details by codes

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	OK	PurchaseInvoiceInformation
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/ca/due-amount

PUT

Summary

Update due amount for purchase invoices in bulk.

Description

API to update due amount for purchase invoices in bulk.

Parameters

Name	Located in	Description	Required	Schema
invoiceUpdateAmountDueDtoList	body	invoiceUpdateAmountDueDtoList	Yes	[ InvoiceUpdateAmountDueDto ]
revert	query	revert	Yes	boolean

Responses

Code	Description
200	Due amounts updated successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Purchase invoice not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/ca/es/{contactCode}

GET

Summary

Get Invoice for contact.

Description

Get Invoice with contact code from ES.

Parameters

Name	Located in	Description	Required	Schema
contactCode	path	contactCode	Yes	string

Responses

Code	Description	Schema
200	Get Invoice successfully.	PurchaseInvoiceResponseCanada
401	Unauthorized
403	Forbidden
404	Invoice with given contact code not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/ca/linked-order/{code}

GET

Summary

Get purchase invoices linked to an order by code.

Description

API to fetch purchase invoices linked to an order by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase invoices has been fetched successfully.	PurchaseInvoiceResponseCanada
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/ca/report/count

POST

Summary

Get purchase invoice count for contacts

Description

API to fetch purchase invoice count for contacts

Parameters

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

Responses

Code	Description	Schema
200	Contact purchase invoice count has been fetched.	object
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/ca/report/overview

GET

Summary

Purchase invoice overview report data.

Description

API to fetch purchase invoice overview report data

Parameters

Name	Located in	Description	Required	Schema
contactCode	query	contactCode	No	string
interval	query	interval	No	string

Responses

Code	Description	Schema
200	Purchase invoice overview report has been prepared.	InvoiceOverviewReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/ca/report/unpaid

GET

Summary

Unpaid purchase invoices report.

Description

API to fetch unpaid purchase invoices

Responses

Code	Description	Schema
200	Unpaid purchase invoices report has been prepared.	DashboardReportData
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/ca/{code}

GET

Summary

Get purchase invoice by code.

Description

API to fetch purchase invoice details by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase invoice information has been fetched successfully.	PurchaseInvoiceResponseCanada
401	Unauthorized
403	Forbidden
404	Purchase invoice not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/ca/{id}

PUT

Summary

Update purchase invoice.

Description

API to update existing purchase invoice.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
purchaseInvoiceRequest	body	purchaseInvoiceRequest	Yes	PurchaseInvoiceRequestCanada

Responses

Code	Description	Schema
200	Purchase Invoice has been updated successfully.	PurchaseInvoiceResponseCanada
201	Created
400	Purchase invoice draft status cannot be changed after saving
401	Unauthorized
403	Forbidden
404	Purchase Invoice with given id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete purchase invoice by id.

Description

API to delete purchase invoice details by id.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description
200	OK
204	Purchase invoice has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Purchase invoice not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update purchase invoice memo or attachment

Description

API to update purchase invoice memo or attachment

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
purchaseInvoiceFields	body	purchaseInvoiceFields	Yes	object

Responses

Code	Description	Schema
200	Memo/attachment for purchase invoice updated successfully.	PurchaseInvoiceResponseCanada
204	No Content
401	Unauthorized
403	Forbidden
404	Purchase Invoice with id not found.

Security

Security Schema	Scopes
Authorization	global

---

purchase-invoice-controller-germany

Purchase Invoice APIs for Germany.

Invoice purchase/de

GET

Summary

Search purchase invoices.

Description

API to search purchase invoices.

Parameters

Name	Located in	Description	Required	Schema
customfield	query	customfield	No	string
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	Purchase invoices have been fetched successfully.	PurchaseInvoiceResponseGermany
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create purchase invoice

Description

API to create purchase invoice.

Parameters

Name	Located in	Description	Required	Schema
purchaseInvoiceRequest	body	purchaseInvoiceRequest	Yes	PurchaseInvoiceRequestGermany

Responses

Code	Description	Schema
200	OK	PurchaseInvoiceResponseGermany
201	Purchase invoice has been created successfully.	PurchaseInvoiceResponseGermany
400	Purchase invoice could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

PUT

Summary

Update purchase invoice attributes by code.

Description

API to update attributes of existing purchase invoice by code.

Parameters

Name	Located in	Description	Required	Schema
code	query	code	Yes	string
request	body	request	Yes	PurchaseInvoiceUpdateRequest

Responses

Code	Description
200	Purchase invoice attributes has been updated successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Purchase invoice with given code not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete purchase invoices by ids in bulk.

Description

API to delete purchase invoices in bulk.

Parameters

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

Responses

Code	Description	Schema
200	OK	BulkResponse
204	No Content
207	Request processed successfully.	BulkResponse
401	Unauthorized
403	Forbidden
404	Purchase invoices not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/de/bulk

POST

Summary

Create multiple sales invoice

Description

API to create sales invoice.

Parameters

Name	Located in	Description	Required	Schema
purchaseInvoiceRequests	body	purchaseInvoiceRequests	Yes	[ PurchaseInvoiceRequestGermany ]

Responses

Code	Description	Schema
200	OK	PurchaseInvoiceResponseGermany
201	Sales invoice has been created successfully.	PurchaseInvoiceResponseGermany
400	Sales invoice could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/de/code/{code}/details

GET

Summary

Purchase invoice details by codes

Description

Purchase invoice details by codes

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	OK	PurchaseInvoiceInformation
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/de/due-amount

PUT

Summary

Update due amount for purchase invoices in bulk.

Description

API to update due amount for purchase invoices in bulk.

Parameters

Name	Located in	Description	Required	Schema
invoiceUpdateAmountDueDtoList	body	invoiceUpdateAmountDueDtoList	Yes	[ InvoiceUpdateAmountDueDto ]
revert	query	revert	Yes	boolean

Responses

Code	Description
200	Due amounts updated successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Purchase invoice not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/de/es/{contactCode}

GET

Summary

Get Invoice for contact.

Description

Get Invoice with contact code from ES.

Parameters

Name	Located in	Description	Required	Schema
contactCode	path	contactCode	Yes	string

Responses

Code	Description	Schema
200	Get Invoice successfully.	PurchaseInvoiceResponseGermany
401	Unauthorized
403	Forbidden
404	Invoice with given contact code not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/de/linked-order/{code}

GET

Summary

Get purchase invoices linked to an order by code.

Description

API to fetch purchase invoices linked to an order by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase invoices has been fetched successfully.	PurchaseInvoiceResponseGermany
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/de/report/count

POST

Summary

Get purchase invoice count for contacts

Description

API to fetch purchase invoice count for contacts

Parameters

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

Responses

Code	Description	Schema
200	Contact purchase invoice count has been fetched.	object
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/de/report/overview

GET

Summary

Purchase invoice overview report data.

Description

API to fetch purchase invoice overview report data

Parameters

Name	Located in	Description	Required	Schema
contactCode	query	contactCode	No	string
interval	query	interval	No	string

Responses

Code	Description	Schema
200	Purchase invoice overview report has been prepared.	InvoiceOverviewReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/de/report/unpaid

GET

Summary

Unpaid purchase invoices report.

Description

API to fetch unpaid purchase invoices

Responses

Code	Description	Schema
200	Unpaid purchase invoices report has been prepared.	DashboardReportData
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/de/{code}

GET

Summary

Get purchase invoice by code.

Description

API to fetch purchase invoice details by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase invoice information has been fetched successfully.	PurchaseInvoiceResponseGermany
401	Unauthorized
403	Forbidden
404	Purchase invoice not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/de/{id}

PUT

Summary

Update purchase invoice.

Description

API to update existing purchase invoice.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
purchaseInvoiceRequest	body	purchaseInvoiceRequest	Yes	PurchaseInvoiceRequestGermany

Responses

Code	Description	Schema
200	Purchase Invoice has been updated successfully.	PurchaseInvoiceResponseGermany
201	Created
400	Purchase invoice draft status cannot be changed after saving
401	Unauthorized
403	Forbidden
404	Purchase Invoice with given id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete purchase invoice by id.

Description

API to delete purchase invoice details by id.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description
200	OK
204	Purchase invoice has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Purchase invoice not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update purchase invoice memo or attachment

Description

API to update purchase invoice memo or attachment

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
purchaseInvoiceFields	body	purchaseInvoiceFields	Yes	object

Responses

Code	Description	Schema
200	Memo/attachment for purchase invoice updated successfully.	PurchaseInvoiceResponseGermany
204	No Content
401	Unauthorized
403	Forbidden
404	Purchase Invoice with id not found.

Security

Security Schema	Scopes
Authorization	global

---

purchase-document-controller

Purchase Document APIs

Invoice purchase/document

GET

Summary

Search purchase documents.

Description

API to search purchase documents.

Parameters

Name	Located in	Description	Required	Schema
documentStage	query	documentStage	No	string
fromDate	query	fromDate	No	dateTime
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
toDate	query	toDate	No	dateTime

Responses

Code	Description	Schema
200	Purchase documents have been fetched successfully.	Page
400	Failed to fetch purchase documents.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/document/purchase/invoices

POST

Summary

Purchase Invoice Report

Description

Purchase Invoice Report API

Parameters

Name	Located in	Description	Required	Schema
request	body	request	Yes	InvoiceDataESRequest

Responses

Code	Description	Schema
200	Purchase Invoice data fetched from ES successfully.	InvoiceDataESResponse
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/document/summary

GET

Summary

Purchase documents summary.

Description

API for purchase documents summary.

Parameters

Name	Located in	Description	Required	Schema
fromDate	query	fromDate	No	dateTime
search	query	search	No	string
toDate	query	toDate	No	dateTime

Responses

Code	Description	Schema
200	Purchase documents summary has been fetched successfully.	DocumentSummaryResponse
400	Failed to fetch purchase documents summary.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

---

purchase-invoice-controller-indonesia

Purchase Invoice APIs for Indonesia

Invoice purchase/id

GET

Summary

Search purchase invoices.

Description

API to search purchase invoices.

Parameters

Name	Located in	Description	Required	Schema
customfield	query	customfield	No	string
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	Purchase invoices have been fetched successfully.	PurchaseInvoiceResponseIndonesia
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create purchase invoice

Description

API to create purchase invoice.

Parameters

Name	Located in	Description	Required	Schema
purchaseInvoiceRequest	body	purchaseInvoiceRequest	Yes	PurchaseInvoiceRequestIndonesia

Responses

Code	Description	Schema
200	OK	PurchaseInvoiceResponseIndonesia
201	Purchase invoice has been created successfully.	PurchaseInvoiceResponseIndonesia
400	Purchase invoice could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

PUT

Summary

Update purchase invoice attributes by code.

Description

API to update attributes of existing purchase invoice by code.

Parameters

Name	Located in	Description	Required	Schema
code	query	code	Yes	string
request	body	request	Yes	PurchaseInvoiceUpdateRequest

Responses

Code	Description
200	Purchase invoice attributes has been updated successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Purchase invoice with given code not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete purchase invoices by ids in bulk.

Description

API to delete purchase invoices in bulk.

Parameters

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

Responses

Code	Description	Schema
200	OK	BulkResponse
204	No Content
207	Request processed successfully.	BulkResponse
401	Unauthorized
403	Forbidden
404	Purchase invoices not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/id/bulk

POST

Summary

Create multiple sales invoice

Description

API to create sales invoice.

Parameters

Name	Located in	Description	Required	Schema
purchaseInvoiceRequests	body	purchaseInvoiceRequests	Yes	[ PurchaseInvoiceRequestIndonesia ]

Responses

Code	Description	Schema
200	OK	PurchaseInvoiceResponseIndonesia
201	Sales invoice has been created successfully.	PurchaseInvoiceResponseIndonesia
400	Sales invoice could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/id/code/{code}

GET

Summary

Get purchase invoice by code.

Description

API to fetch purchase invoice details by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase invoice information has been fetched successfully.	PurchaseInvoiceResponseIndonesia
401	Unauthorized
403	Forbidden
404	Purchase invoice not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/id/code/{code}/details

GET

Summary

Purchase invoice details by codes

Description

Purchase invoice details by codes

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	OK	PurchaseInvoiceInformation
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/id/due-amount

PUT

Summary

Update due amount for purchase invoices in bulk.

Description

API to update due amount for purchase invoices in bulk.

Parameters

Name	Located in	Description	Required	Schema
invoiceUpdateAmountDueDtoList	body	invoiceUpdateAmountDueDtoList	Yes	[ InvoiceUpdateAmountDueDto ]
revert	query	revert	Yes	boolean

Responses

Code	Description
200	Due amounts updated successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Purchase invoice not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/id/es/{contactCode}

GET

Summary

Get Invoice for contact.

Description

Get Invoice with contact code from ES.

Parameters

Name	Located in	Description	Required	Schema
contactCode	path	contactCode	Yes	string

Responses

Code	Description	Schema
200	Get Invoice successfully.	PurchaseInvoiceResponseIndonesia
401	Unauthorized
403	Forbidden
404	Invoice with given contact code not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/id/linked-order/{code}

GET

Summary

Get purchase invoices linked to an order by code.

Description

API to fetch purchase invoices linked to an order by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase invoices has been fetched successfully.	PurchaseInvoiceResponseIndonesia
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/id/report/count

POST

Summary

Get purchase invoice count for contacts

Description

API to fetch purchase invoice count for contacts

Parameters

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

Responses

Code	Description	Schema
200	Contact purchase invoice count has been fetched.	object
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/id/report/overview

GET

Summary

Purchase invoice overview report data.

Description

API to fetch purchase invoice overview report data

Parameters

Name	Located in	Description	Required	Schema
contactCode	query	contactCode	No	string
interval	query	interval	No	string

Responses

Code	Description	Schema
200	Purchase invoice overview report has been prepared.	InvoiceOverviewReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/id/report/unpaid

GET

Summary

Unpaid purchase invoices report.

Description

API to fetch unpaid purchase invoices

Responses

Code	Description	Schema
200	Unpaid purchase invoices report has been prepared.	DashboardReportData
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/id/{code}

GET

Summary

Get purchase invoice by code.

Description

API to fetch purchase invoice details by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase invoice information has been fetched successfully.	PurchaseInvoiceResponseIndonesia
401	Unauthorized
403	Forbidden
404	Purchase invoice not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/id/{id}

PUT

Summary

Update purchase invoice.

Description

API to update existing purchase invoice.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
purchaseInvoiceRequest	body	purchaseInvoiceRequest	Yes	PurchaseInvoiceRequestIndonesia

Responses

Code	Description	Schema
200	Purchase Invoice has been updated successfully.	PurchaseInvoiceResponseIndonesia
201	Created
400	Purchase invoice draft status cannot be changed after saving
401	Unauthorized
403	Forbidden
404	Purchase Invoice with given id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete purchase invoice by id.

Description

API to delete purchase invoice details by id.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description
200	OK
204	Purchase invoice has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Purchase invoice not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update purchase invoice memo or attachment

Description

API to update purchase invoice memo or attachment

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
purchaseInvoiceFields	body	purchaseInvoiceFields	Yes	object

Responses

Code	Description	Schema
200	Memo/attachment for purchase invoice updated successfully.	PurchaseInvoiceResponseIndonesia
204	No Content
401	Unauthorized
403	Forbidden
404	Purchase Invoice with id not found.

Security

Security Schema	Scopes
Authorization	global

---

purchase-invoice-controller-israel

Purchase Invoice APIs for Israel.

Invoice purchase/il

GET

Summary

Search purchase invoices.

Description

API to search purchase invoices.

Parameters

Name	Located in	Description	Required	Schema
customfield	query	customfield	No	string
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	Purchase invoices have been fetched successfully.	PurchaseInvoiceResponseIsrael
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create purchase invoice

Description

API to create purchase invoice.

Parameters

Name	Located in	Description	Required	Schema
purchaseInvoiceRequest	body	purchaseInvoiceRequest	Yes	PurchaseInvoiceRequestIsrael

Responses

Code	Description	Schema
200	OK	PurchaseInvoiceResponseIsrael
201	Purchase invoice has been created successfully.	PurchaseInvoiceResponseIsrael
400	Purchase invoice could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

PUT

Summary

Update purchase invoice attributes by code.

Description

API to update attributes of existing purchase invoice by code.

Parameters

Name	Located in	Description	Required	Schema
code	query	code	Yes	string
request	body	request	Yes	PurchaseInvoiceUpdateRequest

Responses

Code	Description
200	Purchase invoice attributes has been updated successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Purchase invoice with given code not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete purchase invoices by ids in bulk.

Description

API to delete purchase invoices in bulk.

Parameters

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

Responses

Code	Description	Schema
200	OK	BulkResponse
204	No Content
207	Request processed successfully.	BulkResponse
401	Unauthorized
403	Forbidden
404	Purchase invoices not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/il/bulk

POST

Summary

Create multiple sales invoice

Description

API to create sales invoice.

Parameters

Name	Located in	Description	Required	Schema
purchaseInvoiceRequests	body	purchaseInvoiceRequests	Yes	[ PurchaseInvoiceRequestIsrael ]

Responses

Code	Description	Schema
200	OK	PurchaseInvoiceResponseIsrael
201	Sales invoice has been created successfully.	PurchaseInvoiceResponseIsrael
400	Sales invoice could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/il/code/{code}/details

GET

Summary

Purchase invoice details by codes

Description

Purchase invoice details by codes

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	OK	PurchaseInvoiceInformation
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/il/due-amount

PUT

Summary

Update due amount for purchase invoices in bulk.

Description

API to update due amount for purchase invoices in bulk.

Parameters

Name	Located in	Description	Required	Schema
invoiceUpdateAmountDueDtoList	body	invoiceUpdateAmountDueDtoList	Yes	[ InvoiceUpdateAmountDueDto ]
revert	query	revert	Yes	boolean

Responses

Code	Description
200	Due amounts updated successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Purchase invoice not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/il/es/{contactCode}

GET

Summary

Get Invoice for contact.

Description

Get Invoice with contact code from ES.

Parameters

Name	Located in	Description	Required	Schema
contactCode	path	contactCode	Yes	string

Responses

Code	Description	Schema
200	Get Invoice successfully.	PurchaseInvoiceResponseIsrael
401	Unauthorized
403	Forbidden
404	Invoice with given contact code not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/il/linked-order/{code}

GET

Summary

Get purchase invoices linked to an order by code.

Description

API to fetch purchase invoices linked to an order by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase invoices has been fetched successfully.	PurchaseInvoiceResponseIsrael
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/il/report/count

POST

Summary

Get purchase invoice count for contacts

Description

API to fetch purchase invoice count for contacts

Parameters

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

Responses

Code	Description	Schema
200	Contact purchase invoice count has been fetched.	object
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/il/report/overview

GET

Summary

Purchase invoice overview report data.

Description

API to fetch purchase invoice overview report data

Parameters

Name	Located in	Description	Required	Schema
contactCode	query	contactCode	No	string
interval	query	interval	No	string

Responses

Code	Description	Schema
200	Purchase invoice overview report has been prepared.	InvoiceOverviewReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/il/report/unpaid

GET

Summary

Unpaid purchase invoices report.

Description

API to fetch unpaid purchase invoices

Responses

Code	Description	Schema
200	Unpaid purchase invoices report has been prepared.	DashboardReportData
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/il/{code}

GET

Summary

Get purchase invoice by code.

Description

API to fetch purchase invoice details by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase invoice information has been fetched successfully.	PurchaseInvoiceResponseIsrael
401	Unauthorized
403	Forbidden
404	Purchase invoice not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/il/{id}

PUT

Summary

Update purchase invoice.

Description

API to update existing purchase invoice.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
purchaseInvoiceRequest	body	purchaseInvoiceRequest	Yes	PurchaseInvoiceRequestIsrael

Responses

Code	Description	Schema
200	Purchase Invoice has been updated successfully.	PurchaseInvoiceResponseIsrael
201	Created
400	Purchase invoice draft status cannot be changed after saving
401	Unauthorized
403	Forbidden
404	Purchase Invoice with given id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete purchase invoice by id.

Description

API to delete purchase invoice details by id.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description
200	OK
204	Purchase invoice has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Purchase invoice not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update purchase invoice memo or attachment

Description

API to update purchase invoice memo or attachment

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
purchaseInvoiceFields	body	purchaseInvoiceFields	Yes	object

Responses

Code	Description	Schema
200	Memo/attachment for purchase invoice updated successfully.	PurchaseInvoiceResponseIsrael
204	No Content
401	Unauthorized
403	Forbidden
404	Purchase Invoice with id not found.

Security

Security Schema	Scopes
Authorization	global

---

purchase-invoice-controller-india

Purchase Invoice APIs for India

Invoice purchase/in

GET

Summary

Search purchase invoices.

Description

API to search purchase invoices.

Parameters

Name	Located in	Description	Required	Schema
customfield	query	customfield	No	string
fetchAttachmentDetails	query	fetchAttachmentDetails	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	Purchase invoices have been fetched successfully.	PurchaseInvoiceResponseIndia
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create purchase invoice

Description

API to create purchase invoice.

Parameters

Name	Located in	Description	Required	Schema
purchaseInvoiceRequest	body	purchaseInvoiceRequest	Yes	PurchaseInvoiceRequestIndia

Responses

Code	Description	Schema
200	OK	PurchaseInvoiceResponseIndia
201	Purchase invoice has been created successfully.	PurchaseInvoiceResponseIndia
400	Purchase invoice could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

PUT

Summary

Update purchase invoice attributes by code.

Description

API to update attributes of existing purchase invoice by code.

Parameters

Name	Located in	Description	Required	Schema
code	query	code	Yes	string
request	body	request	Yes	PurchaseInvoiceUpdateRequest

Responses

Code	Description
200	Purchase invoice attributes has been updated successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Purchase invoice with given code not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete purchase invoices by ids in bulk.

Description

API to delete purchase invoices in bulk.

Parameters

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

Responses

Code	Description	Schema
200	OK	BulkResponse
204	No Content
207	Request processed successfully.	BulkResponse
401	Unauthorized
403	Forbidden
404	Purchase invoices not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/in/bulk

POST

Summary

Create multiple sales invoice

Description

API to create sales invoice.

Parameters

Name	Located in	Description	Required	Schema
purchaseInvoiceRequests	body	purchaseInvoiceRequests	Yes	[ PurchaseInvoiceRequestIndia ]

Responses

Code	Description	Schema
200	OK	PurchaseInvoiceResponseIndia
201	Sales invoice has been created successfully.	PurchaseInvoiceResponseIndia
400	Sales invoice could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/in/code/{code}

GET

Summary

Get purchase invoice by code.

Description

API to fetch purchase invoice details by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase invoice information has been fetched successfully.	PurchaseInvoiceResponseIndia
401	Unauthorized
403	Forbidden
404	Purchase invoice not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/in/code/{code}/details

GET

Summary

Purchase invoice details by codes

Description

Purchase invoice details by codes

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	OK	PurchaseInvoiceInformation
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/in/due-amount

PUT

Summary

Update due amount for purchase invoices in bulk.

Description

API to update due amount for purchase invoices in bulk.

Parameters

Name	Located in	Description	Required	Schema
invoiceUpdateAmountDueDtoList	body	invoiceUpdateAmountDueDtoList	Yes	[ InvoiceUpdateAmountDueDto ]
revert	query	revert	Yes	boolean

Responses

Code	Description
200	Due amounts updated successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Purchase invoice not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/in/es/{contactCode}

GET

Summary

Get Invoice for contact.

Description

Get Invoice with contact code from ES.

Parameters

Name	Located in	Description	Required	Schema
contactCode	path	contactCode	Yes	string

Responses

Code	Description	Schema
200	Get Invoice successfully.	PurchaseInvoiceResponseIndia
401	Unauthorized
403	Forbidden
404	Invoice with given contact code not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/in/linked-order/{code}

GET

Summary

Get purchase invoices linked to an order by code.

Description

API to fetch purchase invoices linked to an order by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase invoices has been fetched successfully.	PurchaseInvoiceResponseIndia
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/in/report/count

POST

Summary

Get purchase invoice count for contacts

Description

API to fetch purchase invoice count for contacts

Parameters

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

Responses

Code	Description	Schema
200	Contact purchase invoice count has been fetched.	object
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/in/report/overview

GET

Summary

Purchase invoice overview report data.

Description

API to fetch purchase invoice overview report data

Parameters

Name	Located in	Description	Required	Schema
contactCode	query	contactCode	No	string
interval	query	interval	No	string

Responses

Code	Description	Schema
200	Purchase invoice overview report has been prepared.	InvoiceOverviewReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/in/report/unpaid

GET

Summary

Unpaid purchase invoices report.

Description

API to fetch unpaid purchase invoices

Responses

Code	Description	Schema
200	Unpaid purchase invoices report has been prepared.	DashboardReportData
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/in/tds/{id}

GET

Summary

Get purchase invoice amount by tds id.

Description

API to get get total purchase invoice amount by tds id.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	integer

Responses

Code	Description	Schema
200	Purchase invoice information has been fetched successfully.	number
401	Unauthorized
403	Forbidden
404	Purchase invoice not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/in/total

GET

Summary

Get Total Purchase invoices Amount

Description

API to fetch total purchase invoice amount

Responses

Code	Description	Schema
200	Get Total Purchase invoices Amount.	number
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/in/update-tds-processed-flag/{code}

PATCH

Summary

Update tds processed flag by code

Description

Api to update tds processed flag by code

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string
isTdsProcessed	body	isTdsProcessed	Yes	boolean

Responses

Code	Description
200	OK
204	No Content
401	Unauthorized
403	Forbidden

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/in/{code}

GET

Summary

Get purchase invoice by code.

Description

API to fetch purchase invoice details by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase invoice information has been fetched successfully.	PurchaseInvoiceResponseIndia
401	Unauthorized
403	Forbidden
404	Purchase invoice not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/in/{id}

PUT

Summary

Update purchase invoice.

Description

API to update existing purchase invoice.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
purchaseInvoiceRequest	body	purchaseInvoiceRequest	Yes	PurchaseInvoiceRequestIndia

Responses

Code	Description	Schema
200	Purchase Invoice has been updated successfully.	PurchaseInvoiceResponseIndia
201	Created
400	Purchase invoice draft status cannot be changed after saving
401	Unauthorized
403	Forbidden
404	Purchase Invoice with given id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete purchase invoice by id.

Description

API to delete purchase invoice details by id.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description
200	OK
204	Purchase invoice has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Purchase invoice not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update purchase invoice memo or attachment

Description

API to update purchase invoice memo or attachment

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
purchaseInvoiceFields	body	purchaseInvoiceFields	Yes	object

Responses

Code	Description	Schema
200	Memo/attachment for purchase invoice updated successfully.	PurchaseInvoiceResponseIndia
204	No Content
401	Unauthorized
403	Forbidden
404	Purchase Invoice with id not found.

Security

Security Schema	Scopes
Authorization	global

---

purchase-invoice-controller-malaysia

Purchase Invoice APIs for Malaysia

Invoice purchase/my

GET

Summary

Search purchase invoices.

Description

API to search purchase invoices.

Parameters

Name	Located in	Description	Required	Schema
customfield	query	customfield	No	string
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	Purchase invoices have been fetched successfully.	PurchaseInvoiceResponseMalaysia
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create purchase invoice

Description

API to create purchase invoice.

Parameters

Name	Located in	Description	Required	Schema
purchaseInvoiceRequest	body	purchaseInvoiceRequest	Yes	PurchaseInvoiceRequestMalaysia

Responses

Code	Description	Schema
200	OK	PurchaseInvoiceResponseMalaysia
201	Purchase invoice has been created successfully.	PurchaseInvoiceResponseMalaysia
400	Purchase invoice could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

PUT

Summary

Update purchase invoice attributes by code.

Description

API to update attributes of existing purchase invoice by code.

Parameters

Name	Located in	Description	Required	Schema
code	query	code	Yes	string
request	body	request	Yes	PurchaseInvoiceUpdateRequest

Responses

Code	Description
200	Purchase invoice attributes has been updated successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Purchase invoice with given code not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete purchase invoices by ids in bulk.

Description

API to delete purchase invoices in bulk.

Parameters

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

Responses

Code	Description	Schema
200	OK	BulkResponse
204	No Content
207	Request processed successfully.	BulkResponse
401	Unauthorized
403	Forbidden
404	Purchase invoices not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/my/bulk

POST

Summary

Create multiple sales invoice

Description

API to create sales invoice.

Parameters

Name	Located in	Description	Required	Schema
purchaseInvoiceRequests	body	purchaseInvoiceRequests	Yes	[ PurchaseInvoiceRequestMalaysia ]

Responses

Code	Description	Schema
200	OK	PurchaseInvoiceResponseMalaysia
201	Sales invoice has been created successfully.	PurchaseInvoiceResponseMalaysia
400	Sales invoice could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/my/code/{code}/details

GET

Summary

Purchase invoice details by codes

Description

Purchase invoice details by codes

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	OK	PurchaseInvoiceInformation
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/my/due-amount

PUT

Summary

Update due amount for purchase invoices in bulk.

Description

API to update due amount for purchase invoices in bulk.

Parameters

Name	Located in	Description	Required	Schema
invoiceUpdateAmountDueDtoList	body	invoiceUpdateAmountDueDtoList	Yes	[ InvoiceUpdateAmountDueDto ]
revert	query	revert	Yes	boolean

Responses

Code	Description
200	Due amounts updated successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Purchase invoice not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/my/es/{contactCode}

GET

Summary

Get Invoice for contact.

Description

Get Invoice with contact code from ES.

Parameters

Name	Located in	Description	Required	Schema
contactCode	path	contactCode	Yes	string

Responses

Code	Description	Schema
200	Get Invoice successfully.	PurchaseInvoiceResponseMalaysia
401	Unauthorized
403	Forbidden
404	Invoice with given contact code not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/my/linked-order/{code}

GET

Summary

Get purchase invoices linked to an order by code.

Description

API to fetch purchase invoices linked to an order by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase invoices has been fetched successfully.	PurchaseInvoiceResponseMalaysia
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/my/report/count

POST

Summary

Get purchase invoice count for contacts

Description

API to fetch purchase invoice count for contacts

Parameters

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

Responses

Code	Description	Schema
200	Contact purchase invoice count has been fetched.	object
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/my/report/overview

GET

Summary

Purchase invoice overview report data.

Description

API to fetch purchase invoice overview report data

Parameters

Name	Located in	Description	Required	Schema
contactCode	query	contactCode	No	string
interval	query	interval	No	string

Responses

Code	Description	Schema
200	Purchase invoice overview report has been prepared.	InvoiceOverviewReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/my/report/unpaid

GET

Summary

Unpaid purchase invoices report.

Description

API to fetch unpaid purchase invoices

Responses

Code	Description	Schema
200	Unpaid purchase invoices report has been prepared.	DashboardReportData
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/my/{code}

GET

Summary

Get purchase invoice by code.

Description

API to fetch purchase invoice details by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase invoice information has been fetched successfully.	PurchaseInvoiceResponseMalaysia
401	Unauthorized
403	Forbidden
404	Purchase invoice not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/my/{id}

PUT

Summary

Update purchase invoice.

Description

API to update existing purchase invoice.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
purchaseInvoiceRequest	body	purchaseInvoiceRequest	Yes	PurchaseInvoiceRequestMalaysia

Responses

Code	Description	Schema
200	Purchase Invoice has been updated successfully.	PurchaseInvoiceResponseMalaysia
201	Created
400	Purchase invoice draft status cannot be changed after saving
401	Unauthorized
403	Forbidden
404	Purchase Invoice with given id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete purchase invoice by id.

Description

API to delete purchase invoice details by id.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description
200	OK
204	Purchase invoice has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Purchase invoice not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update purchase invoice memo or attachment

Description

API to update purchase invoice memo or attachment

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
purchaseInvoiceFields	body	purchaseInvoiceFields	Yes	object

Responses

Code	Description	Schema
200	Memo/attachment for purchase invoice updated successfully.	PurchaseInvoiceResponseMalaysia
204	No Content
401	Unauthorized
403	Forbidden
404	Purchase Invoice with id not found.

Security

Security Schema	Scopes
Authorization	global

---

purchase-invoice-controller-netherlands

Purchase Invoice APIs for Netherlands

Invoice purchase/nl

GET

Summary

Search purchase invoices.

Description

API to search purchase invoices.

Parameters

Name	Located in	Description	Required	Schema
customfield	query	customfield	No	string
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	Purchase invoices have been fetched successfully.	PurchaseInvoiceResponseAustralia
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create purchase invoice

Description

API to create purchase invoice.

Parameters

Name	Located in	Description	Required	Schema
purchaseInvoiceRequest	body	purchaseInvoiceRequest	Yes	PurchaseInvoiceRequestAustralia

Responses

Code	Description	Schema
200	OK	PurchaseInvoiceResponseAustralia
201	Purchase invoice has been created successfully.	PurchaseInvoiceResponseAustralia
400	Purchase invoice could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

PUT

Summary

Update purchase invoice attributes by code.

Description

API to update attributes of existing purchase invoice by code.

Parameters

Name	Located in	Description	Required	Schema
code	query	code	Yes	string
request	body	request	Yes	PurchaseInvoiceUpdateRequest

Responses

Code	Description
200	Purchase invoice attributes has been updated successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Purchase invoice with given code not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete purchase invoices by ids in bulk.

Description

API to delete purchase invoices in bulk.

Parameters

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

Responses

Code	Description	Schema
200	OK	BulkResponse
204	No Content
207	Request processed successfully.	BulkResponse
401	Unauthorized
403	Forbidden
404	Purchase invoices not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/nl/bulk

POST

Summary

Create multiple sales invoice

Description

API to create sales invoice.

Parameters

Name	Located in	Description	Required	Schema
purchaseInvoiceRequests	body	purchaseInvoiceRequests	Yes	[ PurchaseInvoiceRequestAustralia ]

Responses

Code	Description	Schema
200	OK	PurchaseInvoiceResponseAustralia
201	Sales invoice has been created successfully.	PurchaseInvoiceResponseAustralia
400	Sales invoice could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/nl/code/{code}/details

GET

Summary

Purchase invoice details by codes

Description

Purchase invoice details by codes

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	OK	PurchaseInvoiceInformation
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/nl/due-amount

PUT

Summary

Update due amount for purchase invoices in bulk.

Description

API to update due amount for purchase invoices in bulk.

Parameters

Name	Located in	Description	Required	Schema
invoiceUpdateAmountDueDtoList	body	invoiceUpdateAmountDueDtoList	Yes	[ InvoiceUpdateAmountDueDto ]
revert	query	revert	Yes	boolean

Responses

Code	Description
200	Due amounts updated successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Purchase invoice not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/nl/es/{contactCode}

GET

Summary

Get Invoice for contact.

Description

Get Invoice with contact code from ES.

Parameters

Name	Located in	Description	Required	Schema
contactCode	path	contactCode	Yes	string

Responses

Code	Description	Schema
200	Get Invoice successfully.	PurchaseInvoiceResponseAustralia
401	Unauthorized
403	Forbidden
404	Invoice with given contact code not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/nl/linked-order/{code}

GET

Summary

Get purchase invoices linked to an order by code.

Description

API to fetch purchase invoices linked to an order by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase invoices has been fetched successfully.	PurchaseInvoiceResponseAustralia
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/nl/report/count

POST

Summary

Get purchase invoice count for contacts

Description

API to fetch purchase invoice count for contacts

Parameters

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

Responses

Code	Description	Schema
200	Contact purchase invoice count has been fetched.	object
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/nl/report/overview

GET

Summary

Purchase invoice overview report data.

Description

API to fetch purchase invoice overview report data

Parameters

Name	Located in	Description	Required	Schema
contactCode	query	contactCode	No	string
interval	query	interval	No	string

Responses

Code	Description	Schema
200	Purchase invoice overview report has been prepared.	InvoiceOverviewReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/nl/report/unpaid

GET

Summary

Unpaid purchase invoices report.

Description

API to fetch unpaid purchase invoices

Responses

Code	Description	Schema
200	Unpaid purchase invoices report has been prepared.	DashboardReportData
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/nl/{code}

GET

Summary

Get purchase invoice by code.

Description

API to fetch purchase invoice details by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase invoice information has been fetched successfully.	PurchaseInvoiceResponseAustralia
401	Unauthorized
403	Forbidden
404	Purchase invoice not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/nl/{id}

PUT

Summary

Update purchase invoice.

Description

API to update existing purchase invoice.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
purchaseInvoiceRequest	body	purchaseInvoiceRequest	Yes	PurchaseInvoiceRequestAustralia

Responses

Code	Description	Schema
200	Purchase Invoice has been updated successfully.	PurchaseInvoiceResponseAustralia
201	Created
400	Purchase invoice draft status cannot be changed after saving
401	Unauthorized
403	Forbidden
404	Purchase Invoice with given id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete purchase invoice by id.

Description

API to delete purchase invoice details by id.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description
200	OK
204	Purchase invoice has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Purchase invoice not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update purchase invoice memo or attachment

Description

API to update purchase invoice memo or attachment

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
purchaseInvoiceFields	body	purchaseInvoiceFields	Yes	object

Responses

Code	Description	Schema
200	Memo/attachment for purchase invoice updated successfully.	PurchaseInvoiceResponseAustralia
204	No Content
401	Unauthorized
403	Forbidden
404	Purchase Invoice with id not found.

Security

Security Schema	Scopes
Authorization	global

---

purchase-invoice-controller-nz

Purchase Invoice APIs for New Zealand

Invoice purchase/nz

GET

Summary

Search purchase invoices.

Description

API to search purchase invoices.

Parameters

Name	Located in	Description	Required	Schema
customfield	query	customfield	No	string
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	Purchase invoices have been fetched successfully.	PurchaseInvoiceResponseAustralia
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create purchase invoice

Description

API to create purchase invoice.

Parameters

Name	Located in	Description	Required	Schema
purchaseInvoiceRequest	body	purchaseInvoiceRequest	Yes	PurchaseInvoiceRequestAustralia

Responses

Code	Description	Schema
200	OK	PurchaseInvoiceResponseAustralia
201	Purchase invoice has been created successfully.	PurchaseInvoiceResponseAustralia
400	Purchase invoice could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

PUT

Summary

Update purchase invoice attributes by code.

Description

API to update attributes of existing purchase invoice by code.

Parameters

Name	Located in	Description	Required	Schema
code	query	code	Yes	string
request	body	request	Yes	PurchaseInvoiceUpdateRequest

Responses

Code	Description
200	Purchase invoice attributes has been updated successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Purchase invoice with given code not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete purchase invoices by ids in bulk.

Description

API to delete purchase invoices in bulk.

Parameters

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

Responses

Code	Description	Schema
200	OK	BulkResponse
204	No Content
207	Request processed successfully.	BulkResponse
401	Unauthorized
403	Forbidden
404	Purchase invoices not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/nz/bulk

POST

Summary

Create multiple sales invoice

Description

API to create sales invoice.

Parameters

Name	Located in	Description	Required	Schema
purchaseInvoiceRequests	body	purchaseInvoiceRequests	Yes	[ PurchaseInvoiceRequestAustralia ]

Responses

Code	Description	Schema
200	OK	PurchaseInvoiceResponseAustralia
201	Sales invoice has been created successfully.	PurchaseInvoiceResponseAustralia
400	Sales invoice could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/nz/code/{code}/details

GET

Summary

Purchase invoice details by codes

Description

Purchase invoice details by codes

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	OK	PurchaseInvoiceInformation
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/nz/due-amount

PUT

Summary

Update due amount for purchase invoices in bulk.

Description

API to update due amount for purchase invoices in bulk.

Parameters

Name	Located in	Description	Required	Schema
invoiceUpdateAmountDueDtoList	body	invoiceUpdateAmountDueDtoList	Yes	[ InvoiceUpdateAmountDueDto ]
revert	query	revert	Yes	boolean

Responses

Code	Description
200	Due amounts updated successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Purchase invoice not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/nz/es/{contactCode}

GET

Summary

Get Invoice for contact.

Description

Get Invoice with contact code from ES.

Parameters

Name	Located in	Description	Required	Schema
contactCode	path	contactCode	Yes	string

Responses

Code	Description	Schema
200	Get Invoice successfully.	PurchaseInvoiceResponseAustralia
401	Unauthorized
403	Forbidden
404	Invoice with given contact code not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/nz/linked-order/{code}

GET

Summary

Get purchase invoices linked to an order by code.

Description

API to fetch purchase invoices linked to an order by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase invoices has been fetched successfully.	PurchaseInvoiceResponseAustralia
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/nz/report/count

POST

Summary

Get purchase invoice count for contacts

Description

API to fetch purchase invoice count for contacts

Parameters

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

Responses

Code	Description	Schema
200	Contact purchase invoice count has been fetched.	object
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/nz/report/overview

GET

Summary

Purchase invoice overview report data.

Description

API to fetch purchase invoice overview report data

Parameters

Name	Located in	Description	Required	Schema
contactCode	query	contactCode	No	string
interval	query	interval	No	string

Responses

Code	Description	Schema
200	Purchase invoice overview report has been prepared.	InvoiceOverviewReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/nz/report/unpaid

GET

Summary

Unpaid purchase invoices report.

Description

API to fetch unpaid purchase invoices

Responses

Code	Description	Schema
200	Unpaid purchase invoices report has been prepared.	DashboardReportData
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/nz/{code}

GET

Summary

Get purchase invoice by code.

Description

API to fetch purchase invoice details by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase invoice information has been fetched successfully.	PurchaseInvoiceResponseAustralia
401	Unauthorized
403	Forbidden
404	Purchase invoice not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/nz/{id}

PUT

Summary

Update purchase invoice.

Description

API to update existing purchase invoice.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
purchaseInvoiceRequest	body	purchaseInvoiceRequest	Yes	PurchaseInvoiceRequestAustralia

Responses

Code	Description	Schema
200	Purchase Invoice has been updated successfully.	PurchaseInvoiceResponseAustralia
201	Created
400	Purchase invoice draft status cannot be changed after saving
401	Unauthorized
403	Forbidden
404	Purchase Invoice with given id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete purchase invoice by id.

Description

API to delete purchase invoice details by id.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description
200	OK
204	Purchase invoice has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Purchase invoice not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update purchase invoice memo or attachment

Description

API to update purchase invoice memo or attachment

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
purchaseInvoiceFields	body	purchaseInvoiceFields	Yes	object

Responses

Code	Description	Schema
200	Memo/attachment for purchase invoice updated successfully.	PurchaseInvoiceResponseAustralia
204	No Content
401	Unauthorized
403	Forbidden
404	Purchase Invoice with id not found.

Security

Security Schema	Scopes
Authorization	global

---

purchase-invoice-controller-philippines

Purchase Invoice APIs for Philippines

Invoice purchase/ph

GET

Summary

Search purchase invoices.

Description

API to search purchase invoices.

Parameters

Name	Located in	Description	Required	Schema
customfield	query	customfield	No	string
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	Purchase invoices have been fetched successfully.	PurchaseInvoiceResponsePhilippines
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create purchase invoice

Description

API to create purchase invoice.

Parameters

Name	Located in	Description	Required	Schema
purchaseInvoiceRequest	body	purchaseInvoiceRequest	Yes	PurchaseInvoiceRequestPhilippines

Responses

Code	Description	Schema
200	OK	PurchaseInvoiceResponsePhilippines
201	Purchase invoice has been created successfully.	PurchaseInvoiceResponsePhilippines
400	Purchase invoice could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

PUT

Summary

Update purchase invoice attributes by code.

Description

API to update attributes of existing purchase invoice by code.

Parameters

Name	Located in	Description	Required	Schema
code	query	code	Yes	string
request	body	request	Yes	PurchaseInvoiceUpdateRequest

Responses

Code	Description
200	Purchase invoice attributes has been updated successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Purchase invoice with given code not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete purchase invoices by ids in bulk.

Description

API to delete purchase invoices in bulk.

Parameters

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

Responses

Code	Description	Schema
200	OK	BulkResponse
204	No Content
207	Request processed successfully.	BulkResponse
401	Unauthorized
403	Forbidden
404	Purchase invoices not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/ph/bulk

POST

Summary

Create multiple sales invoice

Description

API to create sales invoice.

Parameters

Name	Located in	Description	Required	Schema
purchaseInvoiceRequests	body	purchaseInvoiceRequests	Yes	[ PurchaseInvoiceRequestPhilippines ]

Responses

Code	Description	Schema
200	OK	PurchaseInvoiceResponsePhilippines
201	Sales invoice has been created successfully.	PurchaseInvoiceResponsePhilippines
400	Sales invoice could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/ph/code/{code}/details

GET

Summary

Purchase invoice details by codes

Description

Purchase invoice details by codes

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	OK	PurchaseInvoiceInformation
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/ph/due-amount

PUT

Summary

Update due amount for purchase invoices in bulk.

Description

API to update due amount for purchase invoices in bulk.

Parameters

Name	Located in	Description	Required	Schema
invoiceUpdateAmountDueDtoList	body	invoiceUpdateAmountDueDtoList	Yes	[ InvoiceUpdateAmountDueDto ]
revert	query	revert	Yes	boolean

Responses

Code	Description
200	Due amounts updated successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Purchase invoice not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/ph/es/{contactCode}

GET

Summary

Get Invoice for contact.

Description

Get Invoice with contact code from ES.

Parameters

Name	Located in	Description	Required	Schema
contactCode	path	contactCode	Yes	string

Responses

Code	Description	Schema
200	Get Invoice successfully.	PurchaseInvoiceResponsePhilippines
401	Unauthorized
403	Forbidden
404	Invoice with given contact code not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/ph/linked-order/{code}

GET

Summary

Get purchase invoices linked to an order by code.

Description

API to fetch purchase invoices linked to an order by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase invoices has been fetched successfully.	PurchaseInvoiceResponsePhilippines
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/ph/report/count

POST

Summary

Get purchase invoice count for contacts

Description

API to fetch purchase invoice count for contacts

Parameters

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

Responses

Code	Description	Schema
200	Contact purchase invoice count has been fetched.	object
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/ph/report/overview

GET

Summary

Purchase invoice overview report data.

Description

API to fetch purchase invoice overview report data

Parameters

Name	Located in	Description	Required	Schema
contactCode	query	contactCode	No	string
interval	query	interval	No	string

Responses

Code	Description	Schema
200	Purchase invoice overview report has been prepared.	InvoiceOverviewReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/ph/report/unpaid

GET

Summary

Unpaid purchase invoices report.

Description

API to fetch unpaid purchase invoices

Responses

Code	Description	Schema
200	Unpaid purchase invoices report has been prepared.	DashboardReportData
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/ph/{code}

GET

Summary

Get purchase invoice by code.

Description

API to fetch purchase invoice details by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase invoice information has been fetched successfully.	PurchaseInvoiceResponsePhilippines
401	Unauthorized
403	Forbidden
404	Purchase invoice not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/ph/{id}

PUT

Summary

Update purchase invoice.

Description

API to update existing purchase invoice.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
purchaseInvoiceRequest	body	purchaseInvoiceRequest	Yes	PurchaseInvoiceRequestPhilippines

Responses

Code	Description	Schema
200	Purchase Invoice has been updated successfully.	PurchaseInvoiceResponsePhilippines
201	Created
400	Purchase invoice draft status cannot be changed after saving
401	Unauthorized
403	Forbidden
404	Purchase Invoice with given id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete purchase invoice by id.

Description

API to delete purchase invoice details by id.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description
200	OK
204	Purchase invoice has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Purchase invoice not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update purchase invoice memo or attachment

Description

API to update purchase invoice memo or attachment

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
purchaseInvoiceFields	body	purchaseInvoiceFields	Yes	object

Responses

Code	Description	Schema
200	Memo/attachment for purchase invoice updated successfully.	PurchaseInvoiceResponsePhilippines
204	No Content
401	Unauthorized
403	Forbidden
404	Purchase Invoice with id not found.

Security

Security Schema	Scopes
Authorization	global

---

purchase-invoice-controller-sa

Purchase Invoice APIs for Saudi Arab

Invoice purchase/sa

GET

Summary

Search purchase invoices.

Description

API to search purchase invoices.

Parameters

Name	Located in	Description	Required	Schema
customfield	query	customfield	No	string
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	Purchase invoices have been fetched successfully.	PurchaseInvoiceResponseSA
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create purchase invoice

Description

API to create purchase invoice.

Parameters

Name	Located in	Description	Required	Schema
purchaseInvoiceRequest	body	purchaseInvoiceRequest	Yes	PurchaseInvoiceRequestSA

Responses

Code	Description	Schema
200	OK	PurchaseInvoiceResponseSA
201	Purchase invoice has been created successfully.	PurchaseInvoiceResponseSA
400	Purchase invoice could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

PUT

Summary

Update purchase invoice attributes by code.

Description

API to update attributes of existing purchase invoice by code.

Parameters

Name	Located in	Description	Required	Schema
code	query	code	Yes	string
request	body	request	Yes	PurchaseInvoiceUpdateRequest

Responses

Code	Description
200	Purchase invoice attributes has been updated successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Purchase invoice with given code not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete purchase invoices by ids in bulk.

Description

API to delete purchase invoices in bulk.

Parameters

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

Responses

Code	Description	Schema
200	OK	BulkResponse
204	No Content
207	Request processed successfully.	BulkResponse
401	Unauthorized
403	Forbidden
404	Purchase invoices not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/sa/bills-for-adjustment-je

GET

Summary

Get list of purchase invoices for Custom / RCM adjustment journal entries

Description

Api to fetch list of purchase invoices for Custom / RCM adjustment journal entries

Parameters

Name	Located in	Description	Required	Schema
adjustmentType	query	adjustmentType	Yes	string
endDate	query	endDate	Yes	string
limit	query	limit	No	integer
page	query	page	No	integer
search	query	search	No	string
startDate	query	startDate	Yes	string

Responses

Code	Description	Schema
200	Purchase invoices have been fetched successfully	JournalBillDetailsSA
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/sa/bills-summary-for-adjustment-je

GET

Summary

Get purchase invoices summary for Custom / RCM adjustment journal entries

Description

Api to fetch purchase invoices summary for Custom / RCM adjustment journal entries

Parameters

Name	Located in	Description	Required	Schema
adjustmentType	query	adjustmentType	Yes	string
endDate	query	endDate	Yes	string
startDate	query	startDate	Yes	string

Responses

Code	Description	Schema
200	Purchase invoices summary have been fetched successfully	JournalAdjustmentBillsSummarySA
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/sa/bulk

POST

Summary

Create multiple sales invoice

Description

API to create sales invoice.

Parameters

Name	Located in	Description	Required	Schema
purchaseInvoiceRequests	body	purchaseInvoiceRequests	Yes	[ PurchaseInvoiceRequestSA ]

Responses

Code	Description	Schema
200	OK	PurchaseInvoiceResponseSA
201	Sales invoice has been created successfully.	PurchaseInvoiceResponseSA
400	Sales invoice could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/sa/code/{code}/details

GET

Summary

Purchase invoice details by codes

Description

Purchase invoice details by codes

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	OK	PurchaseInvoiceInformation
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/sa/due-amount

PUT

Summary

Update due amount for purchase invoices in bulk.

Description

API to update due amount for purchase invoices in bulk.

Parameters

Name	Located in	Description	Required	Schema
invoiceUpdateAmountDueDtoList	body	invoiceUpdateAmountDueDtoList	Yes	[ InvoiceUpdateAmountDueDto ]
revert	query	revert	Yes	boolean

Responses

Code	Description
200	Due amounts updated successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Purchase invoice not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/sa/es/{contactCode}

GET

Summary

Get Invoice for contact.

Description

Get Invoice with contact code from ES.

Parameters

Name	Located in	Description	Required	Schema
contactCode	path	contactCode	Yes	string

Responses

Code	Description	Schema
200	Get Invoice successfully.	PurchaseInvoiceResponseSA
401	Unauthorized
403	Forbidden
404	Invoice with given contact code not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/sa/linked-order/{code}

GET

Summary

Get purchase invoices linked to an order by code.

Description

API to fetch purchase invoices linked to an order by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase invoices has been fetched successfully.	PurchaseInvoiceResponseSA
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/sa/report/count

POST

Summary

Get purchase invoice count for contacts

Description

API to fetch purchase invoice count for contacts

Parameters

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

Responses

Code	Description	Schema
200	Contact purchase invoice count has been fetched.	object
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/sa/report/overview

GET

Summary

Purchase invoice overview report data.

Description

API to fetch purchase invoice overview report data

Parameters

Name	Located in	Description	Required	Schema
contactCode	query	contactCode	No	string
interval	query	interval	No	string

Responses

Code	Description	Schema
200	Purchase invoice overview report has been prepared.	InvoiceOverviewReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/sa/report/unpaid

GET

Summary

Unpaid purchase invoices report.

Description

API to fetch unpaid purchase invoices

Responses

Code	Description	Schema
200	Unpaid purchase invoices report has been prepared.	DashboardReportData
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/sa/update-adjustment-je-flag/{code}

PATCH

Summary

Update adjustment je flag by code for Saudi Arabia

Description

Api to update adjustment je flag by code for Saudi Arabia

Parameters

Name	Located in	Description	Required	Schema
adjustmentJEFlag	body	adjustmentJEFlag	Yes	boolean
code	path	code	Yes	string

Responses

Code	Description
200	OK
204	No Content
401	Unauthorized
403	Forbidden

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/sa/{code}

GET

Summary

Get purchase invoice by code.

Description

API to fetch purchase invoice details by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase invoice information has been fetched successfully.	PurchaseInvoiceResponseSA
401	Unauthorized
403	Forbidden
404	Purchase invoice not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/sa/{id}

PUT

Summary

Update purchase invoice.

Description

API to update existing purchase invoice.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
purchaseInvoiceRequest	body	purchaseInvoiceRequest	Yes	PurchaseInvoiceRequestSA

Responses

Code	Description	Schema
200	Purchase Invoice has been updated successfully.	PurchaseInvoiceResponseSA
201	Created
400	Purchase invoice draft status cannot be changed after saving
401	Unauthorized
403	Forbidden
404	Purchase Invoice with given id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete purchase invoice by id.

Description

API to delete purchase invoice details by id.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description
200	OK
204	Purchase invoice has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Purchase invoice not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update purchase invoice memo or attachment

Description

API to update purchase invoice memo or attachment

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
purchaseInvoiceFields	body	purchaseInvoiceFields	Yes	object

Responses

Code	Description	Schema
200	Memo/attachment for purchase invoice updated successfully.	PurchaseInvoiceResponseSA
204	No Content
401	Unauthorized
403	Forbidden
404	Purchase Invoice with id not found.

Security

Security Schema	Scopes
Authorization	global

---

purchase-invoice-controller-uk

Purchase Invoice APIs for UK.

Invoice purchase/uk

GET

Summary

Search purchase invoices.

Description

API to search purchase invoices.

Parameters

Name	Located in	Description	Required	Schema
customfield	query	customfield	No	string
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	Purchase invoices have been fetched successfully.	PurchaseInvoiceResponseUk
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create purchase invoice

Description

API to create purchase invoice.

Parameters

Name	Located in	Description	Required	Schema
purchaseInvoiceRequest	body	purchaseInvoiceRequest	Yes	PurchaseInvoiceRequestUk

Responses

Code	Description	Schema
200	OK	PurchaseInvoiceResponseUk
201	Purchase invoice has been created successfully.	PurchaseInvoiceResponseUk
400	Purchase invoice could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

PUT

Summary

Update purchase invoice attributes by code.

Description

API to update attributes of existing purchase invoice by code.

Parameters

Name	Located in	Description	Required	Schema
code	query	code	Yes	string
request	body	request	Yes	PurchaseInvoiceUpdateRequest

Responses

Code	Description
200	Purchase invoice attributes has been updated successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Purchase invoice with given code not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete purchase invoices by ids in bulk.

Description

API to delete purchase invoices in bulk.

Parameters

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

Responses

Code	Description	Schema
200	OK	BulkResponse
204	No Content
207	Request processed successfully.	BulkResponse
401	Unauthorized
403	Forbidden
404	Purchase invoices not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/uk/bulk

POST

Summary

Create multiple sales invoice

Description

API to create sales invoice.

Parameters

Name	Located in	Description	Required	Schema
purchaseInvoiceRequests	body	purchaseInvoiceRequests	Yes	[ PurchaseInvoiceRequestUk ]

Responses

Code	Description	Schema
200	OK	PurchaseInvoiceResponseUk
201	Sales invoice has been created successfully.	PurchaseInvoiceResponseUk
400	Sales invoice could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/uk/code/{code}/details

GET

Summary

Purchase invoice details by codes

Description

Purchase invoice details by codes

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	OK	PurchaseInvoiceInformation
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/uk/due-amount

PUT

Summary

Update due amount for purchase invoices in bulk.

Description

API to update due amount for purchase invoices in bulk.

Parameters

Name	Located in	Description	Required	Schema
invoiceUpdateAmountDueDtoList	body	invoiceUpdateAmountDueDtoList	Yes	[ InvoiceUpdateAmountDueDto ]
revert	query	revert	Yes	boolean

Responses

Code	Description
200	Due amounts updated successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Purchase invoice not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/uk/es/{contactCode}

GET

Summary

Get Invoice for contact.

Description

Get Invoice with contact code from ES.

Parameters

Name	Located in	Description	Required	Schema
contactCode	path	contactCode	Yes	string

Responses

Code	Description	Schema
200	Get Invoice successfully.	PurchaseInvoiceResponseUk
401	Unauthorized
403	Forbidden
404	Invoice with given contact code not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/uk/linked-order/{code}

GET

Summary

Get purchase invoices linked to an order by code.

Description

API to fetch purchase invoices linked to an order by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase invoices has been fetched successfully.	PurchaseInvoiceResponseUk
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/uk/report/count

POST

Summary

Get purchase invoice count for contacts

Description

API to fetch purchase invoice count for contacts

Parameters

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

Responses

Code	Description	Schema
200	Contact purchase invoice count has been fetched.	object
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/uk/report/overview

GET

Summary

Purchase invoice overview report data.

Description

API to fetch purchase invoice overview report data

Parameters

Name	Located in	Description	Required	Schema
contactCode	query	contactCode	No	string
interval	query	interval	No	string

Responses

Code	Description	Schema
200	Purchase invoice overview report has been prepared.	InvoiceOverviewReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/uk/report/unpaid

GET

Summary

Unpaid purchase invoices report.

Description

API to fetch unpaid purchase invoices

Responses

Code	Description	Schema
200	Unpaid purchase invoices report has been prepared.	DashboardReportData
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/uk/{code}

GET

Summary

Get purchase invoice by code.

Description

API to fetch purchase invoice details by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Purchase invoice information has been fetched successfully.	PurchaseInvoiceResponseUk
401	Unauthorized
403	Forbidden
404	Purchase invoice not found.

Security

Security Schema	Scopes
Authorization	global

Invoice purchase/uk/{id}

PUT

Summary

Update purchase invoice.

Description

API to update existing purchase invoice.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
purchaseInvoiceRequest	body	purchaseInvoiceRequest	Yes	PurchaseInvoiceRequestUk

Responses

Code	Description	Schema
200	Purchase Invoice has been updated successfully.	PurchaseInvoiceResponseUk
201	Created
400	Purchase invoice draft status cannot be changed after saving
401	Unauthorized
403	Forbidden
404	Purchase Invoice with given id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete purchase invoice by id.

Description

API to delete purchase invoice details by id.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description
200	OK
204	Purchase invoice has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Purchase invoice not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update purchase invoice memo or attachment

Description

API to update purchase invoice memo or attachment

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
purchaseInvoiceFields	body	purchaseInvoiceFields	Yes	object

Responses

Code	Description	Schema
200	Memo/attachment for purchase invoice updated successfully.	PurchaseInvoiceResponseUk
204	No Content
401	Unauthorized
403	Forbidden
404	Purchase Invoice with id not found.

Security

Security Schema	Scopes
Authorization	global

---

data-correction-controller

Purchase Invoice APIs

Invoice purchasecorrection/update

POST

Summary

updateTaxAmount

Responses

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

Security

Security Schema	Scopes
Authorization	global

Invoice purchasecorrection/updateinvoicestatus

POST

Summary

updateInvoicePaymentStatusToReceived

Parameters

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

Responses

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

Security

Security Schema	Scopes
Authorization	global

Invoice purchasecorrection/updatemissingjepurchase

POST

Summary

updateMissingJEPurchase

Responses

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

Security

Security Schema	Scopes
Authorization	global

Invoice purchasecorrection/updatemissingjesales

POST

Summary

updateMissingJESales

Responses

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

Security

Security Schema	Scopes
Authorization	global

---

invoice-reminder-controller

Invoice Reminder APIs

Invoice reminder/configuration

GET

Summary

Get reminder configurations by code

Description

Api to fetch reminder configurations by it's code

Responses

Code	Description	Schema
200	Reminder configurations have been fetched successfully.	ReminderConfigurationDto
401	Unauthorized
403	Forbidden
404	Reminder configurations not found.

Security

Security Schema	Scopes
Authorization	global

PUT

Summary

Update Invoice Reminder Configuration

Description

Api to Update Invoice Reminder Configuration

Parameters

Name	Located in	Description	Required	Schema
reminderConfigurationRequestDto	body	reminderConfigurationRequestDto	Yes	[ ReminderConfigurationRequestDto ]

Responses

Code	Description	Schema
200	Reminder configuration have been updated successfully.	ReminderConfigurationResponseDto
201	Created
401	Unauthorized
403	Forbidden
404	Reminder configuration update is unsuccessful

Security

Security Schema	Scopes
Authorization	global

Invoice reminder/contact

GET

Summary

Get Disabled Contact

Description

Api to Get Disabled Contact

Parameters

Name	Located in	Description	Required	Schema
contactCode	query	contactCode	Yes	string

Responses

Code	Description	Schema
200	Disabled Contact fetched successfully.	ReminderDisabledContactDto
401	Unauthorized
403	Forbidden
404	Failed to fetch Disabled Contact

Security

Security Schema	Scopes
Authorization	global

PUT

Summary

Update Disabled Contact

Description

Api to Update Update Disabled Contact

Parameters

Name	Located in	Description	Required	Schema
reminderDisabledContactRequestDto	body	reminderDisabledContactRequestDto	Yes	ReminderDisabledContactRequestDto

Responses

Code	Description
200	Disabled Contact have been updated successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Disabled Contact update is unsuccessful

Security

Security Schema	Scopes
Authorization	global

Invoice reminder/settings

GET

Summary

Get reminder settings by code

Description

Api to fetch reminder settings by it's code

Responses

Code	Description	Schema
200	Reminder settings have been fetched successfully.	ReminderSettingsDto
401	Unauthorized
403	Forbidden
404	Reminder settings not found.

Security

Security Schema	Scopes
Authorization	global

PUT

Summary

Update reminder settings.

Description

API to update existing reminder settings.

Parameters

Name	Located in	Description	Required	Schema
reminderSettingsRequest	body	reminderSettingsRequest	Yes	ReminderSettingsRequest

Responses

Code	Description	Schema
200	Sales Invoice has been updated successfully.	ReminderSettingsResponse
201	Created
401	Unauthorized
403	Forbidden
404	Sales Invoice with given id not found.

Security

Security Schema	Scopes
Authorization	global

---

sales-invoice-controller

Sales Invoice APIs

Invoice sales/approval-status

POST

Summary

Update approval status

Description

API to update approval status

Parameters

Name	Located in	Description	Required	Schema
approvalStatusRequestDtoList	body	approvalStatusRequestDtoList	Yes	[ ApprovalStatusRequestDto ]

Responses

Code	Description
200	Approval status for Sales documents have been updated successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/bulk

POST

Summary

Create multiple sales invoice

Description

API to create sales invoice.

Parameters

Name	Located in	Description	Required	Schema
salesInvoiceRequests	body	salesInvoiceRequests	Yes	[ SalesInvoiceRequest ]

Responses

Code	Description	Schema
200	OK	SalesInvoiceResponse
201	Sales invoice has been created successfully.	SalesInvoiceResponse
400	Sales invoice could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

PUT

Summary

Batch update sales invoice attributes by codes.

Description

API to batch update attributes of existing sales invoice by codes.

Parameters

Name	Located in	Description	Required	Schema
salesInvoiceUpdateRequests	body	salesInvoiceUpdateRequests	Yes	[ SalesInvoiceUpdateRequest ]

Responses

Code	Description
200	Sales invoice attributes has been updated successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Sales invoice with given code not found.

Security

Security Schema	Scopes
Authorization	global

---

Bulk Delete Invoices

DELETE

Invoice sales/bulk-delete

Summary

Bulk Delete sales invoices.

Description

API to Bulk Delete sales invoices.

Parameters

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

Responses

Code	Description	Schema
200	OK	SalesInvoiceBulkDeleteResponseDto
204	Sales invoice has been deleted successfully.	SalesInvoiceBulkDeleteResponseDto
401	Unauthorized
403	Forbidden
404	Sales invoice not found.

Security

Security Schema	Scopes
Authorization	global

---

Invoice sales/bulk-details

POST

Summary

Sales invoice details by codes

Description

Sales invoice details by codes

Parameters

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

Responses

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

Security

Security Schema	Scopes
Authorization	global

Invoice sales/bulk-details-by-seq

POST

Summary

Sales invoice details by sequence codes

Description

Sales invoice details by sequence codes

Parameters

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

Responses

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

Security

Security Schema	Scopes
Authorization	global

Invoice sales/bulk-update

PATCH

Summary

Update sales invoices memo or attachment

Description

API to Update sales invoices memo or attachment

Parameters

Name	Located in	Description	Required	Schema
salesInvoiceFields	body	salesInvoiceFields	Yes	[ Map«string,string» ]

Responses

Code	Description	Schema
200	OK	BulkApiResponse
204	No Content
207	Memo/attachment for sales invoice updated successfully.	BulkApiResponse
401	Unauthorized
403	Forbidden
404	Sales Invoice with given id not found.

Security

Security Schema	Scopes
Authorization	global

Invoice sales/bulk/codes

POST

Summary

Get multiple sales invoices

Description

API to get sales invoices.

Parameters

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

Responses

Code	Description	Schema
200	Sales documents have been fetched successfully.	SalesInvoiceResponse
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/by-contact-ids

POST

Summary

Search sales invoices.

Description

API to search sales invoices.

Parameters

Name	Located in	Description	Required	Schema
contactIds	body	contactIds	Yes	[ long ]
customfield	query	customfield	No	string
fetchAttachmentDetails	query	fetchAttachmentDetails	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	Sales invoices have been fetched successfully.	SalesInvoiceResponse
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/calculateLoanAmount

GET

Summary

Get Kredx Loan Amount.

Description

API to fetch Loan Amount by wrt to payment term.

Parameters

Name	Located in	Description	Required	Schema
paymentTerm	query	paymentTerm	Yes	string

Responses

Code	Description	Schema
200	Sales invoice information has been fetched successfully.	SalesInvoiceResponse
401	Unauthorized
403	Forbidden
404	Sales invoice not found.

Security

Security Schema	Scopes
Authorization	global

Invoice sales/code/{code}

GET

Summary

Get sales invoice by code.

Description

API to fetch sales invoice details by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Sales invoice information has been fetched successfully.	SalesInvoiceResponse
401	Unauthorized
403	Forbidden
404	Sales invoice not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update sales invoice memo or attachment

Description

API to update sales invoice memo or attachment

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string
salesInvoiceFields	body	salesInvoiceFields	Yes	object

Responses

Code	Description	Schema
200	Memo/attachment for sales invoice updated successfully.	SalesInvoiceResponse
204	No Content
401	Unauthorized
403	Forbidden
404	Sales Invoice with id not found.

Security

Security Schema	Scopes
Authorization	global

---

Get Invoice details By Code

GET

Invoice sales/code/{code}/details

Summary

Sales invoice details by codes

Description

Sales invoice details by codes

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	OK	SalesInvoiceInformation
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

---

Invoice sales/codes

POST

Summary

Get Invoice information by codes.

Description

API to get invoice document information by codes.

Parameters

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

Responses

Code	Description	Schema
200	Invoice documents have been fetched successfully.	[ SalesDocument ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

---

Get Invoice Amount Due

POST

Invoice sales/contact-invoice-amountdue

Summary

Get sales invoices amount due by contact code.

Description

API to fetch sales invoices amount due by contact code.

Parameters

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

Responses

Code	Description	Schema
200	Sales invoices amount due has been fetched successfully.	SalesInvoiceResponse
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

---

Invoice sales/contrainvoice

POST

Summary

Invoice contra adjustment.

Description

API to contra adjustment for invoice of contact.

Parameters

Name	Located in	Description	Required	Schema
contraInvoiceDto	body	contraInvoiceDto	Yes	ContraInvoiceDto

Responses

Code	Description	Schema
200	OK	ContraInvoiceDto
201	Contra adjustment for invoice has been done successfully.	ContraInvoiceDto
400	Contra adjustment for invoice has been failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Invoice contra adjustment.

Description

API to contra adjustment for invoice of contact.

Parameters

Name	Located in	Description	Required	Schema
contraCode	query	contraCode	Yes	string
purchaseInvoiceCode	query	purchaseInvoiceCode	Yes	string

Responses

Code	Description	Schema
200	OK	ContraInvoiceDto
201	Contra adjustment for bill has been done successfully.	ContraInvoiceDto
204	No Content
400	Contra adjustment for bill has been failed because of insufficient data.
401	Unauthorized
403	Forbidden

Security

Security Schema	Scopes
Authorization	global

Invoice sales/create-recurring

POST

Summary

Create a recurring invoice

Description

API to create a recurring invoice.

Parameters

Name	Located in	Description	Required	Schema
event	body	event	Yes	RecurringJobEvent

Responses

Code	Description	Schema
200	OK	SalesInvoiceResponse
201	Recurring invoice created successfully	SalesInvoiceResponse
400	Error while creating recurring invoice
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/delete-duplicate-payment

POST

Summary

Delete duplicate payments of invoices

Parameters

Name	Located in	Description	Required	Schema
invoiceCodes	query	invoiceCodes	No	[ string ]

Responses

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

Security

Security Schema	Scopes
Authorization	global

Invoice sales/delete-knockoff

POST

Summary

Delete given payment details from knockoff_info of given invoice

Parameters

Name	Located in	Description	Required	Schema
request	body	request	Yes	[ DuplicatePaymentDto ]

Responses

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

Security

Security Schema	Scopes
Authorization	global

Invoice sales/draft/trigger

POST

Summary

Create approval status trigger

Description

API to reate approval status trigger

Parameters

Name	Located in	Description	Required	Schema
triggerKafkaRequestDto	body	triggerKafkaRequestDto	Yes	TriggerKafkaRequestDto

Responses

Code	Description
200	Trigger created for approval status
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/dropshipupdateinvoice

PUT

Summary

Batch update sales invoice attributes by codes.

Description

API to batch update attributes of existing sales invoice by codes.

Parameters

Name	Located in	Description	Required	Schema
salesInvoiceUpdateRequests	body	salesInvoiceUpdateRequests	Yes	[ SalesInvoiceUpdateRequest ]

Responses

Code	Description
200	Sales invoice attributes has been updated successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Sales invoice with given code not found.

Security

Security Schema	Scopes
Authorization	global

Invoice sales/due-amount

PUT

Summary

Update due amount for sales invoices in bulk.

Description

API to update due amount for sales invoices in bulk.

Parameters

Name	Located in	Description	Required	Schema
invoiceUpdateAmountDueDtoList	body	invoiceUpdateAmountDueDtoList	Yes	[ InvoiceUpdateAmountDueDto ]
revert	query	revert	Yes	boolean

Responses

Code	Description
200	Due amounts updated successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Sales invoice not found.

Security

Security Schema	Scopes
Authorization	global

Invoice sales/due-amount-bulk-payment-delete

PUT

Summary

Update due amount for sales invoices in bulk delete.

Description

API to update due amount for sales invoices in bulk delete.

Parameters

Name	Located in	Description	Required	Schema
invoiceUpdateAmountDueDtoList	body	invoiceUpdateAmountDueDtoList	Yes	[ InvoiceUpdateAmountDueDto ]

Responses

Code	Description
200	Due amounts updated successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Sales invoice not found.

Security

Security Schema	Scopes
Authorization	global

---

Delete Fulfillment by Fulfillment code

DELETE

Invoice sales/fulfillments

Summary

Delete Fulfillment by Fulfillment code

Description

API to delete Fulfillment by code.

Parameters

Name	Located in	Description	Required	Schema
fulfillmentCode	query	fulfillmentCode	Yes	string
isBulkDelete	query	isBulkDelete	No	boolean
salesInvoiceCode	query	salesInvoiceCode	Yes	string

Responses

Code	Description
200	OK
204	Fulfillment has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Fulfillment has been deleted successfully.

Security

Security Schema	Scopes
Authorization	global

---

Invoice sales/import

POST

Summary

Create multiple sales invoice via import

Description

API to create sales invoice via import.

Parameters

Name	Located in	Description	Required	Schema
salesInvoiceRequests	body	salesInvoiceRequests	Yes	[ SalesInvoiceRequest ]

Responses

Code	Description	Schema
200	OK	BulkApiResponse
201	Sales invoice has been created successfully.	BulkApiResponse
400	Sales invoice could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/invoiceitemsstatus

POST

Summary

Get sales invoice items fulfillment status

Description

API to fetch sales invoice items fulfillment status

Parameters

Name	Located in	Description	Required	Schema
salesInvoiceItemToFulfilledMap	body	salesInvoiceItemToFulfilledMap	Yes	object

Responses

Code	Description	Schema
200	invoice items fulfillment status.	object
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/journal

POST

Summary

Recreate Sales Invoices Journal Entries for all tenants

Description

API to recreate Journal Entries for all Sales Invoices.

Responses

Code	Description
200	Journal Entries for all Sales Invoices recreated successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/linked-docs/product-codes

POST

Summary

Get products by code

Description

API to Get products by code.

Parameters

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

Responses

Code	Description	Schema
200	Product information has been fetched successfully.	string
201	Created
401	Unauthorized
403	Forbidden
404	Products not found.

Security

Security Schema	Scopes
Authorization	global

Invoice sales/linked-invoices-by-multi-code

POST

Summary

Get sales invoices linked to a quotations by code.

Description

API to fetch sales invoices linked to a quotations by it's code.

Parameters

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

Responses

Code	Description	Schema
200	Sales invoices has been fetched successfully.	object
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/linked-invoices/{code}

GET

Summary

Get sales invoices linked to a quotation by code.

Description

API to fetch sales invoices linked to a quotation by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Sales invoices has been fetched successfully.	SalesInvoiceResponse
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/linked-order/{code}

GET

Summary

Get sales invoices linked to an order by code.

Description

API to fetch sales invoices linked to an order by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Sales invoices has been fetched successfully.	SalesInvoiceResponse
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/linked-quotation/{code}

GET

Summary

Get sales invoices linked to a quotation by code.

Description

API to fetch sales invoices linked to a quotation by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Sales invoices has been fetched successfully.	SalesInvoiceResponse
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/linked-salesorder/{code}

GET

Summary

Get sales invoices linked to a sales order by code.

Description

API to fetch sales invoices linked to a sales order by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Sales invoices has been fetched successfully.	SalesInvoiceResponse
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/memo

PUT

Summary

Update memo in invoice.

Description

API to update memo in invoice.

Parameters

Name	Located in	Description	Required	Schema
memoUpdateDto	body	memoUpdateDto	Yes	MemoUpdateDto

Responses

Code	Description	Schema
200	Sales invoices memo updated successfully.	SalesInvoiceResponse
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/notes

DELETE

Summary

Delete sales invoice by id.

Description

API to delete sales invoice details by id.

Parameters

Name	Located in	Description	Required	Schema
code	query	code	Yes	string
invoicecode	query	invoicecode	Yes	string
uid	query	uid	Yes	string (uuid)

Responses

Code	Description
200	OK
204	Sales invoice has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Sales invoice not found.

Security

Security Schema	Scopes
Authorization	global

Invoice sales/partial_invoice

PUT

Summary

Update Partial Invoice Fulfillment status.

Description

API to Update Partial Invoice Fulfillment status.

Parameters

Name	Located in	Description	Required	Schema
partialInvoiceFulfillmentStatusUpdate	body	partialInvoiceFulfillmentStatusUpdate	Yes	PartialInvoiceFulfillmentStatusUpdate

Responses

Code	Description
200	Partial Invoice Fulfillment status updated successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Partial Invoice Fulfillment status updated failure.

Security

Security Schema	Scopes
Authorization	global

Invoice sales/productCode/{productCode}

GET

Summary

Check if a sales invoice exists for a given product

Description

Api to check if a sales invoice exists for a given product

Parameters

Name	Located in	Description	Required	Schema
productCode	path	productCode	Yes	string

Responses

Code	Description	Schema
200	Sales invoice information has been fetched successfully.	boolean
401	Unauthorized
403	Forbidden
404	Sales invoice not found.

Security

Security Schema	Scopes
Authorization	global

Invoice sales/receive

DELETE

Summary

Delete sales invoice by id.

Description

API to delete sales invoice details by id.

Parameters

Name	Located in	Description	Required	Schema
paymentCode	query	paymentCode	Yes	string
salesInvoiceCode	query	salesInvoiceCode	Yes	string
uid	query	uid	No	string (uuid)

Responses

Code	Description
200	OK
204	Sales invoice has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Sales invoice not found.

Security

Security Schema	Scopes
Authorization	global

Invoice sales/record-filter

POST

Summary

Create approval status trigger

Description

API to reate approval status trigger

Parameters

Name	Located in	Description	Required	Schema
filterRecord	body	filterRecord	Yes	FilterRecord

Responses

Code	Description	Schema
200	Trigger created for approval status	boolean
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/report/count

POST

Summary

Get sales invoice count for contacts

Description

API to fetch sales invoice count for contacts

Parameters

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

Responses

Code	Description	Schema
200	Contact sales invoice count has been fetched.	object
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/report/overview

GET

Summary

Sales invoice overview report data.

Description

API to fetch sales invoice overview report data

Parameters

Name	Located in	Description	Required	Schema
contactCode	query	contactCode	No	string
interval	query	interval	No	string

Responses

Code	Description	Schema
200	Sales invoice overview report has been prepared.	InvoiceOverviewReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/report/top-customers

GET

Summary

Fetch top customers

Description

API to fetch top customers.

Parameters

Name	Located in	Description	Required	Schema
measure	query	measure	No	string
tenure	query	tenure	No	string

Responses

Code	Description	Schema
200	Top customers have been determined.	CustomerReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/report/top-products

GET

Summary

Fetch top products

Description

API to fetch top products.

Parameters

Name	Located in	Description	Required	Schema
measure	query	measure	No	string
tenure	query	tenure	No	string

Responses

Code	Description	Schema
200	Top products have been determined.	ProductReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/report/unpaid

GET

Summary

Unpaid sales invoices report.

Description

API to fetch unpaid sales invoices

Responses

Code	Description	Schema
200	Unpaid sales invoices report has been prepared.	DashboardReportData
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/salesinvoicereserved

PUT

Summary

Batch update sales invoice attributes by codes.

Description

API to batch update attributes of existing sales invoice by codes.

Parameters

Name	Located in	Description	Required	Schema
reservedQuantityData	body	reservedQuantityData	Yes	[ PPSReservedQuantityData ]

Responses

Code	Description
200	Sales invoice attributes has been updated successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Sales invoice with given code not found.

Security

Security Schema	Scopes
Authorization	global

Invoice sales/set-recurring

POST

Summary

Set an invoice to recurring

Description

API to set and invoice to recurring.

Parameters

Name	Located in	Description	Required	Schema
setRecurringDto	body	setRecurringDto	Yes	SetRecurringDto

Responses

Code	Description	Schema
200	Invoice set to recur successfully	SalesInvoiceResponse
201	Created
400	Error while setting invoice to recur
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/shopify

POST

Summary

Create sales invoice

Description

API to create sales invoice.

Parameters

Name	Located in	Description	Required	Schema
shopifyOrder	body	shopifyOrder	Yes	ShopifyOrder

Responses

Code	Description	Schema
200	OK	SalesInvoiceResponse
201	Sales invoice has been created successfully.	SalesInvoiceResponse
400	Sales invoice could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/tax/count

POST

Summary

Get sales invoice items count for tax

Description

API to fetch sales invoice items count for tax

Parameters

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

Responses

Code	Description	Schema
200	Tax sales invoice count has been fetched.	object
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/unfulfillment-seq-codes

GET

Summary

Get Unfulfilled sales invoices codes

Description

Get Unfulfilled sales invoices codes

Responses

Code	Description	Schema
200	Sales invoice information has been fetched successfully.	[ object ]
401	Unauthorized
403	Forbidden
404	Sales invoice not found.

Security

Security Schema	Scopes
Authorization	global

Invoice sales/unpaid-seq-codes

GET

Summary

Get unpaid sales invoices document sequence codes.

Description

API to unpaid sales invoices document sequence codes.

Responses

Code	Description	Schema
200	Sales invoice information has been fetched successfully.	[ object ]
401	Unauthorized
403	Forbidden
404	Sales invoice not found.

Security

Security Schema	Scopes
Authorization	global

Invoice sales/unreserve-invoices

POST

Summary

Api to Unreserve quantity in invoices only

Description

Api to Unreserve quantity in invoices only

Parameters

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

Responses

Code	Description
200	Api to Unreserve quantity in invoices only
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/update-knock-off

POST

Summary

Update knock off information

Description

Api to update knock off information

Parameters

Name	Located in	Description	Required	Schema
knockOffInfos	body	knockOffInfos	Yes	object

Responses

Code	Description
200	Knock off information updated successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/update/linkedBackOrder

POST

Summary

Update linked documents for SI backorder

Description

API to update linked documents for SI backorder

Parameters

Name	Located in	Description	Required	Schema
backOrderUpdateRequest	body	backOrderUpdateRequest	Yes	BackOrderUpdateRequest

Responses

Code	Description
200	Linked document for backorder has been successfully updated.
201	Created
400	Linked document for backorder update failed.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/zapier

POST

Summary

Create sales invoice

Description

API to create sales invoice.

Parameters

Name	Located in	Description	Required	Schema
salesInvoiceRequest	body	salesInvoiceRequest	Yes	SalesInvoiceRequest

Responses

Code	Description	Schema
200	OK	SalesInvoiceResponse
201	Sales invoice has been created successfully.	SalesInvoiceResponse
400	Sales invoice could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/{code}

GET

Summary

Get sales invoice by code.

Description

API to fetch sales invoice details by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Sales invoice information has been fetched successfully.	SalesInvoiceResponse
401	Unauthorized
403	Forbidden
404	Sales invoice not found.

Security

Security Schema	Scopes
Authorization	global

Invoice sales/{id}

PUT

Summary

Update sales invoice.

Description

API to update existing sales invoice.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
salesInvoiceRequest	body	salesInvoiceRequest	Yes	SalesInvoiceRequest

Responses

Code	Description	Schema
200	Sales Invoice has been updated successfully.	SalesInvoiceResponse
201	Created
400	Sales invoice draft status cannot be changed after saving
401	Unauthorized
403	Forbidden
404	Sales Invoice with given id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete sales invoice by id.

Description

API to delete sales invoice details by id.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description
200	OK
204	Sales invoice has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Sales invoice not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update sales invoice memo or attachment

Description

API to update sales invoice memo or attachment

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
salesInvoiceFields	body	salesInvoiceFields	Yes	object

Responses

Code	Description	Schema
200	Memo/attachment for sales invoice updated successfully.	SalesInvoiceResponse
204	No Content
401	Unauthorized
403	Forbidden
404	Sales Invoice with id not found.

Security

Security Schema	Scopes
Authorization	global

---

sales-invoice-controller-uae

Sales Invoice UAE APIs

Invoice sales/ae

GET

Summary

Search sales invoices.

Description

API to search sales invoices.

Parameters

Name	Located in	Description	Required	Schema
customfield	query	customfield	No	string
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	Sales invoices have been fetched successfully.	SalesInvoiceResponseUae
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create sales invoice

Description

API to create sales invoice.

Parameters

Name	Located in	Description	Required	Schema
salesInvoiceRequest	body	salesInvoiceRequest	Yes	SalesInvoiceRequestUae

Responses

Code	Description	Schema
200	OK	SalesInvoiceResponseUae
201	Sales invoice has been created successfully.	SalesInvoiceResponseUae
400	Sales invoice could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

PUT

Summary

Update sales invoice attributes by code.

Description

API to update attributes of existing sales invoice by code.

Parameters

Name	Located in	Description	Required	Schema
code	query	code	Yes	string
request	body	request	Yes	SalesInvoiceUpdateRequest

Responses

Code	Description
200	Sales invoice attributes has been updated successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Sales invoice with given code not found.

Security

Security Schema	Scopes
Authorization	global

Invoice sales/ae/bulk

POST

Summary

Create multiple sales invoice

Description

API to create sales invoice.

Parameters

Name	Located in	Description	Required	Schema
salesInvoiceRequests	body	salesInvoiceRequests	Yes	[ SalesInvoiceRequestUae ]

Responses

Code	Description	Schema
200	OK	SalesInvoiceResponseUae
201	Sales invoice has been created successfully.	SalesInvoiceResponseUae
400	Sales invoice could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/ae/bulk-update

PATCH

Summary

Update sales invoices memo or attachment

Description

API to Update sales invoices memo or attachment

Parameters

Name	Located in	Description	Required	Schema
salesInvoiceFields	body	salesInvoiceFields	Yes	[ Map«string,string» ]

Responses

Code	Description	Schema
200	OK	BulkApiResponse
204	No Content
207	Memo/attachment for sales invoice updated successfully.	BulkApiResponse
401	Unauthorized
403	Forbidden
404	Sales Invoice with given id not found.

Security

Security Schema	Scopes
Authorization	global

Invoice sales/ae/code/{code}/details

GET

Summary

Sales invoice details by codes

Description

Sales invoice details by codes

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	OK	SalesInvoiceInformation
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/ae/due-amount

PUT

Summary

Update due amount for sales invoices in bulk.

Description

API to update due amount for sales invoices in bulk.

Parameters

Name	Located in	Description	Required	Schema
invoiceUpdateAmountDueDtoList	body	invoiceUpdateAmountDueDtoList	Yes	[ InvoiceUpdateAmountDueDto ]
revert	query	revert	Yes	boolean

Responses

Code	Description
200	Due amounts updated successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Sales invoice not found.

Security

Security Schema	Scopes
Authorization	global

Invoice sales/ae/import

POST

Summary

Create multiple sales invoice via import

Description

API to create sales invoice via import.

Parameters

Name	Located in	Description	Required	Schema
salesInvoiceRequests	body	salesInvoiceRequests	Yes	[ SalesInvoiceRequestUae ]

Responses

Code	Description	Schema
200	OK	BulkApiResponse
201	Sales invoice has been created successfully.	BulkApiResponse
400	Sales invoice could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/ae/linked-order/{code}

GET

Summary

Get sales invoices linked to an order by code.

Description

API to fetch sales invoices linked to an order by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Sales invoices has been fetched successfully.	SalesInvoiceResponseUae
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/ae/linked-quotation/{code}

GET

Summary

Get sales invoices linked to a quotation by code.

Description

API to fetch sales invoices linked to a quotation by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Sales invoices has been fetched successfully.	SalesInvoiceResponseUae
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/ae/report/count

POST

Summary

Get sales invoice count for contacts

Description

API to fetch sales invoice count for contacts

Parameters

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

Responses

Code	Description	Schema
200	Contact sales invoice count has been fetched.	object
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/ae/report/overview

GET

Summary

Sales invoice overview report data.

Description

API to fetch sales invoice overview report data

Parameters

Name	Located in	Description	Required	Schema
contactCode	query	contactCode	No	string
interval	query	interval	No	string

Responses

Code	Description	Schema
200	Sales invoice overview report has been prepared.	InvoiceOverviewReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/ae/report/top-customers

GET

Summary

Fetch top customers

Description

API to fetch top customers.

Parameters

Name	Located in	Description	Required	Schema
measure	query	measure	No	string
tenure	query	tenure	No	string

Responses

Code	Description	Schema
200	Top customers have been determined.	CustomerReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/ae/report/top-products

GET

Summary

Fetch top products

Description

API to fetch top products.

Parameters

Name	Located in	Description	Required	Schema
measure	query	measure	No	string
tenure	query	tenure	No	string

Responses

Code	Description	Schema
200	Top products have been determined.	ProductReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/ae/report/unpaid

GET

Summary

Unpaid sales invoices report.

Description

API to fetch unpaid sales invoices

Responses

Code	Description	Schema
200	Unpaid sales invoices report has been prepared.	DashboardReportData
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/ae/{code}

GET

Summary

Get sales invoice by code.

Description

API to fetch sales invoice details by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Sales invoice information has been fetched successfully.	SalesInvoiceResponseUae
401	Unauthorized
403	Forbidden
404	Sales invoice not found.

Security

Security Schema	Scopes
Authorization	global

Invoice sales/ae/{id}

PUT

Summary

Update sales invoice.

Description

API to update existing sales invoice.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
salesInvoiceRequest	body	salesInvoiceRequest	Yes	SalesInvoiceRequestUae

Responses

Code	Description	Schema
200	Sales Invoice has been updated successfully.	SalesInvoiceResponseUae
201	Created
400	Sales invoice draft status cannot be changed after saving
401	Unauthorized
403	Forbidden
404	Sales Invoice with given id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete sales invoice by id.

Description

API to delete sales invoice details by id.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description
200	OK
204	Sales invoice has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Sales invoice not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update sales invoice memo or attachment

Description

API to update sales invoice memo or attachment

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
salesInvoiceFields	body	salesInvoiceFields	Yes	object

Responses

Code	Description	Schema
200	Memo/attachment for sales invoice updated successfully.	SalesInvoiceResponseUae
204	No Content
401	Unauthorized
403	Forbidden
404	Sales Invoice with id not found.

Security

Security Schema	Scopes
Authorization	global

---

sales-invoice-controller-australia

Sales Invoice Australia APIs

Invoice sales/au

GET

Summary

Search sales invoices.

Description

API to search sales invoices.

Parameters

Name	Located in	Description	Required	Schema
customfield	query	customfield	No	string
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	Sales invoices have been fetched successfully.	SalesInvoiceResponseAustralia
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create sales invoice

Description

API to create sales invoice.

Parameters

Name	Located in	Description	Required	Schema
salesInvoiceRequest	body	salesInvoiceRequest	Yes	SalesInvoiceRequestAustralia

Responses

Code	Description	Schema
200	OK	SalesInvoiceResponseAustralia
201	Sales invoice has been created successfully.	SalesInvoiceResponseAustralia
400	Sales invoice could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

PUT

Summary

Update sales invoice attributes by code.

Description

API to update attributes of existing sales invoice by code.

Parameters

Name	Located in	Description	Required	Schema
code	query	code	Yes	string
request	body	request	Yes	SalesInvoiceUpdateRequest

Responses

Code	Description
200	Sales invoice attributes has been updated successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Sales invoice with given code not found.

Security

Security Schema	Scopes
Authorization	global

Invoice sales/au/bulk

POST

Summary

Create multiple sales invoice

Description

API to create sales invoice.

Parameters

Name	Located in	Description	Required	Schema
salesInvoiceRequests	body	salesInvoiceRequests	Yes	[ SalesInvoiceRequestAustralia ]

Responses

Code	Description	Schema
200	OK	SalesInvoiceResponseAustralia
201	Sales invoice has been created successfully.	SalesInvoiceResponseAustralia
400	Sales invoice could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/au/bulk-update

PATCH

Summary

Update sales invoices memo or attachment

Description

API to Update sales invoices memo or attachment

Parameters

Name	Located in	Description	Required	Schema
salesInvoiceFields	body	salesInvoiceFields	Yes	[ Map«string,string» ]

Responses

Code	Description	Schema
200	OK	BulkApiResponse
204	No Content
207	Memo/attachment for sales invoice updated successfully.	BulkApiResponse
401	Unauthorized
403	Forbidden
404	Sales Invoice with given id not found.

Security

Security Schema	Scopes
Authorization	global

Invoice sales/au/code/{code}/details

GET

Summary

Sales invoice details by codes

Description

Sales invoice details by codes

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	OK	SalesInvoiceInformation
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/au/due-amount

PUT

Summary

Update due amount for sales invoices in bulk.

Description

API to update due amount for sales invoices in bulk.

Parameters

Name	Located in	Description	Required	Schema
invoiceUpdateAmountDueDtoList	body	invoiceUpdateAmountDueDtoList	Yes	[ InvoiceUpdateAmountDueDto ]
revert	query	revert	Yes	boolean

Responses

Code	Description
200	Due amounts updated successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Sales invoice not found.

Security

Security Schema	Scopes
Authorization	global

Invoice sales/au/import

POST

Summary

Create multiple sales invoice via import

Description

API to create sales invoice via import.

Parameters

Name	Located in	Description	Required	Schema
salesInvoiceRequests	body	salesInvoiceRequests	Yes	[ SalesInvoiceRequestAustralia ]

Responses

Code	Description	Schema
200	OK	BulkApiResponse
201	Sales invoice has been created successfully.	BulkApiResponse
400	Sales invoice could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/au/linked-order/{code}

GET

Summary

Get sales invoices linked to an order by code.

Description

API to fetch sales invoices linked to an order by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Sales invoices has been fetched successfully.	SalesInvoiceResponseAustralia
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/au/linked-quotation/{code}

GET

Summary

Get sales invoices linked to a quotation by code.

Description

API to fetch sales invoices linked to a quotation by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Sales invoices has been fetched successfully.	SalesInvoiceResponseAustralia
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/au/report/count

POST

Summary

Get sales invoice count for contacts

Description

API to fetch sales invoice count for contacts

Parameters

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

Responses

Code	Description	Schema
200	Contact sales invoice count has been fetched.	object
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/au/report/overview

GET

Summary

Sales invoice overview report data.

Description

API to fetch sales invoice overview report data

Parameters

Name	Located in	Description	Required	Schema
contactCode	query	contactCode	No	string
interval	query	interval	No	string

Responses

Code	Description	Schema
200	Sales invoice overview report has been prepared.	InvoiceOverviewReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/au/report/top-customers

GET

Summary

Fetch top customers

Description

API to fetch top customers.

Parameters

Name	Located in	Description	Required	Schema
measure	query	measure	No	string
tenure	query	tenure	No	string

Responses

Code	Description	Schema
200	Top customers have been determined.	CustomerReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/au/report/top-products

GET

Summary

Fetch top products

Description

API to fetch top products.

Parameters

Name	Located in	Description	Required	Schema
measure	query	measure	No	string
tenure	query	tenure	No	string

Responses

Code	Description	Schema
200	Top products have been determined.	ProductReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/au/report/unpaid

GET

Summary

Unpaid sales invoices report.

Description

API to fetch unpaid sales invoices

Responses

Code	Description	Schema
200	Unpaid sales invoices report has been prepared.	DashboardReportData
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/au/{code}

GET

Summary

Get sales invoice by code.

Description

API to fetch sales invoice details by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Sales invoice information has been fetched successfully.	SalesInvoiceResponseAustralia
401	Unauthorized
403	Forbidden
404	Sales invoice not found.

Security

Security Schema	Scopes
Authorization	global

Invoice sales/au/{id}

PUT

Summary

Update sales invoice.

Description

API to update existing sales invoice.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
salesInvoiceRequest	body	salesInvoiceRequest	Yes	SalesInvoiceRequestAustralia

Responses

Code	Description	Schema
200	Sales Invoice has been updated successfully.	SalesInvoiceResponseAustralia
201	Created
400	Sales invoice draft status cannot be changed after saving
401	Unauthorized
403	Forbidden
404	Sales Invoice with given id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete sales invoice by id.

Description

API to delete sales invoice details by id.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description
200	OK
204	Sales invoice has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Sales invoice not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update sales invoice memo or attachment

Description

API to update sales invoice memo or attachment

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
salesInvoiceFields	body	salesInvoiceFields	Yes	object

Responses

Code	Description	Schema
200	Memo/attachment for sales invoice updated successfully.	SalesInvoiceResponseAustralia
204	No Content
401	Unauthorized
403	Forbidden
404	Sales Invoice with id not found.

Security

Security Schema	Scopes
Authorization	global

---

sales-invoice-controller-belgium

Sales Invoice APIs for Belgium

Invoice sales/be

GET

Summary

Search sales invoices.

Description

API to search sales invoices.

Parameters

Name	Located in	Description	Required	Schema
customfield	query	customfield	No	string
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	Sales invoices have been fetched successfully.	SalesInvoiceResponseAustralia
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create sales invoice

Description

API to create sales invoice.

Parameters

Name	Located in	Description	Required	Schema
salesInvoiceRequest	body	salesInvoiceRequest	Yes	SalesInvoiceRequestAustralia

Responses

Code	Description	Schema
200	OK	SalesInvoiceResponseAustralia
201	Sales invoice has been created successfully.	SalesInvoiceResponseAustralia
400	Sales invoice could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

PUT

Summary

Update sales invoice attributes by code.

Description

API to update attributes of existing sales invoice by code.

Parameters

Name	Located in	Description	Required	Schema
code	query	code	Yes	string
request	body	request	Yes	SalesInvoiceUpdateRequest

Responses

Code	Description
200	Sales invoice attributes has been updated successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Sales invoice with given code not found.

Security

Security Schema	Scopes
Authorization	global

Invoice sales/be/bulk

POST

Summary

Create multiple sales invoice

Description

API to create sales invoice.

Parameters

Name	Located in	Description	Required	Schema
salesInvoiceRequests	body	salesInvoiceRequests	Yes	[ SalesInvoiceRequestAustralia ]

Responses

Code	Description	Schema
200	OK	SalesInvoiceResponseAustralia
201	Sales invoice has been created successfully.	SalesInvoiceResponseAustralia
400	Sales invoice could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/be/bulk-update

PATCH

Summary

Update sales invoices memo or attachment

Description

API to Update sales invoices memo or attachment

Parameters

Name	Located in	Description	Required	Schema
salesInvoiceFields	body	salesInvoiceFields	Yes	[ Map«string,string» ]

Responses

Code	Description	Schema
200	OK	BulkApiResponse
204	No Content
207	Memo/attachment for sales invoice updated successfully.	BulkApiResponse
401	Unauthorized
403	Forbidden
404	Sales Invoice with given id not found.

Security

Security Schema	Scopes
Authorization	global

Invoice sales/be/code/{code}/details

GET

Summary

Sales invoice details by codes

Description

Sales invoice details by codes

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	OK	SalesInvoiceInformation
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/be/due-amount

PUT

Summary

Update due amount for sales invoices in bulk.

Description

API to update due amount for sales invoices in bulk.

Parameters

Name	Located in	Description	Required	Schema
invoiceUpdateAmountDueDtoList	body	invoiceUpdateAmountDueDtoList	Yes	[ InvoiceUpdateAmountDueDto ]
revert	query	revert	Yes	boolean

Responses

Code	Description
200	Due amounts updated successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Sales invoice not found.

Security

Security Schema	Scopes
Authorization	global

Invoice sales/be/import

POST

Summary

Create multiple sales invoice via import

Description

API to create sales invoice via import.

Parameters

Name	Located in	Description	Required	Schema
salesInvoiceRequests	body	salesInvoiceRequests	Yes	[ SalesInvoiceRequestAustralia ]

Responses

Code	Description	Schema
200	OK	BulkApiResponse
201	Sales invoice has been created successfully.	BulkApiResponse
400	Sales invoice could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/be/linked-order/{code}

GET

Summary

Get sales invoices linked to an order by code.

Description

API to fetch sales invoices linked to an order by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Sales invoices has been fetched successfully.	SalesInvoiceResponseAustralia
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/be/linked-quotation/{code}

GET

Summary

Get sales invoices linked to a quotation by code.

Description

API to fetch sales invoices linked to a quotation by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Sales invoices has been fetched successfully.	SalesInvoiceResponseAustralia
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/be/report/count

POST

Summary

Get sales invoice count for contacts

Description

API to fetch sales invoice count for contacts

Parameters

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

Responses

Code	Description	Schema
200	Contact sales invoice count has been fetched.	object
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/be/report/overview

GET

Summary

Sales invoice overview report data.

Description

API to fetch sales invoice overview report data

Parameters

Name	Located in	Description	Required	Schema
contactCode	query	contactCode	No	string
interval	query	interval	No	string

Responses

Code	Description	Schema
200	Sales invoice overview report has been prepared.	InvoiceOverviewReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/be/report/top-customers

GET

Summary

Fetch top customers

Description

API to fetch top customers.

Parameters

Name	Located in	Description	Required	Schema
measure	query	measure	No	string
tenure	query	tenure	No	string

Responses

Code	Description	Schema
200	Top customers have been determined.	CustomerReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/be/report/top-products

GET

Summary

Fetch top products

Description

API to fetch top products.

Parameters

Name	Located in	Description	Required	Schema
measure	query	measure	No	string
tenure	query	tenure	No	string

Responses

Code	Description	Schema
200	Top products have been determined.	ProductReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/be/report/unpaid

GET

Summary

Unpaid sales invoices report.

Description

API to fetch unpaid sales invoices

Responses

Code	Description	Schema
200	Unpaid sales invoices report has been prepared.	DashboardReportData
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/be/{code}

GET

Summary

Get sales invoice by code.

Description

API to fetch sales invoice details by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Sales invoice information has been fetched successfully.	SalesInvoiceResponseAustralia
401	Unauthorized
403	Forbidden
404	Sales invoice not found.

Security

Security Schema	Scopes
Authorization	global

Invoice sales/be/{id}

PUT

Summary

Update sales invoice.

Description

API to update existing sales invoice.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
salesInvoiceRequest	body	salesInvoiceRequest	Yes	SalesInvoiceRequestAustralia

Responses

Code	Description	Schema
200	Sales Invoice has been updated successfully.	SalesInvoiceResponseAustralia
201	Created
400	Sales invoice draft status cannot be changed after saving
401	Unauthorized
403	Forbidden
404	Sales Invoice with given id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete sales invoice by id.

Description

API to delete sales invoice details by id.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description
200	OK
204	Sales invoice has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Sales invoice not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update sales invoice memo or attachment

Description

API to update sales invoice memo or attachment

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
salesInvoiceFields	body	salesInvoiceFields	Yes	object

Responses

Code	Description	Schema
200	Memo/attachment for sales invoice updated successfully.	SalesInvoiceResponseAustralia
204	No Content
401	Unauthorized
403	Forbidden
404	Sales Invoice with id not found.

Security

Security Schema	Scopes
Authorization	global

---

sales-invoice-controller-canada

Sales Invoice Canada APIs

Invoice sales/ca

GET

Summary

Search sales invoices.

Description

API to search sales invoices.

Parameters

Name	Located in	Description	Required	Schema
customfield	query	customfield	No	string
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	Sales invoices have been fetched successfully.	SalesInvoiceResponseCanada
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create sales invoice

Description

API to create sales invoice.

Parameters

Name	Located in	Description	Required	Schema
salesInvoiceRequest	body	salesInvoiceRequest	Yes	SalesInvoiceRequestCanada

Responses

Code	Description	Schema
200	OK	SalesInvoiceResponseCanada
201	Sales invoice has been created successfully.	SalesInvoiceResponseCanada
400	Sales invoice could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

PUT

Summary

Update sales invoice attributes by code.

Description

API to update attributes of existing sales invoice by code.

Parameters

Name	Located in	Description	Required	Schema
code	query	code	Yes	string
request	body	request	Yes	SalesInvoiceUpdateRequest

Responses

Code	Description
200	Sales invoice attributes has been updated successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Sales invoice with given code not found.

Security

Security Schema	Scopes
Authorization	global

Invoice sales/ca/bulk

POST

Summary

Create multiple sales invoice

Description

API to create sales invoice.

Parameters

Name	Located in	Description	Required	Schema
salesInvoiceRequests	body	salesInvoiceRequests	Yes	[ SalesInvoiceRequestCanada ]

Responses

Code	Description	Schema
200	OK	SalesInvoiceResponseCanada
201	Sales invoice has been created successfully.	SalesInvoiceResponseCanada
400	Sales invoice could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/ca/bulk-update

PATCH

Summary

Update sales invoices memo or attachment

Description

API to Update sales invoices memo or attachment

Parameters

Name	Located in	Description	Required	Schema
salesInvoiceFields	body	salesInvoiceFields	Yes	[ Map«string,string» ]

Responses

Code	Description	Schema
200	OK	BulkApiResponse
204	No Content
207	Memo/attachment for sales invoice updated successfully.	BulkApiResponse
401	Unauthorized
403	Forbidden
404	Sales Invoice with given id not found.

Security

Security Schema	Scopes
Authorization	global

Invoice sales/ca/code/{code}/details

GET

Summary

Sales invoice details by codes

Description

Sales invoice details by codes

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	OK	SalesInvoiceInformation
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/ca/due-amount

PUT

Summary

Update due amount for sales invoices in bulk.

Description

API to update due amount for sales invoices in bulk.

Parameters

Name	Located in	Description	Required	Schema
invoiceUpdateAmountDueDtoList	body	invoiceUpdateAmountDueDtoList	Yes	[ InvoiceUpdateAmountDueDto ]
revert	query	revert	Yes	boolean

Responses

Code	Description
200	Due amounts updated successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Sales invoice not found.

Security

Security Schema	Scopes
Authorization	global

Invoice sales/ca/import

POST

Summary

Create multiple sales invoice via import

Description

API to create sales invoice via import.

Parameters

Name	Located in	Description	Required	Schema
salesInvoiceRequests	body	salesInvoiceRequests	Yes	[ SalesInvoiceRequestCanada ]

Responses

Code	Description	Schema
200	OK	BulkApiResponse
201	Sales invoice has been created successfully.	BulkApiResponse
400	Sales invoice could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/ca/linked-order/{code}

GET

Summary

Get sales invoices linked to an order by code.

Description

API to fetch sales invoices linked to an order by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Sales invoices has been fetched successfully.	SalesInvoiceResponseCanada
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/ca/linked-quotation/{code}

GET

Summary

Get sales invoices linked to a quotation by code.

Description

API to fetch sales invoices linked to a quotation by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Sales invoices has been fetched successfully.	SalesInvoiceResponseCanada
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/ca/report/count

POST

Summary

Get sales invoice count for contacts

Description

API to fetch sales invoice count for contacts

Parameters

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

Responses

Code	Description	Schema
200	Contact sales invoice count has been fetched.	object
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/ca/report/overview

GET

Summary

Sales invoice overview report data.

Description

API to fetch sales invoice overview report data

Parameters

Name	Located in	Description	Required	Schema
contactCode	query	contactCode	No	string
interval	query	interval	No	string

Responses

Code	Description	Schema
200	Sales invoice overview report has been prepared.	InvoiceOverviewReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/ca/report/top-customers

GET

Summary

Fetch top customers

Description

API to fetch top customers.

Parameters

Name	Located in	Description	Required	Schema
measure	query	measure	No	string
tenure	query	tenure	No	string

Responses

Code	Description	Schema
200	Top customers have been determined.	CustomerReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/ca/report/top-products

GET

Summary

Fetch top products

Description

API to fetch top products.

Parameters

Name	Located in	Description	Required	Schema
measure	query	measure	No	string
tenure	query	tenure	No	string

Responses

Code	Description	Schema
200	Top products have been determined.	ProductReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/ca/report/unpaid

GET

Summary

Unpaid sales invoices report.

Description

API to fetch unpaid sales invoices

Responses

Code	Description	Schema
200	Unpaid sales invoices report has been prepared.	DashboardReportData
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/ca/{code}

GET

Summary

Get sales invoice by code.

Description

API to fetch sales invoice details by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Sales invoice information has been fetched successfully.	SalesInvoiceResponseCanada
401	Unauthorized
403	Forbidden
404	Sales invoice not found.

Security

Security Schema	Scopes
Authorization	global

Invoice sales/ca/{id}

PUT

Summary

Update sales invoice.

Description

API to update existing sales invoice.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
salesInvoiceRequest	body	salesInvoiceRequest	Yes	SalesInvoiceRequestCanada

Responses

Code	Description	Schema
200	Sales Invoice has been updated successfully.	SalesInvoiceResponseCanada
201	Created
400	Sales invoice draft status cannot be changed after saving
401	Unauthorized
403	Forbidden
404	Sales Invoice with given id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete sales invoice by id.

Description

API to delete sales invoice details by id.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description
200	OK
204	Sales invoice has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Sales invoice not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update sales invoice memo or attachment

Description

API to update sales invoice memo or attachment

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
salesInvoiceFields	body	salesInvoiceFields	Yes	object

Responses

Code	Description	Schema
200	Memo/attachment for sales invoice updated successfully.	SalesInvoiceResponseCanada
204	No Content
401	Unauthorized
403	Forbidden
404	Sales Invoice with id not found.

Security

Security Schema	Scopes
Authorization	global

---

sales-invoice-controller-germany

Sales Invoice Germany APIs

Invoice sales/de

GET

Summary

Search sales invoices.

Description

API to search sales invoices.

Parameters

Name	Located in	Description	Required	Schema
customfield	query	customfield	No	string
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	Sales invoices have been fetched successfully.	SalesInvoiceResponseGermany
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create sales invoice

Description

API to create sales invoice.

Parameters

Name	Located in	Description	Required	Schema
salesInvoiceRequest	body	salesInvoiceRequest	Yes	SalesInvoiceRequestGermany

Responses

Code	Description	Schema
200	OK	SalesInvoiceResponseGermany
201	Sales invoice has been created successfully.	SalesInvoiceResponseGermany
400	Sales invoice could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

PUT

Summary

Update sales invoice attributes by code.

Description

API to update attributes of existing sales invoice by code.

Parameters

Name	Located in	Description	Required	Schema
code	query	code	Yes	string
request	body	request	Yes	SalesInvoiceUpdateRequest

Responses

Code	Description
200	Sales invoice attributes has been updated successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Sales invoice with given code not found.

Security

Security Schema	Scopes
Authorization	global

Invoice sales/de/bulk

POST

Summary

Create multiple sales invoice

Description

API to create sales invoice.

Parameters

Name	Located in	Description	Required	Schema
salesInvoiceRequests	body	salesInvoiceRequests	Yes	[ SalesInvoiceRequestGermany ]

Responses

Code	Description	Schema
200	OK	SalesInvoiceResponseGermany
201	Sales invoice has been created successfully.	SalesInvoiceResponseGermany
400	Sales invoice could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/de/code/{code}/details

GET

Summary

Sales invoice details by codes

Description

Sales invoice details by codes

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	OK	SalesInvoiceInformation
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/de/due-amount

PUT

Summary

Update due amount for sales invoices in bulk.

Description

API to update due amount for sales invoices in bulk.

Parameters

Name	Located in	Description	Required	Schema
invoiceUpdateAmountDueDtoList	body	invoiceUpdateAmountDueDtoList	Yes	[ InvoiceUpdateAmountDueDto ]
revert	query	revert	Yes	boolean

Responses

Code	Description
200	Due amounts updated successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Sales invoice not found.

Security

Security Schema	Scopes
Authorization	global

Invoice sales/de/import

POST

Summary

Create multiple sales invoice via import

Description

API to create sales invoice via import.

Parameters

Name	Located in	Description	Required	Schema
salesInvoiceRequests	body	salesInvoiceRequests	Yes	[ SalesInvoiceRequestGermany ]

Responses

Code	Description	Schema
200	OK	BulkApiResponse
201	Sales invoice has been created successfully.	BulkApiResponse
400	Sales invoice could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/de/linked-order/{code}

GET

Summary

Get sales invoices linked to an order by code.

Description

API to fetch sales invoices linked to an order by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Sales invoices has been fetched successfully.	SalesInvoiceResponseGermany
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/de/linked-quotation/{code}

GET

Summary

Get sales invoices linked to a quotation by code.

Description

API to fetch sales invoices linked to a quotation by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Sales invoices has been fetched successfully.	SalesInvoiceResponseGermany
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/de/report/count

POST

Summary

Get sales invoice count for contacts

Description

API to fetch sales invoice count for contacts

Parameters

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

Responses

Code	Description	Schema
200	Contact sales invoice count has been fetched.	object
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/de/report/overview

GET

Summary

Sales invoice overview report data.

Description

API to fetch sales invoice overview report data

Parameters

Name	Located in	Description	Required	Schema
contactCode	query	contactCode	No	string
interval	query	interval	No	string

Responses

Code	Description	Schema
200	Sales invoice overview report has been prepared.	InvoiceOverviewReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/de/report/top-customers

GET

Summary

Fetch top customers

Description

API to fetch top customers.

Parameters

Name	Located in	Description	Required	Schema
measure	query	measure	No	string
tenure	query	tenure	No	string

Responses

Code	Description	Schema
200	Top customers have been determined.	CustomerReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/de/report/top-products

GET

Summary

Fetch top products

Description

API to fetch top products.

Parameters

Name	Located in	Description	Required	Schema
measure	query	measure	No	string
tenure	query	tenure	No	string

Responses

Code	Description	Schema
200	Top products have been determined.	ProductReport
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/de/report/unpaid

GET

Summary

Unpaid sales invoices report.

Description

API to fetch unpaid sales invoices

Responses

Code	Description	Schema
200	Unpaid sales invoices report has been prepared.	DashboardReportData
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/de/{code}

GET

Summary

Get sales invoice by code.

Description

API to fetch sales invoice details by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Sales invoice information has been fetched successfully.	SalesInvoiceResponseGermany
401	Unauthorized
403	Forbidden
404	Sales invoice not found.

Security

Security Schema	Scopes
Authorization	global

Invoice sales/de/{id}

PUT

Summary

Update sales invoice.

Description

API to update existing sales invoice.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
salesInvoiceRequest	body	salesInvoiceRequest	Yes	SalesInvoiceRequestGermany

Responses

Code	Description	Schema
200	Sales Invoice has been updated successfully.	SalesInvoiceResponseGermany
201	Created
400	Sales invoice draft status cannot be changed after saving
401	Unauthorized
403	Forbidden
404	Sales Invoice with given id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete sales invoice by id.

Description

API to delete sales invoice details by id.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description
200	OK
204	Sales invoice has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Sales invoice not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update sales invoice memo or attachment

Description

API to update sales invoice memo or attachment

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
salesInvoiceFields	body	salesInvoiceFields	Yes	object

Responses

Code	Description	Schema
200	Memo/attachment for sales invoice updated successfully.	SalesInvoiceResponseGermany
204	No Content
401	Unauthorized
403	Forbidden
404	Sales Invoice with id not found.

Security

Security Schema	Scopes
Authorization	global

---

sales-document-controller

Sales Document APIs

Invoice sales/document

GET

Summary

Search sales documents.

Description

API to search sales documents.

Parameters

Name	Located in	Description	Required	Schema
documentStage	query	documentStage	No	string
fromDate	query	fromDate	No	dateTime
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
toDate	query	toDate	No	dateTime

Responses

Code	Description	Schema
200	Sales documents have been fetched successfully.	Page
400	Failed to fetch sales documents.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/document/customers

GET

Summary

Top Customers Trend

Description

API for top Customers trend

Parameters

Name	Located in	Description	Required	Schema
fromDate	query		Yes	long
timePeriod	query		No	string
toDate	query		Yes	long

Responses

Code	Description	Schema
200	Top Customers Trend has been fetched successfully.	Page
400	Failed to fetch Top Customers Trend
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/document/products

GET

Summary

Top Products Trend

Description

API for top products trend

Parameters

Name	Located in	Description	Required	Schema
fromDate	query		Yes	long
timePeriod	query		No	string
toDate	query		Yes	long

Responses

Code	Description	Schema
200	Top Products Trend has been fetched successfully.	Page
400	Failed to fetch Top Products Trend
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/document/sales/invoices

POST

Summary

Sales Invoice Report

Description

Sales Invoice Report API

Parameters

Name	Located in	Description	Required	Schema
request	body	request	Yes	InvoiceDataESRequest

Responses

Code	Description	Schema
200	Sales Invoice data fetched from ES successfully.	InvoiceDataESResponse
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/document/summary

GET

Summary

Sales documents summary.

Description

API for sales documents summary.

Parameters

Name	Located in	Description	Required	Schema
fromDate	query	fromDate	No	dateTime
search	query	search	No	string
toDate	query	toDate	No	dateTime

Responses

Code	Description	Schema
200	Sales documents summary has been fetched successfully.	DocumentSummaryResponse
400	Failed to fetch sales documents summary.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Invoice sales/document/vendors

GET

Summary

Top Customers Trend

Description

API for top Customers trend

Parameters

Name	Located in	Description	Required	Schema
fromDate	query		Yes	long
timePeriod	query		No	string
toDate	query		Yes	long

Responses

Code	Description	Schema
200	Top Customers Trend has been fetched successfully.	Page
400	Failed to fetch Top Customers Trend
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

---

sales-invoice-indonesia-controller

Sales Invoice Indonesia APIs

Invoice sales/id

GET

Summary

Search sales invoices.

Description

API to search sales invoices.

Parameters

Name	Located in	Description	Required	Schema
customfield	query	customfield	No	string
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	Sales invoices have been fetched successfully.	SalesInvoiceResponseIndonesia
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create sales invoice

Description

API to create sales invoice.

Parameters

Name	Located in	Description	Required	Schema
salesInvoiceRequest	body	salesInvoiceRequest	Yes	SalesInvoiceRequestIndonesia

Responses

Code	Description	Schema
200	OK	SalesInvoiceResponseIndonesia
201	Sales invoice has been created successfully.	SalesInvoiceResponseIndonesia
400	Sales invoice could not be created due to insufficient data.