GspCardSettlementHeader
Stay organized with collections
Save and categorize content based on your preferences.
All rights reserved. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-02-28 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-28 UTC."],[[["\u003cp\u003eThe header object encapsulates details of a GSP Card settlement, including a unique ID, settlement period, total amount, and the number of settled items.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003esettlementId\u003c/code\u003e is a unique identifier for a settlement report and should be consistent across all related files.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003esettlementPeriod\u003c/code\u003e defines the time range covered by the settlement report using the \u003ccode\u003eInterval\u003c/code\u003e object.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003esettlementAmount\u003c/code\u003e, represented by the \u003ccode\u003eAmount\u003c/code\u003e object, must equal the total of all events and adjustments within the settlement file.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003enumberOfItems\u003c/code\u003e indicates the count of settled items, excluding the header, and is formatted as an \u003ccode\u003eInt64Value\u003c/code\u003e.\u003c/p\u003e\n"]]],["The provided JSON schema outlines the structure for a GSP Card settlement file header. Key components include: a unique `settlementId` for identifying the report, a `settlementPeriod` object indicating the covered timeframe, and a `settlementAmount` object representing the total value. The `numberOfItems` field specifies the count of settled items, excluding the header, within the settlement. All mentioned fields are mandatory.\n"],null,["# GspCardSettlementHeader\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n\nA header object that is used for the purposes of GSP Card settlement files. It is used to encapsulate the detail surrounding the contained settlement.\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"settlementId\": string, \"settlementPeriod\": { object (/pay/card-fop-v1/google-card-fop-api/settlementNotification#Interval) }, \"settlementAmount\": { object (/pay/card-fop-v1/google-card-fop-api/settlementNotification#Amount) }, \"numberOfItems\": string } ``` |\n\n| Fields ||\n|--------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `settlementId` | `string` **REQUIRED** : This should be a unique ID that identifies the settlement report. All files for this settlement report should use the same `settlementId`. |\n| `settlementPeriod` | `object (`[Interval](/pay/card-fop-v1/google-card-fop-api/settlementNotification#Interval)`)` **REQUIRED**: The period this settlement report covers. |\n| `settlementAmount` | `object (`[Amount](/pay/card-fop-v1/google-card-fop-api/settlementNotification#Amount)`)` **REQUIRED**: This should match the sum of all of the events and adjustments in a settlement file. |\n| `numberOfItems` | `string (`[Int64Value](https://developers.google.com/discovery/v1/type-format)` format)` **REQUIRED**: The number of settled items(entries and adjustments). This should exclude the header entry. |"]]