POST v1/company/{companyId}/invoices

Post new invoice

Request Information

URI Parameters

Name	Description	Type	Additional information
companyId	Company id	decimal number	Required

Body Parameters

Invoice detail object

AppInvoiceMasterModelRequest

Name	Description	Type	Additional information
Id	Invoice record id	integer	None.
ContactId	Contact id	integer	Required
VNo	Voucher/Invoice number	string	Required
VDate	Voucher/Invoice date	date	Required Matching regular expression pattern: (19\|20)[0-9]{2}[-](0[1-9]\|1[012])[-](0[1-9]\|[12][0-9]\|3[01])
DueDate	Voucher/Invoice due date	date	Matching regular expression pattern: (19\|20)[0-9]{2}[-](0[1-9]\|1[012])[-](0[1-9]\|[12][0-9]\|3[01])
VatIncluded	VAT included in amount or not	boolean	None.
DiscountAsRate	VAT included in amount or not	boolean	None.
Type	Transaction type (Invoice, Cr. Note)	string	None.
Note	Invoice note/reference	string	None.
Items	Invoice items	Collection of AppInvoiceMasterItemRequest	Required
Receipts		Collection of AppReceiptMasterRequestNew	None.
Attachments	Invoice attachments	Collection of AppAttachmentRequest	None.
isNotifyCustomer	Customer notification is required or not	boolean	None.
isSendCopy	Email copy is need to send or not	boolean	None.
CurrencyId	Currency id	integer	Required
CurrencyRate	Currency conversion rate	decimal number	Required
ISFullyPaid		boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "ContactId": 2,
  "VNo": "sample string 3",
  "VDate": "2025-04-22T15:49:33.3713787+01:00",
  "DueDate": "2025-04-22T15:49:33.3713787+01:00",
  "VatIncluded": true,
  "DiscountAsRate": true,
  "Type": "Invoice",
  "Note": "sample string 9",
  "Items": [
    {
      "ItemId": 1.0,
      "Description": "sample string 2",
      "Quantity": 3.0,
      "Price": 4.0,
      "Discount": 5.0,
      "DiscountRate": 6.0,
      "DiscountNote": "sample string 7",
      "AccountId": 8.0,
      "TaxId": 9.0,
      "TaxRate": 10.0,
      "TaxAmount": 11.0
    },
    {
      "ItemId": 1.0,
      "Description": "sample string 2",
      "Quantity": 3.0,
      "Price": 4.0,
      "Discount": 5.0,
      "DiscountRate": 6.0,
      "DiscountNote": "sample string 7",
      "AccountId": 8.0,
      "TaxId": 9.0,
      "TaxRate": 10.0,
      "TaxAmount": 11.0
    }
  ],
  "Receipts": [
    {
      "Id": 1.0,
      "VDate": "2025-04-22T15:49:33.3713787+01:00",
      "CurrencyRate": 3.0,
      "Amount": 4.0,
      "RAmount": 5.0,
      "Description": "sample string 6",
      "F_CurrencyMaster": 7,
      "AccountName": "sample string 8",
      "F_AccountMaster": 9,
      "Addin": "sample string 10",
      "withInvoice": true
    },
    {
      "Id": 1.0,
      "VDate": "2025-04-22T15:49:33.3713787+01:00",
      "CurrencyRate": 3.0,
      "Amount": 4.0,
      "RAmount": 5.0,
      "Description": "sample string 6",
      "F_CurrencyMaster": 7,
      "AccountName": "sample string 8",
      "F_AccountMaster": 9,
      "Addin": "sample string 10",
      "withInvoice": true
    }
  ],
  "Attachments": [
    {
      "FileName": "sample string 1",
      "ContentType": "sample string 2",
      "FileContents": "sample string 3",
      "ImageType": "sample string 4"
    },
    {
      "FileName": "sample string 1",
      "ContentType": "sample string 2",
      "FileContents": "sample string 3",
      "ImageType": "sample string 4"
    }
  ],
  "isNotifyCustomer": true,
  "isSendCopy": true,
  "CurrencyId": 12,
  "CurrencyRate": 13.0,
  "ISFullyPaid": true
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'AppInvoiceMasterModelRequest'.

Response Information

Resource Description

ApiResponseOfAppInvoiceMasterModel

Name	Description	Type	Additional information
Result		AppInvoiceMasterModel	None.
Status		boolean	None.
Message		string	None.
Errors	Errors occures while processing request	Collection of ApiError	None.

Response Formats

application/json, text/json

Sample:

