Invoice APIs
An Invoice represents a sales form where the customer pays for a product or service later. In ERP, it will help you to keep track of all your invoices and establish an efficient cash-flow system for your business.
Once, you receive payment from your customer, you will update the information such as the payment type – bank or cash – into the invoice overview. This will helps you to sort out which payment types to focus on and organizes your invoices accordingly.
InvoiceDto helps you to create new invoice, retreive a particular invoice, update a partivular invoice, retrieve a list of all invoices.
More about Invoice API documentation
API
Search Invoice
Get invoices by filter criteria.More about search invoice
Description:
- Allows you to retrieve a list of all invoices.
- Allows you to retrieve specific invoices based on it's filter criteria.
GET
Invoice sales
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCodes | query | contactCodes | No | string |
| customfield | query | customfield | No | string |
| fetchAttachmentDetails | query | fetchAttachmentDetails | No | boolean |
| limit | query | limit | No | integer |
| page | query | page | No | integer |
| query | query | query | No | string |
| search | query | search | No | string |
| sort | query | sort | No | string |
| sortDir | query | sortDir | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoices have been fetched successfully. | SalesInvoiceResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Create Invoice
Create a new invoice. More about create invoice
Description:
- Allows you to create a new invoice.
POST
Invoice sales
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceRequest | body | salesInvoiceRequest | Yes | SalesInvoiceRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | SalesInvoiceResponse |
| 201 | Sales invoice has been created successfully. | SalesInvoiceResponse |
| 400 | Sales invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Update Invoice
Update invoice information. More about update invoice
Description:
- Allows you to update a specific invoice information.
PUT
Invoice sales/{id}
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
| salesInvoiceRequest | body | salesInvoiceRequest | Yes | SalesInvoiceRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales Invoice has been updated successfully. | SalesInvoiceResponse |
| 201 | Created | |
| 400 | Sales invoice draft status cannot be changed after saving | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales Invoice with given id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Retrieve Invoice
Get invoice by code. More about update invoice
Description:
- Allows you to retrieve an existing invoice details by it's code.
GET
Invoice sales/{code}
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoice information has been fetched successfully. | SalesInvoiceResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
invoice-controller
Invoice APIs
Invoice analyze-document
POST
Summary
Analyze document image/file
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| file | formData | file | Yes | file |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | AnalyzeDocumentResult |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice bulk-email
POST
Summary
Send invoices email.
Description
Send invoices as email.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| sendSalesInvoiceEmails | body | sendSalesInvoiceEmails | Yes | [ SendSalesInvoiceEmail ] |
Responses
| Code | Description |
|---|---|
| 200 | Emails sent successfully. |
| 201 | Created |
| 400 | Unable to send emails. |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice contacts
POST
Summary
Get Invoice for contact.
Description
Get Invoice with contact code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCodes | body | Contact Codes | No | [ string ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Get Invoice successfully. | object |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Invoice with given contact code not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice contacts/due
POST
Summary
Due amount for contacts report.
Description
API to fetch due amount for contacts.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCodes | body | Contact Codes | No | [ string ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Due amount for contacts report has been prepared. | object |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice count
GET
Summary
count invoices.
Description
API to count invoices.
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | object |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice custom-fields
GET
Summary
Get custom field is used or not
Description
API to Get custom field is used or not
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| customCode | query | customCode | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Custom fields status fetched successfully | boolean |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice demo/{tenantId}
POST
Summary
Create demo invoices.
Description
API to create demo invoices.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| country | query | country | No | string |
| tenantId | path | tenantId | Yes | long |
Responses
| Code | Description |
|---|---|
| 200 | OK |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice email
POST
Summary
Send invoice email.
Description
Send invoice email.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| sendSalesInvoiceEmail | body | sendSalesInvoiceEmail | Yes | SendSalesInvoiceEmail |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Email sent successfully. | SalesInvoiceResponse |
| 201 | Created | |
| 400 | Unable to send email. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice export/{type}
GET
Summary
Get Invoice export.
Description
Get Sales Invoices and Purchase Invoices.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCodes | query | contactCodes | No | string |
| customfield | query | customfield | No | string |
| limit | query | limit | No | integer |
| page | query | page | No | integer |
| query | query | query | No | string |
| search | query | search | No | string |
| sort | query | sort | No | string |
| sortDir | query | sortDir | No | string |
| type | path | type | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Get Invoice successfully. | [ InvoiceReportInfo ] |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice get-doc-seqs
GET
Summary
Get Existing Document Sequence codes
Description
Api to Get Existing Document Sequence codes
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Existing Document Sequence codes fetched successfully | object |
| 400 | Failed to fetch Existing Document Sequence codes | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice opening/contact-info
POST
Summary
Populate contact info for sales invoice
Description
Api to populate contact info for sales invoice
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | SalesInvoiceResponse |
| 201 | Sales invoice contact info has been populated successfully | SalesInvoiceResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice payment-link/{salesInvoiceCode}
GET
Summary
Get/Create payment link for invoice.
Description
Get/Create payment link for invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceCode | path | salesInvoiceCode | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Invoice payment link fetched successfully. | CustomerInvoiceDto |
| 400 | Error getting payment link for invoice. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice product-in-out-qty
GET
Summary
Find invoice data for Product in out qty
Description
API to Find invoice data for Product in out qty
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| productCode | query | productCode | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | [ ProductInOutQty ] |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Get Invoice Tax Report
GET
Invoice sales/us/tax-report
Summary
Sales tax report
Description
Sales tax report API
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| basis | query | basis | No | string |
| export | query | export | No | string |
| fromDate | query | fromDate | No | dateTime |
| region | query | region | No | string |
| toDate | query | toDate | No | dateTime |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | USA sales tax report has been calculated successfully. | UsaSalesTaxReport |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Get Invoices by Contact Code
GET
Invoice {contactCode}
Summary
Get Invoice for contact.
Description
Get Invoice with contact code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCode | path | contactCode | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Get Invoice successfully. | [ object ] |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Invoice with given contact code not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
india-e-invoice-controller
E-invoice APIs
Invoice in/e-invoice
GET
Summary
get Irn Values
Description
API to get Irn Values
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | query | id | No | long |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | IRN values have been fetched successfully. | string |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | IRN Values not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Get e-Invoice Auth Token
POST
Invoice in/e-invoice/auth-token
Summary
Get auth Token
Description
API to Get auth Token
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| irnAuthTokenRequestDto | body | irnAuthTokenRequestDto | No | IrnAuthTokenRequestDto |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Submitting Data is Successful | IrnAuthTokenResponseDto |
| 201 | Created | |
| 401 | Failed to submit data | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice in/e-invoice/cancel-irn-data
POST
Summary
Cancel Irn
Description
API to cancelIrn
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| irnRequestDto | body | irnRequestDto | No | IrnRequestCancelDto |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Canceling Data is Successful | EinvoiceInfoIndiaCancel |
| 201 | Created | |
| 401 | Failed to cancel data | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice in/e-invoice/failure-log-report
GET
Summary
eInvoice Failure Log Report
Description
API to get eInvoice failure log report
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| customfield | query | customfield | No | string |
| limit | query | limit | No | integer |
| page | query | page | No | integer |
| query | query | query | No | string |
| search | query | search | No | string |
| sort | query | sort | No | string |
| sortDir | query | sortDir | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Data have been fetched successfully. | boolean |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | E-Invoice failure log report data not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice in/e-invoice/irn-data
POST
Summary
Post Irn
Description
API to postIrn
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| irnRequestDto | body | irnRequestDto | No | IrnRequestDto |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Submitting Data is Successful | EinvoiceInfoIndia |
| 201 | Created | |
| 401 | Failed to submit data | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice in/e-invoice/irn-data-bulk
POST
Summary
Post Bulk Irn
Description
API to post Bulk Irn
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| irnRequestDto | body | irnRequestDto | No | IrnBulkRequestDto |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Submitting Data is Successful | BulkApiResponse |
| 201 | Created | |
| 401 | Failed to submit data | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice in/e-invoice/irn-data-bulk-cancel
POST
Summary
Cancel Bulk Irn
Description
API to Cancel Bulk Irn
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| irnRequestDto | body | irnRequestDto | No | IrnRequestBulkCancelDto |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Canceling Data is Successful | BulkApiResponse |
| 201 | Created | |
| 401 | Failed to cancel data | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice in/e-invoice/is-cancel-valid
GET
Summary
check invoice can be canceled or not
Description
API to check invoice can be canceled or not
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | query | id | No | long |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Data have been fetched successfully. | boolean |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | IRN Values not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
eway-controller
Eway Bill India APIs
Invoice in/eway
GET
Summary
Fetch Eway bill for current Tenant
Description
API to get Eway bills for current tenant
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Eway Bill has been fetched successfully. | EwayIndiaResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
POST
Summary
Create Eway bill
Description
API to create Eway bill
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| ewayIndiaRequest | body | ewayIndiaRequest | Yes | EwayIndiaRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | EwayIndiaResponse |
| 201 | Eway bill has been created successfully. | EwayIndiaResponse |
| 400 | Eway could not be created due to wrong data | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Get eWay Bill Auth Token
POST
Invoice in/eway/auth-token
Summary
Get auth Token
Description
API to Get auth Token
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| irnAuthTokenRequestDto | body | irnAuthTokenRequestDto | No | EWayBillAuthTokenRequestDto |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Submitting Data is Successful | EWayBillAuthTokenResponseDto |
| 201 | Created | |
| 401 | Failed to submit data | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice in/eway/bulk-generate-ewb
POST
Summary
Generate bulk eWay bill
Description
API to generate bulk eWay bill
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| bulkEwbRequestDto | body | bulkEwbRequestDto | No | BulkEwbRequestDto |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Submitting Data is Successful | BulkApiResponse |
| 201 | Created | |
| 401 | Failed to submit data | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice in/eway/cancel
PUT
Summary
Cancel Eway bill
Description
API to cancel Eway bill
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceCode | body | salesInvoiceCode | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | EwayIndiaResponse |
| 201 | Eway bill has been cancelled successfully. | EwayIndiaResponse |
| 400 | Eway could not be cancelled due to wrong data | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice in/eway/download
GET
Summary
Export Eway Json for current Tenant
Description
API to export Eway Json for current Tenant
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceCode | query | No | [ string ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Export Eway Json for current Tenant is successful | Resource |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice in/eway/ewb-report
GET
Summary
Search Eway Bill
Description
API to search Eway bills.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| fromDate | query | fromDate | No | dateTime |
| limit | query | limit | No | integer |
| page | query | page | No | integer |
| query | query | query | No | string |
| search | query | search | No | string |
| sort | query | sort | No | string |
| sortDir | query | sortDir | No | string |
| toDate | query | toDate | No | dateTime |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoices have been fetched successfully. | SalesInvoiceResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice in/eway/generate-ewb
POST
Summary
Generate eWay bill
Description
API to generate eWay bill
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| ewbRequestDto | body | ewbRequestDto | No | EwbRequestDto |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Submitting Data is Successful | EWayBillInfoIndia |
| 201 | Created | |
| 401 | Failed to submit data | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice in/eway/list/{contactCode}
GET
Summary
Get sales invoice by contact code.
Description
API to fetch sales invoice details by contact code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCode | path | contactCode | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoice information has been fetched successfully. | SalesInvoiceResponseIndia |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice in/eway/search
GET
Summary
Search Eway Bill
Description
API to search Eway bills.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| ewayBillStatus | query | ewayBillStatus | Yes | string |
| fromDate | query | fromDate | No | dateTime |
| limit | query | limit | No | integer |
| page | query | page | No | integer |
| query | query | query | No | string |
| search | query | search | No | string |
| sort | query | sort | No | string |
| sortDir | query | sortDir | No | string |
| toDate | query | toDate | No | dateTime |
| transactionType | query | transactionType | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoices have been fetched successfully. | SalesInvoiceResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice in/eway/update
PUT
Summary
Update Eway bill attributes
Description
API to update Eway bill
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| ewayIndiaRequest | body | ewayIndiaRequest | Yes | EwayIndiaRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | EwayIndiaResponse |
| 201 | Eway bill has been updated successfully. | EwayIndiaResponse |
| 400 | Eway could not be updated due to wrong data | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice in/eway/{salesInvoiceCode}
GET
Summary
Fetch Eway bill by Sales Invoice Code
Description
API to get Eway bill by sales invoice code
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceCode | path | salesInvoiceCode | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Eway Bill has been fetched successfully. | EwayIndiaResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
payment-milestone-controller
Payment milestone APIs
Invoice paymentmilestone
POST
Summary
Create new Payment milestone.
Description
API to create new Payment milestone.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| paymentMilestoneDetails | body | paymentMilestoneDetails | Yes | [ PaymentMilestoneDetailsRequest ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | PaymentMilestoneDetailsResponse |
| 201 | Payment milestone has been created successfully. | PaymentMilestoneDetailsResponse |
| 400 | Payment milestone creation failed because of insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice paymentmilestone/byDocumentType
GET
Summary
Get payment milestone by document type.
Description
API to get existing payment milestones.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| documentType | query | documentType | Yes | string |
| limit | query | limit | No | integer |
| page | query | page | No | integer |
| paymentStatus | query | paymentStatus | Yes | string |
| sort | query | sort | No | string |
| sortDir | query | sortDir | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Payment milestone have been fetched successfully. | Page«PaymentMilestoneDetailsResponse» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice paymentmilestone/details/{documentCode}
GET
Summary
Get payment milestone details by document code and document type.
Description
Payment milestone details have been fetched successfully.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| documentCode | path | documentCode | Yes | string |
| documentType | query | documentType | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | API to get payment milestone details by document code and document type. | [ PaymentMilestoneDetailsResponse ] |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice paymentmilestone/report/tracker/details
GET
Summary
Get payment milestone tracker details report.
Description
API to payment milestone tracker details report.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| ? | query | ? | No | string |
| fromDate | query | fromDate | Yes | dateTime |
| search | query | search | No | string |
| sort | query | sort | No | string |
| sortDir | query | sortDir | No | string |
| toDate | query | toDate | Yes | dateTime |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Payment milestone tracker details report have been fetched successfully. | [ PaymentMilestoneTrackerDetailsReport ] |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice paymentmilestone/report/tracker/summary
GET
Summary
Get payment milestone tracker summary report.
Description
API to payment milestone tracker summary report.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| ? | query | ? | No | string |
| fromDate | query | fromDate | Yes | dateTime |
| search | query | search | No | string |
| sort | query | sort | No | string |
| sortDir | query | sortDir | No | string |
| toDate | query | toDate | Yes | dateTime |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Payment milestone tracker summary report have been fetched successfully. | [ PaymentMilestoneTrackerSummaryReport ] |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice paymentmilestone/search
GET
Summary
Search payment milestone.
Description
API to search existing payment milestones.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| limit | query | limit | No | integer |
| page | query | page | No | integer |
| query | query | query | No | string |
| search | query | search | No | string |
| sort | query | sort | No | string |
| sortDir | query | sortDir | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Payment milestone have been fetched successfully. | Page«PaymentMilestoneDetailsResponse» |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice paymentmilestone/{documentCode}
PUT
Summary
Update existing Payment milestone.
Description
API to update existing Payment milestone.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| documentCode | path | documentCode | Yes | string |
| paymentMilestoneDetails | body | paymentMilestoneDetails | Yes | [ PaymentMilestoneDetailsRequest ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Payment milestone has been updated successfully. | PaymentMilestoneDetailsResponse |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Payment milestone with code not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
DELETE
Summary
Delete Payment milestone.
Description
API to delete existing Payment milestone.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| documentCode | path | documentCode | Yes | string |
| documentType | body | documentType | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | ResponseEntity |
| 204 | Payment milestone has been deleted successfully. | ResponseEntity |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Payment milestone with code not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
purchase-invoice-controller
Purchase Invoice APIs
Invoice purchase
GET
Summary
Search purchase invoices.
Description
API to search purchase invoices.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| customfield | query | customfield | No | string |
| fetchAttachmentDetails | query | fetchAttachmentDetails | No | boolean |
| limit | query | limit | No | integer |
| page | query | page | No | integer |
| query | query | query | No | string |
| search | query | search | No | string |
| sort | query | sort | No | string |
| sortDir | query | sortDir | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoices have been fetched successfully. | PurchaseInvoiceResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
POST
Summary
Create purchase invoice
Description
API to create purchase invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| purchaseInvoiceRequest | body | purchaseInvoiceRequest | Yes | PurchaseInvoiceRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | PurchaseInvoiceResponse |
| 201 | Purchase invoice has been created successfully. | PurchaseInvoiceResponse |
| 400 | Purchase invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
PUT
Summary
Update purchase invoice attributes by code.
Description
API to update attributes of existing purchase invoice by code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | query | code | Yes | string |
| request | body | request | Yes | PurchaseInvoiceUpdateRequest |
Responses
| Code | Description |
|---|---|
| 200 | Purchase invoice attributes has been updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Purchase invoice with given code not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
DELETE
Summary
Delete purchase invoices by ids in bulk.
Description
API to delete purchase invoices in bulk.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| ids | body | ids | Yes | [ long ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | BulkResponse |
| 204 | No Content | |
| 207 | Request processed successfully. | BulkResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase invoices not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/approval-status
POST
Summary
Update approval status
Description
API to update approval status
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| approvalStatusRequestDtoList | body | approvalStatusRequestDtoList | Yes | [ ApprovalStatusRequestDto ] |
Responses
| Code | Description |
|---|---|
| 200 | Approval status for Sales documents have been updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/asset-group-count/{id}
GET
Summary
Get asset group used count.
Description
Api to get asset group used count.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Asset group used count fetched successfully. | integer |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Asset group used count not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/bulk
POST
Summary
Create multiple sales invoice
Description
API to create sales invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| purchaseInvoiceRequests | body | purchaseInvoiceRequests | Yes | [ PurchaseInvoiceRequest ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | PurchaseInvoiceResponse |
| 201 | Sales invoice has been created successfully. | PurchaseInvoiceResponse |
| 400 | Sales invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/bulk-delete
DELETE
Summary
Bulk Delete purchase invoices.
Description
API to Bulk Delete purchase invoices.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| ids | body | ids | Yes | [ long ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | [ BulkDeletePurchaseInvoiceResponse ] |
| 204 | Purchase invoice has been deleted successfully. | [ BulkDeletePurchaseInvoiceResponse ] |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/bulk-details
POST
Summary
Purchase invoice details by codes
Description
Purchase invoice details by codes
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| codes | body | codes | Yes | [ string ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | [ PurchaseInvoiceInformation ] |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/bulk-update-purchase-invoice
PATCH
Summary
Update purchase invoices
Description
API to Update purchase invoices
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| purchaseInvoiceFields | body | purchaseInvoiceFields | Yes | [ Map«string,string» ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | [ BulkPurchaseInvoiceUpdateResponse ] |
| 204 | No Content | |
| 207 | Purchase invoices updated successfully. | [ BulkPurchaseInvoiceUpdateResponse ] |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales Invoice with given id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/bulk/codes
POST
Summary
Get multiple purchase invoices
Description
API to get purchase invoices.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| codes | body | codes | Yes | [ string ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase documents have been fetched successfully. | PurchaseInvoiceResponse |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/code/{code}
GET
Summary
Get purchase invoice by code.
Description
API to fetch purchase invoice details by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoice information has been fetched successfully. | PurchaseInvoiceResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/code/{code}/details
GET
Summary
Purchase invoice details by codes
Description
Purchase invoice details by codes
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | PurchaseInvoiceInformation |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/codes
POST
Summary
Get Invoice information by codes.
Description
API to get invoice document information by codes.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| codes | body | codes | Yes | [ string ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Invoice documents have been fetched successfully. | [ PurchaseDocument ] |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/contrabill
POST
Summary
Bill contra adjustment.
Description
API to contra adjustment for bill of contact.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contraBillDto | body | contraBillDto | Yes | ContraBillDto |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | ContraBillDto |
| 201 | Contra adjustment for bill has been done successfully. | ContraBillDto |
| 400 | Contra adjustment for bill has been failed because of insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
DELETE
Summary
Bill contra adjustment.
Description
API to contra adjustment for bill of contact.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contraCode | query | contraCode | Yes | string |
| salesInvoiceCode | query | salesInvoiceCode | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | ContraBillDto |
| 201 | Contra adjustment for bill has been done successfully. | ContraBillDto |
| 204 | No Content | |
| 400 | Contra adjustment for bill has been failed because of insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/create-recurring
POST
Summary
Create a recurring invoice
Description
API to create a recurring invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| event | body | event | Yes | RecurringJobEvent |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | PurchaseInvoiceResponse |
| 201 | Recurring invoice created successfully | PurchaseInvoiceResponse |
| 400 | Error while creating recurring invoice | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/documentseqcode
POST
Summary
Get purchase invoice by code.
Description
API to fetch purchase invoice details by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| codes | body | codes | Yes | [ string ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoice information has been fetched successfully. | PurchaseInvoiceResponse |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/draft/trigger
POST
Summary
Create approval status trigger
Description
API to reate approval status trigger
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| triggerKafkaRequestDto | body | triggerKafkaRequestDto | Yes | TriggerKafkaRequestDto |
Responses
| Code | Description |
|---|---|
| 200 | Trigger created for approval status |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/due-amount
PUT
Summary
Update due amount for purchase invoices in bulk.
Description
API to update due amount for purchase invoices in bulk.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| invoiceUpdateAmountDueDtoList | body | invoiceUpdateAmountDueDtoList | Yes | [ InvoiceUpdateAmountDueDto ] |
| revert | query | revert | Yes | boolean |
Responses
| Code | Description |
|---|---|
| 200 | Due amounts updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Purchase invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/due-amount-bulk-payment-delete
PUT
Summary
Update due amount for purchase invoices in bulk payment delete.
Description
API to update due amount for purchase invoices in bulk payment delete.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| invoiceUpdateAmountDueDtoList | body | invoiceUpdateAmountDueDtoList | Yes | [ InvoiceUpdateAmountDueDto ] |
Responses
| Code | Description |
|---|---|
| 200 | Due amounts updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Purchase invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/es/{contactCode}
GET
Summary
Get Invoice for contact.
Description
Get Invoice with contact code from ES.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCode | path | contactCode | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Get Invoice successfully. | PurchaseInvoiceResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Invoice with given contact code not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/journal
POST
Summary
Recreate Journal Entries for all Purchase Invoices
Description
API to recreate Journal Entries for all Purchase Invoices.
Responses
| Code | Description |
|---|---|
| 200 | Journal Entries for all Purchase Invoices recreated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/linked-docs/product-codes
POST
Summary
Get products by code
Description
API to Get products by code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| productCodes | body | productCodes | Yes | [ string ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Product information has been fetched successfully. | string |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Products not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/linked-order/{code}
GET
Summary
Get purchase invoices linked to an order by code.
Description
API to fetch purchase invoices linked to an order by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoices has been fetched successfully. | PurchaseInvoiceResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/linked-orders
POST
Summary
Get purchase invoices linked to an order by code.
Description
API to fetch purchase invoices linked to an order by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| codes | body | codes | Yes | [ string ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoices has been fetched successfully. | PurchaseInvoiceResponse |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/linked/status/{code}
PUT
Summary
refreshLinkedPIStatus
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description |
|---|---|
| 200 | OK |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/notes
DELETE
Summary
Delete sales invoice by id.
Description
API to delete sales invoice details by id.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | query | code | Yes | string |
| invoicecode | query | invoicecode | Yes | string |
| uid | query | uid | Yes | string (uuid) |
Responses
| Code | Description |
|---|---|
| 200 | OK |
| 204 | Sales invoice has been deleted successfully. |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Sales invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/payment
DELETE
Summary
Delete Payment
Description
API to Delete Payment
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| paymentCode | query | paymentCode | Yes | string |
| purchaseInvoiceCode | query | purchaseInvoiceCode | Yes | string |
| uid | query | uid | No | string (uuid) |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | API to Delete Payment | PurchaseInvoiceResponse |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/pendingpaymentbillcode
GET
Summary
Get purchase invoice by code for Pending Payment.
Description
API to Get purchase invoice by code for Pending Payment.
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoice information has been fetched successfully. | string |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/purchase/receipt
DELETE
Summary
API to Delete Goods Receipt
Description
API to Delete Goods Receipt
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| goodsReceiptCode | query | goodsReceiptCode | Yes | string |
| isBulkDeleted | query | isBulkDeleted | No | boolean |
| purchaseInvoiceCode | query | purchaseInvoiceCode | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | API to Delete Goods Receipt | PurchaseInvoiceResponse |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/record-filter
POST
Summary
Create approval status trigger
Description
API to reate approval status trigger
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| filterRecord | body | filterRecord | Yes | FilterRecord |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Trigger created for approval status | boolean |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/report/count
POST
Summary
Get purchase invoice count for contacts
Description
API to fetch purchase invoice count for contacts
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCodes | body | contactCodes | Yes | [ string ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Contact purchase invoice count has been fetched. | object |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/report/overview
GET
Summary
Purchase invoice overview report data.
Description
API to fetch purchase invoice overview report data
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCode | query | contactCode | No | string |
| interval | query | interval | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoice overview report has been prepared. | InvoiceOverviewReport |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/report/unpaid
GET
Summary
Unpaid purchase invoices report.
Description
API to fetch unpaid purchase invoices
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Unpaid purchase invoices report has been prepared. | DashboardReportData |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/set-recurring
POST
Summary
Set an invoice to recurring
Description
API to set and invoice to recurring.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| setRecurringDto | body | setRecurringDto | Yes | SetRecurringDto |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Invoice set to recur successfully | PurchaseInvoiceResponse |
| 201 | Created | |
| 400 | Error while setting invoice to recur | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/status/{code}
PUT
Summary
refreshPIStatus
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description |
|---|---|
| 200 | OK |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/stockQuantities
POST
Summary
Get purchase invoice stock quantities
Description
API to get purchase invoice stock quantities
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| request | body | request | Yes | StockQuantitiesRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Fetched purchase invoice stock quantities successfully. | StockQuantitiesResponse |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/tax/count
POST
Summary
Get purchase invoice count for tax
Description
API to fetch purchase invoice count for tax
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| taxCodes | body | taxCodes | Yes | [ string ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Tax purchase invoice count has been fetched. | object |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/unreceived-seq-codes
GET
Summary
Get Unfulfilled purchase invoices codes
Description
Get Unfulfilled purchase invoices codes
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoice information has been fetched successfully. | [ object ] |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/update-knock-off
POST
Summary
Update knock off information
Description
Api to update knock off information
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| knockOffInfos | body | knockOffInfos | Yes | object |
Responses
| Code | Description |
|---|---|
| 200 | Knock off information updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/{code}
GET
Summary
Get purchase invoice by code.
Description
API to fetch purchase invoice details by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoice information has been fetched successfully. | PurchaseInvoiceResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/{code}/asset-details
POST
Summary
Save Assets details for purchase invoice
Description
API to save Assets details for purchase invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| assetRequests | body | assetRequests | Yes | [ AssetRequest ] |
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Asset details for purchase invoice saved successfully. | BulkApiResponse |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Api to save asset details for purchase invoice failed. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/{id}
PUT
Summary
Update purchase invoice.
Description
API to update existing purchase invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
| purchaseInvoiceRequest | body | purchaseInvoiceRequest | Yes | PurchaseInvoiceRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase Invoice has been updated successfully. | PurchaseInvoiceResponse |
| 201 | Created | |
| 400 | Purchase invoice draft status cannot be changed after saving | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase Invoice with given id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
DELETE
Summary
Delete purchase invoice by id.
Description
API to delete purchase invoice details by id.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
Responses
| Code | Description |
|---|---|
| 200 | OK |
| 204 | Purchase invoice has been deleted successfully. |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Purchase invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
PATCH
Summary
Update purchase invoice memo or attachment
Description
API to update purchase invoice memo or attachment
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
| purchaseInvoiceFields | body | purchaseInvoiceFields | Yes | object |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Memo/attachment for purchase invoice updated successfully. | PurchaseInvoiceResponse |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase Invoice with id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
purchase-invoice-controller-uae
Purchase Invoice APIs for UAE
Invoice purchase/ae
GET
Summary
Search purchase invoices.
Description
API to search purchase invoices.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| customfield | query | customfield | No | string |
| limit | query | limit | No | integer |
| page | query | page | No | integer |
| query | query | query | No | string |
| search | query | search | No | string |
| sort | query | sort | No | string |
| sortDir | query | sortDir | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoices have been fetched successfully. | PurchaseInvoiceResponseUae |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
POST
Summary
Create purchase invoice
Description
API to create purchase invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| purchaseInvoiceRequest | body | purchaseInvoiceRequest | Yes | PurchaseInvoiceRequestUae |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | PurchaseInvoiceResponseUae |
| 201 | Purchase invoice has been created successfully. | PurchaseInvoiceResponseUae |
| 400 | Purchase invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
PUT
Summary
Update purchase invoice attributes by code.
Description
API to update attributes of existing purchase invoice by code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | query | code | Yes | string |
| request | body | request | Yes | PurchaseInvoiceUpdateRequest |
Responses
| Code | Description |
|---|---|
| 200 | Purchase invoice attributes has been updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Purchase invoice with given code not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
DELETE
Summary
Delete purchase invoices by ids in bulk.
Description
API to delete purchase invoices in bulk.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| ids | body | ids | Yes | [ long ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | BulkResponse |
| 204 | No Content | |
| 207 | Request processed successfully. | BulkResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase invoices not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/ae/bulk
POST
Summary
Create multiple sales invoice
Description
API to create sales invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| purchaseInvoiceRequests | body | purchaseInvoiceRequests | Yes | [ PurchaseInvoiceRequestUae ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | PurchaseInvoiceResponseUae |
| 201 | Sales invoice has been created successfully. | PurchaseInvoiceResponseUae |
| 400 | Sales invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/ae/code/{code}/details
GET
Summary
Purchase invoice details by codes
Description
Purchase invoice details by codes
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | PurchaseInvoiceInformation |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/ae/due-amount
PUT
Summary
Update due amount for purchase invoices in bulk.
Description
API to update due amount for purchase invoices in bulk.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| invoiceUpdateAmountDueDtoList | body | invoiceUpdateAmountDueDtoList | Yes | [ InvoiceUpdateAmountDueDto ] |
| revert | query | revert | Yes | boolean |
Responses
| Code | Description |
|---|---|
| 200 | Due amounts updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Purchase invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/ae/es/{contactCode}
GET
Summary
Get Invoice for contact.
Description
Get Invoice with contact code from ES.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCode | path | contactCode | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Get Invoice successfully. | PurchaseInvoiceResponseUae |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Invoice with given contact code not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/ae/linked-order/{code}
GET
Summary
Get purchase invoices linked to an order by code.
Description
API to fetch purchase invoices linked to an order by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoices has been fetched successfully. | PurchaseInvoiceResponseUae |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/ae/report/count
POST
Summary
Get purchase invoice count for contacts
Description
API to fetch purchase invoice count for contacts
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCodes | body | contactCodes | Yes | [ string ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Contact purchase invoice count has been fetched. | object |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/ae/report/overview
GET
Summary
Purchase invoice overview report data.
Description
API to fetch purchase invoice overview report data
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCode | query | contactCode | No | string |
| interval | query | interval | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoice overview report has been prepared. | InvoiceOverviewReport |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/ae/report/unpaid
GET
Summary
Unpaid purchase invoices report.
Description
API to fetch unpaid purchase invoices
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Unpaid purchase invoices report has been prepared. | DashboardReportData |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/ae/{code}
GET
Summary
Get purchase invoice by code.
Description
API to fetch purchase invoice details by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoice information has been fetched successfully. | PurchaseInvoiceResponseUae |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/ae/{id}
PUT
Summary
Update purchase invoice.
Description
API to update existing purchase invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
| purchaseInvoiceRequest | body | purchaseInvoiceRequest | Yes | PurchaseInvoiceRequestUae |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase Invoice has been updated successfully. | PurchaseInvoiceResponseUae |
| 201 | Created | |
| 400 | Purchase invoice draft status cannot be changed after saving | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase Invoice with given id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
DELETE
Summary
Delete purchase invoice by id.
Description
API to delete purchase invoice details by id.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
Responses
| Code | Description |
|---|---|
| 200 | OK |
| 204 | Purchase invoice has been deleted successfully. |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Purchase invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
PATCH
Summary
Update purchase invoice memo or attachment
Description
API to update purchase invoice memo or attachment
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
| purchaseInvoiceFields | body | purchaseInvoiceFields | Yes | object |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Memo/attachment for purchase invoice updated successfully. | PurchaseInvoiceResponseUae |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase Invoice with id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
purchase-invoice-controller-australia
Purchase Invoice APIs for Australia.
Invoice purchase/au
GET
Summary
Search purchase invoices.
Description
API to search purchase invoices.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| customfield | query | customfield | No | string |
| limit | query | limit | No | integer |
| page | query | page | No | integer |
| query | query | query | No | string |
| search | query | search | No | string |
| sort | query | sort | No | string |
| sortDir | query | sortDir | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoices have been fetched successfully. | PurchaseInvoiceResponseAustralia |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
POST
Summary
Create purchase invoice
Description
API to create purchase invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| purchaseInvoiceRequest | body | purchaseInvoiceRequest | Yes | PurchaseInvoiceRequestAustralia |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | PurchaseInvoiceResponseAustralia |
| 201 | Purchase invoice has been created successfully. | PurchaseInvoiceResponseAustralia |
| 400 | Purchase invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
PUT
Summary
Update purchase invoice attributes by code.
Description
API to update attributes of existing purchase invoice by code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | query | code | Yes | string |
| request | body | request | Yes | PurchaseInvoiceUpdateRequest |
Responses
| Code | Description |
|---|---|
| 200 | Purchase invoice attributes has been updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Purchase invoice with given code not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
DELETE
Summary
Delete purchase invoices by ids in bulk.
Description
API to delete purchase invoices in bulk.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| ids | body | ids | Yes | [ long ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | BulkResponse |
| 204 | No Content | |
| 207 | Request processed successfully. | BulkResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase invoices not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/au/bulk
POST
Summary
Create multiple sales invoice
Description
API to create sales invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| purchaseInvoiceRequests | body | purchaseInvoiceRequests | Yes | [ PurchaseInvoiceRequestAustralia ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | PurchaseInvoiceResponseAustralia |
| 201 | Sales invoice has been created successfully. | PurchaseInvoiceResponseAustralia |
| 400 | Sales invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/au/code/{code}/details
GET
Summary
Purchase invoice details by codes
Description
Purchase invoice details by codes
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | PurchaseInvoiceInformation |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/au/due-amount
PUT
Summary
Update due amount for purchase invoices in bulk.
Description
API to update due amount for purchase invoices in bulk.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| invoiceUpdateAmountDueDtoList | body | invoiceUpdateAmountDueDtoList | Yes | [ InvoiceUpdateAmountDueDto ] |
| revert | query | revert | Yes | boolean |
Responses
| Code | Description |
|---|---|
| 200 | Due amounts updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Purchase invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/au/es/{contactCode}
GET
Summary
Get Invoice for contact.
Description
Get Invoice with contact code from ES.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCode | path | contactCode | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Get Invoice successfully. | PurchaseInvoiceResponseAustralia |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Invoice with given contact code not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/au/linked-order/{code}
GET
Summary
Get purchase invoices linked to an order by code.
Description
API to fetch purchase invoices linked to an order by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoices has been fetched successfully. | PurchaseInvoiceResponseAustralia |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/au/report/count
POST
Summary
Get purchase invoice count for contacts
Description
API to fetch purchase invoice count for contacts
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCodes | body | contactCodes | Yes | [ string ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Contact purchase invoice count has been fetched. | object |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/au/report/overview
GET
Summary
Purchase invoice overview report data.
Description
API to fetch purchase invoice overview report data
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCode | query | contactCode | No | string |
| interval | query | interval | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoice overview report has been prepared. | InvoiceOverviewReport |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/au/report/unpaid
GET
Summary
Unpaid purchase invoices report.
Description
API to fetch unpaid purchase invoices
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Unpaid purchase invoices report has been prepared. | DashboardReportData |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/au/{code}
GET
Summary
Get purchase invoice by code.
Description
API to fetch purchase invoice details by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoice information has been fetched successfully. | PurchaseInvoiceResponseAustralia |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/au/{id}
PUT
Summary
Update purchase invoice.
Description
API to update existing purchase invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
| purchaseInvoiceRequest | body | purchaseInvoiceRequest | Yes | PurchaseInvoiceRequestAustralia |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase Invoice has been updated successfully. | PurchaseInvoiceResponseAustralia |
| 201 | Created | |
| 400 | Purchase invoice draft status cannot be changed after saving | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase Invoice with given id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
DELETE
Summary
Delete purchase invoice by id.
Description
API to delete purchase invoice details by id.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
Responses
| Code | Description |
|---|---|
| 200 | OK |
| 204 | Purchase invoice has been deleted successfully. |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Purchase invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
PATCH
Summary
Update purchase invoice memo or attachment
Description
API to update purchase invoice memo or attachment
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
| purchaseInvoiceFields | body | purchaseInvoiceFields | Yes | object |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Memo/attachment for purchase invoice updated successfully. | PurchaseInvoiceResponseAustralia |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase Invoice with id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
purchase-invoice-controller-belgium
Purchase Invoice APIs for Belgium
Invoice purchase/be
GET
Summary
Search purchase invoices.
Description
API to search purchase invoices.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| customfield | query | customfield | No | string |
| limit | query | limit | No | integer |
| page | query | page | No | integer |
| query | query | query | No | string |
| search | query | search | No | string |
| sort | query | sort | No | string |
| sortDir | query | sortDir | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoices have been fetched successfully. | PurchaseInvoiceResponseAustralia |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
POST
Summary
Create purchase invoice
Description
API to create purchase invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| purchaseInvoiceRequest | body | purchaseInvoiceRequest | Yes | PurchaseInvoiceRequestAustralia |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | PurchaseInvoiceResponseAustralia |
| 201 | Purchase invoice has been created successfully. | PurchaseInvoiceResponseAustralia |
| 400 | Purchase invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
PUT
Summary
Update purchase invoice attributes by code.
Description
API to update attributes of existing purchase invoice by code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | query | code | Yes | string |
| request | body | request | Yes | PurchaseInvoiceUpdateRequest |
Responses
| Code | Description |
|---|---|
| 200 | Purchase invoice attributes has been updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Purchase invoice with given code not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
DELETE
Summary
Delete purchase invoices by ids in bulk.
Description
API to delete purchase invoices in bulk.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| ids | body | ids | Yes | [ long ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | BulkResponse |
| 204 | No Content | |
| 207 | Request processed successfully. | BulkResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase invoices not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/be/bulk
POST
Summary
Create multiple sales invoice
Description
API to create sales invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| purchaseInvoiceRequests | body | purchaseInvoiceRequests | Yes | [ PurchaseInvoiceRequestAustralia ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | PurchaseInvoiceResponseAustralia |
| 201 | Sales invoice has been created successfully. | PurchaseInvoiceResponseAustralia |
| 400 | Sales invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/be/code/{code}/details
GET
Summary
Purchase invoice details by codes
Description
Purchase invoice details by codes
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | PurchaseInvoiceInformation |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/be/due-amount
PUT
Summary
Update due amount for purchase invoices in bulk.
Description
API to update due amount for purchase invoices in bulk.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| invoiceUpdateAmountDueDtoList | body | invoiceUpdateAmountDueDtoList | Yes | [ InvoiceUpdateAmountDueDto ] |
| revert | query | revert | Yes | boolean |
Responses
| Code | Description |
|---|---|
| 200 | Due amounts updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Purchase invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/be/es/{contactCode}
GET
Summary
Get Invoice for contact.
Description
Get Invoice with contact code from ES.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCode | path | contactCode | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Get Invoice successfully. | PurchaseInvoiceResponseAustralia |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Invoice with given contact code not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/be/linked-order/{code}
GET
Summary
Get purchase invoices linked to an order by code.
Description
API to fetch purchase invoices linked to an order by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoices has been fetched successfully. | PurchaseInvoiceResponseAustralia |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/be/report/count
POST
Summary
Get purchase invoice count for contacts
Description
API to fetch purchase invoice count for contacts
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCodes | body | contactCodes | Yes | [ string ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Contact purchase invoice count has been fetched. | object |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/be/report/overview
GET
Summary
Purchase invoice overview report data.
Description
API to fetch purchase invoice overview report data
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCode | query | contactCode | No | string |
| interval | query | interval | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoice overview report has been prepared. | InvoiceOverviewReport |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/be/report/unpaid
GET
Summary
Unpaid purchase invoices report.
Description
API to fetch unpaid purchase invoices
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Unpaid purchase invoices report has been prepared. | DashboardReportData |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/be/{code}
GET
Summary
Get purchase invoice by code.
Description
API to fetch purchase invoice details by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoice information has been fetched successfully. | PurchaseInvoiceResponseAustralia |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/be/{id}
PUT
Summary
Update purchase invoice.
Description
API to update existing purchase invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
| purchaseInvoiceRequest | body | purchaseInvoiceRequest | Yes | PurchaseInvoiceRequestAustralia |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase Invoice has been updated successfully. | PurchaseInvoiceResponseAustralia |
| 201 | Created | |
| 400 | Purchase invoice draft status cannot be changed after saving | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase Invoice with given id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
DELETE
Summary
Delete purchase invoice by id.
Description
API to delete purchase invoice details by id.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
Responses
| Code | Description |
|---|---|
| 200 | OK |
| 204 | Purchase invoice has been deleted successfully. |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Purchase invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
PATCH
Summary
Update purchase invoice memo or attachment
Description
API to update purchase invoice memo or attachment
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
| purchaseInvoiceFields | body | purchaseInvoiceFields | Yes | object |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Memo/attachment for purchase invoice updated successfully. | PurchaseInvoiceResponseAustralia |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase Invoice with id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
purchase-invoice-controller-canada
Purchase Invoice APIs for Canada.
Invoice purchase/ca
GET
Summary
Search purchase invoices.
Description
API to search purchase invoices.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| customfield | query | customfield | No | string |
| limit | query | limit | No | integer |
| page | query | page | No | integer |
| query | query | query | No | string |
| search | query | search | No | string |
| sort | query | sort | No | string |
| sortDir | query | sortDir | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoices have been fetched successfully. | PurchaseInvoiceResponseCanada |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
POST
Summary
Create purchase invoice
Description
API to create purchase invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| purchaseInvoiceRequest | body | purchaseInvoiceRequest | Yes | PurchaseInvoiceRequestCanada |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | PurchaseInvoiceResponseCanada |
| 201 | Purchase invoice has been created successfully. | PurchaseInvoiceResponseCanada |
| 400 | Purchase invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
PUT
Summary
Update purchase invoice attributes by code.
Description
API to update attributes of existing purchase invoice by code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | query | code | Yes | string |
| request | body | request | Yes | PurchaseInvoiceUpdateRequest |
Responses
| Code | Description |
|---|---|
| 200 | Purchase invoice attributes has been updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Purchase invoice with given code not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
DELETE
Summary
Delete purchase invoices by ids in bulk.
Description
API to delete purchase invoices in bulk.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| ids | body | ids | Yes | [ long ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | BulkResponse |
| 204 | No Content | |
| 207 | Request processed successfully. | BulkResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase invoices not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/ca/bulk
POST
Summary
Create multiple sales invoice
Description
API to create sales invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| purchaseInvoiceRequests | body | purchaseInvoiceRequests | Yes | [ PurchaseInvoiceRequestCanada ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | PurchaseInvoiceResponseCanada |
| 201 | Sales invoice has been created successfully. | PurchaseInvoiceResponseCanada |
| 400 | Sales invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/ca/code/{code}/details
GET
Summary
Purchase invoice details by codes
Description
Purchase invoice details by codes
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | PurchaseInvoiceInformation |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/ca/due-amount
PUT
Summary
Update due amount for purchase invoices in bulk.
Description
API to update due amount for purchase invoices in bulk.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| invoiceUpdateAmountDueDtoList | body | invoiceUpdateAmountDueDtoList | Yes | [ InvoiceUpdateAmountDueDto ] |
| revert | query | revert | Yes | boolean |
Responses
| Code | Description |
|---|---|
| 200 | Due amounts updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Purchase invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/ca/es/{contactCode}
GET
Summary
Get Invoice for contact.
Description
Get Invoice with contact code from ES.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCode | path | contactCode | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Get Invoice successfully. | PurchaseInvoiceResponseCanada |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Invoice with given contact code not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/ca/linked-order/{code}
GET
Summary
Get purchase invoices linked to an order by code.
Description
API to fetch purchase invoices linked to an order by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoices has been fetched successfully. | PurchaseInvoiceResponseCanada |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/ca/report/count
POST
Summary
Get purchase invoice count for contacts
Description
API to fetch purchase invoice count for contacts
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCodes | body | contactCodes | Yes | [ string ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Contact purchase invoice count has been fetched. | object |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/ca/report/overview
GET
Summary
Purchase invoice overview report data.
Description
API to fetch purchase invoice overview report data
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCode | query | contactCode | No | string |
| interval | query | interval | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoice overview report has been prepared. | InvoiceOverviewReport |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/ca/report/unpaid
GET
Summary
Unpaid purchase invoices report.
Description
API to fetch unpaid purchase invoices
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Unpaid purchase invoices report has been prepared. | DashboardReportData |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/ca/{code}
GET
Summary
Get purchase invoice by code.
Description
API to fetch purchase invoice details by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoice information has been fetched successfully. | PurchaseInvoiceResponseCanada |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/ca/{id}
PUT
Summary
Update purchase invoice.
Description
API to update existing purchase invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
| purchaseInvoiceRequest | body | purchaseInvoiceRequest | Yes | PurchaseInvoiceRequestCanada |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase Invoice has been updated successfully. | PurchaseInvoiceResponseCanada |
| 201 | Created | |
| 400 | Purchase invoice draft status cannot be changed after saving | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase Invoice with given id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
DELETE
Summary
Delete purchase invoice by id.
Description
API to delete purchase invoice details by id.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
Responses
| Code | Description |
|---|---|
| 200 | OK |
| 204 | Purchase invoice has been deleted successfully. |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Purchase invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
PATCH
Summary
Update purchase invoice memo or attachment
Description
API to update purchase invoice memo or attachment
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
| purchaseInvoiceFields | body | purchaseInvoiceFields | Yes | object |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Memo/attachment for purchase invoice updated successfully. | PurchaseInvoiceResponseCanada |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase Invoice with id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
purchase-invoice-controller-germany
Purchase Invoice APIs for Germany.
Invoice purchase/de
GET
Summary
Search purchase invoices.
Description
API to search purchase invoices.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| customfield | query | customfield | No | string |
| limit | query | limit | No | integer |
| page | query | page | No | integer |
| query | query | query | No | string |
| search | query | search | No | string |
| sort | query | sort | No | string |
| sortDir | query | sortDir | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoices have been fetched successfully. | PurchaseInvoiceResponseGermany |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
POST
Summary
Create purchase invoice
Description
API to create purchase invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| purchaseInvoiceRequest | body | purchaseInvoiceRequest | Yes | PurchaseInvoiceRequestGermany |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | PurchaseInvoiceResponseGermany |
| 201 | Purchase invoice has been created successfully. | PurchaseInvoiceResponseGermany |
| 400 | Purchase invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
PUT
Summary
Update purchase invoice attributes by code.
Description
API to update attributes of existing purchase invoice by code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | query | code | Yes | string |
| request | body | request | Yes | PurchaseInvoiceUpdateRequest |
Responses
| Code | Description |
|---|---|
| 200 | Purchase invoice attributes has been updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Purchase invoice with given code not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
DELETE
Summary
Delete purchase invoices by ids in bulk.
Description
API to delete purchase invoices in bulk.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| ids | body | ids | Yes | [ long ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | BulkResponse |
| 204 | No Content | |
| 207 | Request processed successfully. | BulkResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase invoices not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/de/bulk
POST
Summary
Create multiple sales invoice
Description
API to create sales invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| purchaseInvoiceRequests | body | purchaseInvoiceRequests | Yes | [ PurchaseInvoiceRequestGermany ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | PurchaseInvoiceResponseGermany |
| 201 | Sales invoice has been created successfully. | PurchaseInvoiceResponseGermany |
| 400 | Sales invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/de/code/{code}/details
GET
Summary
Purchase invoice details by codes
Description
Purchase invoice details by codes
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | PurchaseInvoiceInformation |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/de/due-amount
PUT
Summary
Update due amount for purchase invoices in bulk.
Description
API to update due amount for purchase invoices in bulk.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| invoiceUpdateAmountDueDtoList | body | invoiceUpdateAmountDueDtoList | Yes | [ InvoiceUpdateAmountDueDto ] |
| revert | query | revert | Yes | boolean |
Responses
| Code | Description |
|---|---|
| 200 | Due amounts updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Purchase invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/de/es/{contactCode}
GET
Summary
Get Invoice for contact.
Description
Get Invoice with contact code from ES.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCode | path | contactCode | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Get Invoice successfully. | PurchaseInvoiceResponseGermany |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Invoice with given contact code not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/de/linked-order/{code}
GET
Summary
Get purchase invoices linked to an order by code.
Description
API to fetch purchase invoices linked to an order by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoices has been fetched successfully. | PurchaseInvoiceResponseGermany |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/de/report/count
POST
Summary
Get purchase invoice count for contacts
Description
API to fetch purchase invoice count for contacts
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCodes | body | contactCodes | Yes | [ string ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Contact purchase invoice count has been fetched. | object |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/de/report/overview
GET
Summary
Purchase invoice overview report data.
Description
API to fetch purchase invoice overview report data
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCode | query | contactCode | No | string |
| interval | query | interval | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoice overview report has been prepared. | InvoiceOverviewReport |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/de/report/unpaid
GET
Summary
Unpaid purchase invoices report.
Description
API to fetch unpaid purchase invoices
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Unpaid purchase invoices report has been prepared. | DashboardReportData |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/de/{code}
GET
Summary
Get purchase invoice by code.
Description
API to fetch purchase invoice details by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoice information has been fetched successfully. | PurchaseInvoiceResponseGermany |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/de/{id}
PUT
Summary
Update purchase invoice.
Description
API to update existing purchase invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
| purchaseInvoiceRequest | body | purchaseInvoiceRequest | Yes | PurchaseInvoiceRequestGermany |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase Invoice has been updated successfully. | PurchaseInvoiceResponseGermany |
| 201 | Created | |
| 400 | Purchase invoice draft status cannot be changed after saving | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase Invoice with given id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
DELETE
Summary
Delete purchase invoice by id.
Description
API to delete purchase invoice details by id.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
Responses
| Code | Description |
|---|---|
| 200 | OK |
| 204 | Purchase invoice has been deleted successfully. |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Purchase invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
PATCH
Summary
Update purchase invoice memo or attachment
Description
API to update purchase invoice memo or attachment
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
| purchaseInvoiceFields | body | purchaseInvoiceFields | Yes | object |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Memo/attachment for purchase invoice updated successfully. | PurchaseInvoiceResponseGermany |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase Invoice with id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
purchase-document-controller
Purchase Document APIs
Invoice purchase/document
GET
Summary
Search purchase documents.
Description
API to search purchase documents.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| documentStage | query | documentStage | No | string |
| fromDate | query | fromDate | No | dateTime |
| limit | query | limit | No | integer |
| page | query | page | No | integer |
| search | query | search | No | string |
| sort | query | sort | No | string |
| sortDir | query | sortDir | No | string |
| toDate | query | toDate | No | dateTime |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase documents have been fetched successfully. | Page |
| 400 | Failed to fetch purchase documents. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/document/purchase/invoices
POST
Summary
Purchase Invoice Report
Description
Purchase Invoice Report API
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| request | body | request | Yes | InvoiceDataESRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase Invoice data fetched from ES successfully. | InvoiceDataESResponse |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/document/summary
GET
Summary
Purchase documents summary.
Description
API for purchase documents summary.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| fromDate | query | fromDate | No | dateTime |
| search | query | search | No | string |
| toDate | query | toDate | No | dateTime |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase documents summary has been fetched successfully. | DocumentSummaryResponse |
| 400 | Failed to fetch purchase documents summary. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
purchase-invoice-controller-indonesia
Purchase Invoice APIs for Indonesia
Invoice purchase/id
GET
Summary
Search purchase invoices.
Description
API to search purchase invoices.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| customfield | query | customfield | No | string |
| limit | query | limit | No | integer |
| page | query | page | No | integer |
| query | query | query | No | string |
| search | query | search | No | string |
| sort | query | sort | No | string |
| sortDir | query | sortDir | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoices have been fetched successfully. | PurchaseInvoiceResponseIndonesia |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
POST
Summary
Create purchase invoice
Description
API to create purchase invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| purchaseInvoiceRequest | body | purchaseInvoiceRequest | Yes | PurchaseInvoiceRequestIndonesia |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | PurchaseInvoiceResponseIndonesia |
| 201 | Purchase invoice has been created successfully. | PurchaseInvoiceResponseIndonesia |
| 400 | Purchase invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
PUT
Summary
Update purchase invoice attributes by code.
Description
API to update attributes of existing purchase invoice by code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | query | code | Yes | string |
| request | body | request | Yes | PurchaseInvoiceUpdateRequest |
Responses
| Code | Description |
|---|---|
| 200 | Purchase invoice attributes has been updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Purchase invoice with given code not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
DELETE
Summary
Delete purchase invoices by ids in bulk.
Description
API to delete purchase invoices in bulk.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| ids | body | ids | Yes | [ long ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | BulkResponse |
| 204 | No Content | |
| 207 | Request processed successfully. | BulkResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase invoices not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/id/bulk
POST
Summary
Create multiple sales invoice
Description
API to create sales invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| purchaseInvoiceRequests | body | purchaseInvoiceRequests | Yes | [ PurchaseInvoiceRequestIndonesia ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | PurchaseInvoiceResponseIndonesia |
| 201 | Sales invoice has been created successfully. | PurchaseInvoiceResponseIndonesia |
| 400 | Sales invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/id/code/{code}
GET
Summary
Get purchase invoice by code.
Description
API to fetch purchase invoice details by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoice information has been fetched successfully. | PurchaseInvoiceResponseIndonesia |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/id/code/{code}/details
GET
Summary
Purchase invoice details by codes
Description
Purchase invoice details by codes
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | PurchaseInvoiceInformation |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/id/due-amount
PUT
Summary
Update due amount for purchase invoices in bulk.
Description
API to update due amount for purchase invoices in bulk.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| invoiceUpdateAmountDueDtoList | body | invoiceUpdateAmountDueDtoList | Yes | [ InvoiceUpdateAmountDueDto ] |
| revert | query | revert | Yes | boolean |
Responses
| Code | Description |
|---|---|
| 200 | Due amounts updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Purchase invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/id/es/{contactCode}
GET
Summary
Get Invoice for contact.
Description
Get Invoice with contact code from ES.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCode | path | contactCode | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Get Invoice successfully. | PurchaseInvoiceResponseIndonesia |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Invoice with given contact code not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/id/linked-order/{code}
GET
Summary
Get purchase invoices linked to an order by code.
Description
API to fetch purchase invoices linked to an order by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoices has been fetched successfully. | PurchaseInvoiceResponseIndonesia |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/id/report/count
POST
Summary
Get purchase invoice count for contacts
Description
API to fetch purchase invoice count for contacts
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCodes | body | contactCodes | Yes | [ string ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Contact purchase invoice count has been fetched. | object |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/id/report/overview
GET
Summary
Purchase invoice overview report data.
Description
API to fetch purchase invoice overview report data
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCode | query | contactCode | No | string |
| interval | query | interval | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoice overview report has been prepared. | InvoiceOverviewReport |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/id/report/unpaid
GET
Summary
Unpaid purchase invoices report.
Description
API to fetch unpaid purchase invoices
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Unpaid purchase invoices report has been prepared. | DashboardReportData |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/id/{code}
GET
Summary
Get purchase invoice by code.
Description
API to fetch purchase invoice details by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoice information has been fetched successfully. | PurchaseInvoiceResponseIndonesia |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/id/{id}
PUT
Summary
Update purchase invoice.
Description
API to update existing purchase invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
| purchaseInvoiceRequest | body | purchaseInvoiceRequest | Yes | PurchaseInvoiceRequestIndonesia |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase Invoice has been updated successfully. | PurchaseInvoiceResponseIndonesia |
| 201 | Created | |
| 400 | Purchase invoice draft status cannot be changed after saving | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase Invoice with given id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
DELETE
Summary
Delete purchase invoice by id.
Description
API to delete purchase invoice details by id.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
Responses
| Code | Description |
|---|---|
| 200 | OK |
| 204 | Purchase invoice has been deleted successfully. |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Purchase invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
PATCH
Summary
Update purchase invoice memo or attachment
Description
API to update purchase invoice memo or attachment
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
| purchaseInvoiceFields | body | purchaseInvoiceFields | Yes | object |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Memo/attachment for purchase invoice updated successfully. | PurchaseInvoiceResponseIndonesia |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase Invoice with id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
purchase-invoice-controller-israel
Purchase Invoice APIs for Israel.
Invoice purchase/il
GET
Summary
Search purchase invoices.
Description
API to search purchase invoices.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| customfield | query | customfield | No | string |
| limit | query | limit | No | integer |
| page | query | page | No | integer |
| query | query | query | No | string |
| search | query | search | No | string |
| sort | query | sort | No | string |
| sortDir | query | sortDir | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoices have been fetched successfully. | PurchaseInvoiceResponseIsrael |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
POST
Summary
Create purchase invoice
Description
API to create purchase invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| purchaseInvoiceRequest | body | purchaseInvoiceRequest | Yes | PurchaseInvoiceRequestIsrael |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | PurchaseInvoiceResponseIsrael |
| 201 | Purchase invoice has been created successfully. | PurchaseInvoiceResponseIsrael |
| 400 | Purchase invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
PUT
Summary
Update purchase invoice attributes by code.
Description
API to update attributes of existing purchase invoice by code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | query | code | Yes | string |
| request | body | request | Yes | PurchaseInvoiceUpdateRequest |
Responses
| Code | Description |
|---|---|
| 200 | Purchase invoice attributes has been updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Purchase invoice with given code not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
DELETE
Summary
Delete purchase invoices by ids in bulk.
Description
API to delete purchase invoices in bulk.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| ids | body | ids | Yes | [ long ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | BulkResponse |
| 204 | No Content | |
| 207 | Request processed successfully. | BulkResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase invoices not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/il/bulk
POST
Summary
Create multiple sales invoice
Description
API to create sales invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| purchaseInvoiceRequests | body | purchaseInvoiceRequests | Yes | [ PurchaseInvoiceRequestIsrael ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | PurchaseInvoiceResponseIsrael |
| 201 | Sales invoice has been created successfully. | PurchaseInvoiceResponseIsrael |
| 400 | Sales invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/il/code/{code}/details
GET
Summary
Purchase invoice details by codes
Description
Purchase invoice details by codes
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | PurchaseInvoiceInformation |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/il/due-amount
PUT
Summary
Update due amount for purchase invoices in bulk.
Description
API to update due amount for purchase invoices in bulk.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| invoiceUpdateAmountDueDtoList | body | invoiceUpdateAmountDueDtoList | Yes | [ InvoiceUpdateAmountDueDto ] |
| revert | query | revert | Yes | boolean |
Responses
| Code | Description |
|---|---|
| 200 | Due amounts updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Purchase invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/il/es/{contactCode}
GET
Summary
Get Invoice for contact.
Description
Get Invoice with contact code from ES.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCode | path | contactCode | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Get Invoice successfully. | PurchaseInvoiceResponseIsrael |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Invoice with given contact code not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/il/linked-order/{code}
GET
Summary
Get purchase invoices linked to an order by code.
Description
API to fetch purchase invoices linked to an order by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoices has been fetched successfully. | PurchaseInvoiceResponseIsrael |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/il/report/count
POST
Summary
Get purchase invoice count for contacts
Description
API to fetch purchase invoice count for contacts
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCodes | body | contactCodes | Yes | [ string ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Contact purchase invoice count has been fetched. | object |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/il/report/overview
GET
Summary
Purchase invoice overview report data.
Description
API to fetch purchase invoice overview report data
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCode | query | contactCode | No | string |
| interval | query | interval | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoice overview report has been prepared. | InvoiceOverviewReport |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/il/report/unpaid
GET
Summary
Unpaid purchase invoices report.
Description
API to fetch unpaid purchase invoices
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Unpaid purchase invoices report has been prepared. | DashboardReportData |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/il/{code}
GET
Summary
Get purchase invoice by code.
Description
API to fetch purchase invoice details by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoice information has been fetched successfully. | PurchaseInvoiceResponseIsrael |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/il/{id}
PUT
Summary
Update purchase invoice.
Description
API to update existing purchase invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
| purchaseInvoiceRequest | body | purchaseInvoiceRequest | Yes | PurchaseInvoiceRequestIsrael |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase Invoice has been updated successfully. | PurchaseInvoiceResponseIsrael |
| 201 | Created | |
| 400 | Purchase invoice draft status cannot be changed after saving | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase Invoice with given id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
DELETE
Summary
Delete purchase invoice by id.
Description
API to delete purchase invoice details by id.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
Responses
| Code | Description |
|---|---|
| 200 | OK |
| 204 | Purchase invoice has been deleted successfully. |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Purchase invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
PATCH
Summary
Update purchase invoice memo or attachment
Description
API to update purchase invoice memo or attachment
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
| purchaseInvoiceFields | body | purchaseInvoiceFields | Yes | object |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Memo/attachment for purchase invoice updated successfully. | PurchaseInvoiceResponseIsrael |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase Invoice with id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
purchase-invoice-controller-india
Purchase Invoice APIs for India
Invoice purchase/in
GET
Summary
Search purchase invoices.
Description
API to search purchase invoices.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| customfield | query | customfield | No | string |
| fetchAttachmentDetails | query | fetchAttachmentDetails | No | boolean |
| limit | query | limit | No | integer |
| page | query | page | No | integer |
| query | query | query | No | string |
| search | query | search | No | string |
| sort | query | sort | No | string |
| sortDir | query | sortDir | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoices have been fetched successfully. | PurchaseInvoiceResponseIndia |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
POST
Summary
Create purchase invoice
Description
API to create purchase invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| purchaseInvoiceRequest | body | purchaseInvoiceRequest | Yes | PurchaseInvoiceRequestIndia |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | PurchaseInvoiceResponseIndia |
| 201 | Purchase invoice has been created successfully. | PurchaseInvoiceResponseIndia |
| 400 | Purchase invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
PUT
Summary
Update purchase invoice attributes by code.
Description
API to update attributes of existing purchase invoice by code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | query | code | Yes | string |
| request | body | request | Yes | PurchaseInvoiceUpdateRequest |
Responses
| Code | Description |
|---|---|
| 200 | Purchase invoice attributes has been updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Purchase invoice with given code not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
DELETE
Summary
Delete purchase invoices by ids in bulk.
Description
API to delete purchase invoices in bulk.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| ids | body | ids | Yes | [ long ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | BulkResponse |
| 204 | No Content | |
| 207 | Request processed successfully. | BulkResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase invoices not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/in/bulk
POST
Summary
Create multiple sales invoice
Description
API to create sales invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| purchaseInvoiceRequests | body | purchaseInvoiceRequests | Yes | [ PurchaseInvoiceRequestIndia ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | PurchaseInvoiceResponseIndia |
| 201 | Sales invoice has been created successfully. | PurchaseInvoiceResponseIndia |
| 400 | Sales invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/in/code/{code}
GET
Summary
Get purchase invoice by code.
Description
API to fetch purchase invoice details by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoice information has been fetched successfully. | PurchaseInvoiceResponseIndia |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/in/code/{code}/details
GET
Summary
Purchase invoice details by codes
Description
Purchase invoice details by codes
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | PurchaseInvoiceInformation |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/in/due-amount
PUT
Summary
Update due amount for purchase invoices in bulk.
Description
API to update due amount for purchase invoices in bulk.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| invoiceUpdateAmountDueDtoList | body | invoiceUpdateAmountDueDtoList | Yes | [ InvoiceUpdateAmountDueDto ] |
| revert | query | revert | Yes | boolean |
Responses
| Code | Description |
|---|---|
| 200 | Due amounts updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Purchase invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/in/es/{contactCode}
GET
Summary
Get Invoice for contact.
Description
Get Invoice with contact code from ES.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCode | path | contactCode | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Get Invoice successfully. | PurchaseInvoiceResponseIndia |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Invoice with given contact code not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/in/linked-order/{code}
GET
Summary
Get purchase invoices linked to an order by code.
Description
API to fetch purchase invoices linked to an order by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoices has been fetched successfully. | PurchaseInvoiceResponseIndia |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/in/report/count
POST
Summary
Get purchase invoice count for contacts
Description
API to fetch purchase invoice count for contacts
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCodes | body | contactCodes | Yes | [ string ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Contact purchase invoice count has been fetched. | object |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/in/report/overview
GET
Summary
Purchase invoice overview report data.
Description
API to fetch purchase invoice overview report data
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCode | query | contactCode | No | string |
| interval | query | interval | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoice overview report has been prepared. | InvoiceOverviewReport |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/in/report/unpaid
GET
Summary
Unpaid purchase invoices report.
Description
API to fetch unpaid purchase invoices
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Unpaid purchase invoices report has been prepared. | DashboardReportData |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/in/tds/{id}
GET
Summary
Get purchase invoice amount by tds id.
Description
API to get get total purchase invoice amount by tds id.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | integer |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoice information has been fetched successfully. | number |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/in/total
GET
Summary
Get Total Purchase invoices Amount
Description
API to fetch total purchase invoice amount
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Get Total Purchase invoices Amount. | number |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/in/update-tds-processed-flag/{code}
PATCH
Summary
Update tds processed flag by code
Description
Api to update tds processed flag by code
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
| isTdsProcessed | body | isTdsProcessed | Yes | boolean |
Responses
| Code | Description |
|---|---|
| 200 | OK |
| 204 | No Content |
| 401 | Unauthorized |
| 403 | Forbidden |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/in/{code}
GET
Summary
Get purchase invoice by code.
Description
API to fetch purchase invoice details by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoice information has been fetched successfully. | PurchaseInvoiceResponseIndia |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/in/{id}
PUT
Summary
Update purchase invoice.
Description
API to update existing purchase invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
| purchaseInvoiceRequest | body | purchaseInvoiceRequest | Yes | PurchaseInvoiceRequestIndia |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase Invoice has been updated successfully. | PurchaseInvoiceResponseIndia |
| 201 | Created | |
| 400 | Purchase invoice draft status cannot be changed after saving | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase Invoice with given id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
DELETE
Summary
Delete purchase invoice by id.
Description
API to delete purchase invoice details by id.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
Responses
| Code | Description |
|---|---|
| 200 | OK |
| 204 | Purchase invoice has been deleted successfully. |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Purchase invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
PATCH
Summary
Update purchase invoice memo or attachment
Description
API to update purchase invoice memo or attachment
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
| purchaseInvoiceFields | body | purchaseInvoiceFields | Yes | object |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Memo/attachment for purchase invoice updated successfully. | PurchaseInvoiceResponseIndia |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase Invoice with id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
purchase-invoice-controller-malaysia
Purchase Invoice APIs for Malaysia
Invoice purchase/my
GET
Summary
Search purchase invoices.
Description
API to search purchase invoices.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| customfield | query | customfield | No | string |
| limit | query | limit | No | integer |
| page | query | page | No | integer |
| query | query | query | No | string |
| search | query | search | No | string |
| sort | query | sort | No | string |
| sortDir | query | sortDir | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoices have been fetched successfully. | PurchaseInvoiceResponseMalaysia |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
POST
Summary
Create purchase invoice
Description
API to create purchase invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| purchaseInvoiceRequest | body | purchaseInvoiceRequest | Yes | PurchaseInvoiceRequestMalaysia |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | PurchaseInvoiceResponseMalaysia |
| 201 | Purchase invoice has been created successfully. | PurchaseInvoiceResponseMalaysia |
| 400 | Purchase invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
PUT
Summary
Update purchase invoice attributes by code.
Description
API to update attributes of existing purchase invoice by code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | query | code | Yes | string |
| request | body | request | Yes | PurchaseInvoiceUpdateRequest |
Responses
| Code | Description |
|---|---|
| 200 | Purchase invoice attributes has been updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Purchase invoice with given code not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
DELETE
Summary
Delete purchase invoices by ids in bulk.
Description
API to delete purchase invoices in bulk.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| ids | body | ids | Yes | [ long ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | BulkResponse |
| 204 | No Content | |
| 207 | Request processed successfully. | BulkResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase invoices not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/my/bulk
POST
Summary
Create multiple sales invoice
Description
API to create sales invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| purchaseInvoiceRequests | body | purchaseInvoiceRequests | Yes | [ PurchaseInvoiceRequestMalaysia ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | PurchaseInvoiceResponseMalaysia |
| 201 | Sales invoice has been created successfully. | PurchaseInvoiceResponseMalaysia |
| 400 | Sales invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/my/code/{code}/details
GET
Summary
Purchase invoice details by codes
Description
Purchase invoice details by codes
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | PurchaseInvoiceInformation |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/my/due-amount
PUT
Summary
Update due amount for purchase invoices in bulk.
Description
API to update due amount for purchase invoices in bulk.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| invoiceUpdateAmountDueDtoList | body | invoiceUpdateAmountDueDtoList | Yes | [ InvoiceUpdateAmountDueDto ] |
| revert | query | revert | Yes | boolean |
Responses
| Code | Description |
|---|---|
| 200 | Due amounts updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Purchase invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/my/es/{contactCode}
GET
Summary
Get Invoice for contact.
Description
Get Invoice with contact code from ES.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCode | path | contactCode | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Get Invoice successfully. | PurchaseInvoiceResponseMalaysia |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Invoice with given contact code not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/my/linked-order/{code}
GET
Summary
Get purchase invoices linked to an order by code.
Description
API to fetch purchase invoices linked to an order by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoices has been fetched successfully. | PurchaseInvoiceResponseMalaysia |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/my/report/count
POST
Summary
Get purchase invoice count for contacts
Description
API to fetch purchase invoice count for contacts
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCodes | body | contactCodes | Yes | [ string ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Contact purchase invoice count has been fetched. | object |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/my/report/overview
GET
Summary
Purchase invoice overview report data.
Description
API to fetch purchase invoice overview report data
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCode | query | contactCode | No | string |
| interval | query | interval | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoice overview report has been prepared. | InvoiceOverviewReport |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/my/report/unpaid
GET
Summary
Unpaid purchase invoices report.
Description
API to fetch unpaid purchase invoices
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Unpaid purchase invoices report has been prepared. | DashboardReportData |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/my/{code}
GET
Summary
Get purchase invoice by code.
Description
API to fetch purchase invoice details by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoice information has been fetched successfully. | PurchaseInvoiceResponseMalaysia |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/my/{id}
PUT
Summary
Update purchase invoice.
Description
API to update existing purchase invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
| purchaseInvoiceRequest | body | purchaseInvoiceRequest | Yes | PurchaseInvoiceRequestMalaysia |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase Invoice has been updated successfully. | PurchaseInvoiceResponseMalaysia |
| 201 | Created | |
| 400 | Purchase invoice draft status cannot be changed after saving | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase Invoice with given id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
DELETE
Summary
Delete purchase invoice by id.
Description
API to delete purchase invoice details by id.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
Responses
| Code | Description |
|---|---|
| 200 | OK |
| 204 | Purchase invoice has been deleted successfully. |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Purchase invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
PATCH
Summary
Update purchase invoice memo or attachment
Description
API to update purchase invoice memo or attachment
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
| purchaseInvoiceFields | body | purchaseInvoiceFields | Yes | object |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Memo/attachment for purchase invoice updated successfully. | PurchaseInvoiceResponseMalaysia |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase Invoice with id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
purchase-invoice-controller-netherlands
Purchase Invoice APIs for Netherlands
Invoice purchase/nl
GET
Summary
Search purchase invoices.
Description
API to search purchase invoices.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| customfield | query | customfield | No | string |
| limit | query | limit | No | integer |
| page | query | page | No | integer |
| query | query | query | No | string |
| search | query | search | No | string |
| sort | query | sort | No | string |
| sortDir | query | sortDir | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoices have been fetched successfully. | PurchaseInvoiceResponseAustralia |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
POST
Summary
Create purchase invoice
Description
API to create purchase invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| purchaseInvoiceRequest | body | purchaseInvoiceRequest | Yes | PurchaseInvoiceRequestAustralia |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | PurchaseInvoiceResponseAustralia |
| 201 | Purchase invoice has been created successfully. | PurchaseInvoiceResponseAustralia |
| 400 | Purchase invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
PUT
Summary
Update purchase invoice attributes by code.
Description
API to update attributes of existing purchase invoice by code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | query | code | Yes | string |
| request | body | request | Yes | PurchaseInvoiceUpdateRequest |
Responses
| Code | Description |
|---|---|
| 200 | Purchase invoice attributes has been updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Purchase invoice with given code not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
DELETE
Summary
Delete purchase invoices by ids in bulk.
Description
API to delete purchase invoices in bulk.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| ids | body | ids | Yes | [ long ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | BulkResponse |
| 204 | No Content | |
| 207 | Request processed successfully. | BulkResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase invoices not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/nl/bulk
POST
Summary
Create multiple sales invoice
Description
API to create sales invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| purchaseInvoiceRequests | body | purchaseInvoiceRequests | Yes | [ PurchaseInvoiceRequestAustralia ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | PurchaseInvoiceResponseAustralia |
| 201 | Sales invoice has been created successfully. | PurchaseInvoiceResponseAustralia |
| 400 | Sales invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/nl/code/{code}/details
GET
Summary
Purchase invoice details by codes
Description
Purchase invoice details by codes
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | PurchaseInvoiceInformation |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/nl/due-amount
PUT
Summary
Update due amount for purchase invoices in bulk.
Description
API to update due amount for purchase invoices in bulk.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| invoiceUpdateAmountDueDtoList | body | invoiceUpdateAmountDueDtoList | Yes | [ InvoiceUpdateAmountDueDto ] |
| revert | query | revert | Yes | boolean |
Responses
| Code | Description |
|---|---|
| 200 | Due amounts updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Purchase invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/nl/es/{contactCode}
GET
Summary
Get Invoice for contact.
Description
Get Invoice with contact code from ES.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCode | path | contactCode | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Get Invoice successfully. | PurchaseInvoiceResponseAustralia |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Invoice with given contact code not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/nl/linked-order/{code}
GET
Summary
Get purchase invoices linked to an order by code.
Description
API to fetch purchase invoices linked to an order by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoices has been fetched successfully. | PurchaseInvoiceResponseAustralia |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/nl/report/count
POST
Summary
Get purchase invoice count for contacts
Description
API to fetch purchase invoice count for contacts
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCodes | body | contactCodes | Yes | [ string ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Contact purchase invoice count has been fetched. | object |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/nl/report/overview
GET
Summary
Purchase invoice overview report data.
Description
API to fetch purchase invoice overview report data
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCode | query | contactCode | No | string |
| interval | query | interval | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoice overview report has been prepared. | InvoiceOverviewReport |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/nl/report/unpaid
GET
Summary
Unpaid purchase invoices report.
Description
API to fetch unpaid purchase invoices
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Unpaid purchase invoices report has been prepared. | DashboardReportData |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/nl/{code}
GET
Summary
Get purchase invoice by code.
Description
API to fetch purchase invoice details by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoice information has been fetched successfully. | PurchaseInvoiceResponseAustralia |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/nl/{id}
PUT
Summary
Update purchase invoice.
Description
API to update existing purchase invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
| purchaseInvoiceRequest | body | purchaseInvoiceRequest | Yes | PurchaseInvoiceRequestAustralia |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase Invoice has been updated successfully. | PurchaseInvoiceResponseAustralia |
| 201 | Created | |
| 400 | Purchase invoice draft status cannot be changed after saving | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase Invoice with given id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
DELETE
Summary
Delete purchase invoice by id.
Description
API to delete purchase invoice details by id.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
Responses
| Code | Description |
|---|---|
| 200 | OK |
| 204 | Purchase invoice has been deleted successfully. |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Purchase invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
PATCH
Summary
Update purchase invoice memo or attachment
Description
API to update purchase invoice memo or attachment
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
| purchaseInvoiceFields | body | purchaseInvoiceFields | Yes | object |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Memo/attachment for purchase invoice updated successfully. | PurchaseInvoiceResponseAustralia |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase Invoice with id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
purchase-invoice-controller-nz
Purchase Invoice APIs for New Zealand
Invoice purchase/nz
GET
Summary
Search purchase invoices.
Description
API to search purchase invoices.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| customfield | query | customfield | No | string |
| limit | query | limit | No | integer |
| page | query | page | No | integer |
| query | query | query | No | string |
| search | query | search | No | string |
| sort | query | sort | No | string |
| sortDir | query | sortDir | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoices have been fetched successfully. | PurchaseInvoiceResponseAustralia |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
POST
Summary
Create purchase invoice
Description
API to create purchase invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| purchaseInvoiceRequest | body | purchaseInvoiceRequest | Yes | PurchaseInvoiceRequestAustralia |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | PurchaseInvoiceResponseAustralia |
| 201 | Purchase invoice has been created successfully. | PurchaseInvoiceResponseAustralia |
| 400 | Purchase invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
PUT
Summary
Update purchase invoice attributes by code.
Description
API to update attributes of existing purchase invoice by code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | query | code | Yes | string |
| request | body | request | Yes | PurchaseInvoiceUpdateRequest |
Responses
| Code | Description |
|---|---|
| 200 | Purchase invoice attributes has been updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Purchase invoice with given code not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
DELETE
Summary
Delete purchase invoices by ids in bulk.
Description
API to delete purchase invoices in bulk.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| ids | body | ids | Yes | [ long ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | BulkResponse |
| 204 | No Content | |
| 207 | Request processed successfully. | BulkResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase invoices not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/nz/bulk
POST
Summary
Create multiple sales invoice
Description
API to create sales invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| purchaseInvoiceRequests | body | purchaseInvoiceRequests | Yes | [ PurchaseInvoiceRequestAustralia ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | PurchaseInvoiceResponseAustralia |
| 201 | Sales invoice has been created successfully. | PurchaseInvoiceResponseAustralia |
| 400 | Sales invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/nz/code/{code}/details
GET
Summary
Purchase invoice details by codes
Description
Purchase invoice details by codes
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | PurchaseInvoiceInformation |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/nz/due-amount
PUT
Summary
Update due amount for purchase invoices in bulk.
Description
API to update due amount for purchase invoices in bulk.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| invoiceUpdateAmountDueDtoList | body | invoiceUpdateAmountDueDtoList | Yes | [ InvoiceUpdateAmountDueDto ] |
| revert | query | revert | Yes | boolean |
Responses
| Code | Description |
|---|---|
| 200 | Due amounts updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Purchase invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/nz/es/{contactCode}
GET
Summary
Get Invoice for contact.
Description
Get Invoice with contact code from ES.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCode | path | contactCode | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Get Invoice successfully. | PurchaseInvoiceResponseAustralia |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Invoice with given contact code not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/nz/linked-order/{code}
GET
Summary
Get purchase invoices linked to an order by code.
Description
API to fetch purchase invoices linked to an order by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoices has been fetched successfully. | PurchaseInvoiceResponseAustralia |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/nz/report/count
POST
Summary
Get purchase invoice count for contacts
Description
API to fetch purchase invoice count for contacts
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCodes | body | contactCodes | Yes | [ string ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Contact purchase invoice count has been fetched. | object |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/nz/report/overview
GET
Summary
Purchase invoice overview report data.
Description
API to fetch purchase invoice overview report data
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCode | query | contactCode | No | string |
| interval | query | interval | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoice overview report has been prepared. | InvoiceOverviewReport |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/nz/report/unpaid
GET
Summary
Unpaid purchase invoices report.
Description
API to fetch unpaid purchase invoices
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Unpaid purchase invoices report has been prepared. | DashboardReportData |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/nz/{code}
GET
Summary
Get purchase invoice by code.
Description
API to fetch purchase invoice details by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoice information has been fetched successfully. | PurchaseInvoiceResponseAustralia |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/nz/{id}
PUT
Summary
Update purchase invoice.
Description
API to update existing purchase invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
| purchaseInvoiceRequest | body | purchaseInvoiceRequest | Yes | PurchaseInvoiceRequestAustralia |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase Invoice has been updated successfully. | PurchaseInvoiceResponseAustralia |
| 201 | Created | |
| 400 | Purchase invoice draft status cannot be changed after saving | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase Invoice with given id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
DELETE
Summary
Delete purchase invoice by id.
Description
API to delete purchase invoice details by id.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
Responses
| Code | Description |
|---|---|
| 200 | OK |
| 204 | Purchase invoice has been deleted successfully. |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Purchase invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
PATCH
Summary
Update purchase invoice memo or attachment
Description
API to update purchase invoice memo or attachment
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
| purchaseInvoiceFields | body | purchaseInvoiceFields | Yes | object |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Memo/attachment for purchase invoice updated successfully. | PurchaseInvoiceResponseAustralia |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase Invoice with id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
purchase-invoice-controller-philippines
Purchase Invoice APIs for Philippines
Invoice purchase/ph
GET
Summary
Search purchase invoices.
Description
API to search purchase invoices.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| customfield | query | customfield | No | string |
| limit | query | limit | No | integer |
| page | query | page | No | integer |
| query | query | query | No | string |
| search | query | search | No | string |
| sort | query | sort | No | string |
| sortDir | query | sortDir | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoices have been fetched successfully. | PurchaseInvoiceResponsePhilippines |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
POST
Summary
Create purchase invoice
Description
API to create purchase invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| purchaseInvoiceRequest | body | purchaseInvoiceRequest | Yes | PurchaseInvoiceRequestPhilippines |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | PurchaseInvoiceResponsePhilippines |
| 201 | Purchase invoice has been created successfully. | PurchaseInvoiceResponsePhilippines |
| 400 | Purchase invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
PUT
Summary
Update purchase invoice attributes by code.
Description
API to update attributes of existing purchase invoice by code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | query | code | Yes | string |
| request | body | request | Yes | PurchaseInvoiceUpdateRequest |
Responses
| Code | Description |
|---|---|
| 200 | Purchase invoice attributes has been updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Purchase invoice with given code not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
DELETE
Summary
Delete purchase invoices by ids in bulk.
Description
API to delete purchase invoices in bulk.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| ids | body | ids | Yes | [ long ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | BulkResponse |
| 204 | No Content | |
| 207 | Request processed successfully. | BulkResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase invoices not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/ph/bulk
POST
Summary
Create multiple sales invoice
Description
API to create sales invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| purchaseInvoiceRequests | body | purchaseInvoiceRequests | Yes | [ PurchaseInvoiceRequestPhilippines ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | PurchaseInvoiceResponsePhilippines |
| 201 | Sales invoice has been created successfully. | PurchaseInvoiceResponsePhilippines |
| 400 | Sales invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/ph/code/{code}/details
GET
Summary
Purchase invoice details by codes
Description
Purchase invoice details by codes
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | PurchaseInvoiceInformation |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/ph/due-amount
PUT
Summary
Update due amount for purchase invoices in bulk.
Description
API to update due amount for purchase invoices in bulk.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| invoiceUpdateAmountDueDtoList | body | invoiceUpdateAmountDueDtoList | Yes | [ InvoiceUpdateAmountDueDto ] |
| revert | query | revert | Yes | boolean |
Responses
| Code | Description |
|---|---|
| 200 | Due amounts updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Purchase invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/ph/es/{contactCode}
GET
Summary
Get Invoice for contact.
Description
Get Invoice with contact code from ES.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCode | path | contactCode | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Get Invoice successfully. | PurchaseInvoiceResponsePhilippines |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Invoice with given contact code not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/ph/linked-order/{code}
GET
Summary
Get purchase invoices linked to an order by code.
Description
API to fetch purchase invoices linked to an order by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoices has been fetched successfully. | PurchaseInvoiceResponsePhilippines |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/ph/report/count
POST
Summary
Get purchase invoice count for contacts
Description
API to fetch purchase invoice count for contacts
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCodes | body | contactCodes | Yes | [ string ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Contact purchase invoice count has been fetched. | object |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/ph/report/overview
GET
Summary
Purchase invoice overview report data.
Description
API to fetch purchase invoice overview report data
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCode | query | contactCode | No | string |
| interval | query | interval | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoice overview report has been prepared. | InvoiceOverviewReport |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/ph/report/unpaid
GET
Summary
Unpaid purchase invoices report.
Description
API to fetch unpaid purchase invoices
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Unpaid purchase invoices report has been prepared. | DashboardReportData |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/ph/{code}
GET
Summary
Get purchase invoice by code.
Description
API to fetch purchase invoice details by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoice information has been fetched successfully. | PurchaseInvoiceResponsePhilippines |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/ph/{id}
PUT
Summary
Update purchase invoice.
Description
API to update existing purchase invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
| purchaseInvoiceRequest | body | purchaseInvoiceRequest | Yes | PurchaseInvoiceRequestPhilippines |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase Invoice has been updated successfully. | PurchaseInvoiceResponsePhilippines |
| 201 | Created | |
| 400 | Purchase invoice draft status cannot be changed after saving | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase Invoice with given id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
DELETE
Summary
Delete purchase invoice by id.
Description
API to delete purchase invoice details by id.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
Responses
| Code | Description |
|---|---|
| 200 | OK |
| 204 | Purchase invoice has been deleted successfully. |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Purchase invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
PATCH
Summary
Update purchase invoice memo or attachment
Description
API to update purchase invoice memo or attachment
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
| purchaseInvoiceFields | body | purchaseInvoiceFields | Yes | object |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Memo/attachment for purchase invoice updated successfully. | PurchaseInvoiceResponsePhilippines |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase Invoice with id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
purchase-invoice-controller-sa
Purchase Invoice APIs for Saudi Arab
Invoice purchase/sa
GET
Summary
Search purchase invoices.
Description
API to search purchase invoices.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| customfield | query | customfield | No | string |
| limit | query | limit | No | integer |
| page | query | page | No | integer |
| query | query | query | No | string |
| search | query | search | No | string |
| sort | query | sort | No | string |
| sortDir | query | sortDir | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoices have been fetched successfully. | PurchaseInvoiceResponseSA |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
POST
Summary
Create purchase invoice
Description
API to create purchase invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| purchaseInvoiceRequest | body | purchaseInvoiceRequest | Yes | PurchaseInvoiceRequestSA |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | PurchaseInvoiceResponseSA |
| 201 | Purchase invoice has been created successfully. | PurchaseInvoiceResponseSA |
| 400 | Purchase invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
PUT
Summary
Update purchase invoice attributes by code.
Description
API to update attributes of existing purchase invoice by code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | query | code | Yes | string |
| request | body | request | Yes | PurchaseInvoiceUpdateRequest |
Responses
| Code | Description |
|---|---|
| 200 | Purchase invoice attributes has been updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Purchase invoice with given code not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
DELETE
Summary
Delete purchase invoices by ids in bulk.
Description
API to delete purchase invoices in bulk.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| ids | body | ids | Yes | [ long ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | BulkResponse |
| 204 | No Content | |
| 207 | Request processed successfully. | BulkResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase invoices not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/sa/bills-for-adjustment-je
GET
Summary
Get list of purchase invoices for Custom / RCM adjustment journal entries
Description
Api to fetch list of purchase invoices for Custom / RCM adjustment journal entries
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| adjustmentType | query | adjustmentType | Yes | string |
| endDate | query | endDate | Yes | string |
| limit | query | limit | No | integer |
| page | query | page | No | integer |
| search | query | search | No | string |
| startDate | query | startDate | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoices have been fetched successfully | JournalBillDetailsSA |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/sa/bills-summary-for-adjustment-je
GET
Summary
Get purchase invoices summary for Custom / RCM adjustment journal entries
Description
Api to fetch purchase invoices summary for Custom / RCM adjustment journal entries
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| adjustmentType | query | adjustmentType | Yes | string |
| endDate | query | endDate | Yes | string |
| startDate | query | startDate | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoices summary have been fetched successfully | JournalAdjustmentBillsSummarySA |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/sa/bulk
POST
Summary
Create multiple sales invoice
Description
API to create sales invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| purchaseInvoiceRequests | body | purchaseInvoiceRequests | Yes | [ PurchaseInvoiceRequestSA ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | PurchaseInvoiceResponseSA |
| 201 | Sales invoice has been created successfully. | PurchaseInvoiceResponseSA |
| 400 | Sales invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/sa/code/{code}/details
GET
Summary
Purchase invoice details by codes
Description
Purchase invoice details by codes
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | PurchaseInvoiceInformation |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/sa/due-amount
PUT
Summary
Update due amount for purchase invoices in bulk.
Description
API to update due amount for purchase invoices in bulk.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| invoiceUpdateAmountDueDtoList | body | invoiceUpdateAmountDueDtoList | Yes | [ InvoiceUpdateAmountDueDto ] |
| revert | query | revert | Yes | boolean |
Responses
| Code | Description |
|---|---|
| 200 | Due amounts updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Purchase invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/sa/es/{contactCode}
GET
Summary
Get Invoice for contact.
Description
Get Invoice with contact code from ES.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCode | path | contactCode | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Get Invoice successfully. | PurchaseInvoiceResponseSA |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Invoice with given contact code not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/sa/linked-order/{code}
GET
Summary
Get purchase invoices linked to an order by code.
Description
API to fetch purchase invoices linked to an order by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoices has been fetched successfully. | PurchaseInvoiceResponseSA |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/sa/report/count
POST
Summary
Get purchase invoice count for contacts
Description
API to fetch purchase invoice count for contacts
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCodes | body | contactCodes | Yes | [ string ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Contact purchase invoice count has been fetched. | object |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/sa/report/overview
GET
Summary
Purchase invoice overview report data.
Description
API to fetch purchase invoice overview report data
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCode | query | contactCode | No | string |
| interval | query | interval | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoice overview report has been prepared. | InvoiceOverviewReport |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/sa/report/unpaid
GET
Summary
Unpaid purchase invoices report.
Description
API to fetch unpaid purchase invoices
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Unpaid purchase invoices report has been prepared. | DashboardReportData |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/sa/update-adjustment-je-flag/{code}
PATCH
Summary
Update adjustment je flag by code for Saudi Arabia
Description
Api to update adjustment je flag by code for Saudi Arabia
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| adjustmentJEFlag | body | adjustmentJEFlag | Yes | boolean |
| code | path | code | Yes | string |
Responses
| Code | Description |
|---|---|
| 200 | OK |
| 204 | No Content |
| 401 | Unauthorized |
| 403 | Forbidden |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/sa/{code}
GET
Summary
Get purchase invoice by code.
Description
API to fetch purchase invoice details by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoice information has been fetched successfully. | PurchaseInvoiceResponseSA |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/sa/{id}
PUT
Summary
Update purchase invoice.
Description
API to update existing purchase invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
| purchaseInvoiceRequest | body | purchaseInvoiceRequest | Yes | PurchaseInvoiceRequestSA |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase Invoice has been updated successfully. | PurchaseInvoiceResponseSA |
| 201 | Created | |
| 400 | Purchase invoice draft status cannot be changed after saving | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase Invoice with given id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
DELETE
Summary
Delete purchase invoice by id.
Description
API to delete purchase invoice details by id.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
Responses
| Code | Description |
|---|---|
| 200 | OK |
| 204 | Purchase invoice has been deleted successfully. |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Purchase invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
PATCH
Summary
Update purchase invoice memo or attachment
Description
API to update purchase invoice memo or attachment
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
| purchaseInvoiceFields | body | purchaseInvoiceFields | Yes | object |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Memo/attachment for purchase invoice updated successfully. | PurchaseInvoiceResponseSA |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase Invoice with id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
purchase-invoice-controller-uk
Purchase Invoice APIs for UK.
Invoice purchase/uk
GET
Summary
Search purchase invoices.
Description
API to search purchase invoices.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| customfield | query | customfield | No | string |
| limit | query | limit | No | integer |
| page | query | page | No | integer |
| query | query | query | No | string |
| search | query | search | No | string |
| sort | query | sort | No | string |
| sortDir | query | sortDir | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoices have been fetched successfully. | PurchaseInvoiceResponseUk |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
POST
Summary
Create purchase invoice
Description
API to create purchase invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| purchaseInvoiceRequest | body | purchaseInvoiceRequest | Yes | PurchaseInvoiceRequestUk |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | PurchaseInvoiceResponseUk |
| 201 | Purchase invoice has been created successfully. | PurchaseInvoiceResponseUk |
| 400 | Purchase invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
PUT
Summary
Update purchase invoice attributes by code.
Description
API to update attributes of existing purchase invoice by code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | query | code | Yes | string |
| request | body | request | Yes | PurchaseInvoiceUpdateRequest |
Responses
| Code | Description |
|---|---|
| 200 | Purchase invoice attributes has been updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Purchase invoice with given code not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
DELETE
Summary
Delete purchase invoices by ids in bulk.
Description
API to delete purchase invoices in bulk.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| ids | body | ids | Yes | [ long ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | BulkResponse |
| 204 | No Content | |
| 207 | Request processed successfully. | BulkResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase invoices not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/uk/bulk
POST
Summary
Create multiple sales invoice
Description
API to create sales invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| purchaseInvoiceRequests | body | purchaseInvoiceRequests | Yes | [ PurchaseInvoiceRequestUk ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | PurchaseInvoiceResponseUk |
| 201 | Sales invoice has been created successfully. | PurchaseInvoiceResponseUk |
| 400 | Sales invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/uk/code/{code}/details
GET
Summary
Purchase invoice details by codes
Description
Purchase invoice details by codes
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | PurchaseInvoiceInformation |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/uk/due-amount
PUT
Summary
Update due amount for purchase invoices in bulk.
Description
API to update due amount for purchase invoices in bulk.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| invoiceUpdateAmountDueDtoList | body | invoiceUpdateAmountDueDtoList | Yes | [ InvoiceUpdateAmountDueDto ] |
| revert | query | revert | Yes | boolean |
Responses
| Code | Description |
|---|---|
| 200 | Due amounts updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Purchase invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/uk/es/{contactCode}
GET
Summary
Get Invoice for contact.
Description
Get Invoice with contact code from ES.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCode | path | contactCode | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Get Invoice successfully. | PurchaseInvoiceResponseUk |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Invoice with given contact code not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/uk/linked-order/{code}
GET
Summary
Get purchase invoices linked to an order by code.
Description
API to fetch purchase invoices linked to an order by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoices has been fetched successfully. | PurchaseInvoiceResponseUk |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/uk/report/count
POST
Summary
Get purchase invoice count for contacts
Description
API to fetch purchase invoice count for contacts
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCodes | body | contactCodes | Yes | [ string ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Contact purchase invoice count has been fetched. | object |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/uk/report/overview
GET
Summary
Purchase invoice overview report data.
Description
API to fetch purchase invoice overview report data
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCode | query | contactCode | No | string |
| interval | query | interval | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoice overview report has been prepared. | InvoiceOverviewReport |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/uk/report/unpaid
GET
Summary
Unpaid purchase invoices report.
Description
API to fetch unpaid purchase invoices
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Unpaid purchase invoices report has been prepared. | DashboardReportData |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/uk/{code}
GET
Summary
Get purchase invoice by code.
Description
API to fetch purchase invoice details by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase invoice information has been fetched successfully. | PurchaseInvoiceResponseUk |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchase/uk/{id}
PUT
Summary
Update purchase invoice.
Description
API to update existing purchase invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
| purchaseInvoiceRequest | body | purchaseInvoiceRequest | Yes | PurchaseInvoiceRequestUk |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Purchase Invoice has been updated successfully. | PurchaseInvoiceResponseUk |
| 201 | Created | |
| 400 | Purchase invoice draft status cannot be changed after saving | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase Invoice with given id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
DELETE
Summary
Delete purchase invoice by id.
Description
API to delete purchase invoice details by id.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
Responses
| Code | Description |
|---|---|
| 200 | OK |
| 204 | Purchase invoice has been deleted successfully. |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Purchase invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
PATCH
Summary
Update purchase invoice memo or attachment
Description
API to update purchase invoice memo or attachment
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
| purchaseInvoiceFields | body | purchaseInvoiceFields | Yes | object |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Memo/attachment for purchase invoice updated successfully. | PurchaseInvoiceResponseUk |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Purchase Invoice with id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
data-correction-controller
Purchase Invoice APIs
Invoice purchasecorrection/update
POST
Summary
updateTaxAmount
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | string |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchasecorrection/updateinvoicestatus
POST
Summary
updateInvoicePaymentStatusToReceived
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| ids | body | ids | Yes | [ long ] |
Responses
| Code | Description |
|---|---|
| 200 | OK |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchasecorrection/updatemissingjepurchase
POST
Summary
updateMissingJEPurchase
Responses
| Code | Description |
|---|---|
| 200 | OK |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice purchasecorrection/updatemissingjesales
POST
Summary
updateMissingJESales
Responses
| Code | Description |
|---|---|
| 200 | OK |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
invoice-reminder-controller
Invoice Reminder APIs
Invoice reminder/configuration
GET
Summary
Get reminder configurations by code
Description
Api to fetch reminder configurations by it's code
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Reminder configurations have been fetched successfully. | ReminderConfigurationDto |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Reminder configurations not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
PUT
Summary
Update Invoice Reminder Configuration
Description
Api to Update Invoice Reminder Configuration
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| reminderConfigurationRequestDto | body | reminderConfigurationRequestDto | Yes | [ ReminderConfigurationRequestDto ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Reminder configuration have been updated successfully. | ReminderConfigurationResponseDto |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Reminder configuration update is unsuccessful |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice reminder/contact
GET
Summary
Get Disabled Contact
Description
Api to Get Disabled Contact
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCode | query | contactCode | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Disabled Contact fetched successfully. | ReminderDisabledContactDto |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Failed to fetch Disabled Contact |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
PUT
Summary
Update Disabled Contact
Description
Api to Update Update Disabled Contact
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| reminderDisabledContactRequestDto | body | reminderDisabledContactRequestDto | Yes | ReminderDisabledContactRequestDto |
Responses
| Code | Description |
|---|---|
| 200 | Disabled Contact have been updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Disabled Contact update is unsuccessful |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice reminder/settings
GET
Summary
Get reminder settings by code
Description
Api to fetch reminder settings by it's code
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Reminder settings have been fetched successfully. | ReminderSettingsDto |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Reminder settings not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
PUT
Summary
Update reminder settings.
Description
API to update existing reminder settings.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| reminderSettingsRequest | body | reminderSettingsRequest | Yes | ReminderSettingsRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales Invoice has been updated successfully. | ReminderSettingsResponse |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales Invoice with given id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
sales-invoice-controller
Sales Invoice APIs
Invoice sales/approval-status
POST
Summary
Update approval status
Description
API to update approval status
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| approvalStatusRequestDtoList | body | approvalStatusRequestDtoList | Yes | [ ApprovalStatusRequestDto ] |
Responses
| Code | Description |
|---|---|
| 200 | Approval status for Sales documents have been updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/bulk
POST
Summary
Create multiple sales invoice
Description
API to create sales invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceRequests | body | salesInvoiceRequests | Yes | [ SalesInvoiceRequest ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | SalesInvoiceResponse |
| 201 | Sales invoice has been created successfully. | SalesInvoiceResponse |
| 400 | Sales invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
PUT
Summary
Batch update sales invoice attributes by codes.
Description
API to batch update attributes of existing sales invoice by codes.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceUpdateRequests | body | salesInvoiceUpdateRequests | Yes | [ SalesInvoiceUpdateRequest ] |
Responses
| Code | Description |
|---|---|
| 200 | Sales invoice attributes has been updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Sales invoice with given code not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Bulk Delete Invoices
DELETE
Invoice sales/bulk-delete
Summary
Bulk Delete sales invoices.
Description
API to Bulk Delete sales invoices.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| ids | body | ids | Yes | [ long ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | SalesInvoiceBulkDeleteResponseDto |
| 204 | Sales invoice has been deleted successfully. | SalesInvoiceBulkDeleteResponseDto |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/bulk-details
POST
Summary
Sales invoice details by codes
Description
Sales invoice details by codes
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| codes | body | codes | Yes | [ string ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | [ SalesInvoiceInformation ] |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/bulk-details-by-seq
POST
Summary
Sales invoice details by sequence codes
Description
Sales invoice details by sequence codes
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| seqCodes | body | seqCodes | Yes | [ string ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | [ SalesInvoiceInformation ] |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/bulk-update
PATCH
Summary
Update sales invoices memo or attachment
Description
API to Update sales invoices memo or attachment
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceFields | body | salesInvoiceFields | Yes | [ Map«string,string» ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | BulkApiResponse |
| 204 | No Content | |
| 207 | Memo/attachment for sales invoice updated successfully. | BulkApiResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales Invoice with given id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/bulk/codes
POST
Summary
Get multiple sales invoices
Description
API to get sales invoices.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| codes | body | codes | Yes | [ string ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales documents have been fetched successfully. | SalesInvoiceResponse |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/by-contact-ids
POST
Summary
Search sales invoices.
Description
API to search sales invoices.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactIds | body | contactIds | Yes | [ long ] |
| customfield | query | customfield | No | string |
| fetchAttachmentDetails | query | fetchAttachmentDetails | No | boolean |
| limit | query | limit | No | integer |
| page | query | page | No | integer |
| query | query | query | No | string |
| search | query | search | No | string |
| sort | query | sort | No | string |
| sortDir | query | sortDir | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoices have been fetched successfully. | SalesInvoiceResponse |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/calculateLoanAmount
GET
Summary
Get Kredx Loan Amount.
Description
API to fetch Loan Amount by wrt to payment term.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| paymentTerm | query | paymentTerm | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoice information has been fetched successfully. | SalesInvoiceResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/code/{code}
GET
Summary
Get sales invoice by code.
Description
API to fetch sales invoice details by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoice information has been fetched successfully. | SalesInvoiceResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
PATCH
Summary
Update sales invoice memo or attachment
Description
API to update sales invoice memo or attachment
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
| salesInvoiceFields | body | salesInvoiceFields | Yes | object |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Memo/attachment for sales invoice updated successfully. | SalesInvoiceResponse |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales Invoice with id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Get Invoice details By Code
GET
Invoice sales/code/{code}/details
Summary
Sales invoice details by codes
Description
Sales invoice details by codes
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | SalesInvoiceInformation |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/codes
POST
Summary
Get Invoice information by codes.
Description
API to get invoice document information by codes.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| codes | body | codes | Yes | [ string ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Invoice documents have been fetched successfully. | [ SalesDocument ] |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Get Invoice Amount Due
POST
Invoice sales/contact-invoice-amountdue
Summary
Get sales invoices amount due by contact code.
Description
API to fetch sales invoices amount due by contact code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| codes | body | codes | Yes | [ string ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoices amount due has been fetched successfully. | SalesInvoiceResponse |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/contrainvoice
POST
Summary
Invoice contra adjustment.
Description
API to contra adjustment for invoice of contact.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contraInvoiceDto | body | contraInvoiceDto | Yes | ContraInvoiceDto |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | ContraInvoiceDto |
| 201 | Contra adjustment for invoice has been done successfully. | ContraInvoiceDto |
| 400 | Contra adjustment for invoice has been failed because of insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
DELETE
Summary
Invoice contra adjustment.
Description
API to contra adjustment for invoice of contact.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contraCode | query | contraCode | Yes | string |
| purchaseInvoiceCode | query | purchaseInvoiceCode | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | ContraInvoiceDto |
| 201 | Contra adjustment for bill has been done successfully. | ContraInvoiceDto |
| 204 | No Content | |
| 400 | Contra adjustment for bill has been failed because of insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/create-recurring
POST
Summary
Create a recurring invoice
Description
API to create a recurring invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| event | body | event | Yes | RecurringJobEvent |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | SalesInvoiceResponse |
| 201 | Recurring invoice created successfully | SalesInvoiceResponse |
| 400 | Error while creating recurring invoice | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/delete-duplicate-payment
POST
Summary
Delete duplicate payments of invoices
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| invoiceCodes | query | invoiceCodes | No | [ string ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | object |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/delete-knockoff
POST
Summary
Delete given payment details from knockoff_info of given invoice
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| request | body | request | Yes | [ DuplicatePaymentDto ] |
Responses
| Code | Description |
|---|---|
| 200 | OK |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/draft/trigger
POST
Summary
Create approval status trigger
Description
API to reate approval status trigger
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| triggerKafkaRequestDto | body | triggerKafkaRequestDto | Yes | TriggerKafkaRequestDto |
Responses
| Code | Description |
|---|---|
| 200 | Trigger created for approval status |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/dropshipupdateinvoice
PUT
Summary
Batch update sales invoice attributes by codes.
Description
API to batch update attributes of existing sales invoice by codes.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceUpdateRequests | body | salesInvoiceUpdateRequests | Yes | [ SalesInvoiceUpdateRequest ] |
Responses
| Code | Description |
|---|---|
| 200 | Sales invoice attributes has been updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Sales invoice with given code not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/due-amount
PUT
Summary
Update due amount for sales invoices in bulk.
Description
API to update due amount for sales invoices in bulk.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| invoiceUpdateAmountDueDtoList | body | invoiceUpdateAmountDueDtoList | Yes | [ InvoiceUpdateAmountDueDto ] |
| revert | query | revert | Yes | boolean |
Responses
| Code | Description |
|---|---|
| 200 | Due amounts updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Sales invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/due-amount-bulk-payment-delete
PUT
Summary
Update due amount for sales invoices in bulk delete.
Description
API to update due amount for sales invoices in bulk delete.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| invoiceUpdateAmountDueDtoList | body | invoiceUpdateAmountDueDtoList | Yes | [ InvoiceUpdateAmountDueDto ] |
Responses
| Code | Description |
|---|---|
| 200 | Due amounts updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Sales invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Delete Fulfillment by Fulfillment code
DELETE
Invoice sales/fulfillments
Summary
Delete Fulfillment by Fulfillment code
Description
API to delete Fulfillment by code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| fulfillmentCode | query | fulfillmentCode | Yes | string |
| isBulkDelete | query | isBulkDelete | No | boolean |
| salesInvoiceCode | query | salesInvoiceCode | Yes | string |
Responses
| Code | Description |
|---|---|
| 200 | OK |
| 204 | Fulfillment has been deleted successfully. |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Fulfillment has been deleted successfully. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/import
POST
Summary
Create multiple sales invoice via import
Description
API to create sales invoice via import.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceRequests | body | salesInvoiceRequests | Yes | [ SalesInvoiceRequest ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | BulkApiResponse |
| 201 | Sales invoice has been created successfully. | BulkApiResponse |
| 400 | Sales invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/invoiceitemsstatus
POST
Summary
Get sales invoice items fulfillment status
Description
API to fetch sales invoice items fulfillment status
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceItemToFulfilledMap | body | salesInvoiceItemToFulfilledMap | Yes | object |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | invoice items fulfillment status. | object |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/journal
POST
Summary
Recreate Sales Invoices Journal Entries for all tenants
Description
API to recreate Journal Entries for all Sales Invoices.
Responses
| Code | Description |
|---|---|
| 200 | Journal Entries for all Sales Invoices recreated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/linked-docs/product-codes
POST
Summary
Get products by code
Description
API to Get products by code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| productCodes | body | productCodes | Yes | [ string ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Product information has been fetched successfully. | string |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Products not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/linked-invoices-by-multi-code
POST
Summary
Get sales invoices linked to a quotations by code.
Description
API to fetch sales invoices linked to a quotations by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| codes | body | codes | Yes | [ string ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoices has been fetched successfully. | object |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/linked-invoices/{code}
GET
Summary
Get sales invoices linked to a quotation by code.
Description
API to fetch sales invoices linked to a quotation by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoices has been fetched successfully. | SalesInvoiceResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/linked-order/{code}
GET
Summary
Get sales invoices linked to an order by code.
Description
API to fetch sales invoices linked to an order by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoices has been fetched successfully. | SalesInvoiceResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/linked-quotation/{code}
GET
Summary
Get sales invoices linked to a quotation by code.
Description
API to fetch sales invoices linked to a quotation by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoices has been fetched successfully. | SalesInvoiceResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/linked-salesorder/{code}
GET
Summary
Get sales invoices linked to a sales order by code.
Description
API to fetch sales invoices linked to a sales order by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoices has been fetched successfully. | SalesInvoiceResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/memo
PUT
Summary
Update memo in invoice.
Description
API to update memo in invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| memoUpdateDto | body | memoUpdateDto | Yes | MemoUpdateDto |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoices memo updated successfully. | SalesInvoiceResponse |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/notes
DELETE
Summary
Delete sales invoice by id.
Description
API to delete sales invoice details by id.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | query | code | Yes | string |
| invoicecode | query | invoicecode | Yes | string |
| uid | query | uid | Yes | string (uuid) |
Responses
| Code | Description |
|---|---|
| 200 | OK |
| 204 | Sales invoice has been deleted successfully. |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Sales invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/partial_invoice
PUT
Summary
Update Partial Invoice Fulfillment status.
Description
API to Update Partial Invoice Fulfillment status.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| partialInvoiceFulfillmentStatusUpdate | body | partialInvoiceFulfillmentStatusUpdate | Yes | PartialInvoiceFulfillmentStatusUpdate |
Responses
| Code | Description |
|---|---|
| 200 | Partial Invoice Fulfillment status updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Partial Invoice Fulfillment status updated failure. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/productCode/{productCode}
GET
Summary
Check if a sales invoice exists for a given product
Description
Api to check if a sales invoice exists for a given product
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| productCode | path | productCode | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoice information has been fetched successfully. | boolean |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/receive
DELETE
Summary
Delete sales invoice by id.
Description
API to delete sales invoice details by id.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| paymentCode | query | paymentCode | Yes | string |
| salesInvoiceCode | query | salesInvoiceCode | Yes | string |
| uid | query | uid | No | string (uuid) |
Responses
| Code | Description |
|---|---|
| 200 | OK |
| 204 | Sales invoice has been deleted successfully. |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Sales invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/record-filter
POST
Summary
Create approval status trigger
Description
API to reate approval status trigger
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| filterRecord | body | filterRecord | Yes | FilterRecord |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Trigger created for approval status | boolean |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/report/count
POST
Summary
Get sales invoice count for contacts
Description
API to fetch sales invoice count for contacts
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCodes | body | contactCodes | Yes | [ string ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Contact sales invoice count has been fetched. | object |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/report/overview
GET
Summary
Sales invoice overview report data.
Description
API to fetch sales invoice overview report data
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCode | query | contactCode | No | string |
| interval | query | interval | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoice overview report has been prepared. | InvoiceOverviewReport |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/report/top-customers
GET
Summary
Fetch top customers
Description
API to fetch top customers.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| measure | query | measure | No | string |
| tenure | query | tenure | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Top customers have been determined. | CustomerReport |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/report/top-products
GET
Summary
Fetch top products
Description
API to fetch top products.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| measure | query | measure | No | string |
| tenure | query | tenure | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Top products have been determined. | ProductReport |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/report/unpaid
GET
Summary
Unpaid sales invoices report.
Description
API to fetch unpaid sales invoices
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Unpaid sales invoices report has been prepared. | DashboardReportData |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/salesinvoicereserved
PUT
Summary
Batch update sales invoice attributes by codes.
Description
API to batch update attributes of existing sales invoice by codes.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| reservedQuantityData | body | reservedQuantityData | Yes | [ PPSReservedQuantityData ] |
Responses
| Code | Description |
|---|---|
| 200 | Sales invoice attributes has been updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Sales invoice with given code not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/set-recurring
POST
Summary
Set an invoice to recurring
Description
API to set and invoice to recurring.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| setRecurringDto | body | setRecurringDto | Yes | SetRecurringDto |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Invoice set to recur successfully | SalesInvoiceResponse |
| 201 | Created | |
| 400 | Error while setting invoice to recur | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/shopify
POST
Summary
Create sales invoice
Description
API to create sales invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| shopifyOrder | body | shopifyOrder | Yes | ShopifyOrder |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | SalesInvoiceResponse |
| 201 | Sales invoice has been created successfully. | SalesInvoiceResponse |
| 400 | Sales invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/tax/count
POST
Summary
Get sales invoice items count for tax
Description
API to fetch sales invoice items count for tax
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| taxCodes | body | taxCodes | Yes | [ string ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Tax sales invoice count has been fetched. | object |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/unfulfillment-seq-codes
GET
Summary
Get Unfulfilled sales invoices codes
Description
Get Unfulfilled sales invoices codes
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoice information has been fetched successfully. | [ object ] |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/unpaid-seq-codes
GET
Summary
Get unpaid sales invoices document sequence codes.
Description
API to unpaid sales invoices document sequence codes.
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoice information has been fetched successfully. | [ object ] |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/unreserve-invoices
POST
Summary
Api to Unreserve quantity in invoices only
Description
Api to Unreserve quantity in invoices only
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| updatedInvoiceCodes | body | updatedInvoiceCodes | Yes | [ string ] |
Responses
| Code | Description |
|---|---|
| 200 | Api to Unreserve quantity in invoices only |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/update-knock-off
POST
Summary
Update knock off information
Description
Api to update knock off information
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| knockOffInfos | body | knockOffInfos | Yes | object |
Responses
| Code | Description |
|---|---|
| 200 | Knock off information updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/update/linkedBackOrder
POST
Summary
Update linked documents for SI backorder
Description
API to update linked documents for SI backorder
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| backOrderUpdateRequest | body | backOrderUpdateRequest | Yes | BackOrderUpdateRequest |
Responses
| Code | Description |
|---|---|
| 200 | Linked document for backorder has been successfully updated. |
| 201 | Created |
| 400 | Linked document for backorder update failed. |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/zapier
POST
Summary
Create sales invoice
Description
API to create sales invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceRequest | body | salesInvoiceRequest | Yes | SalesInvoiceRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | SalesInvoiceResponse |
| 201 | Sales invoice has been created successfully. | SalesInvoiceResponse |
| 400 | Sales invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/{code}
GET
Summary
Get sales invoice by code.
Description
API to fetch sales invoice details by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoice information has been fetched successfully. | SalesInvoiceResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/{id}
PUT
Summary
Update sales invoice.
Description
API to update existing sales invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
| salesInvoiceRequest | body | salesInvoiceRequest | Yes | SalesInvoiceRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales Invoice has been updated successfully. | SalesInvoiceResponse |
| 201 | Created | |
| 400 | Sales invoice draft status cannot be changed after saving | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales Invoice with given id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
DELETE
Summary
Delete sales invoice by id.
Description
API to delete sales invoice details by id.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
Responses
| Code | Description |
|---|---|
| 200 | OK |
| 204 | Sales invoice has been deleted successfully. |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Sales invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
PATCH
Summary
Update sales invoice memo or attachment
Description
API to update sales invoice memo or attachment
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
| salesInvoiceFields | body | salesInvoiceFields | Yes | object |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Memo/attachment for sales invoice updated successfully. | SalesInvoiceResponse |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales Invoice with id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
sales-invoice-controller-uae
Sales Invoice UAE APIs
Invoice sales/ae
GET
Summary
Search sales invoices.
Description
API to search sales invoices.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| customfield | query | customfield | No | string |
| limit | query | limit | No | integer |
| page | query | page | No | integer |
| query | query | query | No | string |
| search | query | search | No | string |
| sort | query | sort | No | string |
| sortDir | query | sortDir | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoices have been fetched successfully. | SalesInvoiceResponseUae |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
POST
Summary
Create sales invoice
Description
API to create sales invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceRequest | body | salesInvoiceRequest | Yes | SalesInvoiceRequestUae |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | SalesInvoiceResponseUae |
| 201 | Sales invoice has been created successfully. | SalesInvoiceResponseUae |
| 400 | Sales invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
PUT
Summary
Update sales invoice attributes by code.
Description
API to update attributes of existing sales invoice by code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | query | code | Yes | string |
| request | body | request | Yes | SalesInvoiceUpdateRequest |
Responses
| Code | Description |
|---|---|
| 200 | Sales invoice attributes has been updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Sales invoice with given code not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/ae/bulk
POST
Summary
Create multiple sales invoice
Description
API to create sales invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceRequests | body | salesInvoiceRequests | Yes | [ SalesInvoiceRequestUae ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | SalesInvoiceResponseUae |
| 201 | Sales invoice has been created successfully. | SalesInvoiceResponseUae |
| 400 | Sales invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/ae/bulk-update
PATCH
Summary
Update sales invoices memo or attachment
Description
API to Update sales invoices memo or attachment
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceFields | body | salesInvoiceFields | Yes | [ Map«string,string» ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | BulkApiResponse |
| 204 | No Content | |
| 207 | Memo/attachment for sales invoice updated successfully. | BulkApiResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales Invoice with given id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/ae/code/{code}/details
GET
Summary
Sales invoice details by codes
Description
Sales invoice details by codes
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | SalesInvoiceInformation |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/ae/due-amount
PUT
Summary
Update due amount for sales invoices in bulk.
Description
API to update due amount for sales invoices in bulk.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| invoiceUpdateAmountDueDtoList | body | invoiceUpdateAmountDueDtoList | Yes | [ InvoiceUpdateAmountDueDto ] |
| revert | query | revert | Yes | boolean |
Responses
| Code | Description |
|---|---|
| 200 | Due amounts updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Sales invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/ae/import
POST
Summary
Create multiple sales invoice via import
Description
API to create sales invoice via import.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceRequests | body | salesInvoiceRequests | Yes | [ SalesInvoiceRequestUae ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | BulkApiResponse |
| 201 | Sales invoice has been created successfully. | BulkApiResponse |
| 400 | Sales invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/ae/linked-order/{code}
GET
Summary
Get sales invoices linked to an order by code.
Description
API to fetch sales invoices linked to an order by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoices has been fetched successfully. | SalesInvoiceResponseUae |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/ae/linked-quotation/{code}
GET
Summary
Get sales invoices linked to a quotation by code.
Description
API to fetch sales invoices linked to a quotation by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoices has been fetched successfully. | SalesInvoiceResponseUae |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/ae/report/count
POST
Summary
Get sales invoice count for contacts
Description
API to fetch sales invoice count for contacts
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCodes | body | contactCodes | Yes | [ string ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Contact sales invoice count has been fetched. | object |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/ae/report/overview
GET
Summary
Sales invoice overview report data.
Description
API to fetch sales invoice overview report data
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCode | query | contactCode | No | string |
| interval | query | interval | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoice overview report has been prepared. | InvoiceOverviewReport |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/ae/report/top-customers
GET
Summary
Fetch top customers
Description
API to fetch top customers.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| measure | query | measure | No | string |
| tenure | query | tenure | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Top customers have been determined. | CustomerReport |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/ae/report/top-products
GET
Summary
Fetch top products
Description
API to fetch top products.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| measure | query | measure | No | string |
| tenure | query | tenure | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Top products have been determined. | ProductReport |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/ae/report/unpaid
GET
Summary
Unpaid sales invoices report.
Description
API to fetch unpaid sales invoices
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Unpaid sales invoices report has been prepared. | DashboardReportData |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/ae/{code}
GET
Summary
Get sales invoice by code.
Description
API to fetch sales invoice details by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoice information has been fetched successfully. | SalesInvoiceResponseUae |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/ae/{id}
PUT
Summary
Update sales invoice.
Description
API to update existing sales invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
| salesInvoiceRequest | body | salesInvoiceRequest | Yes | SalesInvoiceRequestUae |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales Invoice has been updated successfully. | SalesInvoiceResponseUae |
| 201 | Created | |
| 400 | Sales invoice draft status cannot be changed after saving | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales Invoice with given id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
DELETE
Summary
Delete sales invoice by id.
Description
API to delete sales invoice details by id.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
Responses
| Code | Description |
|---|---|
| 200 | OK |
| 204 | Sales invoice has been deleted successfully. |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Sales invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
PATCH
Summary
Update sales invoice memo or attachment
Description
API to update sales invoice memo or attachment
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
| salesInvoiceFields | body | salesInvoiceFields | Yes | object |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Memo/attachment for sales invoice updated successfully. | SalesInvoiceResponseUae |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales Invoice with id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
sales-invoice-controller-australia
Sales Invoice Australia APIs
Invoice sales/au
GET
Summary
Search sales invoices.
Description
API to search sales invoices.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| customfield | query | customfield | No | string |
| limit | query | limit | No | integer |
| page | query | page | No | integer |
| query | query | query | No | string |
| search | query | search | No | string |
| sort | query | sort | No | string |
| sortDir | query | sortDir | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoices have been fetched successfully. | SalesInvoiceResponseAustralia |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
POST
Summary
Create sales invoice
Description
API to create sales invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceRequest | body | salesInvoiceRequest | Yes | SalesInvoiceRequestAustralia |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | SalesInvoiceResponseAustralia |
| 201 | Sales invoice has been created successfully. | SalesInvoiceResponseAustralia |
| 400 | Sales invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
PUT
Summary
Update sales invoice attributes by code.
Description
API to update attributes of existing sales invoice by code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | query | code | Yes | string |
| request | body | request | Yes | SalesInvoiceUpdateRequest |
Responses
| Code | Description |
|---|---|
| 200 | Sales invoice attributes has been updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Sales invoice with given code not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/au/bulk
POST
Summary
Create multiple sales invoice
Description
API to create sales invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceRequests | body | salesInvoiceRequests | Yes | [ SalesInvoiceRequestAustralia ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | SalesInvoiceResponseAustralia |
| 201 | Sales invoice has been created successfully. | SalesInvoiceResponseAustralia |
| 400 | Sales invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/au/bulk-update
PATCH
Summary
Update sales invoices memo or attachment
Description
API to Update sales invoices memo or attachment
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceFields | body | salesInvoiceFields | Yes | [ Map«string,string» ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | BulkApiResponse |
| 204 | No Content | |
| 207 | Memo/attachment for sales invoice updated successfully. | BulkApiResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales Invoice with given id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/au/code/{code}/details
GET
Summary
Sales invoice details by codes
Description
Sales invoice details by codes
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | SalesInvoiceInformation |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/au/due-amount
PUT
Summary
Update due amount for sales invoices in bulk.
Description
API to update due amount for sales invoices in bulk.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| invoiceUpdateAmountDueDtoList | body | invoiceUpdateAmountDueDtoList | Yes | [ InvoiceUpdateAmountDueDto ] |
| revert | query | revert | Yes | boolean |
Responses
| Code | Description |
|---|---|
| 200 | Due amounts updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Sales invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/au/import
POST
Summary
Create multiple sales invoice via import
Description
API to create sales invoice via import.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceRequests | body | salesInvoiceRequests | Yes | [ SalesInvoiceRequestAustralia ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | BulkApiResponse |
| 201 | Sales invoice has been created successfully. | BulkApiResponse |
| 400 | Sales invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/au/linked-order/{code}
GET
Summary
Get sales invoices linked to an order by code.
Description
API to fetch sales invoices linked to an order by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoices has been fetched successfully. | SalesInvoiceResponseAustralia |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/au/linked-quotation/{code}
GET
Summary
Get sales invoices linked to a quotation by code.
Description
API to fetch sales invoices linked to a quotation by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoices has been fetched successfully. | SalesInvoiceResponseAustralia |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/au/report/count
POST
Summary
Get sales invoice count for contacts
Description
API to fetch sales invoice count for contacts
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCodes | body | contactCodes | Yes | [ string ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Contact sales invoice count has been fetched. | object |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/au/report/overview
GET
Summary
Sales invoice overview report data.
Description
API to fetch sales invoice overview report data
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCode | query | contactCode | No | string |
| interval | query | interval | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoice overview report has been prepared. | InvoiceOverviewReport |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/au/report/top-customers
GET
Summary
Fetch top customers
Description
API to fetch top customers.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| measure | query | measure | No | string |
| tenure | query | tenure | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Top customers have been determined. | CustomerReport |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/au/report/top-products
GET
Summary
Fetch top products
Description
API to fetch top products.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| measure | query | measure | No | string |
| tenure | query | tenure | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Top products have been determined. | ProductReport |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/au/report/unpaid
GET
Summary
Unpaid sales invoices report.
Description
API to fetch unpaid sales invoices
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Unpaid sales invoices report has been prepared. | DashboardReportData |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/au/{code}
GET
Summary
Get sales invoice by code.
Description
API to fetch sales invoice details by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoice information has been fetched successfully. | SalesInvoiceResponseAustralia |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/au/{id}
PUT
Summary
Update sales invoice.
Description
API to update existing sales invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
| salesInvoiceRequest | body | salesInvoiceRequest | Yes | SalesInvoiceRequestAustralia |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales Invoice has been updated successfully. | SalesInvoiceResponseAustralia |
| 201 | Created | |
| 400 | Sales invoice draft status cannot be changed after saving | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales Invoice with given id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
DELETE
Summary
Delete sales invoice by id.
Description
API to delete sales invoice details by id.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
Responses
| Code | Description |
|---|---|
| 200 | OK |
| 204 | Sales invoice has been deleted successfully. |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Sales invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
PATCH
Summary
Update sales invoice memo or attachment
Description
API to update sales invoice memo or attachment
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
| salesInvoiceFields | body | salesInvoiceFields | Yes | object |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Memo/attachment for sales invoice updated successfully. | SalesInvoiceResponseAustralia |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales Invoice with id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
sales-invoice-controller-belgium
Sales Invoice APIs for Belgium
Invoice sales/be
GET
Summary
Search sales invoices.
Description
API to search sales invoices.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| customfield | query | customfield | No | string |
| limit | query | limit | No | integer |
| page | query | page | No | integer |
| query | query | query | No | string |
| search | query | search | No | string |
| sort | query | sort | No | string |
| sortDir | query | sortDir | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoices have been fetched successfully. | SalesInvoiceResponseAustralia |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
POST
Summary
Create sales invoice
Description
API to create sales invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceRequest | body | salesInvoiceRequest | Yes | SalesInvoiceRequestAustralia |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | SalesInvoiceResponseAustralia |
| 201 | Sales invoice has been created successfully. | SalesInvoiceResponseAustralia |
| 400 | Sales invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
PUT
Summary
Update sales invoice attributes by code.
Description
API to update attributes of existing sales invoice by code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | query | code | Yes | string |
| request | body | request | Yes | SalesInvoiceUpdateRequest |
Responses
| Code | Description |
|---|---|
| 200 | Sales invoice attributes has been updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Sales invoice with given code not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/be/bulk
POST
Summary
Create multiple sales invoice
Description
API to create sales invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceRequests | body | salesInvoiceRequests | Yes | [ SalesInvoiceRequestAustralia ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | SalesInvoiceResponseAustralia |
| 201 | Sales invoice has been created successfully. | SalesInvoiceResponseAustralia |
| 400 | Sales invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/be/bulk-update
PATCH
Summary
Update sales invoices memo or attachment
Description
API to Update sales invoices memo or attachment
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceFields | body | salesInvoiceFields | Yes | [ Map«string,string» ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | BulkApiResponse |
| 204 | No Content | |
| 207 | Memo/attachment for sales invoice updated successfully. | BulkApiResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales Invoice with given id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/be/code/{code}/details
GET
Summary
Sales invoice details by codes
Description
Sales invoice details by codes
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | SalesInvoiceInformation |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/be/due-amount
PUT
Summary
Update due amount for sales invoices in bulk.
Description
API to update due amount for sales invoices in bulk.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| invoiceUpdateAmountDueDtoList | body | invoiceUpdateAmountDueDtoList | Yes | [ InvoiceUpdateAmountDueDto ] |
| revert | query | revert | Yes | boolean |
Responses
| Code | Description |
|---|---|
| 200 | Due amounts updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Sales invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/be/import
POST
Summary
Create multiple sales invoice via import
Description
API to create sales invoice via import.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceRequests | body | salesInvoiceRequests | Yes | [ SalesInvoiceRequestAustralia ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | BulkApiResponse |
| 201 | Sales invoice has been created successfully. | BulkApiResponse |
| 400 | Sales invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/be/linked-order/{code}
GET
Summary
Get sales invoices linked to an order by code.
Description
API to fetch sales invoices linked to an order by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoices has been fetched successfully. | SalesInvoiceResponseAustralia |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/be/linked-quotation/{code}
GET
Summary
Get sales invoices linked to a quotation by code.
Description
API to fetch sales invoices linked to a quotation by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoices has been fetched successfully. | SalesInvoiceResponseAustralia |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/be/report/count
POST
Summary
Get sales invoice count for contacts
Description
API to fetch sales invoice count for contacts
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCodes | body | contactCodes | Yes | [ string ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Contact sales invoice count has been fetched. | object |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/be/report/overview
GET
Summary
Sales invoice overview report data.
Description
API to fetch sales invoice overview report data
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCode | query | contactCode | No | string |
| interval | query | interval | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoice overview report has been prepared. | InvoiceOverviewReport |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/be/report/top-customers
GET
Summary
Fetch top customers
Description
API to fetch top customers.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| measure | query | measure | No | string |
| tenure | query | tenure | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Top customers have been determined. | CustomerReport |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/be/report/top-products
GET
Summary
Fetch top products
Description
API to fetch top products.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| measure | query | measure | No | string |
| tenure | query | tenure | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Top products have been determined. | ProductReport |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/be/report/unpaid
GET
Summary
Unpaid sales invoices report.
Description
API to fetch unpaid sales invoices
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Unpaid sales invoices report has been prepared. | DashboardReportData |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/be/{code}
GET
Summary
Get sales invoice by code.
Description
API to fetch sales invoice details by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoice information has been fetched successfully. | SalesInvoiceResponseAustralia |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/be/{id}
PUT
Summary
Update sales invoice.
Description
API to update existing sales invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
| salesInvoiceRequest | body | salesInvoiceRequest | Yes | SalesInvoiceRequestAustralia |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales Invoice has been updated successfully. | SalesInvoiceResponseAustralia |
| 201 | Created | |
| 400 | Sales invoice draft status cannot be changed after saving | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales Invoice with given id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
DELETE
Summary
Delete sales invoice by id.
Description
API to delete sales invoice details by id.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
Responses
| Code | Description |
|---|---|
| 200 | OK |
| 204 | Sales invoice has been deleted successfully. |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Sales invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
PATCH
Summary
Update sales invoice memo or attachment
Description
API to update sales invoice memo or attachment
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
| salesInvoiceFields | body | salesInvoiceFields | Yes | object |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Memo/attachment for sales invoice updated successfully. | SalesInvoiceResponseAustralia |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales Invoice with id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
sales-invoice-controller-canada
Sales Invoice Canada APIs
Invoice sales/ca
GET
Summary
Search sales invoices.
Description
API to search sales invoices.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| customfield | query | customfield | No | string |
| limit | query | limit | No | integer |
| page | query | page | No | integer |
| query | query | query | No | string |
| search | query | search | No | string |
| sort | query | sort | No | string |
| sortDir | query | sortDir | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoices have been fetched successfully. | SalesInvoiceResponseCanada |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
POST
Summary
Create sales invoice
Description
API to create sales invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceRequest | body | salesInvoiceRequest | Yes | SalesInvoiceRequestCanada |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | SalesInvoiceResponseCanada |
| 201 | Sales invoice has been created successfully. | SalesInvoiceResponseCanada |
| 400 | Sales invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
PUT
Summary
Update sales invoice attributes by code.
Description
API to update attributes of existing sales invoice by code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | query | code | Yes | string |
| request | body | request | Yes | SalesInvoiceUpdateRequest |
Responses
| Code | Description |
|---|---|
| 200 | Sales invoice attributes has been updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Sales invoice with given code not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/ca/bulk
POST
Summary
Create multiple sales invoice
Description
API to create sales invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceRequests | body | salesInvoiceRequests | Yes | [ SalesInvoiceRequestCanada ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | SalesInvoiceResponseCanada |
| 201 | Sales invoice has been created successfully. | SalesInvoiceResponseCanada |
| 400 | Sales invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/ca/bulk-update
PATCH
Summary
Update sales invoices memo or attachment
Description
API to Update sales invoices memo or attachment
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceFields | body | salesInvoiceFields | Yes | [ Map«string,string» ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | BulkApiResponse |
| 204 | No Content | |
| 207 | Memo/attachment for sales invoice updated successfully. | BulkApiResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales Invoice with given id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/ca/code/{code}/details
GET
Summary
Sales invoice details by codes
Description
Sales invoice details by codes
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | SalesInvoiceInformation |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/ca/due-amount
PUT
Summary
Update due amount for sales invoices in bulk.
Description
API to update due amount for sales invoices in bulk.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| invoiceUpdateAmountDueDtoList | body | invoiceUpdateAmountDueDtoList | Yes | [ InvoiceUpdateAmountDueDto ] |
| revert | query | revert | Yes | boolean |
Responses
| Code | Description |
|---|---|
| 200 | Due amounts updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Sales invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/ca/import
POST
Summary
Create multiple sales invoice via import
Description
API to create sales invoice via import.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceRequests | body | salesInvoiceRequests | Yes | [ SalesInvoiceRequestCanada ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | BulkApiResponse |
| 201 | Sales invoice has been created successfully. | BulkApiResponse |
| 400 | Sales invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/ca/linked-order/{code}
GET
Summary
Get sales invoices linked to an order by code.
Description
API to fetch sales invoices linked to an order by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoices has been fetched successfully. | SalesInvoiceResponseCanada |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/ca/linked-quotation/{code}
GET
Summary
Get sales invoices linked to a quotation by code.
Description
API to fetch sales invoices linked to a quotation by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoices has been fetched successfully. | SalesInvoiceResponseCanada |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/ca/report/count
POST
Summary
Get sales invoice count for contacts
Description
API to fetch sales invoice count for contacts
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCodes | body | contactCodes | Yes | [ string ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Contact sales invoice count has been fetched. | object |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/ca/report/overview
GET
Summary
Sales invoice overview report data.
Description
API to fetch sales invoice overview report data
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCode | query | contactCode | No | string |
| interval | query | interval | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoice overview report has been prepared. | InvoiceOverviewReport |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/ca/report/top-customers
GET
Summary
Fetch top customers
Description
API to fetch top customers.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| measure | query | measure | No | string |
| tenure | query | tenure | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Top customers have been determined. | CustomerReport |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/ca/report/top-products
GET
Summary
Fetch top products
Description
API to fetch top products.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| measure | query | measure | No | string |
| tenure | query | tenure | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Top products have been determined. | ProductReport |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/ca/report/unpaid
GET
Summary
Unpaid sales invoices report.
Description
API to fetch unpaid sales invoices
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Unpaid sales invoices report has been prepared. | DashboardReportData |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/ca/{code}
GET
Summary
Get sales invoice by code.
Description
API to fetch sales invoice details by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoice information has been fetched successfully. | SalesInvoiceResponseCanada |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/ca/{id}
PUT
Summary
Update sales invoice.
Description
API to update existing sales invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
| salesInvoiceRequest | body | salesInvoiceRequest | Yes | SalesInvoiceRequestCanada |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales Invoice has been updated successfully. | SalesInvoiceResponseCanada |
| 201 | Created | |
| 400 | Sales invoice draft status cannot be changed after saving | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales Invoice with given id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
DELETE
Summary
Delete sales invoice by id.
Description
API to delete sales invoice details by id.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
Responses
| Code | Description |
|---|---|
| 200 | OK |
| 204 | Sales invoice has been deleted successfully. |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Sales invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
PATCH
Summary
Update sales invoice memo or attachment
Description
API to update sales invoice memo or attachment
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
| salesInvoiceFields | body | salesInvoiceFields | Yes | object |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Memo/attachment for sales invoice updated successfully. | SalesInvoiceResponseCanada |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales Invoice with id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
sales-invoice-controller-germany
Sales Invoice Germany APIs
Invoice sales/de
GET
Summary
Search sales invoices.
Description
API to search sales invoices.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| customfield | query | customfield | No | string |
| limit | query | limit | No | integer |
| page | query | page | No | integer |
| query | query | query | No | string |
| search | query | search | No | string |
| sort | query | sort | No | string |
| sortDir | query | sortDir | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoices have been fetched successfully. | SalesInvoiceResponseGermany |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
POST
Summary
Create sales invoice
Description
API to create sales invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceRequest | body | salesInvoiceRequest | Yes | SalesInvoiceRequestGermany |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | SalesInvoiceResponseGermany |
| 201 | Sales invoice has been created successfully. | SalesInvoiceResponseGermany |
| 400 | Sales invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
PUT
Summary
Update sales invoice attributes by code.
Description
API to update attributes of existing sales invoice by code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | query | code | Yes | string |
| request | body | request | Yes | SalesInvoiceUpdateRequest |
Responses
| Code | Description |
|---|---|
| 200 | Sales invoice attributes has been updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Sales invoice with given code not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/de/bulk
POST
Summary
Create multiple sales invoice
Description
API to create sales invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceRequests | body | salesInvoiceRequests | Yes | [ SalesInvoiceRequestGermany ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | SalesInvoiceResponseGermany |
| 201 | Sales invoice has been created successfully. | SalesInvoiceResponseGermany |
| 400 | Sales invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/de/code/{code}/details
GET
Summary
Sales invoice details by codes
Description
Sales invoice details by codes
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | SalesInvoiceInformation |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/de/due-amount
PUT
Summary
Update due amount for sales invoices in bulk.
Description
API to update due amount for sales invoices in bulk.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| invoiceUpdateAmountDueDtoList | body | invoiceUpdateAmountDueDtoList | Yes | [ InvoiceUpdateAmountDueDto ] |
| revert | query | revert | Yes | boolean |
Responses
| Code | Description |
|---|---|
| 200 | Due amounts updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Sales invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/de/import
POST
Summary
Create multiple sales invoice via import
Description
API to create sales invoice via import.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceRequests | body | salesInvoiceRequests | Yes | [ SalesInvoiceRequestGermany ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | BulkApiResponse |
| 201 | Sales invoice has been created successfully. | BulkApiResponse |
| 400 | Sales invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/de/linked-order/{code}
GET
Summary
Get sales invoices linked to an order by code.
Description
API to fetch sales invoices linked to an order by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoices has been fetched successfully. | SalesInvoiceResponseGermany |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/de/linked-quotation/{code}
GET
Summary
Get sales invoices linked to a quotation by code.
Description
API to fetch sales invoices linked to a quotation by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoices has been fetched successfully. | SalesInvoiceResponseGermany |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/de/report/count
POST
Summary
Get sales invoice count for contacts
Description
API to fetch sales invoice count for contacts
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCodes | body | contactCodes | Yes | [ string ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Contact sales invoice count has been fetched. | object |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/de/report/overview
GET
Summary
Sales invoice overview report data.
Description
API to fetch sales invoice overview report data
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCode | query | contactCode | No | string |
| interval | query | interval | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoice overview report has been prepared. | InvoiceOverviewReport |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/de/report/top-customers
GET
Summary
Fetch top customers
Description
API to fetch top customers.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| measure | query | measure | No | string |
| tenure | query | tenure | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Top customers have been determined. | CustomerReport |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/de/report/top-products
GET
Summary
Fetch top products
Description
API to fetch top products.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| measure | query | measure | No | string |
| tenure | query | tenure | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Top products have been determined. | ProductReport |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/de/report/unpaid
GET
Summary
Unpaid sales invoices report.
Description
API to fetch unpaid sales invoices
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Unpaid sales invoices report has been prepared. | DashboardReportData |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/de/{code}
GET
Summary
Get sales invoice by code.
Description
API to fetch sales invoice details by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoice information has been fetched successfully. | SalesInvoiceResponseGermany |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/de/{id}
PUT
Summary
Update sales invoice.
Description
API to update existing sales invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
| salesInvoiceRequest | body | salesInvoiceRequest | Yes | SalesInvoiceRequestGermany |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales Invoice has been updated successfully. | SalesInvoiceResponseGermany |
| 201 | Created | |
| 400 | Sales invoice draft status cannot be changed after saving | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales Invoice with given id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
DELETE
Summary
Delete sales invoice by id.
Description
API to delete sales invoice details by id.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
Responses
| Code | Description |
|---|---|
| 200 | OK |
| 204 | Sales invoice has been deleted successfully. |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Sales invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
PATCH
Summary
Update sales invoice memo or attachment
Description
API to update sales invoice memo or attachment
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
| salesInvoiceFields | body | salesInvoiceFields | Yes | object |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Memo/attachment for sales invoice updated successfully. | SalesInvoiceResponseGermany |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales Invoice with id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
sales-document-controller
Sales Document APIs
Invoice sales/document
GET
Summary
Search sales documents.
Description
API to search sales documents.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| documentStage | query | documentStage | No | string |
| fromDate | query | fromDate | No | dateTime |
| limit | query | limit | No | integer |
| page | query | page | No | integer |
| search | query | search | No | string |
| sort | query | sort | No | string |
| sortDir | query | sortDir | No | string |
| toDate | query | toDate | No | dateTime |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales documents have been fetched successfully. | Page |
| 400 | Failed to fetch sales documents. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/document/customers
GET
Summary
Top Customers Trend
Description
API for top Customers trend
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| fromDate | query | Yes | long | |
| timePeriod | query | No | string | |
| toDate | query | Yes | long |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Top Customers Trend has been fetched successfully. | Page |
| 400 | Failed to fetch Top Customers Trend | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/document/products
GET
Summary
Top Products Trend
Description
API for top products trend
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| fromDate | query | Yes | long | |
| timePeriod | query | No | string | |
| toDate | query | Yes | long |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Top Products Trend has been fetched successfully. | Page |
| 400 | Failed to fetch Top Products Trend | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/document/sales/invoices
POST
Summary
Sales Invoice Report
Description
Sales Invoice Report API
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| request | body | request | Yes | InvoiceDataESRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales Invoice data fetched from ES successfully. | InvoiceDataESResponse |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/document/summary
GET
Summary
Sales documents summary.
Description
API for sales documents summary.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| fromDate | query | fromDate | No | dateTime |
| search | query | search | No | string |
| toDate | query | toDate | No | dateTime |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales documents summary has been fetched successfully. | DocumentSummaryResponse |
| 400 | Failed to fetch sales documents summary. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/document/vendors
GET
Summary
Top Customers Trend
Description
API for top Customers trend
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| fromDate | query | Yes | long | |
| timePeriod | query | No | string | |
| toDate | query | Yes | long |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Top Customers Trend has been fetched successfully. | Page |
| 400 | Failed to fetch Top Customers Trend | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
sales-invoice-indonesia-controller
Sales Invoice Indonesia APIs
Invoice sales/id
GET
Summary
Search sales invoices.
Description
API to search sales invoices.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| customfield | query | customfield | No | string |
| limit | query | limit | No | integer |
| page | query | page | No | integer |
| query | query | query | No | string |
| search | query | search | No | string |
| sort | query | sort | No | string |
| sortDir | query | sortDir | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoices have been fetched successfully. | SalesInvoiceResponseIndonesia |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
POST
Summary
Create sales invoice
Description
API to create sales invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceRequest | body | salesInvoiceRequest | Yes | SalesInvoiceRequestIndonesia |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | SalesInvoiceResponseIndonesia |
| 201 | Sales invoice has been created successfully. | SalesInvoiceResponseIndonesia |
| 400 | Sales invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
PUT
Summary
Update sales invoice attributes by code.
Description
API to update attributes of existing sales invoice by code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | query | code | Yes | string |
| request | body | request | Yes | SalesInvoiceUpdateRequest |
Responses
| Code | Description |
|---|---|
| 200 | Sales invoice attributes has been updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Sales invoice with given code not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/id/bulk
POST
Summary
Create multiple sales invoice
Description
API to create sales invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceRequests | body | salesInvoiceRequests | Yes | [ SalesInvoiceRequestIndonesia ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | SalesInvoiceResponseIndonesia |
| 201 | Sales invoice has been created successfully. | SalesInvoiceResponseIndonesia |
| 400 | Sales invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/id/bulk-update
PATCH
Summary
Update sales invoices memo or attachment
Description
API to Update sales invoices memo or attachment
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceFields | body | salesInvoiceFields | Yes | [ Map«string,string» ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | BulkApiResponse |
| 204 | No Content | |
| 207 | Memo/attachment for sales invoice updated successfully. | BulkApiResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales Invoice with given id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/id/code/{code}
GET
Summary
Get sales invoice by code.
Description
API to fetch sales invoice details by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoice information has been fetched successfully. | SalesInvoiceResponseIndonesia |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/id/code/{code}/details
GET
Summary
Sales invoice details by codes
Description
Sales invoice details by codes
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | SalesInvoiceInformation |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/id/due-amount
PUT
Summary
Update due amount for sales invoices in bulk.
Description
API to update due amount for sales invoices in bulk.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| invoiceUpdateAmountDueDtoList | body | invoiceUpdateAmountDueDtoList | Yes | [ InvoiceUpdateAmountDueDto ] |
| revert | query | revert | Yes | boolean |
Responses
| Code | Description |
|---|---|
| 200 | Due amounts updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Sales invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/id/import
POST
Summary
Create multiple sales invoice via import
Description
API to create sales invoice via import.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceRequests | body | salesInvoiceRequests | Yes | [ SalesInvoiceRequestIndonesia ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | BulkApiResponse |
| 201 | Sales invoice has been created successfully. | BulkApiResponse |
| 400 | Sales invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/id/linked-order/{code}
GET
Summary
Get sales invoices linked to an order by code.
Description
API to fetch sales invoices linked to an order by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoices has been fetched successfully. | SalesInvoiceResponseIndonesia |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/id/linked-quotation/{code}
GET
Summary
Get sales invoices linked to a quotation by code.
Description
API to fetch sales invoices linked to a quotation by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoices has been fetched successfully. | SalesInvoiceResponseIndonesia |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/id/report/count
POST
Summary
Get sales invoice count for contacts
Description
API to fetch sales invoice count for contacts
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCodes | body | contactCodes | Yes | [ string ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Contact sales invoice count has been fetched. | object |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/id/report/overview
GET
Summary
Sales invoice overview report data.
Description
API to fetch sales invoice overview report data
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCode | query | contactCode | No | string |
| interval | query | interval | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoice overview report has been prepared. | InvoiceOverviewReport |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/id/report/top-customers
GET
Summary
Fetch top customers
Description
API to fetch top customers.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| measure | query | measure | No | string |
| tenure | query | tenure | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Top customers have been determined. | CustomerReport |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/id/report/top-products
GET
Summary
Fetch top products
Description
API to fetch top products.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| measure | query | measure | No | string |
| tenure | query | tenure | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Top products have been determined. | ProductReport |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/id/report/unpaid
GET
Summary
Unpaid sales invoices report.
Description
API to fetch unpaid sales invoices
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Unpaid sales invoices report has been prepared. | DashboardReportData |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/id/{code}
GET
Summary
Get sales invoice by code.
Description
API to fetch sales invoice details by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoice information has been fetched successfully. | SalesInvoiceResponseIndonesia |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/id/{id}
PUT
Summary
Update sales invoice.
Description
API to update existing sales invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
| salesInvoiceRequest | body | salesInvoiceRequest | Yes | SalesInvoiceRequestIndonesia |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales Invoice has been updated successfully. | SalesInvoiceResponseIndonesia |
| 201 | Created | |
| 400 | Sales invoice draft status cannot be changed after saving | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales Invoice with given id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
DELETE
Summary
Delete sales invoice by id.
Description
API to delete sales invoice details by id.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
Responses
| Code | Description |
|---|---|
| 200 | OK |
| 204 | Sales invoice has been deleted successfully. |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Sales invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
PATCH
Summary
Update sales invoice memo or attachment
Description
API to update sales invoice memo or attachment
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
| salesInvoiceFields | body | salesInvoiceFields | Yes | object |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Memo/attachment for sales invoice updated successfully. | SalesInvoiceResponseIndonesia |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales Invoice with id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
sales-invoice-controller-israel
Sales Invoice Israel APIs
Invoice sales/il
GET
Summary
Search sales invoices.
Description
API to search sales invoices.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| customfield | query | customfield | No | string |
| limit | query | limit | No | integer |
| page | query | page | No | integer |
| query | query | query | No | string |
| search | query | search | No | string |
| sort | query | sort | No | string |
| sortDir | query | sortDir | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoices have been fetched successfully. | SalesInvoiceResponseIsrael |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
POST
Summary
Create sales invoice
Description
API to create sales invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceRequest | body | salesInvoiceRequest | Yes | SalesInvoiceRequestIsrael |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | SalesInvoiceResponseIsrael |
| 201 | Sales invoice has been created successfully. | SalesInvoiceResponseIsrael |
| 400 | Sales invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
PUT
Summary
Update sales invoice attributes by code.
Description
API to update attributes of existing sales invoice by code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | query | code | Yes | string |
| request | body | request | Yes | SalesInvoiceUpdateRequest |
Responses
| Code | Description |
|---|---|
| 200 | Sales invoice attributes has been updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Sales invoice with given code not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/il/bulk
POST
Summary
Create multiple sales invoice
Description
API to create sales invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceRequests | body | salesInvoiceRequests | Yes | [ SalesInvoiceRequestIsrael ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | SalesInvoiceResponseIsrael |
| 201 | Sales invoice has been created successfully. | SalesInvoiceResponseIsrael |
| 400 | Sales invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/il/bulk-update
PATCH
Summary
Update sales invoices memo or attachment
Description
API to Update sales invoices memo or attachment
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceFields | body | salesInvoiceFields | Yes | [ Map«string,string» ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | BulkApiResponse |
| 204 | No Content | |
| 207 | Memo/attachment for sales invoice updated successfully. | BulkApiResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales Invoice with given id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/il/code/{code}/details
GET
Summary
Sales invoice details by codes
Description
Sales invoice details by codes
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | SalesInvoiceInformation |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/il/due-amount
PUT
Summary
Update due amount for sales invoices in bulk.
Description
API to update due amount for sales invoices in bulk.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| invoiceUpdateAmountDueDtoList | body | invoiceUpdateAmountDueDtoList | Yes | [ InvoiceUpdateAmountDueDto ] |
| revert | query | revert | Yes | boolean |
Responses
| Code | Description |
|---|---|
| 200 | Due amounts updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Sales invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/il/import
POST
Summary
Create multiple sales invoice via import
Description
API to create sales invoice via import.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceRequests | body | salesInvoiceRequests | Yes | [ SalesInvoiceRequestIsrael ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | BulkApiResponse |
| 201 | Sales invoice has been created successfully. | BulkApiResponse |
| 400 | Sales invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/il/linked-order/{code}
GET
Summary
Get sales invoices linked to an order by code.
Description
API to fetch sales invoices linked to an order by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoices has been fetched successfully. | SalesInvoiceResponseIsrael |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/il/linked-quotation/{code}
GET
Summary
Get sales invoices linked to a quotation by code.
Description
API to fetch sales invoices linked to a quotation by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoices has been fetched successfully. | SalesInvoiceResponseIsrael |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/il/report/count
POST
Summary
Get sales invoice count for contacts
Description
API to fetch sales invoice count for contacts
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCodes | body | contactCodes | Yes | [ string ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Contact sales invoice count has been fetched. | object |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/il/report/overview
GET
Summary
Sales invoice overview report data.
Description
API to fetch sales invoice overview report data
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCode | query | contactCode | No | string |
| interval | query | interval | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoice overview report has been prepared. | InvoiceOverviewReport |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/il/report/top-customers
GET
Summary
Fetch top customers
Description
API to fetch top customers.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| measure | query | measure | No | string |
| tenure | query | tenure | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Top customers have been determined. | CustomerReport |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/il/report/top-products
GET
Summary
Fetch top products
Description
API to fetch top products.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| measure | query | measure | No | string |
| tenure | query | tenure | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Top products have been determined. | ProductReport |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/il/report/unpaid
GET
Summary
Unpaid sales invoices report.
Description
API to fetch unpaid sales invoices
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Unpaid sales invoices report has been prepared. | DashboardReportData |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/il/{code}
GET
Summary
Get sales invoice by code.
Description
API to fetch sales invoice details by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoice information has been fetched successfully. | SalesInvoiceResponseIsrael |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/il/{id}
PUT
Summary
Update sales invoice.
Description
API to update existing sales invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
| salesInvoiceRequest | body | salesInvoiceRequest | Yes | SalesInvoiceRequestIsrael |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales Invoice has been updated successfully. | SalesInvoiceResponseIsrael |
| 201 | Created | |
| 400 | Sales invoice draft status cannot be changed after saving | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales Invoice with given id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
DELETE
Summary
Delete sales invoice by id.
Description
API to delete sales invoice details by id.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
Responses
| Code | Description |
|---|---|
| 200 | OK |
| 204 | Sales invoice has been deleted successfully. |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Sales invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
PATCH
Summary
Update sales invoice memo or attachment
Description
API to update sales invoice memo or attachment
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
| salesInvoiceFields | body | salesInvoiceFields | Yes | object |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Memo/attachment for sales invoice updated successfully. | SalesInvoiceResponseIsrael |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales Invoice with id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
sales-invoice-controller-india
Sales Invoice India APIs
Invoice sales/in
GET
Summary
Search sales invoices.
Description
API to search sales 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 | Sales invoices have been fetched successfully. | SalesInvoiceResponseIndia |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
POST
Summary
Create sales invoice
Description
API to create sales invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceRequest | body | salesInvoiceRequest | Yes | SalesInvoiceRequestIndia |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | SalesInvoiceResponseIndia |
| 201 | Sales invoice has been created successfully. | SalesInvoiceResponseIndia |
| 400 | Sales invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
PUT
Summary
Update sales invoice attributes by code.
Description
API to update attributes of existing sales invoice by code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | query | code | Yes | string |
| request | body | request | Yes | SalesInvoiceUpdateRequest |
Responses
| Code | Description |
|---|---|
| 200 | Sales invoice attributes has been updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Sales invoice with given code not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/in/bulk
POST
Summary
Create multiple sales invoice
Description
API to create sales invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceRequests | body | salesInvoiceRequests | Yes | [ SalesInvoiceRequestIndia ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | SalesInvoiceResponseIndia |
| 201 | Sales invoice has been created successfully. | SalesInvoiceResponseIndia |
| 400 | Sales invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/in/bulk-update
PATCH
Summary
Update sales invoices memo or attachment
Description
API to Update sales invoices memo or attachment
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceFields | body | salesInvoiceFields | Yes | [ Map«string,string» ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | BulkApiResponse |
| 204 | No Content | |
| 207 | Memo/attachment for sales invoice updated successfully. | BulkApiResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales Invoice with given id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/in/code/{code}
GET
Summary
Get sales invoice by code.
Description
API to fetch sales invoice details by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoice information has been fetched successfully. | SalesInvoiceResponseIndia |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/in/code/{code}/details
GET
Summary
Sales invoice details by codes
Description
Sales invoice details by codes
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | SalesInvoiceInformation |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/in/due-amount
PUT
Summary
Update due amount for sales invoices in bulk.
Description
API to update due amount for sales invoices in bulk.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| invoiceUpdateAmountDueDtoList | body | invoiceUpdateAmountDueDtoList | Yes | [ InvoiceUpdateAmountDueDto ] |
| revert | query | revert | Yes | boolean |
Responses
| Code | Description |
|---|---|
| 200 | Due amounts updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Sales invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/in/import
POST
Summary
Create multiple sales invoice via import
Description
API to create sales invoice via import.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceRequests | body | salesInvoiceRequests | Yes | [ SalesInvoiceRequestIndia ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | BulkApiResponse |
| 201 | Sales invoice has been created successfully. | BulkApiResponse |
| 400 | Sales invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/in/linked-order/{code}
GET
Summary
Get sales invoices linked to an order by code.
Description
API to fetch sales invoices linked to an order by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoices has been fetched successfully. | SalesInvoiceResponseIndia |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/in/linked-quotation/{code}
GET
Summary
Get sales invoices linked to a quotation by code.
Description
API to fetch sales invoices linked to a quotation by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoices has been fetched successfully. | SalesInvoiceResponseIndia |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/in/list/{contactCode}
GET
Summary
Get sales invoice by contact code.
Description
API to fetch sales invoice details by contact code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCode | path | contactCode | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoice information has been fetched successfully. | SalesInvoiceResponseIndia |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/in/report/count
POST
Summary
Get sales invoice count for contacts
Description
API to fetch sales invoice count for contacts
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCodes | body | contactCodes | Yes | [ string ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Contact sales invoice count has been fetched. | object |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/in/report/overview
GET
Summary
Sales invoice overview report data.
Description
API to fetch sales invoice overview report data
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCode | query | contactCode | No | string |
| interval | query | interval | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoice overview report has been prepared. | InvoiceOverviewReport |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/in/report/top-customers
GET
Summary
Fetch top customers
Description
API to fetch top customers.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| measure | query | measure | No | string |
| tenure | query | tenure | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Top customers have been determined. | CustomerReport |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/in/report/top-products
GET
Summary
Fetch top products
Description
API to fetch top products.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| measure | query | measure | No | string |
| tenure | query | tenure | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Top products have been determined. | ProductReport |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/in/report/unpaid
GET
Summary
Unpaid sales invoices report.
Description
API to fetch unpaid sales invoices
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Unpaid sales invoices report has been prepared. | DashboardReportData |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/in/{code}
GET
Summary
Get sales invoice by code.
Description
API to fetch sales invoice details by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoice information has been fetched successfully. | SalesInvoiceResponseIndia |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/in/{id}
PUT
Summary
Update sales invoice.
Description
API to update existing sales invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
| salesInvoiceRequest | body | salesInvoiceRequest | Yes | SalesInvoiceRequestIndia |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales Invoice has been updated successfully. | SalesInvoiceResponseIndia |
| 201 | Created | |
| 400 | Sales invoice draft status cannot be changed after saving | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales Invoice with given id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
DELETE
Summary
Delete sales invoice by id.
Description
API to delete sales invoice details by id.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
Responses
| Code | Description |
|---|---|
| 200 | OK |
| 204 | Sales invoice has been deleted successfully. |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Sales invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
PATCH
Summary
Update sales invoice memo or attachment
Description
API to update sales invoice memo or attachment
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
| salesInvoiceFields | body | salesInvoiceFields | Yes | object |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Memo/attachment for sales invoice updated successfully. | SalesInvoiceResponseIndia |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales Invoice with id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
sales-invoice-controller-malaysia
Sales Invoice MALAYSIA APIs
Invoice sales/my
GET
Summary
Search sales invoices.
Description
API to search sales invoices.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| customfield | query | customfield | No | string |
| limit | query | limit | No | integer |
| page | query | page | No | integer |
| query | query | query | No | string |
| search | query | search | No | string |
| sort | query | sort | No | string |
| sortDir | query | sortDir | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoices have been fetched successfully. | SalesInvoiceResponseMalaysia |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
POST
Summary
Create sales invoice
Description
API to create sales invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceRequest | body | salesInvoiceRequest | Yes | SalesInvoiceRequestMalaysia |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | SalesInvoiceResponseMalaysia |
| 201 | Sales invoice has been created successfully. | SalesInvoiceResponseMalaysia |
| 400 | Sales invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
PUT
Summary
Update sales invoice attributes by code.
Description
API to update attributes of existing sales invoice by code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | query | code | Yes | string |
| request | body | request | Yes | SalesInvoiceUpdateRequest |
Responses
| Code | Description |
|---|---|
| 200 | Sales invoice attributes has been updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Sales invoice with given code not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/my/bulk
POST
Summary
Create multiple sales invoice
Description
API to create sales invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceRequests | body | salesInvoiceRequests | Yes | [ SalesInvoiceRequestMalaysia ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | SalesInvoiceResponseMalaysia |
| 201 | Sales invoice has been created successfully. | SalesInvoiceResponseMalaysia |
| 400 | Sales invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/my/bulk-update
PATCH
Summary
Update sales invoices memo or attachment
Description
API to Update sales invoices memo or attachment
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceFields | body | salesInvoiceFields | Yes | [ Map«string,string» ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | BulkApiResponse |
| 204 | No Content | |
| 207 | Memo/attachment for sales invoice updated successfully. | BulkApiResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales Invoice with given id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/my/code/{code}/details
GET
Summary
Sales invoice details by codes
Description
Sales invoice details by codes
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | SalesInvoiceInformation |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/my/due-amount
PUT
Summary
Update due amount for sales invoices in bulk.
Description
API to update due amount for sales invoices in bulk.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| invoiceUpdateAmountDueDtoList | body | invoiceUpdateAmountDueDtoList | Yes | [ InvoiceUpdateAmountDueDto ] |
| revert | query | revert | Yes | boolean |
Responses
| Code | Description |
|---|---|
| 200 | Due amounts updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Sales invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/my/import
POST
Summary
Create multiple sales invoice via import
Description
API to create sales invoice via import.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceRequests | body | salesInvoiceRequests | Yes | [ SalesInvoiceRequestMalaysia ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | BulkApiResponse |
| 201 | Sales invoice has been created successfully. | BulkApiResponse |
| 400 | Sales invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/my/linked-order/{code}
GET
Summary
Get sales invoices linked to an order by code.
Description
API to fetch sales invoices linked to an order by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoices has been fetched successfully. | SalesInvoiceResponseMalaysia |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/my/linked-quotation/{code}
GET
Summary
Get sales invoices linked to a quotation by code.
Description
API to fetch sales invoices linked to a quotation by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoices has been fetched successfully. | SalesInvoiceResponseMalaysia |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/my/report/count
POST
Summary
Get sales invoice count for contacts
Description
API to fetch sales invoice count for contacts
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCodes | body | contactCodes | Yes | [ string ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Contact sales invoice count has been fetched. | object |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/my/report/overview
GET
Summary
Sales invoice overview report data.
Description
API to fetch sales invoice overview report data
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCode | query | contactCode | No | string |
| interval | query | interval | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoice overview report has been prepared. | InvoiceOverviewReport |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/my/report/top-customers
GET
Summary
Fetch top customers
Description
API to fetch top customers.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| measure | query | measure | No | string |
| tenure | query | tenure | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Top customers have been determined. | CustomerReport |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/my/report/top-products
GET
Summary
Fetch top products
Description
API to fetch top products.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| measure | query | measure | No | string |
| tenure | query | tenure | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Top products have been determined. | ProductReport |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/my/report/unpaid
GET
Summary
Unpaid sales invoices report.
Description
API to fetch unpaid sales invoices
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Unpaid sales invoices report has been prepared. | DashboardReportData |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/my/{code}
GET
Summary
Get sales invoice by code.
Description
API to fetch sales invoice details by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoice information has been fetched successfully. | SalesInvoiceResponseMalaysia |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/my/{id}
PUT
Summary
Update sales invoice.
Description
API to update existing sales invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
| salesInvoiceRequest | body | salesInvoiceRequest | Yes | SalesInvoiceRequestMalaysia |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales Invoice has been updated successfully. | SalesInvoiceResponseMalaysia |
| 201 | Created | |
| 400 | Sales invoice draft status cannot be changed after saving | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales Invoice with given id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
DELETE
Summary
Delete sales invoice by id.
Description
API to delete sales invoice details by id.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
Responses
| Code | Description |
|---|---|
| 200 | OK |
| 204 | Sales invoice has been deleted successfully. |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Sales invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
PATCH
Summary
Update sales invoice memo or attachment
Description
API to update sales invoice memo or attachment
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
| salesInvoiceFields | body | salesInvoiceFields | Yes | object |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Memo/attachment for sales invoice updated successfully. | SalesInvoiceResponseMalaysia |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales Invoice with id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
sales-invoice-controller-netherlands
Sales Invoice APIs for Netherlands
Invoice sales/nl
GET
Summary
Search sales invoices.
Description
API to search sales invoices.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| customfield | query | customfield | No | string |
| limit | query | limit | No | integer |
| page | query | page | No | integer |
| query | query | query | No | string |
| search | query | search | No | string |
| sort | query | sort | No | string |
| sortDir | query | sortDir | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoices have been fetched successfully. | SalesInvoiceResponseAustralia |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
POST
Summary
Create sales invoice
Description
API to create sales invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceRequest | body | salesInvoiceRequest | Yes | SalesInvoiceRequestAustralia |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | SalesInvoiceResponseAustralia |
| 201 | Sales invoice has been created successfully. | SalesInvoiceResponseAustralia |
| 400 | Sales invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
PUT
Summary
Update sales invoice attributes by code.
Description
API to update attributes of existing sales invoice by code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | query | code | Yes | string |
| request | body | request | Yes | SalesInvoiceUpdateRequest |
Responses
| Code | Description |
|---|---|
| 200 | Sales invoice attributes has been updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Sales invoice with given code not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/nl/bulk
POST
Summary
Create multiple sales invoice
Description
API to create sales invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceRequests | body | salesInvoiceRequests | Yes | [ SalesInvoiceRequestAustralia ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | SalesInvoiceResponseAustralia |
| 201 | Sales invoice has been created successfully. | SalesInvoiceResponseAustralia |
| 400 | Sales invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/nl/code/{code}/details
GET
Summary
Sales invoice details by codes
Description
Sales invoice details by codes
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | SalesInvoiceInformation |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/nl/due-amount
PUT
Summary
Update due amount for sales invoices in bulk.
Description
API to update due amount for sales invoices in bulk.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| invoiceUpdateAmountDueDtoList | body | invoiceUpdateAmountDueDtoList | Yes | [ InvoiceUpdateAmountDueDto ] |
| revert | query | revert | Yes | boolean |
Responses
| Code | Description |
|---|---|
| 200 | Due amounts updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Sales invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/nl/import
POST
Summary
Create multiple sales invoice via import
Description
API to create sales invoice via import.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceRequests | body | salesInvoiceRequests | Yes | [ SalesInvoiceRequestAustralia ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | BulkApiResponse |
| 201 | Sales invoice has been created successfully. | BulkApiResponse |
| 400 | Sales invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/nl/linked-order/{code}
GET
Summary
Get sales invoices linked to an order by code.
Description
API to fetch sales invoices linked to an order by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoices has been fetched successfully. | SalesInvoiceResponseAustralia |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/nl/linked-quotation/{code}
GET
Summary
Get sales invoices linked to a quotation by code.
Description
API to fetch sales invoices linked to a quotation by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoices has been fetched successfully. | SalesInvoiceResponseAustralia |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/nl/report/count
POST
Summary
Get sales invoice count for contacts
Description
API to fetch sales invoice count for contacts
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCodes | body | contactCodes | Yes | [ string ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Contact sales invoice count has been fetched. | object |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/nl/report/overview
GET
Summary
Sales invoice overview report data.
Description
API to fetch sales invoice overview report data
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCode | query | contactCode | No | string |
| interval | query | interval | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoice overview report has been prepared. | InvoiceOverviewReport |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/nl/report/top-customers
GET
Summary
Fetch top customers
Description
API to fetch top customers.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| measure | query | measure | No | string |
| tenure | query | tenure | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Top customers have been determined. | CustomerReport |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/nl/report/top-products
GET
Summary
Fetch top products
Description
API to fetch top products.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| measure | query | measure | No | string |
| tenure | query | tenure | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Top products have been determined. | ProductReport |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/nl/report/unpaid
GET
Summary
Unpaid sales invoices report.
Description
API to fetch unpaid sales invoices
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Unpaid sales invoices report has been prepared. | DashboardReportData |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/nl/{code}
GET
Summary
Get sales invoice by code.
Description
API to fetch sales invoice details by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoice information has been fetched successfully. | SalesInvoiceResponseAustralia |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/nl/{id}
PUT
Summary
Update sales invoice.
Description
API to update existing sales invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
| salesInvoiceRequest | body | salesInvoiceRequest | Yes | SalesInvoiceRequestAustralia |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales Invoice has been updated successfully. | SalesInvoiceResponseAustralia |
| 201 | Created | |
| 400 | Sales invoice draft status cannot be changed after saving | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales Invoice with given id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
DELETE
Summary
Delete sales invoice by id.
Description
API to delete sales invoice details by id.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
Responses
| Code | Description |
|---|---|
| 200 | OK |
| 204 | Sales invoice has been deleted successfully. |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Sales invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
PATCH
Summary
Update sales invoice memo or attachment
Description
API to update sales invoice memo or attachment
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
| salesInvoiceFields | body | salesInvoiceFields | Yes | object |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Memo/attachment for sales invoice updated successfully. | SalesInvoiceResponseAustralia |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales Invoice with id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
sales-invoice-controller-nz
Sales Invoice APIs for NewZealand
Invoice sales/nz
GET
Summary
Search sales invoices.
Description
API to search sales invoices.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| customfield | query | customfield | No | string |
| limit | query | limit | No | integer |
| page | query | page | No | integer |
| query | query | query | No | string |
| search | query | search | No | string |
| sort | query | sort | No | string |
| sortDir | query | sortDir | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoices have been fetched successfully. | SalesInvoiceResponseAustralia |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
POST
Summary
Create sales invoice
Description
API to create sales invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceRequest | body | salesInvoiceRequest | Yes | SalesInvoiceRequestAustralia |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | SalesInvoiceResponseAustralia |
| 201 | Sales invoice has been created successfully. | SalesInvoiceResponseAustralia |
| 400 | Sales invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
PUT
Summary
Update sales invoice attributes by code.
Description
API to update attributes of existing sales invoice by code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | query | code | Yes | string |
| request | body | request | Yes | SalesInvoiceUpdateRequest |
Responses
| Code | Description |
|---|---|
| 200 | Sales invoice attributes has been updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Sales invoice with given code not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/nz/bulk
POST
Summary
Create multiple sales invoice
Description
API to create sales invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceRequests | body | salesInvoiceRequests | Yes | [ SalesInvoiceRequestAustralia ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | SalesInvoiceResponseAustralia |
| 201 | Sales invoice has been created successfully. | SalesInvoiceResponseAustralia |
| 400 | Sales invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/nz/bulk-update
PATCH
Summary
Update sales invoices memo or attachment
Description
API to Update sales invoices memo or attachment
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceFields | body | salesInvoiceFields | Yes | [ Map«string,string» ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | BulkApiResponse |
| 204 | No Content | |
| 207 | Memo/attachment for sales invoice updated successfully. | BulkApiResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales Invoice with given id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/nz/code/{code}/details
GET
Summary
Sales invoice details by codes
Description
Sales invoice details by codes
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | SalesInvoiceInformation |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/nz/due-amount
PUT
Summary
Update due amount for sales invoices in bulk.
Description
API to update due amount for sales invoices in bulk.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| invoiceUpdateAmountDueDtoList | body | invoiceUpdateAmountDueDtoList | Yes | [ InvoiceUpdateAmountDueDto ] |
| revert | query | revert | Yes | boolean |
Responses
| Code | Description |
|---|---|
| 200 | Due amounts updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Sales invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/nz/import
POST
Summary
Create multiple sales invoice via import
Description
API to create sales invoice via import.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceRequests | body | salesInvoiceRequests | Yes | [ SalesInvoiceRequestAustralia ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | BulkApiResponse |
| 201 | Sales invoice has been created successfully. | BulkApiResponse |
| 400 | Sales invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/nz/linked-order/{code}
GET
Summary
Get sales invoices linked to an order by code.
Description
API to fetch sales invoices linked to an order by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoices has been fetched successfully. | SalesInvoiceResponseAustralia |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/nz/linked-quotation/{code}
GET
Summary
Get sales invoices linked to a quotation by code.
Description
API to fetch sales invoices linked to a quotation by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoices has been fetched successfully. | SalesInvoiceResponseAustralia |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/nz/report/count
POST
Summary
Get sales invoice count for contacts
Description
API to fetch sales invoice count for contacts
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCodes | body | contactCodes | Yes | [ string ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Contact sales invoice count has been fetched. | object |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/nz/report/overview
GET
Summary
Sales invoice overview report data.
Description
API to fetch sales invoice overview report data
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCode | query | contactCode | No | string |
| interval | query | interval | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoice overview report has been prepared. | InvoiceOverviewReport |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/nz/report/top-customers
GET
Summary
Fetch top customers
Description
API to fetch top customers.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| measure | query | measure | No | string |
| tenure | query | tenure | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Top customers have been determined. | CustomerReport |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/nz/report/top-products
GET
Summary
Fetch top products
Description
API to fetch top products.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| measure | query | measure | No | string |
| tenure | query | tenure | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Top products have been determined. | ProductReport |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/nz/report/unpaid
GET
Summary
Unpaid sales invoices report.
Description
API to fetch unpaid sales invoices
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Unpaid sales invoices report has been prepared. | DashboardReportData |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/nz/{code}
GET
Summary
Get sales invoice by code.
Description
API to fetch sales invoice details by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoice information has been fetched successfully. | SalesInvoiceResponseAustralia |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/nz/{id}
PUT
Summary
Update sales invoice.
Description
API to update existing sales invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
| salesInvoiceRequest | body | salesInvoiceRequest | Yes | SalesInvoiceRequestAustralia |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales Invoice has been updated successfully. | SalesInvoiceResponseAustralia |
| 201 | Created | |
| 400 | Sales invoice draft status cannot be changed after saving | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales Invoice with given id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
DELETE
Summary
Delete sales invoice by id.
Description
API to delete sales invoice details by id.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
Responses
| Code | Description |
|---|---|
| 200 | OK |
| 204 | Sales invoice has been deleted successfully. |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Sales invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
PATCH
Summary
Update sales invoice memo or attachment
Description
API to update sales invoice memo or attachment
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
| salesInvoiceFields | body | salesInvoiceFields | Yes | object |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Memo/attachment for sales invoice updated successfully. | SalesInvoiceResponseAustralia |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales Invoice with id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
sales-invoice-controller-philippines
v1/invoices/sales/ph
Invoice sales/ph
GET
Summary
Search sales invoices.
Description
API to search sales invoices.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| customfield | query | customfield | No | string |
| limit | query | limit | No | integer |
| page | query | page | No | integer |
| query | query | query | No | string |
| search | query | search | No | string |
| sort | query | sort | No | string |
| sortDir | query | sortDir | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoices have been fetched successfully. | SalesInvoiceResponsePhilippines |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
POST
Summary
Create sales invoice
Description
API to create sales invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceRequest | body | salesInvoiceRequest | Yes | SalesInvoiceRequestPhilippines |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | SalesInvoiceResponsePhilippines |
| 201 | Sales invoice has been created successfully. | SalesInvoiceResponsePhilippines |
| 400 | Sales invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
PUT
Summary
Update sales invoice attributes by code.
Description
API to update attributes of existing sales invoice by code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | query | code | Yes | string |
| request | body | request | Yes | SalesInvoiceUpdateRequest |
Responses
| Code | Description |
|---|---|
| 200 | Sales invoice attributes has been updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Sales invoice with given code not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/ph/bulk
POST
Summary
Create multiple sales invoice
Description
API to create sales invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceRequests | body | salesInvoiceRequests | Yes | [ SalesInvoiceRequestPhilippines ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | SalesInvoiceResponsePhilippines |
| 201 | Sales invoice has been created successfully. | SalesInvoiceResponsePhilippines |
| 400 | Sales invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/ph/bulk-update
PATCH
Summary
Update sales invoices memo or attachment
Description
API to Update sales invoices memo or attachment
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceFields | body | salesInvoiceFields | Yes | [ Map«string,string» ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | BulkApiResponse |
| 204 | No Content | |
| 207 | Memo/attachment for sales invoice updated successfully. | BulkApiResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales Invoice with given id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/ph/code/{code}/details
GET
Summary
Sales invoice details by codes
Description
Sales invoice details by codes
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | SalesInvoiceInformation |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/ph/due-amount
PUT
Summary
Update due amount for sales invoices in bulk.
Description
API to update due amount for sales invoices in bulk.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| invoiceUpdateAmountDueDtoList | body | invoiceUpdateAmountDueDtoList | Yes | [ InvoiceUpdateAmountDueDto ] |
| revert | query | revert | Yes | boolean |
Responses
| Code | Description |
|---|---|
| 200 | Due amounts updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Sales invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/ph/import
POST
Summary
Create multiple sales invoice via import
Description
API to create sales invoice via import.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceRequests | body | salesInvoiceRequests | Yes | [ SalesInvoiceRequestPhilippines ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | BulkApiResponse |
| 201 | Sales invoice has been created successfully. | BulkApiResponse |
| 400 | Sales invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/ph/linked-order/{code}
GET
Summary
Get sales invoices linked to an order by code.
Description
API to fetch sales invoices linked to an order by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoices has been fetched successfully. | SalesInvoiceResponsePhilippines |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/ph/linked-quotation/{code}
GET
Summary
Get sales invoices linked to a quotation by code.
Description
API to fetch sales invoices linked to a quotation by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoices has been fetched successfully. | SalesInvoiceResponsePhilippines |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/ph/report/count
POST
Summary
Get sales invoice count for contacts
Description
API to fetch sales invoice count for contacts
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCodes | body | contactCodes | Yes | [ string ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Contact sales invoice count has been fetched. | object |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/ph/report/overview
GET
Summary
Sales invoice overview report data.
Description
API to fetch sales invoice overview report data
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCode | query | contactCode | No | string |
| interval | query | interval | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoice overview report has been prepared. | InvoiceOverviewReport |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/ph/report/top-customers
GET
Summary
Fetch top customers
Description
API to fetch top customers.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| measure | query | measure | No | string |
| tenure | query | tenure | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Top customers have been determined. | CustomerReport |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/ph/report/top-products
GET
Summary
Fetch top products
Description
API to fetch top products.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| measure | query | measure | No | string |
| tenure | query | tenure | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Top products have been determined. | ProductReport |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/ph/report/unpaid
GET
Summary
Unpaid sales invoices report.
Description
API to fetch unpaid sales invoices
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Unpaid sales invoices report has been prepared. | DashboardReportData |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/ph/{code}
GET
Summary
Get sales invoice by code.
Description
API to fetch sales invoice details by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoice information has been fetched successfully. | SalesInvoiceResponsePhilippines |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/ph/{id}
PUT
Summary
Update sales invoice.
Description
API to update existing sales invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
| salesInvoiceRequest | body | salesInvoiceRequest | Yes | SalesInvoiceRequestPhilippines |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales Invoice has been updated successfully. | SalesInvoiceResponsePhilippines |
| 201 | Created | |
| 400 | Sales invoice draft status cannot be changed after saving | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales Invoice with given id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
DELETE
Summary
Delete sales invoice by id.
Description
API to delete sales invoice details by id.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
Responses
| Code | Description |
|---|---|
| 200 | OK |
| 204 | Sales invoice has been deleted successfully. |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Sales invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
PATCH
Summary
Update sales invoice memo or attachment
Description
API to update sales invoice memo or attachment
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
| salesInvoiceFields | body | salesInvoiceFields | Yes | object |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Memo/attachment for sales invoice updated successfully. | SalesInvoiceResponsePhilippines |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales Invoice with id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
sales-invoice-controller-sa
Sales Invoice Saudi Arab APIs
Invoice sales/sa
GET
Summary
Search sales invoices.
Description
API to search sales invoices.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| customfield | query | customfield | No | string |
| limit | query | limit | No | integer |
| page | query | page | No | integer |
| query | query | query | No | string |
| search | query | search | No | string |
| sort | query | sort | No | string |
| sortDir | query | sortDir | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoices have been fetched successfully. | SalesInvoiceResponseSA |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
POST
Summary
Create sales invoice
Description
API to create sales invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceRequest | body | salesInvoiceRequest | Yes | SalesInvoiceRequestSA |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | SalesInvoiceResponseSA |
| 201 | Sales invoice has been created successfully. | SalesInvoiceResponseSA |
| 400 | Sales invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
PUT
Summary
Update sales invoice attributes by code.
Description
API to update attributes of existing sales invoice by code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | query | code | Yes | string |
| request | body | request | Yes | SalesInvoiceUpdateRequest |
Responses
| Code | Description |
|---|---|
| 200 | Sales invoice attributes has been updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Sales invoice with given code not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/sa/bulk
POST
Summary
Create multiple sales invoice
Description
API to create sales invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceRequests | body | salesInvoiceRequests | Yes | [ SalesInvoiceRequestSA ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | SalesInvoiceResponseSA |
| 201 | Sales invoice has been created successfully. | SalesInvoiceResponseSA |
| 400 | Sales invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/sa/bulk-update
PATCH
Summary
Update sales invoices memo or attachment
Description
API to Update sales invoices memo or attachment
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceFields | body | salesInvoiceFields | Yes | [ Map«string,string» ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | BulkApiResponse |
| 204 | No Content | |
| 207 | Memo/attachment for sales invoice updated successfully. | BulkApiResponse |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales Invoice with given id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/sa/code/{code}/details
GET
Summary
Sales invoice details by codes
Description
Sales invoice details by codes
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | SalesInvoiceInformation |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/sa/due-amount
PUT
Summary
Update due amount for sales invoices in bulk.
Description
API to update due amount for sales invoices in bulk.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| invoiceUpdateAmountDueDtoList | body | invoiceUpdateAmountDueDtoList | Yes | [ InvoiceUpdateAmountDueDto ] |
| revert | query | revert | Yes | boolean |
Responses
| Code | Description |
|---|---|
| 200 | Due amounts updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Sales invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/sa/import
POST
Summary
Create multiple sales invoice via import
Description
API to create sales invoice via import.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceRequests | body | salesInvoiceRequests | Yes | [ SalesInvoiceRequestSA ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | BulkApiResponse |
| 201 | Sales invoice has been created successfully. | BulkApiResponse |
| 400 | Sales invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/sa/linked-order/{code}
GET
Summary
Get sales invoices linked to an order by code.
Description
API to fetch sales invoices linked to an order by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoices has been fetched successfully. | SalesInvoiceResponseSA |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/sa/linked-quotation/{code}
GET
Summary
Get sales invoices linked to a quotation by code.
Description
API to fetch sales invoices linked to a quotation by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoices has been fetched successfully. | SalesInvoiceResponseSA |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/sa/report/count
POST
Summary
Get sales invoice count for contacts
Description
API to fetch sales invoice count for contacts
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCodes | body | contactCodes | Yes | [ string ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Contact sales invoice count has been fetched. | object |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/sa/report/overview
GET
Summary
Sales invoice overview report data.
Description
API to fetch sales invoice overview report data
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCode | query | contactCode | No | string |
| interval | query | interval | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoice overview report has been prepared. | InvoiceOverviewReport |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/sa/report/top-customers
GET
Summary
Fetch top customers
Description
API to fetch top customers.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| measure | query | measure | No | string |
| tenure | query | tenure | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Top customers have been determined. | CustomerReport |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/sa/report/top-products
GET
Summary
Fetch top products
Description
API to fetch top products.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| measure | query | measure | No | string |
| tenure | query | tenure | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Top products have been determined. | ProductReport |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/sa/report/unpaid
GET
Summary
Unpaid sales invoices report.
Description
API to fetch unpaid sales invoices
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Unpaid sales invoices report has been prepared. | DashboardReportData |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/sa/{code}
GET
Summary
Get sales invoice by code.
Description
API to fetch sales invoice details by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoice information has been fetched successfully. | SalesInvoiceResponseSA |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/sa/{id}
PUT
Summary
Update sales invoice.
Description
API to update existing sales invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
| salesInvoiceRequest | body | salesInvoiceRequest | Yes | SalesInvoiceRequestSA |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales Invoice has been updated successfully. | SalesInvoiceResponseSA |
| 201 | Created | |
| 400 | Sales invoice draft status cannot be changed after saving | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales Invoice with given id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
DELETE
Summary
Delete sales invoice by id.
Description
API to delete sales invoice details by id.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
Responses
| Code | Description |
|---|---|
| 200 | OK |
| 204 | Sales invoice has been deleted successfully. |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Sales invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
PATCH
Summary
Update sales invoice memo or attachment
Description
API to update sales invoice memo or attachment
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
| salesInvoiceFields | body | salesInvoiceFields | Yes | object |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Memo/attachment for sales invoice updated successfully. | SalesInvoiceResponseSA |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales Invoice with id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
sales-invoice-controller-uk
Sales Invoice Uk APIs
Invoice sales/uk
GET
Summary
Search sales invoices.
Description
API to search sales invoices.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| customfield | query | customfield | No | string |
| limit | query | limit | No | integer |
| page | query | page | No | integer |
| query | query | query | No | string |
| search | query | search | No | string |
| sort | query | sort | No | string |
| sortDir | query | sortDir | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoices have been fetched successfully. | SalesInvoiceResponseUk |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
POST
Summary
Create sales invoice
Description
API to create sales invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceRequest | body | salesInvoiceRequest | Yes | SalesInvoiceRequestUk |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | SalesInvoiceResponseUk |
| 201 | Sales invoice has been created successfully. | SalesInvoiceResponseUk |
| 400 | Sales invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
PUT
Summary
Update sales invoice attributes by code.
Description
API to update attributes of existing sales invoice by code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | query | code | Yes | string |
| request | body | request | Yes | SalesInvoiceUpdateRequest |
Responses
| Code | Description |
|---|---|
| 200 | Sales invoice attributes has been updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Sales invoice with given code not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/uk/bulk
POST
Summary
Create multiple sales invoice
Description
API to create sales invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceRequests | body | salesInvoiceRequests | Yes | [ SalesInvoiceRequestUk ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | SalesInvoiceResponseUk |
| 201 | Sales invoice has been created successfully. | SalesInvoiceResponseUk |
| 400 | Sales invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/uk/code/{code}/details
GET
Summary
Sales invoice details by codes
Description
Sales invoice details by codes
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | SalesInvoiceInformation |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/uk/due-amount
PUT
Summary
Update due amount for sales invoices in bulk.
Description
API to update due amount for sales invoices in bulk.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| invoiceUpdateAmountDueDtoList | body | invoiceUpdateAmountDueDtoList | Yes | [ InvoiceUpdateAmountDueDto ] |
| revert | query | revert | Yes | boolean |
Responses
| Code | Description |
|---|---|
| 200 | Due amounts updated successfully. |
| 201 | Created |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Sales invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/uk/import
POST
Summary
Create multiple sales invoice via import
Description
API to create sales invoice via import.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesInvoiceRequests | body | salesInvoiceRequests | Yes | [ SalesInvoiceRequestUk ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | BulkApiResponse |
| 201 | Sales invoice has been created successfully. | BulkApiResponse |
| 400 | Sales invoice could not be created due to insufficient data. | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/uk/linked-order/{code}
GET
Summary
Get sales invoices linked to an order by code.
Description
API to fetch sales invoices linked to an order by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoices has been fetched successfully. | SalesInvoiceResponseUk |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/uk/linked-quotation/{code}
GET
Summary
Get sales invoices linked to a quotation by code.
Description
API to fetch sales invoices linked to a quotation by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoices has been fetched successfully. | SalesInvoiceResponseUk |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/uk/report/count
POST
Summary
Get sales invoice count for contacts
Description
API to fetch sales invoice count for contacts
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCodes | body | contactCodes | Yes | [ string ] |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Contact sales invoice count has been fetched. | object |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/uk/report/overview
GET
Summary
Sales invoice overview report data.
Description
API to fetch sales invoice overview report data
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| contactCode | query | contactCode | No | string |
| interval | query | interval | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoice overview report has been prepared. | InvoiceOverviewReport |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/uk/report/top-customers
GET
Summary
Fetch top customers
Description
API to fetch top customers.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| measure | query | measure | No | string |
| tenure | query | tenure | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Top customers have been determined. | CustomerReport |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/uk/report/top-products
GET
Summary
Fetch top products
Description
API to fetch top products.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| measure | query | measure | No | string |
| tenure | query | tenure | No | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Top products have been determined. | ProductReport |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/uk/report/unpaid
GET
Summary
Unpaid sales invoices report.
Description
API to fetch unpaid sales invoices
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Unpaid sales invoices report has been prepared. | DashboardReportData |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/uk/{code}
GET
Summary
Get sales invoice by code.
Description
API to fetch sales invoice details by it's code.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| code | path | code | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales invoice information has been fetched successfully. | SalesInvoiceResponseUk |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/uk/{id}
PUT
Summary
Update sales invoice.
Description
API to update existing sales invoice.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
| salesInvoiceRequest | body | salesInvoiceRequest | Yes | SalesInvoiceRequestUk |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Sales Invoice has been updated successfully. | SalesInvoiceResponseUk |
| 201 | Created | |
| 400 | Sales invoice draft status cannot be changed after saving | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales Invoice with given id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
DELETE
Summary
Delete sales invoice by id.
Description
API to delete sales invoice details by id.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
Responses
| Code | Description |
|---|---|
| 200 | OK |
| 204 | Sales invoice has been deleted successfully. |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Sales invoice not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
PATCH
Summary
Update sales invoice memo or attachment
Description
API to update sales invoice memo or attachment
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
| salesInvoiceFields | body | salesInvoiceFields | Yes | object |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | Memo/attachment for sales invoice updated successfully. | SalesInvoiceResponseUk |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Sales Invoice with id not found. |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
sales-tax-payment-controller
Sales Tax Payment Controller
Invoice sales/us/delete-sale-tax-payment/{id}
DELETE
Summary
Delete Sales Tax Payment Record.
Description
API to Delete Sales Tax Payment Record.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| id | path | id | Yes | long |
| salesTaxPaymentDto | body | salesTaxPaymentDto | Yes | SalesTaxPaymentDto |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | API to Delete Sales Tax Payment Record. | object |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/us/record-payment
POST
Summary
Record Sales Tax Payment.
Description
API to Record Sales Tax Payment.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesTaxPaymentDto | body | salesTaxPaymentDto | Yes | SalesTaxPaymentDto |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | API to Record Sales Tax Payment. | SalesTaxReviewResponse |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/us/review-payment
POST
Summary
Review Sales Tax Payment.
Description
API to Review Sales Tax Payment.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesTaxPaymentDto | body | salesTaxPaymentDto | Yes | SalesTaxPaymentDto |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | API to Review Sales Tax Payment. | object |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/us/sale-tax-payment
POST
Summary
GET Sales Tax Payment Report.
Description
API to GET Sales Tax Payment Report.
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesTaxPaymentDto | body | salesTaxPaymentDto | Yes | SalesTaxPaymentDto |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | API to GET Sales Tax Payment Report. | object |
| 201 | Created | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Not Found |
Security
| Security Schema | Scopes |
|---|---|
| Authorization | global |
Invoice sales/us/sale-tax-payment-export
POST
Summary
Export Sales Tax Payment Report .
Description
API to Export Sales Tax Payment Report .
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| salesTaxPaymentExportDto | body | salesTaxPaymentExportDto | Yes | SalesTaxPaymentExportDto |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | API to Export Sales Tax Payment Report . | object |
| 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 |
| countryCode | string | Country code Example: "SG" | No |
| customFields | [ CustomFieldItem ] | List of custom fields | No |
| destinationOfSupply | string | state in India Example: "Maharashtra" | No |
| emailId | string | Email address Example: "john.smith@example.com" | No |
| mobileCountryCode | string | Country code of the mobile number Example: "+65" | No |
| mobileNumber | string | Mobile number Example: "98765432" | No |
| placeOfSupply | string | state in India Example: "Punjab" | No |
| postalCode | string | Postal Code Example: 123456 | No |
| preferred | boolean | Is this a default address? Example: true | No |
| state | string | State Example: "CS001" | No |
| stateCode | string | State code Example: "MH" | No |
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 |
ContactIndiaTdsInfo
| Name | Type | Description | Required |
|---|---|---|---|
| considerThresholdLimit | boolean | Consider Exemption Limit can be a check box field Example: true | No |
| deducteeCode | string | Deductee Type Example: "Artificial Juridicial Person" | No |
| deducteeType | string | Deductee Type Example: "Artificial Juridicial Person" | No |
| deductionApplicable | boolean | This field can be visible only if PAN number is mentioned. Example: true | No |
| dttaApplicable | boolean | No | |
| dttaFromDate | dateTime | No | |
| dttaToDate | dateTime | No | |
| higherRate | integer | Percentage value and can be visible only if PAN number is not mentioned. Example: 5 | No |
| noDeductionFromDate | dateTime | Start date field visible only if deductionApplicable field is true Example: "01-01-2020" | No |
| noDeductionReason | string | Choose reason only if deductionApplicable field is true. Example: "TDS not to be made till the Basic Exemption is reached" | No |
| noDeductionRefNo | string | Alphanumeric field and visible only if deductionApplicable field is true. Example: "AAAAABBBB1100" | No |
| noDeductionTdsRate | integer | Special rate override with TDS Rate setting and will be visible only if deductionApplicable field is true Example: 5 | No |
| noDeductionToDate | dateTime | End date field visible only if deductionApplicable field is true Example: "31-12-2020" | No |
| nonDeductionApplicable | boolean | This field can be visible only if PAN number is mentioned. Example: true | No |
| specialRate | integer | No | |
| tan | string | Contact TAN Example: "AAAA99999A" | No |
ContactInfo
| Name | Type | Description | Required |
|---|---|---|---|
| address | string | Address Example: "Raffles Place 1" | No |
| name | string | Customer name Example: "ABC Pte Ltd" | Yes |
| peppolId | string | Peppol ID Example: "u000:1109:uen" | No |
| taxExempted | boolean | True if the contact is tax exempted Example: false | No |
ContactInformation
| Name | Type | Description | Required |
|---|---|---|---|
| beVatIdentificationNo | string | VAT Identification No Example: 123456789012345 | No |
| billingAddress | [ Address ] | List of Billing Address. | No |
| birClassPhilippines | string | BIR class determines the type of business Example: "Services" | No |
| businessRegNo | string | Contact Business Registration No Example: "W10-0108-000000021" | No |
| contactMasterId | string (uuid) | contact master id Example: "2df7a5c1-3305-498d-8d01-aa92c42d19d2" | No |
| contactNumber | string | Contact number Example: "+65999999999" | No |
| creditLimit | number | Credit Limit Example: 100 | No |
| creditLimitInBaseCurrency | number | Credit Limit In Org Currency Example: 100 | No |
| currencyCode | string | Currency code Enum: "AFN", "ALL", "DZD", "AOA", "ARS", "AMD", "AWG", "AZN", "BSD", "BHD", "BDT", "BBD", "BYN", "BZD", "BMD", "BTN", "BOB", "BAM", "BRL", "BND", "BGN", "BIF", "KHR", "CAD", "CVE", "KYD", "CLP", "CNY", "COP", "KMF", "CDF", "CRC", "CZK", "HRK", "CUC", "DJF", "DOP", "EGP", "ERN", "ETB", "FKP", "FJD", "XAF", "GMD", "GEL", "GHS", "GIP", "DKK", "GTQ", "GNF", "GYD", "HTG", "HNL", "HKD", "HUF", "ISK", "INR", "IDR", "IRR", "IQD", "JMD", "JPY", "JOD", "KZT", "KES", "KWD", "KGS", "LAK", "LBP", "LSL", "LRD", "LYD", "MOP", "MKD", "MGA", "MWK", "MYR", "MVR", "MRO", "MUR", "MXN", "MDL", "MNT", "MZN", "MMK", "NAD", "NPR", "NIO", "NGN", "KPW", "OMR", "PKR", "ILS", "PAB", "PGK", "PYG", "PEN", "PHP", "PLN", "QAR", "RON", "RUB", "RWF", "SHP", "XCD", "WST", "STD", "SAR", "RSD", "SCR", "SLL", "SGD", "ANG", "SBD", "SOS", "ZAR", "KRW", "SSP", "EUR", "LKR", "SDG", "SRD", "NOK", "SZL", "SEK", "CHF", "SYP", "TWD", "TJS", "TZS", "THB", "XOF", "NZD", "TOP", "TTD", "TND", "TRY", "TMT", "AUD", "UGX", "UAH", "AED", "GBP", "USD", "UYU", "UZS", "VUV", "VEF", "VND", "XPF", "MAD", "YER", "ZMW", "BWP", "CNH"Example: "SGD" | No |
| customField | [ CustomFieldItem ] | JSON object for custom fields Example: {"field1":"value1","field2":"value2"} | No |
| customerType | string | Customer Type Enum: "EXPORT_WO_PAY", "EXPORT_W_PAY", "NA", "SEZ_WO_PAY", "SEZ_W_PAY"Example: "NA" | No |
| customerTypeMalaysia | string | Customer Type Enum: "NONE", "EXPORT", "SPECIAL_AREA", "DESIGNATED_AREA", "EXEMPTED_UNDER_SCHEDULE_A", "EXEMPTED_UNDER_SCHEDULE_B", "EXEMPTED_UNDER_SCHEDULE_C1_C2", "EXEMPTED_UNDER_SCHEDULE_C3_C4", "EXEMPTED_UNDER_SCHEDULE_C5"Example: "NONE(None)" | No |
| customerTypePhilippines | string | Customer Type Enum: "NORMAL_CORPORATE=Normal(Corporate)", "NORMAL_INDIVIDUAL=Normal(Individual)", "ZERO_RATED_CORPORATE=Zero rated(Corporate)", "ZERO_RATED_INDIVIDUAL=Zero Rated (Individual)", "NORMAL=Normal", "GOVERNMENT=Government"Example: "Normal(Corporate)" | No |
| deVatIdentificationNo | string | VAT Identification No Example: 123456789012345 | No |
| documentSequenceCode | string | Contact Sequence code Example: "C-0000001" | No |
| emailId | string | contact email address Example: "myinfo@domain.com" | No |
| exemptionCertificateMalaysia | boolean | Exemption certificate Example: true | No |
| exemptionCriterialMalaysia | string | Exemption criteria Enum: "NONE", "ZERO_RATED", "EXEMPTED_ZERO"Example: "NONE(None)" | No |
| gstTreatment | string | GST treatment Enum: "REGISTERED_BUSINESS_REGULAR=Registered Business - Regular", "REGISTERED_BUSINESS_COMPOSITION=Registered Business - Composition", "UNREGISTERED_BUSINESS=Unregistered Business", "CUSTOMER=Consumer", "OVERSEAS=Overseas", "SPECIAL_ECONOMIC_ZONE=Special Economic Zone", "DEEMED_EXPORT=Deemed Export"Example: "UnregisteredBusiness" | No |
| gstin | string | Contact GSTIN Example: "21AONPM8088Q211" | No |
| intercompanyType | string | Contact Type either parent or subsidiary Enum: "PARENT", "SUBSIDIARY"Example: "PARENT/SUBSIDIARY" | No |
| invoiceCreditLimitType | string | Invoice Credit Limit Type Enum: "IGNORE", "WARN", "BLOCK"Example: "IGNORE" | No |
| invoices | object | No | |
| isAccountNumberFlag | boolean | indicates if user is sending account number or code Example: true | No |
| isCreditLimitApplicable | boolean | Contact credit limit applicable Example: true | No |
| isIncludeCurrentInvoice | boolean | Include Current Invoice Example: true | No |
| isIncludeCurrentQuotation | boolean | Include Current Quotation Example: true | No |
| isIncludeCurrentSalesOrder | boolean | Include Current Sales Order Example: false | No |
| isParentCompany | boolean | Is Parent company Example: false | No |
| isSubsidiaryCompany | boolean | Is Subsidiary company Example: false | No |
| name | string | Contact name Example: "Sam" | No |
| nikNumber | long | NIK No Example: 123456789012345 | No |
| nlVatIdentificationNo | string | VAT Identification No Example: 123456789012345 | No |
| npwpNumber | long | NPWP No Example: 123456789012345 | No |
| pan | string | Contact PAN Example: "AONPM8088Q" | No |
| payableAccountCode | string | Payable account code Example: "AC002" | No |
| paymentTermCode | string | Payment term code Example: "Net 0" | No |
| purchasePriceLists | [ long ] | Set of Purchase price lists Example: [123,456] | No |
| quotationCreditLimitType | string | Quotation Credit Limit Type Enum: "IGNORE", "WARN", "BLOCK"Example: "IGNORE" | No |
| receivableAccountCode | string | Receivable account code Example: "AC001" | No |
| resident | boolean | Is resident? Example: true | No |
| residentStatusIndonesia | boolean | Resident Status Example: true | No |
| saArabicDetails | ContactSAArabicDto | Contact details in Arabic for Saudi Arabia | No |
| salesOrderCreditLimitType | string | Sales Order Credit Limit Type Enum: "IGNORE", "WARN", "BLOCK"Example: "IGNORE" | No |
| salesPriceLists | [ long ] | Set of Sales price lists Example: [123,456] | No |
| salesTaxRegNo | string | Contact Sales Tax Registration No Example: "W10-0108-000000021" | No |
| sequenceFormat | string | Sequence Format Example: 1 | No |
| serviceTaxRegNo | string | Contact Service Tax Registration No Example: "W10-0108-000000021" | No |
| shippingAddress | [ Address ] | List of Shipping Address. | No |
| taxExempted | boolean | No | |
| taxExemptionNo | string | No | |
| taxExemptionReason | string | No | |
| taxTreatment | string | Tax Treatment Enum: "VAT_Registered", "Non_VAT_Registered", "GCC_VAT_Registered", "GCC_Non_VAT_Registered", "Non_GCC", "VAT_Registered_Designated_Zone", "Non_VAT_Registered_Designated_Zone"Example: "VAT_Registered" | No |
| taxTypeCustomer | string | Tax Types Customer Enum: "TAX_CODE_CUSTOMER_01", "TAX_CODE_CUSTOMER_02", "TAX_CODE_CUSTOMER_03", "TAX_CODE_CUSTOMER_04", "TAX_CODE_CUSTOMER_05", "TAX_CODE_CUSTOMER_06", "TAX_CODE_CUSTOMER_07", "TAX_CODE_CUSTOMER_08"Example: "TAX_CODE_CUSTOMER_01" | No |
| taxTypeVendor | string | Tax Types Vendor Enum: "TAX_CODE_VENDOR_01", "TAX_CODE_VENDOR_02", "TAX_CODE_VENDOR_03", "TAX_CODE_VENDOR_04", "TAX_CODE_VENDOR_05", "TAX_CODE_VENDOR_06", "TAX_CODE_VENDOR_07", "TAX_CODE_VENDOR_08"Example: "TAX_CODE_VENDOR_01" | No |
| tdsApplicableIndia | boolean | No | |
| tdsInfoIndia | ContactIndiaTdsInfo | No | |
| tdsSectionToTdsRateId | long | Contact TDS Section to Tds Rate Id Example: 1213454 | No |
| vatExemptionReasonPhilippines | string | Philippines specific Contact VAT Exemption Reason Example: "Reason" | No |
| vatNoPhilippines | string | Philippines specific Contact VAT No. Example: "012-345-678-910" | No |
| vatRegistrationNo | string | VAT Registration No Example: 123456789012345 | No |
| vatStatusPhilippines | string | Philippines specific Contact VAT Status Example: "Input VAT" | No |
| vendorType | string | Vendor Type Enum: "IMPORT", "NA", "SEZ_W_PAY", "SEZ_WO_PAY"Example: "NA" | No |
| vendorTypeMalaysia | string | Vendor Type Enum: "NONE", "SALES_TAX_EXEMPTION", "MANUFACTURED_EXEMPTION", "PERFORMED_EXEMPTION"Example: "NONE(None)" | No |
| vendorTypePhilippines | string | Vendor Type Enum: "NORMAL_CORPORATE=Normal(Corporate)", "NORMAL_INDIVIDUAL=Normal(Individual)", "ZERO_RATED_CORPORATE=Zero rated(Corporate)", "ZERO_RATED_INDIVIDUAL=Zero Rated (Individual)", "GOVERNMENT=Government", "NORMAL=Normal", "IMPORT=Import"Example: "Normal(Corporate)" | No |
| whtApplicablePhilippines | boolean | Make Contact as WHT applicable Example: true | No |
| whtBusinessPhilippines | string | BIR class determines the type of business Example: "Individual" | No |
ContactSAArabicDto
| Name | Type | Description | Required |
|---|---|---|---|
| billingAddress | [ Address ] | Billing addresses in Arabic language | No |
| saArabicName | string | Example: "Name in Saudi Arabic Language" | No |
| shippingAddress | [ Address ] | Shipping addresses in Arabic language | No |
ContraBillDto
| Name | Type | Description | Required |
|---|---|---|---|
| amount | number | Total amount Example: 12.322 | No |
| billCode | string | Bill code Example: "PI-0000001" | No |
| contactCode | string | Contact code Example: "C-0000001" | No |
| contraBillItems | [ ContraBillItemDto ] | Sales bill item details | No |
| currency | string | Currency Code Enum: "AFN", "ALL", "DZD", "AOA", "ARS", "AMD", "AWG", "AZN", "BSD", "BHD", "BDT", "BBD", "BYN", "BZD", "BMD", "BTN", "BOB", "BAM", "BRL", "BND", "BGN", "BIF", "KHR", "CAD", "CVE", "KYD", "CLP", "CNY", "COP", "KMF", "CDF", "CRC", "CZK", "HRK", "CUC", "DJF", "DOP", "EGP", "ERN", "ETB", "FKP", "FJD", "XAF", "GMD", "GEL", "GHS", "GIP", "DKK", "GTQ", "GNF", "GYD", "HTG", "HNL", "HKD", "HUF", "ISK", "INR", "IDR", "IRR", "IQD", "JMD", "JPY", "JOD", "KZT", "KES", "KWD", "KGS", "LAK", "LBP", "LSL", "LRD", "LYD", "MOP", "MKD", "MGA", "MWK", "MYR", "MVR", "MRO", "MUR", "MXN", "MDL", "MNT", "MZN", "MMK", "NAD", "NPR", "NIO", "NGN", "KPW", "OMR", "PKR", "ILS", "PAB", "PGK", "PYG", "PEN", "PHP", "PLN", "QAR", "RON", "RUB", "RWF", "SHP", "XCD", "WST", "STD", "SAR", "RSD", "SCR", "SLL", "SGD", "ANG", "SBD", "SOS", "ZAR", "KRW", "SSP", "EUR", "LKR", "SDG", "SRD", "NOK", "SZL", "SEK", "CHF", "SYP", "TWD", "TJS", "TZS", "THB", "XOF", "NZD", "TOP", "TTD", "TND", "TRY", "TMT", "AUD", "UGX", "UAH", "AED", "GBP", "USD", "UYU", "UZS", "VUV", "VEF", "VND", "XPF", "MAD", "YER", "ZMW", "BWP", "CNH"Example: "SGD" | Yes |
| documentDate | dateTime | Document Date with pattern dd-mm-yyyy Example: "06-11-2019" | Yes |
| exchangeRate | number | Currency Exchange Rate Example: 1 | No |
ContraBillItemDto
| Name | Type | Description | Required |
|---|---|---|---|
| accountCode | string | AP Account Code Example: "ACC-0000001" | No |
| amount | number | Amount Example: 100 | No |
| salesInvoiceCode | string | Sales invoice code Example: "SI-0000001" | No |
ContraInvoiceDto
| Name | Type | Description | Required |
|---|---|---|---|
| amount | number | Total amount Example: 12.322 | No |
| contactCode | string | Contact code Example: "C-0000001" | No |
| contraInvoiceItems | [ ContraInvoiceItemDto ] | Purchase invoice item details | No |
| currency | string | Currency Code Enum: "AFN", "ALL", "DZD", "AOA", "ARS", "AMD", "AWG", "AZN", "BSD", "BHD", "BDT", "BBD", "BYN", "BZD", "BMD", "BTN", "BOB", "BAM", "BRL", "BND", "BGN", "BIF", "KHR", "CAD", "CVE", "KYD", "CLP", "CNY", "COP", "KMF", "CDF", "CRC", "CZK", "HRK", "CUC", "DJF", "DOP", "EGP", "ERN", "ETB", "FKP", "FJD", "XAF", "GMD", "GEL", "GHS", "GIP", "DKK", "GTQ", "GNF", "GYD", "HTG", "HNL", "HKD", "HUF", "ISK", "INR", "IDR", "IRR", "IQD", "JMD", "JPY", "JOD", "KZT", "KES", "KWD", "KGS", "LAK", "LBP", "LSL", "LRD", "LYD", "MOP", "MKD", "MGA", "MWK", "MYR", "MVR", "MRO", "MUR", "MXN", "MDL", "MNT", "MZN", "MMK", "NAD", "NPR", "NIO", "NGN", "KPW", "OMR", "PKR", "ILS", "PAB", "PGK", "PYG", "PEN", "PHP", "PLN", "QAR", "RON", "RUB", "RWF", "SHP", "XCD", "WST", "STD", "SAR", "RSD", "SCR", "SLL", "SGD", "ANG", "SBD", "SOS", "ZAR", "KRW", "SSP", "EUR", "LKR", "SDG", "SRD", "NOK", "SZL", "SEK", "CHF", "SYP", "TWD", "TJS", "TZS", "THB", "XOF", "NZD", "TOP", "TTD", "TND", "TRY", "TMT", "AUD", "UGX", "UAH", "AED", "GBP", "USD", "UYU", "UZS", "VUV", "VEF", "VND", "XPF", "MAD", "YER", "ZMW", "BWP", "CNH"Example: "SGD" | Yes |
| documentDate | dateTime | Document Date with pattern dd-mm-yyyy Example: "06-11-2019" | Yes |
| invoiceCode | string | Invoice code Example: "SI-0000001" | No |
ContraInvoiceItemDto
| Name | Type | Description | Required |
|---|---|---|---|
| amount | number | Amount Example: 100 | No |
| purchaseInvoiceCode | string | Purchase invoice code Example: "PI-0000001" | No |
CustomFieldItem
| Name | Type | Description | Required |
|---|---|---|---|
| id | long | Dimension Id Example: 11567 | No |
| label | string | Custom Field Name Example: "Label" | Yes |
| module | string | Supported Modules | No |
| value | object | Dimension Value Example: "XYZ" | No |
CustomerInvoiceDto
| Name | Type | Description | Required |
|---|---|---|---|
| amountDue | number | amount due Example: 123654 | No |
| amountPaid | number | amount paid Example: 123654 | No |
| createdOn | string | Invoice Creation Date Example: "2020-11-12" | No |
| currency | string | Currency Example: "USD" | No |
| customerEmail | string | Customer Email Example: "demo@getnda.com" | No |
| dueDate | string | Invoice Due Date Example: "2020-11-12" | No |
| hostedInvoiceURL | string | Invoice Stripe Payment URL Example: "www.stripe.com/payment" | No |
| invoiceNumber | string | Invoice Number Example: "INV001" | No |
| invoicePDF | string | Invoice PDF Example: "invoicePDF" | No |
| platformInvoiceID | string | Invoice Platform ID Example: "platformInvoiceID" | No |
| status | string | Invoice Status Example: "paid" | No |
CustomerReport
| Name | Type | Description | Required |
|---|---|---|---|
| code | string | No | |
| name | string | No | |
| sale | number | No | |
| volume | number | No |
DashboardReportData
| Name | Type | Description | Required |
|---|---|---|---|
| awaitingPayment | number | No | |
| currentWeek | integer | No | |
| currentYear | Year | No | |
| data | object | No | |
| draftInvoices | number | No | |
| invoiceAmount | number | No | |
| overdue | number | No | |
| pendingReceipt | number | No |
DocumentAccountItemDetails
| Name | Type | Description | Required |
|---|---|---|---|
| account | AccountDto | Product Short Info Example: "product" | No |
| accountCode | string | Account code Example: "AC-00001" | Yes |
| accountDescription | string | Account description Example: "Worker's Compensation" | No |
| amount | number | Amount Example: 0.7 | Yes |
| tax | TaxDto | Tax details Example: "taxDto" | No |
| taxCode | string | Tax code Example: "tax code" | No |
DocumentInfo
| Name | Type | Description | Required |
|---|---|---|---|
| documentCode | string | Document Code. Example: "QO-0000001" | No |
| documentCreatedDate | dateTime | Purchase creation date Example: "2023-01-01T00:00:00.000+0000" | No |
| documentSequenceCode | string | Purchase Order Code Example: "0000001" | No |
| documentType | string | Type of document. Enum: "QUOTATION", "PURCHASE_ORDER", "SALES_ORDER", "PURCHASE_INVOICE", "SALES_INVOICE", "MAKE_PAYMENT", "RECEIVE_PAYMENT", "JOURNAL_ENTRY", "BANK_TRANSFER", "CREDIT_NOTE", "DEBIT_NOTE", "EXPENSE", "EXPENSE_PREPAYMENT", "DEPOSIT", "DEPOSIT_ADVPAYMENT", "CONTRA_ADJUSTMENT", "GOODS_RECEIPT", "FULFILLMENT", "PICKLIST", "PACKLIST", "SHIPLIST", "PAYSLIP", "PAYROLL_CHECK", "CHEQUE", "SALES_RETURN", "PURCHASE_RETURN", "STOCK_ADJUSTMENT", "STOCK_TRANSFER", "WORK_ORDER", "FIXED_ASSET", "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"Example: "QUOTATION" | No |
DocumentItemDetails
| Name | Type | Description | Required |
|---|---|---|---|
| documentSequenceCode | string | Product Document Sequence code Example: "P-0000001" | Yes |
| documentUom | long | UOM id Example: 111 | No |
| itemId | long | Document Item id Example: 154 | Yes |
| product | ProductResponse | Product Short Info Example: "product" | No |
| productCode | string | Product code Example: "P00001" | Yes |
| productDescription | string | Product description Example: "Apple watch" | No |
| productName | string | Product Name Example: "iPhone" | No |
| productQuantity | number | Product quantity Example: 2 | Yes |
| tax | TaxDto | Tax details Example: "taxDto" | No |
| taxCode | string | Tax code Example: "tax code" | No |
| unitPrice | number | Product unit price Example: 0.7 | Yes |
DocumentItemTaxMappingDto
| Name | Type | Description | Required |
|---|---|---|---|
| additionalTaxIn | boolean | true/false Example: true | No |
| taxAmount | number | Tax amount Example: 10 | No |
| taxApplyTo | string | Tax Apply To (Pre/AFTER) Example: "Pre" | No |
| taxCode | string | Tax Code Example: "GST (10%)" | No |
| taxName | string | Tax Name Example: "GST (10%)" | No |
| taxRate | number | Tax rate Example: 10 | No |
| taxSeqCode | string | Tax Sequence Code Example: "0000001" | No |
| taxableAmount | number | Taxable Amount Example: 100 | No |
DocumentMetadata
| Name | Type | Description | Required |
|---|---|---|---|
| pages | integer | No |
DocumentSummaryResponse
| Name | Type | Description | Required |
|---|---|---|---|
| closedDocumentAmount | number | Total amount of closed documents Example: 1234.52 | No |
| closedDocumentCount | long | Total closed documents Example: 821 | No |
| initialStageAmount | number | Total amount of all initial stage documents Example: 1020.12 | No |
| initialStageCount | long | Total documents at initial stage Example: 821 | No |
| invoiceAmount | number | Total amount of all invoices Example: 3010.49 | No |
| invoiceCount | long | Total invoices Example: 512 | No |
DocumentUOMSchemaDefinition
| Name | Type | Description | Required |
|---|---|---|---|
| name | string | UOM Schema Name Example: "UNIT" | No |
| schemaId | long | UOM Schema Id Example: 1 | No |
| sinkConversionFactor | number | 10 Example: 10 | No |
| sinkUOM | long | 2 Example: 2 | No |
| sourceConversionFactor | number | 1 Example: 1 | No |
| sourceUOM | long | 4 Example: 4 | No |
| uid | string | UOM Schema Definition Id Example: 1 | No |
DuplicatePaymentDto
| Name | Type | Description | Required |
|---|---|---|---|
| contactCode | string | No | |
| paymentCode | string | No | |
| salesInvoiceCode | string | No |
EWayBillAuthTokenRequestDto
| Name | Type | Description | Required |
|---|---|---|---|
| gstin | string | No | |
| password | string | No | |
| username | string | No |
EWayBillAuthTokenResponseDto
| Name | Type | Description | Required |
|---|---|---|---|
| appKey | string | No | |
| asp_secret_key | string | No | |
| authtoken | string | No | |
| error | object | No | |
| sek | string | No | |
| session_id | string | No | |
| status | string | No | |
| tokenExp | string | No |
EWayBillInfoIndia
| Name | Type | Description | Required |
|---|---|---|---|
| alert | string | No | |
| appKey | string | No | |
| data | string | No | |
| documentSeqCode | string | No | |
| error | IrnResponseErrorDetails | No | |
| errorDetails | [ IrnResponseErrorDetailsList ] | No | |
| ewayBillDate | string | No | |
| ewayBillNo | string | No | |
| id | long | No | |
| isTokenActive | boolean | No | |
| postEwbDate | dateTime | No | |
| sek | string | No | |
| status | string | No | |
| validUpto | string | No |
EinvoiceInfoIndia
| Name | Type | Description | Required |
|---|---|---|---|
| ackDt | string | No | |
| ackNo | string | No | |
| appKey | string | No | |
| data | string | No | |
| error | IrnResponseErrorDetails | No | |
| errorDetails | [ IrnResponseErrorDetailsList ] | No | |
| ewbDt | string | No | |
| ewbNo | string | No | |
| ewbValidTill | string | No | |
| id | long | No | |
| irn | string | No | |
| isTokenActive | boolean | No | |
| postEinvoiceDate | dateTime | No | |
| remarks | string | No | |
| sek | string | No | |
| signedInvoice | string | No | |
| signedQRCode | string | No | |
| status | string | No |
EinvoiceInfoIndiaCancel
| Name | Type | Description | Required |
|---|---|---|---|
| appKey | string | No | |
| cancelDate | string | No | |
| data | string | No | |
| error | IrnResponseErrorDetails | No | |
| errorDetails | [ IrnResponseErrorDetailsList ] | No | |
| id | long | No | |
| irn | string | No | |
| isTokenActive | boolean | No | |
| sek | string | No | |
| status | string | No |
EwayIndiaRequest
| Name | Type | Description | Required |
|---|---|---|---|
| airwayBillDate | dateTime | Airway bill date. Format is dd/MM/yyyy | No |
| airwayBillNo | string | Airway bill number | No |
| billFrom | Address | Bill from address | No |
| billOfLadingDate | dateTime | Bill of lading date. Format is dd/MM/yyyy | No |
| billOfLadingNo | string | Bill of Lading number | No |
| billTo | Address | Billing addresses | No |
| customerName | string | Customer name | No |
| distanceInKm | double | Distance in KM | No |
| ewayBillNo | string | Eway Bill Number | No |
| ewayBillStatus | string | Eway Bill Status Enum: "NOT_GENERATED", "GENERATED", "CANCELLED", "EXPIRED", "EXCLUDED", "GENERATION_FAILED" | No |
| ewayDocumentType | string | Eway document type Enum: "INVOICE", "CREDIT_NOTES", "DELIVERY_CHALLANS" | No |
| salesInvoiceCode | string | Sales invoice code | No |
| shipByDate | dateTime | The Due Date for shipping. Date Format is dd/MM/yyyy Example: "01/01/2020" | No |
| shipFrom | Address | Ship from address | No |
| shipTo | Address | Shipping addresses | No |
| totalAmount | number | Total amount | No |
| totalCessAmount | number | Total cess amount | No |
| totalCgstAmount | number | Total CGST amount | No |
| totalIgstAmount | number | Total IGST amount | No |
| totalSgstAmount | number | Total SGST amount | No |
| totalTaxableAmount | number | Total Taxable amount | No |
| transactionSubType | string | Transaction sub type Enum: "SUPPLY", "IMPORT", "EXPORT", "JOB_WORK", "FOR_OWN_USE", "JOB_WORK_RETURNS", "SALES_RETURN", "OTHERS" | No |
| transactionType | string | Transaction type Enum: "REGULAR", "BILL_TO_SHIP_TO", "BILL_FROM_DISPATCH_FROM", "COMBINATION_OF_2_AND_3" | No |
| transportationMode | string | Transportation Mode Enum: "ROAD", "RAIL", "AIR", "SHIP" | No |
| transporterDocDate | dateTime | Transporter's document date. Format is dd/MM/yyyy | No |
| transporterDocNo | string | Transporter's document number | No |
| transporterName | string | Transporter name | No |
| vehicleNo | string | Vehicle number | No |
| vehicleType | string | Vehicle type Enum: "REGULAR", "OVER_DIMENSIONAL_CARGO" | No |
EwayIndiaResponse
| Name | Type | Description | Required |
|---|---|---|---|
| airwayBillDate | dateTime | Airway bill date. Format is dd/MM/yyyy | No |
| airwayBillNo | string | Airway bill number | No |
| billFrom | Address | Bill from address | No |
| billOfLadingDate | dateTime | Bill of lading date. Format is dd/MM/yyyy | No |
| billOfLadingNo | string | Bill of Lading number | No |
| billTo | Address | Billing addresses | No |
| customerName | string | Customer name | No |
| distanceInKm | double | Distance in KM | No |
| errorDetails | [ IndiaFailureLogReportErrorsDto ] | EWay bill error details. | No |
| ewayBillDate | dateTime | The EWay bill date. Date Format is dd/MM/yyyy Example: "01-01-2020" | No |
| ewayBillNo | string | Eway Bill Number | No |
| ewayBillStatus | string | Eway Bill Status Enum: "NOT_GENERATED", "GENERATED", "CANCELLED", "EXPIRED", "EXCLUDED", "GENERATION_FAILED" | No |
| ewayDocumentType | string | Eway document type Enum: "INVOICE", "CREDIT_NOTES", "DELIVERY_CHALLANS" | No |
| salesInvoice | SalesInvoiceResponseIndia | Sales invoice item details | No |
| salesInvoiceCode | string | Sales invoice code | No |
| shipByDate | dateTime | The Due Date for shipping. Date Format is dd/MM/yyyy Example: "01-01-2020" | No |
| shipFrom | Address | Ship from address | No |
| shipTo | Address | Shipping addresses | No |
| totalAmount | number | Total amount | No |
| totalCessAmount | number | Total cess amount | No |
| totalCgstAmount | number | Total CGST amount | No |
| totalIgstAmount | number | Total IGST amount | No |
| totalSgstAmount | number | Total SGST amount | No |
| totalTaxableAmount | number | Total Taxable amount | No |
| transactionSubType | string | Transaction sub type Enum: "SUPPLY", "IMPORT", "EXPORT", "JOB_WORK", "FOR_OWN_USE", "JOB_WORK_RETURNS", "SALES_RETURN", "OTHERS" | No |
| transactionType | string | Transaction type Enum: "REGULAR", "BILL_TO_SHIP_TO", "BILL_FROM_DISPATCH_FROM", "COMBINATION_OF_2_AND_3" | No |
| transportationMode | string | Transportation Mode Enum: "ROAD", "RAIL", "AIR", "SHIP" | No |
| transporterDocDate | dateTime | Transporter's document date. Format is dd/MM/yyyy | No |
| transporterDocNo | string | Transporter's document number | No |
| transporterId | string | Transporter id | No |
| transporterName | string | Transporter name | No |
| validUptoDate | dateTime | The EWay bill valid upto date. Date Format is dd/MM/yyyy Example: "01-01-2020" | No |
| vehicleNo | string | Vehicle number | No |
| vehicleType | string | Vehicle type Enum: "REGULAR", "OVER_DIMENSIONAL_CARGO" | No |
EwbDetailsDto
| Name | Type | Description | Required |
|---|---|---|---|
| billFrom | Address | Bill from address | No |
| billTo | Address | Billing addresses | No |
| distanceInKm | double | Distance in KM | No |
| ewayBillStatus | string | Eway Bill Status Enum: "NOT_GENERATED", "GENERATED", "CANCELLED", "EXPIRED", "EXCLUDED", "GENERATION_FAILED" | No |
| ewayDocumentType | string | Eway document type Enum: "INVOICE", "CREDIT_NOTES", "DELIVERY_CHALLANS" | No |
| id | long | Invoice ID | No |
| shipFrom | Address | Ship from address | No |
| shipTo | Address | Shipping addresses | No |
| transactionSubType | string | Transaction sub type Enum: "SUPPLY", "IMPORT", "EXPORT", "JOB_WORK", "FOR_OWN_USE", "JOB_WORK_RETURNS", "SALES_RETURN", "OTHERS" | No |
| transactionSubTypeDescForOthers | string | Transaction sub type description for Others | No |
| transactionType | string | Transaction type Enum: "REGULAR", "BILL_TO_SHIP_TO", "BILL_FROM_DISPATCH_FROM", "COMBINATION_OF_2_AND_3" | No |
| transportationMode | string | Transportation Mode Enum: "ROAD", "RAIL", "AIR", "SHIP" | No |
| transporterDocDate | dateTime | Transporter's document date. Format is dd/MM/yyyy | No |
| transporterDocNo | string | Transporter's document number | No |
| transporterId | string | Transporter Id | No |
| transporterName | string | Transporter Name | No |
| vehicleNo | string | Vehicle number | No |
| vehicleType | string | Vehicle type Enum: "REGULAR", "OVER_DIMENSIONAL_CARGO" | No |
EwbRequestDto
| Name | Type | Description | Required |
|---|---|---|---|
| appKey | string | No | |
| asp_secret_key | string | No | |
| authtoken | string | No | |
| billFrom | Address | Bill from address | No |
| billTo | Address | Billing addresses | No |
| distanceInKm | double | Distance in KM | No |
| ewayBillStatus | string | Eway Bill Status Enum: "NOT_GENERATED", "GENERATED", "CANCELLED", "EXPIRED", "EXCLUDED", "GENERATION_FAILED" | No |
| ewayDocumentType | string | Eway document type Enum: "INVOICE", "CREDIT_NOTES", "DELIVERY_CHALLANS" | No |
| gstin | string | No | |
| id | long | Invoice ID | No |
| sek | string | No | |
| session_id | string | No | |
| shipFrom | Address | Ship from address | No |
| shipTo | Address | Shipping addresses | No |
| status | string | No | |
| tokenExp | string | No | |
| transactionSubType | string | Transaction sub type Enum: "SUPPLY", "IMPORT", "EXPORT", "JOB_WORK", "FOR_OWN_USE", "JOB_WORK_RETURNS", "SALES_RETURN", "OTHERS" | No |
| transactionSubTypeDescForOthers | string | Transaction sub type description for Others | No |
| transactionType | string | Transaction type Enum: "REGULAR", "BILL_TO_SHIP_TO", "BILL_FROM_DISPATCH_FROM", "COMBINATION_OF_2_AND_3" | No |
| transportationMode | string | Transportation Mode Enum: "ROAD", "RAIL", "AIR", "SHIP" | No |
| transporterDocDate | dateTime | Transporter's document date. Format is dd/MM/yyyy | No |
| transporterDocNo | string | Transporter's document number | No |
| transporterId | string | Transporter Id | No |
| transporterName | string | Transporter Name | No |
| userName | string | No | |
| vehicleNo | string | Vehicle number | No |
| vehicleType | string | Vehicle type Enum: "REGULAR", "OVER_DIMENSIONAL_CARGO" | No |
ExportDocumentRequest
| Name | Type | Description | Required |
|---|---|---|---|
| categoryName | string | QUOTE,INVOICE etc Example: "QUOTE" | Yes |
| customTemplate | boolean | Invoice Custom Template flag Example: false | No |
| documentCode | string | Document system number , could be invoice number, quotation number etc. Example: "00001" | No |
| documentNumber | string | Document number , could be invoice number, quotation number etc. Example: "00001" | No |
| documentType | 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 |
| fileName | string | File name of the template Example: "QUOTE.DOCX" | No |
| headers | [ Map«string,object» ] | No | |
| moduleName | string | ERP,CRM,HRMS Example: "ERP" | Yes |
| skipDocumentTemplateMapping | boolean | Skip document template mapping Example: false | No |
| templateId | long | Template id Example: 12 | No |
File
| Name | Type | Description | Required |
|---|---|---|---|
| absolute | boolean | No | |
| absoluteFile | File | No | |
| absolutePath | string | No | |
| canonicalFile | File | No | |
| canonicalPath | string | No | |
| directory | boolean | No | |
| file | boolean | No | |
| freeSpace | long | No | |
| hidden | boolean | No | |
| name | string | No | |
| parent | string | No | |
| parentFile | File | No | |
| path | string | No | |
| totalSpace | long | No | |
| usableSpace | long | No |
FilterCondition
| Name | Type | Description | Required |
|---|---|---|---|
| colId | string | No | |
| opr | string | No | |
| value | string | No |
FilterRecord
| Name | Type | Description | Required |
|---|---|---|---|
| filterConditions | [ FilterCondition ] | No | |
| logicalOperator | string | No | |
| uniqueId | long | No |
Geometry
| Name | Type | Description | Required |
|---|---|---|---|
| boundingBox | BoundingBox | No | |
| polygon | [ Point ] | No |
GlobalDiscountDetails
| Name | Type | Description | Required |
|---|---|---|---|
| accountCode | string | No | |
| amount | number | No | |
| isPercent | boolean | No | |
| isSubTotalOnly | boolean | No | |
| name | string | No | |
| percent | number | No |
HumanLoopActivationOutput
| Name | Type | Description | Required |
|---|---|---|---|
| humanLoopActivationConditionsEvaluationResults | string | No | |
| humanLoopActivationReasons | [ string ] | No | |
| humanLoopArn | string | No |
IndiaFailureLogReportDto
| Name | Type | Description | Required |
|---|---|---|---|
| contact | ContactInfo | Contact details | Yes |
| contactCode | string | Contact Code Example: "C0001" | Yes |
| currency | string | Currency Example: "C001" | Yes |
| documentSequenceCode | string | Sales invoice Sequence Code Example: "0000001" | No |
| errorDetails | [ IndiaFailureLogReportErrorsDto ] | eInvoice submit error details. | No |
| id | long | Sales invoice id Example: 1 | No |
| salesInvoiceCode | string | Sales invoice code Example: "SI001" | No |
| salesInvoiceDate | string | Sales Invoice date Example: "25-10-2019" | Yes |
| salesInvoiceDueDate | string | Sales Invoice due date Example: "25-10-2019" | Yes |
| totalAmount | number | Total amount Example: 12.322 | No |
| totalAmountInBaseCurrency | number | Total amount in base currency Example: 12.322 | No |
IndiaFailureLogReportErrorsDto
| Name | Type | Description | Required |
|---|---|---|---|
| errorCode | string | No | |
| errorMessage | string | No |
InputStream
| Name | Type | Description | Required |
|---|---|---|---|
| InputStream | object |
InventoryDto
| Name | Type | Description | Required |
|---|---|---|---|
| availableQuantity | double | Available quantity Example: 100 | No |
| binCode | string | bin code Example: "BIN-00001" | Yes |
| binName | string | bin name Example: "BIN-NAME" | No |
| costOfGoodsSoldAccountCode | string | Cost of goods sold account code Example: "A-10231" | Yes |
| inventoryAccountCode | string | Inventory account code Example: "A-10232" | Yes |
| inventoryAccountName | string | Inventory account name Example: "Inventory Account" | Yes |
| landedCostWeight | number | Landed cost weight value Example: 10.5 | No |
| openingQuantity | double | Opening quantity Example: 10 | No |
| openingValuation | double | Opening valuation Example: 100.4 | No |
| rackCode | string | Rack code Example: "RACK-00001" | Yes |
| rackName | string | Rack name Example: "RACK-NAME" | No |
| reservedQuantity | double | Reserved quantity Example: 100 | No |
| rowCode | string | Row code Example: "ROW-00001" | Yes |
| rowName | string | Row name Example: "ROW-NAME" | No |
| stockAdjustmentAccountCode | string | Stock adjustment account code Example: "A-10234" | Yes |
| warehouseCode | string | Warehouse code Example: "WH-00001" | Yes |
| wipInventoryAccountCode | string | WIP Inventory account code Example: "A-10233" | Yes |
InventoryWarehouseDetails
| Name | Type | Description | Required |
|---|---|---|---|
| availableQuantity | number | Available quantity Example: 100 | No |
| openingQuantity | number | Opening quantity Example: 10 | No |
| openingValuation | number | Opening Valuation Example: 1000 | No |
| warehouseCode | string | Warehouse code Example: "WH-00001" | Yes |
InvoiceAmountDueByContact
| Name | Type | Description | Required |
|---|---|---|---|
| contactCode | string | Contact code Example: "C-0000001" | Yes |
| dueAmount | number | due amount Example: 46 | No |
InvoiceContactOpening
| Name | Type | Description | Required |
|---|---|---|---|
| invoices | object | No | |
| totalBillAmount | number | No | |
| totalNetAmount | number | No |
InvoiceDataESRequest
| Name | Type | Description | Required |
|---|---|---|---|
| fromDate | long | The from date, in milliseconds Example: 1583366400000 | No |
| timeInterval | string | The time interval. Can be DAY/MONTH/QUARTER/YEAR Enum: "DAY", "MONTH", "QUARTER", "YEAR"Example: "MONTH" | No |
| toDate | long | The to date, in milliseconds Example: 1583366400000 | No |
InvoiceDataESResponse
| Name | Type | Description | Required |
|---|---|---|---|
| aggregationBuckets | [ AggregationBucket ] | Example: [{"date":"187238483743","totalAmount":196238},{"date":"177238483743","totalAmount":296238.55}] | No |
InvoiceOverview
| Name | Type | Description | Required |
|---|---|---|---|
| count | integer | No | |
| data | [ TenureData ] | No | |
| dueAmount | number | No | |
| totalAmount | number | No |
InvoiceOverviewReport
| Name | Type | Description | Required |
|---|---|---|---|
| drafts | InvoiceOverview | No | |
| overdue | InvoiceOverview | No | |
| paid | InvoiceOverview | No | |
| pendingPayment | InvoiceOverview | No | |
| pendingReceipt | InvoiceOverview | No | |
| total | InvoiceOverview | No |
InvoiceReportInfo
| Name | Type | Description | Required |
|---|---|---|---|
| adjustment | string | No | |
| contactName | string | No | |
| docCurrency | string | No | |
| documentCode | string | No | |
| dueAmount | string | No | |
| fulfillmentStatus | string | No | |
| invoiceDateFormat | string | No | |
| invoiceDueDateFormat | string | No | |
| journalEntryCode | string | No | |
| paymentStatus | string | No | |
| totalAmount | string | No |
InvoiceRequestDto
| Name | Type | Description | Required |
|---|---|---|---|
| addProcessingFee | boolean | flag to add processing fee Example: true | No |
| amount | number | Invoice amount Example: 3546.23 | No |
| companyName | string | No | |
| currency | string | Currency Example: "USD" | No |
| customerEmail | string | Customer email Example: "john@doe.com" | No |
| customerName | string | Customer Name Example: "John" | No |
| daysUntilDue | long | due date Example: 30 | No |
| description | string | Description Example: "Invoice for inventory" | No |
| dueAmount | number | No | |
| dueDate | string | No | |
| invoiceAmount | number | No | |
| invoiceDate | string | No | |
| invoiceNumber | string | No | |
| platformDetails | PlatformDetailsDto | Platform details dto Example: "platformDetailsDto" | No |
InvoiceResponseInfo
| Name | Type | Description | Required |
|---|---|---|---|
| currency | string | No | |
| documentCode | string | document code Example: "SI-0000041" | No |
| documentSequenceCode | string | Document Sequence Code Example: "00000001" | No |
| dueAmount | number | due amount Example: 46 | No |
| exchangeRate | number | No | |
| id | long | ID Example: 43 | No |
| invoiceDate | dateTime | invoice date Example: "2018-10-01" | No |
| invoiceDueDate | dateTime | invoice due date Example: "2018-10-01" | No |
| memo | string | memo Example: "test" | No |
| purchaseOrderRefNo | string | Contact PO reference number Example: "CPO001" | No |
| status | string | Enum: "OPEN", "DRAFT", "CLOSED" | No |
| supplierInvoiceNo | string | Contact supplier invoice number Example: "CSI001" | No |
| taxAmount | number | Total Amount Example: 1 | No |
| totalAmount | number | total amount Example: 46 | No |
| totalAmountInBaseCurrency | number | total amount in base currency Example: 46 | No |
| type | string | sale invoice or purchase invoice Example: "sale_invoice" | No |
InvoiceUpdateAmountDueDto
| Name | Type | Description | Required |
|---|---|---|---|
| amount | number | No | |
| bulkData | [ BulkPaymentItem ] | No | |
| currency | string | 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" | No |
| documentCode | string | No | |
| documentDate | dateTime | No | |
| documentType | 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 |
| exchangeRate | number | No | |
| invoiceCode | string | No | |
| invoiceDocumentSeqCode | string | No | |
| linkedDocumentSequence | string | No | |
| linkedWhileCreatingNote | boolean | No | |
| paymentDocument | boolean | No | |
| tdsAccountCode | string | No | |
| tdsAmount | number | No | |
| uid | string (uuid) | No |
IrnAuthTokenRequestDto
| Name | Type | Description | Required |
|---|---|---|---|
| gstin | string | No | |
| password | string | No | |
| username | string | No |
IrnAuthTokenResponseDto
| Name | Type | Description | Required |
|---|---|---|---|
| appKey | string | No | |
| asp_secret_key | string | No | |
| authtoken | string | No | |
| errors | [ Map«string,string» ] | No | |
| sek | string | No | |
| session_id | string | No | |
| status | string | No | |
| tokenExp | string | No | |
| userName | string | No |
IrnBulkRequestDto
| Name | Type | Description | Required |
|---|---|---|---|
| appKey | string | No | |
| asp_secret_key | string | No | |
| authtoken | string | No | |
| gstin | string | No | |
| ids | [ long ] | No | |
| sek | string | No | |
| session_id | string | No | |
| status | string | No | |
| tokenExp | string | No | |
| userName | string | No |
IrnRequestBulkCancelDto
| Name | Type | Description | Required |
|---|---|---|---|
| appKey | string | No | |
| asp_secret_key | string | No | |
| authtoken | string | No | |
| cancelDetails | [ CancelDetail ] | No | |
| gstin | string | No | |
| sek | string | No | |
| session_id | string | No | |
| status | string | No | |
| tokenExp | string | No | |
| userName | string | No |
IrnRequestCancelDto
| Name | Type | Description | Required |
|---|---|---|---|
| appKey | string | No | |
| asp_secret_key | string | No | |
| authtoken | string | No | |
| cnlRem | string | No | |
| cnlRsn | string | No | |
| documentCode | string | No | |
| documentType | string | Enum: "INVOICE", "CREDIT_NOTE", "DEBIT_NOTE" | No |
| gstin | string | No | |
| id | long | No | |
| irn | string | No | |
| sek | string | No | |
| session_id | string | No | |
| status | string | No | |
| tokenExp | string | No | |
| userName | string | No |
IrnRequestDto
| Name | Type | Description | Required |
|---|---|---|---|
| appKey | string | No | |
| asp_secret_key | string | No | |
| authtoken | string | No | |
| documentCode | string | No | |
| documentType | string | Enum: "INVOICE", "CREDIT_NOTE", "DEBIT_NOTE" | No |
| gstin | string | No | |
| id | long | No | |
| sek | string | No | |
| session_id | string | No | |
| status | string | No | |
| tokenExp | string | No | |
| userName | string | No |
IrnResponseErrorDetails
| Name | Type | Description | Required |
|---|---|---|---|
| error_cd | string | No | |
| message | string | No |
IrnResponseErrorDetailsList
| Name | Type | Description | Required |
|---|---|---|---|
| errorCode | string | No | |
| errorMessage | string | No |
ItemQtyFulfilledByDoc
| Name | Type | Description | Required |
|---|---|---|---|
| fulfillmentId | string | No | |
| siAmount | number | No |
JournalAdjustmentBillsSummarySA
| Name | Type | Description | Required |
|---|---|---|---|
| totalTaxAmount | number | Total tax payable Example: 20 | No |
| totalTaxPaidAmount | number | Total tax amount Booked/Paid Example: 10 | No |
| totalTaxableAmount | number | Total taxable value of CUSTOM / RCM bills Example: 1000 | No |
JournalBillDetailsSA
| Name | Type | Description | Required |
|---|---|---|---|
| contactCode | string | Contact Code Example: "0000001" | No |
| contactName | string | Contact name Example: "Contact A" | No |
| documentSequenceCode | string | Purchase Invoice Sequence Code Example: "0000001" | No |
| purchaseInvoiceCode | string | Purchase Invoice Code Example: "0000001" | No |
| purchaseInvoiceDate | string | Purchase Invoice date Example: "25-10-2019" | No |
| taxAmount | number | Tax amount Example: 2.322 | No |
| taxRate | number | VAT rate Example: 2 | No |
| taxableAmount | number | Taxable amount Example: 1000 | No |
KnockOffInfo
| Name | Type | Description | Required |
|---|---|---|---|
| amount | number | No | |
| bulkData | [ BulkPaymentItem ] | No | |
| contraDocumentCode | string | No | |
| currency | string | No | |
| documentCode | string | No | |
| documentDate | dateTime | No | |
| documentOrder | integer | No | |
| documentType | 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 |
| exchangeRate | number | No | |
| linkedDocumentSequence | string | No | |
| linkedWhileCreatingNote | boolean | No | |
| uid | string (uuid) | No | |
| whtAmount | number | No |
LandedCostCategory
| Name | Type | Description | Required |
|---|---|---|---|
| allocationType | string | Enum: "QUANTITY", "VALUE", "WEIGHT", "MANUAL", "CUSTOM_DUTY" | No |
| name | string | No |
LandedCostDetails
| Name | Type | Description | Required |
|---|---|---|---|
| allocationType | string | Enum: "QUANTITY", "VALUE", "WEIGHT", "MANUAL", "CUSTOM_DUTY" | No |
| categoryName | string | No | |
| landedCostCategory | string | No | |
| productDetails | [ LandedCostProductDetails ] | No |
LandedCostProductDetails
| Name | Type | Description | Required |
|---|---|---|---|
| allocatedCost | number | No | |
| customDutyAndOtherCharges | number | No | |
| gstRate | string | No | |
| hsncode | string | No | |
| igst | number | No | |
| product | string | No | |
| productId | string | No | |
| quantity | number | No | |
| taxableValueForCustomDuty | number | No | |
| taxableValueForIGST | number | No | |
| totalAmount | number | No | |
| unitPrice | number | No |
LinkedDocumentResponse
| Name | Type | Description | Required |
|---|---|---|---|
| documentDate | dateTime | Purchase Invoice date Example: "25-10-2019" | Yes |
| documentSequenceCode | string | Purchase invoice Sequence Code Example: "0000001" | No |
| dueAmount | number | Amount Due Example: 12.322 | No |
| totalAmount | number | Total Invoice amount Example: 12.322 | No |
LinkedDocumentsDto
| Name | Type | Description | Required |
|---|---|---|---|
| code | string | No | |
| used | boolean | No |
LinkedSalesInvoiceResponse
| Name | Type | Description | Required |
|---|---|---|---|
| documentSequenceCode | string | Sales invoice Sequence Code Example: "0000001" | No |
| dueAmount | number | Amount Due Example: 12.322 | No |
| exchangeRate | number | Exchange rate Example: 0.456345 | No |
| fulfillmentStatus | string | fulfillment status Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"Example: "PARTIAL_FULFILLED" | No |
| salesInvoiceCode | string | Sales invoice code Example: "SI001" | No |
| salesInvoiceDate | string | Sales Invoice date Example: "25-10-2019" | Yes |
| totalAmount | number | Total Amount Example: 1234.33 | No |
LinkedSalesOrderResponse
| Name | Type | Description | Required |
|---|---|---|---|
| documentSequenceCode | string | Sales order Sequence Code Example: "0000001" | No |
| dueAmount | number | Amount Due Example: 12.322 | No |
| exchangeRate | number | Exchange rate Example: 0.456345 | No |
| fulfillmentStatus | string | fulfillment status Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"Example: "PARTIAL_FULFILLED" | No |
| salesOrderCode | string | Sales order code Example: "SO-001" | No |
| salesOrderDate | string | Sales Invoice date Example: "25-10-2019" | Yes |
LinkedWareHouse
| Name | Type | Description | Required |
|---|---|---|---|
| binCode | string | bin code Example: "BIN-00001" | Yes |
| quantity | number | Quantity from Warehouse. Example: 100 | No |
| rackCode | string | Rack code Example: "RACK-00001" | Yes |
| rowCode | string | Row code Example: "ROW-00001" | Yes |
| warehouseCode | string | Warehouse code to identify the Warehouse. Example: "WH-0000001" | No |
Map«string,UsaSalesTaxByRegion»
| Name | Type | Description | Required |
|---|---|---|---|
| Map«string,UsaSalesTaxByRegion» | object |
Map«string,bigdecimal»
| Name | Type | Description | Required |
|---|---|---|---|
| Map«string,bigdecimal» | object |
Map«string,object»
| Name | Type | Description | Required |
|---|---|---|---|
| Map«string,object» | object |
Map«string,string»
| Name | Type | Description | Required |
|---|---|---|---|
| Map«string,string» | object |
MemoUpdateDto
| Name | Type | Description | Required |
|---|---|---|---|
| code | string | No | |
| memo | string | No |
PPSReservedQuantityData
| Name | Type | Description | Required |
|---|---|---|---|
| itemId | long | Document Item id Example: 154 | Yes |
| reservedQuantitiesData | [ ReservedQuantityData ] | Reserved quantity data Example: [] | No |
Page
| Name | Type | Description | Required |
|---|---|---|---|
| content | [ object ] | No | |
| empty | boolean | No | |
| first | boolean | No | |
| last | boolean | No | |
| number | integer | No | |
| numberOfElements | integer | No | |
| pageable | Pageable | No | |
| size | integer | No | |
| sort | Sort | No | |
| totalElements | long | No | |
| totalPages | integer | No |
Pageable
| Name | Type | Description | Required |
|---|---|---|---|
| offset | long | No | |
| pageNumber | integer | No | |
| pageSize | integer | No | |
| paged | boolean | No | |
| sort | Sort | No | |
| unpaged | boolean | No |
Page«EwayIndiaResponse»
| Name | Type | Description | Required |
|---|---|---|---|
| content | [ EwayIndiaResponse ] | No | |
| empty | boolean | No | |
| first | boolean | No | |
| last | boolean | No | |
| number | integer | No | |
| numberOfElements | integer | No | |
| pageable | Pageable | No | |
| size | integer | No | |
| sort | Sort | No | |
| totalElements | long | No | |
| totalPages | integer | No |
Page«IndiaFailureLogReportDto»
| Name | Type | Description | Required |
|---|---|---|---|
| content | [ IndiaFailureLogReportDto ] | No | |
| empty | boolean | No | |
| first | boolean | No | |
| last | boolean | No | |
| number | integer | No | |
| numberOfElements | integer | No | |
| pageable | Pageable | No | |
| size | integer | No | |
| sort | Sort | No | |
| totalElements | long | No | |
| totalPages | integer | No |
Page«JournalBillDetailsSA»
| Name | Type | Description | Required |
|---|---|---|---|
| content | [ JournalBillDetailsSA ] | No | |
| empty | boolean | No | |
| first | boolean | No | |
| last | boolean | No | |
| number | integer | No | |
| numberOfElements | integer | No | |
| pageable | Pageable | No | |
| size | integer | No | |
| sort | Sort | No | |
| totalElements | long | No | |
| totalPages | integer | No |
Page«PaymentMilestoneDetailsResponse»
| Name | Type | Description | Required |
|---|---|---|---|
| content | [ PaymentMilestoneDetailsResponse ] | No | |
| empty | boolean | No | |
| first | boolean | No | |
| last | boolean | No | |
| number | integer | No | |
| numberOfElements | integer | No | |
| pageable | Pageable | No | |
| size | integer | No | |
| sort | Sort | No | |
| totalElements | long | No | |
| totalPages | integer | No |
Page«PurchaseInvoiceResponseAustralia»
| Name | Type | Description | Required |
|---|---|---|---|
| content | [ PurchaseInvoiceResponseAustralia ] | No | |
| empty | boolean | No | |
| first | boolean | No | |
| last | boolean | No | |
| number | integer | No | |
| numberOfElements | integer | No | |
| pageable | Pageable | No | |
| size | integer | No | |
| sort | Sort | No | |
| totalElements | long | No | |
| totalPages | integer | No |
Page«PurchaseInvoiceResponseCanada»
| Name | Type | Description | Required |
|---|---|---|---|
| content | [ PurchaseInvoiceResponseCanada ] | No | |
| empty | boolean | No | |
| first | boolean | No | |
| last | boolean | No | |
| number | integer | No | |
| numberOfElements | integer | No | |
| pageable | Pageable | No | |
| size | integer | No | |
| sort | Sort | No | |
| totalElements | long | No | |
| totalPages | integer | No |
Page«PurchaseInvoiceResponseGermany»
| Name | Type | Description | Required |
|---|---|---|---|
| content | [ PurchaseInvoiceResponseGermany ] | No | |
| empty | boolean | No | |
| first | boolean | No | |
| last | boolean | No | |
| number | integer | No | |
| numberOfElements | integer | No | |
| pageable | Pageable | No | |
| size | integer | No | |
| sort | Sort | No | |
| totalElements | long | No | |
| totalPages | integer | No |
Page«PurchaseInvoiceResponseIndia»
| Name | Type | Description | Required |
|---|---|---|---|
| content | [ PurchaseInvoiceResponseIndia ] | No | |
| empty | boolean | No | |
| first | boolean | No | |
| last | boolean | No | |
| number | integer | No | |
| numberOfElements | integer | No | |
| pageable | Pageable | No | |
| size | integer | No | |
| sort | Sort | No | |
| totalElements | long | No | |
| totalPages | integer | No |
Page«PurchaseInvoiceResponseIndonesia»
| Name | Type | Description | Required |
|---|---|---|---|
| content | [ PurchaseInvoiceResponseIndonesia ] | No | |
| empty | boolean | No | |
| first | boolean | No | |
| last | boolean | No | |
| number | integer | No | |
| numberOfElements | integer | No | |
| pageable | Pageable | No | |
| size | integer | No | |
| sort | Sort | No | |
| totalElements | long | No | |
| totalPages | integer | No |
Page«PurchaseInvoiceResponseIsrael»
| Name | Type | Description | Required |
|---|---|---|---|
| content | [ PurchaseInvoiceResponseIsrael ] | No | |
| empty | boolean | No | |
| first | boolean | No | |
| last | boolean | No | |
| number | integer | No | |
| numberOfElements | integer | No | |
| pageable | Pageable | No | |
| size | integer | No | |
| sort | Sort | No | |
| totalElements | long | No | |
| totalPages | integer | No |
Page«PurchaseInvoiceResponseMalaysia»
| Name | Type | Description | Required |
|---|---|---|---|
| content | [ PurchaseInvoiceResponseMalaysia ] | No | |
| empty | boolean | No | |
| first | boolean | No | |
| last | boolean | No | |
| number | integer | No | |
| numberOfElements | integer | No | |
| pageable | Pageable | No | |
| size | integer | No | |
| sort | Sort | No | |
| totalElements | long | No | |
| totalPages | integer | No |
Page«PurchaseInvoiceResponsePhilippines»
| Name | Type | Description | Required |
|---|---|---|---|
| content | [ PurchaseInvoiceResponsePhilippines ] | No | |
| empty | boolean | No | |
| first | boolean | No | |
| last | boolean | No | |
| number | integer | No | |
| numberOfElements | integer | No | |
| pageable | Pageable | No | |
| size | integer | No | |
| sort | Sort | No | |
| totalElements | long | No | |
| totalPages | integer | No |
Page«PurchaseInvoiceResponseSA»
| Name | Type | Description | Required |
|---|---|---|---|
| content | [ PurchaseInvoiceResponseSA ] | No | |
| empty | boolean | No | |
| first | boolean | No | |
| last | boolean | No | |
| number | integer | No | |
| numberOfElements | integer | No | |
| pageable | Pageable | No | |
| size | integer | No | |
| sort | Sort | No | |
| totalElements | long | No | |
| totalPages | integer | No |
Page«PurchaseInvoiceResponseUae»
| Name | Type | Description | Required |
|---|---|---|---|
| content | [ PurchaseInvoiceResponseUae ] | No | |
| empty | boolean | No | |
| first | boolean | No | |
| last | boolean | No | |
| number | integer | No | |
| numberOfElements | integer | No | |
| pageable | Pageable | No | |
| size | integer | No | |
| sort | Sort | No | |
| totalElements | long | No | |
| totalPages | integer | No |
Page«PurchaseInvoiceResponseUk»
| Name | Type | Description | Required |
|---|---|---|---|
| content | [ PurchaseInvoiceResponseUk ] | No | |
| empty | boolean | No | |
| first | boolean | No | |
| last | boolean | No | |
| number | integer | No | |
| numberOfElements | integer | No | |
| pageable | Pageable | No | |
| size | integer | No | |
| sort | Sort | No | |
| totalElements | long | No | |
| totalPages | integer | No |
Page«PurchaseInvoiceResponse»
| Name | Type | Description | Required |
|---|---|---|---|
| content | [ PurchaseInvoiceResponse ] | No | |
| empty | boolean | No | |
| first | boolean | No | |
| last | boolean | No | |
| number | integer | No | |
| numberOfElements | integer | No | |
| pageable | Pageable | No | |
| size | integer | No | |
| sort | Sort | No | |
| totalElements | long | No | |
| totalPages | integer | No |
Page«SalesInvoiceResponseAustralia»
| Name | Type | Description | Required |
|---|---|---|---|
| content | [ SalesInvoiceResponseAustralia ] | No | |
| empty | boolean | No | |
| first | boolean | No | |
| last | boolean | No | |
| number | integer | No | |
| numberOfElements | integer | No | |
| pageable | Pageable | No | |
| size | integer | No | |
| sort | Sort | No | |
| totalElements | long | No | |
| totalPages | integer | No |
Page«SalesInvoiceResponseCanada»
| Name | Type | Description | Required |
|---|---|---|---|
| content | [ SalesInvoiceResponseCanada ] | No | |
| empty | boolean | No | |
| first | boolean | No | |
| last | boolean | No | |
| number | integer | No | |
| numberOfElements | integer | No | |
| pageable | Pageable | No | |
| size | integer | No | |
| sort | Sort | No | |
| totalElements | long | No | |
| totalPages | integer | No |
Page«SalesInvoiceResponseGermany»
| Name | Type | Description | Required |
|---|---|---|---|
| content | [ SalesInvoiceResponseGermany ] | No | |
| empty | boolean | No | |
| first | boolean | No | |
| last | boolean | No | |
| number | integer | No | |
| numberOfElements | integer | No | |
| pageable | Pageable | No | |
| size | integer | No | |
| sort | Sort | No | |
| totalElements | long | No | |
| totalPages | integer | No |
Page«SalesInvoiceResponseIndia»
| Name | Type | Description | Required |
|---|---|---|---|
| content | [ SalesInvoiceResponseIndia ] | No | |
| empty | boolean | No | |
| first | boolean | No | |
| last | boolean | No | |
| number | integer | No | |
| numberOfElements | integer | No | |
| pageable | Pageable | No | |
| size | integer | No | |
| sort | Sort | No | |
| totalElements | long | No | |
| totalPages | integer | No |
Page«SalesInvoiceResponseIndonesia»
| Name | Type | Description | Required |
|---|---|---|---|
| content | [ SalesInvoiceResponseIndonesia ] | No | |
| empty | boolean | No | |
| first | boolean | No | |
| last | boolean | No | |
| number | integer | No | |
| numberOfElements | integer | No | |
| pageable | Pageable | No | |
| size | integer | No | |
| sort | Sort | No | |
| totalElements | long | No | |
| totalPages | integer | No |
Page«SalesInvoiceResponseIsrael»
| Name | Type | Description | Required |
|---|---|---|---|
| content | [ SalesInvoiceResponseIsrael ] | No | |
| empty | boolean | No | |
| first | boolean | No | |
| last | boolean | No | |
| number | integer | No | |
| numberOfElements | integer | No | |
| pageable | Pageable | No | |
| size | integer | No | |
| sort | Sort | No | |
| totalElements | long | No | |
| totalPages | integer | No |
Page«SalesInvoiceResponseMalaysia»
| Name | Type | Description | Required |
|---|---|---|---|
| content | [ SalesInvoiceResponseMalaysia ] | No | |
| empty | boolean | No | |
| first | boolean | No | |
| last | boolean | No | |
| number | integer | No | |
| numberOfElements | integer | No | |
| pageable | Pageable | No | |
| size | integer | No | |
| sort | Sort | No | |
| totalElements | long | No | |
| totalPages | integer | No |
Page«SalesInvoiceResponsePhilippines»
| Name | Type | Description | Required |
|---|---|---|---|
| content | [ SalesInvoiceResponsePhilippines ] | No | |
| empty | boolean | No | |
| first | boolean | No | |
| last | boolean | No | |
| number | integer | No | |
| numberOfElements | integer | No | |
| pageable | Pageable | No | |
| size | integer | No | |
| sort | Sort | No | |
| totalElements | long | No | |
| totalPages | integer | No |
Page«SalesInvoiceResponseSA»
| Name | Type | Description | Required |
|---|---|---|---|
| content | [ SalesInvoiceResponseSA ] | No | |
| empty | boolean | No | |
| first | boolean | No | |
| last | boolean | No | |
| number | integer | No | |
| numberOfElements | integer | No | |
| pageable | Pageable | No | |
| size | integer | No | |
| sort | Sort | No | |
| totalElements | long | No | |
| totalPages | integer | No |
Page«SalesInvoiceResponseUae»
| Name | Type | Description | Required |
|---|---|---|---|
| content | [ SalesInvoiceResponseUae ] | No | |
| empty | boolean | No | |
| first | boolean | No | |
| last | boolean | No | |
| number | integer | No | |
| numberOfElements | integer | No | |
| pageable | Pageable | No | |
| size | integer | No | |
| sort | Sort | No | |
| totalElements | long | No | |
| totalPages | integer | No |
Page«SalesInvoiceResponseUk»
| Name | Type | Description | Required |
|---|---|---|---|
| content | [ SalesInvoiceResponseUk ] | No | |
| empty | boolean | No | |
| first | boolean | No | |
| last | boolean | No | |
| number | integer | No | |
| numberOfElements | integer | No | |
| pageable | Pageable | No | |
| size | integer | No | |
| sort | Sort | No | |
| totalElements | long | No | |
| totalPages | integer | No |
Page«SalesInvoiceResponse»
| Name | Type | Description | Required |
|---|---|---|---|
| content | [ SalesInvoiceResponse ] | No | |
| empty | boolean | No | |
| first | boolean | No | |
| last | boolean | No | |
| number | integer | No | |
| numberOfElements | integer | No | |
| pageable | Pageable | No | |
| size | integer | No | |
| sort | Sort | No | |
| totalElements | long | No | |
| totalPages | integer | No |
Page«SalesOrderResponseIndia»
| Name | Type | Description | Required |
|---|---|---|---|
| content | [ SalesOrderResponseIndia ] | No | |
| empty | boolean | No | |
| first | boolean | No | |
| last | boolean | No | |
| number | integer | No | |
| numberOfElements | integer | No | |
| pageable | Pageable | No | |
| size | integer | No | |
| sort | Sort | No | |
| totalElements | long | No | |
| totalPages | integer | No |
Page«SalesOrderResponseMalaysia»
| Name | Type | Description | Required |
|---|---|---|---|
| content | [ SalesOrderResponseMalaysia ] | No | |
| empty | boolean | No | |
| first | boolean | No | |
| last | boolean | No | |
| number | integer | No | |
| numberOfElements | integer | No | |
| pageable | Pageable | No | |
| size | integer | No | |
| sort | Sort | No | |
| totalElements | long | No | |
| totalPages | integer | No |
Page«SalesOrderResponse»
| Name | Type | Description | Required |
|---|---|---|---|
| content | [ SalesOrderResponse ] | No | |
| empty | boolean | No | |
| first | boolean | No | |
| last | boolean | No | |
| number | integer | No | |
| numberOfElements | integer | No | |
| pageable | Pageable | No | |
| size | integer | No | |
| sort | Sort | No | |
| totalElements | long | No | |
| totalPages | integer | No |
Page«object»
| Name | Type | Description | Required |
|---|---|---|---|
| content | [ object ] | No | |
| empty | boolean | No | |
| first | boolean | No | |
| last | boolean | No | |
| number | integer | No | |
| numberOfElements | integer | No | |
| pageable | Pageable | No | |
| size | integer | No | |
| sort | Sort | No | |
| totalElements | long | No | |
| totalPages | integer | No |
PartialInvoiceFulfillmentStatusUpdate
| Name | Type | Description | Required |
|---|---|---|---|
| itemQtyFulfilledByDocMap | object | Item Fulfilled Quantity by Doc Example: [] | No |
| itemToFulfillmentMap | object | Fulfilled Quantity by Quotation Item Example: [] | No |
| itemToFulfillmentQtyMap | object | Fulfilled Quantity by Quotation Item Example: [] | No |
PaymentAccountDto
| Name | Type | Description | Required |
|---|---|---|---|
| connected | boolean | No | |
| connectionId | string | No | |
| connectionName | string | No | |
| modules | [ string ] | No |
PaymentInformation
| Name | Type | Description | Required |
|---|---|---|---|
| autoCharge | boolean | No | |
| connectionType | string | Payment connection type Enum: "STRIPE", "VEEM", "WISE", "PAYPAL", "PAYTM", "RAZORPAY", "OPENNODE", "CASHFREE"Example: "stripe" | No |
| customerEmail | string | Customer email Example: "john@doe.com" | No |
| customerPhone | string | Customer phone Example: 1234567890 | No |
| paymentAccountDto | PaymentAccountDto | Payment method information Example: {"connected":true} | No |
| paymentLink | string | Payment link Example: "www.veem.com/payment" | No |
PaymentMilestoneDetailsRequest
| Name | Type | Description | Required |
|---|---|---|---|
| amount | number | Amount Example: 100 | Yes |
| amountInPercent | number | No | |
| amountInPercentFlag | boolean | No | |
| contactCode | string | Contact Code Example: "C-000001" | Yes |
| documentCode | string | Document Code Example: "000001" | Yes |
| documentType | string | Document Type 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"Example: "SALES_INVOICE" | Yes |
| dueAmount | number | Payment Due Amount Example: 0 | Yes |
| milestoneDate | string | Milestone Date Example: "25-10-2019" | Yes |
| milestoneNo | integer | Milestone Number Example: 1 | Yes |
| receivedAmount | number | Payment Received Amount Example: 100 | Yes |
| status | string | Status Enum: "PAYMENT_DUE", "PAYMENT_ON_TIME", "DELAYED"Example: "DELAYED" | Yes |
PaymentMilestoneDetailsResponse
| Name | Type | Description | Required |
|---|---|---|---|
| amount | number | Amount Example: 100 | Yes |
| amountInPercent | number | No | |
| amountInPercentFlag | boolean | No | |
| contactCode | string | Contact Code Example: "C-000001" | Yes |
| documentCode | string | Document Code Example: "000001" | Yes |
| documentType | string | Document Type 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"Example: "SALES_INVOICE" | Yes |
| dueAmount | number | Payment Due Amount Example: 0 | Yes |
| id | long | No | |
| linkedDocument | LinkedDocumentResponse | linkedDocument Example: {} | Yes |
| milestoneDate | string | Milestone Date Example: "25-10-2019" | Yes |
| milestoneNo | integer | Milestone Number Example: 1 | Yes |
| receivedAmount | number | Payment Received Amount Example: 100 | Yes |
| status | string | Status Enum: "PAYMENT_DUE", "PAYMENT_ON_TIME", "DELAYED"Example: "DELAYED" | Yes |
PaymentMilestoneTrackerDetailsReport
| Name | Type | Description | Required |
|---|---|---|---|
| contactCode | string | No | |
| contactName | string | No | |
| currencyCode | string | No | |
| documentCode | string | No | |
| documentDate | dateTime | No | |
| documentDueDate | dateTime | No | |
| documentSequenceCode | string | No | |
| documentType | 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 |
| paymentMilestoneTrackerItems | [ PaymentMilestoneTrackerDetailsReportItem ] | No | |
| totalAmount | number | No | |
| totalMilestoneDelayed | long | No | |
| totalMilestonePaidOnTime | long | No |
PaymentMilestoneTrackerDetailsReportItem
| Name | Type | Description | Required |
|---|---|---|---|
| amount | number | No | |
| milestoneDate | dateTime | No | |
| milestoneNo | integer | No | |
| receivedAmount | number | No | |
| status | string | Enum: "PAYMENT_DUE", "PAYMENT_ON_TIME", "DELAYED" | No |
PaymentMilestoneTrackerSummaryReport
| Name | Type | Description | Required |
|---|---|---|---|
| contactCode | string | No | |
| contactName | string | No | |
| documentType | 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 |
| totalMilestoneDelayed | long | No | |
| totalMilestoneDelayedPercentage | number | No | |
| totalMilestoneForContact | long | No | |
| totalMilestonePaidOnTime | long | No | |
| totalMilestonePaidOnTimePercentage | number | No |
PlatformDetailsDto
| Name | Type | Description | Required |
|---|---|---|---|
| accountCode | string | Account ID Example: "ACC001" | No |
| contactCode | string | Contact ID Example: "C001" | No |
| documentCode | string | Document Code Example: "DOC001" | No |
| documentDate | string | Document Date Example: "2020-10-10" | No |
| documentType | string | Document Type Example: "INVOICE" | No |
| invoiceId | string | Invoice ID Example: "INV001" | No |
| memo | string | Memo Description Example: "Invoice sent for payment" | No |
| paymentCode | string | Payment Code Example: 124552 | No |
| userId | string | User ID Example: 1142 | No |
Point
| Name | Type | Description | Required |
|---|---|---|---|
| x | float | No | |
| y | float | No |
ProductInOutQty
| Name | Type | Description | Required |
|---|---|---|---|
| documentType | 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 |
| productCode | string | No | |
| quantity | number | No |
ProductInformation
| Name | Type | Description | Required |
|---|---|---|---|
| active | boolean | Product status Example: true | No |
| advancedTracking | string | Advanced Tracking Type Enum: "NONE", "BATCH", "SERIAL"Example: "NONE" | No |
| advancedTrackingMetaData | [ AdvancedTrackingMetaDto ] | Advanced Tracking Meta data Example: {"field1":"value1","field2":"value2"} | No |
| amortizationPeriod | integer | Amortization template period Example: 36 | No |
| amortizationTemplateCode | string | Amortization template code Example: "0000001" | No |
| attributes | [ AttributeDetails ] | Attribute Details | No |
| autoFulfillmentEnabled | boolean | Is Auto-Fulfillment enable? Example: false | No |
| availableQuantity | number | Available Quantity Example: 2 | No |
| barcode | string | Product barcode Example: 2365234 | No |
| barcodeDetails | BarcodeDetails | barcode details Example: {"barcodeField":"Samsung"} | No |
| basePrice | double | Revenue Base price Example: 120 | No |
| bomAddCostConfiguration | [ BomAdditionalCostDto ] | Bom additional cost information | No |
| bomMetaDetailsList | [ BomMetaDetailsDto ] | multiple bom configuration Example: "Bom Configuration" | 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 |
| categoryCode | string | Category code Example: "AB0001" | No |
| categoryDesc | string | Category description Example: "Medical Equipment" | No |
| cessRule | string | Cess rule expression Example: "Math.max(21*amount/100,4170*quantity/1000)" | No |
| cessRuleDescription | string | Cess rule description Example: "21% or Rs. 4170 per thousand, whichever is higher" | No |
| costOfGoodsSoldAccountCode | string | No | |
| customField | [ CustomFieldItem ] | JSON object for custom fields Example: {"field1":"value1","field2":"value2"} | No |
| deferredExpenseAccountCode | string | Deferred Expense account code Example: "A-0015" | No |
| deferredRevenueAccountCode | string | Deferred Revenue account code Example: "A-0015" | No |
| deleted | boolean | Product delete status Example: true | No |
| description | string | Product description Example: "Description" | No |
| documentSequenceCode | string | Product Sequence code Example: "P-0000001" | No |
| exciseApplicable | boolean | Example: true | No |
| exciseRate | double | Excise rate based on Excise Type Example: 10 | No |
| exciseType | string | Excise type to apply Enum: "PERCENT", "FLAT"Example: "PERCENT" | No |
| exemptedMalaysia | boolean | Whether Product is Tax Exempted Example: true | No |
| glAccountCode | string | GL account code Example: "A-0017" | No |
| hasBuildAssembly | boolean | Has Build Assembly Example: true | No |
| hasVariants | boolean | Product has variants Example: false | No |
| hsnOrSacCode | string | HSN or SAC code of product Example: 1234 | No |
| id | long | Product ID Example: 1234 | No |
| images | [ string ] | Product image url's | No |
| incomingQty | number | Product incoming Qty | No |
| inventory | InventoryDto | Inventory information required for Tracked Products. | No |
| inventoryAccountCode | string | No | |
| inventoryWarehouseDetails | [ InventoryWarehouseDetails ] | Inventory warehouse details Example: {"warehouseCode":"WH-00001","availableQuantity":"100","openingQuantity":"100"} | No |
| isAccountNumberFlag | boolean | indicates if user is sending account number or code Example: true | No |
| isFinishedProduct | boolean | Is finished product? Example: false | No |
| isUiProductUpdate | boolean | Product is update by UI. Example: false | No |
| isVariant | boolean | Is a variant Example: false | No |
| itcAdjustment | string | ITC adjustment Enum: "NA", "ITC_IS_BLOCKED", "ITC_IS_REVERSED"Example: "ITC_IS_BLOCKED" | No |
| landedCostCategory | [ LandedCostCategory ] | Landed cost category details | No |
| manufacturingCostAccountCode | string | Manufacturing Cost Account Code Example: "AC-0000012" | No |
| masterProductCode | string | Master Product Code Example: "P-0000001" | No |
| multipleUomSchema | boolean | Is multiple Uom Schema? Example: true | No |
| name | string | Product Name Example: "Apple" | Yes |
| nameInArabicSA | string | No | |
| offeringType | string | Offering type Enum: "GOODS", "SERVICES"Example: "GOODS" | No |
| outgoingQty | number | Product outgoing Qty | No |
| productId | string | Product ID Example: "P000011" | No |
| productSubstitutesDetails | [ ProductSubstitutesDetails ] | No | |
| productTransactionType | string | Product Transaction Type Enum: "BOTH", "PURCHASE", "SALES"Example: "BOTH" | Yes |
| purchaseAccountCode | string | Purchase account code Example: "A-0012" | Yes |
| purchasePrice | double | Purchase price Example: 123.33 | Yes |
| purchasePriceTaxInclusive | boolean | Is purchase price tax inclusive? Example: true | No |
| purchaseReturnAccountCode | string | Purchase return account code Example: "A-0014" | No |
| purchaseTaxCode | string | Purchase tax code Example: "T-001" | No |
| recommendedUom | long | Recommended product uom | No |
| reorderEnabled | boolean | Flag to enable reorder level Example: true | No |
| reorderLevel | long | Reorder level of the Products. Example: 100 | No |
| reorderLevelReached | boolean | Has Reorder level reached | No |
| reorderQuantity | long | Quantity to be reordered Example: 50 | No |
| reorderVendorCode | string | Vendor code for reorder Example: "C-000001" | No |
| reorderVendorName | string | Reorder Vendor Name | No |
| reservedQuantity | number | Reserved Quantity Example: 2 | No |
| revenueRecognitionInfo | ProductRevenueRecognitionInfo | Product Revenue Recognition Information Object | No |
| rowRackBinData | RowRackBinData | Row Rack Bin information required for Tracked Products. | No |
| salesAccountCode | string | Sales account code Example: "A-0013" | Yes |
| salesPrice | double | Sales price Example: 120 | Yes |
| salesPriceTaxInclusive | boolean | Is sales price tax inclusive? Example: false | No |
| salesReturnAccountCode | string | Sales return account code Example: "A-0015" | No |
| salesTaxCode | string | Sales tax code Example: "T-002" | No |
| sequenceFormat | string | Sequence Format Example: 1 | No |
| source | string | Identify this is ecom sync product Example: "SHOPIFY" | No |
| stockAdjustmentAccountCode | string | No | |
| stockUom | long | Stock UOM Example: 2 | Yes |
| tariffOrServiceCodeMalaysia | string | Tariff or Service code of product Example: 1234 | No |
| taxExemptionReason | string | Tax Exempted reason to be filled, if taxPreference is true Enum: "EXEMPTED", "NON_GST"Example: "EXEMPTED" | No |
| taxExemptionReasonMalaysia | string | Tax Exempted reason to be filled, if taxPreference is true Enum: "EXEMPTED", "NON_SST", "LIVE_ANIMALS", "UNPROCESSED_FOOD", "VEGETABLES", "MEDICINES", "MACHINERY", "CHEMICALS"Example: "EXEMPTED" | No |
| taxPreference | boolean | Whether Product is Tax Exempted Example: true | No |
| taxable | boolean | Is taxable? Example: true | No |
| tdsApplicableIndia | boolean | No | |
| tdsNatureOfPaymentIndia | string | No | |
| type | string | Product type Enum: "TRACKED", "NONTRACKED", "BILL_OF_MATERIALS"Example: "TRACKED" | Yes |
| uomSchema | long | Reorder level of the Products. Example: 100 | No |
| uomSchemaDto | UOMSchemaDto | Product uom schema information | No |
| valuationMethod | string | Valuation Method Enum: "FIFO", "AVERAGE"Example: "FIFO" | Yes |
| variantAttributes | object | Attribute Details specific to a variant | No |
| variantCount | integer | Variant Count | No |
| whtApplicable | boolean | Example: true | No |
| whtSectionToWhtRateId | long | Product WHT - Nature Of Payment to WHT Rate Id Example: 1213454 | No |
| wipInventoryAccountCode | string | No |
ProductReport
| Name | Type | Description | Required |
|---|---|---|---|
| code | string | No | |
| name | string | No | |
| sale | number | No | |
| volume | number | No |
ProductResponse
| Name | Type | Description | Required |
|---|---|---|---|
| active | boolean | Product status Example: true | No |
| advancedTracking | string | Advanced Tracking Type Enum: "NONE", "BATCH", "SERIAL"Example: "NONE" | No |
| advancedTrackingMetaData | [ AdvancedTrackingMetaDto ] | Advanced Tracking Meta data Example: {"field1":"value1","field2":"value2"} | No |
| amortizationPeriod | integer | Amortization template period Example: 36 | No |
| amortizationTemplateCode | string | Amortization template code Example: "0000001" | No |
| attributes | [ AttributeDetails ] | Attribute Details | No |
| autoFulfillmentEnabled | boolean | Is Auto-Fulfillment enable? Example: false | No |
| barcode | string | Product barcode Example: 2365234 | No |
| barcodeDetails | BarcodeDetails | barcode details Example: {"barcodeField":"Samsung"} | No |
| basePrice | double | Revenue Base price Example: 120 | No |
| bomAddCostConfiguration | [ BomAdditionalCostDto ] | Bom additional cost information | No |
| bomMetaDetailsList | [ BomMetaDetailsDto ] | multiple bom configuration Example: "Bom Configuration" | 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 |
| categoryCode | string | Category code Example: "AB0001" | No |
| categoryDesc | string | Category description Example: "Medical Equipment" | No |
| customField | [ CustomFieldItem ] | JSON object for custom fields Example: {"field1":"value1","field2":"value2"} | No |
| deferredExpenseAccountCode | string | Deferred Expense account code Example: "A-0015" | No |
| deferredRevenueAccountCode | string | Deferred Revenue account code Example: "A-0015" | No |
| deleted | boolean | Product delete status Example: true | No |
| description | string | Product description Example: "Description" | No |
| documentSequenceCode | string | Product Sequence code Example: "P-0000001" | No |
| hasBuildAssembly | boolean | Has Build Assembly Example: true | No |
| hasVariants | boolean | Product has variants Example: false | No |
| id | long | Product ID Example: 1234 | No |
| images | [ string ] | Product image url's | No |
| incomingQty | number | Product incoming Qty | No |
| inventory | InventoryDto | Inventory information required for Tracked Products. | No |
| inventoryWarehouseDetails | [ InventoryWarehouseDetails ] | Inventory warehouse details Example: {"warehouseCode":"WH-00001","availableQuantity":"100","openingQuantity":"100"} | No |
| isAccountNumberFlag | boolean | indicates if user is sending account number or code Example: true | No |
| isFinishedProduct | boolean | Is finished product? Example: false | No |
| isUiProductUpdate | boolean | Product is update by UI. Example: false | No |
| isVariant | boolean | Is a variant Example: false | No |
| landedCostCategory | [ LandedCostCategory ] | Landed cost category details | No |
| manufacturingCostAccountCode | string | Manufacturing Cost Account Code Example: "AC-0000012" | No |
| masterProductCode | string | Master Product Code Example: "P-0000001" | No |
| multipleUomSchema | boolean | Is multiple Uom Schema? Example: true | No |
| name | string | Product Name Example: "Apple" | Yes |
| outgoingQty | number | Product outgoing Qty | No |
| productId | string | Product ID Example: "P000011" | No |
| productSubstitutesDetails | [ ProductSubstitutesDetails ] | No | |
| productTransactionType | string | Product Transaction Type Enum: "BOTH", "PURCHASE", "SALES"Example: "BOTH" | Yes |
| purchaseAccountCode | string | Purchase account code Example: "A-0012" | Yes |
| purchasePrice | double | Purchase price Example: 123.33 | Yes |
| purchasePriceTaxInclusive | boolean | Is purchase price tax inclusive? Example: true | No |
| purchaseReturnAccountCode | string | Purchase return account code Example: "A-0014" | No |
| purchaseTaxCode | string | Purchase tax code Example: "T-001" | No |
| recommendedUom | long | Recommended product uom | No |
| reorderEnabled | boolean | Flag to enable reorder level Example: true | No |
| reorderLevel | long | Reorder level of the Products. Example: 100 | No |
| reorderLevelReached | boolean | Has Reorder level reached | No |
| reorderQuantity | long | Quantity to be reordered Example: 50 | No |
| reorderVendorCode | string | Vendor code for reorder Example: "C-000001" | No |
| reorderVendorName | string | Reorder Vendor Name | No |
| revenueRecognitionInfo | ProductRevenueRecognitionInfo | Product Revenue Recognition Information Object | No |
| rowRackBinData | RowRackBinData | Row Rack Bin information required for Tracked Products. | No |
| salesAccountCode | string | Sales account code Example: "A-0013" | Yes |
| salesPrice | double | Sales price Example: 120 | Yes |
| salesPriceTaxInclusive | boolean | Is sales price tax inclusive? Example: false | No |
| salesReturnAccountCode | string | Sales return account code Example: "A-0015" | No |
| salesTaxCode | string | Sales tax code Example: "T-002" | No |
| sequenceFormat | string | Sequence Format Example: 1 | No |
| source | string | Identify this is ecom sync product Example: "SHOPIFY" | No |
| stockUom | long | Stock UOM Example: 2 | Yes |
| taxable | boolean | Is taxable? Example: true | No |
| type | string | Product type Enum: "TRACKED", "NONTRACKED", "BILL_OF_MATERIALS"Example: "TRACKED" | Yes |
| uomSchema | long | Reorder level of the Products. Example: 100 | No |
| uomSchemaDto | UOMSchemaDto | Product uom schema information | No |
| valuationMethod | string | Valuation Method Enum: "FIFO", "AVERAGE"Example: "FIFO" | Yes |
| variantAttributes | object | Attribute Details specific to a variant | No |
| variantCount | integer | Variant Count | No |
ProductRevenueRecognitionInfo
| Name | Type | Description | Required |
|---|---|---|---|
| allocationType | string | Allocation Type Example: "Normal/Exclude" | No |
| createRevenuePlanOn | string | Create Revenue Plan On Example: "Fulfillment" | No |
| isDirectRevenuePositing | boolean | Direct Revenue Positing Example: true | No |
| itemRevenueCategory | string | Item Revenue Category Example: "Licence" | No |
| revRecForecastRule | string | Revenue Recognition Forecast Rule Example: "Rule Forecast 1" | No |
| revRecRule | string | Revenue Recognition Rule Example: "Rule 1" | No |
ProductStockInfo
| Name | Type | Description | Required |
|---|---|---|---|
| fulfilledQuantity | number | No | |
| pendingQuantity | number | No | |
| productCode | string | No | |
| receiptQuantity | number | No | |
| status | string | No | |
| warehouseCode | string | No |
ProductSubstitutesDetails
| Name | Type | Description | Required |
|---|---|---|---|
| advancedTracking | string | Advanced Tracking Type Enum: "NONE", "BATCH", "SERIAL"Example: "NONE" | No |
| availableQuantity | number | Quantity of product available Example: 10 | No |
| productDocumentSeqCode | string | Doc seq code of Product Example: "P-00001" | No |
| productId | string | Product Id Example: "P-00001" | No |
| productName | string | Name of Product Example: "Test Product" | No |
| stockUom | long | Stock UOM Example: 2 | Yes |
| type | string | Product type Enum: "TRACKED", "NONTRACKED", "BILL_OF_MATERIALS"Example: "TRACKED" | Yes |
PurchaseDocument
| Name | Type | Description | Required |
|---|---|---|---|
| contactCode | string | Contact code Example: "000012" | No |
| contactDto | ContactDto | Contact Details | Yes |
| documentAccountItemDetails | [ DocumentAccountItemDetails ] | Document Account item details. | No |
| documentCode | string | Document Code. Example: "QO-0000001" | No |
| documentDate | dateTime | Document date Example: "25-10-2019" | No |
| documentItemDetails | [ DocumentItemDetails ] | Document item details. | No |
| documentSequenceCode | string | Document Sequence Code. Example: "0000001" | No |
| documentType | string | Type of document. Enum: "QUOTATION", "PURCHASE_ORDER", "SALES_ORDER", "PURCHASE_INVOICE", "SALES_INVOICE", "MAKE_PAYMENT", "RECEIVE_PAYMENT", "JOURNAL_ENTRY", "BANK_TRANSFER", "CREDIT_NOTE", "DEBIT_NOTE", "EXPENSE", "EXPENSE_PREPAYMENT", "DEPOSIT", "DEPOSIT_ADVPAYMENT", "CONTRA_ADJUSTMENT", "GOODS_RECEIPT", "FULFILLMENT", "PICKLIST", "PACKLIST", "SHIPLIST", "PAYSLIP", "PAYROLL_CHECK", "CHEQUE", "SALES_RETURN", "PURCHASE_RETURN", "STOCK_ADJUSTMENT", "STOCK_TRANSFER", "WORK_ORDER", "FIXED_ASSET", "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"Example: "QUOTATION" | No |
| exchangeRate | double | No | |
| linkedDocuments | [ DocumentInfo ] | Linked Documents | No |
| shipByDate | dateTime | Ship by date Example: "25-10-2019" | No |
| shipFrom | Address | Ship from address. | No |
| shipTo | Address | Ship To address. | No |
| warehouseCode | string | Warehouse Code Example: "WH-0000001" | No |
PurchaseInvoiceAccountDetails
| Name | Type | Description | Required |
|---|---|---|---|
| account | AccountDto | Account Response Example: "product" | No |
| accountCode | string | Product code Example: "P00001" | Yes |
| accountDescription | string | Product description Example: "Apple watch" | No |
| accountOrder | integer | Product view order Example: 1 | No |
| amount | number | Amount Example: 2 | Yes |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| discount | number | Discount Example: 2 | No |
| discountInPercent | boolean | Discount in percentage Example: true | No |
| id | long | ID Example: 2 | No |
| isTdsApplicableAccount | boolean | No | |
| isTdsApplicableContact | boolean | No | |
| isTdsApplicableProduct | boolean | No | |
| lineNumber | integer | Line Number Example: 1 | No |
| tax | TaxDto | Tax details Example: "taxDto" | No |
| taxAmount | number | Tax amount Example: 0.5 | No |
| taxCode | string | Tax code Example: "GST7" | No |
| tdsAccount | string | Tds Account Code Example: "AC-0000011" | No |
| tdsAmount | number | TDS Amount Example: 100 | No |
| tdsInfoIndia | TdsInfoIndia | Purchase invoice TDS details | No |
| tdsRate | number | TDS Rate Example: 10.1 | No |
| totalAmount | number | Total amount Example: 2.3 | Yes |
PurchaseInvoiceAssetGroupDetails
| Name | Type | Description | Required |
|---|---|---|---|
| additionalChargeAmount | number | No | |
| additionalChargeTaxamount | number | No | |
| additionalCharges | AdditionalCharges | No | |
| amount | number | Amount Example: 2 | Yes |
| assetDetails | [ AssetRequest ] | No | |
| assetGroupId | long | No | |
| assetGroupName | string | Product code Example: "P00001" | Yes |
| assetGroupResponse | AssetGroupResponse | Account Response Example: "product" | No |
| assetOrder | integer | Product view order Example: 1 | No |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| description | string | Product description Example: "Apple watch" | No |
| discount | number | Discount Example: 2 | No |
| discountInPercent | boolean | Discount in percentage Example: true | No |
| id | long | ID Example: 2 | No |
| invoiceItemCode | string | No | |
| isPartialInvoice | boolean | Whether the Purchase Invoice is a partial invoice Example: false | No |
| lineNumber | integer | Line Number Example: 1 | No |
| linkedOrderItem | long | Order Item linked to invoice item Example: 123 | No |
| quantity | number | No | |
| tax | TaxDto | Tax details Example: "taxDto" | No |
| taxAmount | number | Tax amount Example: 0.5 | No |
| taxCode | string | Tax code Example: "GST7" | No |
| totalAmount | number | Total amount Example: 2.3 | Yes |
| unitPrice | number | No |
PurchaseInvoiceInformation
| Name | Type | Description | Required |
|---|---|---|---|
| additionalCharges | AdditionalCharges | Purchase invoice additional charges details | 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 |
| closedDate | string | No | |
| contact | ContactInfo | Contact details | Yes |
| contactCode | string | Contact Code Example: "C0001" | Yes |
| contactDto | ContactInformation | Contact Details | Yes |
| currency | string | Currency Example: "C001" | Yes |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| customerType | string | Customer Type Enum: "EXPORT_WO_PAY", "EXPORT_W_PAY", "NA", "SEZ_WO_PAY", "SEZ_W_PAY"Example: "NA" | Yes |
| documentSequenceCode | string | Purchase invoice Sequence Code Example: "0000001" | No |
| draft | boolean | Purchase invoice drafted Example: false | No |
| dropShip | boolean | Drop Ship flag to indicate if purchase invoice is created for drop ship Example: true | No |
| dueAmount | number | Amount Due Example: 12.322 | 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 |
| gstin | string | GSTIN Example: "ABSASASSASASA198" | Yes |
| id | long | Purchase invoice id Example: 1 | No |
| isCreditable | boolean | Is Creditable Example: true | No |
| isPartialInvoice | boolean | Whether the Purchase Invoice is a partial invoice Example: false | No |
| journalEntryCode | string | Journal Entry Code Example: "JE0001" | No |
| knockoffInfo | [ KnockOffInfo ] | KnockOff Info | No |
| landedCost | boolean | To mark landed cost bill Example: true | No |
| linkedDocuments | [ DocumentInfo ] | Linked Documents | No |
| memo | string | Memo Example: "Memo details" | No |
| openingDocumentNumber | string | Customer opening document number Example: "DC-0001" | No |
| openingInvoice | boolean | True if opening invoice Example: false | No |
| payableAccountCode | string | Code of Account Example: "AC-000001" | No |
| paymentDate | string | No | |
| paymentMilestoneDetails | [ PaymentMilestoneDetailsResponse ] | Payment milestone details | No |
| paymentMilestoneFlag | boolean | Payment milestone flag to indicate if payment milestones are set Example: true | No |
| paymentStatus | string | Purchase invoice payment status Enum: "PENDING", "PARTIAL", "RECEIVED"Example: "PENDING" | No |
| placeOfSupply | string | state in India Example: "Punjab" | Yes |
| purchaseInvoiceAccounts | [ PurchaseInvoiceAccountDetails ] | Purchase invoice Account item details | No |
| purchaseInvoiceAssets | [ PurchaseInvoiceAssetGroupDetails ] | No | |
| purchaseInvoiceCode | string | Purchase invoice code Example: "SI001" | No |
| purchaseInvoiceDate | string | Purchase Invoice date Example: "25-10-2019" | Yes |
| purchaseInvoiceDueDate | string | Purchase Invoice due date Example: "25-10-2019" | Yes |
| purchaseInvoiceProducts | [ PurchaseInvoiceItemInformation ] | Purchase invoice Product item details | No |
| purchaseInvoiceRecurring | PurchaseInvoiceRecurringDetails | Purchase invoice item details | No |
| purchaseInvoiceType | string | Purchase invoice type. Enum: "INVENTORY", "EXPENSE", "ASSET"Example: "INVENTORY" | Yes |
| purchaseOrderRefNo | string | Contact PO reference number Example: "CPO001" | No |
| rcmApplicable | boolean | Reverse Charge Applicable Example: true | No |
| rcmApplicableSA | boolean | Reverse Charge Applicable Example: true | No |
| receiptDate | string | No | |
| receiptOn | string | No | |
| receiptStatus | string | Purchase invoice receipt status Enum: "UNRECEIVED", "PARTIAL_RECEIVED", "FULLY_RECEIVED", "NOT_APPLICABLE"Example: "UNRECEIVED" | No |
| receiveByDate | dateTime | Receive by date Example: "25-10-2019" | No |
| recurring | boolean | True if Invoice is recurring. Example: true | No |
| recurringActivated | boolean | True if Invoice recurrence is active. Example: false | 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 |
| sequenceFormat | string | Sequence Format Id Example: 1 | 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 | No | |
| taxAmount | number | Tax amount Example: 2.322 | No |
| taxInvoiceNo | string | Tax Invoice No Example: 123456789 | No |
| tcsAmount | number | TCS amount Example: 2.322 | No |
| tcsPercentage | number | TCS percentage Example: 2 | No |
| tcsRateId | long | TCS Rate Id Example: 1 | No |
| tdsProcessedFlag | boolean | TDS Processed Flag Example: false | 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 Example: 12.32 | No |
| unitPriceGstInclusive | boolean | Unit price is GST inclusive Example: false | No |
| vatPaidAtCustomSA | boolean | VAT Applicable Example: true | No |
| vendorType | string | Vendor Type Enum: "IMPORT", "NA", "SEZ_W_PAY", "SEZ_WO_PAY"Example: "NA" | Yes |
| warehouseCode | string | Warehouse Code Example: "WH-000001" | No |
| whtRate | number | Wht rate Example: 1 | No |
PurchaseInvoiceItemInformation
| Name | Type | Description | Required |
|---|---|---|---|
| additionalCharges | AdditionalCharges | Purchase invoice item additional charges details | No |
| amortizationDocumentItemDetails | AmortizationDocumentItemDetails | No | |
| cessAmount | number | cess amount Example: 40 | No |
| cessPercentage | number | Cess Percentage Example: 2.322 | No |
| cessRule | string | Cess rule expression Example: "Math.max(21amount/100,4170quantity/1000)" | No |
| cgstAmount | number | CGST tax amount Example: 60 | No |
| cgstRate | number | CGST tax rate Example: 6 | No |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| discount | number | Discount Example: 2 | No |
| discountInPercent | boolean | Discount in percentage Example: true | No |
| documentUOMSchemaDefinition | DocumentUOMSchemaDefinition | Document UOM Schema Definition Example: 2 | Yes |
| documentUom | long | Document UOM id Example: 2 | Yes |
| exciseAmount | number | Excise amount Example: 0.5 | No |
| exciseRate | double | Rate of Excise Example: 5 | No |
| exciseType | string | Excise type Enum: "PERCENT", "FLAT"Example: "FLAT" | No |
| hsnOrSacCode | string | Hsn or Sac code Example: 110011 | No |
| id | long | ID Example: 2 | No |
| igstAmount | number | IGST tax amount Example: 120 | No |
| igstRate | number | IGST tax rate Example: 12 | No |
| invoiceLineNumber | string | Invoice Line Number Example: "ABSCDDSD1212" | No |
| isPartialInvoice | boolean | Whether the Purchase Invoice is a partial invoice Example: false | No |
| isTdsApplicableContact | boolean | No | |
| isTdsApplicableProduct | boolean | No | |
| itcAdjustment | string | ITC adjustment Enum: "NA", "ITC_IS_BLOCKED", "ITC_IS_REVERSED"Example: "ITC_IS_BLOCKED" | No |
| itcIneligibleType | string | Ineligible - as per Section 17(5) Enum: "ITC_INELIGIBLE_SECTION_17", "ITC_INELIGIBLE_OTHERS"Example: "ITC_INELIGIBLE_SECTION_17" | No |
| landedCostDetails | LandedCostDetails | Landed Cost Details | No |
| lineNumber | integer | Line Number Example: 1 | No |
| linkedOrderItem | long | Order Item linked to invoice item Example: 123 | No |
| otherRate | number | Other Tax total Rate Example: 12 | No |
| otherTaxAmount | number | Other tax amount Example: 60 | No |
| product | ProductInformation | Product Response Example: "product" | No |
| productCode | string | Product code Example: "P00001" | Yes |
| productDescription | string | Product description Example: "Apple watch" | No |
| productOrder | integer | Product view order Example: 1 | No |
| productQuantity | number | Product quantity Example: 2 | Yes |
| purchaseInvoiceItemCode | string | Purchase Invoice Item Code Example: "PII-000001" | No |
| rcmRateSA | number | RCM tax rate for Saudi Example: 5 | No |
| receivedQuantityInBills | number | Example: 123 | No |
| receivedQuantityInOrder | number | Example: 123 | No |
| sgstAmount | number | SGST tax amount Example: 60 | No |
| sgstRate | number | SGST tax rate Example: 6 | No |
| tax | TaxDto | Tax details Example: "taxDto" | No |
| taxAmount | number | Tax amount Example: 0.5 | No |
| taxCode | string | Tax code Example: "GST7" | No |
| taxDetails | [ DocumentItemTaxMappingDto ] | Tax Details for Tax Group | No |
| taxExemptionReason | string | Tax Exemption reason if taxPreference is true Enum: "EXEMPTED", "NON_GST"Example: "EXEMPTED" | No |
| taxPreference | boolean | Tax preference, whether Exempted or not Exempted Example: false | No |
| tdsAccount | string | Tds Account Code Example: "AC-0000011" | No |
| tdsAmount | number | TDS Amount Example: 100 | No |
| tdsId | integer | TDS Id Example: 1 | No |
| tdsInfoIndia | TdsInfoIndia | No | |
| tdsRate | number | TDS Rate Example: 10.1 | No |
| totalAmount | number | Total amount Example: 2.3 | Yes |
| totalAmountInclTax | number | total amount inclusive of all taxes Example: 1160 | Yes |
| uaeRcmRate | number | RCM tax rate for UAE Example: 5 | No |
| unitPrice | number | Product unit price Example: 0.7 | Yes |
| uomQuantity | number | uom quantity Example: 2 | Yes |
| uomUnitPrice | number | UOM Unit price Example: 2.3 | Yes |
| userSetTaxes | boolean | Flag to check whether tax is user edited Example: false | No |
| vatCustomRateSA | number | Custom tax rate for Saudi Example: 5 | No |
PurchaseInvoiceProductDetails
| Name | Type | Description | Required |
|---|---|---|---|
| additionalChargeAmount | number | Example: 123 | No |
| additionalChargeAmountCalculated | number | No | |
| additionalChargeTaxamount | number | Example: 123 | No |
| additionalChargeTaxamountCalculated | number | No | |
| additionalCharges | AdditionalCharges | Purchase invoice item additional charges details | No |
| advancedTrackingType | string | Advanced Tracking Type Enum: "NONE", "BATCH", "SERIAL" | No |
| amortizationDocumentItemDetails | AmortizationDocumentItemDetails | No | |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| discount | number | Discount Example: 2 | No |
| discountInPercent | boolean | Discount in percentage Example: true | No |
| documentUOMSchemaDefinition | DocumentUOMSchemaDefinition | Document UOM Schema Definition Example: 2 | Yes |
| documentUom | long | Document UOM id Example: 2 | Yes |
| id | long | ID Example: 2 | No |
| invoiceLineNumber | string | Invoice Line Number Example: "ABSCDDSD1212" | No |
| isPartialInvoice | boolean | Whether the Purchase Invoice is a partial invoice Example: false | No |
| landedCostDetails | LandedCostDetails | Details for landed cost | No |
| lineNumber | integer | Line Number Example: 1 | No |
| linkedOrderItem | long | Order Item linked to invoice item Example: 123 | No |
| product | ProductResponse | Product Response Example: "product" | No |
| productCode | string | Product code Example: "P00001" | Yes |
| productDescription | string | Product description Example: "Apple watch" | No |
| productOrder | integer | Product view order Example: 1 | No |
| productQuantity | number | Product quantity Example: 2 | Yes |
| purchaseInvoiceItemCode | string | Purchase Invoice Item Code Example: "PII-000001" | No |
| rcmRateSA | number | tax rate of rcm Example: 5 | No |
| rcmTaxAmountSA | number | tax rate of rcm Example: 5 | No |
| receivedQuantityInBills | number | Example: 123 | No |
| receivedQuantityInOrder | number | Example: 123 | No |
| tax | TaxDto | Tax details Example: "taxDto" | No |
| taxAmount | number | Tax amount Example: 0.5 | No |
| taxCode | string | Tax code Example: "GST7" | No |
| tdsAccount | string | Tds Account Code Example: "AC-0000011" | No |
| tdsAmount | number | TDS Amount Example: 100 | No |
| tdsId | integer | TDS Id Example: 1 | No |
| tdsRate | number | TDS Rate Example: 10.1 | No |
| totalAmount | number | Total amount Example: 2.3 | Yes |
| uaeRcmRate | number | tax rate of rcm Example: 5 | No |
| unitPrice | number | Product unit price Example: 0.7 | Yes |
| uomQuantity | number | uom quantity Example: 2 | Yes |
| uomUnitPrice | number | UOM Unit price Example: 2.3 | Yes |
| vatCustomRateSA | number | tax rate of rcm Example: 5 | No |
| vatTaxAmountSA | number | tax rate of rcm Example: 5 | No |
PurchaseInvoiceProductDetailsAustralia
| Name | Type | Description | Required |
|---|---|---|---|
| additionalChargeAmount | number | Example: 123 | No |
| additionalChargeAmountCalculated | number | No | |
| additionalChargeTaxamount | number | Example: 123 | No |
| additionalChargeTaxamountCalculated | number | No | |
| additionalCharges | AdditionalCharges | Purchase invoice item additional charges details | No |
| advancedTrackingType | string | Advanced Tracking Type Enum: "NONE", "BATCH", "SERIAL" | No |
| amortizationDocumentItemDetails | AmortizationDocumentItemDetails | No | |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| discount | number | Discount Example: 2 | No |
| discountInPercent | boolean | Discount in percentage Example: true | No |
| documentUOMSchemaDefinition | DocumentUOMSchemaDefinition | Document UOM Schema Definition Example: 2 | Yes |
| documentUom | long | Document UOM id Example: 2 | Yes |
| id | long | ID Example: 2 | No |
| isPartialInvoice | boolean | Whether the Purchase Invoice is a partial invoice Example: false | No |
| landedCostDetails | LandedCostDetails | Details for landed cost | No |
| lineNumber | integer | Line Number Example: 1 | No |
| linkedOrderItem | long | Order Item linked to invoice item Example: 123 | No |
| product | ProductResponse | Product Response Example: "product" | No |
| productCode | string | Product code Example: "P00001" | Yes |
| productDescription | string | Product description Example: "Apple watch" | No |
| productOrder | integer | Product view order Example: 1 | No |
| productQuantity | number | Product quantity Example: 2 | Yes |
| purchaseInvoiceItemCode | string | Purchase Invoice Item Code Example: "PII-000001" | No |
| receivedQuantityInBills | number | Example: 123 | No |
| receivedQuantityInOrder | number | Example: 123 | No |
| tax | TaxDto | Tax details Example: "taxDto" | No |
| taxAmount | number | Tax amount Example: 0.5 | No |
| taxCode | string | Tax code Example: "GST7" | No |
| tdsAccount | string | Tds Account Code Example: "AC-0000011" | No |
| tdsAmount | number | TDS Amount Example: 100 | No |
| tdsId | integer | TDS Id Example: 1 | No |
| tdsRate | number | TDS Rate Example: 10.1 | No |
| totalAmount | number | Total amount Example: 2.3 | Yes |
| unitPrice | number | Product unit price Example: 0.7 | Yes |
| uomQuantity | number | uom quantity Example: 2 | Yes |
| uomUnitPrice | number | UOM Unit price Example: 2.3 | Yes |
PurchaseInvoiceProductDetailsCanada
| Name | Type | Description | Required |
|---|---|---|---|
| additionalChargeAmount | number | Example: 123 | No |
| additionalChargeAmountCalculated | number | No | |
| additionalChargeTaxamount | number | Example: 123 | No |
| additionalChargeTaxamountCalculated | number | No | |
| additionalCharges | AdditionalCharges | Purchase invoice item additional charges details | No |
| advancedTrackingType | string | Advanced Tracking Type Enum: "NONE", "BATCH", "SERIAL" | No |
| amortizationDocumentItemDetails | AmortizationDocumentItemDetails | No | |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| discount | number | Discount Example: 2 | No |
| discountInPercent | boolean | Discount in percentage Example: true | No |
| documentUOMSchemaDefinition | DocumentUOMSchemaDefinition | Document UOM Schema Definition Example: 2 | Yes |
| documentUom | long | Document UOM id Example: 2 | Yes |
| id | long | ID Example: 2 | No |
| isPartialInvoice | boolean | Whether the Purchase Invoice is a partial invoice Example: false | No |
| landedCostDetails | LandedCostDetails | Details for landed cost | No |
| lineNumber | integer | Line Number Example: 1 | No |
| linkedOrderItem | long | Order Item linked to invoice item Example: 123 | No |
| product | ProductResponse | Product Response Example: "product" | No |
| productCode | string | Product code Example: "P00001" | Yes |
| productDescription | string | Product description Example: "Apple watch" | No |
| productOrder | integer | Product view order Example: 1 | No |
| productQuantity | number | Product quantity Example: 2 | Yes |
| purchaseInvoiceItemCode | string | Purchase Invoice Item Code Example: "PII-000001" | No |
| receivedQuantityInBills | number | Example: 123 | No |
| receivedQuantityInOrder | number | Example: 123 | No |
| tax | TaxDto | Tax details Example: "taxDto" | No |
| taxAmount | number | Tax amount Example: 0.5 | No |
| taxCode | string | Tax code Example: "GST7" | No |
| tdsAccount | string | Tds Account Code Example: "AC-0000011" | No |
| tdsAmount | number | TDS Amount Example: 100 | No |
| tdsId | integer | TDS Id Example: 1 | No |
| tdsRate | number | TDS Rate Example: 10.1 | No |
| totalAmount | number | Total amount Example: 2.3 | Yes |
| unitPrice | number | Product unit price Example: 0.7 | Yes |
| uomQuantity | number | uom quantity Example: 2 | Yes |
| uomUnitPrice | number | UOM Unit price Example: 2.3 | Yes |
PurchaseInvoiceProductDetailsGermany
| Name | Type | Description | Required |
|---|---|---|---|
| additionalChargeAmount | number | Example: 123 | No |
| additionalChargeAmountCalculated | number | No | |
| additionalChargeTaxamount | number | Example: 123 | No |
| additionalChargeTaxamountCalculated | number | No | |
| additionalCharges | AdditionalCharges | Purchase invoice item additional charges details | No |
| advancedTrackingType | string | Advanced Tracking Type Enum: "NONE", "BATCH", "SERIAL" | No |
| amortizationDocumentItemDetails | AmortizationDocumentItemDetails | No | |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| discount | number | Discount Example: 2 | No |
| discountInPercent | boolean | Discount in percentage Example: true | No |
| documentUOMSchemaDefinition | DocumentUOMSchemaDefinition | Document UOM Schema Definition Example: 2 | Yes |
| documentUom | long | Document UOM id Example: 2 | Yes |
| id | long | ID Example: 2 | No |
| isPartialInvoice | boolean | Whether the Purchase Invoice is a partial invoice Example: false | No |
| landedCostDetails | LandedCostDetails | Details for landed cost | No |
| lineNumber | integer | Line Number Example: 1 | No |
| linkedOrderItem | long | Order Item linked to invoice item Example: 123 | No |
| product | ProductResponse | Product Response Example: "product" | No |
| productCode | string | Product code Example: "P00001" | Yes |
| productDescription | string | Product description Example: "Apple watch" | No |
| productOrder | integer | Product view order Example: 1 | No |
| productQuantity | number | Product quantity Example: 2 | Yes |
| purchaseInvoiceItemCode | string | Purchase Invoice Item Code Example: "PII-000001" | No |
| receivedQuantityInBills | number | Example: 123 | No |
| receivedQuantityInOrder | number | Example: 123 | No |
| tax | TaxDto | Tax details Example: "taxDto" | No |
| taxAmount | number | Tax amount Example: 0.5 | No |
| taxCode | string | Tax code Example: "GST7" | No |
| tdsAccount | string | Tds Account Code Example: "AC-0000011" | No |
| tdsAmount | number | TDS Amount Example: 100 | No |
| tdsId | integer | TDS Id Example: 1 | No |
| tdsRate | number | TDS Rate Example: 10.1 | No |
| totalAmount | number | Total amount Example: 2.3 | Yes |
| unitPrice | number | Product unit price Example: 0.7 | Yes |
| uomQuantity | number | uom quantity Example: 2 | Yes |
| uomUnitPrice | number | UOM Unit price Example: 2.3 | Yes |
PurchaseInvoiceProductDetailsIndia
| Name | Type | Description | Required |
|---|---|---|---|
| additionalChargeAmount | number | Example: 123 | No |
| additionalChargeAmountCalculated | number | No | |
| additionalChargeTaxamount | number | Example: 123 | No |
| additionalChargeTaxamountCalculated | number | No | |
| additionalCharges | AdditionalCharges | Purchase invoice item additional charges details | No |
| advancedTrackingType | string | Advanced Tracking Type Enum: "NONE", "BATCH", "SERIAL" | No |
| amortizationDocumentItemDetails | AmortizationDocumentItemDetails | No | |
| cessAmount | number | cess amount Example: 40 | No |
| cessPercentage | number | Cess Percentage Example: 2.322 | No |
| cessRule | string | Cess rule expression Example: "Math.max(21amount/100,4170quantity/1000)" | No |
| cgstAmount | number | CGST tax amount Example: 60 | No |
| cgstRate | number | CGST tax rate Example: 6 | No |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| discount | number | Discount Example: 2 | No |
| discountInPercent | boolean | Discount in percentage Example: true | No |
| documentUOMSchemaDefinition | DocumentUOMSchemaDefinition | Document UOM Schema Definition Example: 2 | Yes |
| documentUom | long | Document UOM id Example: 2 | Yes |
| hsnOrSacCode | string | Hsn or Sac code Example: 110011 | No |
| id | long | ID Example: 2 | No |
| igstAmount | number | IGST tax amount Example: 120 | No |
| igstRate | number | IGST tax rate Example: 12 | No |
| isPartialInvoice | boolean | Whether the Purchase Invoice is a partial invoice Example: false | No |
| isTdsApplicableAccount | boolean | No | |
| isTdsApplicableContact | boolean | No | |
| isTdsApplicableProduct | boolean | No | |
| itcAdjustment | string | ITC adjustment Enum: "NA", "ITC_IS_BLOCKED", "ITC_IS_REVERSED"Example: "ITC_IS_BLOCKED" | No |
| itcIneligibleType | string | Ineligible - as per Section 17(5) Enum: "ITC_INELIGIBLE_SECTION_17", "ITC_INELIGIBLE_OTHERS"Example: "ITC_INELIGIBLE_SECTION_17" | No |
| landedCostDetails | LandedCostDetails | Details for landed cost | No |
| lineNumber | integer | Line Number Example: 1 | No |
| linkedOrderItem | long | Order Item linked to invoice item Example: 123 | No |
| otherRate | number | SGST tax rate Example: 6 | No |
| otherTaxAmount | number | Total amount Example: 1000 | Yes |
| product | ProductResponse | Product Response Example: "product" | No |
| productCode | string | Product code Example: "P00001" | Yes |
| productDescription | string | Product description Example: "Apple watch" | No |
| productOrder | integer | Product view order Example: 1 | No |
| productQuantity | number | Product quantity Example: 2 | Yes |
| purchaseInvoiceItemCode | string | Purchase Invoice Item Code Example: "PII-000001" | No |
| receivedQuantityInBills | number | Example: 123 | No |
| receivedQuantityInOrder | number | Example: 123 | No |
| sgstAmount | number | SGST tax amount Example: 60 | No |
| sgstRate | number | SGST tax rate Example: 6 | No |
| tax | TaxDto | Tax details Example: "taxDto" | No |
| taxAmount | number | Tax amount Example: 160 | Yes |
| taxCode | string | Tax code Example: "GST7" | No |
| taxExemptionReason | string | Tax Exemption reason if taxPreference is true Enum: "EXEMPTED", "NON_GST"Example: "EXEMPTED" | No |
| taxPreference | boolean | Tax preference, whether Exempted or not Exempted Example: false | No |
| tdsAccount | string | Tds Account Code Example: "AC-0000011" | No |
| tdsAmount | number | TDS Amount Example: 100 | No |
| tdsId | integer | TDS Id Example: 1 | No |
| tdsInfoIndia | TdsInfoIndia | Purchase invoice TDS details | No |
| tdsRate | number | TDS Rate Example: 10.1 | No |
| totalAmount | number | Total amount Example: 1000 | Yes |
| totalAmountInclTax | number | total amount inclusive of all taxes Example: 1160 | Yes |
| unitPrice | number | Product unit price Example: 0.7 | Yes |
| uomQuantity | number | uom quantity Example: 2 | Yes |
| uomUnitPrice | number | UOM Unit price Example: 2.3 | Yes |
| userSetTaxes | boolean | Flag to check whether tax is user edited Example: false | No |
PurchaseInvoiceProductDetailsIndonesia
| Name | Type | Description | Required |
|---|---|---|---|
| additionalChargeAmount | number | Example: 123 | No |
| additionalChargeAmountCalculated | number | No | |
| additionalChargeTaxamount | number | Example: 123 | No |
| additionalChargeTaxamountCalculated | number | No | |
| additionalCharges | AdditionalCharges | Purchase invoice item additional charges details | No |
| advancedTrackingType | string | Advanced Tracking Type Enum: "NONE", "BATCH", "SERIAL" | No |
| amortizationDocumentItemDetails | AmortizationDocumentItemDetails | No | |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| discount | number | Discount Example: 2 | No |
| discountInPercent | boolean | Discount in percentage Example: true | No |
| documentUOMSchemaDefinition | DocumentUOMSchemaDefinition | Document UOM Schema Definition Example: 2 | Yes |
| documentUom | long | Document UOM id Example: 2 | Yes |
| exciseAmount | number | Excise amount Example: 0.5 | No |
| exciseRate | double | Rate of Excise Example: 5 | No |
| exciseType | string | Excise type Enum: "PERCENT", "FLAT"Example: "FLAT" | No |
| id | long | ID Example: 2 | No |
| isPartialInvoice | boolean | Whether the Purchase Invoice is a partial invoice Example: false | No |
| landedCostDetails | LandedCostDetails | Details for landed cost | No |
| lineNumber | integer | Line Number Example: 1 | No |
| linkedOrderItem | long | Order Item linked to invoice item Example: 123 | No |
| product | ProductResponse | Product Response Example: "product" | No |
| productCode | string | Product code Example: "P00001" | Yes |
| productDescription | string | Product description Example: "Apple watch" | No |
| productOrder | integer | Product view order Example: 1 | No |
| productQuantity | number | Product quantity Example: 2 | Yes |
| purchaseInvoiceItemCode | string | Purchase Invoice Item Code Example: "PII-000001" | No |
| receivedQuantityInBills | number | Example: 123 | No |
| receivedQuantityInOrder | number | Example: 123 | No |
| tax | TaxDto | Tax details Example: "taxDto" | No |
| taxAmount | number | Tax amount Example: 0.5 | No |
| taxCode | string | Tax code Example: "GST7" | No |
| tdsAccount | string | Tds Account Code Example: "AC-0000011" | No |
| tdsAmount | number | TDS Amount Example: 100 | No |
| tdsId | integer | TDS Id Example: 1 | No |
| tdsRate | number | TDS Rate Example: 10.1 | No |
| totalAmount | number | Total amount Example: 2.3 | Yes |
| unitPrice | number | Product unit price Example: 0.7 | Yes |
| uomQuantity | number | uom quantity Example: 2 | Yes |
| uomUnitPrice | number | UOM Unit price Example: 2.3 | Yes |
PurchaseInvoiceProductDetailsIsrael
| Name | Type | Description | Required |
|---|---|---|---|
| additionalChargeAmount | number | Example: 123 | No |
| additionalChargeAmountCalculated | number | No | |
| additionalChargeTaxamount | number | Example: 123 | No |
| additionalChargeTaxamountCalculated | number | No | |
| additionalCharges | AdditionalCharges | Purchase invoice item additional charges details | No |
| advancedTrackingType | string | Advanced Tracking Type Enum: "NONE", "BATCH", "SERIAL" | No |
| amortizationDocumentItemDetails | AmortizationDocumentItemDetails | No | |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| discount | number | Discount Example: 2 | No |
| discountInPercent | boolean | Discount in percentage Example: true | No |
| documentUOMSchemaDefinition | DocumentUOMSchemaDefinition | Document UOM Schema Definition Example: 2 | Yes |
| documentUom | long | Document UOM id Example: 2 | Yes |
| id | long | ID Example: 2 | No |
| isPartialInvoice | boolean | Whether the Purchase Invoice is a partial invoice Example: false | No |
| landedCostDetails | LandedCostDetails | Details for landed cost | No |
| lineNumber | integer | Line Number Example: 1 | No |
| linkedOrderItem | long | Order Item linked to invoice item Example: 123 | No |
| product | ProductResponse | Product Response Example: "product" | No |
| productCode | string | Product code Example: "P00001" | Yes |
| productDescription | string | Product description Example: "Apple watch" | No |
| productOrder | integer | Product view order Example: 1 | No |
| productQuantity | number | Product quantity Example: 2 | Yes |
| purchaseInvoiceItemCode | string | Purchase Invoice Item Code Example: "PII-000001" | No |
| receivedQuantityInBills | number | Example: 123 | No |
| receivedQuantityInOrder | number | Example: 123 | No |
| tax | TaxDto | Tax details Example: "taxDto" | No |
| taxAmount | number | Tax amount Example: 0.5 | No |
| taxCode | string | Tax code Example: "GST7" | No |
| tdsAccount | string | Tds Account Code Example: "AC-0000011" | No |
| tdsAmount | number | TDS Amount Example: 100 | No |
| tdsId | integer | TDS Id Example: 1 | No |
| tdsRate | number | TDS Rate Example: 10.1 | No |
| totalAmount | number | Total amount Example: 2.3 | Yes |
| unitPrice | number | Product unit price Example: 0.7 | Yes |
| uomQuantity | number | uom quantity Example: 2 | Yes |
| uomUnitPrice | number | UOM Unit price Example: 2.3 | Yes |
PurchaseInvoiceProductDetailsMalaysia
| Name | Type | Description | Required |
|---|---|---|---|
| additionalChargeAmount | number | Example: 123 | No |
| additionalChargeAmountCalculated | number | No | |
| additionalChargeTaxamount | number | Example: 123 | No |
| additionalChargeTaxamountCalculated | number | No | |
| additionalCharges | AdditionalCharges | Purchase invoice item additional charges details | No |
| advancedTrackingType | string | Advanced Tracking Type Enum: "NONE", "BATCH", "SERIAL" | No |
| amortizationDocumentItemDetails | AmortizationDocumentItemDetails | No | |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| discount | number | Discount Example: 2 | No |
| discountInPercent | boolean | Discount in percentage Example: true | No |
| documentUOMSchemaDefinition | DocumentUOMSchemaDefinition | Document UOM Schema Definition Example: 2 | Yes |
| documentUom | long | Document UOM id Example: 2 | Yes |
| id | long | ID Example: 2 | No |
| isPartialInvoice | boolean | Whether the Purchase Invoice is a partial invoice Example: false | No |
| landedCostDetails | LandedCostDetails | Details for landed cost | No |
| lineNumber | integer | Line Number Example: 1 | No |
| linkedOrderItem | long | Order Item linked to invoice item Example: 123 | No |
| product | ProductResponse | Product Response Example: "product" | No |
| productCode | string | Product code Example: "P00001" | Yes |
| productDescription | string | Product description Example: "Apple watch" | No |
| productOrder | integer | Product view order Example: 1 | No |
| productQuantity | number | Product quantity Example: 2 | Yes |
| purchaseInvoiceItemCode | string | Purchase Invoice Item Code Example: "PII-000001" | No |
| receivedQuantityInBills | number | Example: 123 | No |
| receivedQuantityInOrder | number | Example: 123 | No |
| tax | TaxDto | Tax details Example: "taxDto" | No |
| taxAmount | number | Tax amount Example: 0.5 | No |
| taxCode | string | Tax code Example: "GST7" | No |
| tdsAccount | string | Tds Account Code Example: "AC-0000011" | No |
| tdsAmount | number | TDS Amount Example: 100 | No |
| tdsId | integer | TDS Id Example: 1 | No |
| tdsRate | number | TDS Rate Example: 10.1 | No |
| totalAmount | number | Total amount Example: 2.3 | Yes |
| unitPrice | number | Product unit price Example: 0.7 | Yes |
| uomQuantity | number | uom quantity Example: 2 | Yes |
| uomUnitPrice | number | UOM Unit price Example: 2.3 | Yes |
PurchaseInvoiceProductDetailsPhilippines
| Name | Type | Description | Required |
|---|---|---|---|
| additionalChargeAmount | number | Example: 123 | No |
| additionalChargeAmountCalculated | number | No | |
| additionalChargeTaxamount | number | Example: 123 | No |
| additionalChargeTaxamountCalculated | number | No | |
| additionalCharges | AdditionalCharges | Purchase invoice item additional charges details | No |
| advancedTrackingType | string | Advanced Tracking Type Enum: "NONE", "BATCH", "SERIAL" | No |
| amortizationDocumentItemDetails | AmortizationDocumentItemDetails | No | |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| discount | number | Discount Example: 2 | No |
| discountInPercent | boolean | Discount in percentage Example: true | No |
| documentUOMSchemaDefinition | DocumentUOMSchemaDefinition | Document UOM Schema Definition Example: 2 | Yes |
| documentUom | long | Document UOM id Example: 2 | Yes |
| id | long | ID Example: 2 | No |
| isPartialInvoice | boolean | Whether the Purchase Invoice is a partial invoice Example: false | No |
| landedCostDetails | LandedCostDetails | Details for landed cost | No |
| lineNumber | integer | Line Number Example: 1 | No |
| linkedOrderItem | long | Order Item linked to invoice item Example: 123 | No |
| product | ProductResponse | Product Response Example: "product" | No |
| productCode | string | Product code Example: "P00001" | Yes |
| productDescription | string | Product description Example: "Apple watch" | No |
| productOrder | integer | Product view order Example: 1 | No |
| productQuantity | number | Product quantity Example: 2 | Yes |
| purchaseInvoiceItemCode | string | Purchase Invoice Item Code Example: "PII-000001" | No |
| receivedQuantityInBills | number | Example: 123 | No |
| receivedQuantityInOrder | number | Example: 123 | No |
| tax | TaxDto | Tax details Example: "taxDto" | No |
| taxAmount | number | Tax amount Example: 0.5 | No |
| taxCode | string | Tax code Example: "GST7" | No |
| tdsAccount | string | Tds Account Code Example: "AC-0000011" | No |
| tdsAmount | number | TDS Amount Example: 100 | No |
| tdsId | integer | TDS Id Example: 1 | No |
| tdsRate | number | TDS Rate Example: 10.1 | No |
| totalAmount | number | Total amount Example: 2.3 | Yes |
| unitPrice | number | Product unit price Example: 0.7 | Yes |
| uomQuantity | number | uom quantity Example: 2 | Yes |
| uomUnitPrice | number | UOM Unit price Example: 2.3 | Yes |
PurchaseInvoiceProductDetailsUk
| Name | Type | Description | Required |
|---|---|---|---|
| additionalChargeAmount | number | Example: 123 | No |
| additionalChargeAmountCalculated | number | No | |
| additionalChargeTaxamount | number | Example: 123 | No |
| additionalChargeTaxamountCalculated | number | No | |
| additionalCharges | AdditionalCharges | Purchase invoice item additional charges details | No |
| advancedTrackingType | string | Advanced Tracking Type Enum: "NONE", "BATCH", "SERIAL" | No |
| amortizationDocumentItemDetails | AmortizationDocumentItemDetails | No | |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| discount | number | Discount Example: 2 | No |
| discountInPercent | boolean | Discount in percentage Example: true | No |
| documentUOMSchemaDefinition | DocumentUOMSchemaDefinition | Document UOM Schema Definition Example: 2 | Yes |
| documentUom | long | Document UOM id Example: 2 | Yes |
| id | long | ID Example: 2 | No |
| isPartialInvoice | boolean | Whether the Purchase Invoice is a partial invoice Example: false | No |
| landedCostDetails | LandedCostDetails | Details for landed cost | No |
| lineNumber | integer | Line Number Example: 1 | No |
| linkedOrderItem | long | Order Item linked to invoice item Example: 123 | No |
| product | ProductResponse | Product Response Example: "product" | No |
| productCode | string | Product code Example: "P00001" | Yes |
| productDescription | string | Product description Example: "Apple watch" | No |
| productOrder | integer | Product view order Example: 1 | No |
| productQuantity | number | Product quantity Example: 2 | Yes |
| purchaseInvoiceItemCode | string | Purchase Invoice Item Code Example: "PII-000001" | No |
| receivedQuantityInBills | number | Example: 123 | No |
| receivedQuantityInOrder | number | Example: 123 | No |
| tax | TaxDto | Tax details Example: "taxDto" | No |
| taxAmount | number | Tax amount Example: 0.5 | No |
| taxCode | string | Tax code Example: "GST7" | No |
| tdsAccount | string | Tds Account Code Example: "AC-0000011" | No |
| tdsAmount | number | TDS Amount Example: 100 | No |
| tdsId | integer | TDS Id Example: 1 | No |
| tdsRate | number | TDS Rate Example: 10.1 | No |
| totalAmount | number | Total amount Example: 2.3 | Yes |
| unitPrice | number | Product unit price Example: 0.7 | Yes |
| uomQuantity | number | uom quantity Example: 2 | Yes |
| uomUnitPrice | number | UOM Unit price Example: 2.3 | Yes |
PurchaseInvoiceRecurringDetails
| Name | Type | Description | Required |
|---|---|---|---|
| id | long | ID Example: 2 | No |
| invoiceRecurringCount | integer | Number of Invoices to be created Example: 1 | Yes |
| recurrenceEndDate | string | Recurrence End date Example: "25-10-2019" | Yes |
| recurrenceFrequency | string | Days, Weeks or Months Enum: "DAYS", "WEEK", "MONTH"Example: "WEEK" | Yes |
| recurrenceType | integer | Every x Days/Weeks/Months Example: 1 | Yes |
PurchaseInvoiceRequest
| Name | Type | Description | Required |
|---|---|---|---|
| additionalCharges | AdditionalCharges | Purchase invoice additional charges details | No |
| approvalStatus | string | Approval status Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"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 |
| contact | ContactInfo | Contact details | Yes |
| contactCode | string | Contact Code Example: "C0001" | Yes |
| currency | string | Currency Example: "C001" | Yes |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| documentSequenceCode | string | Bill Code Example: "0000001" | No |
| draft | boolean | True if want to save as draft. Example: false | No |
| draftReferenceId | string | Draft reference id | No |
| dropShip | boolean | Drop Ship flag to indicate if purchase invoice is created for drop ship Example: true | No |
| dueAmount | number | Amount Due Example: 12.322 | 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 |
| journalEntryCode | string | Journal Entry Code Example: "JE0001" | No |
| landedCost | boolean | To mark landed cost bill Example: true | No |
| linkedDocuments | [ DocumentInfo ] | Linked Documents | No |
| memo | string | Memo Example: "Memo details" | No |
| openingDocumentNumber | string | Customer opening document number Example: "DC-0001" | No |
| openingInvoice | boolean | True if opening invoice Example: false | No |
| payableAccountCode | string | Code of Account Example: "AC-000001" | 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 |
| purchaseInvoiceAccounts | [ PurchaseInvoiceAccountDetails ] | Purchase invoice Account item details | No |
| purchaseInvoiceAssets | [ PurchaseInvoiceAssetGroupDetails ] | 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 Product item details | No |
| purchaseInvoiceRecurring | PurchaseInvoiceRecurringDetails | Purchase invoice item details | No |
| purchaseInvoiceType | string | Purchase invoice type. Enum: "INVENTORY", "EXPENSE", "ASSET"Example: "INVENTORY" | Yes |
| purchaseOrderRefNo | string | Contact PO reference number Example: "CPO001" | No |
| receiptDate | dateTime | Receipt date Example: "25-10-2019" | No |
| receiveByDate | dateTime | Receive by date Example: "25-10-2019" | No |
| receiveGoodsStatus | string | receipt goods status Enum: "UNRECEIVED", "PARTIAL_RECEIVED", "FULLY_RECEIVED", "NOT_APPLICABLE"Example: "FULLY_RECEIVED" | No |
| receivedComplete | boolean | True if auto received is required. Example: false | No |
| recurring | boolean | True if Invoice is recurring. Example: true | No |
| recurringActivated | boolean | True if Invoice recurrence is active. Example: false | 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 |
| sequenceFormat | string | Sequence Format Id Example: 1 | 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 | 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 Example: 12.32 | No |
| unitPriceGstInclusive | boolean | Unit price is GST inclusive Example: false | No |
| warehouseCode | string | Warehouse Code Example: "WH-000001" | No |
PurchaseInvoiceRequestAustralia
| Name | Type | Description | Required |
|---|---|---|---|
| additionalCharges | AdditionalCharges | Purchase invoice additional charges details | No |
| approvalStatus | string | Approval status Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"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 |
| contact | ContactInfo | Contact details | Yes |
| contactCode | string | Contact Code Example: "C0001" | Yes |
| currency | string | Currency Example: "C001" | Yes |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| documentSequenceCode | string | Bill Code Example: "0000001" | No |
| draft | boolean | True if want to save as draft. Example: false | No |
| draftReferenceId | string | Draft reference id | No |
| dropShip | boolean | Drop Ship flag to indicate if purchase invoice is created for drop ship Example: true | No |
| dueAmount | number | Amount Due Example: 12.322 | 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 |
| journalEntryCode | string | Journal Entry Code Example: "JE0001" | No |
| landedCost | boolean | To mark landed cost bill Example: true | No |
| linkedDocuments | [ DocumentInfo ] | Linked Documents | No |
| memo | string | Memo Example: "Memo details" | No |
| openingDocumentNumber | string | Customer opening document number Example: "DC-0001" | No |
| openingInvoice | boolean | True if opening invoice Example: false | No |
| payableAccountCode | string | Code of Account Example: "AC-000001" | 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 |
| purchaseInvoiceAccounts | [ PurchaseInvoiceAccountDetails ] | Purchase invoice Account item details | No |
| purchaseInvoiceAssets | [ PurchaseInvoiceAssetGroupDetails ] | No | |
| purchaseInvoiceDate | string | Purchase Invoice date Example: "25-10-2019" | Yes |
| purchaseInvoiceDueDate | string | Purchase Invoice due date Example: "25-10-2019" | Yes |
| purchaseInvoiceProducts | [ PurchaseInvoiceProductDetailsAustralia ] | Purchase invoice Product item details | No |
| purchaseInvoiceRecurring | PurchaseInvoiceRecurringDetails | Purchase invoice item details | No |
| purchaseInvoiceType | string | Purchase invoice type. Enum: "INVENTORY", "EXPENSE", "ASSET"Example: "INVENTORY" | Yes |
| purchaseOrderRefNo | string | Contact PO reference number Example: "CPO001" | No |
| receiptDate | dateTime | Receipt date Example: "25-10-2019" | No |
| receiveByDate | dateTime | Receive by date Example: "25-10-2019" | No |
| receiveGoodsStatus | string | receipt goods status Enum: "UNRECEIVED", "PARTIAL_RECEIVED", "FULLY_RECEIVED", "NOT_APPLICABLE"Example: "FULLY_RECEIVED" | No |
| receivedComplete | boolean | True if auto received is required. Example: false | No |
| recurring | boolean | True if Invoice is recurring. Example: true | No |
| recurringActivated | boolean | True if Invoice recurrence is active. Example: false | 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 |
| sequenceFormat | string | Sequence Format Id Example: 1 | 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 | 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 Example: 12.32 | No |
| unitPriceGstInclusive | boolean | Unit price is GST inclusive Example: false | No |
| warehouseCode | string | Warehouse Code Example: "WH-000001" | No |
PurchaseInvoiceRequestCanada
| Name | Type | Description | Required |
|---|---|---|---|
| additionalCharges | AdditionalCharges | Purchase invoice additional charges details | No |
| approvalStatus | string | Approval status Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"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 |
| contact | ContactInfo | Contact details | Yes |
| contactCode | string | Contact Code Example: "C0001" | Yes |
| currency | string | Currency Example: "C001" | Yes |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| documentSequenceCode | string | Bill Code Example: "0000001" | No |
| draft | boolean | True if want to save as draft. Example: false | No |
| draftReferenceId | string | Draft reference id | No |
| dropShip | boolean | Drop Ship flag to indicate if purchase invoice is created for drop ship Example: true | No |
| dueAmount | number | Amount Due Example: 12.322 | 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 |
| journalEntryCode | string | Journal Entry Code Example: "JE0001" | No |
| landedCost | boolean | To mark landed cost bill Example: true | No |
| linkedDocuments | [ DocumentInfo ] | Linked Documents | No |
| memo | string | Memo Example: "Memo details" | No |
| openingDocumentNumber | string | Customer opening document number Example: "DC-0001" | No |
| openingInvoice | boolean | True if opening invoice Example: false | No |
| payableAccountCode | string | Code of Account Example: "AC-000001" | 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 |
| purchaseInvoiceAccounts | [ PurchaseInvoiceAccountDetails ] | Purchase invoice Account item details | No |
| purchaseInvoiceAssets | [ PurchaseInvoiceAssetGroupDetails ] | No | |
| purchaseInvoiceDate | string | Purchase Invoice date Example: "25-10-2019" | Yes |
| purchaseInvoiceDueDate | string | Purchase Invoice due date Example: "25-10-2019" | Yes |
| purchaseInvoiceProducts | [ PurchaseInvoiceProductDetailsCanada ] | Purchase invoice Product item details | No |
| purchaseInvoiceRecurring | PurchaseInvoiceRecurringDetails | Purchase invoice item details | No |
| purchaseInvoiceType | string | Purchase invoice type. Enum: "INVENTORY", "EXPENSE", "ASSET"Example: "INVENTORY" | Yes |
| purchaseOrderRefNo | string | Contact PO reference number Example: "CPO001" | No |
| receiptDate | dateTime | Receipt date Example: "25-10-2019" | No |
| receiveByDate | dateTime | Receive by date Example: "25-10-2019" | No |
| receiveGoodsStatus | string | receipt goods status Enum: "UNRECEIVED", "PARTIAL_RECEIVED", "FULLY_RECEIVED", "NOT_APPLICABLE"Example: "FULLY_RECEIVED" | No |
| receivedComplete | boolean | True if auto received is required. Example: false | No |
| recurring | boolean | True if Invoice is recurring. Example: true | No |
| recurringActivated | boolean | True if Invoice recurrence is active. Example: false | 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 |
| sequenceFormat | string | Sequence Format Id Example: 1 | 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 | 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 Example: 12.32 | No |
| unitPriceGstInclusive | boolean | Unit price is GST inclusive Example: false | No |
| warehouseCode | string | Warehouse Code Example: "WH-000001" | No |
PurchaseInvoiceRequestGermany
| Name | Type | Description | Required |
|---|---|---|---|
| additionalCharges | AdditionalCharges | Purchase invoice additional charges details | No |
| approvalStatus | string | Approval status Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"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 |
| contact | ContactInfo | Contact details | Yes |
| contactCode | string | Contact Code Example: "C0001" | Yes |
| currency | string | Currency Example: "C001" | Yes |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| documentSequenceCode | string | Bill Code Example: "0000001" | No |
| draft | boolean | True if want to save as draft. Example: false | No |
| draftReferenceId | string | Draft reference id | No |
| dropShip | boolean | Drop Ship flag to indicate if purchase invoice is created for drop ship Example: true | No |
| dueAmount | number | Amount Due Example: 12.322 | 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 |
| journalEntryCode | string | Journal Entry Code Example: "JE0001" | No |
| landedCost | boolean | To mark landed cost bill Example: true | No |
| linkedDocuments | [ DocumentInfo ] | Linked Documents | No |
| memo | string | Memo Example: "Memo details" | No |
| openingDocumentNumber | string | Customer opening document number Example: "DC-0001" | No |
| openingInvoice | boolean | True if opening invoice Example: false | No |
| payableAccountCode | string | Code of Account Example: "AC-000001" | 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 |
| purchaseInvoiceAccounts | [ PurchaseInvoiceAccountDetails ] | Purchase invoice Account item details | No |
| purchaseInvoiceAssets | [ PurchaseInvoiceAssetGroupDetails ] | No | |
| purchaseInvoiceDate | string | Purchase Invoice date Example: "25-10-2019" | Yes |
| purchaseInvoiceDueDate | string | Purchase Invoice due date Example: "25-10-2019" | Yes |
| purchaseInvoiceProducts | [ PurchaseInvoiceProductDetailsGermany ] | Purchase invoice Product item details | No |
| purchaseInvoiceRecurring | PurchaseInvoiceRecurringDetails | Purchase invoice item details | No |
| purchaseInvoiceType | string | Purchase invoice type. Enum: "INVENTORY", "EXPENSE", "ASSET"Example: "INVENTORY" | Yes |
| purchaseOrderRefNo | string | Contact PO reference number Example: "CPO001" | No |
| receiptDate | dateTime | Receipt date Example: "25-10-2019" | No |
| receiveByDate | dateTime | Receive by date Example: "25-10-2019" | No |
| receiveGoodsStatus | string | receipt goods status Enum: "UNRECEIVED", "PARTIAL_RECEIVED", "FULLY_RECEIVED", "NOT_APPLICABLE"Example: "FULLY_RECEIVED" | No |
| receivedComplete | boolean | True if auto received is required. Example: false | No |
| recurring | boolean | True if Invoice is recurring. Example: true | No |
| recurringActivated | boolean | True if Invoice recurrence is active. Example: false | 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 |
| sequenceFormat | string | Sequence Format Id Example: 1 | 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 | 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 Example: 12.32 | No |
| unitPriceGstInclusive | boolean | Unit price is GST inclusive Example: false | No |
| warehouseCode | string | Warehouse Code Example: "WH-000001" | No |
PurchaseInvoiceRequestIndia
| Name | Type | Description | Required |
|---|---|---|---|
| additionalCharges | AdditionalCharges | Purchase invoice additional charges details | No |
| approvalStatus | string | Approval status Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"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 |
| contact | ContactInfo | Contact details | Yes |
| contactCode | string | Contact Code Example: "C0001" | Yes |
| currency | string | Currency Example: "C001" | Yes |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| customerType | string | Customer Type Enum: "EXPORT_WO_PAY", "EXPORT_W_PAY", "NA", "SEZ_WO_PAY", "SEZ_W_PAY"Example: "NA" | Yes |
| documentSequenceCode | string | Bill Code Example: "0000001" | No |
| draft | boolean | True if want to save as draft. Example: false | No |
| draftReferenceId | string | Draft reference id | No |
| dropShip | boolean | Drop Ship flag to indicate if purchase invoice is created for drop ship Example: true | No |
| dueAmount | number | Amount Due Example: 12.322 | 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 |
| gstTreatment | string | GST Treatment Example: "REGISTERED_BUSINESS_REGULAR" | No |
| gstin | string | GSTIN Example: "ABSASASSASASA198" | Yes |
| isPartialInvoice | boolean | True if is partial invoice Example: false | No |
| journalEntryCode | string | Journal Entry Code Example: "JE0001" | No |
| landedCost | boolean | To mark landed cost bill Example: true | No |
| linkedDocuments | [ DocumentInfo ] | Linked Documents | No |
| memo | string | Memo Example: "Memo details" | No |
| openingDocumentNumber | string | Customer opening document number Example: "DC-0001" | No |
| openingInvoice | boolean | True if opening invoice Example: false | No |
| payableAccountCode | string | Code of Account Example: "AC-000001" | 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 |
| placeOfSupply | string | state in India Example: "Punjab" | Yes |
| purchaseInvoiceAccounts | [ PurchaseInvoiceAccountDetails ] | Purchase invoice Account item details | No |
| purchaseInvoiceAssets | [ PurchaseInvoiceAssetGroupDetails ] | No | |
| purchaseInvoiceDate | string | Purchase Invoice date Example: "25-10-2019" | Yes |
| purchaseInvoiceDueDate | string | Purchase Invoice due date Example: "25-10-2019" | Yes |
| purchaseInvoiceProducts | [ PurchaseInvoiceProductDetailsIndia ] | Purchase invoice Product item details | No |
| purchaseInvoiceRecurring | PurchaseInvoiceRecurringDetails | Purchase invoice item details | No |
| purchaseInvoiceType | string | Purchase invoice type. Enum: "INVENTORY", "EXPENSE", "ASSET"Example: "INVENTORY" | Yes |
| purchaseOrderRefNo | string | Contact PO reference number Example: "CPO001" | No |
| receiptDate | dateTime | Receipt date Example: "25-10-2019" | No |
| receiveByDate | dateTime | Receive by date Example: "25-10-2019" | No |
| receiveGoodsStatus | string | receipt goods status Enum: "UNRECEIVED", "PARTIAL_RECEIVED", "FULLY_RECEIVED", "NOT_APPLICABLE"Example: "FULLY_RECEIVED" | No |
| receivedComplete | boolean | True if auto received is required. Example: false | No |
| recurring | boolean | True if Invoice is recurring. Example: true | No |
| recurringActivated | boolean | True if Invoice recurrence is active. Example: false | 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 |
| sequenceFormat | string | Sequence Format Id Example: 1 | 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 | 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 Example: 12.32 | No |
| unitPriceGstInclusive | boolean | Unit price is GST inclusive Example: false | No |
| vendorType | string | Vendor Type Enum: "IMPORT", "NA", "SEZ_W_PAY", "SEZ_WO_PAY"Example: "NA" | Yes |
| warehouseCode | string | Warehouse Code Example: "WH-000001" | No |
PurchaseInvoiceRequestIndonesia
| Name | Type | Description | Required |
|---|---|---|---|
| additionalCharges | AdditionalCharges | Purchase invoice additional charges details | No |
| approvalStatus | string | Approval status Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"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 |
| contact | ContactInfo | Contact details | Yes |
| contactCode | string | Contact Code Example: "C0001" | Yes |
| currency | string | Currency Example: "C001" | Yes |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| documentSequenceCode | string | Bill Code Example: "0000001" | No |
| draft | boolean | True if want to save as draft. Example: false | No |
| draftReferenceId | string | Draft reference id | No |
| dropShip | boolean | Drop Ship flag to indicate if purchase invoice is created for drop ship Example: true | No |
| dueAmount | number | Amount Due Example: 12.322 | 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 |
| isCreditable | boolean | Is Creditable Example: true | No |
| isPartialInvoice | boolean | True if is partial invoice Example: false | No |
| journalEntryCode | string | Journal Entry Code Example: "JE0001" | No |
| landedCost | boolean | To mark landed cost bill Example: true | No |
| linkedDocuments | [ DocumentInfo ] | Linked Documents | No |
| memo | string | Memo Example: "Memo details" | No |
| openingDocumentNumber | string | Customer opening document number Example: "DC-0001" | No |
| openingInvoice | boolean | True if opening invoice Example: false | No |
| payableAccountCode | string | Code of Account Example: "AC-000001" | 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 |
| purchaseInvoiceAccounts | [ PurchaseInvoiceAccountDetails ] | Purchase invoice Account item details | No |
| purchaseInvoiceAssets | [ PurchaseInvoiceAssetGroupDetails ] | No | |
| purchaseInvoiceDate | string | Purchase Invoice date Example: "25-10-2019" | Yes |
| purchaseInvoiceDueDate | string | Purchase Invoice due date Example: "25-10-2019" | Yes |
| purchaseInvoiceProducts | [ PurchaseInvoiceProductDetailsIndonesia ] | Purchase invoice Product item details | No |
| purchaseInvoiceRecurring | PurchaseInvoiceRecurringDetails | Purchase invoice item details | No |
| purchaseInvoiceType | string | Purchase invoice type. Enum: "INVENTORY", "EXPENSE", "ASSET"Example: "INVENTORY" | Yes |
| purchaseOrderRefNo | string | Contact PO reference number Example: "CPO001" | No |
| receiptDate | dateTime | Receipt date Example: "25-10-2019" | No |
| receiveByDate | dateTime | Receive by date Example: "25-10-2019" | No |
| receiveGoodsStatus | string | receipt goods status Enum: "UNRECEIVED", "PARTIAL_RECEIVED", "FULLY_RECEIVED", "NOT_APPLICABLE"Example: "FULLY_RECEIVED" | No |
| receivedComplete | boolean | True if auto received is required. Example: false | No |
| recurring | boolean | True if Invoice is recurring. Example: true | No |
| recurringActivated | boolean | True if Invoice recurrence is active. Example: false | 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 |
| sequenceFormat | string | Sequence Format Id Example: 1 | 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 | No | |
| taxAmount | number | Tax amount Example: 2.322 | No |
| taxInvoiceNo | string | Tax Invoice No Example: 123456789 | 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 Example: 12.32 | No |
| unitPriceGstInclusive | boolean | Unit price is GST inclusive Example: false | No |
| warehouseCode | string | Warehouse Code Example: "WH-000001" | No |
PurchaseInvoiceRequestIsrael
| Name | Type | Description | Required |
|---|---|---|---|
| additionalCharges | AdditionalCharges | Purchase invoice additional charges details | No |
| approvalStatus | string | Approval status Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"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 |
| contact | ContactInfo | Contact details | Yes |
| contactCode | string | Contact Code Example: "C0001" | Yes |
| currency | string | Currency Example: "C001" | Yes |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| documentSequenceCode | string | Bill Code Example: "0000001" | No |
| draft | boolean | True if want to save as draft. Example: false | No |
| draftReferenceId | string | Draft reference id | No |
| dropShip | boolean | Drop Ship flag to indicate if purchase invoice is created for drop ship Example: true | No |
| dueAmount | number | Amount Due Example: 12.322 | 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 |
| journalEntryCode | string | Journal Entry Code Example: "JE0001" | No |
| landedCost | boolean | To mark landed cost bill Example: true | No |
| linkedDocuments | [ DocumentInfo ] | Linked Documents | No |
| memo | string | Memo Example: "Memo details" | No |
| openingDocumentNumber | string | Customer opening document number Example: "DC-0001" | No |
| openingInvoice | boolean | True if opening invoice Example: false | No |
| payableAccountCode | string | Code of Account Example: "AC-000001" | 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 |
| purchaseInvoiceAccounts | [ PurchaseInvoiceAccountDetails ] | Purchase invoice Account item details | No |
| purchaseInvoiceAssets | [ PurchaseInvoiceAssetGroupDetails ] | No | |
| purchaseInvoiceDate | string | Purchase Invoice date Example: "25-10-2019" | Yes |
| purchaseInvoiceDueDate | string | Purchase Invoice due date Example: "25-10-2019" | Yes |
| purchaseInvoiceProducts | [ PurchaseInvoiceProductDetailsIsrael ] | Purchase invoice Product item details | No |
| purchaseInvoiceRecurring | PurchaseInvoiceRecurringDetails | Purchase invoice item details | No |
| purchaseInvoiceType | string | Purchase invoice type. Enum: "INVENTORY", "EXPENSE", "ASSET"Example: "INVENTORY" | Yes |
| purchaseOrderRefNo | string | Contact PO reference number Example: "CPO001" | No |
| receiptDate | dateTime | Receipt date Example: "25-10-2019" | No |
| receiveByDate | dateTime | Receive by date Example: "25-10-2019" | No |
| receiveGoodsStatus | string | receipt goods status Enum: "UNRECEIVED", "PARTIAL_RECEIVED", "FULLY_RECEIVED", "NOT_APPLICABLE"Example: "FULLY_RECEIVED" | No |
| receivedComplete | boolean | True if auto received is required. Example: false | No |
| recurring | boolean | True if Invoice is recurring. Example: true | No |
| recurringActivated | boolean | True if Invoice recurrence is active. Example: false | 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 |
| sequenceFormat | string | Sequence Format Id Example: 1 | 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 | 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 Example: 12.32 | No |
| unitPriceGstInclusive | boolean | Unit price is GST inclusive Example: false | No |
| warehouseCode | string | Warehouse Code Example: "WH-000001" | No |
PurchaseInvoiceRequestMalaysia
| Name | Type | Description | Required |
|---|---|---|---|
| additionalCharges | AdditionalCharges | Purchase invoice additional charges details | No |
| approvalStatus | string | Approval status Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"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 |
| contact | ContactInfo | Contact details | Yes |
| contactCode | string | Contact Code Example: "C0001" | Yes |
| currency | string | Currency Example: "C001" | Yes |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| documentSequenceCode | string | Bill Code Example: "0000001" | No |
| draft | boolean | True if want to save as draft. Example: false | No |
| draftReferenceId | string | Draft reference id | No |
| dropShip | boolean | Drop Ship flag to indicate if purchase invoice is created for drop ship Example: true | No |
| dueAmount | number | Amount Due Example: 12.322 | 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 |
| journalEntryCode | string | Journal Entry Code Example: "JE0001" | No |
| landedCost | boolean | To mark landed cost bill Example: true | No |
| linkedDocuments | [ DocumentInfo ] | Linked Documents | No |
| memo | string | Memo Example: "Memo details" | No |
| openingDocumentNumber | string | Customer opening document number Example: "DC-0001" | No |
| openingInvoice | boolean | True if opening invoice Example: false | No |
| payableAccountCode | string | Code of Account Example: "AC-000001" | 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 |
| purchaseInvoiceAccounts | [ PurchaseInvoiceAccountDetails ] | Purchase invoice Account item details | No |
| purchaseInvoiceAssets | [ PurchaseInvoiceAssetGroupDetails ] | No | |
| purchaseInvoiceDate | string | Purchase Invoice date Example: "25-10-2019" | Yes |
| purchaseInvoiceDueDate | string | Purchase Invoice due date Example: "25-10-2019" | Yes |
| purchaseInvoiceProducts | [ PurchaseInvoiceProductDetailsMalaysia ] | Purchase invoice Product item details | No |
| purchaseInvoiceRecurring | PurchaseInvoiceRecurringDetails | Purchase invoice item details | No |
| purchaseInvoiceType | string | Purchase invoice type. Enum: "INVENTORY", "EXPENSE", "ASSET"Example: "INVENTORY" | Yes |
| purchaseOrderRefNo | string | Contact PO reference number Example: "CPO001" | No |
| receiptDate | dateTime | Receipt date Example: "25-10-2019" | No |
| receiveByDate | dateTime | Receive by date Example: "25-10-2019" | No |
| receiveGoodsStatus | string | receipt goods status Enum: "UNRECEIVED", "PARTIAL_RECEIVED", "FULLY_RECEIVED", "NOT_APPLICABLE"Example: "FULLY_RECEIVED" | No |
| receivedComplete | boolean | True if auto received is required. Example: false | No |
| recurring | boolean | True if Invoice is recurring. Example: true | No |
| recurringActivated | boolean | True if Invoice recurrence is active. Example: false | 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 |
| sequenceFormat | string | Sequence Format Id Example: 1 | 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 | 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 Example: 12.32 | No |
| unitPriceGstInclusive | boolean | Unit price is GST inclusive Example: false | No |
| warehouseCode | string | Warehouse Code Example: "WH-000001" | No |
PurchaseInvoiceRequestPhilippines
| Name | Type | Description | Required |
|---|---|---|---|
| additionalCharges | AdditionalCharges | Purchase invoice additional charges details | No |
| approvalStatus | string | Approval status Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"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 |
| contact | ContactInfo | Contact details | Yes |
| contactCode | string | Contact Code Example: "C0001" | Yes |
| currency | string | Currency Example: "C001" | Yes |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| documentSequenceCode | string | Bill Code Example: "0000001" | No |
| draft | boolean | True if want to save as draft. Example: false | No |
| draftReferenceId | string | Draft reference id | No |
| dropShip | boolean | Drop Ship flag to indicate if purchase invoice is created for drop ship Example: true | No |
| dueAmount | number | Amount Due Example: 12.322 | 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 |
| journalEntryCode | string | Journal Entry Code Example: "JE0001" | No |
| landedCost | boolean | To mark landed cost bill Example: true | No |
| linkedDocuments | [ DocumentInfo ] | Linked Documents | No |
| memo | string | Memo Example: "Memo details" | No |
| openingDocumentNumber | string | Customer opening document number Example: "DC-0001" | No |
| openingInvoice | boolean | True if opening invoice Example: false | No |
| payableAccountCode | string | Code of Account Example: "AC-000001" | 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 |
| purchaseInvoiceAccounts | [ PurchaseInvoiceAccountDetails ] | Purchase invoice Account item details | No |
| purchaseInvoiceAssets | [ PurchaseInvoiceAssetGroupDetails ] | No | |
| purchaseInvoiceDate | string | Purchase Invoice date Example: "25-10-2019" | Yes |
| purchaseInvoiceDueDate | string | Purchase Invoice due date Example: "25-10-2019" | Yes |
| purchaseInvoiceProducts | [ PurchaseInvoiceProductDetailsPhilippines ] | Purchase invoice Product item details | No |
| purchaseInvoiceRecurring | PurchaseInvoiceRecurringDetails | Purchase invoice item details | No |
| purchaseInvoiceType | string | Purchase invoice type. Enum: "INVENTORY", "EXPENSE", "ASSET"Example: "INVENTORY" | Yes |
| purchaseOrderRefNo | string | Contact PO reference number Example: "CPO001" | No |
| receiptDate | dateTime | Receipt date Example: "25-10-2019" | No |
| receiveByDate | dateTime | Receive by date Example: "25-10-2019" | No |
| receiveGoodsStatus | string | receipt goods status Enum: "UNRECEIVED", "PARTIAL_RECEIVED", "FULLY_RECEIVED", "NOT_APPLICABLE"Example: "FULLY_RECEIVED" | No |
| receivedComplete | boolean | True if auto received is required. Example: false | No |
| recurring | boolean | True if Invoice is recurring. Example: true | No |
| recurringActivated | boolean | True if Invoice recurrence is active. Example: false | 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 |
| sequenceFormat | string | Sequence Format Id Example: 1 | 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 | 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 Example: 12.32 | No |
| unitPriceGstInclusive | boolean | Unit price is GST inclusive Example: false | No |
| warehouseCode | string | Warehouse Code Example: "WH-000001" | No |
PurchaseInvoiceRequestSA
| Name | Type | Description | Required |
|---|---|---|---|
| additionalCharges | AdditionalCharges | Purchase invoice additional charges details | No |
| approvalStatus | string | Approval status Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"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 |
| contact | ContactInfo | Contact details | Yes |
| contactCode | string | Contact Code Example: "C0001" | Yes |
| currency | string | Currency Example: "C001" | Yes |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| documentSequenceCode | string | Bill Code Example: "0000001" | No |
| draft | boolean | True if want to save as draft. Example: false | No |
| draftReferenceId | string | Draft reference id | No |
| dropShip | boolean | Drop Ship flag to indicate if purchase invoice is created for drop ship Example: true | No |
| dueAmount | number | Amount Due Example: 12.322 | 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 |
| journalEntryCode | string | Journal Entry Code Example: "JE0001" | No |
| landedCost | boolean | To mark landed cost bill Example: true | No |
| linkedDocuments | [ DocumentInfo ] | Linked Documents | No |
| memo | string | Memo Example: "Memo details" | No |
| openingDocumentNumber | string | Customer opening document number Example: "DC-0001" | No |
| openingInvoice | boolean | True if opening invoice Example: false | No |
| payableAccountCode | string | Code of Account Example: "AC-000001" | 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 |
| purchaseInvoiceAccounts | [ PurchaseInvoiceAccountDetails ] | Purchase invoice Account item details | No |
| purchaseInvoiceAssets | [ PurchaseInvoiceAssetGroupDetails ] | 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 Product item details | No |
| purchaseInvoiceRecurring | PurchaseInvoiceRecurringDetails | Purchase invoice item details | No |
| purchaseInvoiceType | string | Purchase invoice type. Enum: "INVENTORY", "EXPENSE", "ASSET"Example: "INVENTORY" | Yes |
| purchaseOrderRefNo | string | Contact PO reference number Example: "CPO001" | No |
| rcmApplicableSA | boolean | Reverse Charge Applicable Example: true | No |
| receiptDate | dateTime | Receipt date Example: "25-10-2019" | No |
| receiveByDate | dateTime | Receive by date Example: "25-10-2019" | No |
| receiveGoodsStatus | string | receipt goods status Enum: "UNRECEIVED", "PARTIAL_RECEIVED", "FULLY_RECEIVED", "NOT_APPLICABLE"Example: "FULLY_RECEIVED" | No |
| receivedComplete | boolean | True if auto received is required. Example: false | No |
| recurring | boolean | True if Invoice is recurring. Example: true | No |
| recurringActivated | boolean | True if Invoice recurrence is active. Example: false | 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 |
| sequenceFormat | string | Sequence Format Id Example: 1 | 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 | 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 Example: 12.32 | No |
| unitPriceGstInclusive | boolean | Unit price is GST inclusive Example: false | No |
| vatPaidAtCustomSA | boolean | VAT Applicable Example: true | No |
| warehouseCode | string | Warehouse Code Example: "WH-000001" | No |
PurchaseInvoiceRequestUae
| Name | Type | Description | Required |
|---|---|---|---|
| additionalCharges | AdditionalCharges | Purchase invoice additional charges details | No |
| approvalStatus | string | Approval status Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"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 |
| contact | ContactInfo | Contact details | Yes |
| contactCode | string | Contact Code Example: "C0001" | Yes |
| currency | string | Currency Example: "C001" | Yes |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| documentSequenceCode | string | Bill Code Example: "0000001" | No |
| draft | boolean | True if want to save as draft. Example: false | No |
| draftReferenceId | string | Draft reference id | No |
| dropShip | boolean | Drop Ship flag to indicate if purchase invoice is created for drop ship Example: true | No |
| dueAmount | number | Amount Due Example: 12.322 | 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 |
| journalEntryCode | string | Journal Entry Code Example: "JE0001" | No |
| landedCost | boolean | To mark landed cost bill Example: true | No |
| linkedDocuments | [ DocumentInfo ] | Linked Documents | No |
| memo | string | Memo Example: "Memo details" | No |
| openingDocumentNumber | string | Customer opening document number Example: "DC-0001" | No |
| openingInvoice | boolean | True if opening invoice Example: false | No |
| payableAccountCode | string | Code of Account Example: "AC-000001" | 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 |
| purchaseInvoiceAccounts | [ PurchaseInvoiceAccountDetails ] | Purchase invoice Account item details | No |
| purchaseInvoiceAssets | [ PurchaseInvoiceAssetGroupDetails ] | 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 Product item details | No |
| purchaseInvoiceRecurring | PurchaseInvoiceRecurringDetails | Purchase invoice item details | No |
| purchaseInvoiceType | string | Purchase invoice type. Enum: "INVENTORY", "EXPENSE", "ASSET"Example: "INVENTORY" | Yes |
| purchaseOrderRefNo | string | Contact PO reference number Example: "CPO001" | No |
| rcmApplicable | boolean | Reverse Charge Applicable Example: true | No |
| receiptDate | dateTime | Receipt date Example: "25-10-2019" | No |
| receiveByDate | dateTime | Receive by date Example: "25-10-2019" | No |
| receiveGoodsStatus | string | receipt goods status Enum: "UNRECEIVED", "PARTIAL_RECEIVED", "FULLY_RECEIVED", "NOT_APPLICABLE"Example: "FULLY_RECEIVED" | No |
| receivedComplete | boolean | True if auto received is required. Example: false | No |
| recurring | boolean | True if Invoice is recurring. Example: true | No |
| recurringActivated | boolean | True if Invoice recurrence is active. Example: false | 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 |
| sequenceFormat | string | Sequence Format Id Example: 1 | 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 | 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 Example: 12.32 | No |
| unitPriceGstInclusive | boolean | Unit price is GST inclusive Example: false | No |
| warehouseCode | string | Warehouse Code Example: "WH-000001" | No |
PurchaseInvoiceRequestUk
| Name | Type | Description | Required |
|---|---|---|---|
| additionalCharges | AdditionalCharges | Purchase invoice additional charges details | No |
| approvalStatus | string | Approval status Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"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 |
| contact | ContactInfo | Contact details | Yes |
| contactCode | string | Contact Code Example: "C0001" | Yes |
| currency | string | Currency Example: "C001" | Yes |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| documentSequenceCode | string | Bill Code Example: "0000001" | No |
| draft | boolean | True if want to save as draft. Example: false | No |
| draftReferenceId | string | Draft reference id | No |
| dropShip | boolean | Drop Ship flag to indicate if purchase invoice is created for drop ship Example: true | No |
| dueAmount | number | Amount Due Example: 12.322 | 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 |
| journalEntryCode | string | Journal Entry Code Example: "JE0001" | No |
| landedCost | boolean | To mark landed cost bill Example: true | No |
| linkedDocuments | [ DocumentInfo ] | Linked Documents | No |
| memo | string | Memo Example: "Memo details" | No |
| openingDocumentNumber | string | Customer opening document number Example: "DC-0001" | No |
| openingInvoice | boolean | True if opening invoice Example: false | No |
| payableAccountCode | string | Code of Account Example: "AC-000001" | 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 |
| purchaseInvoiceAccounts | [ PurchaseInvoiceAccountDetails ] | Purchase invoice Account item details | No |
| purchaseInvoiceAssets | [ PurchaseInvoiceAssetGroupDetails ] | No | |
| purchaseInvoiceDate | string | Purchase Invoice date Example: "25-10-2019" | Yes |
| purchaseInvoiceDueDate | string | Purchase Invoice due date Example: "25-10-2019" | Yes |
| purchaseInvoiceProducts | [ PurchaseInvoiceProductDetailsUk ] | Purchase invoice Product item details | No |
| purchaseInvoiceRecurring | PurchaseInvoiceRecurringDetails | Purchase invoice item details | No |
| purchaseInvoiceType | string | Purchase invoice type. Enum: "INVENTORY", "EXPENSE", "ASSET"Example: "INVENTORY" | Yes |
| purchaseOrderRefNo | string | Contact PO reference number Example: "CPO001" | No |
| receiptDate | dateTime | Receipt date Example: "25-10-2019" | No |
| receiveByDate | dateTime | Receive by date Example: "25-10-2019" | No |
| receiveGoodsStatus | string | receipt goods status Enum: "UNRECEIVED", "PARTIAL_RECEIVED", "FULLY_RECEIVED", "NOT_APPLICABLE"Example: "FULLY_RECEIVED" | No |
| receivedComplete | boolean | True if auto received is required. Example: false | No |
| recurring | boolean | True if Invoice is recurring. Example: true | No |
| recurringActivated | boolean | True if Invoice recurrence is active. Example: false | 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 |
| sequenceFormat | string | Sequence Format Id Example: 1 | 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 | 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 Example: 12.32 | No |
| unitPriceGstInclusive | boolean | Unit price is GST inclusive Example: false | No |
| warehouseCode | string | Warehouse Code Example: "WH-000001" | No |
PurchaseInvoiceResponse
| Name | Type | Description | Required |
|---|---|---|---|
| additionalCharges | AdditionalCharges | Purchase invoice additional charges details | No |
| approvalStatus | string | Approval status Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"Example: "APPROVED" | No |
| attachmentIds | [ integer ] | No | |
| attachments | [ string ] | File attachments | No |
| attachmentsWithLink | [ AttachmentsResponse ] | Attachments Details | No |
| backOrder | boolean | Backorder flag to indicate if purchase invoice is backorder Example: true | No |
| billTo | Address | Bill to Address | No |
| contact | ContactInfo | Contact details | Yes |
| contactCode | string | Contact Code Example: "C0001" | Yes |
| contactDto | ContactDto | Contact Details | Yes |
| currency | string | Currency Example: "C001" | Yes |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| documentSequenceCode | string | Purchase invoice Sequence Code Example: "0000001" | No |
| draft | boolean | Purchase invoice drafted Example: false | No |
| draftReferenceId | string | Draft reference id | No |
| dropShip | boolean | Drop Ship flag to indicate if purchase invoice is created for drop ship Example: true | No |
| dueAmount | number | Amount Due Example: 12.322 | 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 |
| id | long | Purchase invoice id Example: 1 | No |
| isPartialInvoice | boolean | Whether the Purchase Invoice is a partial invoice Example: false | No |
| journalEntryCode | string | Journal Entry Code Example: "JE0001" | No |
| knockoffInfo | [ KnockOffInfo ] | KnockOff Info | No |
| landedCost | boolean | To mark landed cost bill Example: true | No |
| linkedDocuments | [ DocumentInfo ] | Linked Documents | No |
| memo | string | Memo Example: "Memo details" | No |
| openingDocumentNumber | string | Customer opening document number Example: "DC-0001" | No |
| openingInvoice | boolean | True if opening invoice Example: false | No |
| payableAccountCode | string | Code of Account Example: "AC-000001" | No |
| paymentMilestoneFlag | boolean | Payment milestone flag to indicate if payment milestones are set Example: true | No |
| paymentStatus | string | Purchase invoice payment status Enum: "PENDING", "PARTIAL", "RECEIVED"Example: "PENDING" | No |
| purchaseInvoiceAccounts | [ PurchaseInvoiceAccountDetails ] | Purchase invoice Account item details | No |
| purchaseInvoiceAssets | [ PurchaseInvoiceAssetGroupDetails ] | No | |
| purchaseInvoiceCode | string | Purchase invoice code Example: "SI001" | 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 Product item details | No |
| purchaseInvoiceRecurring | PurchaseInvoiceRecurringDetails | Purchase invoice item details | No |
| purchaseInvoiceType | string | Purchase invoice type. Enum: "INVENTORY", "EXPENSE", "ASSET"Example: "INVENTORY" | Yes |
| purchaseOrderRefNo | string | Contact PO reference number Example: "CPO001" | No |
| receiveByDate | dateTime | Receive by date Example: "25-10-2019" | No |
| receiveGoodsStatus | string | Purchase invoice receipt status Enum: "UNRECEIVED", "PARTIAL_RECEIVED", "FULLY_RECEIVED", "NOT_APPLICABLE"Example: "UNRECEIVED" | No |
| recurring | boolean | True if Invoice is recurring. Example: true | No |
| recurringActivated | boolean | True if Invoice recurrence is active. Example: false | 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 |
| sequenceFormat | string | Sequence Format Id Example: 1 | 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 | 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 Example: 12.32 | No |
| unitPriceGstInclusive | boolean | Unit price is GST inclusive Example: false | No |
| warehouseCode | string | Warehouse Code Example: "WH-000001" | No |
PurchaseInvoiceResponseAustralia
| Name | Type | Description | Required |
|---|---|---|---|
| additionalCharges | AdditionalCharges | Purchase invoice additional charges details | No |
| approvalStatus | string | Approval status Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"Example: "APPROVED" | No |
| attachmentIds | [ integer ] | No | |
| attachments | [ string ] | File attachments | No |
| attachmentsWithLink | [ AttachmentsResponse ] | Attachments Details | No |
| backOrder | boolean | Backorder flag to indicate if purchase invoice is backorder Example: true | No |
| billTo | Address | Bill to Address | No |
| contact | ContactInfo | Contact details | Yes |
| contactCode | string | Contact Code Example: "C0001" | Yes |
| contactDto | ContactDto | Contact Details | Yes |
| currency | string | Currency Example: "C001" | Yes |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| documentSequenceCode | string | Purchase invoice Sequence Code Example: "0000001" | No |
| draft | boolean | Purchase invoice drafted Example: false | No |
| draftReferenceId | string | Draft reference id | No |
| dropShip | boolean | Drop Ship flag to indicate if purchase invoice is created for drop ship Example: true | No |
| dueAmount | number | Amount Due Example: 12.322 | 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 |
| id | long | Purchase invoice id Example: 1 | No |
| isPartialInvoice | boolean | Whether the Purchase Invoice is a partial invoice Example: false | No |
| journalEntryCode | string | Journal Entry Code Example: "JE0001" | No |
| knockoffInfo | [ KnockOffInfo ] | KnockOff Info | No |
| landedCost | boolean | To mark landed cost bill Example: true | No |
| linkedDocuments | [ DocumentInfo ] | Linked Documents | No |
| memo | string | Memo Example: "Memo details" | No |
| openingDocumentNumber | string | Customer opening document number Example: "DC-0001" | No |
| openingInvoice | boolean | True if opening invoice Example: false | No |
| payableAccountCode | string | Code of Account Example: "AC-000001" | No |
| paymentMilestoneFlag | boolean | Payment milestone flag to indicate if payment milestones are set Example: true | No |
| paymentStatus | string | Purchase invoice payment status Enum: "PENDING", "PARTIAL", "RECEIVED"Example: "PENDING" | No |
| purchaseInvoiceAccounts | [ PurchaseInvoiceAccountDetails ] | Purchase invoice Account item details | No |
| purchaseInvoiceAssets | [ PurchaseInvoiceAssetGroupDetails ] | No | |
| purchaseInvoiceCode | string | Purchase invoice code Example: "SI001" | No |
| purchaseInvoiceDate | string | Purchase Invoice date Example: "25-10-2019" | Yes |
| purchaseInvoiceDueDate | string | Purchase Invoice due date Example: "25-10-2019" | Yes |
| purchaseInvoiceProducts | [ PurchaseInvoiceProductDetailsAustralia ] | Purchase invoice Product item details | No |
| purchaseInvoiceRecurring | PurchaseInvoiceRecurringDetails | Purchase invoice item details | No |
| purchaseInvoiceType | string | Purchase invoice type. Enum: "INVENTORY", "EXPENSE", "ASSET"Example: "INVENTORY" | Yes |
| purchaseOrderRefNo | string | Contact PO reference number Example: "CPO001" | No |
| receiveByDate | dateTime | Receive by date Example: "25-10-2019" | No |
| receiveGoodsStatus | string | Purchase invoice receipt status Enum: "UNRECEIVED", "PARTIAL_RECEIVED", "FULLY_RECEIVED", "NOT_APPLICABLE"Example: "UNRECEIVED" | No |
| recurring | boolean | True if Invoice is recurring. Example: true | No |
| recurringActivated | boolean | True if Invoice recurrence is active. Example: false | 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 |
| sequenceFormat | string | Sequence Format Id Example: 1 | 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 | 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 Example: 12.32 | No |
| unitPriceGstInclusive | boolean | Unit price is GST inclusive Example: false | No |
| warehouseCode | string | Warehouse Code Example: "WH-000001" | No |
PurchaseInvoiceResponseCanada
| Name | Type | Description | Required |
|---|---|---|---|
| additionalCharges | AdditionalCharges | Purchase invoice additional charges details | No |
| approvalStatus | string | Approval status Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"Example: "APPROVED" | No |
| attachmentIds | [ integer ] | No | |
| attachments | [ string ] | File attachments | No |
| attachmentsWithLink | [ AttachmentsResponse ] | Attachments Details | No |
| backOrder | boolean | Backorder flag to indicate if purchase invoice is backorder Example: true | No |
| billTo | Address | Bill to Address | No |
| contact | ContactInfo | Contact details | Yes |
| contactCode | string | Contact Code Example: "C0001" | Yes |
| contactDto | ContactDto | Contact Details | Yes |
| currency | string | Currency Example: "C001" | Yes |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| documentSequenceCode | string | Purchase invoice Sequence Code Example: "0000001" | No |
| draft | boolean | Purchase invoice drafted Example: false | No |
| draftReferenceId | string | Draft reference id | No |
| dropShip | boolean | Drop Ship flag to indicate if purchase invoice is created for drop ship Example: true | No |
| dueAmount | number | Amount Due Example: 12.322 | 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 |
| id | long | Purchase invoice id Example: 1 | No |
| isPartialInvoice | boolean | Whether the Purchase Invoice is a partial invoice Example: false | No |
| journalEntryCode | string | Journal Entry Code Example: "JE0001" | No |
| knockoffInfo | [ KnockOffInfo ] | KnockOff Info | No |
| landedCost | boolean | To mark landed cost bill Example: true | No |
| linkedDocuments | [ DocumentInfo ] | Linked Documents | No |
| memo | string | Memo Example: "Memo details" | No |
| openingDocumentNumber | string | Customer opening document number Example: "DC-0001" | No |
| openingInvoice | boolean | True if opening invoice Example: false | No |
| payableAccountCode | string | Code of Account Example: "AC-000001" | No |
| paymentMilestoneFlag | boolean | Payment milestone flag to indicate if payment milestones are set Example: true | No |
| paymentStatus | string | Purchase invoice payment status Enum: "PENDING", "PARTIAL", "RECEIVED"Example: "PENDING" | No |
| purchaseInvoiceAccounts | [ PurchaseInvoiceAccountDetails ] | Purchase invoice Account item details | No |
| purchaseInvoiceAssets | [ PurchaseInvoiceAssetGroupDetails ] | No | |
| purchaseInvoiceCode | string | Purchase invoice code Example: "SI001" | No |
| purchaseInvoiceDate | string | Purchase Invoice date Example: "25-10-2019" | Yes |
| purchaseInvoiceDueDate | string | Purchase Invoice due date Example: "25-10-2019" | Yes |
| purchaseInvoiceProducts | [ PurchaseInvoiceProductDetailsCanada ] | Purchase invoice Product item details | No |
| purchaseInvoiceRecurring | PurchaseInvoiceRecurringDetails | Purchase invoice item details | No |
| purchaseInvoiceType | string | Purchase invoice type. Enum: "INVENTORY", "EXPENSE", "ASSET"Example: "INVENTORY" | Yes |
| purchaseOrderRefNo | string | Contact PO reference number Example: "CPO001" | No |
| receiveByDate | dateTime | Receive by date Example: "25-10-2019" | No |
| receiveGoodsStatus | string | Purchase invoice receipt status Enum: "UNRECEIVED", "PARTIAL_RECEIVED", "FULLY_RECEIVED", "NOT_APPLICABLE"Example: "UNRECEIVED" | No |
| recurring | boolean | True if Invoice is recurring. Example: true | No |
| recurringActivated | boolean | True if Invoice recurrence is active. Example: false | 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 |
| sequenceFormat | string | Sequence Format Id Example: 1 | 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 | 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 Example: 12.32 | No |
| unitPriceGstInclusive | boolean | Unit price is GST inclusive Example: false | No |
| warehouseCode | string | Warehouse Code Example: "WH-000001" | No |
PurchaseInvoiceResponseGermany
| Name | Type | Description | Required |
|---|---|---|---|
| additionalCharges | AdditionalCharges | Purchase invoice additional charges details | No |
| approvalStatus | string | Approval status Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"Example: "APPROVED" | No |
| attachmentIds | [ integer ] | No | |
| attachments | [ string ] | File attachments | No |
| attachmentsWithLink | [ AttachmentsResponse ] | Attachments Details | No |
| backOrder | boolean | Backorder flag to indicate if purchase invoice is backorder Example: true | No |
| billTo | Address | Bill to Address | No |
| contact | ContactInfo | Contact details | Yes |
| contactCode | string | Contact Code Example: "C0001" | Yes |
| contactDto | ContactDto | Contact Details | Yes |
| currency | string | Currency Example: "C001" | Yes |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| documentSequenceCode | string | Purchase invoice Sequence Code Example: "0000001" | No |
| draft | boolean | Purchase invoice drafted Example: false | No |
| draftReferenceId | string | Draft reference id | No |
| dropShip | boolean | Drop Ship flag to indicate if purchase invoice is created for drop ship Example: true | No |
| dueAmount | number | Amount Due Example: 12.322 | 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 |
| id | long | Purchase invoice id Example: 1 | No |
| isPartialInvoice | boolean | Whether the Purchase Invoice is a partial invoice Example: false | No |
| journalEntryCode | string | Journal Entry Code Example: "JE0001" | No |
| knockoffInfo | [ KnockOffInfo ] | KnockOff Info | No |
| landedCost | boolean | To mark landed cost bill Example: true | No |
| linkedDocuments | [ DocumentInfo ] | Linked Documents | No |
| memo | string | Memo Example: "Memo details" | No |
| openingDocumentNumber | string | Customer opening document number Example: "DC-0001" | No |
| openingInvoice | boolean | True if opening invoice Example: false | No |
| payableAccountCode | string | Code of Account Example: "AC-000001" | No |
| paymentMilestoneFlag | boolean | Payment milestone flag to indicate if payment milestones are set Example: true | No |
| paymentStatus | string | Purchase invoice payment status Enum: "PENDING", "PARTIAL", "RECEIVED"Example: "PENDING" | No |
| purchaseInvoiceAccounts | [ PurchaseInvoiceAccountDetails ] | Purchase invoice Account item details | No |
| purchaseInvoiceAssets | [ PurchaseInvoiceAssetGroupDetails ] | No | |
| purchaseInvoiceCode | string | Purchase invoice code Example: "SI001" | No |
| purchaseInvoiceDate | string | Purchase Invoice date Example: "25-10-2019" | Yes |
| purchaseInvoiceDueDate | string | Purchase Invoice due date Example: "25-10-2019" | Yes |
| purchaseInvoiceProducts | [ PurchaseInvoiceProductDetailsGermany ] | Purchase invoice Product item details | No |
| purchaseInvoiceRecurring | PurchaseInvoiceRecurringDetails | Purchase invoice item details | No |
| purchaseInvoiceType | string | Purchase invoice type. Enum: "INVENTORY", "EXPENSE", "ASSET"Example: "INVENTORY" | Yes |
| purchaseOrderRefNo | string | Contact PO reference number Example: "CPO001" | No |
| receiveByDate | dateTime | Receive by date Example: "25-10-2019" | No |
| receiveGoodsStatus | string | Purchase invoice receipt status Enum: "UNRECEIVED", "PARTIAL_RECEIVED", "FULLY_RECEIVED", "NOT_APPLICABLE"Example: "UNRECEIVED" | No |
| recurring | boolean | True if Invoice is recurring. Example: true | No |
| recurringActivated | boolean | True if Invoice recurrence is active. Example: false | 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 |
| sequenceFormat | string | Sequence Format Id Example: 1 | 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 | 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 Example: 12.32 | No |
| unitPriceGstInclusive | boolean | Unit price is GST inclusive Example: false | No |
| warehouseCode | string | Warehouse Code Example: "WH-000001" | No |
PurchaseInvoiceResponseIndia
| Name | Type | Description | Required |
|---|---|---|---|
| additionalCharges | AdditionalCharges | Purchase invoice additional charges details | No |
| approvalStatus | string | Approval status Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"Example: "APPROVED" | No |
| attachmentIds | [ integer ] | No | |
| attachments | [ string ] | File attachments | No |
| attachmentsWithLink | [ AttachmentsResponse ] | Attachments Details | No |
| backOrder | boolean | Backorder flag to indicate if purchase invoice is backorder Example: true | No |
| billTo | Address | Bill to Address | No |
| contact | ContactInfo | Contact details | Yes |
| contactCode | string | Contact Code Example: "C0001" | Yes |
| contactDto | ContactDto | Contact Details | Yes |
| currency | string | Currency Example: "C001" | Yes |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| customerType | string | Customer Type Enum: "EXPORT_WO_PAY", "EXPORT_W_PAY", "NA", "SEZ_WO_PAY", "SEZ_W_PAY"Example: "NA" | Yes |
| documentSequenceCode | string | Purchase invoice Sequence Code Example: "0000001" | No |
| draft | boolean | Purchase invoice drafted Example: false | No |
| draftReferenceId | string | Draft reference id | No |
| dropShip | boolean | Drop Ship flag to indicate if purchase invoice is created for drop ship Example: true | No |
| dueAmount | number | Amount Due Example: 12.322 | 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 |
| gstTreatment | string | GST Treatment Example: "REGISTERED_BUSINESS_REGULAR" | No |
| gstin | string | GSTIN Example: "ABSASASSASASA198" | Yes |
| id | long | Purchase invoice id Example: 1 | No |
| isPartialInvoice | boolean | Whether the Purchase Invoice is a partial invoice Example: false | No |
| journalEntryCode | string | Journal Entry Code Example: "JE0001" | No |
| knockoffInfo | [ KnockOffInfo ] | KnockOff Info | No |
| landedCost | boolean | To mark landed cost bill Example: true | No |
| linkedDocuments | [ DocumentInfo ] | Linked Documents | No |
| memo | string | Memo Example: "Memo details" | No |
| openingDocumentNumber | string | Customer opening document number Example: "DC-0001" | No |
| openingInvoice | boolean | True if opening invoice Example: false | No |
| payableAccountCode | string | Code of Account Example: "AC-000001" | No |
| paymentMilestoneFlag | boolean | Payment milestone flag to indicate if payment milestones are set Example: true | No |
| paymentStatus | string | Purchase invoice payment status Enum: "PENDING", "PARTIAL", "RECEIVED"Example: "PENDING" | No |
| placeOfSupply | string | state in India Example: "Punjab" | Yes |
| purchaseInvoiceAccounts | [ PurchaseInvoiceAccountDetails ] | Purchase invoice Account item details | No |
| purchaseInvoiceAssets | [ PurchaseInvoiceAssetGroupDetails ] | No | |
| purchaseInvoiceCode | string | Purchase invoice code Example: "SI001" | No |
| purchaseInvoiceDate | string | Purchase Invoice date Example: "25-10-2019" | Yes |
| purchaseInvoiceDueDate | string | Purchase Invoice due date Example: "25-10-2019" | Yes |
| purchaseInvoiceProducts | [ PurchaseInvoiceProductDetailsIndia ] | Purchase invoice Product item details | No |
| purchaseInvoiceRecurring | PurchaseInvoiceRecurringDetails | Purchase invoice item details | No |
| purchaseInvoiceType | string | Purchase invoice type. Enum: "INVENTORY", "EXPENSE", "ASSET"Example: "INVENTORY" | Yes |
| purchaseOrderRefNo | string | Contact PO reference number Example: "CPO001" | No |
| receiveByDate | dateTime | Receive by date Example: "25-10-2019" | No |
| receiveGoodsStatus | string | Purchase invoice receipt status Enum: "UNRECEIVED", "PARTIAL_RECEIVED", "FULLY_RECEIVED", "NOT_APPLICABLE"Example: "UNRECEIVED" | No |
| recurring | boolean | True if Invoice is recurring. Example: true | No |
| recurringActivated | boolean | True if Invoice recurrence is active. Example: false | 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 |
| sequenceFormat | string | Sequence Format Id Example: 1 | 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 | 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 |
| tdsProcessedFlag | boolean | TDS Processed Flag Example: false | 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 Example: 12.32 | No |
| unitPriceGstInclusive | boolean | Unit price is GST inclusive Example: false | No |
| vendorType | string | Vendor Type Enum: "IMPORT", "NA", "SEZ_W_PAY", "SEZ_WO_PAY"Example: "NA" | Yes |
| warehouseCode | string | Warehouse Code Example: "WH-000001" | No |
PurchaseInvoiceResponseIndonesia
| Name | Type | Description | Required |
|---|---|---|---|
| additionalCharges | AdditionalCharges | Purchase invoice additional charges details | No |
| approvalStatus | string | Approval status Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"Example: "APPROVED" | No |
| attachmentIds | [ integer ] | No | |
| attachments | [ string ] | File attachments | No |
| attachmentsWithLink | [ AttachmentsResponse ] | Attachments Details | No |
| backOrder | boolean | Backorder flag to indicate if purchase invoice is backorder Example: true | No |
| billTo | Address | Bill to Address | No |
| contact | ContactInfo | Contact details | Yes |
| contactCode | string | Contact Code Example: "C0001" | Yes |
| contactDto | ContactDto | Contact Details | Yes |
| currency | string | Currency Example: "C001" | Yes |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| documentSequenceCode | string | Purchase invoice Sequence Code Example: "0000001" | No |
| draft | boolean | Purchase invoice drafted Example: false | No |
| draftReferenceId | string | Draft reference id | No |
| dropShip | boolean | Drop Ship flag to indicate if purchase invoice is created for drop ship Example: true | No |
| dueAmount | number | Amount Due Example: 12.322 | 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 |
| id | long | Purchase invoice id Example: 1 | No |
| isCreditable | boolean | Is Creditable Example: true | No |
| isPartialInvoice | boolean | Whether the Purchase Invoice is a partial invoice Example: false | No |
| journalEntryCode | string | Journal Entry Code Example: "JE0001" | No |
| knockoffInfo | [ KnockOffInfo ] | KnockOff Info | No |
| landedCost | boolean | To mark landed cost bill Example: true | No |
| linkedDocuments | [ DocumentInfo ] | Linked Documents | No |
| memo | string | Memo Example: "Memo details" | No |
| openingDocumentNumber | string | Customer opening document number Example: "DC-0001" | No |
| openingInvoice | boolean | True if opening invoice Example: false | No |
| payableAccountCode | string | Code of Account Example: "AC-000001" | No |
| paymentMilestoneFlag | boolean | Payment milestone flag to indicate if payment milestones are set Example: true | No |
| paymentStatus | string | Purchase invoice payment status Enum: "PENDING", "PARTIAL", "RECEIVED"Example: "PENDING" | No |
| purchaseInvoiceAccounts | [ PurchaseInvoiceAccountDetails ] | Purchase invoice Account item details | No |
| purchaseInvoiceAssets | [ PurchaseInvoiceAssetGroupDetails ] | No | |
| purchaseInvoiceCode | string | Purchase invoice code Example: "SI001" | No |
| purchaseInvoiceDate | string | Purchase Invoice date Example: "25-10-2019" | Yes |
| purchaseInvoiceDueDate | string | Purchase Invoice due date Example: "25-10-2019" | Yes |
| purchaseInvoiceProducts | [ PurchaseInvoiceProductDetailsIndonesia ] | Purchase invoice Product item details | No |
| purchaseInvoiceRecurring | PurchaseInvoiceRecurringDetails | Purchase invoice item details | No |
| purchaseInvoiceType | string | Purchase invoice type. Enum: "INVENTORY", "EXPENSE", "ASSET"Example: "INVENTORY" | Yes |
| purchaseOrderRefNo | string | Contact PO reference number Example: "CPO001" | No |
| receiveByDate | dateTime | Receive by date Example: "25-10-2019" | No |
| receiveGoodsStatus | string | Purchase invoice receipt status Enum: "UNRECEIVED", "PARTIAL_RECEIVED", "FULLY_RECEIVED", "NOT_APPLICABLE"Example: "UNRECEIVED" | No |
| recurring | boolean | True if Invoice is recurring. Example: true | No |
| recurringActivated | boolean | True if Invoice recurrence is active. Example: false | 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 |
| sequenceFormat | string | Sequence Format Id Example: 1 | 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 | No | |
| taxAmount | number | Tax amount Example: 2.322 | No |
| taxInvoiceNo | string | Tax Invoice No Example: 123456789 | 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 Example: 12.32 | No |
| unitPriceGstInclusive | boolean | Unit price is GST inclusive Example: false | No |
| warehouseCode | string | Warehouse Code Example: "WH-000001" | No |
PurchaseInvoiceResponseIsrael
| Name | Type | Description | Required |
|---|---|---|---|
| additionalCharges | AdditionalCharges | Purchase invoice additional charges details | No |
| approvalStatus | string | Approval status Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"Example: "APPROVED" | No |
| attachmentIds | [ integer ] | No | |
| attachments | [ string ] | File attachments | No |
| attachmentsWithLink | [ AttachmentsResponse ] | Attachments Details | No |
| backOrder | boolean | Backorder flag to indicate if purchase invoice is backorder Example: true | No |
| billTo | Address | Bill to Address | No |
| contact | ContactInfo | Contact details | Yes |
| contactCode | string | Contact Code Example: "C0001" | Yes |
| contactDto | ContactDto | Contact Details | Yes |
| currency | string | Currency Example: "C001" | Yes |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| documentSequenceCode | string | Purchase invoice Sequence Code Example: "0000001" | No |
| draft | boolean | Purchase invoice drafted Example: false | No |
| draftReferenceId | string | Draft reference id | No |
| dropShip | boolean | Drop Ship flag to indicate if purchase invoice is created for drop ship Example: true | No |
| dueAmount | number | Amount Due Example: 12.322 | 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 |
| id | long | Purchase invoice id Example: 1 | No |
| isPartialInvoice | boolean | Whether the Purchase Invoice is a partial invoice Example: false | No |
| journalEntryCode | string | Journal Entry Code Example: "JE0001" | No |
| knockoffInfo | [ KnockOffInfo ] | KnockOff Info | No |
| landedCost | boolean | To mark landed cost bill Example: true | No |
| linkedDocuments | [ DocumentInfo ] | Linked Documents | No |
| memo | string | Memo Example: "Memo details" | No |
| openingDocumentNumber | string | Customer opening document number Example: "DC-0001" | No |
| openingInvoice | boolean | True if opening invoice Example: false | No |
| payableAccountCode | string | Code of Account Example: "AC-000001" | No |
| paymentMilestoneFlag | boolean | Payment milestone flag to indicate if payment milestones are set Example: true | No |
| paymentStatus | string | Purchase invoice payment status Enum: "PENDING", "PARTIAL", "RECEIVED"Example: "PENDING" | No |
| purchaseInvoiceAccounts | [ PurchaseInvoiceAccountDetails ] | Purchase invoice Account item details | No |
| purchaseInvoiceAssets | [ PurchaseInvoiceAssetGroupDetails ] | No | |
| purchaseInvoiceCode | string | Purchase invoice code Example: "SI001" | No |
| purchaseInvoiceDate | string | Purchase Invoice date Example: "25-10-2019" | Yes |
| purchaseInvoiceDueDate | string | Purchase Invoice due date Example: "25-10-2019" | Yes |
| purchaseInvoiceProducts | [ PurchaseInvoiceProductDetailsIsrael ] | Purchase invoice Product item details | No |
| purchaseInvoiceRecurring | PurchaseInvoiceRecurringDetails | Purchase invoice item details | No |
| purchaseInvoiceType | string | Purchase invoice type. Enum: "INVENTORY", "EXPENSE", "ASSET"Example: "INVENTORY" | Yes |
| purchaseOrderRefNo | string | Contact PO reference number Example: "CPO001" | No |
| receiveByDate | dateTime | Receive by date Example: "25-10-2019" | No |
| receiveGoodsStatus | string | Purchase invoice receipt status Enum: "UNRECEIVED", "PARTIAL_RECEIVED", "FULLY_RECEIVED", "NOT_APPLICABLE"Example: "UNRECEIVED" | No |
| recurring | boolean | True if Invoice is recurring. Example: true | No |
| recurringActivated | boolean | True if Invoice recurrence is active. Example: false | 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 |
| sequenceFormat | string | Sequence Format Id Example: 1 | 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 | 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 Example: 12.32 | No |
| unitPriceGstInclusive | boolean | Unit price is GST inclusive Example: false | No |
| warehouseCode | string | Warehouse Code Example: "WH-000001" | No |
PurchaseInvoiceResponseMalaysia
| Name | Type | Description | Required |
|---|---|---|---|
| additionalCharges | AdditionalCharges | Purchase invoice additional charges details | No |
| approvalStatus | string | Approval status Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"Example: "APPROVED" | No |
| attachmentIds | [ integer ] | No | |
| attachments | [ string ] | File attachments | No |
| attachmentsWithLink | [ AttachmentsResponse ] | Attachments Details | No |
| backOrder | boolean | Backorder flag to indicate if purchase invoice is backorder Example: true | No |
| billTo | Address | Bill to Address | No |
| contact | ContactInfo | Contact details | Yes |
| contactCode | string | Contact Code Example: "C0001" | Yes |
| contactDto | ContactDto | Contact Details | Yes |
| currency | string | Currency Example: "C001" | Yes |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| documentSequenceCode | string | Purchase invoice Sequence Code Example: "0000001" | No |
| draft | boolean | Purchase invoice drafted Example: false | No |
| draftReferenceId | string | Draft reference id | No |
| dropShip | boolean | Drop Ship flag to indicate if purchase invoice is created for drop ship Example: true | No |
| dueAmount | number | Amount Due Example: 12.322 | 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 |
| id | long | Purchase invoice id Example: 1 | No |
| isPartialInvoice | boolean | Whether the Purchase Invoice is a partial invoice Example: false | No |
| journalEntryCode | string | Journal Entry Code Example: "JE0001" | No |
| knockoffInfo | [ KnockOffInfo ] | KnockOff Info | No |
| landedCost | boolean | To mark landed cost bill Example: true | No |
| linkedDocuments | [ DocumentInfo ] | Linked Documents | No |
| memo | string | Memo Example: "Memo details" | No |
| openingDocumentNumber | string | Customer opening document number Example: "DC-0001" | No |
| openingInvoice | boolean | True if opening invoice Example: false | No |
| payableAccountCode | string | Code of Account Example: "AC-000001" | No |
| paymentMilestoneFlag | boolean | Payment milestone flag to indicate if payment milestones are set Example: true | No |
| paymentStatus | string | Purchase invoice payment status Enum: "PENDING", "PARTIAL", "RECEIVED"Example: "PENDING" | No |
| purchaseInvoiceAccounts | [ PurchaseInvoiceAccountDetails ] | Purchase invoice Account item details | No |
| purchaseInvoiceAssets | [ PurchaseInvoiceAssetGroupDetails ] | No | |
| purchaseInvoiceCode | string | Purchase invoice code Example: "SI001" | No |
| purchaseInvoiceDate | string | Purchase Invoice date Example: "25-10-2019" | Yes |
| purchaseInvoiceDueDate | string | Purchase Invoice due date Example: "25-10-2019" | Yes |
| purchaseInvoiceProducts | [ PurchaseInvoiceProductDetailsMalaysia ] | Purchase invoice Product item details | No |
| purchaseInvoiceRecurring | PurchaseInvoiceRecurringDetails | Purchase invoice item details | No |
| purchaseInvoiceType | string | Purchase invoice type. Enum: "INVENTORY", "EXPENSE", "ASSET"Example: "INVENTORY" | Yes |
| purchaseOrderRefNo | string | Contact PO reference number Example: "CPO001" | No |
| receiveByDate | dateTime | Receive by date Example: "25-10-2019" | No |
| receiveGoodsStatus | string | Purchase invoice receipt status Enum: "UNRECEIVED", "PARTIAL_RECEIVED", "FULLY_RECEIVED", "NOT_APPLICABLE"Example: "UNRECEIVED" | No |
| recurring | boolean | True if Invoice is recurring. Example: true | No |
| recurringActivated | boolean | True if Invoice recurrence is active. Example: false | 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 |
| sequenceFormat | string | Sequence Format Id Example: 1 | 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 | 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 Example: 12.32 | No |
| unitPriceGstInclusive | boolean | Unit price is GST inclusive Example: false | No |
| warehouseCode | string | Warehouse Code Example: "WH-000001" | No |
PurchaseInvoiceResponsePhilippines
| Name | Type | Description | Required |
|---|---|---|---|
| additionalCharges | AdditionalCharges | Purchase invoice additional charges details | No |
| approvalStatus | string | Approval status Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"Example: "APPROVED" | No |
| attachmentIds | [ integer ] | No | |
| attachments | [ string ] | File attachments | No |
| attachmentsWithLink | [ AttachmentsResponse ] | Attachments Details | No |
| backOrder | boolean | Backorder flag to indicate if purchase invoice is backorder Example: true | No |
| billTo | Address | Bill to Address | No |
| contact | ContactInfo | Contact details | Yes |
| contactCode | string | Contact Code Example: "C0001" | Yes |
| contactDto | ContactDto | Contact Details | Yes |
| currency | string | Currency Example: "C001" | Yes |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| documentSequenceCode | string | Purchase invoice Sequence Code Example: "0000001" | No |
| draft | boolean | Purchase invoice drafted Example: false | No |
| draftReferenceId | string | Draft reference id | No |
| dropShip | boolean | Drop Ship flag to indicate if purchase invoice is created for drop ship Example: true | No |
| dueAmount | number | Amount Due Example: 12.322 | 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 |
| id | long | Purchase invoice id Example: 1 | No |
| isPartialInvoice | boolean | Whether the Purchase Invoice is a partial invoice Example: false | No |
| journalEntryCode | string | Journal Entry Code Example: "JE0001" | No |
| knockoffInfo | [ KnockOffInfo ] | KnockOff Info | No |
| landedCost | boolean | To mark landed cost bill Example: true | No |
| linkedDocuments | [ DocumentInfo ] | Linked Documents | No |
| memo | string | Memo Example: "Memo details" | No |
| openingDocumentNumber | string | Customer opening document number Example: "DC-0001" | No |
| openingInvoice | boolean | True if opening invoice Example: false | No |
| payableAccountCode | string | Code of Account Example: "AC-000001" | No |
| paymentMilestoneFlag | boolean | Payment milestone flag to indicate if payment milestones are set Example: true | No |
| paymentStatus | string | Purchase invoice payment status Enum: "PENDING", "PARTIAL", "RECEIVED"Example: "PENDING" | No |
| purchaseInvoiceAccounts | [ PurchaseInvoiceAccountDetails ] | Purchase invoice Account item details | No |
| purchaseInvoiceAssets | [ PurchaseInvoiceAssetGroupDetails ] | No | |
| purchaseInvoiceCode | string | Purchase invoice code Example: "SI001" | No |
| purchaseInvoiceDate | string | Purchase Invoice date Example: "25-10-2019" | Yes |
| purchaseInvoiceDueDate | string | Purchase Invoice due date Example: "25-10-2019" | Yes |
| purchaseInvoiceProducts | [ PurchaseInvoiceProductDetailsPhilippines ] | Purchase invoice Product item details | No |
| purchaseInvoiceRecurring | PurchaseInvoiceRecurringDetails | Purchase invoice item details | No |
| purchaseInvoiceType | string | Purchase invoice type. Enum: "INVENTORY", "EXPENSE", "ASSET"Example: "INVENTORY" | Yes |
| purchaseOrderRefNo | string | Contact PO reference number Example: "CPO001" | No |
| receiveByDate | dateTime | Receive by date Example: "25-10-2019" | No |
| receiveGoodsStatus | string | Purchase invoice receipt status Enum: "UNRECEIVED", "PARTIAL_RECEIVED", "FULLY_RECEIVED", "NOT_APPLICABLE"Example: "UNRECEIVED" | No |
| recurring | boolean | True if Invoice is recurring. Example: true | No |
| recurringActivated | boolean | True if Invoice recurrence is active. Example: false | 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 |
| sequenceFormat | string | Sequence Format Id Example: 1 | 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 | 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 Example: 12.32 | No |
| unitPriceGstInclusive | boolean | Unit price is GST inclusive Example: false | No |
| warehouseCode | string | Warehouse Code Example: "WH-000001" | No |
PurchaseInvoiceResponseSA
| Name | Type | Description | Required |
|---|---|---|---|
| additionalCharges | AdditionalCharges | Purchase invoice additional charges details | No |
| approvalStatus | string | Approval status Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"Example: "APPROVED" | No |
| attachmentIds | [ integer ] | No | |
| attachments | [ string ] | File attachments | No |
| attachmentsWithLink | [ AttachmentsResponse ] | Attachments Details | No |
| backOrder | boolean | Backorder flag to indicate if purchase invoice is backorder Example: true | No |
| billTo | Address | Bill to Address | No |
| contact | ContactInfo | Contact details | Yes |
| contactCode | string | Contact Code Example: "C0001" | Yes |
| contactDto | ContactDto | Contact Details | Yes |
| currency | string | Currency Example: "C001" | Yes |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| documentSequenceCode | string | Purchase invoice Sequence Code Example: "0000001" | No |
| draft | boolean | Purchase invoice drafted Example: false | No |
| draftReferenceId | string | Draft reference id | No |
| dropShip | boolean | Drop Ship flag to indicate if purchase invoice is created for drop ship Example: true | No |
| dueAmount | number | Amount Due Example: 12.322 | 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 |
| id | long | Purchase invoice id Example: 1 | No |
| isPartialInvoice | boolean | Whether the Purchase Invoice is a partial invoice Example: false | No |
| journalEntryCode | string | Journal Entry Code Example: "JE0001" | No |
| knockoffInfo | [ KnockOffInfo ] | KnockOff Info | No |
| landedCost | boolean | To mark landed cost bill Example: true | No |
| linkedDocuments | [ DocumentInfo ] | Linked Documents | No |
| memo | string | Memo Example: "Memo details" | No |
| openingDocumentNumber | string | Customer opening document number Example: "DC-0001" | No |
| openingInvoice | boolean | True if opening invoice Example: false | No |
| payableAccountCode | string | Code of Account Example: "AC-000001" | No |
| paymentMilestoneFlag | boolean | Payment milestone flag to indicate if payment milestones are set Example: true | No |
| paymentStatus | string | Purchase invoice payment status Enum: "PENDING", "PARTIAL", "RECEIVED"Example: "PENDING" | No |
| purchaseInvoiceAccounts | [ PurchaseInvoiceAccountDetails ] | Purchase invoice Account item details | No |
| purchaseInvoiceAssets | [ PurchaseInvoiceAssetGroupDetails ] | No | |
| purchaseInvoiceCode | string | Purchase invoice code Example: "SI001" | 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 Product item details | No |
| purchaseInvoiceRecurring | PurchaseInvoiceRecurringDetails | Purchase invoice item details | No |
| purchaseInvoiceType | string | Purchase invoice type. Enum: "INVENTORY", "EXPENSE", "ASSET"Example: "INVENTORY" | Yes |
| purchaseOrderRefNo | string | Contact PO reference number Example: "CPO001" | No |
| rcmApplicableSA | boolean | Reverse Charge Applicable Example: true | No |
| receiveByDate | dateTime | Receive by date Example: "25-10-2019" | No |
| receiveGoodsStatus | string | Purchase invoice receipt status Enum: "UNRECEIVED", "PARTIAL_RECEIVED", "FULLY_RECEIVED", "NOT_APPLICABLE"Example: "UNRECEIVED" | No |
| recurring | boolean | True if Invoice is recurring. Example: true | No |
| recurringActivated | boolean | True if Invoice recurrence is active. Example: false | 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 |
| sequenceFormat | string | Sequence Format Id Example: 1 | 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 | 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 Example: 12.32 | No |
| unitPriceGstInclusive | boolean | Unit price is GST inclusive Example: false | No |
| vatPaidAtCustomSA | boolean | VAT Applicable Example: true | No |
| warehouseCode | string | Warehouse Code Example: "WH-000001" | No |
PurchaseInvoiceResponseUae
| Name | Type | Description | Required |
|---|---|---|---|
| additionalCharges | AdditionalCharges | Purchase invoice additional charges details | No |
| approvalStatus | string | Approval status Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"Example: "APPROVED" | No |
| attachmentIds | [ integer ] | No | |
| attachments | [ string ] | File attachments | No |
| attachmentsWithLink | [ AttachmentsResponse ] | Attachments Details | No |
| backOrder | boolean | Backorder flag to indicate if purchase invoice is backorder Example: true | No |
| billTo | Address | Bill to Address | No |
| contact | ContactInfo | Contact details | Yes |
| contactCode | string | Contact Code Example: "C0001" | Yes |
| contactDto | ContactDto | Contact Details | Yes |
| currency | string | Currency Example: "C001" | Yes |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| documentSequenceCode | string | Purchase invoice Sequence Code Example: "0000001" | No |
| draft | boolean | Purchase invoice drafted Example: false | No |
| draftReferenceId | string | Draft reference id | No |
| dropShip | boolean | Drop Ship flag to indicate if purchase invoice is created for drop ship Example: true | No |
| dueAmount | number | Amount Due Example: 12.322 | 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 |
| id | long | Purchase invoice id Example: 1 | No |
| isPartialInvoice | boolean | Whether the Purchase Invoice is a partial invoice Example: false | No |
| journalEntryCode | string | Journal Entry Code Example: "JE0001" | No |
| knockoffInfo | [ KnockOffInfo ] | KnockOff Info | No |
| landedCost | boolean | To mark landed cost bill Example: true | No |
| linkedDocuments | [ DocumentInfo ] | Linked Documents | No |
| memo | string | Memo Example: "Memo details" | No |
| openingDocumentNumber | string | Customer opening document number Example: "DC-0001" | No |
| openingInvoice | boolean | True if opening invoice Example: false | No |
| payableAccountCode | string | Code of Account Example: "AC-000001" | No |
| paymentMilestoneFlag | boolean | Payment milestone flag to indicate if payment milestones are set Example: true | No |
| paymentStatus | string | Purchase invoice payment status Enum: "PENDING", "PARTIAL", "RECEIVED"Example: "PENDING" | No |
| purchaseInvoiceAccounts | [ PurchaseInvoiceAccountDetails ] | Purchase invoice Account item details | No |
| purchaseInvoiceAssets | [ PurchaseInvoiceAssetGroupDetails ] | No | |
| purchaseInvoiceCode | string | Purchase invoice code Example: "SI001" | 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 Product item details | No |
| purchaseInvoiceRecurring | PurchaseInvoiceRecurringDetails | Purchase invoice item details | No |
| purchaseInvoiceType | string | Purchase invoice type. Enum: "INVENTORY", "EXPENSE", "ASSET"Example: "INVENTORY" | Yes |
| purchaseOrderRefNo | string | Contact PO reference number Example: "CPO001" | No |
| rcmApplicable | boolean | Reverse Charge Applicable Example: true | No |
| receiveByDate | dateTime | Receive by date Example: "25-10-2019" | No |
| receiveGoodsStatus | string | Purchase invoice receipt status Enum: "UNRECEIVED", "PARTIAL_RECEIVED", "FULLY_RECEIVED", "NOT_APPLICABLE"Example: "UNRECEIVED" | No |
| recurring | boolean | True if Invoice is recurring. Example: true | No |
| recurringActivated | boolean | True if Invoice recurrence is active. Example: false | 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 |
| sequenceFormat | string | Sequence Format Id Example: 1 | 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 | 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 Example: 12.32 | No |
| unitPriceGstInclusive | boolean | Unit price is GST inclusive Example: false | No |
| warehouseCode | string | Warehouse Code Example: "WH-000001" | No |
PurchaseInvoiceResponseUk
| Name | Type | Description | Required |
|---|---|---|---|
| additionalCharges | AdditionalCharges | Purchase invoice additional charges details | No |
| approvalStatus | string | Approval status Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"Example: "APPROVED" | No |
| attachmentIds | [ integer ] | No | |
| attachments | [ string ] | File attachments | No |
| attachmentsWithLink | [ AttachmentsResponse ] | Attachments Details | No |
| backOrder | boolean | Backorder flag to indicate if purchase invoice is backorder Example: true | No |
| billTo | Address | Bill to Address | No |
| contact | ContactInfo | Contact details | Yes |
| contactCode | string | Contact Code Example: "C0001" | Yes |
| contactDto | ContactDto | Contact Details | Yes |
| currency | string | Currency Example: "C001" | Yes |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| documentSequenceCode | string | Purchase invoice Sequence Code Example: "0000001" | No |
| draft | boolean | Purchase invoice drafted Example: false | No |
| draftReferenceId | string | Draft reference id | No |
| dropShip | boolean | Drop Ship flag to indicate if purchase invoice is created for drop ship Example: true | No |
| dueAmount | number | Amount Due Example: 12.322 | 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 |
| id | long | Purchase invoice id Example: 1 | No |
| isPartialInvoice | boolean | Whether the Purchase Invoice is a partial invoice Example: false | No |
| journalEntryCode | string | Journal Entry Code Example: "JE0001" | No |
| knockoffInfo | [ KnockOffInfo ] | KnockOff Info | No |
| landedCost | boolean | To mark landed cost bill Example: true | No |
| linkedDocuments | [ DocumentInfo ] | Linked Documents | No |
| memo | string | Memo Example: "Memo details" | No |
| openingDocumentNumber | string | Customer opening document number Example: "DC-0001" | No |
| openingInvoice | boolean | True if opening invoice Example: false | No |
| payableAccountCode | string | Code of Account Example: "AC-000001" | No |
| paymentMilestoneFlag | boolean | Payment milestone flag to indicate if payment milestones are set Example: true | No |
| paymentStatus | string | Purchase invoice payment status Enum: "PENDING", "PARTIAL", "RECEIVED"Example: "PENDING" | No |
| purchaseInvoiceAccounts | [ PurchaseInvoiceAccountDetails ] | Purchase invoice Account item details | No |
| purchaseInvoiceAssets | [ PurchaseInvoiceAssetGroupDetails ] | No | |
| purchaseInvoiceCode | string | Purchase invoice code Example: "SI001" | No |
| purchaseInvoiceDate | string | Purchase Invoice date Example: "25-10-2019" | Yes |
| purchaseInvoiceDueDate | string | Purchase Invoice due date Example: "25-10-2019" | Yes |
| purchaseInvoiceProducts | [ PurchaseInvoiceProductDetailsUk ] | Purchase invoice Product item details | No |
| purchaseInvoiceRecurring | PurchaseInvoiceRecurringDetails | Purchase invoice item details | No |
| purchaseInvoiceType | string | Purchase invoice type. Enum: "INVENTORY", "EXPENSE", "ASSET"Example: "INVENTORY" | Yes |
| purchaseOrderRefNo | string | Contact PO reference number Example: "CPO001" | No |
| receiveByDate | dateTime | Receive by date Example: "25-10-2019" | No |
| receiveGoodsStatus | string | Purchase invoice receipt status Enum: "UNRECEIVED", "PARTIAL_RECEIVED", "FULLY_RECEIVED", "NOT_APPLICABLE"Example: "UNRECEIVED" | No |
| recurring | boolean | True if Invoice is recurring. Example: true | No |
| recurringActivated | boolean | True if Invoice recurrence is active. Example: false | 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 |
| sequenceFormat | string | Sequence Format Id Example: 1 | 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 | 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 Example: 12.32 | No |
| unitPriceGstInclusive | boolean | Unit price is GST inclusive Example: false | No |
| warehouseCode | string | Warehouse Code Example: "WH-000001" | No |
PurchaseInvoiceUpdateRequest
| Name | Type | Description | Required |
|---|---|---|---|
| closedDate | dateTime | Purchase Invoice closed on date Example: "05-12-2019" | No |
| goodsReceiptCode | string | Goods Receipt Code Example: "0000012" | No |
| itemToReceivedQtyMap | object | Received Quantity by Purchase Invoice Item Example: [] | No |
| linkedDocuments | [ DocumentInfo ] | Linked Documents | No |
| paymentDate | dateTime | No | |
| paymentStatus | string | Payment status Enum: "PENDING", "PARTIAL", "RECEIVED"Example: "RECEIVED" | No |
| purchaseInvoiceCode | string | Purchase Invoice Code Example: "0000012" | No |
| receiptDate | dateTime | No | |
| receiptOn | dateTime | No | |
| receiptStatus | string | Purchase Invoice Receipt status Enum: "UNRECEIVED", "PARTIAL_RECEIVED", "FULLY_RECEIVED", "NOT_APPLICABLE"Example: "FULLY_RECEIVED" | No |
| status | string | Invoice status Enum: "OPEN", "DRAFT", "CLOSED"Example: "OPEN" | No |
RecurringInvoicePaymentInfoDto
| Name | Type | Description | Required |
|---|---|---|---|
| currency | string | No | |
| invoiceCode | string | No | |
| invoiceId | long | No | |
| paymentInformation | PaymentInformation | Payment information | No |
RecurringJobEvent
| Name | Type | Description | Required |
|---|---|---|---|
| customTemplate | boolean | No | |
| documentDate | dateTime | No | |
| documentType | 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 |
| emailBody | string | No | |
| emailReplyTo | string | No | |
| emailSenderName | string | No | |
| emailSubject | string | No | |
| emailTemplateId | long | No | |
| emailTo | string | No | |
| iamUserId | long | No | |
| insertPaymentLinkFlag | boolean | No | |
| jobId | long | No | |
| parentDocumentCode | string | No | |
| sendEmailNotificationFlag | boolean | No | |
| tenantId | long | No | |
| userId | long | No |
Relationship
| Name | Type | Description | Required |
|---|---|---|---|
| ids | [ string ] | No | |
| type | string | No |
ReminderConfigurationDto
| Name | Type | Description | Required |
|---|---|---|---|
| code | string | Code | No |
| enabled | boolean | Enable reminder Example: true | No |
| id | long | Sales Return Code Example: 1 | No |
| isBefore | boolean | Enable is before Example: true | No |
| numDays | long | Number of Days Example: 7 | No |
| repeatInterval | long | Number of Times reminder repeats Example: 3 | No |
| repeatTimes | long | Number of Days after which reminder repeats Example: 5 | No |
| tenantId | long | Tenant id Example: 12345 | No |
ReminderConfigurationRequestDto
| Name | Type | Description | Required |
|---|---|---|---|
| code | string | Code | No |
| enabled | boolean | Enable reminder Example: true | No |
| isBefore | boolean | Enable is before Example: true | No |
| numDays | long | Number of Days Example: "7L" | No |
| repeatInterval | long | Number of Times reminder repeats Example: "3L" | No |
| repeatTimes | long | Number of Days after which reminder repeats Example: "5L" | No |
| tenantId | long | Tenant id Example: "123L" | No |
ReminderConfigurationResponseDto
| Name | Type | Description | Required |
|---|---|---|---|
| code | string | Code | No |
| enabled | boolean | Enable reminder Example: true | No |
| id | long | Sales Return Code Example: "REM-00001" | No |
| isBefore | boolean | Enable is before Example: true | No |
| numDays | long | Number of Days Example: "7L" | No |
| repeatInterval | long | Number of Times reminder repeats Example: "3L" | No |
| repeatTimes | long | Number of Days after which reminder repeats Example: "5L" | No |
| tenantId | long | Tenant id Example: "123L" | No |
ReminderDisabledContactDto
| Name | Type | Description | Required |
|---|---|---|---|
| contactCode | string | Contact Code Example: "C-0000001" | No |
| disabled | boolean | Contact disabled Example: false | No |
ReminderDisabledContactRequestDto
| Name | Type | Description | Required |
|---|---|---|---|
| contactCode | string | Contact Code | No |
| disabled | boolean | Disabled contacts for reminder Example: true | No |
ReminderLogDto
| Name | Type | Description | Required |
|---|---|---|---|
| id | long | Sales Return Code Example: 1 | No |
| invoiceId | long | Invoice Id Example: 1 | No |
| reminderDate | dateTime | Reminder Date | No |
| reminderId | long | Reminder Id Example: 12345 | No |
| tenantId | long | Tenant id Example: 12345 | No |
ReminderSettingsDto
| Name | Type | Description | Required |
|---|---|---|---|
| cc | [ string ] | Array of email ids in cc | No |
| enabled | boolean | Enable invoice reminder Example: true | No |
| id | long | Sales Return Code Example: 1 | No |
| tenantId | long | Tenant id Example: 12345 | No |
| timeZone | string | Time zone Example: "IST" | No |
| timeZoneOffset | string | Time zone offset Example: "+05:30" | No |
ReminderSettingsRequest
| Name | Type | Description | Required |
|---|---|---|---|
| cc | [ string ] | Array of email ids in cc | No |
| enabled | boolean | Enable invoice reminder Example: true | No |
| tenantId | long | Tenant id Example: "123L" | No |
| timeZone | string | Time zone Example: "IST" | No |
| timeZoneOffset | string | Time zone offset Example: "+05:30" | No |
ReminderSettingsResponse
| Name | Type | Description | Required |
|---|---|---|---|
| cc | [ string ] | Array of email ids in cc | No |
| enabled | boolean | Enable invoice reminder Example: true | No |
| id | long | Sales Return Code Example: "REM-00001" | No |
| tenantId | long | Tenant id Example: "123L" | No |
| timeZone | string | Time zone Example: "IST" | No |
| timeZoneOffset | string | Time zone offset Example: "+05:30" | No |
ReservedQuantityData
| Name | Type | Description | Required |
|---|---|---|---|
| advancedTrackingMetaDtos | [ AdvancedTrackingMetaDto ] | Advance tracking type Example: "SERIAL" | No |
| advancedTrackingType | string | Advance tracking type Enum: "NONE", "BATCH", "SERIAL"Example: "SERIAL" | No |
| availableQuantity | double | Available quantity in warehouse Example: 100 | No |
| binCode | string | bin code Example: "BIN-00001" | Yes |
| documentCode | string | Document code Example: "000005" | No |
| documentItemCode | string | Document item code Example: "000005" | No |
| documentType | string | Document type Example: "SALES_INVOICE" | No |
| productCode | string | Product Code Example: 10 | No |
| rackCode | string | Rack code Example: "RACK-00001" | Yes |
| reservedDate | dateTime | reserved date Example: "20-10-2022" | No |
| reservedQuantity | double | Reserved quantity Example: 100 | No |
| rowCode | string | Row code Example: "ROW-00001" | Yes |
| warehouseCode | string | Warehouse Code Example: 100.4 | No |
| wipProcessType | string | Work Order WIP Process Type Enum: "PRODUCTION", "CONSUMPTION", "WASTAGE", "SCRAP", "CO_PRODUCT"Example: "CONSUMPTION" | No |
ReservedQuantityFulfillmentItemDto
| Name | Type | Description | Required |
|---|---|---|---|
| advancedTrackingFulfilmentDtos | [ AdvancedTrackingFulfilmentDto ] | Advanced tracking data for fulfilled reserved quantity Example: [] | No |
| fulfilledQtyByWarehouse | [ LinkedWareHouse ] | Fulfilled reserved quantity by warehouse Example: [] | No |
Resource
| Name | Type | Description | Required |
|---|---|---|---|
| description | string | No | |
| file | File | No | |
| filename | string | No | |
| inputStream | InputStream | No | |
| open | boolean | No | |
| readable | boolean | No | |
| uri | URI | No | |
| url | URL | No |
ResponseEntity
| Name | Type | Description | Required |
|---|---|---|---|
| body | object | No | |
| statusCode | string | 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" | No |
| statusCodeValue | integer | No |
ResponseMetadata
| Name | Type | Description | Required |
|---|---|---|---|
| requestId | string | No |
RevRecDocumentItemDetails
| Name | Type | Description | Required |
|---|---|---|---|
| endDate | dateTime | No | |
| startDate | dateTime | No |
RowRackBinData
| Name | Type | Description | Required |
|---|---|---|---|
| binId | long | Row Id Example: 1 | Yes |
| binName | string | Row Name Example: "Row1" | Yes |
| rackId | long | Row Id Example: 1 | Yes |
| rackName | string | Row Name Example: "Row1" | Yes |
| rowId | long | Row Id Example: 1 | Yes |
| rowName | string | Row Name Example: "Row1" | Yes |
SalesDocument
| Name | Type | Description | Required |
|---|---|---|---|
| contactCode | string | Contact code Example: "000012" | No |
| contactDto | ContactDto | Contact Details | Yes |
| documentCode | string | Document Code. Example: "QO-0000001" | No |
| documentDate | dateTime | Document date Example: "25-10-2019" | No |
| documentItemDetails | [ DocumentItemDetails ] | Document item details. | No |
| documentSequenceCode | string | Document Sequence Code. Example: "0000001" | No |
| documentType | string | Type of document. Enum: "QUOTATION", "PURCHASE_ORDER", "SALES_ORDER", "PURCHASE_INVOICE", "SALES_INVOICE", "MAKE_PAYMENT", "RECEIVE_PAYMENT", "JOURNAL_ENTRY", "BANK_TRANSFER", "CREDIT_NOTE", "DEBIT_NOTE", "EXPENSE", "EXPENSE_PREPAYMENT", "DEPOSIT", "DEPOSIT_ADVPAYMENT", "CONTRA_ADJUSTMENT", "GOODS_RECEIPT", "FULFILLMENT", "PICKLIST", "PACKLIST", "SHIPLIST", "PAYSLIP", "PAYROLL_CHECK", "CHEQUE", "SALES_RETURN", "PURCHASE_RETURN", "STOCK_ADJUSTMENT", "STOCK_TRANSFER", "WORK_ORDER", "FIXED_ASSET", "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"Example: "QUOTATION" | No |
| exchangeRate | double | No | |
| linkedDocuments | [ DocumentInfo ] | Linked Documents | No |
| shipByDate | dateTime | Ship by date Example: "25-10-2019" | No |
| shipFrom | Address | Ship from address. | No |
| shipTo | Address | Ship To address. | No |
| warehouseCode | string | Warehouse Code Example: "WH-0000001" | No |
SalesInvoiceBulkDeleteResponseDto
| Name | Type | Description | Required |
|---|---|---|---|
| documentSequenceCode | string | documentSequenceCode Example: "QU-0000001" | 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 |
SalesInvoiceInformation
| Name | Type | Description | Required |
|---|---|---|---|
| additionalCharges | AdditionalCharges | Purchase invoice additional charges details | No |
| attachmentIds | [ integer ] | No | |
| attachments | [ string ] | File attachments | No |
| backOrder | boolean | Backorder flag to indicate if backorder created Example: true | No |
| billTo | Address | Bill to address | No |
| closedDate | string | No | |
| contact | ContactInfo | Contact details | Yes |
| contactCode | string | Contact Code Example: "C0001" | Yes |
| contactDto | ContactInformation | Contact Details | Yes |
| currency | string | Currency Example: "C001" | Yes |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| customerType | string | Customer Type Enum: "EXPORT_WO_PAY", "EXPORT_W_PAY", "NA", "SEZ_WO_PAY", "SEZ_W_PAY"Example: "NA" | Yes |
| documentSequenceCode | string | Sales invoice Sequence Code Example: "0000001" | No |
| draft | boolean | Sales invoice drafted Example: false | No |
| dropShip | boolean | Drop Ship flag to indicate if purchase invoice is created for drop ship Example: true | No |
| dueAmount | number | Amount Due Example: 12.322 | No |
| einvoiceInfoIndia | EinvoiceInfoIndia | eInvoice Information Example: "eInvoice" | No |
| einvoiceInfoIndiaCancel | EinvoiceInfoIndiaCancel | eInvoice Information Example: "eInvoice" | No |
| ewayBillInfoIndia | EWayBillInfoIndia | No | |
| ewayGenerated | boolean | No | |
| exchangeRate | number | Exchange rate Example: 0.456345 | No |
| fulfillmentDate | string | No | |
| fulfillmentOn | string | No | |
| fulfillmentStatus | string | Sales invoice fulfillment status Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"Example: "UNFULFILLED" | No |
| fulfillmentType | string | Fulfillment type: NONE, DEFAULT, PICK_PACK_SHIP, DROP_SHIP Enum: "NONE", "DEFAULT", "PICK_PACK_SHIP", "DROP_SHIP"Example: "PICK_PACK_SHIP" | No |
| gstExchangeRate | number | GST Exchange rate if tax residency currency is different than base currency Example: 1 | No |
| gstin | string | GSTIN Example: "ABSASASSASASA198" | Yes |
| id | long | Sales invoice id Example: 1 | No |
| isCancelEinvoice | boolean | eInvoice is canceled or not Example: false | No |
| isPartialInvoice | boolean | Is Partial Invoice | Yes |
| journalEntryCode | string | Journal Entry Code Example: "JE0001" | No |
| knockoffInfo | [ KnockOffInfo ] | KnockOff Info | No |
| linkedDocuments | [ DocumentInfo ] | Linked Documents | No |
| memo | string | Memo Example: "Memo details" | No |
| openingDocumentNumber | string | Customer opening document number Example: "DC-0001" | No |
| openingInvoice | boolean | True if opening invoice Example: false | No |
| paymentDate | string | No | |
| paymentInformation | PaymentInformation | Payment information | No |
| paymentMilestoneDetails | [ PaymentMilestoneDetailsResponse ] | Payment milestone details | No |
| paymentMilestoneFlag | boolean | Payment milestone flag to indicate if payment milestones are set Example: true | No |
| paymentStatus | string | Sales invoice payment status Enum: "PENDING", "PARTIAL", "RECEIVED"Example: "PENDING" | No |
| placeOfSupply | string | state in India Example: "Punjab" | Yes |
| purchaseOrderRefNo | string | Contact PO reference number Example: "CPO001" | No |
| recurring | boolean | True if Invoice is recurring. Example: true | No |
| recurringActivated | boolean | True if Invoice recurrence is active. Example: false | No |
| reservedStock | boolean | Reserved stock enabled Example: true | 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 |
| salesInvoiceCode | string | Sales invoice code Example: "SI001" | No |
| salesInvoiceDate | string | Sales Invoice date Example: "25-10-2019" | Yes |
| salesInvoiceDueDate | string | Sales Invoice due date Example: "25-10-2019" | Yes |
| salesInvoiceItems | [ SalesInvoiceItemInformation ] | Sales invoice item details | No |
| salesInvoiceRecurring | SalesInvoiceRecurringDetails | Sales invoice item details | No |
| sequenceFormat | string | Sequence Format Id Example: 1 | No |
| shipByDate | string | Ship by date Example: "25-10-2019" | No |
| shipFrom | Address | Ship from address | No |
| shipTo | Address | Ship to address | No |
| status | string | Invoice status Enum: "OPEN", "DRAFT", "CLOSED"Example: "OPEN" | No |
| taxAmount | number | Tax amount Example: 2.322 | No |
| taxInvoiceNo | string | Tax Invoice No Example: 123456789 | No |
| tcsAmount | number | TCS amount Example: 2.322 | No |
| tcsPercentage | number | TCS percentage Example: 2 | No |
| tcsRateId | long | TCS Rate Id Example: 1 | No |
| tdsInfo | [ SalesInvoiceTdsInfo ] | SalesInvoice Tds Info | No |
| totalAmount | number | Total amount Example: 12.322 | No |
| totalAmountInBaseCurrency | number | Total amount in base currency Example: 12.322 | No |
| unitPriceGstInclusive | boolean | Unit price is GST inclusive Example: false | No |
| vendorType | string | Vendor Type Enum: "IMPORT", "NA", "SEZ_W_PAY", "SEZ_WO_PAY"Example: "NA" | Yes |
| warehouseCode | string | Warehouse Code Example: "WH-000001" | No |
| whtRate | number | Wht rate Example: 1 | No |
| withheldAmount | number | Withheld Amount Example: 12.322 | No |
SalesInvoiceItemDetails
| Name | Type | Description | Required |
|---|---|---|---|
| additionalCharges | AdditionalCharges | Additional charges applied to the item | No |
| allocationType | string | Allocation Type Example: "NORMAL" | No |
| availableQuantity | number | Total available quantity Example: 3 | No |
| basePrice | number | Revenue Base price Example: 120 | No |
| bomComponentGroupDetails | object | Bill-of-materials component group details | No |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| discount | number | Discount Example: 2 | No |
| discountInPercent | boolean | Discount in percentage Example: true | No |
| documentSequenceCode | string | Product Document Sequence Code Example: "P-0000001" | Yes |
| documentUOMSchemaDefinition | DocumentUOMSchemaDefinition | Document UOM Schema Definition Example: 2 | Yes |
| documentUom | long | Document UOM id Example: 2 | Yes |
| errors | [ string ] | List of validation error messages | No |
| fulfillmentByDoc | [ ItemQtyFulfilledByDoc ] | Item Qty fulfilled by Fulfillment Doc Example: [] | No |
| id | long | ID Example: 2 | No |
| invoiceLineNumber | string | Invoice Line Number Example: "ABSCDDSD1212" | No |
| isLocalizedUomQty | boolean | True if the UOM quantity is localized Example: false | No |
| isPartialInvoice | boolean | Whether the Sales Invoice is a partial invoice Example: false | No |
| isShortClosed | boolean | True if the item is short closed Example: false | No |
| itemDiscountMethod | string | Discount method applied to the item Example: "AMOUNT" | No |
| itemFulfillmentStatus | string | Item Fulfillment Status Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"Example: "UNFULFILLED" | No |
| landedCostWeight | number | Landed cost weight of the item Example: 1.5 | No |
| lineNumber | integer | Line Number Example: 1 | No |
| lineRefNo | string | Line reference number Example: "L-0001" | No |
| linkedQuoteItem | long | Quote Item linked to invoice item Example: "QO-001" | No |
| linkedQuoteItemCode | string | Linked quote item code Example: "QO-002" | No |
| localizedBaseQtyDiff | number | Difference in base quantity due to localization Example: 0 | No |
| preTaxGlobalDiscount | number | Pre-tax global discount applied to the item Example: 2 | No |
| product | ProductResponse | Product Response Example: "product" | No |
| productCode | string | Product code Example: "P00001" | Yes |
| productDescription | string | Product description Example: "Apple watch" | No |
| productOrder | integer | Product view order Example: 1 | No |
| productQuantity | number | Product quantity Example: 2 | Yes |
| qtyConvertedToDropShip | number | Quantity converted to drop ship Example: 0 | No |
| qtyConvertedToPps | number | Quantity converted to pick-pack-ship Example: 0 | No |
| qtyFulfilledFromPps | number | Quantity fulfilled from pick-pack-ship Example: 0 | No |
| qtyFulfilledFromToDropShip | number | Quantity fulfilled from a drop ship conversion Example: 0 | No |
| quantityFulfilled | number | quantity fulfilled Example: 10 | No |
| quantityFulfilledByFlowover | number | Total Quantity Fulfilled By Flowover | Yes |
| quantityFulfilledByUser | number | Total Quantity Fulfilled By User | Yes |
| reservedQuantitiesData | [ ReservedQuantityData ] | Reserved quantity data Example: [] | No |
| revRecDocumentItemDetails | RevRecDocumentItemDetails | Item Revenue Details Example: "revRecDocumentItemDetails" | No |
| salesInvoiceItemCode | string | Sales Invoice Item Code Example: "SII-000001" | No |
| shortClosedNotes | string | Notes recorded when the item was short closed Example: "Remaining qty written off" | No |
| shortClosedQuantity | number | Quantity that was short closed Example: 0 | No |
| tax | TaxDto | Tax details Example: "taxDto" | No |
| taxAmount | number | Tax amount Example: 0.5 | No |
| taxCode | string | Tax code Example: "GST7" | No |
| taxDetails | [ DocumentItemTaxMappingDto ] | Tax mapping details for the item | No |
| totalAmount | number | Total amount Example: 2.3 | Yes |
| type | string | Product type Enum: "TRACKED", "NONTRACKED"Example: "TRACKED" | Yes |
| unitPrice | number | Product unit price Example: 0.7 | Yes |
| unlocalizedDocumentUOMSchemaDefinition | DocumentUOMSchemaDefinition | Document UOM Schema Definition before localization | No |
| uomQuantity | number | uom quantity Example: 2 | Yes |
| uomUnitPrice | number | UOM Unit price Example: 2.3 | Yes |
| updatedPartialQuantity | number | partial invoice updated quantity Example: 10 | No |
| userSetTaxes | boolean | True if taxes were manually set by the user Example: false | No |
SalesInvoiceItemDetailsAustralia
| Name | Type | Description | Required |
|---|---|---|---|
| allocationType | string | Allocation Type Example: "NORMAL" | No |
| availableQuantity | number | Total available quantity Example: 3 | No |
| basePrice | number | Revenue Base price Example: 120 | No |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| discount | number | Discount Example: 2 | No |
| discountInPercent | boolean | Discount in percentage Example: true | No |
| documentSequenceCode | string | Product Document Sequence Code Example: "P-0000001" | Yes |
| documentUOMSchemaDefinition | DocumentUOMSchemaDefinition | Document UOM Schema Definition Example: 2 | Yes |
| documentUom | long | Document UOM id Example: 2 | Yes |
| errors | [ string ] | List of validation error messages | No |
| fulfillmentByDoc | [ ItemQtyFulfilledByDoc ] | Item Qty fulfilled by Fulfillment Doc Example: [] | No |
| id | long | ID Example: 2 | No |
| isPartialInvoice | boolean | Whether the Sales Invoice is a partial invoice Example: false | No |
| itemFulfillmentStatus | string | Item Fulfillment Status Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"Example: "UNFULFILLED" | No |
| lineNumber | integer | Line Number Example: 1 | No |
| linkedQuoteItem | long | Quote Item linked to invoice item Example: "QO-001" | No |
| linkedQuoteItemCode | string | Linked quote item code Example: "QO-002" | No |
| product | ProductResponse | Product Response Example: "product" | No |
| productCode | string | Product code Example: "P00001" | Yes |
| productDescription | string | Product description Example: "Apple watch" | No |
| productOrder | integer | Product view order Example: 1 | No |
| productQuantity | number | Product quantity Example: 2 | Yes |
| quantityFulfilled | number | quantity fulfilled Example: 10 | No |
| quantityFulfilledByFlowover | number | Total Quantity Fulfilled By Flowover | Yes |
| quantityFulfilledByUser | number | Total Quantity Fulfilled By User | Yes |
| reservedQuantitiesData | [ ReservedQuantityData ] | Reserved quantity data Example: [] | No |
| revRecDocumentItemDetails | RevRecDocumentItemDetails | Item Revenue Details Example: "revRecDocumentItemDetails" | No |
| salesInvoiceItemCode | string | Sales Invoice Item Code Example: "SII-000001" | No |
| tax | TaxDto | Tax details Example: "taxDto" | No |
| taxAmount | number | Tax amount Example: 0.5 | No |
| taxCode | string | Tax code Example: "GST7" | No |
| totalAmount | number | Total amount Example: 2.3 | Yes |
| type | string | Product type Enum: "TRACKED", "NONTRACKED"Example: "TRACKED" | Yes |
| unitPrice | number | Product unit price Example: 0.7 | Yes |
| uomQuantity | number | uom quantity Example: 2 | Yes |
| uomUnitPrice | number | UOM Unit price Example: 2.3 | Yes |
| updatedPartialQuantity | number | partial invoice updated quantity Example: 10 | No |
SalesInvoiceItemDetailsCanada
| Name | Type | Description | Required |
|---|---|---|---|
| allocationType | string | Allocation Type Example: "NORMAL" | No |
| availableQuantity | number | Total available quantity Example: 3 | No |
| basePrice | number | Revenue Base price Example: 120 | No |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| discount | number | Discount Example: 2 | No |
| discountInPercent | boolean | Discount in percentage Example: true | No |
| documentSequenceCode | string | Product Document Sequence Code Example: "P-0000001" | Yes |
| documentUOMSchemaDefinition | DocumentUOMSchemaDefinition | Document UOM Schema Definition Example: 2 | Yes |
| documentUom | long | Document UOM id Example: 2 | Yes |
| errors | [ string ] | List of validation error messages | No |
| fulfillmentByDoc | [ ItemQtyFulfilledByDoc ] | Item Qty fulfilled by Fulfillment Doc Example: [] | No |
| id | long | ID Example: 2 | No |
| isPartialInvoice | boolean | Whether the Sales Invoice is a partial invoice Example: false | No |
| itemFulfillmentStatus | string | Item Fulfillment Status Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"Example: "UNFULFILLED" | No |
| lineNumber | integer | Line Number Example: 1 | No |
| linkedQuoteItem | long | Quote Item linked to invoice item Example: "QO-001" | No |
| linkedQuoteItemCode | string | Linked quote item code Example: "QO-002" | No |
| product | ProductResponse | Product Response Example: "product" | No |
| productCode | string | Product code Example: "P00001" | Yes |
| productDescription | string | Product description Example: "Apple watch" | No |
| productOrder | integer | Product view order Example: 1 | No |
| productQuantity | number | Product quantity Example: 2 | Yes |
| quantityFulfilled | number | quantity fulfilled Example: 10 | No |
| quantityFulfilledByFlowover | number | Total Quantity Fulfilled By Flowover | Yes |
| quantityFulfilledByUser | number | Total Quantity Fulfilled By User | Yes |
| reservedQuantitiesData | [ ReservedQuantityData ] | Reserved quantity data Example: [] | No |
| revRecDocumentItemDetails | RevRecDocumentItemDetails | Item Revenue Details Example: "revRecDocumentItemDetails" | No |
| salesInvoiceItemCode | string | Sales Invoice Item Code Example: "SII-000001" | No |
| tax | TaxDto | Tax details Example: "taxDto" | No |
| taxAmount | number | Tax amount Example: 0.5 | No |
| taxCode | string | Tax code Example: "GST7" | No |
| totalAmount | number | Total amount Example: 2.3 | Yes |
| type | string | Product type Enum: "TRACKED", "NONTRACKED"Example: "TRACKED" | Yes |
| unitPrice | number | Product unit price Example: 0.7 | Yes |
| uomQuantity | number | uom quantity Example: 2 | Yes |
| uomUnitPrice | number | UOM Unit price Example: 2.3 | Yes |
| updatedPartialQuantity | number | partial invoice updated quantity Example: 10 | No |
SalesInvoiceItemDetailsGermany
| Name | Type | Description | Required |
|---|---|---|---|
| allocationType | string | Allocation Type Example: "NORMAL" | No |
| availableQuantity | number | Total available quantity Example: 3 | No |
| basePrice | number | Revenue Base price Example: 120 | No |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| discount | number | Discount Example: 2 | No |
| discountInPercent | boolean | Discount in percentage Example: true | No |
| documentSequenceCode | string | Product Document Sequence Code Example: "P-0000001" | Yes |
| documentUOMSchemaDefinition | DocumentUOMSchemaDefinition | Document UOM Schema Definition Example: 2 | Yes |
| documentUom | long | Document UOM id Example: 2 | Yes |
| errors | [ string ] | List of validation error messages | No |
| fulfillmentByDoc | [ ItemQtyFulfilledByDoc ] | Item Qty fulfilled by Fulfillment Doc Example: [] | No |
| id | long | ID Example: 2 | No |
| isPartialInvoice | boolean | Whether the Sales Invoice is a partial invoice Example: false | No |
| itemFulfillmentStatus | string | Item Fulfillment Status Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"Example: "UNFULFILLED" | No |
| lineNumber | integer | Line Number Example: 1 | No |
| linkedQuoteItem | long | Quote Item linked to invoice item Example: "QO-001" | No |
| linkedQuoteItemCode | string | Linked quote item code Example: "QO-002" | No |
| product | ProductResponse | Product Response Example: "product" | No |
| productCode | string | Product code Example: "P00001" | Yes |
| productDescription | string | Product description Example: "Apple watch" | No |
| productOrder | integer | Product view order Example: 1 | No |
| productQuantity | number | Product quantity Example: 2 | Yes |
| quantityFulfilled | number | quantity fulfilled Example: 10 | No |
| quantityFulfilledByFlowover | number | Total Quantity Fulfilled By Flowover | Yes |
| quantityFulfilledByUser | number | Total Quantity Fulfilled By User | Yes |
| reservedQuantitiesData | [ ReservedQuantityData ] | Reserved quantity data Example: [] | No |
| revRecDocumentItemDetails | RevRecDocumentItemDetails | Item Revenue Details Example: "revRecDocumentItemDetails" | No |
| salesInvoiceItemCode | string | Sales Invoice Item Code Example: "SII-000001" | No |
| tax | TaxDto | Tax details Example: "taxDto" | No |
| taxAmount | number | Tax amount Example: 0.5 | No |
| taxCode | string | Tax code Example: "GST7" | No |
| totalAmount | number | Total amount Example: 2.3 | Yes |
| type | string | Product type Enum: "TRACKED", "NONTRACKED"Example: "TRACKED" | Yes |
| unitPrice | number | Product unit price Example: 0.7 | Yes |
| uomQuantity | number | uom quantity Example: 2 | Yes |
| uomUnitPrice | number | UOM Unit price Example: 2.3 | Yes |
| updatedPartialQuantity | number | partial invoice updated quantity Example: 10 | No |
SalesInvoiceItemDetailsIndia
| Name | Type | Description | Required |
|---|---|---|---|
| allocationType | string | Allocation Type Example: "NORMAL" | No |
| availableQuantity | number | Total available quantity Example: 3 | No |
| basePrice | number | Revenue Base price Example: 120 | No |
| cessAmount | number | cess amount Example: 40 | No |
| cessPercentage | number | Cess Percentage Example: 2.322 | No |
| cessRule | string | Cess rule expression Example: "Math.max(21amount/100,4170quantity/1000)" | No |
| cgstAmount | number | CGST tax amount Example: 60 | No |
| cgstRate | number | CGST tax rate Example: 6 | No |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| discount | number | Discount Example: 2 | No |
| discountInPercent | boolean | Discount in percentage Example: true | No |
| documentSequenceCode | string | Product Document Sequence Code Example: "P-0000001" | Yes |
| documentUOMSchemaDefinition | DocumentUOMSchemaDefinition | Document UOM Schema Definition Example: 2 | Yes |
| documentUom | long | Document UOM id Example: 2 | Yes |
| errors | [ string ] | List of validation error messages | No |
| fulfillmentByDoc | [ ItemQtyFulfilledByDoc ] | Item Qty fulfilled by Fulfillment Doc Example: [] | No |
| hsnOrSacCode | string | Hsn or Sac code Example: 110011 | No |
| id | long | ID Example: 2 | No |
| igstAmount | number | IGST tax amount Example: 120 | No |
| igstRate | number | IGST tax rate Example: 12 | No |
| isPartialInvoice | boolean | Whether the Sales Invoice is a partial invoice Example: false | No |
| itemFulfillmentStatus | string | Item Fulfillment Status Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"Example: "UNFULFILLED" | No |
| lineNumber | integer | Line Number Example: 1 | No |
| linkedQuoteItem | long | Quote Item linked to invoice item Example: "QO-001" | No |
| linkedQuoteItemCode | string | Linked quote item code Example: "QO-002" | No |
| otherRate | number | SGST tax rate Example: 6 | No |
| otherTaxAmount | number | Total amount Example: 1000 | Yes |
| product | ProductResponse | Product Response Example: "product" | No |
| productCode | string | Product code Example: "P00001" | Yes |
| productDescription | string | Product description Example: "Apple watch" | No |
| productOrder | integer | Product view order Example: 1 | No |
| productQuantity | number | Product quantity Example: 2 | Yes |
| quantityFulfilled | number | quantity fulfilled Example: 10 | No |
| quantityFulfilledByFlowover | number | Total Quantity Fulfilled By Flowover | Yes |
| quantityFulfilledByUser | number | Total Quantity Fulfilled By User | Yes |
| reservedQuantitiesData | [ ReservedQuantityData ] | Reserved quantity data Example: [] | No |
| revRecDocumentItemDetails | RevRecDocumentItemDetails | Item Revenue Details Example: "revRecDocumentItemDetails" | No |
| salesInvoiceItemCode | string | Sales Invoice Item Code Example: "SII-000001" | No |
| sgstAmount | number | SGST tax amount Example: 60 | No |
| sgstRate | number | SGST tax rate Example: 6 | No |
| tax | TaxDto | Tax details Example: "taxDto" | No |
| taxAmount | number | Tax amount Example: 160 | Yes |
| taxCode | string | Tax code Example: "GST7" | No |
| taxExemptionReason | string | Tax Exemption reason if taxPreference is true Enum: "EXEMPTED", "NON_GST"Example: "EXEMPTED" | No |
| taxPreference | boolean | Tax preference, whether Exempted or not Exempted Example: false | No |
| totalAmount | number | Total amount Example: 1000 | Yes |
| type | string | Product type Enum: "TRACKED", "NONTRACKED"Example: "TRACKED" | Yes |
| unitPrice | number | Product unit price Example: 0.7 | Yes |
| uomQuantity | number | uom quantity Example: 2 | Yes |
| uomUnitPrice | number | UOM Unit price Example: 2.3 | Yes |
| updatedPartialQuantity | number | partial invoice updated quantity Example: 10 | No |
| userSetTaxes | boolean | Flag to check whether tax is user edited Example: false | No |
SalesInvoiceItemDetailsIndonesia
| Name | Type | Description | Required |
|---|---|---|---|
| allocationType | string | Allocation Type Example: "NORMAL" | No |
| availableQuantity | number | Total available quantity Example: 3 | No |
| basePrice | number | Revenue Base price Example: 120 | No |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| discount | number | Discount Example: 2 | No |
| discountInPercent | boolean | Discount in percentage Example: true | No |
| documentSequenceCode | string | Product Document Sequence Code Example: "P-0000001" | Yes |
| documentUOMSchemaDefinition | DocumentUOMSchemaDefinition | Document UOM Schema Definition Example: 2 | Yes |
| documentUom | long | Document UOM id Example: 2 | Yes |
| errors | [ string ] | List of validation error messages | No |
| exciseAmount | number | Excise amount Example: 0.5 | No |
| exciseRate | double | Rate of Excise Example: 5 | No |
| exciseType | string | Excise type Enum: "PERCENT", "FLAT"Example: "FLAT" | No |
| fulfillmentByDoc | [ ItemQtyFulfilledByDoc ] | Item Qty fulfilled by Fulfillment Doc Example: [] | No |
| id | long | ID Example: 2 | No |
| isPartialInvoice | boolean | Whether the Sales Invoice is a partial invoice Example: false | No |
| itemFulfillmentStatus | string | Item Fulfillment Status Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"Example: "UNFULFILLED" | No |
| lineNumber | integer | Line Number Example: 1 | No |
| linkedQuoteItem | long | Quote Item linked to invoice item Example: "QO-001" | No |
| linkedQuoteItemCode | string | Linked quote item code Example: "QO-002" | No |
| product | ProductResponse | Product Response Example: "product" | No |
| productCode | string | Product code Example: "P00001" | Yes |
| productDescription | string | Product description Example: "Apple watch" | No |
| productOrder | integer | Product view order Example: 1 | No |
| productQuantity | number | Product quantity Example: 2 | Yes |
| quantityFulfilled | number | quantity fulfilled Example: 10 | No |
| quantityFulfilledByFlowover | number | Total Quantity Fulfilled By Flowover | Yes |
| quantityFulfilledByUser | number | Total Quantity Fulfilled By User | Yes |
| reservedQuantitiesData | [ ReservedQuantityData ] | Reserved quantity data Example: [] | No |
| revRecDocumentItemDetails | RevRecDocumentItemDetails | Item Revenue Details Example: "revRecDocumentItemDetails" | No |
| salesInvoiceItemCode | string | Sales Invoice Item Code Example: "SII-000001" | No |
| tax | TaxDto | Tax details Example: "taxDto" | No |
| taxAmount | number | Tax amount Example: 0.5 | No |
| taxCode | string | Tax code Example: "GST7" | No |
| totalAmount | number | Total amount Example: 2.3 | Yes |
| type | string | Product type Enum: "TRACKED", "NONTRACKED"Example: "TRACKED" | Yes |
| unitPrice | number | Product unit price Example: 0.7 | Yes |
| uomQuantity | number | uom quantity Example: 2 | Yes |
| uomUnitPrice | number | UOM Unit price Example: 2.3 | Yes |
| updatedPartialQuantity | number | partial invoice updated quantity Example: 10 | No |
SalesInvoiceItemDetailsIsrael
| Name | Type | Description | Required |
|---|---|---|---|
| allocationType | string | Allocation Type Example: "NORMAL" | No |
| availableQuantity | number | Total available quantity Example: 3 | No |
| basePrice | number | Revenue Base price Example: 120 | No |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| discount | number | Discount Example: 2 | No |
| discountInPercent | boolean | Discount in percentage Example: true | No |
| documentSequenceCode | string | Product Document Sequence Code Example: "P-0000001" | Yes |
| documentUOMSchemaDefinition | DocumentUOMSchemaDefinition | Document UOM Schema Definition Example: 2 | Yes |
| documentUom | long | Document UOM id Example: 2 | Yes |
| errors | [ string ] | List of validation error messages | No |
| fulfillmentByDoc | [ ItemQtyFulfilledByDoc ] | Item Qty fulfilled by Fulfillment Doc Example: [] | No |
| id | long | ID Example: 2 | No |
| isPartialInvoice | boolean | Whether the Sales Invoice is a partial invoice Example: false | No |
| itemFulfillmentStatus | string | Item Fulfillment Status Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"Example: "UNFULFILLED" | No |
| lineNumber | integer | Line Number Example: 1 | No |
| linkedQuoteItem | long | Quote Item linked to invoice item Example: "QO-001" | No |
| linkedQuoteItemCode | string | Linked quote item code Example: "QO-002" | No |
| product | ProductResponse | Product Response Example: "product" | No |
| productCode | string | Product code Example: "P00001" | Yes |
| productDescription | string | Product description Example: "Apple watch" | No |
| productOrder | integer | Product view order Example: 1 | No |
| productQuantity | number | Product quantity Example: 2 | Yes |
| quantityFulfilled | number | quantity fulfilled Example: 10 | No |
| quantityFulfilledByFlowover | number | Total Quantity Fulfilled By Flowover | Yes |
| quantityFulfilledByUser | number | Total Quantity Fulfilled By User | Yes |
| reservedQuantitiesData | [ ReservedQuantityData ] | Reserved quantity data Example: [] | No |
| revRecDocumentItemDetails | RevRecDocumentItemDetails | Item Revenue Details Example: "revRecDocumentItemDetails" | No |
| salesInvoiceItemCode | string | Sales Invoice Item Code Example: "SII-000001" | No |
| tax | TaxDto | Tax details Example: "taxDto" | No |
| taxAmount | number | Tax amount Example: 0.5 | No |
| taxCode | string | Tax code Example: "GST7" | No |
| totalAmount | number | Total amount Example: 2.3 | Yes |
| type | string | Product type Enum: "TRACKED", "NONTRACKED"Example: "TRACKED" | Yes |
| unitPrice | number | Product unit price Example: 0.7 | Yes |
| uomQuantity | number | uom quantity Example: 2 | Yes |
| uomUnitPrice | number | UOM Unit price Example: 2.3 | Yes |
| updatedPartialQuantity | number | partial invoice updated quantity Example: 10 | No |
SalesInvoiceItemDetailsMalaysia
| Name | Type | Description | Required |
|---|---|---|---|
| allocationType | string | Allocation Type Example: "NORMAL" | No |
| availableQuantity | number | Total available quantity Example: 3 | No |
| basePrice | number | Revenue Base price Example: 120 | No |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| discount | number | Discount Example: 2 | No |
| discountInPercent | boolean | Discount in percentage Example: true | No |
| documentSequenceCode | string | Product Document Sequence Code Example: "P-0000001" | Yes |
| documentUOMSchemaDefinition | DocumentUOMSchemaDefinition | Document UOM Schema Definition Example: 2 | Yes |
| documentUom | long | Document UOM id Example: 2 | Yes |
| errors | [ string ] | List of validation error messages | No |
| fulfillmentByDoc | [ ItemQtyFulfilledByDoc ] | Item Qty fulfilled by Fulfillment Doc Example: [] | No |
| id | long | ID Example: 2 | No |
| isPartialInvoice | boolean | Whether the Sales Invoice is a partial invoice Example: false | No |
| itemFulfillmentStatus | string | Item Fulfillment Status Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"Example: "UNFULFILLED" | No |
| lineNumber | integer | Line Number Example: 1 | No |
| linkedQuoteItem | long | Quote Item linked to invoice item Example: "QO-001" | No |
| linkedQuoteItemCode | string | Linked quote item code Example: "QO-002" | No |
| product | ProductResponse | Product Response Example: "product" | No |
| productCode | string | Product code Example: "P00001" | Yes |
| productDescription | string | Product description Example: "Apple watch" | No |
| productOrder | integer | Product view order Example: 1 | No |
| productQuantity | number | Product quantity Example: 2 | Yes |
| quantityFulfilled | number | quantity fulfilled Example: 10 | No |
| quantityFulfilledByFlowover | number | Total Quantity Fulfilled By Flowover | Yes |
| quantityFulfilledByUser | number | Total Quantity Fulfilled By User | Yes |
| reservedQuantitiesData | [ ReservedQuantityData ] | Reserved quantity data Example: [] | No |
| revRecDocumentItemDetails | RevRecDocumentItemDetails | Item Revenue Details Example: "revRecDocumentItemDetails" | No |
| salesInvoiceItemCode | string | Sales Invoice Item Code Example: "SII-000001" | No |
| tax | TaxDto | Tax details Example: "taxDto" | No |
| taxAmount | number | Tax amount Example: 0.5 | No |
| taxCode | string | Tax code Example: "GST7" | No |
| totalAmount | number | Total amount Example: 2.3 | Yes |
| type | string | Product type Enum: "TRACKED", "NONTRACKED"Example: "TRACKED" | Yes |
| unitPrice | number | Product unit price Example: 0.7 | Yes |
| uomQuantity | number | uom quantity Example: 2 | Yes |
| uomUnitPrice | number | UOM Unit price Example: 2.3 | Yes |
| updatedPartialQuantity | number | partial invoice updated quantity Example: 10 | No |
SalesInvoiceItemDetailsPhilippines
| Name | Type | Description | Required |
|---|---|---|---|
| allocationType | string | Allocation Type Example: "NORMAL" | No |
| availableQuantity | number | Total available quantity Example: 3 | No |
| basePrice | number | Revenue Base price Example: 120 | No |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| discount | number | Discount Example: 2 | No |
| discountInPercent | boolean | Discount in percentage Example: true | No |
| documentSequenceCode | string | Product Document Sequence Code Example: "P-0000001" | Yes |
| documentUOMSchemaDefinition | DocumentUOMSchemaDefinition | Document UOM Schema Definition Example: 2 | Yes |
| documentUom | long | Document UOM id Example: 2 | Yes |
| errors | [ string ] | List of validation error messages | No |
| fulfillmentByDoc | [ ItemQtyFulfilledByDoc ] | Item Qty fulfilled by Fulfillment Doc Example: [] | No |
| id | long | ID Example: 2 | No |
| isPartialInvoice | boolean | Whether the Sales Invoice is a partial invoice Example: false | No |
| itemFulfillmentStatus | string | Item Fulfillment Status Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"Example: "UNFULFILLED" | No |
| lineNumber | integer | Line Number Example: 1 | No |
| linkedQuoteItem | long | Quote Item linked to invoice item Example: "QO-001" | No |
| linkedQuoteItemCode | string | Linked quote item code Example: "QO-002" | No |
| product | ProductResponse | Product Response Example: "product" | No |
| productCode | string | Product code Example: "P00001" | Yes |
| productDescription | string | Product description Example: "Apple watch" | No |
| productOrder | integer | Product view order Example: 1 | No |
| productQuantity | number | Product quantity Example: 2 | Yes |
| quantityFulfilled | number | quantity fulfilled Example: 10 | No |
| quantityFulfilledByFlowover | number | Total Quantity Fulfilled By Flowover | Yes |
| quantityFulfilledByUser | number | Total Quantity Fulfilled By User | Yes |
| reservedQuantitiesData | [ ReservedQuantityData ] | Reserved quantity data Example: [] | No |
| revRecDocumentItemDetails | RevRecDocumentItemDetails | Item Revenue Details Example: "revRecDocumentItemDetails" | No |
| salesInvoiceItemCode | string | Sales Invoice Item Code Example: "SII-000001" | No |
| tax | TaxDto | Tax details Example: "taxDto" | No |
| taxAmount | number | Tax amount Example: 0.5 | No |
| taxCode | string | Tax code Example: "GST7" | No |
| totalAmount | number | Total amount Example: 2.3 | Yes |
| type | string | Product type Enum: "TRACKED", "NONTRACKED"Example: "TRACKED" | Yes |
| unitPrice | number | Product unit price Example: 0.7 | Yes |
| uomQuantity | number | uom quantity Example: 2 | Yes |
| uomUnitPrice | number | UOM Unit price Example: 2.3 | Yes |
| updatedPartialQuantity | number | partial invoice updated quantity Example: 10 | No |
SalesInvoiceItemDetailsSA
| Name | Type | Description | Required |
|---|---|---|---|
| allocationType | string | Allocation Type Example: "NORMAL" | No |
| availableQuantity | number | Total available quantity Example: 3 | No |
| basePrice | number | Revenue Base price Example: 120 | No |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| discount | number | Discount Example: 2 | No |
| discountInPercent | boolean | Discount in percentage Example: true | No |
| documentSequenceCode | string | Product Document Sequence Code Example: "P-0000001" | Yes |
| documentUOMSchemaDefinition | DocumentUOMSchemaDefinition | Document UOM Schema Definition Example: 2 | Yes |
| documentUom | long | Document UOM id Example: 2 | Yes |
| errors | [ string ] | List of validation error messages | No |
| exciseAmount | number | Excise amount Example: 0.5 | No |
| exciseRate | double | Rate of Excise Example: 5 | No |
| exciseType | string | Excise type Enum: "PERCENT", "FLAT"Example: "FLAT" | No |
| fulfillmentByDoc | [ ItemQtyFulfilledByDoc ] | Item Qty fulfilled by Fulfillment Doc Example: [] | No |
| id | long | ID Example: 2 | No |
| isPartialInvoice | boolean | Whether the Sales Invoice is a partial invoice Example: false | No |
| itemFulfillmentStatus | string | Item Fulfillment Status Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"Example: "UNFULFILLED" | No |
| lineNumber | integer | Line Number Example: 1 | No |
| linkedQuoteItem | long | Quote Item linked to invoice item Example: "QO-001" | No |
| linkedQuoteItemCode | string | Linked quote item code Example: "QO-002" | No |
| product | ProductResponse | Product Response Example: "product" | No |
| productCode | string | Product code Example: "P00001" | Yes |
| productDescription | string | Product description Example: "Apple watch" | No |
| productOrder | integer | Product view order Example: 1 | No |
| productQuantity | number | Product quantity Example: 2 | Yes |
| quantityFulfilled | number | quantity fulfilled Example: 10 | No |
| quantityFulfilledByFlowover | number | Total Quantity Fulfilled By Flowover | Yes |
| quantityFulfilledByUser | number | Total Quantity Fulfilled By User | Yes |
| reservedQuantitiesData | [ ReservedQuantityData ] | Reserved quantity data Example: [] | No |
| revRecDocumentItemDetails | RevRecDocumentItemDetails | Item Revenue Details Example: "revRecDocumentItemDetails" | No |
| salesInvoiceItemCode | string | Sales Invoice Item Code Example: "SII-000001" | No |
| tax | TaxDto | Tax details Example: "taxDto" | No |
| taxAmount | number | Tax amount Example: 0.5 | No |
| taxCode | string | Tax code Example: "GST7" | No |
| totalAmount | number | Total amount Example: 2.3 | Yes |
| type | string | Product type Enum: "TRACKED", "NONTRACKED"Example: "TRACKED" | Yes |
| unitPrice | number | Product unit price Example: 0.7 | Yes |
| uomQuantity | number | uom quantity Example: 2 | Yes |
| uomUnitPrice | number | UOM Unit price Example: 2.3 | Yes |
| updatedPartialQuantity | number | partial invoice updated quantity Example: 10 | No |
SalesInvoiceItemDetailsUae
| Name | Type | Description | Required |
|---|---|---|---|
| allocationType | string | Allocation Type Example: "NORMAL" | No |
| availableQuantity | number | Total available quantity Example: 3 | No |
| basePrice | number | Revenue Base price Example: 120 | No |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| discount | number | Discount Example: 2 | No |
| discountInPercent | boolean | Discount in percentage Example: true | No |
| documentSequenceCode | string | Product Document Sequence Code Example: "P-0000001" | Yes |
| documentUOMSchemaDefinition | DocumentUOMSchemaDefinition | Document UOM Schema Definition Example: 2 | Yes |
| documentUom | long | Document UOM id Example: 2 | Yes |
| errors | [ string ] | List of validation error messages | No |
| exciseAmount | number | Excise amount Example: 0.5 | No |
| exciseRate | double | Rate of Excise Example: 5 | No |
| exciseType | string | Excise type Enum: "PERCENT", "FLAT"Example: "FLAT" | No |
| fulfillmentByDoc | [ ItemQtyFulfilledByDoc ] | Item Qty fulfilled by Fulfillment Doc Example: [] | No |
| id | long | ID Example: 2 | No |
| isPartialInvoice | boolean | Whether the Sales Invoice is a partial invoice Example: false | No |
| itemFulfillmentStatus | string | Item Fulfillment Status Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"Example: "UNFULFILLED" | No |
| lineNumber | integer | Line Number Example: 1 | No |
| linkedQuoteItem | long | Quote Item linked to invoice item Example: "QO-001" | No |
| linkedQuoteItemCode | string | Linked quote item code Example: "QO-002" | No |
| product | ProductResponse | Product Response Example: "product" | No |
| productCode | string | Product code Example: "P00001" | Yes |
| productDescription | string | Product description Example: "Apple watch" | No |
| productOrder | integer | Product view order Example: 1 | No |
| productQuantity | number | Product quantity Example: 2 | Yes |
| quantityFulfilled | number | quantity fulfilled Example: 10 | No |
| quantityFulfilledByFlowover | number | Total Quantity Fulfilled By Flowover | Yes |
| quantityFulfilledByUser | number | Total Quantity Fulfilled By User | Yes |
| reservedQuantitiesData | [ ReservedQuantityData ] | Reserved quantity data Example: [] | No |
| revRecDocumentItemDetails | RevRecDocumentItemDetails | Item Revenue Details Example: "revRecDocumentItemDetails" | No |
| salesInvoiceItemCode | string | Sales Invoice Item Code Example: "SII-000001" | No |
| tax | TaxDto | Tax details Example: "taxDto" | No |
| taxAmount | number | Tax amount Example: 0.5 | No |
| taxCode | string | Tax code Example: "GST7" | No |
| totalAmount | number | Total amount Example: 2.3 | Yes |
| type | string | Product type Enum: "TRACKED", "NONTRACKED"Example: "TRACKED" | Yes |
| unitPrice | number | Product unit price Example: 0.7 | Yes |
| uomQuantity | number | uom quantity Example: 2 | Yes |
| uomUnitPrice | number | UOM Unit price Example: 2.3 | Yes |
| updatedPartialQuantity | number | partial invoice updated quantity Example: 10 | No |
SalesInvoiceItemDetailsUk
| Name | Type | Description | Required |
|---|---|---|---|
| allocationType | string | Allocation Type Example: "NORMAL" | No |
| availableQuantity | number | Total available quantity Example: 3 | No |
| basePrice | number | Revenue Base price Example: 120 | No |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| discount | number | Discount Example: 2 | No |
| discountInPercent | boolean | Discount in percentage Example: true | No |
| documentSequenceCode | string | Product Document Sequence Code Example: "P-0000001" | Yes |
| documentUOMSchemaDefinition | DocumentUOMSchemaDefinition | Document UOM Schema Definition Example: 2 | Yes |
| documentUom | long | Document UOM id Example: 2 | Yes |
| errors | [ string ] | List of validation error messages | No |
| fulfillmentByDoc | [ ItemQtyFulfilledByDoc ] | Item Qty fulfilled by Fulfillment Doc Example: [] | No |
| id | long | ID Example: 2 | No |
| isPartialInvoice | boolean | Whether the Sales Invoice is a partial invoice Example: false | No |
| itemFulfillmentStatus | string | Item Fulfillment Status Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"Example: "UNFULFILLED" | No |
| lineNumber | integer | Line Number Example: 1 | No |
| linkedQuoteItem | long | Quote Item linked to invoice item Example: "QO-001" | No |
| linkedQuoteItemCode | string | Linked quote item code Example: "QO-002" | No |
| product | ProductResponse | Product Response Example: "product" | No |
| productCode | string | Product code Example: "P00001" | Yes |
| productDescription | string | Product description Example: "Apple watch" | No |
| productOrder | integer | Product view order Example: 1 | No |
| productQuantity | number | Product quantity Example: 2 | Yes |
| quantityFulfilled | number | quantity fulfilled Example: 10 | No |
| quantityFulfilledByFlowover | number | Total Quantity Fulfilled By Flowover | Yes |
| quantityFulfilledByUser | number | Total Quantity Fulfilled By User | Yes |
| reservedQuantitiesData | [ ReservedQuantityData ] | Reserved quantity data Example: [] | No |
| revRecDocumentItemDetails | RevRecDocumentItemDetails | Item Revenue Details Example: "revRecDocumentItemDetails" | No |
| salesInvoiceItemCode | string | Sales Invoice Item Code Example: "SII-000001" | No |
| tax | TaxDto | Tax details Example: "taxDto" | No |
| taxAmount | number | Tax amount Example: 0.5 | No |
| taxCode | string | Tax code Example: "GST7" | No |
| totalAmount | number | Total amount Example: 2.3 | Yes |
| type | string | Product type Enum: "TRACKED", "NONTRACKED"Example: "TRACKED" | Yes |
| unitPrice | number | Product unit price Example: 0.7 | Yes |
| uomQuantity | number | uom quantity Example: 2 | Yes |
| uomUnitPrice | number | UOM Unit price Example: 2.3 | Yes |
| updatedPartialQuantity | number | partial invoice updated quantity Example: 10 | No |
SalesInvoiceItemInformation
| Name | Type | Description | Required |
|---|---|---|---|
| allocationType | string | Allocation Type Example: "NORMAL" | No |
| availableQuantity | number | Total available quantity Example: 3 | No |
| basePrice | number | Revenue Base price Example: 120 | No |
| cessAmount | number | cess amount Example: 40 | No |
| cessPercentage | number | Cess Percentage Example: 2.322 | No |
| cessRule | string | Cess rule expression Example: "Math.max(21amount/100,4170quantity/1000)" | No |
| cgstAmount | number | CGST tax amount Example: 60 | No |
| cgstRate | number | CGST tax rate Example: 6 | No |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| discount | number | Discount Example: 2 | No |
| discountInPercent | boolean | Discount in percentage Example: true | No |
| documentSequenceCode | string | Product Document Sequence Code Example: "P-0000001" | Yes |
| documentUOMSchemaDefinition | DocumentUOMSchemaDefinition | Document UOM Schema Definition Example: 2 | Yes |
| documentUom | long | Document UOM id Example: 2 | Yes |
| exciseAmount | number | Excise amount Example: 0.5 | No |
| exciseRate | double | Rate of Excise Example: 5 | No |
| exciseType | string | Excise type Enum: "PERCENT", "FLAT"Example: "FLAT" | No |
| fulfillmentByDoc | [ ItemQtyFulfilledByDoc ] | Quantity fulfilled docs | No |
| hsnOrSacCode | string | Hsn or Sac code Example: 110011 | No |
| id | long | ID Example: 2 | No |
| igstAmount | number | IGST tax amount Example: 120 | No |
| igstRate | number | IGST tax rate Example: 12 | No |
| invoiceLineNumber | string | Invoice Line Number Example: "ABSCDDSD1212" | No |
| isPartialInvoice | boolean | Whether the Sales Invoice is a partial invoice Example: false | No |
| lineNumber | integer | Line Number Example: 1 | No |
| linkedQuoteItem | long | Quote Item linked to invoice item Example: "QO-001" | No |
| otherRate | number | Other Tax total Rate Example: 12 | No |
| otherTaxAmount | number | Other tax amount Example: 60 | No |
| product | ProductInformation | Product Response Example: "product" | No |
| productCode | string | Product code Example: "P00001" | Yes |
| productDescription | string | Product description Example: "Apple watch" | No |
| productOrder | integer | Product view order Example: 1 | No |
| productQuantity | number | Product quantity Example: 2 | Yes |
| quantityFulfilled | number | quantity fulfilled Example: 10 | No |
| reservedQuantitiesData | [ ReservedQuantityData ] | Reserved quantity data Example: [] | No |
| revRecDocumentItemDetails | RevRecDocumentItemDetails | Item Revenue Details Example: "revRecDocumentItemDetails" | No |
| salesInvoiceItemCode | string | Sales Invoice Item Code Example: "SII-000001" | No |
| sgstAmount | number | SGST tax amount Example: 60 | No |
| sgstRate | number | SGST tax rate Example: 6 | No |
| tax | TaxDto | Tax details Example: "taxDto" | No |
| taxAmount | number | Tax amount Example: 0.5 | No |
| taxCode | string | Tax code Example: "GST7" | No |
| taxDetails | [ DocumentItemTaxMappingDto ] | Tax Details for Tax Group | No |
| taxExemptionReason | string | Tax Exemption reason if taxPreference is true Enum: "EXEMPTED", "NON_GST"Example: "EXEMPTED" | No |
| taxPreference | boolean | Tax preference, whether Exempted or not Exempted Example: false | No |
| totalAmount | number | Total amount Example: 2.3 | Yes |
| type | string | Product type Enum: "TRACKED", "NONTRACKED"Example: "TRACKED" | Yes |
| unitPrice | number | Product unit price Example: 0.7 | Yes |
| uomQuantity | number | uom quantity Example: 2 | Yes |
| uomUnitPrice | number | UOM Unit price Example: 2.3 | Yes |
| updatedPartialQuantity | number | partial invoice updated quantity Example: 10 | No |
| userSetTaxes | boolean | Flag to check whether tax is user edited Example: false | No |
SalesInvoiceRecurringDetails
| Name | Type | Description | Required |
|---|---|---|---|
| id | long | ID Example: 2 | No |
| invoiceRecurringCount | integer | Number of Invoices to be created Example: 1 | Yes |
| recurrenceEndDate | string | Recurrence End date Example: "25-10-2019" | Yes |
| recurrenceFrequency | string | Days, Weeks or Months Enum: "DAYS", "WEEK", "MONTH"Example: "WEEK" | Yes |
| recurrenceType | integer | Every x Days/Weeks/Months Example: 1 | Yes |
SalesInvoiceRequest
| Name | Type | Description | Required |
|---|---|---|---|
| additionalCharges | AdditionalCharges | Purchase invoice additional charges details | No |
| approvalStatus | string | Approval status Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"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 Example: "BR-0001" | No |
| contact | ContactInfo | Contact details | Yes |
| contactCode | string | Contact Code Example: "C0001" | Yes |
| createdBy | long | Identifier of the user who created the invoice Example: 1 | No |
| createdDate | string | Date on which the invoice was created Example: "25-10-2019" | No |
| currency | string | Currency Example: "C001" | Yes |
| customerOrderNumber | string | Customer order number Example: "CO-0001" | No |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| documentSequenceCode | string | Sales Invoice Code Example: "0000001" | No |
| draft | boolean | True if want to save as draft. Example: false | No |
| draftReferenceId | string | Draft reference id Example: "DR-0001" | No |
| draftSeqCode | string | Draft sequence code Example: "DS-0001" | No |
| dropShip | boolean | Drop Ship flag to indicate if purchase invoice is created for drop ship Example: true | No |
| dueAmount | number | Amount Due Example: 12.322 | No |
| eInvoiceStatus | [ object ] | List of e-invoice status details | No |
| errors | [ string ] | List of validation error messages | No |
| exchangeRate | number | Exchange rate Example: 0.456345 | No |
| fulfillmentComplete | boolean | True if auto fulfilled is required. Example: false | No |
| fulfillmentStatus | string | fulfillment status Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"Example: "PARTIAL_FULFILLED" | No |
| fulfillmentType | string | Fulfillment type: NONE, DEFAULT, PICK_PACK_SHIP, DROP_SHIP Enum: "NONE", "DEFAULT", "PICK_PACK_SHIP", "DROP_SHIP"Example: "PICK_PACK_SHIP" | 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 |
| journalEntryCode | string | Journal Entry Code Example: "JE0001" | No |
| linkedDocuments | [ DocumentInfo ] | Linked Documents | No |
| memo | string | Memo Example: "Memo details" | No |
| multiApprovalDetails | object | Multi-level approval details | No |
| openingDocumentNumber | string | Customer opening document number Example: "DC-0001" | No |
| openingInvoice | boolean | True if opening invoice Example: false | No |
| paymentInformation | PaymentInformation | Payment information | 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 |
| poNumber | string | Purchase order number Example: "PO-0001" | No |
| primaryExchangeRate | number | Primary exchange rate Example: 1 | No |
| purchaseOrderRefNo | string | Contact PO reference number Example: "CPO001" | 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 Example: 1 | No |
| reservedStock | boolean | Reserved stock enabled Example: true | 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 |
| salesInvoiceDate | string | Sales Invoice date Example: "25-10-2019" | Yes |
| salesInvoiceDueDate | string | Sales Invoice due date Example: "25-10-2019" | Yes |
| salesInvoiceItems | [ SalesInvoiceItemDetails ] | Sales invoice item details | No |
| salesInvoiceRecurring | SalesInvoiceRecurringDetails | Sales invoice item details | 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 Example: "SENT" | No |
| sgEInvoiceStatus | string | Singapore e-invoice status Example: "SENT" | No |
| shipByDate | string | Ship by date Example: "25-10-2019" | No |
| shipFrom | Address | Ship from address | No |
| shipTo | Address | Ship to address | No |
| status | string | Invoice status Enum: "OPEN", "DRAFT", "CLOSED"Example: "OPEN" | 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 |
| unitPriceGstInclusive | boolean | Unit price is GST inclusive Example: false | No |
| warehouseCode | string | Warehouse Code Example: "WH-000001" | No |
SalesInvoiceRequestAustralia
| Name | Type | Description | Required |
|---|---|---|---|
| additionalCharges | AdditionalCharges | Purchase invoice additional charges details | No |
| approvalStatus | string | Approval status Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"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 |
| contact | ContactInfo | Contact details | Yes |
| contactCode | string | Contact Code Example: "C0001" | Yes |
| currency | string | Currency Example: "C001" | Yes |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| documentSequenceCode | string | Sales Invoice Code Example: "0000001" | No |
| draft | boolean | True if want to save as draft. Example: false | No |
| dropShip | boolean | Drop Ship flag to indicate if purchase invoice is created for drop ship Example: true | No |
| dueAmount | number | Amount Due Example: 12.322 | No |
| errors | [ string ] | List of validation error messages | No |
| exchangeRate | number | Exchange rate Example: 0.456345 | No |
| fulfillmentComplete | boolean | True if auto fulfilled is required. Example: false | No |
| fulfillmentStatus | string | fulfillment status Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"Example: "PARTIAL_FULFILLED" | No |
| fulfillmentType | string | Fulfillment type: NONE, DEFAULT, PICK_PACK_SHIP, DROP_SHIP Enum: "NONE", "DEFAULT", "PICK_PACK_SHIP", "DROP_SHIP"Example: "PICK_PACK_SHIP" | 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 |
| journalEntryCode | string | Journal Entry Code Example: "JE0001" | No |
| linkedDocuments | [ DocumentInfo ] | Linked Documents | No |
| memo | string | Memo Example: "Memo details" | No |
| openingDocumentNumber | string | Customer opening document number Example: "DC-0001" | No |
| openingInvoice | boolean | True if opening invoice Example: false | No |
| paymentInformation | PaymentInformation | Payment information | 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 |
| purchaseOrderRefNo | string | Contact PO reference number Example: "CPO001" | No |
| recurring | boolean | True if Invoice is recurring. Example: true | No |
| recurringActivated | boolean | True if Invoice recurrence is active. Example: false | No |
| reservedStock | boolean | Reserved stock enabled Example: true | 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 |
| salesInvoiceDate | string | Sales Invoice date Example: "25-10-2019" | Yes |
| salesInvoiceDueDate | string | Sales Invoice due date Example: "25-10-2019" | Yes |
| salesInvoiceItems | [ SalesInvoiceItemDetailsAustralia ] | Sales invoice item details | No |
| salesInvoiceRecurring | SalesInvoiceRecurringDetails | Sales invoice item details | No |
| seqCodeAlreadyDumped | boolean | True if Sequence Code is already dumped. Example: false | No |
| sequenceFormat | string | Sequence Format Id Example: 1 | No |
| shipByDate | string | Ship by date Example: "25-10-2019" | No |
| shipFrom | Address | Ship from address | No |
| shipTo | Address | Ship to address | No |
| status | string | Invoice status Enum: "OPEN", "DRAFT", "CLOSED"Example: "OPEN" | 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 |
| unitPriceGstInclusive | boolean | Unit price is GST inclusive Example: false | No |
| warehouseCode | string | Warehouse Code Example: "WH-000001" | No |
SalesInvoiceRequestCanada
| Name | Type | Description | Required |
|---|---|---|---|
| additionalCharges | AdditionalCharges | Purchase invoice additional charges details | No |
| approvalStatus | string | Approval status Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"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 |
| contact | ContactInfo | Contact details | Yes |
| contactCode | string | Contact Code Example: "C0001" | Yes |
| currency | string | Currency Example: "C001" | Yes |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| documentSequenceCode | string | Sales Invoice Code Example: "0000001" | No |
| draft | boolean | True if want to save as draft. Example: false | No |
| dropShip | boolean | Drop Ship flag to indicate if purchase invoice is created for drop ship Example: true | No |
| dueAmount | number | Amount Due Example: 12.322 | No |
| errors | [ string ] | List of validation error messages | No |
| exchangeRate | number | Exchange rate Example: 0.456345 | No |
| fulfillmentComplete | boolean | True if auto fulfilled is required. Example: false | No |
| fulfillmentStatus | string | fulfillment status Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"Example: "PARTIAL_FULFILLED" | No |
| fulfillmentType | string | Fulfillment type: NONE, DEFAULT, PICK_PACK_SHIP, DROP_SHIP Enum: "NONE", "DEFAULT", "PICK_PACK_SHIP", "DROP_SHIP"Example: "PICK_PACK_SHIP" | 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 |
| journalEntryCode | string | Journal Entry Code Example: "JE0001" | No |
| linkedDocuments | [ DocumentInfo ] | Linked Documents | No |
| memo | string | Memo Example: "Memo details" | No |
| openingDocumentNumber | string | Customer opening document number Example: "DC-0001" | No |
| openingInvoice | boolean | True if opening invoice Example: false | No |
| paymentInformation | PaymentInformation | Payment information | 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 |
| purchaseOrderRefNo | string | Contact PO reference number Example: "CPO001" | No |
| recurring | boolean | True if Invoice is recurring. Example: true | No |
| recurringActivated | boolean | True if Invoice recurrence is active. Example: false | No |
| reservedStock | boolean | Reserved stock enabled Example: true | 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 |
| salesInvoiceDate | string | Sales Invoice date Example: "25-10-2019" | Yes |
| salesInvoiceDueDate | string | Sales Invoice due date Example: "25-10-2019" | Yes |
| salesInvoiceItems | [ SalesInvoiceItemDetailsCanada ] | Sales invoice item details | No |
| salesInvoiceRecurring | SalesInvoiceRecurringDetails | Sales invoice item details | No |
| seqCodeAlreadyDumped | boolean | True if Sequence Code is already dumped. Example: false | No |
| sequenceFormat | string | Sequence Format Id Example: 1 | No |
| shipByDate | string | Ship by date Example: "25-10-2019" | No |
| shipFrom | Address | Ship from address | No |
| shipTo | Address | Ship to address | No |
| status | string | Invoice status Enum: "OPEN", "DRAFT", "CLOSED"Example: "OPEN" | 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 |
| unitPriceGstInclusive | boolean | Unit price is GST inclusive Example: false | No |
| warehouseCode | string | Warehouse Code Example: "WH-000001" | No |
SalesInvoiceRequestGermany
| Name | Type | Description | Required |
|---|---|---|---|
| additionalCharges | AdditionalCharges | Purchase invoice additional charges details | No |
| approvalStatus | string | Approval status Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"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 |
| contact | ContactInfo | Contact details | Yes |
| contactCode | string | Contact Code Example: "C0001" | Yes |
| currency | string | Currency Example: "C001" | Yes |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| documentSequenceCode | string | Sales Invoice Code Example: "0000001" | No |
| draft | boolean | True if want to save as draft. Example: false | No |
| dropShip | boolean | Drop Ship flag to indicate if purchase invoice is created for drop ship Example: true | No |
| dueAmount | number | Amount Due Example: 12.322 | No |
| errors | [ string ] | List of validation error messages | No |
| exchangeRate | number | Exchange rate Example: 0.456345 | No |
| fulfillmentComplete | boolean | True if auto fulfilled is required. Example: false | No |
| fulfillmentStatus | string | fulfillment status Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"Example: "PARTIAL_FULFILLED" | No |
| fulfillmentType | string | Fulfillment type: NONE, DEFAULT, PICK_PACK_SHIP, DROP_SHIP Enum: "NONE", "DEFAULT", "PICK_PACK_SHIP", "DROP_SHIP"Example: "PICK_PACK_SHIP" | 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 |
| journalEntryCode | string | Journal Entry Code Example: "JE0001" | No |
| linkedDocuments | [ DocumentInfo ] | Linked Documents | No |
| memo | string | Memo Example: "Memo details" | No |
| openingDocumentNumber | string | Customer opening document number Example: "DC-0001" | No |
| openingInvoice | boolean | True if opening invoice Example: false | No |
| paymentInformation | PaymentInformation | Payment information | 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 |
| purchaseOrderRefNo | string | Contact PO reference number Example: "CPO001" | No |
| recurring | boolean | True if Invoice is recurring. Example: true | No |
| recurringActivated | boolean | True if Invoice recurrence is active. Example: false | No |
| reservedStock | boolean | Reserved stock enabled Example: true | 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 |
| salesInvoiceDate | string | Sales Invoice date Example: "25-10-2019" | Yes |
| salesInvoiceDueDate | string | Sales Invoice due date Example: "25-10-2019" | Yes |
| salesInvoiceItems | [ SalesInvoiceItemDetailsGermany ] | Sales invoice item details | No |
| salesInvoiceRecurring | SalesInvoiceRecurringDetails | Sales invoice item details | No |
| seqCodeAlreadyDumped | boolean | True if Sequence Code is already dumped. Example: false | No |
| sequenceFormat | string | Sequence Format Id Example: 1 | No |
| shipByDate | string | Ship by date Example: "25-10-2019" | No |
| shipFrom | Address | Ship from address | No |
| shipTo | Address | Ship to address | No |
| status | string | Invoice status Enum: "OPEN", "DRAFT", "CLOSED"Example: "OPEN" | 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 |
| unitPriceGstInclusive | boolean | Unit price is GST inclusive Example: false | No |
| warehouseCode | string | Warehouse Code Example: "WH-000001" | No |
SalesInvoiceRequestIndia
| Name | Type | Description | Required |
|---|---|---|---|
| additionalCharges | AdditionalCharges | Purchase invoice additional charges details | No |
| approvalStatus | string | Approval status Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"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 |
| contact | ContactInfo | Contact details | Yes |
| contactCode | string | Contact Code Example: "C0001" | Yes |
| currency | string | Currency Example: "C001" | Yes |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| customerType | string | Customer Type Enum: "EXPORT_WO_PAY", "EXPORT_W_PAY", "NA", "SEZ_WO_PAY", "SEZ_W_PAY"Example: "NA" | Yes |
| documentSequenceCode | string | Sales Invoice Code Example: "0000001" | No |
| draft | boolean | True if want to save as draft. Example: false | No |
| dropShip | boolean | Drop Ship flag to indicate if purchase invoice is created for drop ship Example: true | No |
| dueAmount | number | Amount Due Example: 12.322 | No |
| errors | [ string ] | List of validation error messages | No |
| exchangeRate | number | Exchange rate Example: 0.456345 | No |
| fulfillmentComplete | boolean | True if auto fulfilled is required. Example: false | No |
| fulfillmentStatus | string | fulfillment status Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"Example: "PARTIAL_FULFILLED" | No |
| fulfillmentType | string | Fulfillment type: NONE, DEFAULT, PICK_PACK_SHIP, DROP_SHIP Enum: "NONE", "DEFAULT", "PICK_PACK_SHIP", "DROP_SHIP"Example: "PICK_PACK_SHIP" | No |
| gstExchangeRate | number | GST Exchange rate if tax residency currency is different than base currency Example: 1 | No |
| gstTreatment | string | GST Treatment Enum: "REGISTERED_BUSINESS_REGULAR=Registered Business - Regular", "REGISTERED_BUSINESS_COMPOSITION=Registered Business - Composition", "UNREGISTERED_BUSINESS=Unregistered Business", "CUSTOMER=Consumer", "OVERSEAS=Overseas", "SPECIAL_ECONOMIC_ZONE=Special Economic Zone", "DEEMED_EXPORT=Deemed Export"Example: "REGISTERED_BUSINESS_REGULAR" | Yes |
| gstin | string | GSTIN Example: "ABSASASSASASA198" | Yes |
| isPartialInvoice | boolean | True if is partial invoice Example: false | No |
| journalEntryCode | string | Journal Entry Code Example: "JE0001" | No |
| linkedDocuments | [ DocumentInfo ] | Linked Documents | No |
| memo | string | Memo Example: "Memo details" | No |
| openingDocumentNumber | string | Customer opening document number Example: "DC-0001" | No |
| openingInvoice | boolean | True if opening invoice Example: false | No |
| paymentInformation | PaymentInformation | Payment information | 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 |
| placeOfSupply | string | state in India Example: "Punjab" | Yes |
| purchaseOrderRefNo | string | Contact PO reference number Example: "CPO001" | No |
| recurring | boolean | True if Invoice is recurring. Example: true | No |
| recurringActivated | boolean | True if Invoice recurrence is active. Example: false | No |
| reservedStock | boolean | Reserved stock enabled Example: true | 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 |
| salesInvoiceDate | string | Sales Invoice date Example: "25-10-2019" | Yes |
| salesInvoiceDueDate | string | Sales Invoice due date Example: "25-10-2019" | Yes |
| salesInvoiceItems | [ SalesInvoiceItemDetailsIndia ] | Sales invoice item details | No |
| salesInvoiceRecurring | SalesInvoiceRecurringDetails | Sales invoice item details | No |
| seqCodeAlreadyDumped | boolean | True if Sequence Code is already dumped. Example: false | No |
| sequenceFormat | string | Sequence Format Id Example: 1 | No |
| shipByDate | string | Ship by date Example: "25-10-2019" | No |
| shipFrom | Address | Ship from address | No |
| shipTo | Address | Ship to address | No |
| status | string | Invoice status Enum: "OPEN", "DRAFT", "CLOSED"Example: "OPEN" | 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 |
| unitPriceGstInclusive | boolean | Unit price is GST inclusive Example: false | No |
| vendorType | string | Vendor Type Enum: "IMPORT", "NA", "SEZ_W_PAY", "SEZ_WO_PAY"Example: "NA" | Yes |
| warehouseCode | string | Warehouse Code Example: "WH-000001" | No |
SalesInvoiceRequestIndonesia
| Name | Type | Description | Required |
|---|---|---|---|
| additionalCharges | AdditionalCharges | Purchase invoice additional charges details | No |
| approvalStatus | string | Approval status Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"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 |
| contact | ContactInfo | Contact details | Yes |
| contactCode | string | Contact Code Example: "C0001" | Yes |
| currency | string | Currency Example: "C001" | Yes |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| documentSequenceCode | string | Sales Invoice Code Example: "0000001" | No |
| draft | boolean | True if want to save as draft. Example: false | No |
| dropShip | boolean | Drop Ship flag to indicate if purchase invoice is created for drop ship Example: true | No |
| dueAmount | number | Amount Due Example: 12.322 | No |
| errors | [ string ] | List of validation error messages | No |
| exchangeRate | number | Exchange rate Example: 0.456345 | No |
| fulfillmentComplete | boolean | True if auto fulfilled is required. Example: false | No |
| fulfillmentStatus | string | fulfillment status Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"Example: "PARTIAL_FULFILLED" | No |
| fulfillmentType | string | Fulfillment type: NONE, DEFAULT, PICK_PACK_SHIP, DROP_SHIP Enum: "NONE", "DEFAULT", "PICK_PACK_SHIP", "DROP_SHIP"Example: "PICK_PACK_SHIP" | 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 |
| journalEntryCode | string | Journal Entry Code Example: "JE0001" | No |
| linkedDocuments | [ DocumentInfo ] | Linked Documents | No |
| memo | string | Memo Example: "Memo details" | No |
| openingDocumentNumber | string | Customer opening document number Example: "DC-0001" | No |
| openingInvoice | boolean | True if opening invoice Example: false | No |
| paymentInformation | PaymentInformation | Payment information | 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 |
| purchaseOrderRefNo | string | Contact PO reference number Example: "CPO001" | No |
| recurring | boolean | True if Invoice is recurring. Example: true | No |
| recurringActivated | boolean | True if Invoice recurrence is active. Example: false | No |
| reservedStock | boolean | Reserved stock enabled Example: true | 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 |
| salesInvoiceDate | string | Sales Invoice date Example: "25-10-2019" | Yes |
| salesInvoiceDueDate | string | Sales Invoice due date Example: "25-10-2019" | Yes |
| salesInvoiceItems | [ SalesInvoiceItemDetailsIndonesia ] | Sales invoice item details | No |
| salesInvoiceRecurring | SalesInvoiceRecurringDetails | Sales invoice item details | No |
| seqCodeAlreadyDumped | boolean | True if Sequence Code is already dumped. Example: false | No |
| sequenceFormat | string | Sequence Format Id Example: 1 | No |
| shipByDate | string | Ship by date Example: "25-10-2019" | No |
| shipFrom | Address | Ship from address | No |
| shipTo | Address | Ship to address | No |
| status | string | Invoice status Enum: "OPEN", "DRAFT", "CLOSED"Example: "OPEN" | No |
| taxAmount | number | Tax amount Example: 2.322 | No |
| taxInvoiceNo | string | Tax Invoice No Example: 123456789 | 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 |
| unitPriceGstInclusive | boolean | Unit price is GST inclusive Example: false | No |
| warehouseCode | string | Warehouse Code Example: "WH-000001" | No |
SalesInvoiceRequestIsrael
| Name | Type | Description | Required |
|---|---|---|---|
| additionalCharges | AdditionalCharges | Purchase invoice additional charges details | No |
| approvalStatus | string | Approval status Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"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 |
| contact | ContactInfo | Contact details | Yes |
| contactCode | string | Contact Code Example: "C0001" | Yes |
| currency | string | Currency Example: "C001" | Yes |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| documentSequenceCode | string | Sales Invoice Code Example: "0000001" | No |
| draft | boolean | True if want to save as draft. Example: false | No |
| dropShip | boolean | Drop Ship flag to indicate if purchase invoice is created for drop ship Example: true | No |
| dueAmount | number | Amount Due Example: 12.322 | No |
| errors | [ string ] | List of validation error messages | No |
| exchangeRate | number | Exchange rate Example: 0.456345 | No |
| fulfillmentComplete | boolean | True if auto fulfilled is required. Example: false | No |
| fulfillmentStatus | string | fulfillment status Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"Example: "PARTIAL_FULFILLED" | No |
| fulfillmentType | string | Fulfillment type: NONE, DEFAULT, PICK_PACK_SHIP, DROP_SHIP Enum: "NONE", "DEFAULT", "PICK_PACK_SHIP", "DROP_SHIP"Example: "PICK_PACK_SHIP" | 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 |
| journalEntryCode | string | Journal Entry Code Example: "JE0001" | No |
| linkedDocuments | [ DocumentInfo ] | Linked Documents | No |
| memo | string | Memo Example: "Memo details" | No |
| openingDocumentNumber | string | Customer opening document number Example: "DC-0001" | No |
| openingInvoice | boolean | True if opening invoice Example: false | No |
| paymentInformation | PaymentInformation | Payment information | 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 |
| purchaseOrderRefNo | string | Contact PO reference number Example: "CPO001" | No |
| recurring | boolean | True if Invoice is recurring. Example: true | No |
| recurringActivated | boolean | True if Invoice recurrence is active. Example: false | No |
| reservedStock | boolean | Reserved stock enabled Example: true | 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 |
| salesInvoiceDate | string | Sales Invoice date Example: "25-10-2019" | Yes |
| salesInvoiceDueDate | string | Sales Invoice due date Example: "25-10-2019" | Yes |
| salesInvoiceItems | [ SalesInvoiceItemDetailsIsrael ] | Sales invoice item details | No |
| salesInvoiceRecurring | SalesInvoiceRecurringDetails | Sales invoice item details | No |
| seqCodeAlreadyDumped | boolean | True if Sequence Code is already dumped. Example: false | No |
| sequenceFormat | string | Sequence Format Id Example: 1 | No |
| shipByDate | string | Ship by date Example: "25-10-2019" | No |
| shipFrom | Address | Ship from address | No |
| shipTo | Address | Ship to address | No |
| status | string | Invoice status Enum: "OPEN", "DRAFT", "CLOSED"Example: "OPEN" | 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 |
| unitPriceGstInclusive | boolean | Unit price is GST inclusive Example: false | No |
| warehouseCode | string | Warehouse Code Example: "WH-000001" | No |
SalesInvoiceRequestMalaysia
| Name | Type | Description | Required |
|---|---|---|---|
| additionalCharges | AdditionalCharges | Purchase invoice additional charges details | No |
| approvalStatus | string | Approval status Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"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 |
| contact | ContactInfo | Contact details | Yes |
| contactCode | string | Contact Code Example: "C0001" | Yes |
| currency | string | Currency Example: "C001" | Yes |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| documentSequenceCode | string | Sales Invoice Code Example: "0000001" | No |
| draft | boolean | True if want to save as draft. Example: false | No |
| dropShip | boolean | Drop Ship flag to indicate if purchase invoice is created for drop ship Example: true | No |
| dueAmount | number | Amount Due Example: 12.322 | No |
| errors | [ string ] | List of validation error messages | No |
| exchangeRate | number | Exchange rate Example: 0.456345 | No |
| fulfillmentComplete | boolean | True if auto fulfilled is required. Example: false | No |
| fulfillmentStatus | string | fulfillment status Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"Example: "PARTIAL_FULFILLED" | No |
| fulfillmentType | string | Fulfillment type: NONE, DEFAULT, PICK_PACK_SHIP, DROP_SHIP Enum: "NONE", "DEFAULT", "PICK_PACK_SHIP", "DROP_SHIP"Example: "PICK_PACK_SHIP" | 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 |
| journalEntryCode | string | Journal Entry Code Example: "JE0001" | No |
| linkedDocuments | [ DocumentInfo ] | Linked Documents | No |
| memo | string | Memo Example: "Memo details" | No |
| openingDocumentNumber | string | Customer opening document number Example: "DC-0001" | No |
| openingInvoice | boolean | True if opening invoice Example: false | No |
| paymentInformation | PaymentInformation | Payment information | 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 |
| purchaseOrderRefNo | string | Contact PO reference number Example: "CPO001" | No |
| recurring | boolean | True if Invoice is recurring. Example: true | No |
| recurringActivated | boolean | True if Invoice recurrence is active. Example: false | No |
| reservedStock | boolean | Reserved stock enabled Example: true | 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 |
| salesInvoiceDate | string | Sales Invoice date Example: "25-10-2019" | Yes |
| salesInvoiceDueDate | string | Sales Invoice due date Example: "25-10-2019" | Yes |
| salesInvoiceItems | [ SalesInvoiceItemDetailsMalaysia ] | Sales invoice item details | No |
| salesInvoiceRecurring | SalesInvoiceRecurringDetails | Sales invoice item details | No |
| seqCodeAlreadyDumped | boolean | True if Sequence Code is already dumped. Example: false | No |
| sequenceFormat | string | Sequence Format Id Example: 1 | No |
| shipByDate | string | Ship by date Example: "25-10-2019" | No |
| shipFrom | Address | Ship from address | No |
| shipTo | Address | Ship to address | No |
| status | string | Invoice status Enum: "OPEN", "DRAFT", "CLOSED"Example: "OPEN" | 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 |
| unitPriceGstInclusive | boolean | Unit price is GST inclusive Example: false | No |
| warehouseCode | string | Warehouse Code Example: "WH-000001" | No |
SalesInvoiceRequestPhilippines
| Name | Type | Description | Required |
|---|---|---|---|
| additionalCharges | AdditionalCharges | Purchase invoice additional charges details | No |
| approvalStatus | string | Approval status Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"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 |
| contact | ContactInfo | Contact details | Yes |
| contactCode | string | Contact Code Example: "C0001" | Yes |
| currency | string | Currency Example: "C001" | Yes |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| documentSequenceCode | string | Sales Invoice Code Example: "0000001" | No |
| draft | boolean | True if want to save as draft. Example: false | No |
| dropShip | boolean | Drop Ship flag to indicate if purchase invoice is created for drop ship Example: true | No |
| dueAmount | number | Amount Due Example: 12.322 | No |
| errors | [ string ] | List of validation error messages | No |
| exchangeRate | number | Exchange rate Example: 0.456345 | No |
| fulfillmentComplete | boolean | True if auto fulfilled is required. Example: false | No |
| fulfillmentStatus | string | fulfillment status Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"Example: "PARTIAL_FULFILLED" | No |
| fulfillmentType | string | Fulfillment type: NONE, DEFAULT, PICK_PACK_SHIP, DROP_SHIP Enum: "NONE", "DEFAULT", "PICK_PACK_SHIP", "DROP_SHIP"Example: "PICK_PACK_SHIP" | 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 |
| journalEntryCode | string | Journal Entry Code Example: "JE0001" | No |
| linkedDocuments | [ DocumentInfo ] | Linked Documents | No |
| memo | string | Memo Example: "Memo details" | No |
| openingDocumentNumber | string | Customer opening document number Example: "DC-0001" | No |
| openingInvoice | boolean | True if opening invoice Example: false | No |
| paymentInformation | PaymentInformation | Payment information | 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 |
| purchaseOrderRefNo | string | Contact PO reference number Example: "CPO001" | No |
| recurring | boolean | True if Invoice is recurring. Example: true | No |
| recurringActivated | boolean | True if Invoice recurrence is active. Example: false | No |
| reservedStock | boolean | Reserved stock enabled Example: true | 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 |
| salesInvoiceDate | string | Sales Invoice date Example: "25-10-2019" | Yes |
| salesInvoiceDueDate | string | Sales Invoice due date Example: "25-10-2019" | Yes |
| salesInvoiceItems | [ SalesInvoiceItemDetailsPhilippines ] | Sales invoice item details | No |
| salesInvoiceRecurring | SalesInvoiceRecurringDetails | Sales invoice item details | No |
| seqCodeAlreadyDumped | boolean | True if Sequence Code is already dumped. Example: false | No |
| sequenceFormat | string | Sequence Format Id Example: 1 | No |
| shipByDate | string | Ship by date Example: "25-10-2019" | No |
| shipFrom | Address | Ship from address | No |
| shipTo | Address | Ship to address | No |
| status | string | Invoice status Enum: "OPEN", "DRAFT", "CLOSED"Example: "OPEN" | 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 |
| unitPriceGstInclusive | boolean | Unit price is GST inclusive Example: false | No |
| warehouseCode | string | Warehouse Code Example: "WH-000001" | No |
SalesInvoiceRequestSA
| Name | Type | Description | Required |
|---|---|---|---|
| additionalCharges | AdditionalCharges | Purchase invoice additional charges details | No |
| approvalStatus | string | Approval status Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"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 |
| contact | ContactInfo | Contact details | Yes |
| contactCode | string | Contact Code Example: "C0001" | Yes |
| currency | string | Currency Example: "C001" | Yes |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| documentSequenceCode | string | Sales Invoice Code Example: "0000001" | No |
| draft | boolean | True if want to save as draft. Example: false | No |
| dropShip | boolean | Drop Ship flag to indicate if purchase invoice is created for drop ship Example: true | No |
| dueAmount | number | Amount Due Example: 12.322 | No |
| errors | [ string ] | List of validation error messages | No |
| exchangeRate | number | Exchange rate Example: 0.456345 | No |
| fulfillmentComplete | boolean | True if auto fulfilled is required. Example: false | No |
| fulfillmentStatus | string | fulfillment status Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"Example: "PARTIAL_FULFILLED" | No |
| fulfillmentType | string | Fulfillment type: NONE, DEFAULT, PICK_PACK_SHIP, DROP_SHIP Enum: "NONE", "DEFAULT", "PICK_PACK_SHIP", "DROP_SHIP"Example: "PICK_PACK_SHIP" | 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 |
| journalEntryCode | string | Journal Entry Code Example: "JE0001" | No |
| linkedDocuments | [ DocumentInfo ] | Linked Documents | No |
| memo | string | Memo Example: "Memo details" | No |
| openingDocumentNumber | string | Customer opening document number Example: "DC-0001" | No |
| openingInvoice | boolean | True if opening invoice Example: false | No |
| paymentInformation | PaymentInformation | Payment information | 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 |
| purchaseOrderRefNo | string | Contact PO reference number Example: "CPO001" | No |
| recurring | boolean | True if Invoice is recurring. Example: true | No |
| recurringActivated | boolean | True if Invoice recurrence is active. Example: false | No |
| reservedStock | boolean | Reserved stock enabled Example: true | 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 |
| salesInvoiceDate | string | Sales Invoice date Example: "25-10-2019" | Yes |
| salesInvoiceDueDate | string | Sales Invoice due date Example: "25-10-2019" | Yes |
| salesInvoiceItems | [ SalesInvoiceItemDetailsSA ] | Sales invoice item details | No |
| salesInvoiceRecurring | SalesInvoiceRecurringDetails | Sales invoice item details | No |
| seqCodeAlreadyDumped | boolean | True if Sequence Code is already dumped. Example: false | No |
| sequenceFormat | string | Sequence Format Id Example: 1 | No |
| shipByDate | string | Ship by date Example: "25-10-2019" | No |
| shipFrom | Address | Ship from address | No |
| shipTo | Address | Ship to address | No |
| status | string | Invoice status Enum: "OPEN", "DRAFT", "CLOSED"Example: "OPEN" | 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 |
| unitPriceGstInclusive | boolean | Unit price is GST inclusive Example: false | No |
| warehouseCode | string | Warehouse Code Example: "WH-000001" | No |
SalesInvoiceRequestUae
| Name | Type | Description | Required |
|---|---|---|---|
| additionalCharges | AdditionalCharges | Purchase invoice additional charges details | No |
| approvalStatus | string | Approval status Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"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 |
| contact | ContactInfo | Contact details | Yes |
| contactCode | string | Contact Code Example: "C0001" | Yes |
| currency | string | Currency Example: "C001" | Yes |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| documentSequenceCode | string | Sales Invoice Code Example: "0000001" | No |
| draft | boolean | True if want to save as draft. Example: false | No |
| dropShip | boolean | Drop Ship flag to indicate if purchase invoice is created for drop ship Example: true | No |
| dueAmount | number | Amount Due Example: 12.322 | No |
| errors | [ string ] | List of validation error messages | No |
| exchangeRate | number | Exchange rate Example: 0.456345 | No |
| fulfillmentComplete | boolean | True if auto fulfilled is required. Example: false | No |
| fulfillmentStatus | string | fulfillment status Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"Example: "PARTIAL_FULFILLED" | No |
| fulfillmentType | string | Fulfillment type: NONE, DEFAULT, PICK_PACK_SHIP, DROP_SHIP Enum: "NONE", "DEFAULT", "PICK_PACK_SHIP", "DROP_SHIP"Example: "PICK_PACK_SHIP" | 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 |
| journalEntryCode | string | Journal Entry Code Example: "JE0001" | No |
| linkedDocuments | [ DocumentInfo ] | Linked Documents | No |
| memo | string | Memo Example: "Memo details" | No |
| openingDocumentNumber | string | Customer opening document number Example: "DC-0001" | No |
| openingInvoice | boolean | True if opening invoice Example: false | No |
| paymentInformation | PaymentInformation | Payment information | 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 |
| purchaseOrderRefNo | string | Contact PO reference number Example: "CPO001" | No |
| recurring | boolean | True if Invoice is recurring. Example: true | No |
| recurringActivated | boolean | True if Invoice recurrence is active. Example: false | No |
| reservedStock | boolean | Reserved stock enabled Example: true | 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 |
| salesInvoiceDate | string | Sales Invoice date Example: "25-10-2019" | Yes |
| salesInvoiceDueDate | string | Sales Invoice due date Example: "25-10-2019" | Yes |
| salesInvoiceItems | [ SalesInvoiceItemDetailsUae ] | Sales invoice item details | No |
| salesInvoiceRecurring | SalesInvoiceRecurringDetails | Sales invoice item details | No |
| seqCodeAlreadyDumped | boolean | True if Sequence Code is already dumped. Example: false | No |
| sequenceFormat | string | Sequence Format Id Example: 1 | No |
| shipByDate | string | Ship by date Example: "25-10-2019" | No |
| shipFrom | Address | Ship from address | No |
| shipTo | Address | Ship to address | No |
| status | string | Invoice status Enum: "OPEN", "DRAFT", "CLOSED"Example: "OPEN" | 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 |
| unitPriceGstInclusive | boolean | Unit price is GST inclusive Example: false | No |
| warehouseCode | string | Warehouse Code Example: "WH-000001" | No |
SalesInvoiceRequestUk
| Name | Type | Description | Required |
|---|---|---|---|
| additionalCharges | AdditionalCharges | Purchase invoice additional charges details | No |
| approvalStatus | string | Approval status Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"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 |
| contact | ContactInfo | Contact details | Yes |
| contactCode | string | Contact Code Example: "C0001" | Yes |
| currency | string | Currency Example: "C001" | Yes |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| documentSequenceCode | string | Sales Invoice Code Example: "0000001" | No |
| draft | boolean | True if want to save as draft. Example: false | No |
| dropShip | boolean | Drop Ship flag to indicate if purchase invoice is created for drop ship Example: true | No |
| dueAmount | number | Amount Due Example: 12.322 | No |
| errors | [ string ] | List of validation error messages | No |
| exchangeRate | number | Exchange rate Example: 0.456345 | No |
| fulfillmentComplete | boolean | True if auto fulfilled is required. Example: false | No |
| fulfillmentStatus | string | fulfillment status Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"Example: "PARTIAL_FULFILLED" | No |
| fulfillmentType | string | Fulfillment type: NONE, DEFAULT, PICK_PACK_SHIP, DROP_SHIP Enum: "NONE", "DEFAULT", "PICK_PACK_SHIP", "DROP_SHIP"Example: "PICK_PACK_SHIP" | 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 |
| journalEntryCode | string | Journal Entry Code Example: "JE0001" | No |
| linkedDocuments | [ DocumentInfo ] | Linked Documents | No |
| memo | string | Memo Example: "Memo details" | No |
| openingDocumentNumber | string | Customer opening document number Example: "DC-0001" | No |
| openingInvoice | boolean | True if opening invoice Example: false | No |
| paymentInformation | PaymentInformation | Payment information | 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 |
| purchaseOrderRefNo | string | Contact PO reference number Example: "CPO001" | No |
| recurring | boolean | True if Invoice is recurring. Example: true | No |
| recurringActivated | boolean | True if Invoice recurrence is active. Example: false | No |
| reservedStock | boolean | Reserved stock enabled Example: true | 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 |
| salesInvoiceDate | string | Sales Invoice date Example: "25-10-2019" | Yes |
| salesInvoiceDueDate | string | Sales Invoice due date Example: "25-10-2019" | Yes |
| salesInvoiceItems | [ SalesInvoiceItemDetailsUk ] | Sales invoice item details | No |
| salesInvoiceRecurring | SalesInvoiceRecurringDetails | Sales invoice item details | No |
| seqCodeAlreadyDumped | boolean | True if Sequence Code is already dumped. Example: false | No |
| sequenceFormat | string | Sequence Format Id Example: 1 | No |
| shipByDate | string | Ship by date Example: "25-10-2019" | No |
| shipFrom | Address | Ship from address | No |
| shipTo | Address | Ship to address | No |
| status | string | Invoice status Enum: "OPEN", "DRAFT", "CLOSED"Example: "OPEN" | 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 |
| unitPriceGstInclusive | boolean | Unit price is GST inclusive Example: false | No |
| warehouseCode | string | Warehouse Code Example: "WH-000001" | No |
SalesInvoiceResponse
| Name | Type | Description | Required |
|---|---|---|---|
| additionalCharges | AdditionalCharges | Purchase invoice additional charges details | No |
| approvalStatus | string | Approval status Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"Example: "APPROVED" | No |
| attachmentIds | [ integer ] | No | |
| attachments | [ string ] | File attachments | No |
| attachmentsWithLink | [ AttachmentsResponse ] | Attachments Details | No |
| backOrder | boolean | Backorder flag to indicate if backorder created Example: true | No |
| bankTransactionFileCode | string | Bank transaction file code associated with the invoice Example: "BTF-0001" | No |
| billTo | Address | Bill to address | No |
| buyerReference | string | Buyer reference Example: "BR-0001" | No |
| cogsAmount | number | Cost of goods sold amount Example: 12.322 | No |
| contact | ContactInfo | Contact details | Yes |
| contactCode | string | Contact Code Example: "C0001" | Yes |
| contactDto | ContactDto | Contact Details | Yes |
| createdBy | long | Identifier of the user who created the invoice Example: 1 | No |
| createdDate | string | Date on which the invoice was created Example: "25-10-2019" | No |
| currency | string | Currency Example: "C001" | Yes |
| customerOrderNumber | string | Customer order number Example: "CO-0001" | No |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| documentSequenceCode | string | Sales invoice Sequence Code Example: "0000001" | No |
| draft | boolean | Sales invoice drafted Example: false | No |
| draftReferenceId | string | Draft reference id Example: "DR-0001" | No |
| draftSeqCode | string | Draft sequence code Example: "DS-0001" | No |
| dropShip | boolean | Drop Ship flag to indicate if purchase invoice is created for drop ship Example: true | No |
| dueAmount | number | Amount Due Example: 12.322 | No |
| eInvoiceResponseReason | string | Reason returned from the e-invoice response Example: "Accepted" | No |
| eInvoiceResponseStatus | string | Status returned from the e-invoice response Example: "ACCEPTED" | No |
| eInvoiceStatus | [ object ] | List of e-invoice status details | No |
| emailStatus | string | Status of the last email sent for the invoice Example: "SENT" | No |
| errors | [ string ] | List of validation error messages | No |
| exchangeRate | number | Exchange rate Example: 0.456345 | No |
| fulfillmentStatus | string | Sales invoice fulfillment status Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"Example: "UNFULFILLED" | No |
| fulfillmentType | string | Fulfillment type: NONE, DEFAULT, PICK_PACK_SHIP, DROP_SHIP Enum: "NONE", "DEFAULT", "PICK_PACK_SHIP", "DROP_SHIP"Example: "PICK_PACK_SHIP" | No |
| gstExchangeRate | number | GST Exchange rate if tax residency currency is different than base currency Example: 1 | No |
| id | long | Sales invoice id Example: 1 | No |
| isPartialInvoice | boolean | Is Partial Invoice | Yes |
| journalEntryCode | string | Journal Entry Code Example: "JE0001" | No |
| knockoffInfo | [ KnockOffInfo ] | KnockOff Info | No |
| linkedCreditNote | [ KnockOffInfo ] | No | |
| linkedDebitNote | [ KnockOffInfo ] | No | |
| linkedDocHasPps | boolean | True if a linked document has a pick-pack-ship record Example: false | No |
| linkedDocuments | [ DocumentInfo ] | Linked Documents | No |
| linkedRefundDocs | [ DocumentInfo ] | Refund documents linked to the invoice | No |
| manuallyClosed | boolean | True if the invoice was manually closed Example: false | No |
| memo | string | Memo Example: "Memo details" | No |
| multiApprovalDetails | object | Multi-level approval details | No |
| openingDocumentNumber | string | Customer opening document number Example: "DC-0001" | No |
| openingInvoice | boolean | True if opening invoice Example: false | No |
| paymentInformation | PaymentInformation | Payment information | No |
| paymentMilestoneFlag | boolean | Payment milestone flag to indicate if payment milestones are set Example: true | No |
| paymentStatus | string | Sales invoice payment status Enum: "PENDING", "PARTIAL", "RECEIVED"Example: "PENDING" | No |
| poNumber | string | Purchase order number Example: "PO-0001" | No |
| primaryExchangeRate | number | Primary exchange rate Example: 1 | No |
| printStatus | string | Print status of the invoice Example: "PRINTED" | No |
| purchaseOrderRefNo | string | Contact PO reference number Example: "CPO001" | No |
| recurring | boolean | True if Invoice is recurring. Example: true | No |
| recurringActivated | boolean | True if Invoice recurrence is active. Example: false | No |
| refundAmount | number | Refunded amount Example: 12.322 | No |
| refundStatus | string | Refund status Enum: "NOT_REFUNDED", "PARTIALLY_REFUNDED", "FULLY_REFUNDED"Example: "NOT_REFUNDED" | No |
| requestedBy | long | Identifier of the user who requested the invoice Example: 1 | No |
| reservedStock | boolean | Reserved stock enabled Example: true | No |
| revertPrintStatusBy | long | Identifier of the user who reverted the print status Example: 1 | No |
| revertPrintStatusOn | string | Date on which the print status was reverted Example: "25-10-2019" | 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 |
| salesInvoiceCode | string | Sales invoice code Example: "SI001" | No |
| salesInvoiceDate | string | Sales Invoice date Example: "25-10-2019" | Yes |
| salesInvoiceDueDate | string | Sales Invoice due date Example: "25-10-2019" | Yes |
| salesInvoiceItems | [ SalesInvoiceItemDetails ] | Sales invoice item details | No |
| salesInvoiceRecurring | SalesInvoiceRecurringDetails | Sales invoice item details | 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 Example: "SENT" | No |
| sgEInvoiceStatus | string | Singapore e-invoice status Example: "SENT" | No |
| shipByDate | string | Ship by date Example: "25-10-2019" | 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"Example: "NONE" | No |
| status | string | Invoice status Enum: "OPEN", "DRAFT", "CLOSED"Example: "OPEN" | 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 |
| tdsInfo | [ SalesInvoiceTdsInfo ] | SalesInvoice Tds Info | No |
| totalAmount | number | Total amount Example: 12.322 | No |
| totalAmountInBaseCurrency | number | Total amount in base currency Example: 12.322 | No |
| unitPriceGstInclusive | boolean | Unit price is GST inclusive Example: false | No |
| updatedBy | long | Identifier of the user who last updated the invoice Example: 1 | No |
| warehouseCode | string | Warehouse Code Example: "WH-000001" | No |
| withheldAmount | number | Withheld Amount Example: 12.322 | No |
SalesInvoiceResponseAustralia
| Name | Type | Description | Required |
|---|---|---|---|
| additionalCharges | AdditionalCharges | Purchase invoice additional charges details | No |
| approvalStatus | string | Approval status Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"Example: "APPROVED" | No |
| attachmentIds | [ integer ] | No | |
| attachments | [ string ] | File attachments | No |
| attachmentsWithLink | [ AttachmentsResponse ] | Attachments Details | No |
| backOrder | boolean | Backorder flag to indicate if backorder created Example: true | No |
| billTo | Address | Bill to address | No |
| contact | ContactInfo | Contact details | Yes |
| contactCode | string | Contact Code Example: "C0001" | Yes |
| contactDto | ContactDto | Contact Details | Yes |
| currency | string | Currency Example: "C001" | Yes |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| documentSequenceCode | string | Sales invoice Sequence Code Example: "0000001" | No |
| draft | boolean | Sales invoice drafted Example: false | No |
| dropShip | boolean | Drop Ship flag to indicate if purchase invoice is created for drop ship Example: true | No |
| dueAmount | number | Amount Due Example: 12.322 | No |
| errors | [ string ] | List of validation error messages | No |
| exchangeRate | number | Exchange rate Example: 0.456345 | No |
| fulfillmentStatus | string | Sales invoice fulfillment status Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"Example: "UNFULFILLED" | No |
| fulfillmentType | string | Fulfillment type: NONE, DEFAULT, PICK_PACK_SHIP, DROP_SHIP Enum: "NONE", "DEFAULT", "PICK_PACK_SHIP", "DROP_SHIP"Example: "PICK_PACK_SHIP" | No |
| id | long | Sales invoice id Example: 1 | No |
| isPartialInvoice | boolean | Is Partial Invoice | Yes |
| journalEntryCode | string | Journal Entry Code Example: "JE0001" | No |
| knockoffInfo | [ KnockOffInfo ] | KnockOff Info | No |
| linkedCreditNote | [ KnockOffInfo ] | No | |
| linkedDebitNote | [ KnockOffInfo ] | No | |
| linkedDocuments | [ DocumentInfo ] | Linked Documents | No |
| memo | string | Memo Example: "Memo details" | No |
| openingDocumentNumber | string | Customer opening document number Example: "DC-0001" | No |
| openingInvoice | boolean | True if opening invoice Example: false | No |
| paymentInformation | PaymentInformation | Payment information | No |
| paymentMilestoneFlag | boolean | Payment milestone flag to indicate if payment milestones are set Example: true | No |
| paymentStatus | string | Sales invoice payment status Enum: "PENDING", "PARTIAL", "RECEIVED"Example: "PENDING" | No |
| purchaseOrderRefNo | string | Contact PO reference number Example: "CPO001" | No |
| recurring | boolean | True if Invoice is recurring. Example: true | No |
| recurringActivated | boolean | True if Invoice recurrence is active. Example: false | No |
| reservedStock | boolean | Reserved stock enabled Example: true | 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 |
| salesInvoiceCode | string | Sales invoice code Example: "SI001" | No |
| salesInvoiceDate | string | Sales Invoice date Example: "25-10-2019" | Yes |
| salesInvoiceDueDate | string | Sales Invoice due date Example: "25-10-2019" | Yes |
| salesInvoiceItems | [ SalesInvoiceItemDetailsAustralia ] | Sales invoice item details | No |
| salesInvoiceRecurring | SalesInvoiceRecurringDetails | Sales invoice item details | No |
| sequenceFormat | string | Sequence Format Id Example: 1 | No |
| shipByDate | string | Ship by date Example: "25-10-2019" | No |
| shipFrom | Address | Ship from address | No |
| shipTo | Address | Ship to address | No |
| status | string | Invoice status Enum: "OPEN", "DRAFT", "CLOSED"Example: "OPEN" | 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 |
| tdsInfo | [ SalesInvoiceTdsInfo ] | SalesInvoice Tds Info | No |
| totalAmount | number | Total amount Example: 12.322 | No |
| totalAmountInBaseCurrency | number | Total amount in base currency Example: 12.322 | No |
| unitPriceGstInclusive | boolean | Unit price is GST inclusive Example: false | No |
| warehouseCode | string | Warehouse Code Example: "WH-000001" | No |
| withheldAmount | number | Withheld Amount Example: 12.322 | No |
SalesInvoiceResponseCanada
| Name | Type | Description | Required |
|---|---|---|---|
| additionalCharges | AdditionalCharges | Purchase invoice additional charges details | No |
| approvalStatus | string | Approval status Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"Example: "APPROVED" | No |
| attachmentIds | [ integer ] | No | |
| attachments | [ string ] | File attachments | No |
| attachmentsWithLink | [ AttachmentsResponse ] | Attachments Details | No |
| backOrder | boolean | Backorder flag to indicate if backorder created Example: true | No |
| billTo | Address | Bill to address | No |
| contact | ContactInfo | Contact details | Yes |
| contactCode | string | Contact Code Example: "C0001" | Yes |
| contactDto | ContactDto | Contact Details | Yes |
| currency | string | Currency Example: "C001" | Yes |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| documentSequenceCode | string | Sales invoice Sequence Code Example: "0000001" | No |
| draft | boolean | Sales invoice drafted Example: false | No |
| dropShip | boolean | Drop Ship flag to indicate if purchase invoice is created for drop ship Example: true | No |
| dueAmount | number | Amount Due Example: 12.322 | No |
| errors | [ string ] | List of validation error messages | No |
| exchangeRate | number | Exchange rate Example: 0.456345 | No |
| fulfillmentStatus | string | Sales invoice fulfillment status Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"Example: "UNFULFILLED" | No |
| fulfillmentType | string | Fulfillment type: NONE, DEFAULT, PICK_PACK_SHIP, DROP_SHIP Enum: "NONE", "DEFAULT", "PICK_PACK_SHIP", "DROP_SHIP"Example: "PICK_PACK_SHIP" | No |
| id | long | Sales invoice id Example: 1 | No |
| isPartialInvoice | boolean | Is Partial Invoice | Yes |
| journalEntryCode | string | Journal Entry Code Example: "JE0001" | No |
| knockoffInfo | [ KnockOffInfo ] | KnockOff Info | No |
| linkedCreditNote | [ KnockOffInfo ] | No | |
| linkedDebitNote | [ KnockOffInfo ] | No | |
| linkedDocuments | [ DocumentInfo ] | Linked Documents | No |
| memo | string | Memo Example: "Memo details" | No |
| openingDocumentNumber | string | Customer opening document number Example: "DC-0001" | No |
| openingInvoice | boolean | True if opening invoice Example: false | No |
| paymentInformation | PaymentInformation | Payment information | No |
| paymentMilestoneFlag | boolean | Payment milestone flag to indicate if payment milestones are set Example: true | No |
| paymentStatus | string | Sales invoice payment status Enum: "PENDING", "PARTIAL", "RECEIVED"Example: "PENDING" | No |
| purchaseOrderRefNo | string | Contact PO reference number Example: "CPO001" | No |
| recurring | boolean | True if Invoice is recurring. Example: true | No |
| recurringActivated | boolean | True if Invoice recurrence is active. Example: false | No |
| reservedStock | boolean | Reserved stock enabled Example: true | 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 |
| salesInvoiceCode | string | Sales invoice code Example: "SI001" | No |
| salesInvoiceDate | string | Sales Invoice date Example: "25-10-2019" | Yes |
| salesInvoiceDueDate | string | Sales Invoice due date Example: "25-10-2019" | Yes |
| salesInvoiceItems | [ SalesInvoiceItemDetailsCanada ] | Sales invoice item details | No |
| salesInvoiceRecurring | SalesInvoiceRecurringDetails | Sales invoice item details | No |
| sequenceFormat | string | Sequence Format Id Example: 1 | No |
| shipByDate | string | Ship by date Example: "25-10-2019" | No |
| shipFrom | Address | Ship from address | No |
| shipTo | Address | Ship to address | No |
| status | string | Invoice status Enum: "OPEN", "DRAFT", "CLOSED"Example: "OPEN" | 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 |
| tdsInfo | [ SalesInvoiceTdsInfo ] | SalesInvoice Tds Info | No |
| totalAmount | number | Total amount Example: 12.322 | No |
| totalAmountInBaseCurrency | number | Total amount in base currency Example: 12.322 | No |
| unitPriceGstInclusive | boolean | Unit price is GST inclusive Example: false | No |
| warehouseCode | string | Warehouse Code Example: "WH-000001" | No |
| withheldAmount | number | Withheld Amount Example: 12.322 | No |
SalesInvoiceResponseGermany
| Name | Type | Description | Required |
|---|---|---|---|
| additionalCharges | AdditionalCharges | Purchase invoice additional charges details | No |
| approvalStatus | string | Approval status Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"Example: "APPROVED" | No |
| attachmentIds | [ integer ] | No | |
| attachments | [ string ] | File attachments | No |
| attachmentsWithLink | [ AttachmentsResponse ] | Attachments Details | No |
| backOrder | boolean | Backorder flag to indicate if backorder created Example: true | No |
| billTo | Address | Bill to address | No |
| contact | ContactInfo | Contact details | Yes |
| contactCode | string | Contact Code Example: "C0001" | Yes |
| contactDto | ContactDto | Contact Details | Yes |
| currency | string | Currency Example: "C001" | Yes |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| documentSequenceCode | string | Sales invoice Sequence Code Example: "0000001" | No |
| draft | boolean | Sales invoice drafted Example: false | No |
| dropShip | boolean | Drop Ship flag to indicate if purchase invoice is created for drop ship Example: true | No |
| dueAmount | number | Amount Due Example: 12.322 | No |
| errors | [ string ] | List of validation error messages | No |
| exchangeRate | number | Exchange rate Example: 0.456345 | No |
| fulfillmentStatus | string | Sales invoice fulfillment status Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"Example: "UNFULFILLED" | No |
| fulfillmentType | string | Fulfillment type: NONE, DEFAULT, PICK_PACK_SHIP, DROP_SHIP Enum: "NONE", "DEFAULT", "PICK_PACK_SHIP", "DROP_SHIP"Example: "PICK_PACK_SHIP" | No |
| id | long | Sales invoice id Example: 1 | No |
| isPartialInvoice | boolean | Is Partial Invoice | Yes |
| journalEntryCode | string | Journal Entry Code Example: "JE0001" | No |
| knockoffInfo | [ KnockOffInfo ] | KnockOff Info | No |
| linkedCreditNote | [ KnockOffInfo ] | No | |
| linkedDebitNote | [ KnockOffInfo ] | No | |
| linkedDocuments | [ DocumentInfo ] | Linked Documents | No |
| memo | string | Memo Example: "Memo details" | No |
| openingDocumentNumber | string | Customer opening document number Example: "DC-0001" | No |
| openingInvoice | boolean | True if opening invoice Example: false | No |
| paymentInformation | PaymentInformation | Payment information | No |
| paymentMilestoneFlag | boolean | Payment milestone flag to indicate if payment milestones are set Example: true | No |
| paymentStatus | string | Sales invoice payment status Enum: "PENDING", "PARTIAL", "RECEIVED"Example: "PENDING" | No |
| purchaseOrderRefNo | string | Contact PO reference number Example: "CPO001" | No |
| recurring | boolean | True if Invoice is recurring. Example: true | No |
| recurringActivated | boolean | True if Invoice recurrence is active. Example: false | No |
| reservedStock | boolean | Reserved stock enabled Example: true | 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 |
| salesInvoiceCode | string | Sales invoice code Example: "SI001" | No |
| salesInvoiceDate | string | Sales Invoice date Example: "25-10-2019" | Yes |
| salesInvoiceDueDate | string | Sales Invoice due date Example: "25-10-2019" | Yes |
| salesInvoiceItems | [ SalesInvoiceItemDetailsGermany ] | Sales invoice item details | No |
| salesInvoiceRecurring | SalesInvoiceRecurringDetails | Sales invoice item details | No |
| sequenceFormat | string | Sequence Format Id Example: 1 | No |
| shipByDate | string | Ship by date Example: "25-10-2019" | No |
| shipFrom | Address | Ship from address | No |
| shipTo | Address | Ship to address | No |
| status | string | Invoice status Enum: "OPEN", "DRAFT", "CLOSED"Example: "OPEN" | 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 |
| tdsInfo | [ SalesInvoiceTdsInfo ] | SalesInvoice Tds Info | No |
| totalAmount | number | Total amount Example: 12.322 | No |
| totalAmountInBaseCurrency | number | Total amount in base currency Example: 12.322 | No |
| unitPriceGstInclusive | boolean | Unit price is GST inclusive Example: false | No |
| warehouseCode | string | Warehouse Code Example: "WH-000001" | No |
| withheldAmount | number | Withheld Amount Example: 12.322 | No |
SalesInvoiceResponseIndia
| Name | Type | Description | Required |
|---|---|---|---|
| additionalCharges | AdditionalCharges | Purchase invoice additional charges details | No |
| approvalStatus | string | Approval status Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"Example: "APPROVED" | No |
| attachmentIds | [ integer ] | No | |
| attachments | [ string ] | File attachments | No |
| attachmentsWithLink | [ AttachmentsResponse ] | Attachments Details | No |
| backOrder | boolean | Backorder flag to indicate if backorder created Example: true | No |
| billTo | Address | Bill to address | No |
| contact | ContactInfo | Contact details | Yes |
| contactCode | string | Contact Code Example: "C0001" | Yes |
| contactDto | ContactDto | Contact Details | Yes |
| currency | string | Currency Example: "C001" | Yes |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| customerType | string | Customer Type Enum: "EXPORT_WO_PAY", "EXPORT_W_PAY", "NA", "SEZ_WO_PAY", "SEZ_W_PAY"Example: "NA" | Yes |
| documentSequenceCode | string | Sales invoice Sequence Code Example: "0000001" | No |
| draft | boolean | Sales invoice drafted Example: false | No |
| dropShip | boolean | Drop Ship flag to indicate if purchase invoice is created for drop ship Example: true | No |
| dueAmount | number | Amount Due Example: 12.322 | No |
| einvoiceInfoIndia | EinvoiceInfoIndia | eInvoice Information Example: "eInvoice" | No |
| einvoiceInfoIndiaCancel | EinvoiceInfoIndiaCancel | eInvoice Information Example: "eInvoice" | No |
| errors | [ string ] | List of validation error messages | No |
| ewayBillNumber | string | Eway bill number | No |
| ewayBillStatus | string | Eway bill status Example: "GENERATED" | No |
| ewayGenerated | boolean | No | |
| exchangeRate | number | Exchange rate Example: 0.456345 | No |
| fulfillmentStatus | string | Sales invoice fulfillment status Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"Example: "UNFULFILLED" | No |
| fulfillmentType | string | Fulfillment type: NONE, DEFAULT, PICK_PACK_SHIP, DROP_SHIP Enum: "NONE", "DEFAULT", "PICK_PACK_SHIP", "DROP_SHIP"Example: "PICK_PACK_SHIP" | No |
| gstTreatment | string | GST Treatment Enum: "REGISTERED_BUSINESS_REGULAR=Registered Business - Regular", "REGISTERED_BUSINESS_COMPOSITION=Registered Business - Composition", "UNREGISTERED_BUSINESS=Unregistered Business", "CUSTOMER=Consumer", "OVERSEAS=Overseas", "SPECIAL_ECONOMIC_ZONE=Special Economic Zone", "DEEMED_EXPORT=Deemed Export"Example: "REGISTERED_BUSINESS_REGULAR" | Yes |
| gstin | string | GSTIN Example: "ABSASASSASASA198" | Yes |
| id | long | Sales invoice id Example: 1 | No |
| isCancelEinvoice | boolean | eInvoice is canceled or not Example: false | No |
| isPartialInvoice | boolean | Is Partial Invoice | Yes |
| journalEntryCode | string | Journal Entry Code Example: "JE0001" | No |
| knockoffInfo | [ KnockOffInfo ] | KnockOff Info | No |
| linkedCreditNote | [ KnockOffInfo ] | No | |
| linkedDebitNote | [ KnockOffInfo ] | No | |
| linkedDocuments | [ DocumentInfo ] | Linked Documents | No |
| memo | string | Memo Example: "Memo details" | No |
| openingDocumentNumber | string | Customer opening document number Example: "DC-0001" | No |
| openingInvoice | boolean | True if opening invoice Example: false | No |
| paymentInformation | PaymentInformation | Payment information | No |
| paymentMilestoneFlag | boolean | Payment milestone flag to indicate if payment milestones are set Example: true | No |
| paymentStatus | string | Sales invoice payment status Enum: "PENDING", "PARTIAL", "RECEIVED"Example: "PENDING" | No |
| placeOfSupply | string | state in India Example: "Punjab" | Yes |
| purchaseOrderRefNo | string | Contact PO reference number Example: "CPO001" | No |
| recurring | boolean | True if Invoice is recurring. Example: true | No |
| recurringActivated | boolean | True if Invoice recurrence is active. Example: false | No |
| reservedStock | boolean | Reserved stock enabled Example: true | 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 |
| salesInvoiceCode | string | Sales invoice code Example: "SI001" | No |
| salesInvoiceDate | string | Sales Invoice date Example: "25-10-2019" | Yes |
| salesInvoiceDueDate | string | Sales Invoice due date Example: "25-10-2019" | Yes |
| salesInvoiceItems | [ SalesInvoiceItemDetailsIndia ] | Sales invoice item details | No |
| salesInvoiceRecurring | SalesInvoiceRecurringDetails | Sales invoice item details | No |
| sequenceFormat | string | Sequence Format Id Example: 1 | No |
| shipByDate | string | Ship by date Example: "25-10-2019" | No |
| shipFrom | Address | Ship from address | No |
| shipTo | Address | Ship to address | No |
| status | string | Invoice status Enum: "OPEN", "DRAFT", "CLOSED"Example: "OPEN" | 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 |
| tdsInfo | [ SalesInvoiceTdsInfo ] | SalesInvoice Tds Info | No |
| totalAmount | number | Total amount Example: 12.322 | No |
| totalAmountInBaseCurrency | number | Total amount in base currency Example: 12.322 | No |
| unitPriceGstInclusive | boolean | Unit price is GST inclusive Example: false | No |
| vendorType | string | Vendor Type Enum: "IMPORT", "NA", "SEZ_W_PAY", "SEZ_WO_PAY"Example: "NA" | Yes |
| warehouseCode | string | Warehouse Code Example: "WH-000001" | No |
| withheldAmount | number | Withheld Amount Example: 12.322 | No |
SalesInvoiceResponseIndonesia
| Name | Type | Description | Required |
|---|---|---|---|
| additionalCharges | AdditionalCharges | Purchase invoice additional charges details | No |
| approvalStatus | string | Approval status Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"Example: "APPROVED" | No |
| attachmentIds | [ integer ] | No | |
| attachments | [ string ] | File attachments | No |
| attachmentsWithLink | [ AttachmentsResponse ] | Attachments Details | No |
| backOrder | boolean | Backorder flag to indicate if backorder created Example: true | No |
| billTo | Address | Bill to address | No |
| contact | ContactInfo | Contact details | Yes |
| contactCode | string | Contact Code Example: "C0001" | Yes |
| contactDto | ContactDto | Contact Details | Yes |
| currency | string | Currency Example: "C001" | Yes |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| documentSequenceCode | string | Sales invoice Sequence Code Example: "0000001" | No |
| draft | boolean | Sales invoice drafted Example: false | No |
| dropShip | boolean | Drop Ship flag to indicate if purchase invoice is created for drop ship Example: true | No |
| dueAmount | number | Amount Due Example: 12.322 | No |
| errors | [ string ] | List of validation error messages | No |
| exchangeRate | number | Exchange rate Example: 0.456345 | No |
| fulfillmentStatus | string | Sales invoice fulfillment status Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"Example: "UNFULFILLED" | No |
| fulfillmentType | string | Fulfillment type: NONE, DEFAULT, PICK_PACK_SHIP, DROP_SHIP Enum: "NONE", "DEFAULT", "PICK_PACK_SHIP", "DROP_SHIP"Example: "PICK_PACK_SHIP" | No |
| id | long | Sales invoice id Example: 1 | No |
| isPartialInvoice | boolean | Is Partial Invoice | Yes |
| journalEntryCode | string | Journal Entry Code Example: "JE0001" | No |
| knockoffInfo | [ KnockOffInfo ] | KnockOff Info | No |
| linkedCreditNote | [ KnockOffInfo ] | No | |
| linkedDebitNote | [ KnockOffInfo ] | No | |
| linkedDocuments | [ DocumentInfo ] | Linked Documents | No |
| memo | string | Memo Example: "Memo details" | No |
| openingDocumentNumber | string | Customer opening document number Example: "DC-0001" | No |
| openingInvoice | boolean | True if opening invoice Example: false | No |
| paymentInformation | PaymentInformation | Payment information | No |
| paymentMilestoneFlag | boolean | Payment milestone flag to indicate if payment milestones are set Example: true | No |
| paymentStatus | string | Sales invoice payment status Enum: "PENDING", "PARTIAL", "RECEIVED"Example: "PENDING" | No |
| purchaseOrderRefNo | string | Contact PO reference number Example: "CPO001" | No |
| recurring | boolean | True if Invoice is recurring. Example: true | No |
| recurringActivated | boolean | True if Invoice recurrence is active. Example: false | No |
| reservedStock | boolean | Reserved stock enabled Example: true | 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 |
| salesInvoiceCode | string | Sales invoice code Example: "SI001" | No |
| salesInvoiceDate | string | Sales Invoice date Example: "25-10-2019" | Yes |
| salesInvoiceDueDate | string | Sales Invoice due date Example: "25-10-2019" | Yes |
| salesInvoiceItems | [ SalesInvoiceItemDetailsIndonesia ] | Sales invoice item details | No |
| salesInvoiceRecurring | SalesInvoiceRecurringDetails | Sales invoice item details | No |
| sequenceFormat | string | Sequence Format Id Example: 1 | No |
| shipByDate | string | Ship by date Example: "25-10-2019" | No |
| shipFrom | Address | Ship from address | No |
| shipTo | Address | Ship to address | No |
| status | string | Invoice status Enum: "OPEN", "DRAFT", "CLOSED"Example: "OPEN" | No |
| taxAmount | number | Tax amount Example: 2.322 | No |
| taxInvoiceNo | string | Tax Invoice No Example: 123456789 | No |
| tcsAmount | number | TCS amount Example: 2.322 | No |
| tcsPercentage | number | TCS percentage Example: 2 | No |
| tcsRateId | long | TCS Rate Id Example: 1 | No |
| tdsInfo | [ SalesInvoiceTdsInfo ] | SalesInvoice Tds Info | No |
| totalAmount | number | Total amount Example: 12.322 | No |
| totalAmountInBaseCurrency | number | Total amount in base currency Example: 12.322 | No |
| unitPriceGstInclusive | boolean | Unit price is GST inclusive Example: false | No |
| warehouseCode | string | Warehouse Code Example: "WH-000001" | No |
| withheldAmount | number | Withheld Amount Example: 12.322 | No |
SalesInvoiceResponseIsrael
| Name | Type | Description | Required |
|---|---|---|---|
| additionalCharges | AdditionalCharges | Purchase invoice additional charges details | No |
| approvalStatus | string | Approval status Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"Example: "APPROVED" | No |
| attachmentIds | [ integer ] | No | |
| attachments | [ string ] | File attachments | No |
| attachmentsWithLink | [ AttachmentsResponse ] | Attachments Details | No |
| backOrder | boolean | Backorder flag to indicate if backorder created Example: true | No |
| billTo | Address | Bill to address | No |
| contact | ContactInfo | Contact details | Yes |
| contactCode | string | Contact Code Example: "C0001" | Yes |
| contactDto | ContactDto | Contact Details | Yes |
| currency | string | Currency Example: "C001" | Yes |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| documentSequenceCode | string | Sales invoice Sequence Code Example: "0000001" | No |
| draft | boolean | Sales invoice drafted Example: false | No |
| dropShip | boolean | Drop Ship flag to indicate if purchase invoice is created for drop ship Example: true | No |
| dueAmount | number | Amount Due Example: 12.322 | No |
| errors | [ string ] | List of validation error messages | No |
| exchangeRate | number | Exchange rate Example: 0.456345 | No |
| fulfillmentStatus | string | Sales invoice fulfillment status Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"Example: "UNFULFILLED" | No |
| fulfillmentType | string | Fulfillment type: NONE, DEFAULT, PICK_PACK_SHIP, DROP_SHIP Enum: "NONE", "DEFAULT", "PICK_PACK_SHIP", "DROP_SHIP"Example: "PICK_PACK_SHIP" | No |
| id | long | Sales invoice id Example: 1 | No |
| isPartialInvoice | boolean | Is Partial Invoice | Yes |
| journalEntryCode | string | Journal Entry Code Example: "JE0001" | No |
| knockoffInfo | [ KnockOffInfo ] | KnockOff Info | No |
| linkedCreditNote | [ KnockOffInfo ] | No | |
| linkedDebitNote | [ KnockOffInfo ] | No | |
| linkedDocuments | [ DocumentInfo ] | Linked Documents | No |
| memo | string | Memo Example: "Memo details" | No |
| openingDocumentNumber | string | Customer opening document number Example: "DC-0001" | No |
| openingInvoice | boolean | True if opening invoice Example: false | No |
| paymentInformation | PaymentInformation | Payment information | No |
| paymentMilestoneFlag | boolean | Payment milestone flag to indicate if payment milestones are set Example: true | No |
| paymentStatus | string | Sales invoice payment status Enum: "PENDING", "PARTIAL", "RECEIVED"Example: "PENDING" | No |
| purchaseOrderRefNo | string | Contact PO reference number Example: "CPO001" | No |
| recurring | boolean | True if Invoice is recurring. Example: true | No |
| recurringActivated | boolean | True if Invoice recurrence is active. Example: false | No |
| reservedStock | boolean | Reserved stock enabled Example: true | 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 |
| salesInvoiceCode | string | Sales invoice code Example: "SI001" | No |
| salesInvoiceDate | string | Sales Invoice date Example: "25-10-2019" | Yes |
| salesInvoiceDueDate | string | Sales Invoice due date Example: "25-10-2019" | Yes |
| salesInvoiceItems | [ SalesInvoiceItemDetailsIsrael ] | Sales invoice item details | No |
| salesInvoiceRecurring | SalesInvoiceRecurringDetails | Sales invoice item details | No |
| sequenceFormat | string | Sequence Format Id Example: 1 | No |
| shipByDate | string | Ship by date Example: "25-10-2019" | No |
| shipFrom | Address | Ship from address | No |
| shipTo | Address | Ship to address | No |
| status | string | Invoice status Enum: "OPEN", "DRAFT", "CLOSED"Example: "OPEN" | 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 |
| tdsInfo | [ SalesInvoiceTdsInfo ] | SalesInvoice Tds Info | No |
| totalAmount | number | Total amount Example: 12.322 | No |
| totalAmountInBaseCurrency | number | Total amount in base currency Example: 12.322 | No |
| unitPriceGstInclusive | boolean | Unit price is GST inclusive Example: false | No |
| warehouseCode | string | Warehouse Code Example: "WH-000001" | No |
| withheldAmount | number | Withheld Amount Example: 12.322 | No |
SalesInvoiceResponseMalaysia
| Name | Type | Description | Required |
|---|---|---|---|
| additionalCharges | AdditionalCharges | Purchase invoice additional charges details | No |
| approvalStatus | string | Approval status Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"Example: "APPROVED" | No |
| attachmentIds | [ integer ] | No | |
| attachments | [ string ] | File attachments | No |
| attachmentsWithLink | [ AttachmentsResponse ] | Attachments Details | No |
| backOrder | boolean | Backorder flag to indicate if backorder created Example: true | No |
| billTo | Address | Bill to address | No |
| contact | ContactInfo | Contact details | Yes |
| contactCode | string | Contact Code Example: "C0001" | Yes |
| contactDto | ContactDto | Contact Details | Yes |
| currency | string | Currency Example: "C001" | Yes |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| documentSequenceCode | string | Sales invoice Sequence Code Example: "0000001" | No |
| draft | boolean | Sales invoice drafted Example: false | No |
| dropShip | boolean | Drop Ship flag to indicate if purchase invoice is created for drop ship Example: true | No |
| dueAmount | number | Amount Due Example: 12.322 | No |
| errors | [ string ] | List of validation error messages | No |
| exchangeRate | number | Exchange rate Example: 0.456345 | No |
| fulfillmentStatus | string | Sales invoice fulfillment status Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"Example: "UNFULFILLED" | No |
| fulfillmentType | string | Fulfillment type: NONE, DEFAULT, PICK_PACK_SHIP, DROP_SHIP Enum: "NONE", "DEFAULT", "PICK_PACK_SHIP", "DROP_SHIP"Example: "PICK_PACK_SHIP" | No |
| id | long | Sales invoice id Example: 1 | No |
| isPartialInvoice | boolean | Is Partial Invoice | Yes |
| journalEntryCode | string | Journal Entry Code Example: "JE0001" | No |
| knockoffInfo | [ KnockOffInfo ] | KnockOff Info | No |
| linkedCreditNote | [ KnockOffInfo ] | No | |
| linkedDebitNote | [ KnockOffInfo ] | No | |
| linkedDocuments | [ DocumentInfo ] | Linked Documents | No |
| memo | string | Memo Example: "Memo details" | No |
| openingDocumentNumber | string | Customer opening document number Example: "DC-0001" | No |
| openingInvoice | boolean | True if opening invoice Example: false | No |
| paymentInformation | PaymentInformation | Payment information | No |
| paymentMilestoneFlag | boolean | Payment milestone flag to indicate if payment milestones are set Example: true | No |
| paymentStatus | string | Sales invoice payment status Enum: "PENDING", "PARTIAL", "RECEIVED"Example: "PENDING" | No |
| purchaseOrderRefNo | string | Contact PO reference number Example: "CPO001" | No |
| recurring | boolean | True if Invoice is recurring. Example: true | No |
| recurringActivated | boolean | True if Invoice recurrence is active. Example: false | No |
| reservedStock | boolean | Reserved stock enabled Example: true | 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 |
| salesInvoiceCode | string | Sales invoice code Example: "SI001" | No |
| salesInvoiceDate | string | Sales Invoice date Example: "25-10-2019" | Yes |
| salesInvoiceDueDate | string | Sales Invoice due date Example: "25-10-2019" | Yes |
| salesInvoiceItems | [ SalesInvoiceItemDetailsMalaysia ] | Sales invoice item details | No |
| salesInvoiceRecurring | SalesInvoiceRecurringDetails | Sales invoice item details | No |
| sequenceFormat | string | Sequence Format Id Example: 1 | No |
| shipByDate | string | Ship by date Example: "25-10-2019" | No |
| shipFrom | Address | Ship from address | No |
| shipTo | Address | Ship to address | No |
| status | string | Invoice status Enum: "OPEN", "DRAFT", "CLOSED"Example: "OPEN" | 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 |
| tdsInfo | [ SalesInvoiceTdsInfo ] | SalesInvoice Tds Info | No |
| totalAmount | number | Total amount Example: 12.322 | No |
| totalAmountInBaseCurrency | number | Total amount in base currency Example: 12.322 | No |
| unitPriceGstInclusive | boolean | Unit price is GST inclusive Example: false | No |
| warehouseCode | string | Warehouse Code Example: "WH-000001" | No |
| withheldAmount | number | Withheld Amount Example: 12.322 | No |
SalesInvoiceResponsePhilippines
| Name | Type | Description | Required |
|---|---|---|---|
| additionalCharges | AdditionalCharges | Purchase invoice additional charges details | No |
| approvalStatus | string | Approval status Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"Example: "APPROVED" | No |
| attachmentIds | [ integer ] | No | |
| attachments | [ string ] | File attachments | No |
| attachmentsWithLink | [ AttachmentsResponse ] | Attachments Details | No |
| backOrder | boolean | Backorder flag to indicate if backorder created Example: true | No |
| billTo | Address | Bill to address | No |
| contact | ContactInfo | Contact details | Yes |
| contactCode | string | Contact Code Example: "C0001" | Yes |
| contactDto | ContactDto | Contact Details | Yes |
| currency | string | Currency Example: "C001" | Yes |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| documentSequenceCode | string | Sales invoice Sequence Code Example: "0000001" | No |
| draft | boolean | Sales invoice drafted Example: false | No |
| dropShip | boolean | Drop Ship flag to indicate if purchase invoice is created for drop ship Example: true | No |
| dueAmount | number | Amount Due Example: 12.322 | No |
| errors | [ string ] | List of validation error messages | No |
| exchangeRate | number | Exchange rate Example: 0.456345 | No |
| fulfillmentStatus | string | Sales invoice fulfillment status Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"Example: "UNFULFILLED" | No |
| fulfillmentType | string | Fulfillment type: NONE, DEFAULT, PICK_PACK_SHIP, DROP_SHIP Enum: "NONE", "DEFAULT", "PICK_PACK_SHIP", "DROP_SHIP"Example: "PICK_PACK_SHIP" | No |
| id | long | Sales invoice id Example: 1 | No |
| isPartialInvoice | boolean | Is Partial Invoice | Yes |
| journalEntryCode | string | Journal Entry Code Example: "JE0001" | No |
| knockoffInfo | [ KnockOffInfo ] | KnockOff Info | No |
| linkedCreditNote | [ KnockOffInfo ] | No | |
| linkedDebitNote | [ KnockOffInfo ] | No | |
| linkedDocuments | [ DocumentInfo ] | Linked Documents | No |
| memo | string | Memo Example: "Memo details" | No |
| openingDocumentNumber | string | Customer opening document number Example: "DC-0001" | No |
| openingInvoice | boolean | True if opening invoice Example: false | No |
| paymentInformation | PaymentInformation | Payment information | No |
| paymentMilestoneFlag | boolean | Payment milestone flag to indicate if payment milestones are set Example: true | No |
| paymentStatus | string | Sales invoice payment status Enum: "PENDING", "PARTIAL", "RECEIVED"Example: "PENDING" | No |
| purchaseOrderRefNo | string | Contact PO reference number Example: "CPO001" | No |
| recurring | boolean | True if Invoice is recurring. Example: true | No |
| recurringActivated | boolean | True if Invoice recurrence is active. Example: false | No |
| reservedStock | boolean | Reserved stock enabled Example: true | 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 |
| salesInvoiceCode | string | Sales invoice code Example: "SI001" | No |
| salesInvoiceDate | string | Sales Invoice date Example: "25-10-2019" | Yes |
| salesInvoiceDueDate | string | Sales Invoice due date Example: "25-10-2019" | Yes |
| salesInvoiceItems | [ SalesInvoiceItemDetailsPhilippines ] | Sales invoice item details | No |
| salesInvoiceRecurring | SalesInvoiceRecurringDetails | Sales invoice item details | No |
| sequenceFormat | string | Sequence Format Id Example: 1 | No |
| shipByDate | string | Ship by date Example: "25-10-2019" | No |
| shipFrom | Address | Ship from address | No |
| shipTo | Address | Ship to address | No |
| status | string | Invoice status Enum: "OPEN", "DRAFT", "CLOSED"Example: "OPEN" | 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 |
| tdsInfo | [ SalesInvoiceTdsInfo ] | SalesInvoice Tds Info | No |
| totalAmount | number | Total amount Example: 12.322 | No |
| totalAmountInBaseCurrency | number | Total amount in base currency Example: 12.322 | No |
| unitPriceGstInclusive | boolean | Unit price is GST inclusive Example: false | No |
| warehouseCode | string | Warehouse Code Example: "WH-000001" | No |
| withheldAmount | number | Withheld Amount Example: 12.322 | No |
SalesInvoiceResponseSA
| Name | Type | Description | Required |
|---|---|---|---|
| additionalCharges | AdditionalCharges | Purchase invoice additional charges details | No |
| approvalStatus | string | Approval status Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"Example: "APPROVED" | No |
| attachmentIds | [ integer ] | No | |
| attachments | [ string ] | File attachments | No |
| attachmentsWithLink | [ AttachmentsResponse ] | Attachments Details | No |
| backOrder | boolean | Backorder flag to indicate if backorder created Example: true | No |
| billTo | Address | Bill to address | No |
| contact | ContactInfo | Contact details | Yes |
| contactCode | string | Contact Code Example: "C0001" | Yes |
| contactDto | ContactDto | Contact Details | Yes |
| currency | string | Currency Example: "C001" | Yes |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| documentSequenceCode | string | Sales invoice Sequence Code Example: "0000001" | No |
| draft | boolean | Sales invoice drafted Example: false | No |
| dropShip | boolean | Drop Ship flag to indicate if purchase invoice is created for drop ship Example: true | No |
| dueAmount | number | Amount Due Example: 12.322 | No |
| errors | [ string ] | List of validation error messages | No |
| exchangeRate | number | Exchange rate Example: 0.456345 | No |
| fulfillmentStatus | string | Sales invoice fulfillment status Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"Example: "UNFULFILLED" | No |
| fulfillmentType | string | Fulfillment type: NONE, DEFAULT, PICK_PACK_SHIP, DROP_SHIP Enum: "NONE", "DEFAULT", "PICK_PACK_SHIP", "DROP_SHIP"Example: "PICK_PACK_SHIP" | No |
| id | long | Sales invoice id Example: 1 | No |
| isPartialInvoice | boolean | Is Partial Invoice | Yes |
| journalEntryCode | string | Journal Entry Code Example: "JE0001" | No |
| knockoffInfo | [ KnockOffInfo ] | KnockOff Info | No |
| linkedCreditNote | [ KnockOffInfo ] | No | |
| linkedDebitNote | [ KnockOffInfo ] | No | |
| linkedDocuments | [ DocumentInfo ] | Linked Documents | No |
| memo | string | Memo Example: "Memo details" | No |
| openingDocumentNumber | string | Customer opening document number Example: "DC-0001" | No |
| openingInvoice | boolean | True if opening invoice Example: false | No |
| paymentInformation | PaymentInformation | Payment information | No |
| paymentMilestoneFlag | boolean | Payment milestone flag to indicate if payment milestones are set Example: true | No |
| paymentStatus | string | Sales invoice payment status Enum: "PENDING", "PARTIAL", "RECEIVED"Example: "PENDING" | No |
| purchaseOrderRefNo | string | Contact PO reference number Example: "CPO001" | No |
| recurring | boolean | True if Invoice is recurring. Example: true | No |
| recurringActivated | boolean | True if Invoice recurrence is active. Example: false | No |
| reservedStock | boolean | Reserved stock enabled Example: true | 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 |
| salesInvoiceCode | string | Sales invoice code Example: "SI001" | No |
| salesInvoiceDate | string | Sales Invoice date Example: "25-10-2019" | Yes |
| salesInvoiceDueDate | string | Sales Invoice due date Example: "25-10-2019" | Yes |
| salesInvoiceItems | [ SalesInvoiceItemDetailsSA ] | Sales invoice item details | No |
| salesInvoiceRecurring | SalesInvoiceRecurringDetails | Sales invoice item details | No |
| sequenceFormat | string | Sequence Format Id Example: 1 | No |
| shipByDate | string | Ship by date Example: "25-10-2019" | No |
| shipFrom | Address | Ship from address | No |
| shipTo | Address | Ship to address | No |
| status | string | Invoice status Enum: "OPEN", "DRAFT", "CLOSED"Example: "OPEN" | 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 |
| tdsInfo | [ SalesInvoiceTdsInfo ] | SalesInvoice Tds Info | No |
| totalAmount | number | Total amount Example: 12.322 | No |
| totalAmountInBaseCurrency | number | Total amount in base currency Example: 12.322 | No |
| unitPriceGstInclusive | boolean | Unit price is GST inclusive Example: false | No |
| warehouseCode | string | Warehouse Code Example: "WH-000001" | No |
| withheldAmount | number | Withheld Amount Example: 12.322 | No |
SalesInvoiceResponseUae
| Name | Type | Description | Required |
|---|---|---|---|
| additionalCharges | AdditionalCharges | Purchase invoice additional charges details | No |
| approvalStatus | string | Approval status Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"Example: "APPROVED" | No |
| attachmentIds | [ integer ] | No | |
| attachments | [ string ] | File attachments | No |
| attachmentsWithLink | [ AttachmentsResponse ] | Attachments Details | No |
| backOrder | boolean | Backorder flag to indicate if backorder created Example: true | No |
| billTo | Address | Bill to address | No |
| contact | ContactInfo | Contact details | Yes |
| contactCode | string | Contact Code Example: "C0001" | Yes |
| contactDto | ContactDto | Contact Details | Yes |
| currency | string | Currency Example: "C001" | Yes |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| documentSequenceCode | string | Sales invoice Sequence Code Example: "0000001" | No |
| draft | boolean | Sales invoice drafted Example: false | No |
| dropShip | boolean | Drop Ship flag to indicate if purchase invoice is created for drop ship Example: true | No |
| dueAmount | number | Amount Due Example: 12.322 | No |
| errors | [ string ] | List of validation error messages | No |
| exchangeRate | number | Exchange rate Example: 0.456345 | No |
| fulfillmentStatus | string | Sales invoice fulfillment status Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"Example: "UNFULFILLED" | No |
| fulfillmentType | string | Fulfillment type: NONE, DEFAULT, PICK_PACK_SHIP, DROP_SHIP Enum: "NONE", "DEFAULT", "PICK_PACK_SHIP", "DROP_SHIP"Example: "PICK_PACK_SHIP" | No |
| id | long | Sales invoice id Example: 1 | No |
| isPartialInvoice | boolean | Is Partial Invoice | Yes |
| journalEntryCode | string | Journal Entry Code Example: "JE0001" | No |
| knockoffInfo | [ KnockOffInfo ] | KnockOff Info | No |
| linkedCreditNote | [ KnockOffInfo ] | No | |
| linkedDebitNote | [ KnockOffInfo ] | No | |
| linkedDocuments | [ DocumentInfo ] | Linked Documents | No |
| memo | string | Memo Example: "Memo details" | No |
| openingDocumentNumber | string | Customer opening document number Example: "DC-0001" | No |
| openingInvoice | boolean | True if opening invoice Example: false | No |
| paymentInformation | PaymentInformation | Payment information | No |
| paymentMilestoneFlag | boolean | Payment milestone flag to indicate if payment milestones are set Example: true | No |
| paymentStatus | string | Sales invoice payment status Enum: "PENDING", "PARTIAL", "RECEIVED"Example: "PENDING" | No |
| purchaseOrderRefNo | string | Contact PO reference number Example: "CPO001" | No |
| recurring | boolean | True if Invoice is recurring. Example: true | No |
| recurringActivated | boolean | True if Invoice recurrence is active. Example: false | No |
| reservedStock | boolean | Reserved stock enabled Example: true | 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 |
| salesInvoiceCode | string | Sales invoice code Example: "SI001" | No |
| salesInvoiceDate | string | Sales Invoice date Example: "25-10-2019" | Yes |
| salesInvoiceDueDate | string | Sales Invoice due date Example: "25-10-2019" | Yes |
| salesInvoiceItems | [ SalesInvoiceItemDetailsUae ] | Sales invoice item details | No |
| salesInvoiceRecurring | SalesInvoiceRecurringDetails | Sales invoice item details | No |
| sequenceFormat | string | Sequence Format Id Example: 1 | No |
| shipByDate | string | Ship by date Example: "25-10-2019" | No |
| shipFrom | Address | Ship from address | No |
| shipTo | Address | Ship to address | No |
| status | string | Invoice status Enum: "OPEN", "DRAFT", "CLOSED"Example: "OPEN" | 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 |
| tdsInfo | [ SalesInvoiceTdsInfo ] | SalesInvoice Tds Info | No |
| totalAmount | number | Total amount Example: 12.322 | No |
| totalAmountInBaseCurrency | number | Total amount in base currency Example: 12.322 | No |
| unitPriceGstInclusive | boolean | Unit price is GST inclusive Example: false | No |
| warehouseCode | string | Warehouse Code Example: "WH-000001" | No |
| withheldAmount | number | Withheld Amount Example: 12.322 | No |
SalesInvoiceResponseUk
| Name | Type | Description | Required |
|---|---|---|---|
| additionalCharges | AdditionalCharges | Purchase invoice additional charges details | No |
| approvalStatus | string | Approval status Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"Example: "APPROVED" | No |
| attachmentIds | [ integer ] | No | |
| attachments | [ string ] | File attachments | No |
| attachmentsWithLink | [ AttachmentsResponse ] | Attachments Details | No |
| backOrder | boolean | Backorder flag to indicate if backorder created Example: true | No |
| billTo | Address | Bill to address | No |
| contact | ContactInfo | Contact details | Yes |
| contactCode | string | Contact Code Example: "C0001" | Yes |
| contactDto | ContactDto | Contact Details | Yes |
| currency | string | Currency Example: "C001" | Yes |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| documentSequenceCode | string | Sales invoice Sequence Code Example: "0000001" | No |
| draft | boolean | Sales invoice drafted Example: false | No |
| dropShip | boolean | Drop Ship flag to indicate if purchase invoice is created for drop ship Example: true | No |
| dueAmount | number | Amount Due Example: 12.322 | No |
| errors | [ string ] | List of validation error messages | No |
| exchangeRate | number | Exchange rate Example: 0.456345 | No |
| fulfillmentStatus | string | Sales invoice fulfillment status Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"Example: "UNFULFILLED" | No |
| fulfillmentType | string | Fulfillment type: NONE, DEFAULT, PICK_PACK_SHIP, DROP_SHIP Enum: "NONE", "DEFAULT", "PICK_PACK_SHIP", "DROP_SHIP"Example: "PICK_PACK_SHIP" | No |
| id | long | Sales invoice id Example: 1 | No |
| isPartialInvoice | boolean | Is Partial Invoice | Yes |
| journalEntryCode | string | Journal Entry Code Example: "JE0001" | No |
| knockoffInfo | [ KnockOffInfo ] | KnockOff Info | No |
| linkedCreditNote | [ KnockOffInfo ] | No | |
| linkedDebitNote | [ KnockOffInfo ] | No | |
| linkedDocuments | [ DocumentInfo ] | Linked Documents | No |
| memo | string | Memo Example: "Memo details" | No |
| openingDocumentNumber | string | Customer opening document number Example: "DC-0001" | No |
| openingInvoice | boolean | True if opening invoice Example: false | No |
| paymentInformation | PaymentInformation | Payment information | No |
| paymentMilestoneFlag | boolean | Payment milestone flag to indicate if payment milestones are set Example: true | No |
| paymentStatus | string | Sales invoice payment status Enum: "PENDING", "PARTIAL", "RECEIVED"Example: "PENDING" | No |
| purchaseOrderRefNo | string | Contact PO reference number Example: "CPO001" | No |
| recurring | boolean | True if Invoice is recurring. Example: true | No |
| recurringActivated | boolean | True if Invoice recurrence is active. Example: false | No |
| reservedStock | boolean | Reserved stock enabled Example: true | 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 |
| salesInvoiceCode | string | Sales invoice code Example: "SI001" | No |
| salesInvoiceDate | string | Sales Invoice date Example: "25-10-2019" | Yes |
| salesInvoiceDueDate | string | Sales Invoice due date Example: "25-10-2019" | Yes |
| salesInvoiceItems | [ SalesInvoiceItemDetailsUk ] | Sales invoice item details | No |
| salesInvoiceRecurring | SalesInvoiceRecurringDetails | Sales invoice item details | No |
| sequenceFormat | string | Sequence Format Id Example: 1 | No |
| shipByDate | string | Ship by date Example: "25-10-2019" | No |
| shipFrom | Address | Ship from address | No |
| shipTo | Address | Ship to address | No |
| status | string | Invoice status Enum: "OPEN", "DRAFT", "CLOSED"Example: "OPEN" | 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 |
| tdsInfo | [ SalesInvoiceTdsInfo ] | SalesInvoice Tds Info | No |
| totalAmount | number | Total amount Example: 12.322 | No |
| totalAmountInBaseCurrency | number | Total amount in base currency Example: 12.322 | No |
| unitPriceGstInclusive | boolean | Unit price is GST inclusive Example: false | No |
| warehouseCode | string | Warehouse Code Example: "WH-000001" | No |
| withheldAmount | number | Withheld Amount Example: 12.322 | No |
SalesInvoiceTdsInfo
| Name | Type | Description | Required |
|---|---|---|---|
| documentCode | string | No | |
| tdsAccountCode | string | No | |
| tdsAmount | number | No |
SalesInvoiceUpdateRequest
| Name | Type | Description | Required |
|---|---|---|---|
| backOrder | boolean | Backorder flag to indicate if backorder created Example: true | No |
| closedDate | dateTime | Sales Invoice closed on date Example: "05-12-2019" | No |
| fulfillmentCode | string | Fulfillment Code Example: "0000012" | No |
| fulfillmentDate | dateTime | No | |
| fulfillmentOn | dateTime | No | |
| fulfillmentStatus | string | Sales Fulfillment status Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"Example: "FULLY_FULFILLED" | No |
| fulfillmentType | string | Fulfillment type: NONE, DEFAULT, PICK_PACK_SHIP, DROP_SHIP Enum: "NONE", "DEFAULT", "PICK_PACK_SHIP", "DROP_SHIP"Example: "PICK_PACK_SHIP" | No |
| itemToFulfilledQtyMap | object | Fulfilled Quantity by Sales Invoice Item Example: [] | No |
| itemToFulfilledReservedQtyMap | object | Reserved quantity fulfillment data Example: [] | No |
| linkedDocuments | [ DocumentInfo ] | Linked Documents | No |
| paymentDate | dateTime | No | |
| paymentStatus | string | Payment status Enum: "PENDING", "PARTIAL", "RECEIVED"Example: "RECEIVED" | No |
| salesInvoiceCode | string | SalesInvoice Code Example: "0000012" | No |
| status | string | Invoice status Enum: "OPEN", "DRAFT", "CLOSED"Example: "OPEN" | No |
SalesOrderBulkDeleteResponseDto
| Name | Type | Description | Required |
|---|---|---|---|
| documentSequenceCode | string | documentSequenceCode Example: "QU-0000001" | 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 |
SalesOrderInformation
| Name | Type | Description | Required |
|---|---|---|---|
| additionalCharges | AdditionalCharges | Sales order additional charges details | No |
| attachmentIds | [ integer ] | No | |
| attachments | [ string ] | File attachments | No |
| backOrder | boolean | Backorder flag to indicate if backorder created Example: true | No |
| billTo | Address | Bill to address | No |
| closedDate | string | No | |
| contact | ContactInfo | Contact details | Yes |
| contactCode | string | Contact Code Example: "C0001" | Yes |
| contactDto | ContactInformation | Contact Details | Yes |
| currency | string | Currency Example: "C001" | Yes |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| customerType | string | Customer Type Enum: "EXPORT_WO_PAY", "EXPORT_W_PAY", "NA", "SEZ_WO_PAY", "SEZ_W_PAY"Example: "NA" | Yes |
| documentSequenceCode | string | Sales order Sequence Code Example: "0000001" | No |
| draft | boolean | Sales order drafted Example: false | No |
| exchangeRate | number | Exchange rate Example: 0.456345 | No |
| fulfillmentDate | string | No | |
| fulfillmentOn | string | No | |
| fulfillmentStatus | string | Sales order fulfillment status Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"Example: "UNFULFILLED" | No |
| fulfillmentType | string | Fulfillment type: NONE, DEFAULT, PICK_PACK_SHIP, DROP_SHIP Enum: "NONE", "DEFAULT", "PICK_PACK_SHIP", "DROP_SHIP"Example: "PICK_PACK_SHIP" | No |
| gstExchangeRate | number | GST Exchange rate if tax residency currency is different than base currency Example: 1 | No |
| gstin | string | GSTIN Example: "ABSASASSASASA198" | Yes |
| id | long | Sales order id Example: 1 | No |
| isPartialSalesOrder | boolean | Is Partial Sales Order | Yes |
| linkedQuotationDocuments | [ DocumentInfo ] | Linked Quotation Documents | No |
| linkedSalesInvoiceDocuments | [ DocumentInfo ] | Linked Sales Invoice Documents | No |
| linkedSalesInvoices | [ LinkedSalesInvoiceResponse ] | Linked Sales Invoices | No |
| memo | string | Memo Example: "Memo details" | No |
| openingDocumentNumber | string | Customer opening document number Example: "DC-0001" | No |
| openingSalesOrder | boolean | True if opening sales order Example: false | No |
| placeOfSupply | string | state in India Example: "Punjab" | Yes |
| purchaseOrderRefNo | string | Contact PO reference number Example: "CPO001" | No |
| recurring | boolean | True if Sales order is recurring. Example: true | No |
| recurringActivated | boolean | True if Sales order recurrence is active. Example: false | No |
| reservedStock | boolean | Reserved stock enabled Example: true | 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 |
| salesOrderCode | string | Sales order code Example: "SI001" | No |
| salesOrderDate | string | Sales order date Example: "25-10-2019" | Yes |
| salesOrderDueDate | string | Sales order due date Example: "25-10-2019" | Yes |
| salesOrderItems | [ SalesOrderItemInformation ] | Sales order item details | No |
| sequenceFormat | string | Sequence Format Id Example: 1 | No |
| shipByDate | string | Ship by date Example: "25-10-2019" | No |
| shipFrom | Address | Ship from address | No |
| shipTo | Address | Ship to address | No |
| status | string | Sales Order status Enum: "DRAFT", "OPEN", "CLOSED", "ARCHIVED", "PROCESSED"Example: "OPEN" | No |
| taxAmount | number | Tax amount Example: 2.322 | No |
| taxInvoiceNo | string | Tax Invoice No Example: 123456789 | 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 |
| unitPriceGstInclusive | boolean | Unit price is GST inclusive Example: false | No |
| vendorType | string | Vendor Type Enum: "IMPORT", "NA", "SEZ_W_PAY", "SEZ_WO_PAY"Example: "NA" | Yes |
| warehouseCode | string | Warehouse Code Example: "WH-000001" | No |
| whtRate | number | Wht rate Example: 1 | No |
SalesOrderItemDetails
| Name | Type | Description | Required |
|---|---|---|---|
| allocationType | string | Allocation Type Example: "NORMAL" | No |
| availableQuantity | number | Total available quantity Example: 3 | No |
| basePrice | number | Revenue Base price Example: 120 | No |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| discount | number | Discount Example: 2 | No |
| discountInPercent | boolean | Discount in percentage Example: true | No |
| documentSequenceCode | string | Product Document Sequence Code Example: "P-0000001" | Yes |
| documentUOMSchemaDefinition | DocumentUOMSchemaDefinition | Document UOM Schema Definition Example: 2 | Yes |
| documentUom | long | Document UOM id Example: 2 | Yes |
| errors | [ string ] | List of validation error messages | No |
| fulfillmentByDoc | [ ItemQtyFulfilledByDoc ] | Item Qty fulfilled by Fulfillment Doc Example: [] | No |
| id | long | ID Example: 2 | No |
| isPartialSalesOrder | boolean | Whether the Sales Order is a partial order Example: false | No |
| itemFulfillmentStatus | string | Item Fulfillment Status Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"Example: "UNFULFILLED" | No |
| lineNumber | integer | Line Number Example: 1 | No |
| linkedQuoteItem | long | Quote Item linked to sales order item Example: "QO-001" | No |
| linkedQuoteItemCode | string | Linked quote item code Example: "QO-002" | No |
| pendingQuantity | number | Pending Quantity Example: 3 | No |
| product | ProductResponse | Product Response Example: "product" | No |
| productCode | string | Product code Example: "P00001" | Yes |
| productDescription | string | Product description Example: "Apple watch" | No |
| productOrder | integer | Product view order Example: 1 | No |
| productQuantity | number | Product quantity Example: 2 | Yes |
| quantityFulfilled | number | quantity fulfilled Example: 10 | No |
| quantityFulfilledByFlowover | number | Total Quantity Fulfilled By Flowover | Yes |
| quantityFulfilledByUser | number | Total Quantity Fulfilled By User | Yes |
| reservedQuantitiesData | [ ReservedQuantityData ] | Reserved quantity data Example: [] | No |
| revRecDocumentItemDetails | RevRecDocumentItemDetails | Item Revenue Details Example: "revRecDocumentItemDetails" | No |
| salesOrderItemCode | string | Sales Order Item Code Example: "SII-000001" | No |
| salesOrderLineNumber | string | Sales Order Line Number Example: "ABSCDDSD1212" | No |
| tax | TaxDto | Tax details Example: "taxDto" | No |
| taxAmount | number | Tax amount Example: 0.5 | No |
| taxCode | string | Tax code Example: "GST7" | No |
| totalAmount | number | Total amount Example: 2.3 | Yes |
| type | string | Product type Enum: "TRACKED", "NONTRACKED"Example: "TRACKED" | Yes |
| unitPrice | number | Product unit price Example: 0.7 | Yes |
| uomQuantity | number | uom quantity Example: 2 | Yes |
| uomUnitPrice | number | UOM Unit price Example: 2.3 | Yes |
| updatedPartialQuantity | number | partial sales Order updated quantity Example: 10 | No |
SalesOrderItemDetailsIndia
| Name | Type | Description | Required |
|---|---|---|---|
| allocationType | string | Allocation Type Example: "NORMAL" | No |
| availableQuantity | number | Total available quantity Example: 3 | No |
| basePrice | number | Revenue Base price Example: 120 | No |
| cessAmount | number | cess amount Example: 40 | No |
| cessPercentage | number | Cess Percentage Example: 2.322 | No |
| cessRule | string | Cess rule expression Example: "Math.max(21amount/100,4170quantity/1000)" | No |
| cgstAmount | number | CGST tax amount Example: 60 | No |
| cgstRate | number | CGST tax rate Example: 6 | No |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| discount | number | Discount Example: 2 | No |
| discountInPercent | boolean | Discount in percentage Example: true | No |
| documentSequenceCode | string | Product Document Sequence Code Example: "P-0000001" | Yes |
| documentUOMSchemaDefinition | DocumentUOMSchemaDefinition | Document UOM Schema Definition Example: 2 | Yes |
| documentUom | long | Document UOM id Example: 2 | Yes |
| errors | [ string ] | List of validation error messages | No |
| fulfillmentByDoc | [ ItemQtyFulfilledByDoc ] | Item Qty fulfilled by Fulfillment Doc Example: [] | No |
| hsnOrSacCode | string | Hsn or Sac code Example: 110011 | No |
| id | long | ID Example: 2 | No |
| igstAmount | number | IGST tax amount Example: 120 | No |
| igstRate | number | IGST tax rate Example: 12 | No |
| isPartialSalesOrder | boolean | Whether the Sales Order is a partial order Example: false | No |
| itemFulfillmentStatus | string | Item Fulfillment Status Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"Example: "UNFULFILLED" | No |
| lineNumber | integer | Line Number Example: 1 | No |
| linkedQuoteItem | long | Quote Item linked to sales order item Example: "QO-001" | No |
| linkedQuoteItemCode | string | Linked quote item code Example: "QO-002" | No |
| otherRate | number | SGST tax rate Example: 6 | No |
| otherTaxAmount | number | Total amount Example: 1000 | Yes |
| pendingQuantity | number | Pending Quantity Example: 3 | No |
| product | ProductResponse | Product Response Example: "product" | No |
| productCode | string | Product code Example: "P00001" | Yes |
| productDescription | string | Product description Example: "Apple watch" | No |
| productOrder | integer | Product view order Example: 1 | No |
| productQuantity | number | Product quantity Example: 2 | Yes |
| quantityFulfilled | number | quantity fulfilled Example: 10 | No |
| quantityFulfilledByFlowover | number | Total Quantity Fulfilled By Flowover | Yes |
| quantityFulfilledByUser | number | Total Quantity Fulfilled By User | Yes |
| reservedQuantitiesData | [ ReservedQuantityData ] | Reserved quantity data Example: [] | No |
| revRecDocumentItemDetails | RevRecDocumentItemDetails | Item Revenue Details Example: "revRecDocumentItemDetails" | No |
| salesOrderItemCode | string | Sales Order Item Code Example: "SII-000001" | No |
| sgstAmount | number | SGST tax amount Example: 60 | No |
| sgstRate | number | SGST tax rate Example: 6 | No |
| tax | TaxDto | Tax details Example: "taxDto" | No |
| taxAmount | number | Tax amount Example: 160 | Yes |
| taxCode | string | Tax code Example: "GST7" | No |
| taxExemptionReason | string | Tax Exemption reason if taxPreference is true Enum: "EXEMPTED", "NON_GST"Example: "EXEMPTED" | No |
| taxPreference | boolean | Tax preference, whether Exempted or not Exempted Example: false | No |
| totalAmount | number | Total amount Example: 1000 | Yes |
| type | string | Product type Enum: "TRACKED", "NONTRACKED"Example: "TRACKED" | Yes |
| unitPrice | number | Product unit price Example: 0.7 | Yes |
| uomQuantity | number | uom quantity Example: 2 | Yes |
| uomUnitPrice | number | UOM Unit price Example: 2.3 | Yes |
| updatedPartialQuantity | number | partial sales Order updated quantity Example: 10 | No |
| userSetTaxes | boolean | Flag to check whether tax is user edited Example: false | No |
SalesOrderItemDetailsMalaysia
| Name | Type | Description | Required |
|---|---|---|---|
| allocationType | string | Allocation Type Example: "NORMAL" | No |
| availableQuantity | number | Total available quantity Example: 3 | No |
| basePrice | number | Revenue Base price Example: 120 | No |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| discount | number | Discount Example: 2 | No |
| discountInPercent | boolean | Discount in percentage Example: true | No |
| documentSequenceCode | string | Product Document Sequence Code Example: "P-0000001" | Yes |
| documentUOMSchemaDefinition | DocumentUOMSchemaDefinition | Document UOM Schema Definition Example: 2 | Yes |
| documentUom | long | Document UOM id Example: 2 | Yes |
| errors | [ string ] | List of validation error messages | No |
| fulfillmentByDoc | [ ItemQtyFulfilledByDoc ] | Item Qty fulfilled by Fulfillment Doc Example: [] | No |
| id | long | ID Example: 2 | No |
| isPartialSalesOrder | boolean | Whether the Sales Order is a partial order Example: false | No |
| itemFulfillmentStatus | string | Item Fulfillment Status Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"Example: "UNFULFILLED" | No |
| lineNumber | integer | Line Number Example: 1 | No |
| linkedQuoteItem | long | Quote Item linked to sales order item Example: "QO-001" | No |
| linkedQuoteItemCode | string | Linked quote item code Example: "QO-002" | No |
| pendingQuantity | number | Pending Quantity Example: 3 | No |
| product | ProductResponse | Product Response Example: "product" | No |
| productCode | string | Product code Example: "P00001" | Yes |
| productDescription | string | Product description Example: "Apple watch" | No |
| productOrder | integer | Product view order Example: 1 | No |
| productQuantity | number | Product quantity Example: 2 | Yes |
| quantityFulfilled | number | quantity fulfilled Example: 10 | No |
| quantityFulfilledByFlowover | number | Total Quantity Fulfilled By Flowover | Yes |
| quantityFulfilledByUser | number | Total Quantity Fulfilled By User | Yes |
| reservedQuantitiesData | [ ReservedQuantityData ] | Reserved quantity data Example: [] | No |
| revRecDocumentItemDetails | RevRecDocumentItemDetails | Item Revenue Details Example: "revRecDocumentItemDetails" | No |
| salesOrderItemCode | string | Sales Order Item Code Example: "SII-000001" | No |
| tax | TaxDto | Tax details Example: "taxDto" | No |
| taxAmount | number | Tax amount Example: 0.5 | No |
| taxCode | string | Tax code Example: "GST7" | No |
| totalAmount | number | Total amount Example: 2.3 | Yes |
| type | string | Product type Enum: "TRACKED", "NONTRACKED"Example: "TRACKED" | Yes |
| unitPrice | number | Product unit price Example: 0.7 | Yes |
| uomQuantity | number | uom quantity Example: 2 | Yes |
| uomUnitPrice | number | UOM Unit price Example: 2.3 | Yes |
| updatedPartialQuantity | number | partial sales Order updated quantity Example: 10 | No |
SalesOrderItemInformation
| Name | Type | Description | Required |
|---|---|---|---|
| allocationType | string | Allocation Type Example: "NORMAL" | No |
| availableQuantity | number | Total available quantity Example: 3 | No |
| basePrice | number | Revenue Base price Example: 120 | No |
| cessAmount | number | cess amount Example: 40 | No |
| cessPercentage | number | Cess Percentage Example: 2.322 | No |
| cessRule | string | Cess rule expression Example: "Math.max(21amount/100,4170quantity/1000)" | No |
| cgstAmount | number | CGST tax amount Example: 60 | No |
| cgstRate | number | CGST tax rate Example: 6 | No |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| discount | number | Discount Example: 2 | No |
| discountInPercent | boolean | Discount in percentage Example: true | No |
| documentSequenceCode | string | Product Document Sequence Code Example: "P-0000001" | Yes |
| documentUOMSchemaDefinition | DocumentUOMSchemaDefinition | Document UOM Schema Definition Example: 2 | Yes |
| documentUom | long | Document UOM id Example: 2 | Yes |
| exciseAmount | number | Excise amount Example: 0.5 | No |
| exciseRate | double | Rate of Excise Example: 5 | No |
| exciseType | string | Excise type Enum: "PERCENT", "FLAT"Example: "FLAT" | No |
| fulfilledQuantity | number | Total Fulfilled Quantity Example: 3 | No |
| fulfilledQuantityByFlowover | number | Total Fulfilled Quantity By Flowover Example: 3 | No |
| fulfilledQuantityByUser | number | Total Fulfilled Quantity By User Example: 3 | No |
| fulfilledQuantityInvoiced | number | Total Fulfilled Quantity Invoiced Example: 3 | No |
| fulfillmentByDoc | [ ItemQtyFulfilledByDoc ] | Quantity fulfilled docs | No |
| hsnOrSacCode | string | Hsn or Sac code Example: 110011 | No |
| id | long | ID Example: 2 | No |
| igstAmount | number | IGST tax amount Example: 120 | No |
| igstRate | number | IGST tax rate Example: 12 | No |
| isPartialSalesOrder | boolean | Whether the Sales Order is a partial order Example: false | No |
| lineNumber | integer | Line Number Example: 1 | No |
| linkedQuoteItem | long | Quote Item linked to sales order item Example: "QO-001" | No |
| otherRate | number | Other Tax total Rate Example: 12 | No |
| otherTaxAmount | number | Other tax amount Example: 60 | No |
| pendingAmount | number | Pending amount Example: 100 | No |
| pendingQuantity | number | Pending Quantity Example: 3 | No |
| product | ProductInformation | Product Response Example: "product" | No |
| productCode | string | Product code Example: "P00001" | Yes |
| productDescription | string | Product description Example: "Apple watch" | No |
| productOrder | integer | Product view order Example: 1 | No |
| productQuantity | number | Product quantity Example: 2 | Yes |
| quantityFulfilled | number | quantity fulfilled Example: 10 | No |
| reservedQuantitiesData | [ ReservedQuantityData ] | Reserved quantity data Example: [] | No |
| revRecDocumentItemDetails | RevRecDocumentItemDetails | Item Revenue Details Example: "revRecDocumentItemDetails" | No |
| salesOrderItemCode | string | Sales Order Item Code Example: "SII-000001" | No |
| salesOrderLineNumber | string | Sales Order Line Number Example: "ABSCDDSD1212" | No |
| sgstAmount | number | SGST tax amount Example: 60 | No |
| sgstRate | number | SGST tax rate Example: 6 | No |
| tax | TaxDto | Tax details Example: "taxDto" | No |
| taxAmount | number | Tax amount Example: 0.5 | No |
| taxCode | string | Tax code Example: "GST7" | No |
| taxDetails | [ DocumentItemTaxMappingDto ] | Tax Details for Tax Group | No |
| taxExemptionReason | string | Tax Exemption reason if taxPreference is true Enum: "EXEMPTED", "NON_GST"Example: "EXEMPTED" | No |
| taxPreference | boolean | Tax preference, whether Exempted or not Exempted Example: false | No |
| totalAmount | number | Total amount Example: 2.3 | Yes |
| type | string | Product type Enum: "TRACKED", "NONTRACKED"Example: "TRACKED" | Yes |
| unitPrice | number | Product unit price Example: 0.7 | Yes |
| uomQuantity | number | uom quantity Example: 2 | Yes |
| uomUnitPrice | number | UOM Unit price Example: 2.3 | Yes |
| updatedPartialQuantity | number | partial sales order updated quantity Example: 10 | No |
| userSetTaxes | boolean | Flag to check whether tax is user edited Example: false | No |
SalesOrderProgressDto
| Name | Type | Description | Required |
|---|---|---|---|
| field | string | field name Example: "Invoice" | No |
| order | integer | field order Example: 1 | No |
| status | string | field status Example: "COMPLETED" | No |
SalesOrderReportInfo
| Name | Type | Description | Required |
|---|---|---|---|
| contactName | string | No | |
| customField | [ CustomFieldItem ] | No | |
| docCurrency | string | No | |
| documentCode | string | No | |
| documentDate | string | No | |
| dueDate | string | No | |
| fulfillmentStatus | string | No | |
| totalAmount | string | No |
SalesOrderRequest
| Name | Type | Description | Required |
|---|---|---|---|
| additionalCharges | AdditionalCharges | Sales Order additional charges details | No |
| approvalStatus | string | Approval status Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"Example: "APPROVED" | No |
| attachmentIds | [ integer ] | No | |
| attachments | [ string ] | File attachments | No |
| backOrder | boolean | Backorder flag to indicate if sales order is backorder Example: true | No |
| billTo | Address | Bill to address | No |
| contact | ContactInfo | Contact details | Yes |
| contactCode | string | Contact Code Example: "C0001" | Yes |
| currency | string | Currency Example: "C001" | Yes |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| documentSequenceCode | string | Sales Order Code Example: "0000001" | No |
| draft | boolean | True if want to save as draft. Example: false | No |
| errors | [ string ] | List of validation error messages | No |
| exchangeRate | number | Exchange rate Example: 0.456345 | No |
| fulfillmentComplete | boolean | True if auto fulfilled is required. Example: false | No |
| fulfillmentStatus | string | fulfillment status Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"Example: "PARTIAL_FULFILLED" | No |
| fulfillmentType | string | Fulfillment type: NONE, DEFAULT, PICK_PACK_SHIP, DROP_SHIP Enum: "NONE", "DEFAULT", "PICK_PACK_SHIP", "DROP_SHIP"Example: "PICK_PACK_SHIP" | No |
| gstExchangeRate | number | GST Exchange rate if tax residency currency is different than base currency Example: 1 | No |
| isPartialSalesOrder | boolean | True if is partial Sales Order Example: false | No |
| linkedQuotationDocuments | [ DocumentInfo ] | Linked Quotation Documents | No |
| linkedSalesInvoiceDocuments | [ DocumentInfo ] | Linked Sales Invoice Documents | No |
| linkedSalesInvoices | [ LinkedSalesInvoiceResponse ] | No | |
| memo | string | Memo Example: "Memo details" | No |
| openingDocumentNumber | string | Customer opening document number Example: "DC-0001" | No |
| openingSalesOrder | boolean | True if opening sales order Example: false | No |
| purchaseOrderRefNo | string | Contact PO reference number Example: "CPO001" | No |
| recurring | boolean | True if Sales Order is recurring. Example: true | No |
| recurringActivated | boolean | True if Sales order recurrence is active. Example: false | No |
| reservedStock | boolean | Reserved stock enabled Example: true | 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 |
| salesOrderDate | string | Sales Order date Example: "25-10-2019" | Yes |
| salesOrderDueDate | string | Sales Order due date Example: "25-10-2019" | Yes |
| salesOrderItems | [ SalesOrderItemDetails ] | Sales Order item details | No |
| seqCodeAlreadyDumped | boolean | True if Sequence Code is already dumped. Example: false | No |
| sequenceFormat | string | Sequence Format Id Example: 1 | No |
| shipByDate | string | Ship by date Example: "25-10-2019" | No |
| shipFrom | Address | Ship from address | No |
| shipTo | Address | Ship to address | No |
| status | string | Sales Order status Enum: "DRAFT", "OPEN", "CLOSED", "ARCHIVED", "PROCESSED"Example: "OPEN" | 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 |
| unitPriceGstInclusive | boolean | Unit price is GST inclusive Example: false | No |
| warehouseCode | string | Warehouse Code Example: "WH-000001" | No |
SalesOrderRequestDto
| Name | Type | Description | Required |
|---|---|---|---|
| addProcessingFee | boolean | flag to add processing fee Example: true | No |
| amount | number | Sales order amount Example: 3546.23 | No |
| companyName | string | No | |
| currency | string | Currency Example: "USD" | No |
| customerEmail | string | Customer email Example: "john@doe.com" | No |
| customerName | string | Customer Name Example: "John" | No |
| daysUntilDue | long | due date Example: 30 | No |
| description | string | Description Example: "Sales Order for inventory" | No |
| dueAmount | number | No | |
| dueDate | string | No | |
| salesOrderAmount | number | No | |
| salesOrderDate | string | No | |
| salesOrderNumber | string | No |
SalesOrderRequestIndia
| Name | Type | Description | Required |
|---|---|---|---|
| additionalCharges | AdditionalCharges | Sales Order additional charges details | No |
| approvalStatus | string | Approval status Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"Example: "APPROVED" | No |
| attachmentIds | [ integer ] | No | |
| attachments | [ string ] | File attachments | No |
| backOrder | boolean | Backorder flag to indicate if sales order is backorder Example: true | No |
| billTo | Address | Bill to address | No |
| contact | ContactInfo | Contact details | Yes |
| contactCode | string | Contact Code Example: "C0001" | Yes |
| currency | string | Currency Example: "C001" | Yes |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| customerType | string | Customer Type Enum: "EXPORT_WO_PAY", "EXPORT_W_PAY", "NA", "SEZ_WO_PAY", "SEZ_W_PAY"Example: "NA" | Yes |
| documentSequenceCode | string | Sales Order Code Example: "0000001" | No |
| draft | boolean | True if want to save as draft. Example: false | No |
| errors | [ string ] | List of validation error messages | No |
| exchangeRate | number | Exchange rate Example: 0.456345 | No |
| fulfillmentComplete | boolean | True if auto fulfilled is required. Example: false | No |
| fulfillmentStatus | string | fulfillment status Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"Example: "PARTIAL_FULFILLED" | No |
| fulfillmentType | string | Fulfillment type: NONE, DEFAULT, PICK_PACK_SHIP, DROP_SHIP Enum: "NONE", "DEFAULT", "PICK_PACK_SHIP", "DROP_SHIP"Example: "PICK_PACK_SHIP" | No |
| gstExchangeRate | number | GST Exchange rate if tax residency currency is different than base currency Example: 1 | No |
| gstTreatment | string | GST Treatment Enum: "REGISTERED_BUSINESS_REGULAR=Registered Business - Regular", "REGISTERED_BUSINESS_COMPOSITION=Registered Business - Composition", "UNREGISTERED_BUSINESS=Unregistered Business", "CUSTOMER=Consumer", "OVERSEAS=Overseas", "SPECIAL_ECONOMIC_ZONE=Special Economic Zone", "DEEMED_EXPORT=Deemed Export"Example: "REGISTERED_BUSINESS_REGULAR" | Yes |
| gstin | string | GSTIN Example: "ABSASASSASASA198" | Yes |
| isPartialSalesOrder | boolean | True if is partial Sales Order Example: false | No |
| linkedQuotationDocuments | [ DocumentInfo ] | Linked Quotation Documents | No |
| linkedSalesInvoiceDocuments | [ DocumentInfo ] | Linked Sales Invoice Documents | No |
| linkedSalesInvoices | [ LinkedSalesInvoiceResponse ] | No | |
| memo | string | Memo Example: "Memo details" | No |
| openingDocumentNumber | string | Customer opening document number Example: "DC-0001" | No |
| openingSalesOrder | boolean | True if opening sales order Example: false | No |
| placeOfSupply | string | state in India Example: "Punjab" | Yes |
| purchaseOrderRefNo | string | Contact PO reference number Example: "CPO001" | No |
| recurring | boolean | True if Sales Order is recurring. Example: true | No |
| recurringActivated | boolean | True if Sales order recurrence is active. Example: false | No |
| reservedStock | boolean | Reserved stock enabled Example: true | 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 |
| salesOrderDate | string | Sales Order date Example: "25-10-2019" | Yes |
| salesOrderDueDate | string | Sales Order due date Example: "25-10-2019" | Yes |
| salesOrderItems | [ SalesOrderItemDetailsIndia ] | Sales Order item details | No |
| seqCodeAlreadyDumped | boolean | True if Sequence Code is already dumped. Example: false | No |
| sequenceFormat | string | Sequence Format Id Example: 1 | No |
| shipByDate | string | Ship by date Example: "25-10-2019" | No |
| shipFrom | Address | Ship from address | No |
| shipTo | Address | Ship to address | No |
| status | string | Sales Order status Enum: "DRAFT", "OPEN", "CLOSED", "ARCHIVED", "PROCESSED"Example: "OPEN" | 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 |
| unitPriceGstInclusive | boolean | Unit price is GST inclusive Example: false | No |
| vendorType | string | Vendor Type Enum: "IMPORT", "NA", "SEZ_W_PAY", "SEZ_WO_PAY"Example: "NA" | Yes |
| warehouseCode | string | Warehouse Code Example: "WH-000001" | No |
SalesOrderRequestMalaysia
| Name | Type | Description | Required |
|---|---|---|---|
| additionalCharges | AdditionalCharges | Sales Order additional charges details | No |
| approvalStatus | string | Approval status Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"Example: "APPROVED" | No |
| attachmentIds | [ integer ] | No | |
| attachments | [ string ] | File attachments | No |
| backOrder | boolean | Backorder flag to indicate if sales order is backorder Example: true | No |
| billTo | Address | Bill to address | No |
| contact | ContactInfo | Contact details | Yes |
| contactCode | string | Contact Code Example: "C0001" | Yes |
| currency | string | Currency Example: "C001" | Yes |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| documentSequenceCode | string | Sales Order Code Example: "0000001" | No |
| draft | boolean | True if want to save as draft. Example: false | No |
| errors | [ string ] | List of validation error messages | No |
| exchangeRate | number | Exchange rate Example: 0.456345 | No |
| fulfillmentComplete | boolean | True if auto fulfilled is required. Example: false | No |
| fulfillmentStatus | string | fulfillment status Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"Example: "PARTIAL_FULFILLED" | No |
| fulfillmentType | string | Fulfillment type: NONE, DEFAULT, PICK_PACK_SHIP, DROP_SHIP Enum: "NONE", "DEFAULT", "PICK_PACK_SHIP", "DROP_SHIP"Example: "PICK_PACK_SHIP" | No |
| gstExchangeRate | number | GST Exchange rate if tax residency currency is different than base currency Example: 1 | No |
| isPartialSalesOrder | boolean | True if is partial Sales Order Example: false | No |
| linkedQuotationDocuments | [ DocumentInfo ] | Linked Quotation Documents | No |
| linkedSalesInvoiceDocuments | [ DocumentInfo ] | Linked Sales Invoice Documents | No |
| linkedSalesInvoices | [ LinkedSalesInvoiceResponse ] | No | |
| memo | string | Memo Example: "Memo details" | No |
| openingDocumentNumber | string | Customer opening document number Example: "DC-0001" | No |
| openingSalesOrder | boolean | True if opening sales order Example: false | No |
| purchaseOrderRefNo | string | Contact PO reference number Example: "CPO001" | No |
| recurring | boolean | True if Sales Order is recurring. Example: true | No |
| recurringActivated | boolean | True if Sales order recurrence is active. Example: false | No |
| reservedStock | boolean | Reserved stock enabled Example: true | 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 |
| salesOrderDate | string | Sales Order date Example: "25-10-2019" | Yes |
| salesOrderDueDate | string | Sales Order due date Example: "25-10-2019" | Yes |
| salesOrderItems | [ SalesOrderItemDetailsMalaysia ] | Sales Order item details | No |
| seqCodeAlreadyDumped | boolean | True if Sequence Code is already dumped. Example: false | No |
| sequenceFormat | string | Sequence Format Id Example: 1 | No |
| shipByDate | string | Ship by date Example: "25-10-2019" | No |
| shipFrom | Address | Ship from address | No |
| shipTo | Address | Ship to address | No |
| status | string | Sales Order status Enum: "DRAFT", "OPEN", "CLOSED", "ARCHIVED", "PROCESSED"Example: "OPEN" | 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 |
| unitPriceGstInclusive | boolean | Unit price is GST inclusive Example: false | No |
| warehouseCode | string | Warehouse Code Example: "WH-000001" | No |
SalesOrderResponse
| Name | Type | Description | Required |
|---|---|---|---|
| additionalCharges | AdditionalCharges | Sales order additional charges details | No |
| amountPaid | number | Total Amount paid from all the invoices | No |
| approvalStatus | string | Approval status Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"Example: "APPROVED" | No |
| attachmentIds | [ integer ] | No | |
| attachments | [ string ] | File attachments | No |
| attachmentsWithLink | [ AttachmentsResponse ] | Attachments Details | No |
| backOrder | boolean | Backorder flag to indicate if backorder created Example: true | No |
| balanceDue | number | Total amount due from all the invoices | No |
| billTo | Address | Bill to address | No |
| contact | ContactInfo | Contact details | Yes |
| contactCode | string | Contact Code Example: "C0001" | Yes |
| contactDto | ContactDto | Contact Details | Yes |
| currency | string | Currency Example: "C001" | Yes |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| documentSequenceCode | string | Sales order Sequence Code Example: "0000001" | No |
| draft | boolean | Sales order drafted Example: false | No |
| errors | [ string ] | List of validation error messages | No |
| exchangeRate | number | Exchange rate Example: 0.456345 | No |
| fulfillmentStatus | string | Sales order fulfillment status Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"Example: "UNFULFILLED" | No |
| fulfillmentType | string | Fulfillment type: NONE, DEFAULT, PICK_PACK_SHIP, DROP_SHIP Enum: "NONE", "DEFAULT", "PICK_PACK_SHIP", "DROP_SHIP"Example: "PICK_PACK_SHIP" | No |
| id | long | Sales order id Example: 1 | No |
| isPartialSalesOrder | boolean | Is Partial sales order | Yes |
| linkedQuotationDocuments | [ DocumentInfo ] | Linked Quotation Documents | No |
| linkedSalesInvoiceDocuments | [ DocumentInfo ] | Linked Sales Invoice Documents | No |
| linkedSalesInvoices | [ LinkedSalesInvoiceResponse ] | No | |
| linkedWorkOrderDocuments | [ DocumentInfo ] | No | |
| memo | string | Memo Example: "Memo details" | No |
| openingDocumentNumber | string | Customer opening document number Example: "DC-0001" | No |
| openingSalesOrder | boolean | True if opening sales order Example: false | No |
| orderProgress | [ SalesOrderProgressDto ] | Sales order different status | No |
| productionStatus | string | Product status of all linked WO | No |
| purchaseOrderRefNo | string | Contact PO reference number Example: "CPO001" | No |
| recurring | boolean | True if sales order is recurring. Example: true | No |
| recurringActivated | boolean | True if sales order recurrence is active. Example: false | No |
| reservedStock | boolean | Reserved stock enabled Example: true | 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 |
| salesOrderCode | string | Sales order code Example: "SI001" | No |
| salesOrderDate | string | Sales order date Example: "25-10-2019" | Yes |
| salesOrderDueDate | string | Sales sales order due date Example: "25-10-2019" | Yes |
| salesOrderItems | [ SalesOrderItemDetails ] | Sales order item details | No |
| sequenceFormat | string | Sequence Format Id Example: 1 | No |
| shipByDate | string | Ship by date Example: "25-10-2019" | No |
| shipFrom | Address | Ship from address | No |
| shipTo | Address | Ship to address | No |
| status | string | Sales Order status Enum: "DRAFT", "OPEN", "CLOSED", "ARCHIVED", "PROCESSED"Example: "OPEN" | 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 |
| unitPriceGstInclusive | boolean | Unit price is GST inclusive Example: false | No |
| warehouseCode | string | Warehouse Code Example: "WH-000001" | No |
SalesOrderResponseIndia
| Name | Type | Description | Required |
|---|---|---|---|
| additionalCharges | AdditionalCharges | Sales order additional charges details | No |
| amountPaid | number | Total Amount paid from all the invoices | No |
| approvalStatus | string | Approval status Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"Example: "APPROVED" | No |
| attachmentIds | [ integer ] | No | |
| attachments | [ string ] | File attachments | No |
| attachmentsWithLink | [ AttachmentsResponse ] | Attachments Details | No |
| backOrder | boolean | Backorder flag to indicate if backorder created Example: true | No |
| balanceDue | number | Total amount due from all the invoices | No |
| billTo | Address | Bill to address | No |
| contact | ContactInfo | Contact details | Yes |
| contactCode | string | Contact Code Example: "C0001" | Yes |
| contactDto | ContactDto | Contact Details | Yes |
| currency | string | Currency Example: "C001" | Yes |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| customerType | string | Customer Type Enum: "EXPORT_WO_PAY", "EXPORT_W_PAY", "NA", "SEZ_WO_PAY", "SEZ_W_PAY"Example: "NA" | Yes |
| documentSequenceCode | string | Sales order Sequence Code Example: "0000001" | No |
| draft | boolean | Sales order drafted Example: false | No |
| errors | [ string ] | List of validation error messages | No |
| exchangeRate | number | Exchange rate Example: 0.456345 | No |
| fulfillmentStatus | string | Sales order fulfillment status Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"Example: "UNFULFILLED" | No |
| fulfillmentType | string | Fulfillment type: NONE, DEFAULT, PICK_PACK_SHIP, DROP_SHIP Enum: "NONE", "DEFAULT", "PICK_PACK_SHIP", "DROP_SHIP"Example: "PICK_PACK_SHIP" | No |
| gstTreatment | string | GST Treatment Enum: "REGISTERED_BUSINESS_REGULAR=Registered Business - Regular", "REGISTERED_BUSINESS_COMPOSITION=Registered Business - Composition", "UNREGISTERED_BUSINESS=Unregistered Business", "CUSTOMER=Consumer", "OVERSEAS=Overseas", "SPECIAL_ECONOMIC_ZONE=Special Economic Zone", "DEEMED_EXPORT=Deemed Export"Example: "REGISTERED_BUSINESS_REGULAR" | Yes |
| gstin | string | GSTIN Example: "ABSASASSASASA198" | Yes |
| id | long | Sales order id Example: 1 | No |
| isPartialSalesOrder | boolean | Is Partial sales order | Yes |
| linkedQuotationDocuments | [ DocumentInfo ] | Linked Quotation Documents | No |
| linkedSalesInvoiceDocuments | [ DocumentInfo ] | Linked Sales Invoice Documents | No |
| linkedSalesInvoices | [ LinkedSalesInvoiceResponse ] | No | |
| linkedWorkOrderDocuments | [ DocumentInfo ] | No | |
| memo | string | Memo Example: "Memo details" | No |
| openingDocumentNumber | string | Customer opening document number Example: "DC-0001" | No |
| openingSalesOrder | boolean | True if opening sales order Example: false | No |
| orderProgress | [ SalesOrderProgressDto ] | Sales order different status | No |
| placeOfSupply | string | state in India Example: "Punjab" | Yes |
| productionStatus | string | Product status of all linked WO | No |
| purchaseOrderRefNo | string | Contact PO reference number Example: "CPO001" | No |
| recurring | boolean | True if sales order is recurring. Example: true | No |
| recurringActivated | boolean | True if sales order recurrence is active. Example: false | No |
| reservedStock | boolean | Reserved stock enabled Example: true | 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 |
| salesOrderCode | string | Sales order code Example: "SI001" | No |
| salesOrderDate | string | Sales order date Example: "25-10-2019" | Yes |
| salesOrderDueDate | string | Sales sales order due date Example: "25-10-2019" | Yes |
| salesOrderItems | [ SalesOrderItemDetailsIndia ] | Sales order item details | No |
| sequenceFormat | string | Sequence Format Id Example: 1 | No |
| shipByDate | string | Ship by date Example: "25-10-2019" | No |
| shipFrom | Address | Ship from address | No |
| shipTo | Address | Ship to address | No |
| status | string | Sales Order status Enum: "DRAFT", "OPEN", "CLOSED", "ARCHIVED", "PROCESSED"Example: "OPEN" | 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 |
| unitPriceGstInclusive | boolean | Unit price is GST inclusive Example: false | No |
| vendorType | string | Vendor Type Enum: "IMPORT", "NA", "SEZ_W_PAY", "SEZ_WO_PAY"Example: "NA" | Yes |
| warehouseCode | string | Warehouse Code Example: "WH-000001" | No |
SalesOrderResponseMalaysia
| Name | Type | Description | Required |
|---|---|---|---|
| additionalCharges | AdditionalCharges | Sales order additional charges details | No |
| amountPaid | number | Total Amount paid from all the invoices | No |
| approvalStatus | string | Approval status Enum: "APPROVED", "PENDING_FOR_APPROVAL", "REJECTED", "NOT_REQUIRED"Example: "APPROVED" | No |
| attachmentIds | [ integer ] | No | |
| attachments | [ string ] | File attachments | No |
| attachmentsWithLink | [ AttachmentsResponse ] | Attachments Details | No |
| backOrder | boolean | Backorder flag to indicate if backorder created Example: true | No |
| balanceDue | number | Total amount due from all the invoices | No |
| billTo | Address | Bill to address | No |
| contact | ContactInfo | Contact details | Yes |
| contactCode | string | Contact Code Example: "C0001" | Yes |
| contactDto | ContactDto | Contact Details | Yes |
| currency | string | Currency Example: "C001" | Yes |
| customField | [ CustomFieldItem ] | List of custom fields | No |
| documentSequenceCode | string | Sales order Sequence Code Example: "0000001" | No |
| draft | boolean | Sales order drafted Example: false | No |
| errors | [ string ] | List of validation error messages | No |
| exchangeRate | number | Exchange rate Example: 0.456345 | No |
| fulfillmentStatus | string | Sales order fulfillment status Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"Example: "UNFULFILLED" | No |
| fulfillmentType | string | Fulfillment type: NONE, DEFAULT, PICK_PACK_SHIP, DROP_SHIP Enum: "NONE", "DEFAULT", "PICK_PACK_SHIP", "DROP_SHIP"Example: "PICK_PACK_SHIP" | No |
| id | long | Sales order id Example: 1 | No |
| isPartialSalesOrder | boolean | Is Partial sales order | Yes |
| linkedQuotationDocuments | [ DocumentInfo ] | Linked Quotation Documents | No |
| linkedSalesInvoiceDocuments | [ DocumentInfo ] | Linked Sales Invoice Documents | No |
| linkedSalesInvoices | [ LinkedSalesInvoiceResponse ] | No | |
| linkedWorkOrderDocuments | [ DocumentInfo ] | No | |
| memo | string | Memo Example: "Memo details" | No |
| openingDocumentNumber | string | Customer opening document number Example: "DC-0001" | No |
| openingSalesOrder | boolean | True if opening sales order Example: false | No |
| orderProgress | [ SalesOrderProgressDto ] | Sales order different status | No |
| productionStatus | string | Product status of all linked WO | No |
| purchaseOrderRefNo | string | Contact PO reference number Example: "CPO001" | No |
| recurring | boolean | True if sales order is recurring. Example: true | No |
| recurringActivated | boolean | True if sales order recurrence is active. Example: false | No |
| reservedStock | boolean | Reserved stock enabled Example: true | 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 |
| salesOrderCode | string | Sales order code Example: "SI001" | No |
| salesOrderDate | string | Sales order date Example: "25-10-2019" | Yes |
| salesOrderDueDate | string | Sales sales order due date Example: "25-10-2019" | Yes |
| salesOrderItems | [ SalesOrderItemDetailsMalaysia ] | Sales order item details | No |
| sequenceFormat | string | Sequence Format Id Example: 1 | No |
| shipByDate | string | Ship by date Example: "25-10-2019" | No |
| shipFrom | Address | Ship from address | No |
| shipTo | Address | Ship to address | No |
| status | string | Sales Order status Enum: "DRAFT", "OPEN", "CLOSED", "ARCHIVED", "PROCESSED"Example: "OPEN" | 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 |
| unitPriceGstInclusive | boolean | Unit price is GST inclusive Example: false | No |
| warehouseCode | string | Warehouse Code Example: "WH-000001" | No |
SalesOrderUpdateRequest
| Name | Type | Description | Required |
|---|---|---|---|
| backOrder | boolean | Backorder flag to indicate if backorder created Example: true | No |
| closedDate | dateTime | Sales Invoice closed on date Example: "05-12-2019" | No |
| fulfilledQtyByItem | object | Fulfilled Quantity by Sales order Item Example: [] | No |
| fulfillmentCode | string | Fulfillment Code Example: "0000012" | No |
| fulfillmentDate | dateTime | No | |
| fulfillmentOn | dateTime | No | |
| fulfillmentStatus | string | Sales Fulfillment status Enum: "UNFULFILLED", "PARTIAL_FULFILLED", "FULLY_FULFILLED"Example: "FULLY_FULFILLED" | No |
| fulfillmentType | string | Fulfillment type: NONE, DEFAULT, PICK_PACK_SHIP, DROP_SHIP Enum: "NONE", "DEFAULT", "PICK_PACK_SHIP", "DROP_SHIP"Example: "PICK_PACK_SHIP" | No |
| isUpdateSIItemFulfillmentQty | boolean | Whether to update Sales Invoice Item Fulfillment Qty Example: false | No |
| isUpdateSalesOrderStatus | boolean | Whether to update Sales order status Example: false | No |
| itemToFulfilledQtyMap | object | Fulfilled Quantity by Sales Order Item Example: [] | No |
| itemToFulfilledReservedQtyMap | object | Reserved quantity fulfillment data Example: [] | No |
| linkedQuotationDocuments | [ DocumentInfo ] | Linked Quotation Documents | No |
| linkedSalesInvoiceDocuments | [ DocumentInfo ] | Linked Invoice Documents | No |
| operation | string | Partial Invoice Item added Example: "add" | No |
| partialInvoiceItemsQuantities | object | Partial Invoice Item quantities Example: [] | No |
| reservedQuantityFulfillmentItemDtoByItem | object | Reserved quantity fulfillment data Example: [] | No |
| salesOrderCode | string | Sales Order Code Example: "0000012" | No |
| salesOrderId | long | Sales Order ID Example: 123 | No |
| status | string | Sales order status Enum: "DRAFT", "OPEN", "CLOSED", "ARCHIVED", "PROCESSED"Example: "OPEN" | No |
SalesTaxPaymentDto
| Name | Type | Description | Required |
|---|---|---|---|
| accountCode | string | Pay from account code Example: "AC-0000001" | No |
| accountName | string | Pay from account name Example: "Bank" | No |
| agencyCode | string | Tax Agency code Example: "CA" | No |
| agencyName | string | Tax Agency Name Example: "California" | No |
| endDate | dateTime | Example: "31-01-2022" | No |
| id | long | No | |
| memo | string | Example: "Sales Tax Payment" | No |
| paymentAmount | number | Sales payment tax amount for period Example: 100 | No |
| paymentDate | dateTime | Example: "01-02-2022" | No |
| startDate | dateTime | Example: "01-02-2022" | No |
SalesTaxPaymentExportDto
| Name | Type | Description | Required |
|---|---|---|---|
| accountCode | string | Pay from account code Example: "AC-0000001" | No |
| accountName | string | Pay from account name Example: "Bank" | No |
| agencyCode | string | Tax Agency code Example: "CA" | No |
| agencyName | string | Tax Agency Name Example: "California" | No |
| endDate | dateTime | Example: "31-01-2022" | No |
| fileFormat | string | Enum: "XLS", "PDF", "CSV" | No |
| id | long | No | |
| memo | string | Example: "Sales Tax Payment" | No |
| paymentAmount | number | Sales payment tax amount for period Example: 100 | No |
| paymentDate | dateTime | Example: "01-02-2022" | No |
| startDate | dateTime | Example: "01-02-2022" | No |
SalesTaxReviewResponse
| Name | Type | Description | Required |
|---|---|---|---|
| accountingBasis | string | Enum: "ACCRUAL", "CASH" | No |
| agencyCode | string | No | |
| agencyName | string | No | |
| dueDate | dateTime | No | |
| duePeriod | string | No | |
| endDate | dateTime | No | |
| filingFrequency | string | Enum: "MONTHLY", "QUARTERLY", "YEARLY" | No |
| salesTaxByRegions | object | No | |
| salesTaxPayments | [ SalesTaxPaymentDto ] | No | |
| startDate | dateTime | No | |
| status | string | No | |
| taxPeriod | string | No | |
| totalDue | number | No | |
| totalPaidAmount | number | No | |
| totalTaxAmount | number | No |
SanctionLimitResponseDto
| Name | Type | Description | Required |
|---|---|---|---|
| sanctionLimit | number | No | |
| tenantId | long | No |
SdkHttpMetadata
| Name | Type | Description | Required |
|---|---|---|---|
| allHttpHeaders | object | No | |
| httpHeaders | object | No | |
| httpStatusCode | integer | No |
SendEmailRequest
| Name | Type | Description | Required |
|---|---|---|---|
| application | string | Application name Example: "ERP" | No |
| bcc | string | Sender to email address Example: "john@doe.com" | No |
| body | string | email body Example: "This is a invite email" | No |
| category | string | Module Name Example: "INVOICE" | No |
| cc | string | Sender cc to email address Example: "john@doe.com" | No |
| exportDocumentRequest | ExportDocumentRequest | Application name Example: "ERP" | No |
| isEncoded | boolean | Is email body encoded Example: false | No |
| replyTo | string | Reply to email address Example: "john@doe.com" | No |
| senderName | string | Sender's name Example: "Sender Name" | No |
| subject | string | subject line Example: "Invoice Email" | No |
| to | string | to email address Example: "john@doe.com" | No |
SendSalesInvoiceEmail
| Name | Type | Description | Required |
|---|---|---|---|
| contactCode | string | No | |
| invoiceRequest | InvoiceRequestDto | config for stripe payment link Example: "Get Payment Link Config" | No |
| isSendPaymentLink | boolean | Send stripe payment link Example: true | No |
| recurring | boolean | No | |
| recurringInvoicePaymentInfoDto | RecurringInvoicePaymentInfoDto | No | |
| saveContact | boolean | No | |
| sendEmailRequest | SendEmailRequest | Send email config Example: "Send email config" | No |
SendSalesOrderEmail
| Name | Type | Description | Required |
|---|---|---|---|
| contactCode | string | No | |
| salesOrderRequestDto | SalesOrderRequestDto | sales order Example: "Sales order" | No |
| saveContact | boolean | No | |
| sendEmailRequest | SendEmailRequest | Send email config Example: "Send email config" | No |
SetRecurringDto
| Name | Type | Description | Required |
|---|---|---|---|
| documentCode | string | No | |
| documentType | 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 |
| recurring | boolean | No | |
| recurringActivated | boolean | No |
ShopifyAddress
| Name | Type | Description | Required |
|---|---|---|---|
| address1 | string | No | |
| address2 | string | No | |
| city | string | No | |
| country | string | No | |
| postalCode | string | No | |
| state | string | No |
ShopifyCustomer
| Name | Type | Description | Required |
|---|---|---|---|
| contactEmail | string | No | |
| contactFirstName | string | No | |
| contactId | string | No | |
| contactLastName | string | No |
ShopifyOrder
| Name | Type | Description | Required |
|---|---|---|---|
| billingAddress | ShopifyAddress | No | |
| contactInfo | ShopifyCustomer | No | |
| currency | string | No | |
| string | No | ||
| id | string | No | |
| invoiceStatus | string | No | |
| lineItems | [ ShopifyOrderLine ] | No | |
| paymentAccountCode | string | No | |
| paymentReferenceNumber | string | No | |
| shippingAddress | ShopifyAddress | No | |
| shippingLines | string | No | |
| subtotalPrice | string | No | |
| taxesIncluded | boolean | No | |
| totalDiscount | string | No | |
| totalPrice | string | No | |
| totalTax | string | No |
ShopifyOrderLine
| Name | Type | Description | Required |
|---|---|---|---|
| lineItemsDiscount | string | No | |
| lineItemsProductId | string | No | |
| lineItemsProductPrice | string | No | |
| lineItemsProductQuantity | integer | No | |
| lineItemsTitle | string | No |
Sort
| Name | Type | Description | Required |
|---|---|---|---|
| empty | boolean | No | |
| sorted | boolean | No | |
| unsorted | boolean | No |
StockQuantitiesRequest
| Name | Type | Description | Required |
|---|---|---|---|
| productVariantCodes | [ string ] | No | |
| status | [ string ] | No | |
| warehouseCode | string | No |
StockQuantitiesResponse
| Name | Type | Description | Required |
|---|---|---|---|
| productStockInfo | [ ProductStockInfo ] | No |
TaxDto
| Name | Type | Description | Required |
|---|---|---|---|
| accountCode | string | Account code Example: "AC-001" | No |
| additionalTaxIn | boolean | TRUE/FALSE Example: false | No |
| basReporting | string | Reporting Method Example: "BOTH" | No |
| code | string | Tax code Example: "TC-001" | No |
| defaultMemoBE | string | Default memo Example: "Memo" | No |
| defaultMemoDe | string | Default Memo Germany Example: "memo" | No |
| defaultMemoNL | string | Default memo Example: "Momo" | No |
| defaultMemoUk | string | Default Memo UK Example: "memo" | No |
| deleted | boolean | Tax deleted Example: false | No |
| description | string | Description Example: "sales Tax for SG" | No |
| effectiveEndDate | dateTime | Effective end date of the tax Example: "2023-12-31" | No |
| effectiveStartDate | dateTime | Effective start date of the tax Example: "2023-01-01" | No |
| flatRateSchemeUk | boolean | Flat Rate Scheme UK Example: false | No |
| isDefault | boolean | Is Default Tax Example: false | No |
| isTaxGroup | boolean | Is Tax Group Example: false | No |
| name | string | Tax Name Example: "SGST" | No |
| netAmountBefore | string | Net Amount Before Section Example: "Box 5,Box 6" | No |
| netAmountBeforeBE | string | Net Amount Before Section Example: "Box 00,Box 01" | No |
| netAmountBeforeNL | string | Net Amount Before Section Example: "Box 5,Box 6" | No |
| netAmountDe | string | No | |
| netAmountUk | string | Net Amount Before Section Example: "Box 5,Box 6" | No |
| percent | number | Tax percentage Example: 7 | No |
| showInReportsID | boolean | Flag to consider in reports Example: true | No |
| status | string | Tax status Example: "active" | No |
| taxAccountCode | string | Account Code Example: "ACC-0000001" | No |
| taxAgencyCan | string | Example: "British Columbia" | No |
| taxAmountDe | string | Tax Amount In Section Example: "Box 5,Box 6" | No |
| taxAmountIn | string | Tax Amount In Section Example: "Box 5,Box 6" | No |
| taxAmountInBE | string | Tax Amount In Section Example: "Box 54,Box 55" | No |
| taxAmountInNL | string | Tax Amount In Section Example: "Box 5,Box 6" | No |
| taxAmountUk | string | Tax Amount In Section Example: "Box 5,Box 6" | No |
| taxCode | string | Tax code Example: "TC-001" | No |
| taxGroupDetails | [ TaxGroupDetails ] | Tax Details | No |
| taxSectionAus | string | Tax Section Enum: "DEFAULT_GST=Default GST", "EXPORT_SALES=Export Sales", "OTHER_GST=Other GST-free sales", "INPUT_TAX_SALES=Input Taxed Sales", "CAPITAL_PURCHASES=Capital purchases", "NONCAPITAL_PURCHASES=Non-capital purchases", "INPUT_TAX_PURCHASES=Input Tax Purchases", "EXCLUDED_FROM_BAS=Excluded from BAS"Example: "DEFAULT_GST" | No |
| taxSectionSAR | string | Tax Section Name Example: "Standard rates sales, Standard rated domestic purchase" | No |
| type | string | SALES Enum: "SALES", "PURCHASE", "BOTH"Example: "SALES" | No |
TaxGroupDetails
| Name | Type | Description | Required |
|---|---|---|---|
| additionalTaxIn | boolean | No | |
| applyTo | string | No | |
| code | string | No | |
| id | long | No | |
| name | string | No | |
| percentage | number | No | |
| type | string | No |
TdsInfoIndia
| Name | Type | Description | Required |
|---|---|---|---|
| assessableAmount | number | No | |
| deducteeType | string | No | |
| incomePayment | string | No | |
| lineAmount | number | No | |
| payableAccount | string | No | |
| remark | string | No | |
| tdsAmount | number | No | |
| tdsRate | number | No |
TenureData
| Name | Type | Description | Required |
|---|---|---|---|
| amount | number | No | |
| count | integer | No | |
| day | integer | No | |
| due | number | No | |
| month | string | Enum: "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER" | No |
| year | Year | No |
TopTrend
| Name | Type | Description | Required |
|---|---|---|---|
| code | string | No | |
| name | string | No | |
| trendList | [ Trend ] | No |
TransporterRequest
| Name | Type | Description | Required |
|---|---|---|---|
| transporterId | string | Transporter Unique Id Example: "G2796968IN" | No |
| transporterName | string | Transporter Name Example: "Jagdish Transports" | No |
TransporterResponse
| Name | Type | Description | Required |
|---|---|---|---|
| transporterId | string | Transporter Unique Id Example: "G2796968IN" | No |
| transporterName | string | Transporter Name Example: "Jagdish Transports" | No |
Trend
| Name | Type | Description | Required |
|---|---|---|---|
| count | double | No | |
| transactionDate | dateTime | No |
TriggerKafkaRequestDto
| Name | Type | Description | Required |
|---|---|---|---|
| approvalHistory | [ ApprovalHistoryItem ] | No | |
| approverMap | object | No | |
| contactCode | string | No | |
| currency | string | No | |
| currentLevel | integer | No | |
| totalAmount | string | No | |
| userName | string | No |
UOMDto
| Name | Type | Description | Required |
|---|---|---|---|
| active | boolean | Is active or not Example: true | No |
| deleted | boolean | Is deleted or not Example: false | No |
| description | string | UOM description Example: "UOM to measure weight" | No |
| id | long | UOM Id Example: 1 | No |
| isSystemGenerated | boolean | Flag to specify if the UOM is system or user generated Example: false | No |
| name | string | UOM name Example: "LB" | No |
| tenantId | long | Tenant Id Example: 1233 | No |
UOMSchemaDefinitionDto
| Name | Type | Description | Required |
|---|---|---|---|
| sinkConversionFactor | number | 10 Example: 10 | No |
| sinkUOM | long | 2 Example: 2 | No |
| sourceConversionFactor | number | 1 Example: 1 | No |
| sourceUOM | long | 4 Example: 4 | No |
| uid | string (uuid) | UOM Schema Definition Id Example: 1 | No |
UOMSchemaDto
| Name | Type | Description | Required |
|---|---|---|---|
| active | boolean | Is active or not Example: true | No |
| baseUOM | UOMDto | Base UOM Example: "LB" | No |
| id | long | UOM Id Example: 1 | No |
| name | string | UOM name Example: "LB" | No |
| uomSchemaDefinitions | [ UOMSchemaDefinitionDto ] | UOM schema definitions | No |
URI
| Name | Type | Description | Required |
|---|---|---|---|
| absolute | boolean | No | |
| authority | string | No | |
| fragment | string | No | |
| host | string | No | |
| opaque | boolean | No | |
| path | string | No | |
| port | integer | No | |
| query | string | No | |
| rawAuthority | string | No | |
| rawFragment | string | No | |
| rawPath | string | No | |
| rawQuery | string | No | |
| rawSchemeSpecificPart | string | No | |
| rawUserInfo | string | No | |
| scheme | string | No | |
| schemeSpecificPart | string | No | |
| userInfo | string | No |
URL
| Name | Type | Description | Required |
|---|---|---|---|
| authority | string | No | |
| content | object | No | |
| defaultPort | integer | No | |
| file | string | No | |
| host | string | No | |
| path | string | No | |
| port | integer | No | |
| protocol | string | No | |
| query | string | No | |
| ref | string | No | |
| userInfo | string | No |
UsaSalesTaxByRegion
| Name | Type | Description | Required |
|---|---|---|---|
| jurisCode | string | No | |
| jurisName | string | No | |
| jurisType | string | No | |
| region | string | No | |
| taxAmount | number | No | |
| taxName | string | No | |
| taxable | number | No | |
| totalAmount | number | No | |
| totalExempt | number | No |
UsaSalesTaxReport
| Name | Type | Description | Required |
|---|---|---|---|
| data | object | No |
WeeklyData
| Name | Type | Description | Required |
|---|---|---|---|
| count | integer | No | |
| due | number | No | |
| month | string | Enum: "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER" | No |
| total | number | No | |
| week | double | No | |
| year | Year | No |
Year
| Name | Type | Description | Required |
|---|---|---|---|
| leap | boolean | No | |
| value | integer | No |