{"title":"Aggregate settlement details report","category":"default","creationDate":1776961629,"content":"<p>The Aggregate settlement details report shows details of payout batches in a specific date range. You can use this report to <a href=\"\/reporting\/settlement-reconciliation\/batch-level\">perform reconciliation on a batch level<\/a>.<\/p>\n<p>For each settlement batch, the report shows credits, debits, and counts of transactions for all payment journal type entries. The entries are separated by each of the following properties:<\/p>\n<ul>\n<li>Merchant account<\/li>\n<li>Store<\/li>\n<li>Terminal<\/li>\n<li>Payment method<\/li>\n<li>Journal type<\/li>\n<li>Creation date (the date of sale)<\/li>\n<\/ul>\n<p><strong>Generating and downloading<\/strong>: Get this report <a href=\"\/pt\/reporting\/manually-get-reports\">manually<\/a> or <a href=\"\/pt\/reporting\/automatically-get-reports\">automatically<\/a>.<\/p>\n<p><strong>Time zone<\/strong>: The <a href=\"\/pt\/reporting\/time-zone-setting\">time zone setting<\/a> of your account.<\/p>\n<p><strong>Date range<\/strong>: Select the date range of data included when you generate the report in your <a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Customer Area<\/a>.<\/p>\n<p><strong>Availability<\/strong>: Available for <a href=\"\/pt\/account\/account-structure#company-account\">company accounts<\/a> and <a href=\"\/pt\/account\/account-structure#merchant-accounts\">merchant accounts<\/a>.<\/p>\n<h2>Sample<\/h2>\n<p><a href=\"\/pt\/reporting\/settlement-reconciliation\/batch-level\/aggregate-settlement-details-report\/SAMPLE_settlement_report_aggregate_yourMerchantAccount___2019-03-01_2019-03-31.csv\">Download a sample Aggregate settlement details report<\/a> for examples of the included data.<\/p>\n<p>Based on your account and settings, a report you generate in your account can contain additional data or columns that are not included in the sample report.<\/p>\n<h2>Structure<\/h2>\n<h3>Summary<\/h3>\n<p>The first two lines show a summary of what's in the report:<\/p>\n<table>\n<thead>\n<tr>\n<th>Column<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td>Merchant\/Company<\/td>\n<td>Your merchant or company account code.<\/td>\n<\/tr>\n<tr>\n<td>Start date<\/td>\n<td>The start date of the data.<\/td>\n<\/tr>\n<tr>\n<td>End date<\/td>\n<td>The end date of the data.<\/td>\n<\/tr>\n<tr>\n<td>Aggregation<\/td>\n<td>If there are special criteria for aggregation of the data.<\/td>\n<\/tr>\n<tr>\n<td>Country codes<\/td>\n<td>If there is more than one country code.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h3 id=\"entries\">Entries<\/h3>\n<p>Under the header line, each line in the report is a separate entry.<\/p>\n<h3 id=\"columns\">Columns<\/h3>\n<p>Each column shows specific information about the entries. By default, the report includes <a href=\"#standard-columns\">standard columns<\/a>. You can optionally add <a href=\"#additional-columns\">additional columns<\/a>.<\/p>\n<h4 id=\"standard-columns\">Standard columns<\/h4>\n<div class=\"sticky-table-container\">\n    \n<table>\n<thead>\n<tr>\n<th>#<\/th>\n<th>Column<\/th>\n<th>Data type<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td>1<\/td>\n<td>Company Account<\/td>\n<td>Unicode Text (80-character)<\/td>\n<td>Name of your company account as registered in the plataforma de pagamentos da Adyen.<\/td>\n<\/tr>\n<tr>\n<td>2<\/td>\n<td>Merchant Account<\/td>\n<td>Unicode Text (80-character)<\/td>\n<td>Name of your merchant account used to process the original payment request.<\/td>\n<\/tr>\n<tr>\n<td>3<\/td>\n<td>Country Code<\/td>\n<td>Alpha Text (2 character)<\/td>\n<td>Country of your merchant account.<\/td>\n<\/tr>\n<tr>\n<td>4<\/td>\n<td>Store<\/td>\n<td>Unicode text (255-character)<\/td>\n<td>Merchant store code.<br>Value will be <strong>[empty]<\/strong> for balance-level bookings (For example, MerchantPayout, Fees), or if a store is not enabled when running the report.<\/td>\n<\/tr>\n<tr>\n<td>5<\/td>\n<td>Terminal ID<\/td>\n<td>Unicode Text (99-character)<\/td>\n<td>Unique identifier of the terminal.<br>Value will be <strong>[empty]<\/strong> for balance-level bookings (For example, MerchantPayout, Fees), or if a terminal is not enabled when running the report.<\/td>\n<\/tr>\n<tr>\n<td>6<\/td>\n<td>Batch Number<\/td>\n<td>Integer<\/td>\n<td>Sequence number of the settlement batch.<\/td>\n<\/tr>\n<tr>\n<td>7<\/td>\n<td>Batch Closed Date<\/td>\n<td>Date field (Format: YYYY-MM-DD).<\/td>\n<td>Date on which the settlement batch was closed (resulting in MerchantPayout and\/or BalanceTransfer to next batch). This corresponds to the start\/end date of the report.<\/td>\n<\/tr>\n<tr>\n<td>8<\/td>\n<td>Payment Method<\/td>\n<td>Unicode Text (30-character)<\/td>\n<td>Payment method type of the payment. <br>For example, <strong>visa<\/strong>, <strong>mc<\/strong>, <strong>amex<\/strong>.<\/td>\n<\/tr>\n<tr>\n<td>9<\/td>\n<td>Creation Date<\/td>\n<td>Date field (Format: YYYY-MM-DD).<\/td>\n<td>Day of sale for payment-level bookings; relates to transaction date on the terminal, or the date of capture.<br>For balance-level bookings (e.g. MerchantPayout, Fee, etc.), timestamp of the booking in the plataforma de pagamentos da Adyen.<\/td>\n<\/tr>\n<tr>\n<td>10<\/td>\n<td>TimeZone<\/td>\n<td>Alpha Text (4 character limit)<\/td>\n<td>The time zone of the <strong>Creation Date<\/strong>. <br>This is the ISO code for your <a href=\"\/pt\/reporting\/time-zone-setting\">time zone setting<\/a>.<\/td>\n<\/tr>\n<tr>\n<td>11<\/td>\n<td>Journal Type<\/td>\n<td>Alpha Text (50 character)<\/td>\n<td>Type of record included in the report, most commonly:<br><ul><li markdown=\"1\">Settled<\/li><li markdown=\"1\">Refunded \/ RefundedReversed<\/li><li markdown=\"1\">Chargeback \/ ChargebackReversed \/ SecondChargeback<\/li><li markdown=\"1\">Fee<\/li><li markdown=\"1\">InvoiceDeduction<\/li><li markdown=\"1\">PaymentCost<\/li><li markdown=\"1\">MerchantPayout<\/li><li markdown=\"1\">BalanceTransfer<\/li><li markdown=\"1\">ReserveAdjustment<\/li><li markdown=\"1\">MerchantPayin<\/li><\/ul>For a full list of possible entries and further description, see the <a href=\"\/pt\/reporting\/settlement-reconciliation\/transaction-level\/settlement-details-report\">Settlement details report<\/a>.<\/td>\n<\/tr>\n<tr>\n<td>12<\/td>\n<td>Gross Currency<\/td>\n<td>Alpha Text (3 character)<\/td>\n<td>Three-character ISO code for the currency that was used for processing the payment (transaction currency).<\/td>\n<\/tr>\n<tr>\n<td>13<\/td>\n<td>Gross Debit (GC)<\/td>\n<td>Fixed point number<\/td>\n<td>Amount submitted in the transaction request.<br>For example, <strong>100.00<\/strong>.<\/td>\n<\/tr>\n<tr>\n<td>14<\/td>\n<td>Gross Credit (GC)<\/td>\n<td>Fixed point number<\/td>\n<td>Amount submitted in the transaction request.<br>For example, <strong>100.00<\/strong>.<\/td>\n<\/tr>\n<tr>\n<td>15<\/td>\n<td>Exchange Rate<\/td>\n<td>Floating point number<\/td>\n<td>Exchange rate used for converting the gross amount into the net amount. This will be 1 if you process and settle in the same currency.<\/td>\n<\/tr>\n<tr>\n<td>16<\/td>\n<td>Net Currency<\/td>\n<td>Alpha Text (3 character)<\/td>\n<td>Three character ISO code for the currency that was used for processing the payment (settlement currency).<\/td>\n<\/tr>\n<tr>\n<td>17<\/td>\n<td>Net Debit (NC)<\/td>\n<td>Fixed point number<\/td>\n<td>Amount submitted in a debit transaction request, minus Bank\/Card Commission. For example: <strong>100.00<\/strong>.<\/td>\n<\/tr>\n<tr>\n<td>18<\/td>\n<td>Net Credit (NC)<\/td>\n<td>Fixed point number<\/td>\n<td>Amount submitted in a credit transaction request minus Bank\/Card Commission. For example: <strong>100.00<\/strong>.<\/td>\n<\/tr>\n<tr>\n<td>19<\/td>\n<td>Bank\/Card Commission (NC)<\/td>\n<td>Fixed point number<\/td>\n<td>Total commission (including markup, scheme fee and interchange) charged.<\/td>\n<\/tr>\n<tr>\n<td>20<\/td>\n<td>DCC Markup (NC)<\/td>\n<td>Fixed point number<\/td>\n<td>Dynamic Currency Conversion markup: a negative amount indicates a credit in your account (ie additional revenue).<\/td>\n<\/tr>\n<tr>\n<td>21<\/td>\n<td>Num Txs<\/td>\n<td>Integer<\/td>\n<td>Count of payments for this entry.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\n<\/div>\n\n<h4 id=\"additional-columns\">Additional columns<\/h4>\n<p>You can <a href=\"#configure-report-columns\">configure report columns<\/a> to add these to your report:<\/p>\n<div class=\"sticky-table-container\">\n    \n<table>\n<thead>\n<tr>\n<th>Column<\/th>\n<th>Data type<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td>Payable booking date<\/td>\n<td>Date field (Format: YYYY-MM-DD)<\/td>\n<td>Date on which the payment\/refund was booked into the settlement batch; can be used in the context of reconciling the monthly Adyen invoice.<\/td>\n<\/tr>\n<tr>\n<td>Payout reference<\/td>\n<td>Unicode Text (max. 15-characters)<\/td>\n<td>Unique identifier of a merchant payout, formatted like <strong>TX...XT<\/strong>. This also appears in the description of the transfer in your bank account or bank statement. Only applies to the <code>MerchantPayout<\/code> entry.<\/td>\n<\/tr>\n<tr>\n<td>Settlement Flow<\/td>\n<td>String<\/td>\n<td>The Adyen flow into which the transaction was booked.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\n<\/div>\n\n<h2 id=\"configure-report-columns\">Configure report columns<\/h2>\n<p>If you want to add additional columns or change the order of columns in a report, you can do so in the <a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Customer Area<\/a>. If you have an automated system that uses the report's data, configuring the report columns can affect your automated system.<\/p>\n<p>To configure report columns, you need to have one of the following <a href=\"\/pt\/account\/user-roles\">user roles<\/a>:<\/p>\n<ul>\n<li>Merchant admin<\/li>\n<li>Merchant report role<\/li>\n<li>Merchant financial<\/li>\n<li>Merchant POS Report role<\/li>\n<\/ul>\n<p>To configure report columns:<\/p>\n<ol>\n<li>Log in to your <a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Customer Area<\/a>.<\/li>\n<li>Go to <strong>Settings<\/strong> &gt; <strong>Report columns<\/strong>.<br \/>\nThis opens a page with all the reports that you can configure.<\/li>\n<li>Find the report that you want to configure and select <strong>Configure<\/strong>.<\/li>\n<li>Select checkboxes to indicate which columns you want to include in the report.<\/li>\n<li>Drag the columns into the order you want them to appear in.<\/li>\n<li>Select <strong>Save configuration<\/strong>.<\/li>\n<\/ol>\n<h2>See also<\/h2>\n<div class=\"see-also-links output-inline\" id=\"see-also\">\n<ul><li><a href=\"\/reporting\/settlement-reconciliation\/batch-level\"\n                        target=\"_self\"\n                        >\n                    Batch-level reconciliation\n                <\/a><\/li><\/ul><\/div>\n","url":"https:\/\/docs.adyen.com\/pt\/reporting\/settlement-reconciliation\/batch-level\/aggregate-settlement-details-report","articleFields":{"description":"Use this report to reconcile your settlements on a batch level.","id":"31500465","type":"page","_expandable":{"operations":""},"status":"current","parameters":{"report_name":"Aggregate settlement details report","file_name":"\/reporting\/settlement-reconciliation\/batch-level\/aggregate-settlement-details-report\/SAMPLE_settlement_report_aggregate_yourMerchantAccount___2019-03-01_2019-03-31.csv","additional_columns":"true","time_zone":"na","action":"<a href=\"\/reporting\/settlement-reconciliation\/batch-level\">perform reconciliation on a batch level<\/a>","ca_type":"ca","automatic":"yes","dates":"range","company_level":"yes"}},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/reporting\/settlement-reconciliation\/batch-level\/aggregate-settlement-details-report","title":"Aggregate settlement details report","content":"The Aggregate settlement details report shows details of payout batches in a specific date range. You can use this report to perform reconciliation on a batch level.\nFor each settlement batch, the report shows credits, debits, and counts of transactions for all payment journal type entries. The entries are separated by each of the following properties:\n\nMerchant account\nStore\nTerminal\nPayment method\nJournal type\nCreation date (the date of sale)\n\nGenerating and downloading: Get this report manually or automatically.\nTime zone: The time zone setting of your account.\nDate range: Select the date range of data included when you generate the report in your Customer Area.\nAvailability: Available for company accounts and merchant accounts.\nSample\nDownload a sample Aggregate settlement details report for examples of the included data.\nBased on your account and settings, a report you generate in your account can contain additional data or columns that are not included in the sample report.\nStructure\nSummary\nThe first two lines show a summary of what's in the report:\n\n\n\nColumn\nDescription\n\n\n\n\nMerchant\/Company\nYour merchant or company account code.\n\n\nStart date\nThe start date of the data.\n\n\nEnd date\nThe end date of the data.\n\n\nAggregation\nIf there are special criteria for aggregation of the data.\n\n\nCountry codes\nIf there is more than one country code.\n\n\n\nEntries\nUnder the header line, each line in the report is a separate entry.\nColumns\nEach column shows specific information about the entries. By default, the report includes standard columns. You can optionally add additional columns.\nStandard columns\n\n    \n\n\n\n#\nColumn\nData type\nDescription\n\n\n\n\n1\nCompany Account\nUnicode Text (80-character)\nName of your company account as registered in the plataforma de pagamentos da Adyen.\n\n\n2\nMerchant Account\nUnicode Text (80-character)\nName of your merchant account used to process the original payment request.\n\n\n3\nCountry Code\nAlpha Text (2 character)\nCountry of your merchant account.\n\n\n4\nStore\nUnicode text (255-character)\nMerchant store code.Value will be [empty] for balance-level bookings (For example, MerchantPayout, Fees), or if a store is not enabled when running the report.\n\n\n5\nTerminal ID\nUnicode Text (99-character)\nUnique identifier of the terminal.Value will be [empty] for balance-level bookings (For example, MerchantPayout, Fees), or if a terminal is not enabled when running the report.\n\n\n6\nBatch Number\nInteger\nSequence number of the settlement batch.\n\n\n7\nBatch Closed Date\nDate field (Format: YYYY-MM-DD).\nDate on which the settlement batch was closed (resulting in MerchantPayout and\/or BalanceTransfer to next batch). This corresponds to the start\/end date of the report.\n\n\n8\nPayment Method\nUnicode Text (30-character)\nPayment method type of the payment. For example, visa, mc, amex.\n\n\n9\nCreation Date\nDate field (Format: YYYY-MM-DD).\nDay of sale for payment-level bookings; relates to transaction date on the terminal, or the date of capture.For balance-level bookings (e.g. MerchantPayout, Fee, etc.), timestamp of the booking in the plataforma de pagamentos da Adyen.\n\n\n10\nTimeZone\nAlpha Text (4 character limit)\nThe time zone of the Creation Date. This is the ISO code for your time zone setting.\n\n\n11\nJournal Type\nAlpha Text (50 character)\nType of record included in the report, most commonly:SettledRefunded \/ RefundedReversedChargeback \/ ChargebackReversed \/ SecondChargebackFeeInvoiceDeductionPaymentCostMerchantPayoutBalanceTransferReserveAdjustmentMerchantPayinFor a full list of possible entries and further description, see the Settlement details report.\n\n\n12\nGross Currency\nAlpha Text (3 character)\nThree-character ISO code for the currency that was used for processing the payment (transaction currency).\n\n\n13\nGross Debit (GC)\nFixed point number\nAmount submitted in the transaction request.For example, 100.00.\n\n\n14\nGross Credit (GC)\nFixed point number\nAmount submitted in the transaction request.For example, 100.00.\n\n\n15\nExchange Rate\nFloating point number\nExchange rate used for converting the gross amount into the net amount. This will be 1 if you process and settle in the same currency.\n\n\n16\nNet Currency\nAlpha Text (3 character)\nThree character ISO code for the currency that was used for processing the payment (settlement currency).\n\n\n17\nNet Debit (NC)\nFixed point number\nAmount submitted in a debit transaction request, minus Bank\/Card Commission. For example: 100.00.\n\n\n18\nNet Credit (NC)\nFixed point number\nAmount submitted in a credit transaction request minus Bank\/Card Commission. For example: 100.00.\n\n\n19\nBank\/Card Commission (NC)\nFixed point number\nTotal commission (including markup, scheme fee and interchange) charged.\n\n\n20\nDCC Markup (NC)\nFixed point number\nDynamic Currency Conversion markup: a negative amount indicates a credit in your account (ie additional revenue).\n\n\n21\nNum Txs\nInteger\nCount of payments for this entry.\n\n\n\n\n\n\nAdditional columns\nYou can configure report columns to add these to your report:\n\n    \n\n\n\nColumn\nData type\nDescription\n\n\n\n\nPayable booking date\nDate field (Format: YYYY-MM-DD)\nDate on which the payment\/refund was booked into the settlement batch; can be used in the context of reconciling the monthly Adyen invoice.\n\n\nPayout reference\nUnicode Text (max. 15-characters)\nUnique identifier of a merchant payout, formatted like TX...XT. This also appears in the description of the transfer in your bank account or bank statement. Only applies to the MerchantPayout entry.\n\n\nSettlement Flow\nString\nThe Adyen flow into which the transaction was booked.\n\n\n\n\n\n\nConfigure report columns\nIf you want to add additional columns or change the order of columns in a report, you can do so in the Customer Area. If you have an automated system that uses the report's data, configuring the report columns can affect your automated system.\nTo configure report columns, you need to have one of the following user roles:\n\nMerchant admin\nMerchant report role\nMerchant financial\nMerchant POS Report role\n\nTo configure report columns:\n\nLog in to your Customer Area.\nGo to Settings &gt; Report columns.\nThis opens a page with all the reports that you can configure.\nFind the report that you want to configure and select Configure.\nSelect checkboxes to indicate which columns you want to include in the report.\nDrag the columns into the order you want them to appear in.\nSelect Save configuration.\n\nSee also\n\n\n                    Batch-level reconciliation\n                \n","type":"page","locale":"pt","boost":16,"hierarchy":{"lvl0":"Home","lvl1":"Reporting","lvl2":"Settlement reconciliation","lvl3":"Batch-level reconciliation","lvl4":"Aggregate settlement details report"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/reporting","lvl2":"https:\/\/docs.adyen.com\/pt\/reporting\/settlement-reconciliation","lvl3":"https:\/\/docs.adyen.com\/pt\/reporting\/settlement-reconciliation\/batch-level","lvl4":"\/pt\/reporting\/settlement-reconciliation\/batch-level\/aggregate-settlement-details-report"},"levels":5,"category":"Reporting","category_color":"green","tags":["Aggregate","settlement","details","report"]},"articleFiles":{"SAMPLE_settlement_report_aggregate_yourMerchantAccount___2019-03-01_2019-03-31.csv":"<p alt=\"\">SAMPLE_settlement_report_aggregate_yourMerchantAccount___2019-03-01_2019-03-31.csv<\/p>"}}