Posting Profile

Posting Profile - Get

HTTP Request

GET /api/v1/sap-posting-bot/posting/profiles/{id}

Interactive Demo

📋 Description: Retrieves the financial record associated with a specific ledger entry by its unique identifier, providing essential details about the transaction and account involved.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponsePostingProfileDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "erpSystem": {
      "id": 0,
      "displayId": "string"
    },
    "companyFilterType": "ALL",
    "companies": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "erpSystemId": 0,
        "erpSystemDisplayId": "string",
        "countryId": 0,
        "countryDisplayId": "string",
        "name": "string",
        "postingPeriodVariantId": 0,
        "fiscalVariantId": 0
      }
    ],
    "accountingStandardFilterType": "ALL",
    "accountingStandards": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string",
        "standardType": "GAAP",
        "erpSystemId": 0,
        "erpSystemDisplayId": "string"
      }
    ],
    "objectStatus": "CREATED"
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Posting Profile - Update

HTTP Request

PUT /api/v1/sap-posting-bot/posting/profiles/{id}

Interactive Demo

📋 Description: Updates the specified posting profile in the General Ledger, allowing for modifications to ledger entries, transactions, and associated financial records. This operation ensures that account information remains accurate and up-to-date.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	PostingProfileDto	true	Request body containing the updated financial record data for the specified ledger entry, including transaction details and account information.

Body Parameters

{
  "id": 0,
  "erpSystem": {
    "id": 0,
    "displayId": "string"
  },
  "companyFilterType": "ALL",
  "companies": [
    {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "countryId": 0,
      "countryDisplayId": "string",
      "name": "string",
      "postingPeriodVariantId": 0,
      "fiscalVariantId": 0
    }
  ],
  "accountingStandardFilterType": "ALL",
  "accountingStandards": [
    {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string",
      "standardType": "GAAP",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string"
    }
  ],
  "objectStatus": "CREATED"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponsePostingProfileDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "erpSystem": {
      "id": 0,
      "displayId": "string"
    },
    "companyFilterType": "ALL",
    "companies": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "erpSystemId": 0,
        "erpSystemDisplayId": "string",
        "countryId": 0,
        "countryDisplayId": "string",
        "name": "string",
        "postingPeriodVariantId": 0,
        "fiscalVariantId": 0
      }
    ],
    "accountingStandardFilterType": "ALL",
    "accountingStandards": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string",
        "standardType": "GAAP",
        "erpSystemId": 0,
        "erpSystemDisplayId": "string"
      }
    ],
    "objectStatus": "CREATED"
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Posting Profile - Delete

HTTP Request

DELETE /api/v1/sap-posting-bot/posting/profiles/{id}

Interactive Demo

📋 Description: Deletes a specified posting profile from the General Ledger, effectively removing the associated ledger entry and transaction details from the financial records.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {}
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Posting Profile - Create Or Update

HTTP Request

PUT /api/v1/sap-posting-bot/posting/profiles/createOrUpdate

Interactive Demo

📋 Description: Creates or updates posting profiles within the General Ledger, ensuring accurate ledger entries and financial records for transactions and accounts. This operation streamlines the management of posting profiles to enhance financial reporting and compliance.

Parameters

Name	In	Type	Required	Description
body	body	PostingProfileDto	true	Request body containing the ledger entry data, including transaction details, account information, and relevant financial record attributes for creating or updating posting profiles.

Body Parameters

{
  "id": 0,
  "erpSystem": {
    "id": 0,
    "displayId": "string"
  },
  "companyFilterType": "ALL",
  "companies": [
    {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "countryId": 0,
      "countryDisplayId": "string",
      "name": "string",
      "postingPeriodVariantId": 0,
      "fiscalVariantId": 0
    }
  ],
  "accountingStandardFilterType": "ALL",
  "accountingStandards": [
    {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "name": "string",
      "standardType": "GAAP",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string"
    }
  ],
  "objectStatus": "CREATED"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponsePostingProfileDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "erpSystem": {
      "id": 0,
      "displayId": "string"
    },
    "companyFilterType": "ALL",
    "companies": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "erpSystemId": 0,
        "erpSystemDisplayId": "string",
        "countryId": 0,
        "countryDisplayId": "string",
        "name": "string",
        "postingPeriodVariantId": 0,
        "fiscalVariantId": 0
      }
    ],
    "accountingStandardFilterType": "ALL",
    "accountingStandards": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string",
        "standardType": "GAAP",
        "erpSystemId": 0,
        "erpSystemDisplayId": "string"
      }
    ],
    "objectStatus": "CREATED"
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Posting Profile - Create Or Update Bulk

