Home Registreren Help Blog Over API Contact Login

API Reference
Start developing plugins for BizFusion.

 
Credit Reason (CreditReasonDTO)

The Credit Reasons that you can use on Credit Notes.

Properties
property data type reference
CreditReasonId Int32 Primary Key
CreditReasonName String
Timestamp String


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


Enum Values
1 = QuantityCorrection
2 = AmountCorrection


* This object is read only.

JSON sample
{
  "CreditReasonId": 1,
  "CreditReasonName": "QuantityCorrection",
  "Timestamp": "AQIDIA=="
}


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.