YM REST Services

<back to all web services

Dues

Requires Authentication
Requires any of the roles:admin, oauthadminRequired permission:CanAdminMembers
The following routes are available for this service:
POST/Ams/{ClientID}/DuesCreate a Dues invoice.
Dues Parameters:
NameParameterData TypeRequiredDescription
transactionIdbodyintNo
IsTaxExemptbodyboolNo
DescriptionbodystringNo
AmountbodydoubleNo
MembershipbodyMembershipNo
RulesbodyDuesRulesResponseNo
invoicebodyInvoiceNo
DuesPromoCodebodystringNo
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
Membership Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
CodeformstringNo
NameformstringNo
DuesAmountformdoubleNo
ProRatedDuesformboolNo
ProRateFactorformdoubleNo
AllowMultipleOpenInvoicesformboolNo
DuesRulesResponse Parameters:
NameParameterData TypeRequiredDescription
RulesformList<DuesRule>No
DuesRules Parameters:
NameParameterData TypeRequiredDescription
MemberIDformintNo
MembershipIDformintNo
DuesRule Parameters:
NameParameterData TypeRequiredDescription
IDformintNo
NameformstringNo
DescriptionformstringNo
AmountformdoubleNo
SelectedformboolNo
Invoice Parameters:
NameParameterData TypeRequiredDescription
dateformDateTimeNo
shippingMethodIdformintNo
shippingMethodNameformstringNo
shippingTaxformdoubleNo
shippingTotalformdoubleNo
taxRateformdoubleNo
taxTotalformdoubleNo
totalAmountformdoubleNo
commentformstringNo
personformPersonNo
shippingAddressformAddressNo
invoiceItemsformList<InvoiceItem>No
isNewMemberformboolNo
taxGLCodeformstringNo
taxQBClassformstringNo
shippingGLCodeformstringNo
shippingQBClassformstringNo
Person Parameters:
NameParameterData TypeRequiredDescription
idformintNo
organizationformstringNo
firstNameformstringNo
lastNameformstringNo
middleNameformstringNo
nameSuffixformstringNo
emailAddressformstringNo
primaryAddressformAddressNo
usernameformstringNo
passwordformstringNo
isMemberformboolNo
expirationDateformstringNo
currentMembershipAllowsMultipleOpenInvoicesformboolNo
currentMembershipInvoiceIsOpenformboolNo
currentMembershipInvoiceAwaitingAutoBillformboolNo
Address Parameters:
NameParameterData TypeRequiredDescription
firstNameformstringNo
lastNameformstringNo
organizationformstringNo
address1formstringNo
address2formstringNo
cityformstringNo
locationformstringNo
postalCodeformstringNo
countryCodeformstringNo
countryNameformstringNo
areaCodeformstringNo
phoneformstringNo
InvoiceItem Parameters:
NameParameterData TypeRequiredDescription
itemTypeIdformstringNo
idformintNo
shippingCostformdoubleNo
descriptionformstringNo
customDescriptionformstringNo
taxRateformdoubleNo
taxGLCodeformstringNo
quantityformdoubleNo
amountformdoubleNo
isProRatedformboolNo
GLCodeformstringNo
isModifierformboolNo
isDuesRuleformboolNo
taxQBClassformstringNo
QBClassformstringNo
skuformstringNo
taxableformboolNo
autoPromoCodeAmountformdoubleNo
autoPromoCodeTitleformstringNo
salesDiscountformdoubleNo
DuesResponse Parameters:
NameParameterData TypeRequiredDescription
invoiceGuidformstringNo

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.