HTTP Request

PUT /api/v1/sap-posting-bot/posting/profiles/createOrUpdate/bulk

Interactive Demo

📋 Description: Updates or creates multiple posting profiles in bulk for ledger entries, ensuring accurate transaction and account management within the General Ledger. This operation streamlines the maintenance of financial records by allowing batch processing of profile data.

Parameters

Name	In	Type	Required	Description
body	body	PostingProfileDto	true	Request body containing bulk ledger entry data, including transaction details, account information, and associated financial records for creation or update.

Body Parameters

[
  {
    "id": 0,
    "erpSystem": {
      "id": 0,
      "displayId": "string"
    },
    "companyFilterType": "ALL",
    "companies": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "erpSystemId": 0,
        "erpSystemDisplayId": "string",
        "countryId": 0,
        "countryDisplayId": "string",
        "name": "string",
        "postingPeriodVariantId": 0,
        "fiscalVariantId": 0
      }
    ],
    "accountingStandardFilterType": "ALL",
    "accountingStandards": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string",
        "standardType": "GAAP",
        "erpSystemId": 0,
        "erpSystemDisplayId": "string"
      }
    ],
    "objectStatus": "CREATED"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListPostingProfileDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "erpSystem": {
        "id": 0,
        "displayId": "string"
      },
      "companyFilterType": "ALL",
      "companies": [
        {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "erpSystemId": 0,
          "erpSystemDisplayId": "string",
          "countryId": 0,
          "countryDisplayId": "string",
          "name": "string",
          "postingPeriodVariantId": 0,
          "fiscalVariantId": 0
        }
      ],
      "accountingStandardFilterType": "ALL",
      "accountingStandards": [
        {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string",
          "standardType": "GAAP",
          "erpSystemId": 0,
          "erpSystemDisplayId": "string"
        }
      ],
      "objectStatus": "CREATED"
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Posting Profile - Bulk Update

HTTP Request

PUT /api/v1/sap-posting-bot/posting/profiles/bulk

Interactive Demo

📋 Description: Updates multiple posting profiles in bulk for ledger entries, enabling efficient management of transactions and financial records within the General Ledger.

Parameters

Name	In	Type	Required	Description
body	body	PostingProfileDto	true	Request body containing a collection of ledger entries for bulk posting, including transaction details, account information, and associated financial records.

Body Parameters

[
  {
    "id": 0,
    "erpSystem": {
      "id": 0,
      "displayId": "string"
    },
    "companyFilterType": "ALL",
    "companies": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "erpSystemId": 0,
        "erpSystemDisplayId": "string",
        "countryId": 0,
        "countryDisplayId": "string",
        "name": "string",
        "postingPeriodVariantId": 0,
        "fiscalVariantId": 0
      }
    ],
    "accountingStandardFilterType": "ALL",
    "accountingStandards": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string",
        "standardType": "GAAP",
        "erpSystemId": 0,
        "erpSystemDisplayId": "string"
      }
    ],
    "objectStatus": "CREATED"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListPostingProfileDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "erpSystem": {
        "id": 0,
        "displayId": "string"
      },
      "companyFilterType": "ALL",
      "companies": [
        {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "erpSystemId": 0,
          "erpSystemDisplayId": "string",
          "countryId": 0,
          "countryDisplayId": "string",
          "name": "string",
          "postingPeriodVariantId": 0,
          "fiscalVariantId": 0
        }
      ],
      "accountingStandardFilterType": "ALL",
      "accountingStandards": [
        {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string",
          "standardType": "GAAP",
          "erpSystemId": 0,
          "erpSystemDisplayId": "string"
        }
      ],
      "objectStatus": "CREATED"
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Posting Profile - Bulk Delete

