- [JSON representation](https://developers.google.com/pay/card-fop-v1/google-card-fop-api/GspDomesticPayoutHeader#SCHEMA_REPRESENTATION)

Header record details in a domestic payout file.

There can be multiple header records in a file, but only a single header per each customer ID (i.e. Settlement Line of Business ID).

The Record type can be dynamically determined by the file consumer using the `DomesticPayoutRecord.type` field.

| JSON representation |
|---|
| ``` { "domesticPayoutId": string, "settlementDate": { object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-api/settlementNotification#Timestamp`) }, "settlementLineOfBusinessId": string, "merchantId": string, "paymentRecordCount": string, "refundRecordCount": string, "paymentGrossAmount": { object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-api/settlementNotification#Amount`) }, "refundGrossAmount": { object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-api/settlementNotification#Amount`) }, "marketplaceAmount": { object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-api/settlementNotification#Amount`) }, "incentiveAmount": { object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-api/settlementNotification#Amount`) }, // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "adjustmentCredit": { object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-api/settlementNotification#Amount`) }, "adjustmentDebit": { object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-api/settlementNotification#Amount`) } // End of mutually exclusive fields. } ``` |

| Fields ||
|---|---|
| `domesticPayoutId` | `string` **REQUIRED**: The Domestic Payout ID. As populated in the file, a combination of a non-zero, non-negative prefix number and the settlement date. |
| `settlementDate` | ``object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-api/settlementNotification#Timestamp`)`` **REQUIRED**: The settlement date, in milliseconds. This date needs to be greater than, or equal to, the system date. Usually this is the date of the file creation. |
| `settlementLineOfBusinessId` | `string` **REQUIRED**: The customer ID (i.e. Settlement Line of Business ID). |
| `merchantId` | `string` **REQUIRED**: The merchant ID. |
| `paymentRecordCount` | `string (https://developers.google.com/discovery/v1/type-format format)` **REQUIRED**: The number of payment records associated with this header. |
| `refundRecordCount` | `string (https://developers.google.com/discovery/v1/type-format format)` **REQUIRED**: The number of refund records associated with this header. |
| `paymentGrossAmount` | ``object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-api/settlementNotification#Amount`)`` **REQUIRED**: The gross amount of all payment records associated with this header. |
| `refundGrossAmount` | ``object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-api/settlementNotification#Amount`)`` **REQUIRED**: The gross amount of all refund records associated with this header. |
| `marketplaceAmount` | ``object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-api/settlementNotification#Amount`)`` **REQUIRED**: The "marketplace" amount associated with this header. |
| `incentiveAmount` | ``object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-api/settlementNotification#Amount`)`` **REQUIRED**: The "incentive" amount associated with this header. |
| **REQUIRED**: The "adjustment" associated with this header. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response: ||
| `adjustmentCredit` | ``object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-api/settlementNotification#Amount`)`` The credit "adjustment" amount associated with this header. |
| `adjustmentDebit` | ``object (`https://developers.google.com/pay/card-fop-v1/google-card-fop-api/settlementNotification#Amount`)`` **REQUIRED**: The debit "adjustment" amount associated with this header. |
| End of mutually exclusive fields. ||