{
  "Result": {
    "Id": 1.0,
    "ContactId": 2.0,
    "ContactName": "sample string 3",
    "VNo": "sample string 4",
    "VDate": "2025-04-22",
    "DueDate": "2025-04-22",
    "CurrencyCode": "sample string 7",
    "CurrencySymbol": "sample string 8",
    "GrossAmount": 9.0,
    "TaxAmount": 10.0,
    "TotalAmount": 23.0,
    "IGrossAmount": 11.0,
    "ITaxAmount": 12.0,
    "ITotalAmount": 19.0,
    "IsEditable": true,
    "Type": "Invoice",
    "BalanceRemaining": 16.0,
    "AppliedAmount": 17.0,
    "IAppliedAmount": 18.0,
    "Note": "sample string 19",
    "Items": [
      {
        "Id": 1.0,
        "ItemId": 3.0,
        "ItemName": "sample string 4",
        "Description": "sample string 5",
        "Discount": 1.0,
        "VatIncluded": true,
        "DiscountRate": 1.0,
        "Quantity": 7.0,
        "Price": 8.0,
        "AccountId": 9.0,
        "AccountName": "sample string 10",
        "AccountCode": "sample string 11",
        "TaxId": 12.0,
        "TaxName": "sample string 13",
        "TaxRate": 14.0,
        "TaxAmount": 15.0,
        "GrossAmount": 16.0,
        "ITaxAmount": 17.0,
        "IGrossAmount": 18.0,
        "DiscountNote": "sample string 19",
        "NetAmount": 20.0
      },
      {
        "Id": 1.0,
        "ItemId": 3.0,
        "ItemName": "sample string 4",
        "Description": "sample string 5",
        "Discount": 1.0,
        "VatIncluded": true,
        "DiscountRate": 1.0,
        "Quantity": 7.0,
        "Price": 8.0,
        "AccountId": 9.0,
        "AccountName": "sample string 10",
        "AccountCode": "sample string 11",
        "TaxId": 12.0,
        "TaxName": "sample string 13",
        "TaxRate": 14.0,
        "TaxAmount": 15.0,
        "GrossAmount": 16.0,
        "ITaxAmount": 17.0,
        "IGrossAmount": 18.0,
        "DiscountNote": "sample string 19",
        "NetAmount": 20.0
      }
    ],
    "Attachments": [
      {
        "Id": 1.0,
        "Name": "sample string 2",
        "ContentType": "sample string 3",
        "FileUrl": "sample string 6",
        "FileContent": "sample string 7"
      },
      {
        "Id": 1.0,
        "Name": "sample string 2",
        "ContentType": "sample string 3",
        "FileUrl": "sample string 6",
        "FileContent": "sample string 7"
      }
    ],
    "ContactEmail": "sample string 21",
    "VatIncluded": true,
    "DiscountAsRate": true,
    "CurrencyId": 1.0,
    "CurrencyRate": 23.0,
    "CurrencyName": "sample string 24",
    "Receipts": [
      {
        "Id": 1.0,
        "VDate_Receipt": "sample string 2",
        "VNo_Receipt": "sample string 3",
        "Amount": 4.0,
        "RAmount": 5.0,
        "Symbol": "sample string 6",
        "F_CurrencyMaster": 7,
        "AccountName": "sample string 8"
      },
      {
        "Id": 1.0,
        "VDate_Receipt": "sample string 2",
        "VNo_Receipt": "sample string 3",
        "Amount": 4.0,
        "RAmount": 5.0,
        "Symbol": "sample string 6",
        "F_CurrencyMaster": 7,
        "AccountName": "sample string 8"
      }
    ]
  },
  "Status": true,
  "Message": "sample string 2",
  "Errors": [
    {
      "Number": 1,
      "Message": "sample string 2",
      "Exception": {
        "ClassName": "System.Exception",
        "Message": null,
        "Data": null,
        "InnerException": null,
        "HelpURL": "sample string 1",
        "StackTraceString": null,
        "RemoteStackTraceString": null,
        "RemoteStackIndex": 0,
        "ExceptionMethod": null,
        "HResult": 3,
        "Source": "sample string 2",
        "WatsonBuckets": null
      }
    },
    {
      "Number": 1,
      "Message": "sample string 2",
      "Exception": {
        "ClassName": "System.Exception",
        "Message": null,
        "Data": null,
        "InnerException": null,
        "HelpURL": "sample string 1",
        "StackTraceString": null,
        "RemoteStackTraceString": null,
        "RemoteStackIndex": 0,
        "ExceptionMethod": null,
        "HResult": 3,
        "Source": "sample string 2",
        "WatsonBuckets": null
      }
    }
  ]
}