Tax Code Retrieval

This API allows to retrieve the SAP Document Type and Tax Code based on vendor, company, document and item information. #### Request URI #### Request Structure

API field	Type	Description	Mandatory	Format / Constraints	SAP Mapping
`vendorCode`	String	Vendor identifier used for the Tax Code and Document Type determination.	Y	A non-empty value is required.	`I_LIFNR`
`companyCode`	String	Company code for which the Tax Code and Document Type must be determined.	Y	A non-empty value is required.	`I_BUKRS`
`documentType`	String	Indicates whether the document is an invoice or a credit note.	Y	Allowed values: `I` (invoice) or `C` (credit note).	`I_SIGN`
`totalAmount`	String	Total amount of the document.	Y	A valid decimal value is required. Zero is allowed.	`I_AMOUNT`
`taxAmount`	String	Total tax amount of the document.	Y	A valid decimal value is required. Zero is allowed.	`I_TAX`
`stampDutyAmount`	String	Stamp duty amount associated with the document.	Y	A valid decimal value is required. Zero is allowed and must be provided when no stamp duty is applicable.	`I_ZBOL`
`conditionType`	String	Condition type used for the Tax Code determination.	Y	A non-empty value is required. Current expected value: `XD15`.	`IT_INBOUND_DATA/YCODE`
`item (1..1)`
`totalAmount`	String	Amount associated with the document item.	Y	A valid decimal value is required. Zero is allowed.	`IT_INBOUND_DATA/DMBTR`
`numberOfAgreement`	String	Agreement number associated with the document item.	Y	Numeric value required. Accepted range: `0-99999` (maximum 5 significant digits). Leading zeros are allowed.	`IT_INBOUND_DATA/NRCONTRATTO`
`assignmentNumber`	String	Assignment number associated with the document item.	Y	The field must be present. An empty string is allowed.	`IT_INBOUND_DATA/ZUONR`
`itemText`	String	Text associated with the document item.	Y	The field must be present. An empty string is allowed.	`IT_INBOUND_DATA/SGTXT`
`xRef3`	String	Reference information associated with the document item.	Y	The field must be present. An empty string is allowed.	`IT_INBOUND_DATA/XREF3`

#### Request Example

{ "vendorCode": "1000004784", "companyCode": "IT10", "documentType": "I", "totalAmount": "0", "taxAmount": "0", "stampDutyAmount": "0", "conditionType": "XD15", "item": { "totalAmount": "0", "numberOfAgreement": "00000", "assignmentNumber": "", "itemText": "", "xRef3": "" } }

#### Response Structure

API field	Type	Mandatory	Description
`documentType`	String	Y	SAP Document Type determined for the provided input data.
`taxCode`	String	N	SAP Tax Code determined for the provided input data. Returned as null when no Tax Code is determined.

#### Response Example - Successful Retrieval

{
  "documentType": "R5",
  "taxCode": "A5"
}

#### Response Example - No Tax Code Determined

{
  "documentType": "R5",
  "taxCode": null
}

#### 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 for the failure.

#### Error Response Examples

Missing required value - HTTP 400

{
  "status": "Error",
  "message": "Invalid companyCode. A value is required."
}

Invalid document type - HTTP 400

{
  "status": "Error",
  "message": "Invalid documentType. Expected I or C."
}

Invalid decimal value - HTTP 400

{
  "status": "Error",
  "message": "Invalid totalAmount. Expected a decimal value."
}

Invalid agreement number - HTTP 400

{
  "status": "Error",
  "message": "Invalid item.numberOfAgreement. The provided value is not compatible with the expected SAP format."
}

SAP / backend processing error - HTTP 500

{
  "status": "Error",
  "message": "Unable to retrieve Tax Code information."
}

Generic processing error - HTTP 500

{
  "status": "Error",
  "message": "Unable to process Tax Code retrieval request."
}

version 4 as of 7 days ago by Daniele.Urciuoli

0 Comments

Please sign in to post a comment.

Tax Code Retrieval

0 Comments

Docs Navigation