HTTP Request

DELETE /api/v1/sap-posting-bot/posting/profiles/bulk

Interactive Demo

📋 Description: Deletes multiple posting profiles in bulk from the General Ledger, allowing for efficient management of ledger entries and financial records associated with transactions and accounts.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing an array of profile identifiers for bulk deletion of ledger entry profiles associated with financial records and transactions.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {}
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Posting Profile - Search

HTTP Request

POST /api/v1/sap-posting-bot/posting/profiles/search

Interactive Demo

📋 Description: Submits a search request for posting profiles within the General Ledger, enabling users to locate specific ledger entries, transactions, or accounts related to financial records efficiently.

Parameters

Name	In	Type	Required	Description
page	query	integer	false	Zero-based page index (0..N)
size	query	integer	false	The size of the page to be returned
sort	query	array[string]	false	Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
body	body	PostingProfileExtendedDtoFilter	false	Request body containing search criteria for ledger entries, including transaction details, account identifiers, and relevant financial record parameters.

Default Values

Parameter	Default	Type
page	0	query
size	100	query
sort	["createdAt,ASC"]	query

Parameter Constraints

Parameter	Constraints
page	Min: 0
size	Min: 1

Body Parameters

{
  "idIn": [
    0
  ],
  "idEqual": 0,
  "idLike": "string",
  "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
  "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
  "createdByLike": "string",
  "createdByEqual": "string",
  "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
  "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
  "modifiedByLike": "string",
  "modifiedByEqual": "string",
  "systemIdEqual": 0,
  "systemDisplayIdLike": "string",
  "companyFilterTypeIn": [
    "ALL"
  ],
  "companyFilterTypeEqual": "ALL",
  "accountingStandardFilterTypeIn": [
    "ALL"
  ],
  "accountingStandardFilterTypeEqual": "ALL",
  "objectStatusIn": [
    "CREATED"
  ],
  "objectStatusEqual": "CREATED",
  "companyDisplayIdLike": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PagePostingProfileDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "unpaged": true,
    "paged": true,
    "pageSize": 0,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "erpSystem": {
        "id": 0,
        "displayId": "string"
      },
      "companyFilterType": "ALL",
      "companies": [
        {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "erpSystemId": 0,
          "erpSystemDisplayId": "string",
          "countryId": 0,
          "countryDisplayId": "string",
          "name": "string",
          "postingPeriodVariantId": 0,
          "fiscalVariantId": 0
        }
      ],
      "accountingStandardFilterType": "ALL",
      "accountingStandards": [
        {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string",
          "standardType": "GAAP",
          "erpSystemId": 0,
          "erpSystemDisplayId": "string"
        }
      ],
      "objectStatus": "CREATED"
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Posting Profile - Find All

HTTP Request

GET /api/v1/sap-posting-bot/posting/profiles

Interactive Demo

📋 Description: Retrieves a list of posting profiles used for ledger entries, enabling users to manage transaction-related settings and maintain accurate financial records.

Parameters

Name	In	Type	Required	Description
pageable	query	Pageable	true	Indicates whether the results of the ledger entry profiles retrieval should be paginated, facilitating efficient navigation through large sets of financial records.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PagePostingProfileDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "unpaged": true,
    "paged": true,
    "pageSize": 0,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "erpSystem": {
        "id": 0,
        "displayId": "string"
      },
      "companyFilterType": "ALL",
      "companies": [
        {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "erpSystemId": 0,
          "erpSystemDisplayId": "string",
          "countryId": 0,
          "countryDisplayId": "string",
          "name": "string",
          "postingPeriodVariantId": 0,
          "fiscalVariantId": 0
        }
      ],
      "accountingStandardFilterType": "ALL",
      "accountingStandards": [
        {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string",
          "standardType": "GAAP",
          "erpSystemId": 0,
          "erpSystemDisplayId": "string"
        }
      ],
      "objectStatus": "CREATED"
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

---