POST api/esuite/v1/tylerpayments/CloseBatch
Closes a single batch.
Request Information
Parameters
Name | Description | Additional information |
---|---|---|
closeBatchRequest | Contains the batch to close. External ID should be populated. |
Define this parameter in the request body. |
Request body formats
application/json, text/json
Sample:
{ "Batch": { "Id": 1, "Number": "sample string 2", "ExternalId": "sample string 3", "ExternalSystemId": 4, "ProcessingDate": "2025-05-12T03:01:40.9892272-05:00", "EffectiveDate": "2025-05-12T03:01:40.9892272-05:00", "GLDate": "2025-05-12T03:01:40.9892272-05:00", "BeginningCash": 8.0, "TransactionsCount": 9, "TransactionsTotal": 10.0, "FullTransactionsCount": 11, "FullTransactionsTotal": 12.0, "PaymentsCount": 13, "PaymentsTotal": 14.0, "TendersCount": 15, "TendersTotal": 16.0, "CashTenderTransactionsCount": 17, "CheckTenderTransactionsCount": 18, "CreditCardTenderTransactionsCount": 19, "AccountTenderTransactionsCount": 20, "OtherTenderTransactionsCount": 21, "Tenders": [ { "Classification": 0, "TenderTypeId": 1, "TenderTypeDescription": "sample string 2", "Amount": 3.0, "TenderCount": 4 }, { "Classification": 0, "TenderTypeId": 1, "TenderTypeDescription": "sample string 2", "Amount": 3.0, "TenderCount": 4 }, { "Classification": 0, "TenderTypeId": 1, "TenderTypeDescription": "sample string 2", "Amount": 3.0, "TenderCount": 4 } ] }, "AdditionalInfo": { "sample string 1": "sample string 2", "sample string 3": "sample string 4", "sample string 5": "sample string 6" }, "ExternalExecutionContext": { "BatchEffectiveDate": "2025-05-12T03:01:40.9892272-05:00", "BatchProcessingDate": "2025-05-12T03:01:40.9892272-05:00", "BatchGLDate": "2025-05-12T03:01:40.9892272-05:00", "UTCBatchEffectiveDate": "2025-05-12T03:01:40.9892272-05:00", "UTCBatchProcessingDate": "2025-05-12T03:01:40.9892272-05:00", "UTCBatchGLDate": "2025-05-12T03:01:40.9892272-05:00", "UserId": "sample string 1", "CashierId": "sample string 2", "WorkstationId": "sample string 3", "StateCode": "sample string 4", "BatchDepartmentCode": "sample string 5", "BatchDepositReference": "sample string 6" } }
application/xml, text/xml
Sample:
<CloseBatchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tyler.Cashiering.Integration.StandardApiModels"> <AdditionalInfo xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:KeyValueOfstringstring> <d2p1:Key>sample string 1</d2p1:Key> <d2p1:Value>sample string 2</d2p1:Value> </d2p1:KeyValueOfstringstring> <d2p1:KeyValueOfstringstring> <d2p1:Key>sample string 3</d2p1:Key> <d2p1:Value>sample string 4</d2p1:Value> </d2p1:KeyValueOfstringstring> <d2p1:KeyValueOfstringstring> <d2p1:Key>sample string 5</d2p1:Key> <d2p1:Value>sample string 6</d2p1:Value> </d2p1:KeyValueOfstringstring> </AdditionalInfo> <ExternalExecutionContext xmlns:d2p1="http://schemas.datacontract.org/2004/07/Tyler.Cashiering.Integration"> <d2p1:BatchDepartmentCode>sample string 5</d2p1:BatchDepartmentCode> <d2p1:BatchDepositReference>sample string 6</d2p1:BatchDepositReference> <d2p1:BatchEffectiveDate>2025-05-12T03:01:40.9892272-05:00</d2p1:BatchEffectiveDate> <d2p1:BatchGLDate>2025-05-12T03:01:40.9892272-05:00</d2p1:BatchGLDate> <d2p1:BatchProcessingDate>2025-05-12T03:01:40.9892272-05:00</d2p1:BatchProcessingDate> <d2p1:CashierId>sample string 2</d2p1:CashierId> <d2p1:StateCode>sample string 4</d2p1:StateCode> <d2p1:UTCBatchEffectiveDate>2025-05-12T03:01:40.9892272-05:00</d2p1:UTCBatchEffectiveDate> <d2p1:UTCBatchGLDate>2025-05-12T03:01:40.9892272-05:00</d2p1:UTCBatchGLDate> <d2p1:UTCBatchProcessingDate>2025-05-12T03:01:40.9892272-05:00</d2p1:UTCBatchProcessingDate> <d2p1:UserId>sample string 1</d2p1:UserId> <d2p1:WorkstationId>sample string 3</d2p1:WorkstationId> </ExternalExecutionContext> <Batch xmlns:d2p1="http://schemas.datacontract.org/2004/07/Tyler.Cashiering.Integration"> <d2p1:AccountTenderTransactionsCount>20</d2p1:AccountTenderTransactionsCount> <d2p1:BeginningCash>8</d2p1:BeginningCash> <d2p1:CashTenderTransactionsCount>17</d2p1:CashTenderTransactionsCount> <d2p1:CheckTenderTransactionsCount>18</d2p1:CheckTenderTransactionsCount> <d2p1:CreditCardTenderTransactionsCount>19</d2p1:CreditCardTenderTransactionsCount> <d2p1:EffectiveDate>2025-05-12T03:01:40.9892272-05:00</d2p1:EffectiveDate> <d2p1:ExternalId>sample string 3</d2p1:ExternalId> <d2p1:ExternalSystemId>4</d2p1:ExternalSystemId> <d2p1:FullTransactionsCount>11</d2p1:FullTransactionsCount> <d2p1:FullTransactionsTotal>12</d2p1:FullTransactionsTotal> <d2p1:GLDate>2025-05-12T03:01:40.9892272-05:00</d2p1:GLDate> <d2p1:Id>1</d2p1:Id> <d2p1:Number>sample string 2</d2p1:Number> <d2p1:OtherTenderTransactionsCount>21</d2p1:OtherTenderTransactionsCount> <d2p1:PaymentsCount>13</d2p1:PaymentsCount> <d2p1:PaymentsTotal>14</d2p1:PaymentsTotal> <d2p1:ProcessingDate>2025-05-12T03:01:40.9892272-05:00</d2p1:ProcessingDate> <d2p1:Tenders> <d2p1:EndOfDayTender> <d2p1:Amount>3</d2p1:Amount> <d2p1:Classification>Cash</d2p1:Classification> <d2p1:TenderCount>4</d2p1:TenderCount> <d2p1:TenderTypeDescription>sample string 2</d2p1:TenderTypeDescription> <d2p1:TenderTypeId>1</d2p1:TenderTypeId> </d2p1:EndOfDayTender> <d2p1:EndOfDayTender> <d2p1:Amount>3</d2p1:Amount> <d2p1:Classification>Cash</d2p1:Classification> <d2p1:TenderCount>4</d2p1:TenderCount> <d2p1:TenderTypeDescription>sample string 2</d2p1:TenderTypeDescription> <d2p1:TenderTypeId>1</d2p1:TenderTypeId> </d2p1:EndOfDayTender> <d2p1:EndOfDayTender> <d2p1:Amount>3</d2p1:Amount> <d2p1:Classification>Cash</d2p1:Classification> <d2p1:TenderCount>4</d2p1:TenderCount> <d2p1:TenderTypeDescription>sample string 2</d2p1:TenderTypeDescription> <d2p1:TenderTypeId>1</d2p1:TenderTypeId> </d2p1:EndOfDayTender> </d2p1:Tenders> <d2p1:TendersCount>15</d2p1:TendersCount> <d2p1:TendersTotal>16</d2p1:TendersTotal> <d2p1:TransactionsCount>9</d2p1:TransactionsCount> <d2p1:TransactionsTotal>10</d2p1:TransactionsTotal> </Batch> </CloseBatchRequest>
Response Information
Response containing any errors/business rule exceptions encountered closing the batch in the external system. No errors means a success.
Response body formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.