POST /Ams/{ClientID}/Dues HTTP/1.1 
Host: ws.yourmembership.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<Dues 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>
  <Amount>0</Amount>
  <Description>String</Description>
  <DuesPromoCode>String</DuesPromoCode>
  <IsTaxExempt>false</IsTaxExempt>
  <Membership>
    <AllowMultipleOpenInvoices>false</AllowMultipleOpenInvoices>
    <Code>String</Code>
    <DuesAmount>0</DuesAmount>
    <Id>0</Id>
    <Name>String</Name>
    <ProRateFactor>0</ProRateFactor>
    <ProRatedDues>false</ProRatedDues>
  </Membership>
  <Rules>
    <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:d3p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">
      <d3p1:ErrorCode>String</d3p1:ErrorCode>
      <d3p1:Message>String</d3p1:Message>
      <d3p1:StackTrace>String</d3p1:StackTrace>
      <d3p1:Errors>
        <d3p1:ResponseError>
          <d3p1:ErrorCode>String</d3p1:ErrorCode>
          <d3p1:FieldName>String</d3p1:FieldName>
          <d3p1:Message>String</d3p1:Message>
          <d3p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d3p1:Meta>
        </d3p1:ResponseError>
      </d3p1:Errors>
      <d3p1:Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </d3p1:Meta>
    </ResponseStatus>
    <MemberID>0</MemberID>
    <MembershipID>0</MembershipID>
    <Rules>
      <DuesRule>
        <Amount>0</Amount>
        <Description>String</Description>
        <ID>0</ID>
        <Name>String</Name>
        <Selected>false</Selected>
      </DuesRule>
    </Rules>
  </Rules>
  <invoice>
    <comment>String</comment>
    <date>0001-01-01T00:00:00</date>
    <invoiceItems>
      <InvoiceItem>
        <GLCode>String</GLCode>
        <QBClass>String</QBClass>
        <amount>0</amount>
        <autoPromoCodeAmount>0</autoPromoCodeAmount>
        <autoPromoCodeTitle>String</autoPromoCodeTitle>
        <customDescription>String</customDescription>
        <description>String</description>
        <id>0</id>
        <isDuesRule>false</isDuesRule>
        <isModifier>false</isModifier>
        <isProRated>false</isProRated>
        <itemTypeId>String</itemTypeId>
        <quantity>0</quantity>
        <salesDiscount>0</salesDiscount>
        <shippingCost>0</shippingCost>
        <sku>String</sku>
        <taxGLCode>String</taxGLCode>
        <taxQBClass>String</taxQBClass>
        <taxRate>0</taxRate>
        <taxable>false</taxable>
      </InvoiceItem>
    </invoiceItems>
    <isNewMember>false</isNewMember>
    <person>
      <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:d4p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">
        <d4p1:ErrorCode>String</d4p1:ErrorCode>
        <d4p1:Message>String</d4p1:Message>
        <d4p1:StackTrace>String</d4p1:StackTrace>
        <d4p1:Errors>
          <d4p1:ResponseError>
            <d4p1:ErrorCode>String</d4p1:ErrorCode>
            <d4p1:FieldName>String</d4p1:FieldName>
            <d4p1:Message>String</d4p1:Message>
            <d4p1:Meta xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:KeyValueOfstringstring>
                <d7p1:Key>String</d7p1:Key>
                <d7p1:Value>String</d7p1:Value>
              </d7p1:KeyValueOfstringstring>
            </d4p1:Meta>
          </d4p1:ResponseError>
        </d4p1:Errors>
        <d4p1: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>
        </d4p1:Meta>
      </ResponseStatus>
      <currentMembershipAllowsMultipleOpenInvoices>false</currentMembershipAllowsMultipleOpenInvoices>
      <currentMembershipInvoiceAwaitingAutoBill>false</currentMembershipInvoiceAwaitingAutoBill>
      <currentMembershipInvoiceIsOpen>false</currentMembershipInvoiceIsOpen>
      <emailAddress>String</emailAddress>
      <expirationDate>String</expirationDate>
      <firstName>String</firstName>
      <id>0</id>
      <isMember>false</isMember>
      <lastName>String</lastName>
      <middleName>String</middleName>
      <nameSuffix>String</nameSuffix>
      <organization>String</organization>
      <password>String</password>
      <primaryAddress>
        <address1>String</address1>
        <address2>String</address2>
        <areaCode>String</areaCode>
        <city>String</city>
        <countryCode>String</countryCode>
        <countryName>String</countryName>
        <firstName>String</firstName>
        <lastName>String</lastName>
        <location>String</location>
        <organization>String</organization>
        <phone>String</phone>
        <postalCode>String</postalCode>
      </primaryAddress>
      <username>String</username>
    </person>
    <shippingAddress>
      <address1>String</address1>
      <address2>String</address2>
      <areaCode>String</areaCode>
      <city>String</city>
      <countryCode>String</countryCode>
      <countryName>String</countryName>
      <firstName>String</firstName>
      <lastName>String</lastName>
      <location>String</location>
      <organization>String</organization>
      <phone>String</phone>
      <postalCode>String</postalCode>
    </shippingAddress>
    <shippingGLCode>String</shippingGLCode>
    <shippingMethodId>0</shippingMethodId>
    <shippingMethodName>String</shippingMethodName>
    <shippingQBClass>String</shippingQBClass>
    <shippingTax>0</shippingTax>
    <shippingTotal>0</shippingTotal>
    <taxGLCode>String</taxGLCode>
    <taxQBClass>String</taxQBClass>
    <taxRate>0</taxRate>
    <taxTotal>0</taxTotal>
    <totalAmount>0</totalAmount>
  </invoice>
  <transactionId>0</transactionId>
