Add or Update a Contract Financial Line

This is used to create or amend an invoice line on a financial contract.

When creating a new financial line, you must specify the Id of the contract and the parameters below. To amend a contract financial line, you only need to pass in the item Id. An output of the financial line details is provided.

Query String Parameters

Name	Type	Description	Required
Action	String	AddContractFinancialLine	Required
ContractId	Int	The contracts Contract Id. Must be specified if adding a new item or amending an existing contract.	Required
Itemid	Int	Financial item Id. Must be specified if amending an existing item.	Required
Quantity	Double	Financial line quantity. Must be specified if creating a new item line.	Required
InvoiceDescription	String	Financial line invoice description. Must be specified if creating a new item line and not using a stock or predefined item.	Required
UnitPrice	Double	Financial line unit price. Must be specified if creating a new item line.	Required
VatCode	String	Financial line vat code. Must be specified if creating a new item line or where a stock item does not have a vat code specified.	Required
CurrencyCode	String	Financial line currency code. Must be specified if creating a new item line.	Required
Itemid	Int	Financial item Id. Specify if amending an existing item.	Optional
NominalCode	String	Financial line nominal code.	Optional
DepartmentCode	String	Financial line department code.	Optional
Description	String	Financial line item description.	Optional
CurrencyCode	String	Financial line currency code.	Optional
CostPrice	Double	Financial line cost.	Optional
UnitPrice	Double	Financial line unit price.	Optional
DiscountedPercentage	Double	Financial line discounted percentage.	Optional
DiscountedValue	Double	Financial line discounted value.	Optional
Quantity	Double	Financial line quantity.	Optional
VatCode	String	Financial line VAT Code.	Optional
PredefinedItemId	Int	Financial line predefined Id.	Optional
InvoiceDescription	String	Financial line invoice description.	Optional
StockItemId	Int	Financial line stock item Id.	Optional
ItemType	String	Financial line item type. Stock , Predefined or freetext.	Optional

Response Codes

Example

Request

Request URL

https://webservice.bigchange.com/v01/services.ashx?action=AddContractFinancialLine&ContractId=304734&Quantity=2&InvoiceDescription=New Fin Line&UnitPrice=100&VatCode=001&CurrencyCode=GBP&NominalCode&DepartmentCode&Description&CurrencyCode&CostPrice&UnitPrice&DiscountPercentage&DiscountedValue&PredefinedItemId&StockItemId&ItemType

Response

Response Data

{
  "Code": 0,
  "Result": {
    "InvoiceItemId": 109546283,
    "InvoiceItemJobFinanceDocumentItemId": null,
    "InvoiceItemJobFinanceDocumentId": null,
    "InvoiceItemEntityId": 304734,
    "InvoiceItemEntityType": 4,
    "InvoiceItemType": 0,
    "InvoiceItemTypeFK": null,
    "InvoiceItemTypeGroupId": null,
    "InvoiceItemNominalCodeId": null,
    "InvoiceItemNominalCode": null,
    "InvoiceItemDepartmentCodeId": null,
    "InvoiceItemDepartmentCode": null,
    "InvoiceItemDescription": "New Fin Line",
    "InvoiceItemPrices": {
      "Quantity": 2,
      "Cost": 0,
      "UnitPrice": 100,
      "Vat": 23,
      "UnitVatAmount": 23,
      "VatAmount": 46,
      "NetPrice": 246
    },
    "InvoiceItemCurrency": "GBP",
    "InvoiceItemMarkupPercentage": null,
    "InvoiceItemDiscountedPercentage": null,
    "InvoiceItemDiscountedValue": null,
    "InvoiceItemVatId": 2981,
    "InvoiceItemVatCode": null,
    "InvoiceItemVatDescription": null,
    "InvoiceItemOrder": 0,
    "InvoiceItemRecurringPayment": false,
    "InvoiceItemNewSection": false,
    "InvoiceItemCreationDate": null,
    "InvoiceItemOwnerId": 0,
    "InvoiceItemOrigin": 1,
    "InvoiceItemIntegrationCode1": null,
    "InvoiceItemIntegrationCode2": null,
    "InvoiceItemContactId": null,
    "InvoiceItemContact": null,
    "InvoiceItemOriginalVatId": null,
    "InvoiceItemOriginalVat": null,
    "InvoiceItemOriginalUnitVatAmount": null,
    "InvoiceItemOriginalVatAmount": null,
    "InvoiceItemInvoiceId": null,
    "InvoiceItemCategory": null,
    "InvoiceItemJobInvoiceId": null
  }
}