Accruals

This API allows to post accrual information based on the selected contract, invoice details and brand allocation. #### Request URI #### Request Structure

API field	Type	Description	Mandatory	Technical Details
`invoiceId`	String	Invoice identifier associated with the accrual posting.	Y	Mapped to SAP InvoiceID. Maximum length: 30.
`contractCode`	String	Identifier of the commercial contract to be used for the accrual posting.	Y	Mapped to SAP CondContract. Maximum length: 10.
`invoiceDate`	String	Date of the invoice associated with the accrual posting.	Y	Mapped to SAP InvoiceDate. Expected format: YYYY-MM-DD.
`companyCode`	String	Company code under which the accrual is posted.	Y	Mapped to SAP Company. Maximum length: 4.
`threshold`	String	Threshold value to be considered during the accrual posting.	N	Mapped to SAP Threshold when provided. Expected positive integer value.
`invoiceNetAmount`	String	Net amount of the invoice.	Y	Mapped to SAP InvoiceNetAmount. Expected decimal value.
`invoiceCurrencyCode`	String	Currency of the invoice net amount.	Y	Mapped to SAP InvoiceCurrency. Use the ISO 4217 currency code, for example EUR.
`creditNote`	String	Indicates whether the invoice is a credit note.	Y	Mapped to SAP isCreditNote. Expected values: true or false.
`accrualCheckRequired`	String	Indicates whether the accrual validation must be performed.	Y	Mapped to SAP checkAccrual. Expected values: true or false.
`invoiceItem (1..∞)`
`brandCode`	String	Brand associated with the invoice amount.	Y	Mapped to SAP InvoiceItems/Brand.
`amount`	String	Invoice amount associated with the brand.	Y	Mapped to SAP InvoiceItems/Amount. Expected decimal value.
`taxCode`	String	Tax code associated with the invoice item.	Y	Mapped to SAP InvoiceItems/TaxCode. Maximum length: 2.

#### Request Example

{ "invoiceId": "9900000360", "contractCode": "1000013066", "invoiceDate": "2026-07-10", "companyCode": "ES10", "threshold": "300", "invoiceNetAmount": "121.09", "invoiceCurrencyCode": "EUR", "creditNote": "false", "accrualCheckRequired": "true", "invoiceItem": [ { "brandCode": "CG0A1301", "amount": "121.09", "taxCode": "A2" } ] }

#### Response Structure

API field	Type	Mandatory	Description
`status`	String	Y	Outcome status of the accrual posting. Example: SUCCESS.
`message`	String	N	Outcome message for the accrual posting, when returned.
`settlementDocumentNumber`	String	N	Identifier of the settlement document created for the accrual.
`accountingDocumentNumber`	String	N	Identifier of the accounting document generated by the posting.
`companyCode`	String	N	Company code associated with the generated documents.
`fiscalYear`	String	N	Fiscal year associated with the accounting document.
`exceptionCode`	String	N	Code providing additional information in case of business exceptions.

#### Response Example - Successful Posting

{
  "status": "SUCCESS",
  "message": "Settlement created successfully",
  "settlementDocumentNumber": "0101000389",
  "accountingDocumentNumber": "0101000389",
  "companyCode": "ES10",
  "fiscalYear": "2026"
}

#### Response Example - Business Exception

{
  "settlementDocumentNumber": "",
  "accountingDocumentNumber": "",
  "companyCode": "ES10",
  "fiscalYear": "",
  "exceptionCode": "001",
  "message": "Invoice exceeds contract amount beyond threshold. Workflow initiated."
}

#### Error Response Structure

API field	Type	Mandatory	Description
`status`	String	Y	Response status. Returned as Error in case of failed processing.
`message`	String	Y	Error message describing the reason of the failure.

#### Error Response Examples

Validation error

{
  "status": "Error",
  "message": "Invalid or missing request parameters."
}

SAP / backend processing error

{
  "status": "Error",
  "message": "Unable to post accrual information. SAP returned a processing error."
}

version 9 as of 1 week ago by Daniele.Urciuoli

0 Comments

Please sign in to post a comment.

Accruals

0 Comments

Docs Navigation