API Reference
Start developing plugins for BizFusion.

 
Credit Note Line (CreditNoteLineDTO)

The Credit Note Line contains the details of the Credit Note.
Note: you need to provide positive values for quantity and price.

There are two price fields: 'Price' and 'Product Price'.
'Product Price' contains the original price of the product on the sales/purchase invoice,
while 'Price' contains the amount of credit that is given.


Properties
property data type reference
Timestamp String
CreditNoteLineId Int32 Primary Key
CreditNoteId Int32 CreditNoteDTO
ProductId Int32 ProductDTO
Quantity Int32
Price Decimal
ProductPrice Decimal
CreditNoteVariant Array of: CreditNoteVariantDTO


Methods
method parameters URL
Get
/api/CreditNoteLine
Get
Int32 id
/api/CreditNoteLine?id={value}
Get
Int32 pageIndex, Int32 recordsPerPage
/api/CreditNoteLine?pageIndex={value}&recordsPerPage={value}
GetRecordCount
/api/CreditNoteLineSet/RecordCount
GetByField
String field, String value
/api/CreditNoteLineSet/ByField?field={value}&value={value}
GetAfterId
Int32 id
/api/CreditNoteLineSet/AfterId?id={value}
GetBeforeId
Int32 id
/api/CreditNoteLineSet/BeforeId?id={value}
GetMaxId
/api/CreditNoteLineSet/MaxId


JSON sample
{
  "CreditNoteLineId": 1,
  "CreditNoteId": 1,
  "ProductId": 1,
  "Quantity": 1,
  "Price": 299.0,
  "Timestamp": "AQIDIw==",
  "ProductPrice": 299.0,
  "CreditNoteVariant": []
}


General Info

- Numbers should be in English format: 124.99
- Dates look like: 2014-12-31T00:00:00
- Time information is ignored.
- Concurrency is handled through timestamps

Create Record (POST)

- Primary keys are not required when doing a post.
- Timestamps are not required when doing a post.
- Provide the JSON record in the body of the post request.

Update Record (PUT)

- Timestamps are required.
- Provide the JSON record in the body of the put request.

Delete Record (DELETE)

- Primary key and Timestamp are required.