POST v1/Invoices
Request Information
URI Parameters
None.
Body Parameters
Invoice| Name | Description | Type | Additional information |
|---|---|---|---|
| TransactionType | TransactionTypeEnum |
None. |
|
| F_UserMaster_Asign | integer |
None. |
|
| F_CategoryMaster | integer |
None. |
|
| F_InvoiceTemplate | integer |
None. |
|
| UserAssignName | string |
None. |
|
| CategoryName | string |
None. |
|
| VatNo | string |
None. |
|
| IsAdhoc | boolean |
None. |
|
| IsInventory | boolean |
None. |
|
| IsDomestic | boolean |
None. |
|
| Receipts | Collection of Receipt |
None. |
|
| CrNoteTrans | Collection of CreditNoteTrans |
None. |
|
| IsRecurring | boolean |
None. |
|
| F_RecurringInvoiceMaster | integer |
None. |
|
| AddIn | string |
None. |
|
| F_QuoteMaster | integer |
None. |
|
| IsFullyPaid | boolean |
None. |
|
| DiscountAsRate | boolean |
None. |
|
| DueDate | date |
None. |
|
| DueDateStr | string |
None. |
|
| IsDraft | boolean |
None. |
|
| VatIncluded | boolean |
None. |
|
| ContactName | string |
None. |
|
| ContactEmail | string |
None. |
|
| ContactAddress | string |
None. |
|
| Address1 | string |
None. |
|
| Address2 | string |
None. |
|
| City | string |
None. |
|
| Zip | string |
None. |
|
| Country | string |
None. |
|
| County | string |
None. |
|
| VatRegNo | string |
None. |
|
| CurrentTransaction | SqlTransaction |
None. |
|
| GrossAmount | decimal number |
None. |
|
| TaxAmount | decimal number |
None. |
|
| IGrossAmount | decimal number |
None. |
|
| ITaxAmount | decimal number |
None. |
|
| ITotalAmount | decimal number |
None. |
|
| AppliedAmount | decimal number |
None. |
|
| IAppliedAmount | decimal number |
None. |
|
| BalanceRemaining | decimal number |
None. |
|
| IBalanceRemaining | decimal number |
None. |
|
| F_CurrencyMaster | integer |
None. |
|
| CurrencyRate | decimal number |
None. |
|
| Items | Collection of InvoiceItem |
None. |
|
| TotalDiscount | decimal number |
None. |
|
| AdvanceAmount | decimal number |
None. |
|
| F_Transactions | integer |
None. |
|
| F_LineId | integer |
None. |
|
| VNoAuto | integer |
None. |
|
| VNo | string |
None. |
|
| VDate | date |
None. |
|
| VDateStr | string |
None. |
|
| F_ContactMaster | integer |
None. |
|
| F_AccountMaster | integer |
None. |
|
| Note | string |
None. |
|
| TotalAmount | decimal number |
None. |
|
| IAmount | decimal number |
None. |
|
| IsLocked | boolean |
None. |
|
| IsNewRecord |
Determine that the current record is New Record or Not. |
boolean |
None. |
| UserId | integer |
None. |
|
| Id | integer |
None. |
|
| F_CompanyMaster | integer |
None. |
|
| Name | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"TransactionType": 0,
"F_UserMaster_Asign": 1,
"F_CategoryMaster": 2,
"F_InvoiceTemplate": 3,
"UserAssignName": "sample string 4",
"CategoryName": "sample string 5",
"VatNo": "sample string 6",
"IsAdhoc": true,
"IsInventory": true,
"IsDomestic": true,
"Receipts": [
{
"IsRefund": true,
"IsAllocated": true,
"TransactionType": 5,
"AccountName": "sample string 3",
"ContactName": "sample string 4",
"ContactAddress": "sample string 5",
"withInvoice": true,
"F_CurrencyMaster": 7,
"CurrencyRate": 8.0,
"AddIn": "sample string 9",
"UniversalId": "7a6c47d0-2c3e-45c9-95ad-f37a12c6296d",
"Items": [
{
"Id": 1,
"F_ReceiptMaster": 2,
"F_InvoiceMaster": 3,
"F_Transactions": 4,
"F_CurrencyMaster": 5,
"CurrencySymbol": "sample string 6",
"IsFullyPaid": true,
"ExchangeGL": 8.0,
"ContactName": "sample string 9",
"VDate": "2025-11-02T18:53:11.1916787+00:00",
"VNo": "sample string 11",
"Note": "sample string 12",
"TotalAmount": 13.0,
"PaidAmount": 14.0,
"DueAmount": 0.0,
"NetDueAmount": -20.0,
"ITotalAmount": 15.0,
"IPaidAmount": 16.0,
"IDueAmount": -1.0,
"INetDueAmount": -20.0,
"AllocatedOn": "2025-11-02T18:53:11.1916787+00:00",
"TradeCreditor": 18.0,
"RAmount": 19.0,
"PayAmount": 20.0,
"CurrencyRate": 21.0,
"IAmount": 22.0,
"UniversalId": "c9e6e6e2-06dd-4a90-b1e6-7539582a9880"
},
{
"Id": 1,
"F_ReceiptMaster": 2,
"F_InvoiceMaster": 3,
"F_Transactions": 4,
"F_CurrencyMaster": 5,
"CurrencySymbol": "sample string 6",
"IsFullyPaid": true,
"ExchangeGL": 8.0,
"ContactName": "sample string 9",
"VDate": "2025-11-02T18:53:11.1916787+00:00",
"VNo": "sample string 11",
"Note": "sample string 12",
"TotalAmount": 13.0,
"PaidAmount": 14.0,
"DueAmount": 0.0,
"NetDueAmount": -20.0,
"ITotalAmount": 15.0,
"IPaidAmount": 16.0,
"IDueAmount": -1.0,
"INetDueAmount": -20.0,
"AllocatedOn": "2025-11-02T18:53:11.1916787+00:00",
"TradeCreditor": 18.0,
"RAmount": 19.0,
"PayAmount": 20.0,
"CurrencyRate": 21.0,
"IAmount": 22.0,
"UniversalId": "c9e6e6e2-06dd-4a90-b1e6-7539582a9880"
}
],
"RAmount": 10.0,
"F_Transactions": 11,
"F_LineId": 12,
"VNoAuto": 13,
"VNo": "sample string 14",
"VDate": "2025-11-02T18:53:11.2229182+00:00",
"VDateStr": "02/11/2025",
"F_ContactMaster": 17,
"F_AccountMaster": 18,
"Note": "sample string 19",
"TotalAmount": 20.0,
"IAmount": 21.0,
"IsLocked": true,
"IsNewRecord": false,
"UserId": 23,
"Id": 24,
"F_CompanyMaster": 25,
"Name": "sample string 26"
},
{
"IsRefund": true,
"IsAllocated": true,
"TransactionType": 5,
"AccountName": "sample string 3",
"ContactName": "sample string 4",
"ContactAddress": "sample string 5",
"withInvoice": true,
"F_CurrencyMaster": 7,
"CurrencyRate": 8.0,
"AddIn": "sample string 9",
"UniversalId": "7a6c47d0-2c3e-45c9-95ad-f37a12c6296d",
"Items": [
{
"Id": 1,
"F_ReceiptMaster": 2,
"F_InvoiceMaster": 3,
"F_Transactions": 4,
"F_CurrencyMaster": 5,
"CurrencySymbol": "sample string 6",
"IsFullyPaid": true,
"ExchangeGL": 8.0,
"ContactName": "sample string 9",
"VDate": "2025-11-02T18:53:11.1916787+00:00",
"VNo": "sample string 11",
"Note": "sample string 12",
"TotalAmount": 13.0,
"PaidAmount": 14.0,
"DueAmount": 0.0,
"NetDueAmount": -20.0,
"ITotalAmount": 15.0,
"IPaidAmount": 16.0,
"IDueAmount": -1.0,
"INetDueAmount": -20.0,
"AllocatedOn": "2025-11-02T18:53:11.1916787+00:00",
"TradeCreditor": 18.0,
"RAmount": 19.0,
"PayAmount": 20.0,
"CurrencyRate": 21.0,
"IAmount": 22.0,
"UniversalId": "c9e6e6e2-06dd-4a90-b1e6-7539582a9880"
},
{
"Id": 1,
"F_ReceiptMaster": 2,
"F_InvoiceMaster": 3,
"F_Transactions": 4,
"F_CurrencyMaster": 5,
"CurrencySymbol": "sample string 6",
"IsFullyPaid": true,
"ExchangeGL": 8.0,
"ContactName": "sample string 9",
"VDate": "2025-11-02T18:53:11.1916787+00:00",
"VNo": "sample string 11",
"Note": "sample string 12",
"TotalAmount": 13.0,
"PaidAmount": 14.0,
"DueAmount": 0.0,
"NetDueAmount": -20.0,
"ITotalAmount": 15.0,
"IPaidAmount": 16.0,
"IDueAmount": -1.0,
"INetDueAmount": -20.0,
"AllocatedOn": "2025-11-02T18:53:11.1916787+00:00",
"TradeCreditor": 18.0,
"RAmount": 19.0,
"PayAmount": 20.0,
"CurrencyRate": 21.0,
"IAmount": 22.0,
"UniversalId": "c9e6e6e2-06dd-4a90-b1e6-7539582a9880"
}
],
"RAmount": 10.0,
"F_Transactions": 11,
"F_LineId": 12,
"VNoAuto": 13,
"VNo": "sample string 14",
"VDate": "2025-11-02T18:53:11.2229182+00:00",
"VDateStr": "02/11/2025",
"F_ContactMaster": 17,
"F_AccountMaster": 18,
"Note": "sample string 19",
"TotalAmount": 20.0,
"IAmount": 21.0,
"IsLocked": true,
"IsNewRecord": false,
"UserId": 23,
"Id": 24,
"F_CompanyMaster": 25,
"Name": "sample string 26"
}
],
"CrNoteTrans": [
{
"F_InvoiceMaster": 1,
"F_CrnoteInvoiceMaster": 2,
"CreditAmount": 3.0,
"ICreditAmount": 4.0
},
{
"F_InvoiceMaster": 1,
"F_CrnoteInvoiceMaster": 2,
"CreditAmount": 3.0,
"ICreditAmount": 4.0
}
],
"IsRecurring": true,
"F_RecurringInvoiceMaster": 11,
"AddIn": "sample string 12",
"F_QuoteMaster": 13,
"IsFullyPaid": true,
"DiscountAsRate": true,
"DueDate": "0001-01-01T00:00:00",
"DueDateStr": "",
"IsDraft": true,
"VatIncluded": true,
"ContactName": "sample string 20",
"ContactEmail": "sample string 21",
"ContactAddress": "sample string 22",
"Address1": "sample string 23",
"Address2": "sample string 24",
"City": "sample string 25",
"Zip": "sample string 26",
"Country": "sample string 27",
"County": "sample string 28",
"VatRegNo": "sample string 29",
"CurrentTransaction": null,
"GrossAmount": 30.0,
"TaxAmount": 31.0,
"IGrossAmount": 32.0,
"ITaxAmount": 33.0,
"ITotalAmount": 34.0,
"AppliedAmount": 35.0,
"IAppliedAmount": 36.0,
"BalanceRemaining": 15.0,
"IBalanceRemaining": -2.0,
"F_CurrencyMaster": 37,
"CurrencyRate": 38.0,
"Items": [
{
"F_InvoiceMaster": 1,
"F_ItemMaster": 2,
"ItemName": "sample string 3",
"F_RecurringInvoiceMaster": 4,
"F_TaskMaster": 5,
"IsVatIncluded": true,
"Id": 7,
"Note": "sample string 8",
"Quantity": 9.0,
"DiscountNote": "sample string 10",
"Discount": 11.0,
"DiscountRate": 12.0,
"Price": 13.0,
"IPrice": 14.0,
"F_AccountMaster": 15,
"F_TaxCodeMaster": 16,
"TaxRate": 17.0,
"TaxName": "sample string 18",
"AccountName": "sample string 19",
"AccountCode": "sample string 20",
"CurrencyRate": 21.0,
"LabourAmount": 22.0,
"MaterialAmount": 23.0,
"GrossAmount": -18.52,
"IGrossAmount": 90.0,
"TaxAmount": 24.0,
"ITaxAmount": 25.0,
"Amount": 5.48,
"IAmount": 115.0,
"IsTaxable": true
},
{
"F_InvoiceMaster": 1,
"F_ItemMaster": 2,
"ItemName": "sample string 3",
"F_RecurringInvoiceMaster": 4,
"F_TaskMaster": 5,
"IsVatIncluded": true,
"Id": 7,
"Note": "sample string 8",
"Quantity": 9.0,
"DiscountNote": "sample string 10",
"Discount": 11.0,
"DiscountRate": 12.0,
"Price": 13.0,
"IPrice": 14.0,
"F_AccountMaster": 15,
"F_TaxCodeMaster": 16,
"TaxRate": 17.0,
"TaxName": "sample string 18",
"AccountName": "sample string 19",
"AccountCode": "sample string 20",
"CurrencyRate": 21.0,
"LabourAmount": 22.0,
"MaterialAmount": 23.0,
"GrossAmount": -18.52,
"IGrossAmount": 90.0,
"TaxAmount": 24.0,
"ITaxAmount": 25.0,
"Amount": 5.48,
"IAmount": 115.0,
"IsTaxable": true
}
],
"TotalDiscount": 39.0,
"AdvanceAmount": 40.0,
"F_Transactions": 41,
"F_LineId": 42,
"VNoAuto": 43,
"VNo": "sample string 44",
"VDate": "2025-11-02T18:53:11.2385427+00:00",
"VDateStr": "02/11/2025",
"F_ContactMaster": 47,
"F_AccountMaster": 48,
"Note": "sample string 49",
"TotalAmount": 50.0,
"IAmount": 51.0,
"IsLocked": true,
"IsNewRecord": false,
"UserId": 53,
"Id": 54,
"F_CompanyMaster": 55,
"Name": "sample string 56"
}
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
stringResponse Formats
application/json, text/json
Sample:
"sample string 1"