YM REST Services

<back to all web services

InvoicePayments

Requires Authentication
Requires any of the roles:admin, oauthadmin
The following routes are available for this service:
POST/Ams/{ClientID}/InvoicePaymentsApply a payment to an invoice.
InvoicePayments Parameters:
NameParameterData TypeRequiredDescription
InvoiceNobodyintNo
AmountbodyintNo
TypebodyInvoicePaymentOptions?No

Allowable Values

  • ach
  • cash
  • cc
  • check
RefNobodystringNo
PaymentDatebodyDateTime?No
PayerNamebodystringNo
PayerEmailbodystringNo
BillOrganizationbodystringNo
UpdateInvoiceInfobodyboolNo
AutoCloseInvoicebodyboolNo
UseInvoiceAddressbodyboolNo
BillAddress1bodystringNo
BillAddress2bodystringNo
BillCitybodystringNo
BillLocationbodystringNo
BillPostalCodebodystringNo
BillCountrybodystringNo
BillPhonebodystringNo
PaymentNotesbodystringNo
InternalNotesbodystringNo
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo

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

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	InvoiceNo: 0,
	Amount: 0,
	Type: ach,
	RefNo: String,
	PaymentDate: 0001-01-01,
	PayerName: String,
	PayerEmail: String,
	BillOrganization: String,
	UpdateInvoiceInfo: False,
	AutoCloseInvoice: False,
	UseInvoiceAddress: False,
	BillAddress1: String,
	BillAddress2: String,
	BillCity: String,
	BillLocation: String,
	BillPostalCode: String,
	BillCountry: String,
	BillPhone: String,
	PaymentNotes: String,
	InternalNotes: String,
	UsingRedis: True,
	AppInitTime: 2025-01-15T06:15:49.6223497-05:00,
	ServerID: WS-4-190-907,
	ClientID: 0,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	BypassCache: False,
	DateCached: 2025-01-15T08:46:40.0579437-05:00,
	Device: Desktop
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	InvoiceNo: 0,
	Amount: 0,
	Type: ach,
	RefNo: String,
	PaymentDate: 0001-01-01,
	PayerName: String,
	PayerEmail: String,
	BillOrganization: String,
	UpdateInvoiceInfo: False,
	AutoCloseInvoice: False,
	UseInvoiceAddress: False,
	BillAddress1: String,
	BillAddress2: String,
	BillCity: String,
	BillLocation: String,
	BillPostalCode: String,
	BillCountry: String,
	BillPhone: String,
	PaymentNotes: String,
	InternalNotes: String,
	UsingRedis: True,
	AppInitTime: 2025-01-15T06:15:49.6223497-05:00,
	ServerID: WS-4-190-907,
	ClientID: 0,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	BypassCache: False,
	DateCached: 2025-01-15T08:46:40.0579437-05:00,
	Device: Desktop
}