openapi: 3.0.0 info: title: SAP API version: 1.0.0 servers: - url: http://localhost:8080 paths: /rfc/BAPI_TC_GETDETAIL: post: tags: - FSBP_TC_BAPI summary: Read Contract Details of Total Commitment operationId: /rfc/BAPI_TC_GETDETAIL requestBody: content: application/json: schema: properties: CONTEXT: type: string default: DEFAULT maxLength: 15 description: Call Context CURRENCY: type: string maxLength: 5 description: Currency Key CURRENCYISO: type: string maxLength: 3 description: ISO Currency Code LANGUAGE: type: string maxLength: 1 description: Language Key LANGUAGEISO: type: string maxLength: 2 description: Language According to ISO 639 PARTNER: type: string maxLength: 10 description: Business Partner Number PARTNERGUID: type: string maxLength: 32 description: GUID of Business Partner PROCESSEXTENSION: type: string default: '' maxLength: 1 description: Execute Customer Enhancements SELECTIONVARIANT: type: string maxLength: 20 description: Selection Variant EXTENSIONIN: type: array items: type: object properties: STRUCTURE: type: string maxLength: 30 description: Structure name of BAPI table extension VALUEPART1: type: string maxLength: 240 description: Data part of BAPI extension parameter VALUEPART2: type: string maxLength: 240 description: Data part of BAPI extension parameter VALUEPART3: type: string maxLength: 240 description: Data part of BAPI extension parameter VALUEPART4: type: string maxLength: 240 description: Data part of BAPI extension parameter EXTENSIONOUT: type: array items: type: object properties: STRUCTURE: type: string maxLength: 30 description: Structure name of BAPI table extension VALUEPART1: type: string maxLength: 240 description: Data part of BAPI extension parameter VALUEPART2: type: string maxLength: 240 description: Data part of BAPI extension parameter VALUEPART3: type: string maxLength: 240 description: Data part of BAPI extension parameter VALUEPART4: type: string maxLength: 240 description: Data part of BAPI extension parameter TOTALCOMMITMENTHEADER: type: array items: type: object properties: PARTNER: type: string maxLength: 10 description: Business Partner Number PARTNER_GUID: type: string maxLength: 32 description: GUID of a Business Partner RELATIONSHIPID: type: string maxLength: 12 description: BP Relationship Number RELATIONSHIPCATEGORY: type: string maxLength: 6 description: Business Partner Relationship Category RELATIONSHIP_DESCRIPTION: type: string maxLength: 50 description: Cust. Name of Business Partner Relationship from BP 1 View PERCENTAGE_OF_PARTICIPATION: type: integer format: int64 description: Percentage of Capital Interest AMOUNT_OF_PARTICIPATION: type: integer format: int64 description: Amount of Capital Interest PARTICIPATION_CURRENCY: type: string maxLength: 5 description: Currency PARTICIPATION_CURRENCY_ISO: type: string maxLength: 3 description: ISO currency code RELATIONSHIPCATEGORY_SORT: type: integer format: int64 description: Sort Sequence for Displayed BP Relationship Category PARTNER_DESCRIPTION: type: string maxLength: 80 description: Business Partner Address BIRTHDATE: type: string format: date description: Date of Birth of Business Partner VIP: type: string maxLength: 1 description: 'VIP Business Partner enumValues: ""=No,X=Yes' enum: - '' - X UNW_CUSTOMER: type: string maxLength: 1 description: 'Undesirable Customer enumValues: ""=No,X=Yes' enum: - '' - X TOTALCOMMITMENTITEMS: type: array items: type: object properties: APPLICATION: type: string maxLength: 10 description: Application PARTNER: type: string maxLength: 10 description: Business Partner Number PARTNER_GUID: type: string format: byte description: GUID of a Business Partner IDNUM: type: string maxLength: 60 description: Identification Number for Business Partner ROLECATEGORY: type: string maxLength: 6 description: Business Partner Role for Application INTERNALID: type: string maxLength: 32 description: Internal Contract ID EXTERNALID: type: string maxLength: 70 description: Contract Number PRODUCT_DESCRIPTION: type: string maxLength: 35 description: Product Description START_OF_TERM: type: string format: date description: Start Date of Contract TERMINATION_DATE: type: string format: date description: Contract End Date END_OF_TERM: type: string format: date description: End of Term Date CONTRACT_AMOUNT: type: integer format: int64 description: Contract Amount CONTRACT_CURRENCY: type: string maxLength: 5 description: Display Currency for Contract CONTRACT_CURRENCY_ISO: type: string maxLength: 3 description: Display Currency for Contract S_COLL_AVAILABLE: type: string maxLength: 1 description: 'Collateral Available enumValues: X=TRUE,""=FALSE' enum: - X - '' S_3RD_PARTY: type: string maxLength: 1 description: 'Third-Party Account enumValues: X=TRUE,""=FALSE' enum: - X - '' ASSET_LIABILITY: type: string maxLength: 1 description: 'Asset/Liability Transaction enumValues: 1=Liabilities Transaction,0=Asset Transaction,""=-' enum: - '1' - '0' - '' ACCOUNT_BALANCE: type: integer format: int64 description: Account Balance ACCOUNT_CURRENCY: type: string maxLength: 5 description: Display Currency for Account Balance ACCOUNT_CURRENCY_ISO: type: string maxLength: 3 description: Display Currency According to ISO for Account Balance LIMIT_EXTERNAL: type: integer format: int64 description: External Limit LIMIT_INTERNAL: type: integer format: int64 description: Internal Limit LIMIT_CARD: type: integer format: int64 description: Credit Line of Credit Card LIMIT_CURRENCY: type: string maxLength: 5 description: Display Currency for Limits LIMIT_CURRENCY_ISO: type: string maxLength: 3 description: Display Currency According to ISO for Limits BLOCKED: type: string maxLength: 1 description: 'Lock on Contract enumValues: X=TRUE,""=FALSE' enum: - X - '' STATUS: type: string maxLength: 20 description: Status Information ACCOUNT_BALANCE_SUM: type: integer format: int64 description: Account Balance CONTRACT_AMOUNT_SUM: type: integer format: int64 description: Contract Amount LIMIT_EXTERNAL_SUM: type: integer format: int64 description: External Limit LIMIT_INTERNAL_SUM: type: integer format: int64 description: Internal Limit LIMIT_CARD_SUM: type: integer format: int64 description: Credit Line of Credit Card ORIGINAL_CURRENCY: type: string maxLength: 5 description: Original Contract Currency ORIGINAL_CURRENCY_ISO: type: string maxLength: 3 description: Original Contract Currency NO_SUM: type: string maxLength: 1 description: 'Exclude Contract from Totaling enumValues: X=TRUE,""=FALSE' enum: - X - '' APPLICATION_DESCRIPTION: type: string maxLength: 40 description: Name ROLECATEGORY_DESCRIPTION: type: string maxLength: 50 description: Description of Business Partner Role APPLICATION_SORT: type: integer format: int64 description: Sort Sequence for Displayed Application Data ROLECATEGORY_SORT: type: integer format: int64 description: Sort Sequence for Displayed Business Partner Role responses: '200': description: OK content: application/json: schema: properties: SUM: type: object properties: ACCOUNT_BALANCE_SUM: type: integer format: int64 description: Account Balance ACCOUNT_CURRENCY: type: string maxLength: 5 description: Display Currency for Account Balance ACCOUNT_CURRENCY_ISO: type: string maxLength: 3 description: Display Currency According to ISO for Account Balance CONTRACT_AMOUNT_SUM: type: integer format: int64 description: Contract Amount CONTRACT_CURRENCY: type: string maxLength: 5 description: Display Currency for Contract CONTRACT_CURRENCY_ISO: type: string maxLength: 3 description: Display Currency for Contract LIMIT_EXTERNAL_SUM: type: integer format: int64 description: External Limit LIMIT_INTERNAL_SUM: type: integer format: int64 description: Internal Limit LIMIT_CARD_SUM: type: integer format: int64 description: Credit Line of Credit Card LIMIT_CURRENCY: type: string maxLength: 5 description: Display Currency for Limits LIMIT_CURRENCY_ISO: type: string maxLength: 3 description: Display Currency According to ISO for Limits EXTENSIONIN: type: array items: type: object properties: STRUCTURE: type: string maxLength: 30 description: Structure name of BAPI table extension VALUEPART1: type: string maxLength: 240 description: Data part of BAPI extension parameter VALUEPART2: type: string maxLength: 240 description: Data part of BAPI extension parameter VALUEPART3: type: string maxLength: 240 description: Data part of BAPI extension parameter VALUEPART4: type: string maxLength: 240 description: Data part of BAPI extension parameter EXTENSIONOUT: type: array items: type: object properties: STRUCTURE: type: string maxLength: 30 description: Structure name of BAPI table extension VALUEPART1: type: string maxLength: 240 description: Data part of BAPI extension parameter VALUEPART2: type: string maxLength: 240 description: Data part of BAPI extension parameter VALUEPART3: type: string maxLength: 240 description: Data part of BAPI extension parameter VALUEPART4: type: string maxLength: 240 description: Data part of BAPI extension parameter RETURN: type: array items: type: object properties: TYPE: type: string maxLength: 1 description: 'Message type: S Success, E Error, W Warning, I Info, A Abort' ID: type: string maxLength: 20 description: Message Class NUMBER: type: integer format: int64 description: Message Number MESSAGE: type: string maxLength: 220 description: Message Text LOG_NO: type: string maxLength: 20 description: 'Application log: log number' LOG_MSG_NO: type: integer format: int64 description: 'Application log: Internal message serial number' MESSAGE_V1: type: string maxLength: 50 description: Message Variable MESSAGE_V2: type: string maxLength: 50 description: Message Variable MESSAGE_V3: type: string maxLength: 50 description: Message Variable MESSAGE_V4: type: string maxLength: 50 description: Message Variable PARAMETER: type: string maxLength: 32 description: Parameter Name ROW: type: integer format: int32 description: Lines in parameter FIELD: type: string maxLength: 30 description: Field in parameter SYSTEM: type: string maxLength: 10 description: Logical system from which message originates TOTALCOMMITMENTHEADER: type: array items: type: object properties: PARTNER: type: string maxLength: 10 description: Business Partner Number PARTNER_GUID: type: string maxLength: 32 description: GUID of a Business Partner RELATIONSHIPID: type: string maxLength: 12 description: BP Relationship Number RELATIONSHIPCATEGORY: type: string maxLength: 6 description: Business Partner Relationship Category RELATIONSHIP_DESCRIPTION: type: string maxLength: 50 description: Cust. Name of Business Partner Relationship from BP 1 View PERCENTAGE_OF_PARTICIPATION: type: integer format: int64 description: Percentage of Capital Interest AMOUNT_OF_PARTICIPATION: type: integer format: int64 description: Amount of Capital Interest PARTICIPATION_CURRENCY: type: string maxLength: 5 description: Currency PARTICIPATION_CURRENCY_ISO: type: string maxLength: 3 description: ISO currency code RELATIONSHIPCATEGORY_SORT: type: integer format: int64 description: Sort Sequence for Displayed BP Relationship Category PARTNER_DESCRIPTION: type: string maxLength: 80 description: Business Partner Address BIRTHDATE: type: string format: date description: Date of Birth of Business Partner VIP: type: string maxLength: 1 description: 'VIP Business Partner enumValues: ""=No,X=Yes' enum: - '' - X UNW_CUSTOMER: type: string maxLength: 1 description: 'Undesirable Customer enumValues: ""=No,X=Yes' enum: - '' - X TOTALCOMMITMENTITEMS: type: array items: type: object properties: APPLICATION: type: string maxLength: 10 description: Application PARTNER: type: string maxLength: 10 description: Business Partner Number PARTNER_GUID: type: string format: byte description: GUID of a Business Partner IDNUM: type: string maxLength: 60 description: Identification Number for Business Partner ROLECATEGORY: type: string maxLength: 6 description: Business Partner Role for Application INTERNALID: type: string maxLength: 32 description: Internal Contract ID EXTERNALID: type: string maxLength: 70 description: Contract Number PRODUCT_DESCRIPTION: type: string maxLength: 35 description: Product Description START_OF_TERM: type: string format: date description: Start Date of Contract TERMINATION_DATE: type: string format: date description: Contract End Date END_OF_TERM: type: string format: date description: End of Term Date CONTRACT_AMOUNT: type: integer format: int64 description: Contract Amount CONTRACT_CURRENCY: type: string maxLength: 5 description: Display Currency for Contract CONTRACT_CURRENCY_ISO: type: string maxLength: 3 description: Display Currency for Contract S_COLL_AVAILABLE: type: string maxLength: 1 description: 'Collateral Available enumValues: X=TRUE,""=FALSE' enum: - X - '' S_3RD_PARTY: type: string maxLength: 1 description: 'Third-Party Account enumValues: X=TRUE,""=FALSE' enum: - X - '' ASSET_LIABILITY: type: string maxLength: 1 description: 'Asset/Liability Transaction enumValues: 1=Liabilities Transaction,0=Asset Transaction,""=-' enum: - '1' - '0' - '' ACCOUNT_BALANCE: type: integer format: int64 description: Account Balance ACCOUNT_CURRENCY: type: string maxLength: 5 description: Display Currency for Account Balance ACCOUNT_CURRENCY_ISO: type: string maxLength: 3 description: Display Currency According to ISO for Account Balance LIMIT_EXTERNAL: type: integer format: int64 description: External Limit LIMIT_INTERNAL: type: integer format: int64 description: Internal Limit LIMIT_CARD: type: integer format: int64 description: Credit Line of Credit Card LIMIT_CURRENCY: type: string maxLength: 5 description: Display Currency for Limits LIMIT_CURRENCY_ISO: type: string maxLength: 3 description: Display Currency According to ISO for Limits BLOCKED: type: string maxLength: 1 description: 'Lock on Contract enumValues: X=TRUE,""=FALSE' enum: - X - '' STATUS: type: string maxLength: 20 description: Status Information ACCOUNT_BALANCE_SUM: type: integer format: int64 description: Account Balance CONTRACT_AMOUNT_SUM: type: integer format: int64 description: Contract Amount LIMIT_EXTERNAL_SUM: type: integer format: int64 description: External Limit LIMIT_INTERNAL_SUM: type: integer format: int64 description: Internal Limit LIMIT_CARD_SUM: type: integer format: int64 description: Credit Line of Credit Card ORIGINAL_CURRENCY: type: string maxLength: 5 description: Original Contract Currency ORIGINAL_CURRENCY_ISO: type: string maxLength: 3 description: Original Contract Currency NO_SUM: type: string maxLength: 1 description: 'Exclude Contract from Totaling enumValues: X=TRUE,""=FALSE' enum: - X - '' APPLICATION_DESCRIPTION: type: string maxLength: 40 description: Name ROLECATEGORY_DESCRIPTION: type: string maxLength: 50 description: Description of Business Partner Role APPLICATION_SORT: type: integer format: int64 description: Sort Sequence for Displayed Application Data ROLECATEGORY_SORT: type: integer format: int64 description: Sort Sequence for Displayed Business Partner Role '400': description: Bad request. 5XX: description: Unexpected error.