Bill APIs

Bill is a transaction representing a request-for-payment from a third party for goods/services rendered, received, or both. With a complete overview of your bills with the "Bill" tab, you will be able to steer clear of late payment fees and build effective supplier relationships by paying your bills on time..

Bill Api helps you to create new bill, update a particular bill, retrieve bill by id, or get the list of all bills.

More about Bill API documentation

API

---

Search Bill

Get bills by filter criteria. More about search bill

Description:

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

GET

Bill

More about search bill

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
salesperson	query	salesperson	No	long
fetchAttachmentDetails	query	fetchAttachmentDetails	No	boolean

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

---

Create Bill

Create a new bill. More about create bill

Description:

• Allows you to create a new bill.

POST

Bill

More about create bill

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

---

Update Bill

Update bill information. More about update bill

Description:

• Allows you to update a specific bill information.

PUT

Bill /{id}

More about update bill

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

---

Retrieve Bill

Get bill by code. More about retrieve bill

Description:

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

GET

Bill /{code}

More about retrieve bill

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

---

Retrieve Bill details by code

GET

Bill /code/{code}/details

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

---

Bulk Delete Bills

DELETE

Bill /bulk-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

---

Delete Bill

DELETE

Bill /{id}

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

---

Bill

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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /{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

Bill /{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

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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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.

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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.

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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.

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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.

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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.

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill /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

Bill correction/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

Bill correction/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

Bill correction/updatemissingjepurchase

POST

Summary

updateMissingJEPurchase

Responses

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

Security

Security Schema	Scopes
Authorization	global

Bill correction/updatemissingjesales

POST

Summary

updateMissingJESales

Responses

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

Security

Security Schema	Scopes
Authorization	global

---

Models

AccountDto

Name	Type	Description	Required
accountCode	string	Account code Example: "SA"	No
accountGroup	string	Account group	No
accountGroupId	string	Account group	No
accountNature	string	Account Nature Example: "ASSET"	No
accountSubGroup	string	Account group	No
accountSubGroupName	string	Account group	No
balance	number	Balance Amount Example: 999.99	No
balanceInAccountCurrency	number	Balance Amount in Account Currency Example: 999.99	No
code	string	Account code	No
currency	string	Account Currency	No
customField	[ CustomFieldItem ]	List of custom fields	No
description	string	Account Description Example: "Savings account"	No
exchangeRate	number	Base to Foreign Exchange Rate Example: 1	No
id	long	Account ID. Example: 1	No
isCreditCard	boolean	Is account is credit card account or not Example: false	No
isSubAccount	boolean	Flag to confirm Subaccount Example: false	No
isTdsApplicable	boolean	Is TDS applicable or not Example: false	No
isUndepositedFundAccount	boolean	Account is Undeposited fund account or not Example: true	No
name	string	Account Name Example: "Savings account"	No
natureOfIncomePayment	string	Nature of income payment Example: "Interest on Securities"	No
openingBalance	number	Opening Balance Amount in Base currency Example: 999.99	No
openingBalanceCdType	string	Opening balance Credit/Debit Type Example: "DEBIT"	No
openingBalanceEditable	boolean	Account Opening Balance editable or not Example: true	No
openingBalanceInAccountCurrency	number	Opening Balance Amount in Account currency Example: 999.99	No
parent	long	Parent AccountId Example: 2431252	No
parentName	string	Parent Name Example: 2431252	No
status	string	Account Status Example: "ACTIVE"	No
taxCode	string	Account Tax	No
totalBalance	number	Summation of Opening Balance and Balance Example: 999.99	No
totalBalanceInAccountCurrency	number	Summation of Opening Balance and Balance in Account Currency Example: 999.99	No
totalCOABalance	number	Summation of Opening Balance and Balance with Nature Example: 999.99	No
totalCOABalanceInAccountCurrency	number	Summation of Opening Balance and Balance with Nature in Account Currency Example: 999.99	No
usedChequeNumbers	string	Used Cheque Series Example: "301,302"	No

AdditionalCharges

Name	Type	Description	Required
additionalChargeAmount	number		No
additionalChargeTaxAmount	number		No
additionalChargesDetails	[ AdditionalChargesDetails ]		No
globalDiscount	GlobalDiscountDetails		No
globalDiscounts	[ GlobalDiscountDetails ]		No

AdditionalChargesDetails

Name	Type	Description	Required
additionalCharge	string		No
additionalChargeAccountCode	string		No
addtionalChargeTax	string		No
addtionalChargeTaxCode	string		No
apportionFlag	boolean		No
apportionValue	string	Enum: "APPORTION_MANUAL", "APPORTION_ON_QTY", "APPORTION_ON_VALUE"	No
cgst	number		No
chargeAmount	number		No
igst	number		No
isPercent	boolean		No
isPreCharge	boolean		No
percent	number		No
sgst	number		No
taxAmount	number		No

Address

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

AdvancedTrackingFulfilmentDto

Name	Type	Description	Required
binCode	string	bin code Example: "BIN-00001"	Yes
binName	string	Bin name Example: "Bin1"	No
qtyToFulfil	double	Batch qty to fulfill Example: 1	No
rackCode	string	Rack code Example: "RACK-00001"	Yes
rackName	string	Rack name Example: "Rack1"	No
rowCode	string	Row code Example: "ROW-00001"	Yes
rowName	string	Row name Example: "Row1"	No
serialBatchNumber	string	Batch or serial number to be fulfilled Example: "Batch-001"	No
warehouseCode	string	Warehouse of selected Batch/Serial Example: "WH-0000001"	No
warehouseName	string	Warehouse name Example: "Warehouse-1"	No

AdvancedTrackingMetaDto

Name	Type	Description	Required
acquiredCost	number	Acquired cost of the entire serial or batch Example: 1	No
advancedTrackingReturned	AdvancedTrackingReturned		No
batchSize	double	Serial Number or Batch size Example: 1	Yes
batchSizeAvailableForReturn	double	How much of the batch or serial is fulfilled Example: 1	Yes
batchSizeFulfilled	double	How much of the batch or serial is fulfilled Example: 1	Yes
batchSizeReturned	double	How much of the batch or serial is returned Example: 1	Yes
batchSizeReturnedPurchase	double	How much of the batch or serial is returned Example: 1	Yes
binCode	string	bin code Example: "BIN-00001"	Yes
binName	string	bin Name Example: "Bin 1"	Yes
expiryDate	dateTime	Expiry date. Date Format is dd-mm-yyyy. Applicable when AdvancedTrackingType is Batch Example: "01-01-2020"	No
id	long		No
manufacturingDate	dateTime	Manufacturing date. Date Format is dd-mm-yyyy. Applicable when AdvancedTrackingType is Batch Example: "01-01-2020"	No
productVariantCode	string	Product code Example: "P-001"	Yes
rackCode	string	Rack code Example: "RACK-00001"	Yes
rackName	string	Rack Name Example: "Rack 1"	Yes
reservedQuantity	double	Reserved Serial Number or Batch size Example: 1	No
reservedQuantityFulfilled	double	Fulfilled reserved serial number or batch size Example: 1	Yes
rowCode	string	Row code Example: "ROW-00001"	Yes
rowName	string	Row Name Example: "Row 1"	Yes
sequence	long	Sequence number Example: 1	No
serialBatchNumber	string	Serial Number or Batch Number Example: "BATCH-001"	Yes
subSequence	long	Subsequence number Example: 1	No
warehouseCode	string	Primary Warehouse Example: "WH-0000001"	No
warehouseName	string	Primary Warehouse Example: "warehouse name"	No

AdvancedTrackingReturned

Name	Type	Description	Required
batchSizeReturned	double		No
batchSizeReturnedPurchase	double		No
returnsByDoc	[ AdvancedTrackingReturnedByDoc ]		No

AdvancedTrackingReturnedByDoc

Name	Type	Description	Required
documentCode	string		No
qtyReturned	double		No
returnType	string	Enum: "SALES_RETURN", "PURCHASE_RETURN"	No
transactionRefCode	string		No

AggregationBucket

Name	Type	Description	Required
invoiceCount	long		No
invoiceDate	long		No
totalAmount	number		No

AmortizationDocumentItemDetails

Name	Type	Description	Required
deferralAccountCode	string		No
endDate	dateTime		No
startDate	dateTime		No
templateCode	string		No

AnalyzeDocumentResult

Name	Type	Description	Required
analyzeDocumentModelVersion	string		No
blocks	[ Block ]		No
documentMetadata	DocumentMetadata		No
humanLoopActivationOutput	HumanLoopActivationOutput		No
sdkHttpMetadata	SdkHttpMetadata		No
sdkResponseMetadata	ResponseMetadata		No

ApprovalHistoryItem

Name	Type	Description	Required
approvedBy	string		No
approvedDate	string		No
level	integer		No
remarks	string		No
status	string	Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"	No

ApprovalStatusRequestDto

Name	Type	Description	Required
approvalStatus	string	Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"	No
documentCodes	string		No

AssetGroupResponse

Name	Type	Description	Required
active	boolean	Is Asset Group active? Example: true	No
assetAccountCode	string	Asset Account Code Example: "AC-0000001"	No
assetAccountDisplayCode	string	Asset Account Display Code Example: "Acc00001"	No
assetAccountName	string	Asset Account Name Example: "Computer Equipment Asset Account"	No
assetAccumulatedAccountCode	string	Asset Accumulated Account Code Example: "AC-0000002"	No
assetAccumulatedAccountDisplayCode	string	Asset Accumulated Account Display Code Example: "Acc00002"	No
assetAccumulatedAccountName	string	Asset Accumulated Account Name Example: "Computer Equipment Accumulated Account"	No
decliningFactor	number	Declining Factor Example: 1	No
depreciationConvention	string	Depreciation Convention Enum: "FULL_MONTH", "ACTUAL_DATE" Example: "FULL_MONTH"	No
depreciationExpenseAccountCode	string	Depreciation Expense Account Code Example: "AC-0000003"	No
depreciationExpenseAccountDisplayCode	string	Depreciation Expense Account Display Code Example: "Acc00003"	No
depreciationExpenseAccountName	string	Depreciation Expense Account Name Example: "Computer Equipment Depreciation Account"	No
depreciationMethod	string	Depreciation Method Enum: "NO_DEPRECIATION", "STRAIGHT_LINE", "DECLINING_BALANCE", "INSTANT_ASSET_WRITE_OFF" Example: "STRAIGHT_LINE"	No
depreciationRate	number	Depreciation Rate Example: 1	No
effectiveLife	number	Effective Life Example: 2	No
hsnOrSacCode	string	HSN or SAC Code Example: "011"	No
id	long	Id Example: 1	No
name	string	Asset Group Name Example: "IT Hardware"	No
purchaseTaxCode	string	GST Tax Code Example: "TX-0000003"	No
uqcIndia	string	UQC Example: "BAGS"	No
viewOnly	boolean	Is Asset Group view-only? Example: true	No
writeOffAccountCode	string	Write off Account Code Example: "AC-0000002"	No

AssetRequest

Name	Type	Description	Required
assetGroupId	long	Asset Group Id Example: 1	No
currency	string	Currency Example: "USD"	No
decliningFactor	number	Declining Factor Example: 2.5	No
depreciationConvention	string	Depreciation Convention Enum: "FULL_MONTH", "ACTUAL_DATE" Example: "FULL_MONTH"	No
depreciationMethod	string	Depreciation Method Enum: "NO_DEPRECIATION", "STRAIGHT_LINE", "DECLINING_BALANCE", "INSTANT_ASSET_WRITE_OFF" Example: "STRAIGHT_LINE"	No
depreciationRate	number	Depreciation Rate Example: 66.66	No
depreciationStartDate	dateTime	Depreciation Start Date Example: "20-06-2019"	No
depreciationThreshold	number	Depreciation Threshold Example: 8765.43	No
description	string	Asset Description Example: "Computer for developers"	No
discount	number		No
discountInPercent	boolean		No
documentCode	string		No
documentItemCode	string		No
documentSequenceCode	string	Document Sequence Code Example: "FA-0000001"	No
documentType	string		No
effectiveLife	number	Effective Life Example: 1.5	No
errors	[ string ]		No
expenseBillCode	string	Expense Bill Code Example: "BUY-0000001"	No
id	long	Id Example: 1	No
installationDate	dateTime	Installation Date Example: "20-06-2019"	No
name	string	Asset Name Example: "Computer"	No
openingAccumulatedDepreciation	number	Opening Accumulated Depreciation Example: 1234.56	No
openingAsset	boolean	Is this an Opening Asset Example: false	No
profitLossAccountCode	string	Profit/Loss Account Code Example: "AC-0000001"	No
purchaseDate	dateTime	Purchase Date Example: "20-06-2019"	No
purchaseInvoiceId	long		No
purchaseInvoiceRequest	PurchaseInvoiceRequest		No
purchasePrice	number	Purchase Price Example: 9999.99	No
residualValue	number	Residual Value Example: 1234.56	No
salesIncomeAccountCode	string	Sales/Income Account Code Example: "AC-0000001"	No
sequenceFormat	string	Document Sequence Format Example: "FA-0000000"	No
serialNumber	string	Serial Number Example: "ABCD123456"	No
taxAmount	number		No
taxCode	string		No
totalAmount	number		No
warehouse	string	Warehouse Code Example: "WH-0000001"	No
warrantyEndDate	string	Warranty End Date Example: "01-11-2024"	No
warrantyStartDate	string	Warranty Start Date Example: "01-11-2023"	No

AssetResponse

Name	Type	Description	Required
assetGroup	AssetGroupResponse	Asset Group	No
assetGroupId	long	Asset Group Id Example: 1	No
bookValue	number	Book Value Example: 9999.99	No
currency	string	Currency Example: "USD"	No
decliningFactor	number	Declining Factor Example: 2.5	No
depreciationConvention	string	Depreciation Convention Enum: "FULL_MONTH", "ACTUAL_DATE" Example: "FULL_MONTH"	No
depreciationMethod	string	Depreciation Method Enum: "NO_DEPRECIATION", "STRAIGHT_LINE", "DECLINING_BALANCE", "INSTANT_ASSET_WRITE_OFF" Example: "STRAIGHT_LINE"	No
depreciationRate	number	Depreciation Rate Example: 66.66	No
depreciationStartDate	dateTime	Depreciation Start Date Example: "20-06-2019"	No
depreciationThreshold	number	Depreciation Threshold Example: 8765.43	No
description	string	Asset Description Example: "Computer for developers"	No
discount	number		No
discountInPercent	boolean		No
documentCode	string		No
documentItemCode	string		No
documentSequenceCode	string	Document Sequence Code Example: "FA-0000001"	No
documentType	string		No
effectiveLife	number	Effective Life Example: 1.5	No
errors	[ string ]		No
expenseBillCode	string	Expense Bill Code Example: "BUY-0000001"	No
id	long	Id Example: 1	No
installationDate	dateTime	Installation Date Example: "20-06-2019"	No
name	string	Asset Name Example: "Computer"	No
netBookValue	number	Net Book Value Example: 9876.54	No
openingAccumulatedDepreciation	number	Opening Accumulated Depreciation Example: 1234.56	No
openingAsset	boolean	Is this an Opening Asset Example: false	No
profitLossAccountCode	string	Profit/Loss Account Code Example: "AC-0000001"	No
purchaseDate	dateTime	Purchase Date Example: "20-06-2019"	No
purchaseInvoiceId	long		No
purchaseInvoiceRequest	PurchaseInvoiceRequest		No
purchasePrice	number	Purchase Price Example: 9999.99	No
remainingLife	string	Remaining Life Example: "1.25 years"	No
residualValue	number	Residual Value Example: 1234.56	No
salesIncomeAccountCode	string	Sales/Income Account Code Example: "AC-0000001"	No
sequenceFormat	string	Document Sequence Format Example: "FA-0000000"	No
serialNumber	string	Serial Number Example: "ABCD123456"	No
taxAmount	number		No
taxCode	string		No
totalAmount	number		No
viewOnly	boolean	Is Asset view-only? Example: true	No
warehouse	string	Warehouse Code Example: "WH-0000001"	No
warrantyEndDate	string	Warranty End Date Example: "01-11-2024"	No
warrantyStartDate	string	Warranty Start Date Example: "01-11-2023"	No

AttachmentsResponse

Name	Type	Description	Required
attachmentDate	dateTime		No
attachmentFileName	string		No
attachmentId	long		No
attachmentSize	string		No

AttributeDetails

Name	Type	Description	Required
id	long	Attribute ID Example: "Id"	No
name	string	Attribute Name Example: "Colour"	No
values	[ string ]	Attribute values	No

BackOrderUpdateRequest

Name	Type	Description	Required
documentInfo	DocumentInfo		No
salesDocumentCode	string		No
salesDocumentType	string	Enum: "QUOTATION", "PURCHASE_ORDER", "SALES_ORDER", "PURCHASE_INVOICE", "SALES_INVOICE", "MAKE_PAYMENT", "RECEIVE_PAYMENT", "JOURNAL_ENTRY", "BANK_TRANSFER", "CREDIT_NOTE", "DEBIT_NOTE", "EXPENSE", "EXPENSE_PREPAYMENT", "DEPOSIT", "DEPOSIT_ADVPAYMENT", "CONTRA_ADJUSTMENT", "GOODS_RECEIPT", "FULFILLMENT", "PICKLIST", "PACKLIST", "SHIPLIST", "PAYSLIP", "PAYROLL_CHECK", "CHEQUE", "SALES_RETURN", "PURCHASE_RETURN", "STOCK_ADJUSTMENT", "STOCK_TRANSFER", "WORK_ORDER", "FIXED_ASSET", "E_WAY_BILL_SUMMARY", "E_WAY_BILL_DETAIL", "PURCHASE_REQUEST", "JOB_WORK_OUT_ORDER", "JOB_WORK_OUT_TRANSFER", "QC_DOCUMENT", "WIP_PRODUCTION", "STOCK_REQUEST", "STOCK_ISSUE", "FORECAST"	No

BarcodeDetails

Name	Type	Description	Required
barcodeField	string		No
hideBarcodeLabel	boolean		No

Block

Name	Type	Description	Required
blockType	string		No
columnIndex	integer		No
columnSpan	integer		No
confidence	float		No
entityTypes	[ string ]		No
geometry	Geometry		No
id	string		No
page	integer		No
relationships	[ Relationship ]		No
rowIndex	integer		No
rowSpan	integer		No
selectionStatus	string		No
text	string		No
textType	string		No

BomAdditionalCostDto

Name	Type	Description	Required
bomMetaDetailsId	long	id of bomMetaDetailsId Example: 1234	No
bomMetaName	string	BOM Meta Name Example: "DEFAULT"	No
label	string	Name of manufacturing service Example: "Labour charges"	No
price	number	Quantity of product in bom Example: 10.5	No

BomMetaDetailsDto

Name	Type	Description	Required
active	boolean	bom meta details status Example: true	No
bomAddCostConfiguration	[ BomAdditionalCostDto ]	Bom additional cost information	No
bomOperationsConfiguration	[ BomOperationDto ]	Bom Operations information	No
bomProductCostDetails	[ BomProductCostDetails ]	JSON object for custom fields Example: {"field1":"value1","field2":"value2"}	No
bomProductsConfiguration	[ BomMetaDto ]	Bom Products information	No
code	string	bom meta details code Example: "code"	No
deleted	boolean	bom meta details delete status Example: true	No
id	long	id of bom meta details Example: 1234	No
isDefault	boolean	bom default Example: true	No
name	string	bom meta details name Example: "bom meta name"	No
productId	string	id of bom product Example: 1234	No

BomMetaDto

Name	Type	Description	Required
bomMetaDetailsId	long	id of bomMetaDetailsId Example: 1234	No
bomMetaName	string	BOM Meta Name Example: "DEFAULT"	No
bomProductSubstitutesDetails	[ ProductSubstitutesDetails ]		No
cost	number	Cost of product in bom Example: 10.5	No
itemId	long	id of item in bom Example: 1234	No
itemName	string	Product Name Example: "Apple"	Yes
produceProductType	string	Produce Product type Enum: "NONE", "SCRAP", "COPRODUCT" Example: "SCRAP"	Yes
productCode	string		No
quantity	number	Quantity of product in bom Example: 10.5	No
stockUom	long		No

BomOperationDto

Name	Type	Description	Required
bomMetaDetailsId	long	id of bomMetaDetailsId Example: 1234	No
bomMetaName	string	BOM Meta Name Example: "DEFAULT"	No
costPerHour	number	Cost of operation in bom Example: 10.5	No
fixedRate	number	Cost of operation in bom Example: 10.5	No
operationId	long	id of operation in bom Example: 1234	No
operationName	string	Operation Name Example: "Apple"	Yes
totalCost	number	Cost of operation in bom Example: 10.5	No

BomProductCostDetails

Name	Type	Description	Required
operationCost	number	Operation Cost Example: 15	No
rawMaterialCost	number	Raw material cost Example: 20	No
totalCost	number	Total cost Example: 35	No

BoundingBox

Name	Type	Description	Required
height	float		No
left	float		No
top	float		No
width	float		No

BulkApiResponse

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

BulkApiResponse«AssetResponse»

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

BulkApiResponse«SalesInvoiceResponseAustralia»

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

BulkApiResponse«SalesInvoiceResponseCanada»

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

BulkApiResponse«SalesInvoiceResponseGermany»

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

BulkApiResponse«SalesInvoiceResponseIndia»

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

BulkApiResponse«SalesInvoiceResponseIndonesia»

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

BulkApiResponse«SalesInvoiceResponseIsrael»

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

BulkApiResponse«SalesInvoiceResponseMalaysia»

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

BulkApiResponse«SalesInvoiceResponsePhilippines»

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

BulkApiResponse«SalesInvoiceResponseSA»

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

BulkApiResponse«SalesInvoiceResponseUae»

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

BulkApiResponse«SalesInvoiceResponseUk»

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

BulkApiResponse«SalesInvoiceResponse»

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

BulkApiResponse«SalesOrderResponseIndia»

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

BulkApiResponse«SalesOrderResponseMalaysia»

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

BulkApiResponse«SalesOrderResponse»

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

BulkDeletePurchaseInvoiceResponse

Name	Type	Description	Required
documentSequenceCode	string	ID Example: 2	No
httpStatus	string	HTTP Status Enum: "100 CONTINUE", "101 SWITCHING_PROTOCOLS", "102 PROCESSING", "103 CHECKPOINT", "200 OK", "201 CREATED", "202 ACCEPTED", "203 NON_AUTHORITATIVE_INFORMATION", "204 NO_CONTENT", "205 RESET_CONTENT", "206 PARTIAL_CONTENT", "207 MULTI_STATUS", "208 ALREADY_REPORTED", "226 IM_USED", "300 MULTIPLE_CHOICES", "301 MOVED_PERMANENTLY", "302 FOUND", "302 MOVED_TEMPORARILY", "303 SEE_OTHER", "304 NOT_MODIFIED", "305 USE_PROXY", "307 TEMPORARY_REDIRECT", "308 PERMANENT_REDIRECT", "400 BAD_REQUEST", "401 UNAUTHORIZED", "402 PAYMENT_REQUIRED", "403 FORBIDDEN", "404 NOT_FOUND", "405 METHOD_NOT_ALLOWED", "406 NOT_ACCEPTABLE", "407 PROXY_AUTHENTICATION_REQUIRED", "408 REQUEST_TIMEOUT", "409 CONFLICT", "410 GONE", "411 LENGTH_REQUIRED", "412 PRECONDITION_FAILED", "413 PAYLOAD_TOO_LARGE", "413 REQUEST_ENTITY_TOO_LARGE", "414 URI_TOO_LONG", "414 REQUEST_URI_TOO_LONG", "415 UNSUPPORTED_MEDIA_TYPE", "416 REQUESTED_RANGE_NOT_SATISFIABLE", "417 EXPECTATION_FAILED", "418 I_AM_A_TEAPOT", "419 INSUFFICIENT_SPACE_ON_RESOURCE", "420 METHOD_FAILURE", "421 DESTINATION_LOCKED", "422 UNPROCESSABLE_ENTITY", "423 LOCKED", "424 FAILED_DEPENDENCY", "426 UPGRADE_REQUIRED", "428 PRECONDITION_REQUIRED", "429 TOO_MANY_REQUESTS", "431 REQUEST_HEADER_FIELDS_TOO_LARGE", "451 UNAVAILABLE_FOR_LEGAL_REASONS", "500 INTERNAL_SERVER_ERROR", "501 NOT_IMPLEMENTED", "502 BAD_GATEWAY", "503 SERVICE_UNAVAILABLE", "504 GATEWAY_TIMEOUT", "505 HTTP_VERSION_NOT_SUPPORTED", "506 VARIANT_ALSO_NEGOTIATES", "507 INSUFFICIENT_STORAGE", "508 LOOP_DETECTED", "509 BANDWIDTH_LIMIT_EXCEEDED", "510 NOT_EXTENDED", "511 NETWORK_AUTHENTICATION_REQUIRED" Example: "404 NOT_FOUND"	No
reason	string	Example: "NOT FOUND"	No

BulkEwbRequestDto

Name	Type	Description	Required
appKey	string		No
asp_secret_key	string		No
authtoken	string		No
ewbDetailsDtoList	[ EwbDetailsDto ]		No
gstin	string		No
sek	string		No
session_id	string		No
status	string		No
tokenExp	string		No
userName	string		No

BulkPaymentItem

Name	Type	Description	Required
amount	number		No
documentCode	string		No

BulkPurchaseInvoiceUpdateResponse

Name	Type	Description	Required
httpStatus	string	HTTP Status Enum: "100 CONTINUE", "101 SWITCHING_PROTOCOLS", "102 PROCESSING", "103 CHECKPOINT", "200 OK", "201 CREATED", "202 ACCEPTED", "203 NON_AUTHORITATIVE_INFORMATION", "204 NO_CONTENT", "205 RESET_CONTENT", "206 PARTIAL_CONTENT", "207 MULTI_STATUS", "208 ALREADY_REPORTED", "226 IM_USED", "300 MULTIPLE_CHOICES", "301 MOVED_PERMANENTLY", "302 FOUND", "302 MOVED_TEMPORARILY", "303 SEE_OTHER", "304 NOT_MODIFIED", "305 USE_PROXY", "307 TEMPORARY_REDIRECT", "308 PERMANENT_REDIRECT", "400 BAD_REQUEST", "401 UNAUTHORIZED", "402 PAYMENT_REQUIRED", "403 FORBIDDEN", "404 NOT_FOUND", "405 METHOD_NOT_ALLOWED", "406 NOT_ACCEPTABLE", "407 PROXY_AUTHENTICATION_REQUIRED", "408 REQUEST_TIMEOUT", "409 CONFLICT", "410 GONE", "411 LENGTH_REQUIRED", "412 PRECONDITION_FAILED", "413 PAYLOAD_TOO_LARGE", "413 REQUEST_ENTITY_TOO_LARGE", "414 URI_TOO_LONG", "414 REQUEST_URI_TOO_LONG", "415 UNSUPPORTED_MEDIA_TYPE", "416 REQUESTED_RANGE_NOT_SATISFIABLE", "417 EXPECTATION_FAILED", "418 I_AM_A_TEAPOT", "419 INSUFFICIENT_SPACE_ON_RESOURCE", "420 METHOD_FAILURE", "421 DESTINATION_LOCKED", "422 UNPROCESSABLE_ENTITY", "423 LOCKED", "424 FAILED_DEPENDENCY", "426 UPGRADE_REQUIRED", "428 PRECONDITION_REQUIRED", "429 TOO_MANY_REQUESTS", "431 REQUEST_HEADER_FIELDS_TOO_LARGE", "451 UNAVAILABLE_FOR_LEGAL_REASONS", "500 INTERNAL_SERVER_ERROR", "501 NOT_IMPLEMENTED", "502 BAD_GATEWAY", "503 SERVICE_UNAVAILABLE", "504 GATEWAY_TIMEOUT", "505 HTTP_VERSION_NOT_SUPPORTED", "506 VARIANT_ALSO_NEGOTIATES", "507 INSUFFICIENT_STORAGE", "508 LOOP_DETECTED", "509 BANDWIDTH_LIMIT_EXCEEDED", "510 NOT_EXTENDED", "511 NETWORK_AUTHENTICATION_REQUIRED" Example: "404 NOT_FOUND"	No
id	long	ID Example: 2	No
reason	string	Example: "NOT FOUND"	No

BulkResponse

Name	Type	Description	Required
httpStatus	string	HTTP Status Enum: "100 CONTINUE", "101 SWITCHING_PROTOCOLS", "102 PROCESSING", "103 CHECKPOINT", "200 OK", "201 CREATED", "202 ACCEPTED", "203 NON_AUTHORITATIVE_INFORMATION", "204 NO_CONTENT", "205 RESET_CONTENT", "206 PARTIAL_CONTENT", "207 MULTI_STATUS", "208 ALREADY_REPORTED", "226 IM_USED", "300 MULTIPLE_CHOICES", "301 MOVED_PERMANENTLY", "302 FOUND", "302 MOVED_TEMPORARILY", "303 SEE_OTHER", "304 NOT_MODIFIED", "305 USE_PROXY", "307 TEMPORARY_REDIRECT", "308 PERMANENT_REDIRECT", "400 BAD_REQUEST", "401 UNAUTHORIZED", "402 PAYMENT_REQUIRED", "403 FORBIDDEN", "404 NOT_FOUND", "405 METHOD_NOT_ALLOWED", "406 NOT_ACCEPTABLE", "407 PROXY_AUTHENTICATION_REQUIRED", "408 REQUEST_TIMEOUT", "409 CONFLICT", "410 GONE", "411 LENGTH_REQUIRED", "412 PRECONDITION_FAILED", "413 PAYLOAD_TOO_LARGE", "413 REQUEST_ENTITY_TOO_LARGE", "414 URI_TOO_LONG", "414 REQUEST_URI_TOO_LONG", "415 UNSUPPORTED_MEDIA_TYPE", "416 REQUESTED_RANGE_NOT_SATISFIABLE", "417 EXPECTATION_FAILED", "418 I_AM_A_TEAPOT", "419 INSUFFICIENT_SPACE_ON_RESOURCE", "420 METHOD_FAILURE", "421 DESTINATION_LOCKED", "422 UNPROCESSABLE_ENTITY", "423 LOCKED", "424 FAILED_DEPENDENCY", "426 UPGRADE_REQUIRED", "428 PRECONDITION_REQUIRED", "429 TOO_MANY_REQUESTS", "431 REQUEST_HEADER_FIELDS_TOO_LARGE", "451 UNAVAILABLE_FOR_LEGAL_REASONS", "500 INTERNAL_SERVER_ERROR", "501 NOT_IMPLEMENTED", "502 BAD_GATEWAY", "503 SERVICE_UNAVAILABLE", "504 GATEWAY_TIMEOUT", "505 HTTP_VERSION_NOT_SUPPORTED", "506 VARIANT_ALSO_NEGOTIATES", "507 INSUFFICIENT_STORAGE", "508 LOOP_DETECTED", "509 BANDWIDTH_LIMIT_EXCEEDED", "510 NOT_EXTENDED", "511 NETWORK_AUTHENTICATION_REQUIRED" Example: "404 NOT_FOUND"	No
id	long	ID Example: 2	No

CancelDetail

Name	Type	Description	Required
cnlRem	string		No
cnlRsn	string		No
id	long		No
irn	string		No

ContactDto

Name	Type	Description	Required
attentionTo	string	the contact name in govt agency Example: "Peter Parker"	No
billingAddress	[ Address ]	List of Billing Address.	No
businessUnit	string	indicates the contact is govt agency Example: "CAA01 - Cvl Avtn Authrty of Singapore"	No
contactMasterId	string (uuid)	contact master id Example: "2df7a5c1-3305-498d-8d01-aa92c42d19d2"	No
contactNumber	string	Contact number Example: "+65999999999"	No
creditLimit	number	Credit Limit Example: 100	No
creditLimitInBaseCurrency	number	Credit Limit In Org Currency Example: 100	No
currencyCode	string	Currency code Enum: "AFN", "ALL", "DZD", "AOA", "ARS", "AMD", "AWG", "AZN", "BSD", "BHD", "BDT", "BBD", "BYN", "BZD", "BMD", "BTN", "BOB", "BAM", "BRL", "BND", "BGN", "BIF", "KHR", "CAD", "CVE", "KYD", "CLP", "CNY", "COP", "KMF", "CDF", "CRC", "CZK", "HRK", "CUC", "DJF", "DOP", "EGP", "ERN", "ETB", "FKP", "FJD", "XAF", "GMD", "GEL", "GHS", "GIP", "DKK", "GTQ", "GNF", "GYD", "HTG", "HNL", "HKD", "HUF", "ISK", "INR", "IDR", "IRR", "IQD", "JMD", "JPY", "JOD", "KZT", "KES", "KWD", "KGS", "LAK", "LBP", "LSL", "LRD", "LYD", "MOP", "MKD", "MGA", "MWK", "MYR", "MVR", "MRO", "MUR", "MXN", "MDL", "MNT", "MZN", "MMK", "NAD", "NPR", "NIO", "NGN", "KPW", "OMR", "PKR", "ILS", "PAB", "PGK", "PYG", "PEN", "PHP", "PLN", "QAR", "RON", "RUB", "RWF", "SHP", "XCD", "WST", "STD", "SAR", "RSD", "SCR", "SLL", "SGD", "ANG", "SBD", "SOS", "ZAR", "KRW", "SSP", "EUR", "LKR", "SDG", "SRD", "NOK", "SZL", "SEK", "CHF", "SYP", "TWD", "TJS", "TZS", "THB", "XOF", "NZD", "TOP", "TTD", "TND", "TRY", "TMT", "AUD", "UGX", "UAH", "AED", "GBP", "USD", "UYU", "UZS", "VUV", "VEF", "VND", "XPF", "MAD", "YER", "ZMW", "BWP", "CNH" Example: "SGD"	No
customField	[ CustomFieldItem ]	JSON object for custom fields Example: {"field1":"value1","field2":"value2"}	No
documentSequenceCode	string	Contact Sequence code Example: "C-0000001"	No
emailId	string	contact email address Example: "myinfo@domain.com"	No
extCompanyName	string	the company name from external app Example: "QuickBook"	No
intercompanyType	string	Contact Type either parent or subsidiary Enum: "PARENT", "SUBSIDIARY" Example: "PARENT/SUBSIDIARY"	No
invoiceCreditLimitType	string	Invoice Credit Limit Type Enum: "IGNORE", "WARN", "BLOCK" Example: "IGNORE"	No
invoices	object		No
isAccountNumberFlag	boolean	indicates if user is sending account number or code Example: true	No
isCreditLimitApplicable	boolean	Contact credit limit applicable Example: true	No
isIncludeCurrentInvoice	boolean	Include Current Invoice Example: true	No
isIncludeCurrentQuotation	boolean	Include Current Quotation Example: true	No
isIncludeCurrentSalesOrder	boolean	Include Current Sales Order Example: false	No
isParentCompany	boolean	Is Parent company Example: false	No
isSubsidiaryCompany	boolean	Is Subsidiary company Example: false	No
name	string	Contact name Example: "Sam"	No
payableAccountCode	string	Payable account code Example: "AC002"	No
paymentTermCode	string	Payment term code Example: "Net 0"	No
peppolId	string	Peppol ID Example: "u000:11::11293"	No
purchasePriceLists	[ long ]	Set of Purchase price lists Example: [123,456]	No
quotationCreditLimitType	string	Quotation Credit Limit Type Enum: "IGNORE", "WARN", "BLOCK" Example: "IGNORE"	No
receivableAccountCode	string	Receivable account code Example: "AC001"	No
salesOrderCreditLimitType	string	Sales Order Credit Limit Type Enum: "IGNORE", "WARN", "BLOCK" Example: "IGNORE"	No
salesPriceLists	[ long ]	Set of Sales price lists Example: [123,456]	No
sequenceFormat	string	Sequence Format Example: 1	No
shippingAddress	[ Address ]	List of Shipping Address.	No
singaporeGovt	boolean	indicates the contact is govt agency Example: true	No
taxExempted	boolean	Denotes if customer is tax exempted Example: true	No
taxExemptionNo	string	Generated tax exemption number Example: "234s-few3-2422"	No
taxExemptionReason	string	Tax exemption reason Example: "Resale, Federal Agency"	No
taxNumber	string	Tax number Example: 123456	No
uen	string	Contact UEN Example: "DHJEUK"	No

PurchaseInvoiceRequest

Name	Type	Description	Required
additionalCharges	AdditionalCharges	Purchase invoice additional charges details	No
approvalStatus	string	Approval status Enum: "APPROVED", "PENDING_FOR_APPROVAL", "EDITING", "REJECTED", "NOT_REQUIRED", "PULLED_BACK" Example: "APPROVED"	No
attachmentIds	[ integer ]		No
attachments	[ string ]	File attachments	No
backOrder	boolean	Backorder flag to indicate if purchase invoice is backorder Example: true	No
billTo	Address	Bill to address	No
buyerReference	string	Buyer reference	No
contact	object	Contact details	No
contactCode	string	Contact Code Example: "C0001"	Yes
createdBy	long	Identifier of the user who created the invoice	No
createdDate	string	Date on which the invoice was created	No
currency	string	Currency Example: "C001"	Yes
customField	[ object ]	List of custom fields	No
documentSequenceCode	string	Purchase Invoice Code Example: "0000001"	No
draft	boolean	True if want to save as draft. Example: false	No
draftReferenceId	string	Draft reference id	No
dueAmount	number	Amount Due Example: 12.322	No
eInvoiceStatus	[ object ]	List of e-invoice status details	No
exchangeRate	number	Exchange rate Example: 0.456345	No
gstExchangeRate	number	GST Exchange rate if tax residency currency is different than base currency Example: 1	No
isPartialInvoice	boolean	True if is partial invoice Example: false	No
isValidForUpdateValueOfGoods	boolean	True if the value of goods can still be updated	No
journalEntryCode	string	Journal Entry Code Example: "JE0001"	No
landedCost	boolean	True if landed cost applies to the invoice	No
lineRefNo	string	Line reference number	No
linkedDocuments	[ DocumentInfo ]	Linked Documents	No
memo	string	Memo Example: "Memo details"	No
multiApprovalDetails	object	Multi-level approval details	No
openingDocumentNumber	string	Vendor opening document number Example: "DC-0001"	No
openingInvoice	boolean	True if opening invoice Example: false	No
paymentMilestoneFlag	boolean	Payment milestone flag to indicate if payment milestones are set Example: true	No
paymentStatus	string	Payment status Enum: "PENDING", "PARTIAL", "RECEIVED" Example: "PENDING"	No
paymentTerm	string	Payment term	No
payableAccountCode	string	Account code of contact's account payable Example: "AC-001"	No
poNumber	string	Purchase order number	No
primaryExchangeRate	number	Primary exchange rate	No
purchaseInvoiceAccounts	[ PurchaseInvoiceAccountDetails ]	Purchase invoice account (expense/asset) line details	No
purchaseInvoiceAssets	[ PurchaseInvoiceAssetGroupDetails ]	Purchase invoice asset group details	No
purchaseInvoiceDate	string	Purchase Invoice date Example: "25-10-2019"	Yes
purchaseInvoiceDueDate	string	Purchase Invoice due date Example: "25-10-2019"	Yes
purchaseInvoiceProducts	[ PurchaseInvoiceProductDetails ]	Purchase invoice item details	No
purchaseInvoiceRecurring	PurchaseInvoiceRecurringDetails	Purchase invoice recurring details	No
purchaseInvoiceType	string	Purchase invoice type Enum: "INVENTORY", "EXPENSE", "ASSET" Example: "INVENTORY"	No
purchaseOrderRefNo	string	Contact PO reference number Example: "CPO001"	No
receiptDate	string	Receipt date	No
receiptStatus	string	Receipt status Enum: "UNRECEIVED", "PARTIAL_RECEIVED", "FULLY_RECEIVED", "NOT_APPLICABLE", "IN_PROGRESS", "PENDING_FOR_APPROVAL" Example: "UNRECEIVED"	No
receiveByDate	string	Receive by date	No
receivedComplete	boolean	True if the purchase invoice has been fully received	No
recurring	boolean	True if Invoice is recurring. Example: true	No
recurringActivated	boolean	True if Invoice recurrence is active. Example: false	No
requestedBy	long	Identifier of the user who requested the invoice	No
roundOffAmountInBaseCurrency	number	Round Off Amount In Base Currency Example: 12.322	No
roundOffAmountInDocumentCurrency	number	Round Off Amount In Document Currency Example: 12.322	No
seqCodeAlreadyDumped	boolean	True if Sequence Code is already dumped. Example: false	No
sequenceFormat	string	Sequence Format Id Example: 1	No
sgEInvoiceIRASStatus	string	Singapore IRAS e-invoice status	No
sgEInvoiceStatus	string	Singapore e-invoice status	No
shipFrom	Address	Ship from address	No
shipTo	Address	Ship to address	No
status	string	Invoice status Enum: "OPEN", "DRAFT", "CLOSED" Example: "OPEN"	No
supplierInvoiceNo	string	Supplier invoice number	No
taxAmount	number	Tax amount Example: 2.322	No
tcsAmount	number	TCS amount Example: 2.322	No
tcsPercentage	number	TCS percentage Example: 2	No
tcsRateId	long	TCS Rate Id Example: 1	No
totalAmount	number	Total amount Example: 12.322	No
totalAmountInBaseCurrency	number	Total amount in base currency Example: 12.322	No
totalTdsAmount	number	Total TDS amount	No
unitPriceGstInclusive	boolean	Unit price is GST inclusive Example: false	No
warehouseCode	string	Warehouse Code Example: "WH-000001"	No

PurchaseInvoiceResponse

PurchaseInvoiceResponse includes all attributes of PurchaseInvoiceRequest, plus the following response-only attributes.

Name	Type	Description	Required
attachmentsWithLink	[ AttachmentsResponse ]	Attachment details including download links	No
bankTransactionFileCode	string	Bank transaction file code associated with the invoice	No
contactDto	ContactDto	Full contact details of the invoice's contact	No
emailStatus	string	Status of the last email sent for the invoice	No
id	long	Purchase invoice id	No
isManuallyClosed	boolean	True if the invoice was manually closed	No
knockoffInfo	[ object ]	Knock-off information linked to the invoice	No
purchaseInvoiceCode	string	Purchase invoice code Example: "PI-0000001"	No
shortClosedStatus	string	Short-closed status Enum: "NONE", "PARTIALLY_SHORT_CLOSED", "FULLY_SHORT_CLOSED" Example: "NONE"	No
updatedBy	long	Identifier of the user who last updated the invoice	No

PurchaseInvoiceInformation

Response returned by Retrieve Bill details by code.

Name	Type	Description	Required
additionalCharges	AdditionalCharges	Purchase invoice additional charges details	No
applyRcmCheck	boolean	True if the RCM (Reverse Charge Mechanism) check should be applied	No
approvalStatus	string	Approval status Enum: "APPROVED", "PENDING_FOR_APPROVAL", "EDITING", "REJECTED", "NOT_REQUIRED", "PULLED_BACK" Example: "APPROVED"	No
attachments	[ string ]	File attachments	No
backOrder	boolean	Backorder flag to indicate if purchase invoice is backorder	No
billTo	Address	Bill to address	No
buyerReference	string	Buyer reference	No
closedDate	string	Date on which the invoice was closed	No
cogsAmount	number	Cost of goods sold amount	No
contact	object	Contact details	No
contactCode	string	Contact Code	No
contactDto	object	Full contact details of the invoice's contact	No
createdBy	long	Identifier of the user who created the invoice	No
createdDate	string	Date on which the invoice was created	No
currency	string	Currency	No
customerType	string	India Compliance filed Enum: "EXPORT_WO_PAY", "EXPORT_W_PAY", "NA", "SEZ_WO_PAY", "SEZ_W_PAY"	No
customField	[ object ]	List of custom fields	No
documentSequenceCode	string	Purchase Invoice Code	No
draft	boolean	True if the invoice is saved as draft	No
dueAmount	number	Amount Due	No
emailStatus	string	Status of the last email sent for the invoice	No
exchangeRate	number	Exchange rate	No
gstExchangeRate	number	GST Exchange rate if tax residency currency is different than base currency	No
gstin	string	GST identification number	No
id	long	Purchase invoice id	No
isCreditable	boolean	True if the invoice is creditable	No
isPartialInvoice	boolean	True if is partial invoice	No
journalEntryCode	string	Journal Entry Code	No
knockoffInfo	[ object ]	Knock-off information linked to the invoice	No
landedCost	boolean	True if landed cost applies to the invoice	No
linkedDocuments	[ DocumentInfo ]	Linked Documents	No
manuallyClosed	boolean	True if the invoice was manually closed	No
memo	string	Memo	No
openingDocumentNumber	string	Vendor opening document number	No
openingInvoice	boolean	True if opening invoice	No
paymentDate	string	Date on which the invoice was paid	No
paymentMilestoneDetails	[ object ]	Payment milestone details for the invoice	No
paymentStatus	string	Payment status Enum: "PENDING", "PARTIAL", "RECEIVED"	No
payableAccountCode	string	Account code of contact's account payable	No
placeOfSupply	string	Place of supply	No
poNumber	string	Purchase order number	No
primaryExchangeRate	number	Primary exchange rate	No
purchaseInvoiceAccounts	[ PurchaseInvoiceAccountDetails ]	Purchase invoice account (expense/asset) line details	No
purchaseInvoiceAssets	[ PurchaseInvoiceAssetGroupDetails ]	Purchase invoice asset group details	No
purchaseInvoiceCode	string	Purchase invoice code	No
purchaseInvoiceDate	string	Purchase Invoice date	No
purchaseInvoiceDueDate	string	Purchase Invoice due date	No
purchaseInvoiceProducts	[ object ]	Purchase invoice item details	No
purchaseInvoiceRecurring	PurchaseInvoiceRecurringDetails	Purchase invoice recurring details	No
purchaseInvoiceType	string	Purchase invoice type Enum: "INVENTORY", "EXPENSE", "ASSET"	No
purchaseOrderRefNo	string	Contact PO reference number	No
printStatus	string	Print status of the invoice	No
rcmApplicable	boolean	True if RCM (Reverse Charge Mechanism) is applicable	No
rcmApplicableSA	boolean	True if RCM is applicable (Saudi Arabia)	No
receiptDate	string	Receipt date	No
receiptOn	string	Date on which the goods/services were received	No
receiptStatus	string	Receipt status Enum: "UNRECEIVED", "PARTIAL_RECEIVED", "FULLY_RECEIVED", "NOT_APPLICABLE", "IN_PROGRESS", "PENDING_FOR_APPROVAL"	No
receiveByDate	string	Receive by date	No
recurring	boolean	True if Invoice is recurring	No
recurringActivated	boolean	True if Invoice recurrence is active	No
revertPrintStatusBy	long	Identifier of the user who reverted the print status	No
revertPrintStatusOn	string	Date on which the print status was reverted	No
sequenceFormat	string	Sequence Format Id	No
shipFrom	Address	Ship from address	No
shipTo	Address	Ship to address	No
shortClosedStatus	string	Short-closed status Enum: "NONE", "PARTIALLY_SHORT_CLOSED", "FULLY_SHORT_CLOSED"	No
status	string	Invoice status Enum: "OPEN", "DRAFT", "CLOSED"	No
supplierInvoiceNo	string	Supplier invoice number	No
taxAmount	number	Tax amount	No
taxInvoiceNo	string	Tax invoice number	No
totalAmount	number	Total amount	No
totalTdsAmount	number	Total TDS amount	No
tdsProcessedFlag	boolean	True if TDS has been processed	No
unitPriceGstInclusive	boolean	Unit price is GST inclusive	No
vatPaidAtCustomSA	boolean	True if VAT was paid at customs (Saudi Arabia)	No
vendorType	string	India Compliance filed Enum: "IMPORT", "NA", "SEZ_W_PAY", "SEZ_WO_PAY"	No
whtRate	number	Withholding tax rate	No

ContraBillDto

Name	Type	Description	Required
id	long	Unique identifier of the contra bill.	No
code	string	Contra bill code.	No
jeCode	string	Journal Entry Code associated with the contra bill.	No
contactCode	string	Contact code.	No
billCode	string	Bill (purchase invoice) code being contra-adjusted.	No
documentDate	string	Document date of the contra bill.	No
amount	number	Contra amount.	No
amountInBaseCurrency	number	Contra amount in base currency.	No
exchangeRate	number	Exchange rate.	No
currency	string	Currency code.	No
contraBillItems	[ object ]	List of contra bill line items.	No

PurchaseInvoiceAccountDetails

Name	Type	Description	Required
accountCode	string	Account code for the expense/asset line.	No
accountName	string	Account name for the expense/asset line.	No
amount	number	Amount posted to the account.	No
description	string	Description of the account line.	No
taxCode	string	Tax code applied to the line.	No
taxAmount	number	Tax amount for the line.	No
customField	[ object ]	List of custom fields	No

PurchaseInvoiceRecurringDetails

Name	Type	Description	Required
id	long	Unique identifier for the recurring schedule.	No
recurrenceType	int	Every x Days/Weeks/Months.	No
recurrenceFrequency	string	Recurrence frequency. Enum: "DAYS", "WEEK", "MONTH"	No
invoiceRecurringCount	int	Number of invoices to be created.	No
recurrenceEndDate	string	Recurrence end date.	No

PurchaseInvoiceAssetGroupDetails

Name	Type	Description	Required
assetGroupCode	string	Asset group code.	No
assetGroupName	string	Asset group name.	No
quantity	number	Quantity of assets in the group.	No
amount	number	Amount allocated to the asset group.	No

PurchaseInvoiceProductDetails

Name	Type	Description	Required
id	long	Unique identifier for the item.	No
productCode	string	Product code Example: "P00001"	Yes
productDescription	string	Product description	No
productQuantity	number	Product quantity	Yes
uomQuantity	number	UOM quantity	No
uomUnitPrice	number	UOM unit price	No
documentUom	long	Document UOM id	No
documentUOMSchemaDefinition	object	Document UOM schema definition	No
unitPrice	number	Product unit price	Yes
discount	number	Discount	No
discountInPercent	boolean	Discount in percentage	No
preTaxGlobalDiscount	number	Pre-tax global discount applied to the item	No
taxCode	string	Tax code Example: "GST7"	No
taxAmount	number	Tax amount	No
tdsAccount	string	TDS account code	No
tdsId	long	TDS identifier	No
tdsRate	number	TDS rate	No
tdsAmount	number	TDS amount	No
totalAmount	number	Total amount	Yes
productOrder	integer	Product view order	No
purchaseInvoiceItemCode	string	Purchase invoice item code	No
purchaseOrderItemCode	string	Linked purchase order item code	No
product	object	Product details	No
tax	object	Tax details	No
customField	[ object ]	List of custom fields	No
advancedTrackingType	string	Advanced tracking type Enum: "NONE", "BATCH", "SERIAL"	No
taxDetails	[ object ]	Tax mapping details for the item	No
isPartialInvoice	boolean	Whether the item is a partial invoice item	No
linkedOrderItem	long	Identifier of the linked purchase order item	No
lineNumber	integer	Line number	No
receivedQuantityInOrder	number	Quantity received against the order	No
receivedQuantityInBills	number	Quantity received against bills	No
landedCostDetails	object	Landed cost details	No
additionalCharges	AdditionalCharges	Additional charges applied to the item	No
additionalChargeAmount	number	Additional charge amount	No
additionalChargeAmountCalculated	number	Calculated additional charge amount	No
additionalChargeTaxamount	number	Additional charge tax amount	No
additionalChargeTaxamountCalculated	number	Calculated additional charge tax amount	No
amortizationDocumentItemDetails	object	Amortization details for the item	No
itemDiscountMethod	string	Discount method applied to the item	No
expectedDeliveryDt	string	Expected delivery date	No
lineRefNo	string	Line reference number	No
userSetTaxes	boolean	True if taxes were manually set by the user	No
supplierPartNumber	string	Supplier part number	No
supplierPartName	string	Supplier part name	No
supplierPartDescription	string	Supplier part description	No
isShortClosed	boolean	True if the item is short closed	No
shortClosedQuantity	number	Quantity that was short closed	No
shortClosedNotes	string	Notes recorded when the item was short closed	No
isLocalizedUomQty	boolean	True if the UOM quantity is localized	No
localizedBaseQtyDiff	number	Difference in base quantity due to localization	No
unlocalizedDocumentUOMSchemaDefinition	object	Document UOM schema definition before localization	No
invoiceLineNumber	string	Invoice line number	No
additionalLineItemCost	number	Additional line item cost	No
discountLineItemCost	number	Discount line item cost	No
landedCostWeight	number	Landed cost weight of the item	No