JiwaAPI

DebtorLedgerQuery

The following routes are available for this service:
GET	/Queries/DebtorLedger	A debtor's ledger (invoices, credit notes, receipts, refunds, adjustments) with the amount outstanding on each, newest first; a branch's own rows plus, for a head office, its branches' (AutoQuery: Skip, Take, OrderBy, Include=Total and column filters; LedgerDebtorID is required).

**DebtorLedgerQuery** Parameters:
Name	Parameter	Data Type	Required
LedgerDebtorID	query	string	No
TransID	query	string	No
TransIDIn	query	string[]	No
TransType	query	string	No
TransTypeIn	query	string[]	No
InvoiceID	query	string	No
Reference	query	string	No
TranDateGreaterThanOrEqualTo	query	DateTime?	No
TranDateGreaterThan	query	DateTime?	No
TranDateLessThan	query	DateTime?	No
TranDateLessThanOrEqualTo	query	DateTime?	No
DueDateGreaterThanOrEqualTo	query	DateTime?	No
DueDateLessThan	query	DateTime?	No
DueDateLessThanOrEqualTo	query	DateTime?	No
OutstandingNotEqualTo	query	decimal?	No
OutstandingGreaterThan	query	decimal?	No
OutstandingLessThan	query	decimal?	No

**QueryBase** Parameters:
Name	Parameter	Data Type	Required
Skip	form	int?	No
Take	form	int?	No
OrderBy	form	string	No
OrderByDesc	form	string	No
Include	form	string	No
Fields	form	string	No
Meta	form	Dictionary<string, string>	No

**v_TFM_DebtorLedger** Parameters:
Name	Parameter	Data Type	Required
LedgerDebtorID	form	string	No
TransID	form	string	No
DebtorID	form	string	No
ChildDebtorID	form	string	No
TranDate	form	DateTime?	No
DueDate	form	DateTime?	No
DebitCredit	form	bool?	No
SubType	form	short?	No
TransType	form	string	No
Reference	form	string	No
Ref	form	string	No
Remark	form	string	No
Amount	form	decimal?	No
AllocatedAmount	form	decimal?	No
Outstanding	form	decimal?	No
GSTAmount	form	decimal?	No
InvoiceID	form	string	No
LastSavedDateTime	form	DateTime?	No

**QueryResponse<T>** Parameters:
Name	Parameter	Data Type	Required
Offset	form	int	No
Total	form	int	No
Results	form	List<T>	No
Meta	form	Dictionary<string, string>	No
ResponseStatus	form	ResponseStatus	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /Queries/DebtorLedger HTTP/1.1 
Host: testapi.wagga.redpoint.com.au 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfv_TFM_DebtorLedger6LgwzCd1 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Offset>0</Offset>
  <Total>0</Total>
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel">
    <d2p1:v_TFM_DebtorLedger>
      <d2p1:_x003C_AllocatedAmount_x003E_k__BackingField>0</d2p1:_x003C_AllocatedAmount_x003E_k__BackingField>
      <d2p1:_x003C_Amount_x003E_k__BackingField>0</d2p1:_x003C_Amount_x003E_k__BackingField>
      <d2p1:_x003C_ChildDebtorID_x003E_k__BackingField>String</d2p1:_x003C_ChildDebtorID_x003E_k__BackingField>
      <d2p1:_x003C_DebitCredit_x003E_k__BackingField>false</d2p1:_x003C_DebitCredit_x003E_k__BackingField>
      <d2p1:_x003C_DebtorID_x003E_k__BackingField>String</d2p1:_x003C_DebtorID_x003E_k__BackingField>
      <d2p1:_x003C_DueDate_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_DueDate_x003E_k__BackingField>
      <d2p1:_x003C_GSTAmount_x003E_k__BackingField>0</d2p1:_x003C_GSTAmount_x003E_k__BackingField>
      <d2p1:_x003C_InvoiceID_x003E_k__BackingField>String</d2p1:_x003C_InvoiceID_x003E_k__BackingField>
      <d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>
      <d2p1:_x003C_LedgerDebtorID_x003E_k__BackingField>String</d2p1:_x003C_LedgerDebtorID_x003E_k__BackingField>
      <d2p1:_x003C_Outstanding_x003E_k__BackingField>0</d2p1:_x003C_Outstanding_x003E_k__BackingField>
      <d2p1:_x003C_Ref_x003E_k__BackingField>String</d2p1:_x003C_Ref_x003E_k__BackingField>
      <d2p1:_x003C_Reference_x003E_k__BackingField>String</d2p1:_x003C_Reference_x003E_k__BackingField>
      <d2p1:_x003C_Remark_x003E_k__BackingField>String</d2p1:_x003C_Remark_x003E_k__BackingField>
      <d2p1:_x003C_SubType_x003E_k__BackingField>0</d2p1:_x003C_SubType_x003E_k__BackingField>
      <d2p1:_x003C_TranDate_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_TranDate_x003E_k__BackingField>
      <d2p1:_x003C_TransID_x003E_k__BackingField>String</d2p1:_x003C_TransID_x003E_k__BackingField>
      <d2p1:_x003C_TransType_x003E_k__BackingField>String</d2p1:_x003C_TransType_x003E_k__BackingField>
    </d2p1:v_TFM_DebtorLedger>
  </Results>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Meta>
      </ResponseError>
    </Errors>
    <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Meta>
  </ResponseStatus>
</QueryResponseOfv_TFM_DebtorLedger6LgwzCd1>