Resengo Web API ~ documentation

General Info:

Security
Xml or Json ?
C# example: a HTTP GET request
Validation Errors

Available Entities:

Module Entity
FI Transaction
PL Person
RES PartnerReservation
RES PartnerReservationContacts
RES PartnerReservations
SUB PersonSubscription
SUB Subscription
SUB SubscriptionTransaction
WS Order
WS OrderItem

Description for FI/Transaction:

The Transaction entities are debts and payments.
When an order is created, a "debt" transaction is also made for the value of that order.
Payments done by or expected from the customer become "payment" transactions which can have a status of paid or unpaid.
An order is paid when the total value of all payment transactions equals the total value of all debt transactions for that order.
Do not confuse with SUB/SubscriptionTransaction, which are payments with credits.

Available Services for FI/Transaction:

DELETE
GET
POST
You can request information about all the Transactions in your network by issuing a GET request to http://api.resengo.com/FI/Transaction.

Parameters for FI/Transaction (GET):

Name C# DataType Description
LastUpdatedBySomeoneElseSince DateTime The list of Transactions you receive will only contain those Transactions that have been modified since the specified date.
Transactions that were last modified by a POST request to http://api.resengo.com/FI/Transaction are excluded.
You can use this parameter to set up a heartbeat synchronisation application.
TransactionID List<int> The list of Transactions you receive will only contain the Transactions with the specified TransactionID.
Multiple values are possible using the notation &TransactionID=123&TransactionID=456&TransactionID=...
Sorting string The field that should be used to sort the resulting list (this affects Paging also).
Currently possible values:
  • TransactionIDAscending (default)
If you are using the response of this request to do updates to your system, expecially when using the parameter LastUpdatedBySomeoneElseSince, you should use TransactionIDAscending to prevent concurrency problems.
NumberOfItemsPerPage int (default: 50) You will receive only this many results at a time.
You can request the rest of the items by re-issuing the call with another CurrentPageIndex parameter.
The default of 50 is also the maximum value.
CurrentPageIndex int (default: 1) See the description of NumberOfItemsPerPage

Response of FI/Transaction (GET):

<?xml version="1.0" encoding="utf-8"?>
<Response>
  <PagingInfo>(fields)</PagingInfo>
  <Transactions>
    <Transaction>(fields)</Transaction>
    <Transaction>(fields)</Transaction>
    ...
  </Transactions>
</Response>

Fields of <PagingInfo>:

FieldName C# DataType Description
CurrentPageIndex int This should be the same value as was specified in the request.
MaximumNumberOfItemsPerPage int Informational, always 50.
NumberOfItemsPerPage int This should be the same value as was specified in the request.
TotalNumberOfItems int The total number of items that matched the criteria in the request.
If this number is greater than MaximumNumberOfItemsPerPage, you can re-issue the request with a different CurrentPageIndex to get the rest of the results (if needed).

Fields of <Transaction>:

FieldName C# DataType Description
Bank string
CardType string
CodaItemID int?
CounterTransactionID int
CreditCardNR string
Currency string
Description string
EndTime DateTime?
ePayID string
ePayLogID int?
FreeIntegerField1 int?
FreeIntegerField2 int?
FreeIntegerField3 int?
FreeIntegerField4 int?
FreeIntegerField5 int?
FreeTextField1 string
FreeTextField2 string
FreeTextField3 string
FreeTextField4 string
FreeTextField5 string
Frozen bool
Index int
InsertDate DateTime
InsertPersonID int
InvoiceDate DateTime?
InvoiceNumber string
LastPaymentDate DateTime?
ML_PersonID int
ModuleID string
OR_EventID int
Paid bool
PaymentTypeID int
PaymentUnitID int
PercentageOfTotalValue double?
PersonID int
PR_ProjectID int
ReferenceID1 int
ReferenceID2 int
ReferenceID3 int
ReferenceID4 int
ReferenceID5 int
RefTransactionID int?
RemarkLine1 string
RemarkLine2 string
Remarks string
SMS_TransactionID int?
SourceTransactionID int
StartTime DateTime?
StructuredRemark string
SUB_PersonSubscriptionID int
SUB_SubscriptionID int
TransactionDate DateTime?
TransactionID int
TransactionStatusID int
TransactionTypeID int
TransactionUID Guid
UpdateDate DateTime
UpdatePersonID int
Value double?
ValueExcVAT double?
ValueIncVAT double?
VAT double?
VATPercentage double?
VoucherID int
WS_CashRegisterID int
WS_CashReportID int
WS_OrderHeadID int