API Reference
Start developing plugins for BizFusion.

 
Credit Note Variant (CreditNoteVariantDTO)

A credit note line contains the product that should be credited, but doesn't specify the selected options.
Use a 'Credit Note Variant' to specify the selected product options.

E.g. you register the credit of a T-Shirt on a credit note line, but the ordered Size and Color values
are registered on the Credit Note Variant record.

The following relationship exists between credit notes and variants:
Credit Note > Credit Note Line > Credit Note Variant > Variant Value > Variant


Properties
property data type reference
CreditNoteVariantId Int32 Primary Key
CreditNoteLineId Int32 CreditNoteLineDTO
VariantValueId Int32 VariantValueDTO
Timestamp String


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




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.