| Requires any of the roles: | admin, oauthadmin |
| 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. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UsingRedis | form | bool | No | |
| AppInitTime | form | DateTime | No | |
| ServerID | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ClientID | form | int | No | |
| ResponseStatus | form | ResponseStatus | No | |
| BypassCache | form | bool | No | |
| DateCached | form | DateTime | No | |
| Device | form | Device | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BatchID | form | string | No | |
| ItemCount | form | int? | No | |
| FinanceBatchList | form | List<FinanceBatch> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 .csv suffix or ?format=csv
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/csv
Content-Type: text/csv
Content-Length: length
{"CommerceType":"String","ClosingDate":"0001-01-01T00:00:00.0000000","ClosedOnly":false,"Timestamp":"0001-01-01T00:00:00.0000000","StartBatchID":"String","PageSize":0,"PageNumber":0,"UsingRedis":true,"AppInitTime":"2024-05-02T22:46:00.1553775-04:00","ServerID":"WS-4-7-585","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-03T00:15:34.7727557-04:00","Device":"Desktop"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"BatchID":"String","ItemCount":0,"FinanceBatchList":[{"BatchID":"String","CommerceType":"String","ItemCount":0,"ClosedDate":"0001-01-01T00:00:00.0000000","CreateDateTime":"0001-01-01T00:00:00.0000000"}],"CommerceType":"String","ClosingDate":"0001-01-01T00:00:00.0000000","ClosedOnly":false,"Timestamp":"0001-01-01T00:00:00.0000000","StartBatchID":"String","PageSize":0,"PageNumber":0,"UsingRedis":true,"AppInitTime":"2024-05-02T22:46:00.1553775-04:00","ServerID":"WS-4-7-585","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-03T00:15:34.7727557-04:00","Device":"Desktop"}