</Dues>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DuesResponse 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>
  <Amount>0</Amount>
  <Description>String</Description>
  <DuesPromoCode>String</DuesPromoCode>
  <IsTaxExempt>false</IsTaxExempt>
  <Membership>
    <AllowMultipleOpenInvoices>false</AllowMultipleOpenInvoices>
    <Code>String</Code>
    <DuesAmount>0</DuesAmount>
    <Id>0</Id>
    <Name>String</Name>
    <ProRateFactor>0</ProRateFactor>
    <ProRatedDues>false</ProRatedDues>
  </Membership>
  <Rules>
    <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:d3p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">
      <d3p1:ErrorCode>String</d3p1:ErrorCode>
      <d3p1:Message>String</d3p1:Message>
      <d3p1:StackTrace>String</d3p1:StackTrace>
      <d3p1:Errors>
        <d3p1:ResponseError>
          <d3p1:ErrorCode>String</d3p1:ErrorCode>
          <d3p1:FieldName>String</d3p1:FieldName>
          <d3p1:Message>String</d3p1:Message>
          <d3p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d3p1:Meta>
        </d3p1:ResponseError>
      </d3p1:Errors>
      <d3p1:Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </d3p1:Meta>
    </ResponseStatus>
    <MemberID>0</MemberID>
    <MembershipID>0</MembershipID>
    <Rules>
      <DuesRule>
        <Amount>0</Amount>
        <Description>String</Description>
        <ID>0</ID>
        <Name>String</Name>
        <Selected>false</Selected>
      </DuesRule>
    </Rules>
  </Rules>
  <invoice>
    <comment>String</comment>
    <date>0001-01-01T00:00:00</date>
    <invoiceItems>
      <InvoiceItem>
        <GLCode>String</GLCode>
        <QBClass>String</QBClass>
        <amount>0</amount>
        <autoPromoCodeAmount>0</autoPromoCodeAmount>
        <autoPromoCodeTitle>String</autoPromoCodeTitle>
        <customDescription>String</customDescription>
        <description>String</description>
        <id>0</id>
        <isDuesRule>false</isDuesRule>
        <isModifier>false</isModifier>
        <isProRated>false</isProRated>
        <itemTypeId>String</itemTypeId>
        <quantity>0</quantity>
        <salesDiscount>0</salesDiscount>
        <shippingCost>0</shippingCost>
        <sku>String</sku>
        <taxGLCode>String</taxGLCode>
        <taxQBClass>String</taxQBClass>
        <taxRate>0</taxRate>
        <taxable>false</taxable>
      </InvoiceItem>
    </invoiceItems>
    <isNewMember>false</isNewMember>
    <person>
      <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:d4p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">
        <d4p1:ErrorCode>String</d4p1:ErrorCode>
        <d4p1:Message>String</d4p1:Message>
        <d4p1:StackTrace>String</d4p1:StackTrace>
        <d4p1:Errors>
          <d4p1:ResponseError>
            <d4p1:ErrorCode>String</d4p1:ErrorCode>
            <d4p1:FieldName>String</d4p1:FieldName>
            <d4p1:Message>String</d4p1:Message>
            <d4p1:Meta xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:KeyValueOfstringstring>
                <d7p1:Key>String</d7p1:Key>
                <d7p1:Value>String</d7p1:Value>
              </d7p1:KeyValueOfstringstring>
            </d4p1:Meta>
          </d4p1:ResponseError>
        </d4p1:Errors>
        <d4p1: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>
        </d4p1:Meta>
      </ResponseStatus>
      <currentMembershipAllowsMultipleOpenInvoices>false</currentMembershipAllowsMultipleOpenInvoices>
      <currentMembershipInvoiceAwaitingAutoBill>false</currentMembershipInvoiceAwaitingAutoBill>
      <currentMembershipInvoiceIsOpen>false</currentMembershipInvoiceIsOpen>
      <emailAddress>String</emailAddress>
      <expirationDate>String</expirationDate>
      <firstName>String</firstName>
      <id>0</id>
      <isMember>false</isMember>
      <lastName>String</lastName>
      <middleName>String</middleName>
      <nameSuffix>String</nameSuffix>
      <organization>String</organization>
      <password>String</password>
      <primaryAddress>
        <address1>String</address1>
        <address2>String</address2>
        <areaCode>String</areaCode>
        <city>String</city>
        <countryCode>String</countryCode>
        <countryName>String</countryName>
        <firstName>String</firstName>
        <lastName>String</lastName>
        <location>String</location>
        <organization>String</organization>
        <phone>String</phone>
        <postalCode>String</postalCode>
      </primaryAddress>
      <username>String</username>
    </person>
    <shippingAddress>
      <address1>String</address1>
      <address2>String</address2>
      <areaCode>String</areaCode>
      <city>String</city>
      <countryCode>String</countryCode>
      <countryName>String</countryName>
      <firstName>String</firstName>
      <lastName>String</lastName>
      <location>String</location>
      <organization>String</organization>
      <phone>String</phone>
      <postalCode>String</postalCode>
    </shippingAddress>
    <shippingGLCode>String</shippingGLCode>
    <shippingMethodId>0</shippingMethodId>
    <shippingMethodName>String</shippingMethodName>
    <shippingQBClass>String</shippingQBClass>
    <shippingTax>0</shippingTax>
    <shippingTotal>0</shippingTotal>
    <taxGLCode>String</taxGLCode>
    <taxQBClass>String</taxQBClass>
    <taxRate>0</taxRate>
    <taxTotal>0</taxTotal>
    <totalAmount>0</totalAmount>
  </invoice>
  <transactionId>0</transactionId>
  <invoiceGuid>String</invoiceGuid>
</DuesResponse>