YM REST Services

FinanceBatches

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

The following routes are available for this service:
GET	/Ams/{ClientID}/FinanceBatches	Return a chronological list of Financial Batches.	Uses either a specific batch (recommended) or timestamp as a starting point. This method would typically be used in conjunction with subsequent calls to Sa.Export.Finance.Batch for each BatchID returned for the purposes of importing financial data into a 3rd-party accounting sytem. Server time information is also returned, specifically the current date/time ServerTime and GMT bias ServerGmtBias.
POST	/Ams/{ClientID}/FinanceBatches	Starts an export of all invoice items in the specified batch and returns the ExportID.	To query the status of an export, call Sa.Export.Status until receiving either a COMPLETE or FAILURE status code. Upon receiving a COMPLETE status code, the download location of your export file will be returned by Sa.Export.Status as ExportURI.

**FinanceBatches** Parameters:
Name	Parameter	Data Type	Required
CommerceType	body	string	No
ClosingDate	body	DateTime	No
ClosedOnly	body	bool	No
Timestamp	body	DateTime?	No
StartBatchID	body	string	No
PageSize	body	int	No
PageNumber	body	int	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

**FinanceBatchesResponse** Parameters:
Name	Parameter	Data Type	Required
BatchID	form	string	No
ItemCount	form	int?	No
FinanceBatchList	form	List<FinanceBatch>	No

**FinanceBatch** Parameters:
Name	Parameter	Data Type	Required
BatchID	form	string	No
CommerceType	form	string	No
ItemCount	form	int	No
ClosedDate	form	DateTime	No
CreateDateTime	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.

POST /Ams/{ClientID}/FinanceBatches HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CommerceType: String,
	ClosingDate: 0001-01-01,
	ClosedOnly: False,
	Timestamp: 0001-01-01,
	StartBatchID: String,
	PageSize: 0,
	PageNumber: 0,
	UsingRedis: True,
	AppInitTime: 2025-01-15T07:19:47.5165087-05:00,
	ServerID: WS-6-56-398,
	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:38:23.7788431-05:00,
	Device: Desktop
}

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

{
	BatchID: String,
	ItemCount: 0,
	FinanceBatchList: 
	[
		{
			BatchID: String,
			CommerceType: String,
			ItemCount: 0,
			ClosedDate: 0001-01-01,
			CreateDateTime: 0001-01-01
		}
	],
	CommerceType: String,
	ClosingDate: 0001-01-01,
	ClosedOnly: False,
	Timestamp: 0001-01-01,
	StartBatchID: String,
	PageSize: 0,
	PageNumber: 0,
	UsingRedis: True,
	AppInitTime: 2025-01-15T07:19:47.5165087-05:00,
	ServerID: WS-6-56-398,
	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:38:23.7788431-05:00,
	Device: Desktop
}