YM REST Services

DuesTransactions

**Requires Authentication**
Requires any of the roles:	admin, oauthadmin

The following routes are available for this service:
GET	/Ams/{ClientID}/DuesTransactions	Return all Dues Transactions for a given criteria.

**DuesTransactions** Parameters:
Name	Parameter	Data Type	Required
DateFrom	query	DateTime?	No
PageSize	query	int	No
PageNumber	query	int	No
OffSet	query	int	No

**BaseDto** Parameters:
Name	Parameter	Data Type	Required
UsingRedis	form	bool	No
AppInitTime	form	DateTime	No
ServerID	form	string	No

**BaseSharedDto** Parameters:
Name	Parameter	Data Type	Required
ClientID	form	int	No
ResponseStatus	form	ResponseStatus	No
BypassCache	form	bool	No
DateCached	form	DateTime	No
Device	form	Device	No

**DuesTransactionsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
DuesTransactionsList	form	List<DuesTransactionData>	No

**DuesTransactionData** Parameters:
Name	Parameter	Data Type	Required
TransactionID	form	int	No
Status	form	string	No
ClosedBy	form	string	No
PaymentType	form	string	No
DateSubmitted	form	DateTime	No
DateScheduled	form	DateTime	No
DateProcessed	form	DateTime	No
Amount	form	double	No
BalanceDue	form	double	No
WebsiteMemberID	form	int	No
ConstituentID	form	string	No
DateMemberSignup	form	DateTime	No
MemberPrimaryGroup	form	string	No
Title	form	string	No
FirstName	form	string	No
MiddleName	form	string	No
LastName	form	string	No
Suffix	form	string	No
Email	form	string	No
Organization	form	string	No
MembershipRequested	form	string	No
CurrentMembershipExpDate	form	DateTime	No
CurrentMembership	form	string	No
CardName	form	string	No
CardType	form	string	No
CardNumber	form	string	No
CardMonth	form	string	No
CardYear	form	string	No
CurrentMemberOrganization	form	string	No
CurrentMemberAddress1	form	string	No
CurrentMemberAddress2	form	string	No
CurrentMemberCity	form	string	No
CurrentMemberState	form	string	No
CurrentMemberProvince	form	string	No
CurrentMemberPostalCode	form	string	No
CurrentMemberCountry	form	string	No
BillingPhone	form	string	No
BillingAddress1	form	string	No
BillingAddress2	form	string	No
BillingCity	form	string	No
BillingState	form	string	No
BillingPostalCode	form	string	No
BillingCountry	form	string	No
ReferenceNumber	form	string	No
PromotionalCode	form	string	No
MemberComments	form	string	No
AdminComments	form	string	No
InvoiceNumber	form	int	No
Terms	form	string	No
MemberType	form	string	No
BillingOrganization	form	string	No
MemberAPIGUID	form	string	No
InvoiceDate	form	DateTime	No
PurchaseOrderNo	form	string	No
NextInstallmentDate	form	DateTime	No
NextInstallmentAmount	form	double	No
TotalInstallmentPaymentsToDate	form	double	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 /Ams/{ClientID}/DuesTransactions HTTP/1.1 
Host: ws.yourmembership.com 
Accept: application/xml

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

<DuesTransactionsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/YM.Web.Services.Ams">
  <BypassCache xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">false</BypassCache>
  <ClientID xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">0</ClientID>
  <Device xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">Desktop</Device>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1: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>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1: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>
    </d2p1:Meta>
  </ResponseStatus>
  <DateFrom>0001-01-01T00:00:00</DateFrom>
  <OffSet>0</OffSet>
  <PageNumber>0</PageNumber>
  <PageSize>0</PageSize>
  <DuesTransactionsList>
    <DuesTransactionData>
      <AdminComments>String</AdminComments>
      <Amount>0</Amount>
      <BalanceDue>0</BalanceDue>
      <BillingAddress1>String</BillingAddress1>
      <BillingAddress2>String</BillingAddress2>
      <BillingCity>String</BillingCity>
      <BillingCountry>String</BillingCountry>
      <BillingOrganization>String</BillingOrganization>
      <BillingPhone>String</BillingPhone>
      <BillingPostalCode>String</BillingPostalCode>
      <BillingState>String</BillingState>
      <CardMonth>String</CardMonth>
      <CardName>String</CardName>
      <CardNumber>String</CardNumber>
      <CardType>String</CardType>
      <CardYear>String</CardYear>
      <ClosedBy>String</ClosedBy>
      <ConstituentID>String</ConstituentID>
      <CurrentMemberAddress1>String</CurrentMemberAddress1>
      <CurrentMemberAddress2>String</CurrentMemberAddress2>
      <CurrentMemberCity>String</CurrentMemberCity>
      <CurrentMemberCountry>String</CurrentMemberCountry>
      <CurrentMemberOrganization>String</CurrentMemberOrganization>
      <CurrentMemberPostalCode>String</CurrentMemberPostalCode>
      <CurrentMemberProvince>String</CurrentMemberProvince>
      <CurrentMemberState>String</CurrentMemberState>
      <CurrentMembership>String</CurrentMembership>
      <CurrentMembershipExpDate>0001-01-01T00:00:00</CurrentMembershipExpDate>
      <DateMemberSignup>0001-01-01T00:00:00</DateMemberSignup>
      <DateProcessed>0001-01-01T00:00:00</DateProcessed>
      <DateScheduled>0001-01-01T00:00:00</DateScheduled>
      <DateSubmitted>0001-01-01T00:00:00</DateSubmitted>
      <Email>String</Email>
      <FirstName>String</FirstName>
      <InvoiceDate>0001-01-01T00:00:00</InvoiceDate>
      <InvoiceNumber>0</InvoiceNumber>
      <LastName>String</LastName>
      <MemberAPIGUID>String</MemberAPIGUID>
      <MemberComments>String</MemberComments>
      <MemberPrimaryGroup>String</MemberPrimaryGroup>
      <MemberType>String</MemberType>
      <MembershipRequested>String</MembershipRequested>
      <MiddleName>String</MiddleName>
      <NextInstallmentAmount>0</NextInstallmentAmount>
      <NextInstallmentDate>0001-01-01T00:00:00</NextInstallmentDate>
      <Organization>String</Organization>
      <PaymentType>String</PaymentType>
      <PromotionalCode>String</PromotionalCode>
      <PurchaseOrderNo>String</PurchaseOrderNo>
      <ReferenceNumber>String</ReferenceNumber>
      <Status>String</Status>
      <Suffix>String</Suffix>
      <Terms>String</Terms>
      <Title>String</Title>
      <TotalInstallmentPaymentsToDate>0</TotalInstallmentPaymentsToDate>
      <TransactionID>0</TransactionID>
      <WebsiteMemberID>0</WebsiteMemberID>
    </DuesTransactionData>
  </DuesTransactionsList>
</DuesTransactionsResponse>