YM REST Services

InvoicePayments

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

The following routes are available for this service:
POST	/Ams/{ClientID}/InvoicePayments	Apply a payment to an invoice.

**InvoicePayments** Parameters:
Name	Parameter	Data Type	Required	Description
InvoiceNo	body	int	No
Amount	body	int	No
Type	body	InvoicePaymentOptions?	No	Allowable Values ach cash cc check
RefNo	body	string	No
PaymentDate	body	DateTime?	No
PayerName	body	string	No
PayerEmail	body	string	No
BillOrganization	body	string	No
UpdateInvoiceInfo	body	bool	No
AutoCloseInvoice	body	bool	No
UseInvoiceAddress	body	bool	No
BillAddress1	body	string	No
BillAddress2	body	string	No
BillCity	body	string	No
BillLocation	body	string	No
BillPostalCode	body	string	No
BillCountry	body	string	No
BillPhone	body	string	No
PaymentNotes	body	string	No
InternalNotes	body	string	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

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}/InvoicePayments HTTP/1.1 
Host: ws.yourmembership.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<InvoicePayments 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>
  <AutoCloseInvoice>false</AutoCloseInvoice>
  <BillAddress1>String</BillAddress1>
  <BillAddress2>String</BillAddress2>
  <BillCity>String</BillCity>
  <BillCountry>String</BillCountry>
  <BillLocation>String</BillLocation>
  <BillOrganization>String</BillOrganization>
  <BillPhone>String</BillPhone>
  <BillPostalCode>String</BillPostalCode>
  <InternalNotes>String</InternalNotes>
  <InvoiceNo>0</InvoiceNo>
  <PayerEmail>String</PayerEmail>
  <PayerName>String</PayerName>
  <PaymentDate>0001-01-01T00:00:00</PaymentDate>
  <PaymentNotes>String</PaymentNotes>
  <RefNo>String</RefNo>
  <Type>ach</Type>
  <UpdateInvoiceInfo>false</UpdateInvoiceInfo>
  <UseInvoiceAddress>false</UseInvoiceAddress>
</InvoicePayments>

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

<InvoicePaymentsResponse 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>
  <AutoCloseInvoice>false</AutoCloseInvoice>
  <BillAddress1>String</BillAddress1>
  <BillAddress2>String</BillAddress2>
  <BillCity>String</BillCity>
  <BillCountry>String</BillCountry>
  <BillLocation>String</BillLocation>
  <BillOrganization>String</BillOrganization>
  <BillPhone>String</BillPhone>
  <BillPostalCode>String</BillPostalCode>
  <InternalNotes>String</InternalNotes>
  <InvoiceNo>0</InvoiceNo>
  <PayerEmail>String</PayerEmail>
  <PayerName>String</PayerName>
  <PaymentDate>0001-01-01T00:00:00</PaymentDate>
  <PaymentNotes>String</PaymentNotes>
  <RefNo>String</RefNo>
  <Type>ach</Type>
  <UpdateInvoiceInfo>false</UpdateInvoiceInfo>
  <UseInvoiceAddress>false</UseInvoiceAddress>
</InvoicePaymentsResponse>

YM REST Services

InvoicePayments

Allowable Values

HTTP + XML