API Reference
Start developing plugins for BizFusion.

 
Payment (PaymentDTO)

You can add one or more payments to transaction documents.

You need to know a document's 'Journal Transaction Id' before you can link a payment to the document.
E.g. if you want to link a payment to an Invoice, then call: 'GetJournalTransactionId(invoiceId)' on the invoice
object to get the value. You then specify this value in 'ForJournalTransactionId' on the payment object.


Properties
property data type reference
PaymentId Int32 Primary Key
PaymentDate DateTime
PaymentSourceId Int32 PaymentSourceDTO
PaymentTypeId Int32 PaymentTypeDTO
Amount Decimal
ForJournalTransactionId Int32
Timestamp String


Methods
method parameters URL
Get
/api/Payment
Get
Int32 id
/api/Payment?id={value}
Get
Int32 pageIndex, Int32 recordsPerPage
/api/Payment?pageIndex={value}&recordsPerPage={value}
Post /api/Payment
Put
Int32 id, PaymentDTO record
/api/Payment?id={value}
Delete
Int32 id, String timestamp
/api/Payment?id={value}&timestamp={value}
GetJournalTransactionId
Int32 id
/api/PaymentSet/JournalTransactionId?id={value}
GetByYear
Int32 year
/api/PaymentSet/ByYear?year={value}
GetByPeriod
DateTime startDate, DateTime endDate
/api/PaymentSet/ByPeriod?startDate={value}&endDate={value}
GetRecordCount
/api/PaymentSet/RecordCount
PutUnpost
Int32 id, String timestamp
/api/PaymentSet/Unpost?id={value}&timestamp={value}
PutUnpostAndDelete
Int32 id, String timestamp
/api/PaymentSet/UnpostAndDelete?id={value}&timestamp={value}
GetByField
String field, String value
/api/PaymentSet/ByField?field={value}&value={value}
GetAfterId
Int32 id
/api/PaymentSet/AfterId?id={value}
GetBeforeId
Int32 id
/api/PaymentSet/BeforeId?id={value}
GetMaxId
/api/PaymentSet/MaxId


JSON sample
{
  "Timestamp": "AQIDHA==",
  "PaymentId": 1,
  "PaymentDate": "2015-12-31T00:00:00",
  "PaymentSourceId": 1,
  "PaymentTypeId": 1,
  "Amount": 299.0,
  "ForJournalTransactionId": 123
}


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.