YM REST Services

InvoiceItems

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

The following routes are available for this service:
GET	/Ams/{ClientID}/InvoiceItems	Invoice items lookup - with cache.	Return all invoice items for given criteria.

**InvoiceItems** Parameters:
Name	Parameter	Data Type	Required
DateFrom	query	DateTime	No
InvoiceItemType	query	InvoiceItemType	No
PageSize	query	int	No
PageNumber	query	int	No
OffSet	query	int	No
LineItemDateEnteredFrom	query	DateTime?	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

**InvoiceItemsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
InvoiceItemsList	form	List<InvoiceItemData>	No

**InvoiceItemData** Parameters:
Name	Parameter	Data Type	Required
InvoiceNo	form	int	No
InvoiceType	form	string	No
InvoiceNameLast	form	string	No
InvoiceNameFirst	form	string	No
InvoiceNameMiddle	form	string	No
InvoiceNameSuffix	form	string	No
OriginalInvoicePaymentOption	form	string	No
PaymentTerms	form	string	No
Organization	form	string	No
Address1	form	string	No
Address2	form	string	No
City	form	string	No
State	form	string	No
Province	form	string	No
PostalCode	form	string	No
Country	form	string	No
EmailAddress	form	string	No
Phone	form	string	No
OutstandingBalance	form	double	No
OriginalInvoiceBillingAddress1	form	string	No
OriginalInvoiceBillingAddress2	form	string	No
OriginalInvoiceBillingCity	form	string	No
OriginalInvoiceBillingState	form	string	No
OriginalInvoiceBillingProvince	form	string	No
OriginalInvoiceBillingPostalCode	form	string	No
OriginalInvoiceBillingCountry	form	string	No
OriginalInvoiceBillingPhone	form	string	No
OriginalInvoiceNameOnCard	form	string	No
OriginalInvoiceCardNumber	form	string	No
OriginalInvoiceCardType	form	string	No
OriginalInvoiceCardExpMonth	form	int	No
OriginalInvoiceCardExpYear	form	int	No
OriginalInvoiceComments	form	string	No
OriginalInvoiceInternalNotes	form	string	No
DateInvoiceLastSent	form	DateTime	No
LineItemID	form	int	No
LineItemRelatedTo	form	int	No
LineItemType	form	string	No
LineItemDescription	form	string	No
GLCodeItemName	form	string	No
QBClassItemName	form	string	No
LineItemDate	form	DateTime	No
LineItemAmount	form	double	No
LineItemQuantity	form	int	No
LineTotal	form	double	No
LineItemTaxVATRate	form	double	No
LineItemNotesVisible	form	string	No
LineItemNotesInternal	form	string	No
PaymentOption	form	string	No
PaymentCheckReferenceNumber	form	string	No
PaymentBillingAddress1	form	string	No
PaymentBillingAddress2	form	string	No
PaymentBillingCity	form	string	No
PaymentBillingState	form	string	No
PaymentBillingProvince	form	string	No
PaymentBillingPostalCode	form	string	No
PaymentBillingCountry	form	string	No
PaymentBillingPhone	form	string	No
PaymentNameOnCard	form	string	No
PaymentEmailAddress	form	string	No
PaymentCardNumber	form	string	No
PaymentCardType	form	string	No
PaymentCardExpMonth	form	int	No
PaymentCardExpYear	form	int	No
EnteredBy	form	string	No
Account	form	string	No
OriginalInvoiceBillingOrganization	form	string	No
PaymentBillingOrganization	form	string	No
PO	form	string	No
WebSiteMemberID	form	int	No
ConstituentID	form	string	No
PaymentProcessorAccountID	form	int	No
PaymentProcessor	form	string	No
PaymentProcessorAccountNickname	form	string	No
LineItemDateEntered	form	DateTime	No

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.

GET /Ams/{ClientID}/InvoiceItems HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/jsv

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

{
	InvoiceItemsList: 
	[
		{
			InvoiceNo: 0,
			InvoiceType: String,
			InvoiceNameLast: String,
			InvoiceNameFirst: String,
			InvoiceNameMiddle: String,
			InvoiceNameSuffix: String,
			OriginalInvoicePaymentOption: String,
			PaymentTerms: String,
			Organization: String,
			Address1: String,
			Address2: String,
			City: String,
			State: String,
			Province: String,
			PostalCode: String,
			Country: String,
			EmailAddress: String,
			Phone: String,
			OutstandingBalance: 0,
			OriginalInvoiceBillingAddress1: String,
			OriginalInvoiceBillingAddress2: String,
			OriginalInvoiceBillingCity: String,
			OriginalInvoiceBillingState: String,
			OriginalInvoiceBillingProvince: String,
			OriginalInvoiceBillingPostalCode: String,
			OriginalInvoiceBillingCountry: String,
			OriginalInvoiceBillingPhone: String,
			OriginalInvoiceNameOnCard: String,
			OriginalInvoiceCardNumber: String,
			OriginalInvoiceCardType: String,
			OriginalInvoiceCardExpMonth: 0,
			OriginalInvoiceCardExpYear: 0,
			OriginalInvoiceComments: String,
			OriginalInvoiceInternalNotes: String,
			DateInvoiceLastSent: 0001-01-01,
			LineItemID: 0,
			LineItemRelatedTo: 0,
			LineItemType: String,
			LineItemDescription: String,
			GLCodeItemName: String,
			QBClassItemName: String,
			LineItemDate: 0001-01-01,
			LineItemAmount: 0,
			LineItemQuantity: 0,
			LineTotal: 0,
			LineItemTaxVATRate: 0,
			LineItemNotesVisible: String,
			LineItemNotesInternal: String,
			PaymentOption: String,
			PaymentCheckReferenceNumber: String,
			PaymentBillingAddress1: String,
			PaymentBillingAddress2: String,
			PaymentBillingCity: String,
			PaymentBillingState: String,
			PaymentBillingProvince: String,
			PaymentBillingPostalCode: String,
			PaymentBillingCountry: String,
			PaymentBillingPhone: String,
			PaymentNameOnCard: String,
			PaymentEmailAddress: String,
			PaymentCardNumber: String,
			PaymentCardType: String,
			PaymentCardExpMonth: 0,
			PaymentCardExpYear: 0,
			EnteredBy: String,
			Account: String,
			OriginalInvoiceBillingOrganization: String,
			PaymentBillingOrganization: String,
			PO: String,
			WebSiteMemberID: 0,
			ConstituentID: String,
			PaymentProcessorAccountID: 0,
			PaymentProcessor: String,
			PaymentProcessorAccountNickname: String,
			LineItemDateEntered: 0001-01-01
		}
	],
	DateFrom: 0001-01-01,
	InvoiceItemType: All,
	PageSize: 0,
	PageNumber: 0,
	OffSet: 0,
	LineItemDateEnteredFrom: 0001-01-01,
	UsingRedis: True,
	AppInitTime: 2024-05-03T03:25:08.2888604-04:00,
	ServerID: WS-4-69-031,
	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: 2024-05-03T05:43:38.5774507-04:00,
	Device: Desktop
}