YM REST Services

<back to all web services

FinanceBatchDetails

Requires Authentication
Requires any of the roles:admin, oauthadmin
The following routes are available for this service:
GET/Ams/{ClientID}/FinanceBatchDetailsReturn details of the finance batch for a given batchid.
FinanceBatchDetails Parameters:
NameParameterData TypeRequiredDescription
BatchIdquerystringNo
PageSizequeryintNo
PageNumberqueryintNo
OffSetqueryintNo
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
FinanceBatchDetailsResponse Parameters:
NameParameterData TypeRequiredDescription
FinanceBatchDetailsListformList<FinanceBatchDetailData>No
FinanceBatchDetailData Parameters:
NameParameterData TypeRequiredDescription
InvoiceNoformintNo
InvoiceTypeformstringNo
NameOnInvoiceLastformstringNo
NameOnInvoiceFirstformstringNo
NameOnInvoiceMiddleformstringNo
NameOnInvoiceSuffixformstringNo
OriginalInvoicePaymentOptionformstringNo
PaymentTermsformstringNo
OrganizationformstringNo
Address1formstringNo
Address2formstringNo
CityformstringNo
StateformstringNo
ProvinceformstringNo
PostalCodeformstringNo
CountryformstringNo
EmailAddressformstringNo
PhoneformstringNo
OutstandingBalanceformdoubleNo
OriginalInvoiceBillingAddress1formstringNo
OriginalInvoiceBillingAddress2formstringNo
OriginalInvoiceBillingCityformstringNo
OriginalInvoiceBillingStateformstringNo
OriginalInvoiceBillingProvinceformstringNo
OriginalInvoiceBillingPostalCodeformstringNo
OriginalInvoiceBillingCountryformstringNo
OriginalInvoiceBillingPhoneformstringNo
OriginalInvoiceNameOnCardformstringNo
OriginalInvoiceCardNumberformstringNo
OriginalInvoiceCardTypeformstringNo
OriginalInvoiceCardExpMonthformstringNo
OriginalInvoiceCardExpYearformstringNo
OriginalInvoiceCommentsformstringNo
OriginalInvoiceInternalNotesformstringNo
DateInvoiceLastSentformDateTimeNo
LineItemIDformintNo
LineItemRelatedToformintNo
LineItemTypeformstringNo
LineItemDescriptionformstringNo
GLCodeItemNameformstringNo
QBClassItemNameformstringNo
LineItemDateformDateTimeNo
LineItemAmountformdoubleNo
LineItemQuantityformintNo
LineTotalformdoubleNo
LineItemTaxVATRateformdoubleNo
LineItemNotesVisibleformstringNo
LineItemNotesInternalformstringNo
PaymentOptionformstringNo
PaymentCheckReferenceNumberformstringNo
PaymentBillingAddress1formstringNo
PaymentBillingAddress2formstringNo
PaymentBillingCityformstringNo
PaymentBillingStateformstringNo
PaymentBillingProvinceformstringNo
PaymentBillingPostalCodeformstringNo
PaymentBillingCountryformstringNo
PaymentBillingPhoneformstringNo
PaymentNameOnCardformstringNo
PaymentEmailAddressformstringNo
PaymentCardNumberformstringNo
PaymentCardTypeformstringNo
PaymentCardExpMonthformstringNo
PaymentCardExpYearformstringNo
EnteredByformstringNo
AccountformstringNo
OriginalInvoiceBillingOrganizationformstringNo
PaymentBillingOrganizationformstringNo
POformstringNo
WebSiteMemberIDformintNo
ConstituentIDformstringNo
PaymentProcessorAccountIDformintNo
PaymentProcessorformstringNo
PaymentProcessorAccountNicknameformstringNo
LineItemDateEnteredformDateTimeNo

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

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

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

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

{"FinanceBatchDetailsList":[{"InvoiceNo":0,"InvoiceType":"String","NameOnInvoiceLast":"String","NameOnInvoiceFirst":"String","NameOnInvoiceMiddle":"String","NameOnInvoiceSuffix":"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":"String","OriginalInvoiceCardExpYear":"String","OriginalInvoiceComments":"String","OriginalInvoiceInternalNotes":"String","DateInvoiceLastSent":"0001-01-01T00:00:00.0000000","LineItemID":0,"LineItemRelatedTo":0,"LineItemType":"String","LineItemDescription":"String","GLCodeItemName":"String","QBClassItemName":"String","LineItemDate":"0001-01-01T00:00:00.0000000","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":"String","PaymentCardExpYear":"String","EnteredBy":"String","Account":"String","OriginalInvoiceBillingOrganization":"String","PaymentBillingOrganization":"String","PO":"String","WebSiteMemberID":0,"ConstituentID":"String","PaymentProcessorAccountID":0,"PaymentProcessor":"String","PaymentProcessorAccountNickname":"String","LineItemDateEntered":"0001-01-01T00:00:00.0000000"}],"BatchId":"String","PageSize":0,"PageNumber":0,"OffSet":0,"UsingRedis":true,"AppInitTime":"2025-01-15T06:36:34.5424027-05:00","ServerID":"WS-5-212-532","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:39:28.6293995-05:00","Device":"Desktop"}