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	Technical Details
`vendorCode`	String	Vendor identifier used for the Tax Code and Document Type determination.	Y	Mapped to SAP I_LIFNR.
`companyCode`	String	Company code for which the Tax Code and Document Type must be determined.	Y	Mapped to SAP I_BUKRS.
`documentType`	String	Indicates whether the document is an invoice or a credit note.	Y	Mapped to SAP I_SIGN. Expected values: I for invoice or C for credit note.
`totalAmount`	String	Total amount of the document.	Y	Mapped to SAP I_AMOUNT. Expected decimal value.
`taxAmount`	String	Total tax amount of the document.	Y	Mapped to SAP I_TAX. Expected decimal value.
`stampDutyAmount`	String	Stamp duty amount associated with the document.	Y	Mapped to SAP I_ZBOL. Expected decimal value. Currently expected to be provided as 0 by SPIRIT when not applicable.
`conditionType`	String	Condition type used by SAP for the Tax Code determination.	Y	Mapped to SAP IT_INBOUND_DATA/YCODE. Current expected value: XD15.
`item (1..1)`
`totalAmount`	String	Amount associated with the document item.	Y	Mapped to SAP IT_INBOUND_DATA/DMBTR. Expected decimal value.
`numberOfAgreement`	String	Agreement number associated with the document item.	Y	Mapped to SAP IT_INBOUND_DATA/NRCONTRATTO. Expected numeric value.
`assignmentNumber`	String	Assignment number associated with the document item.	Y	Mapped to SAP IT_INBOUND_DATA/ZUONR. The field is required but can be provided as an empty string.
`itemText`	String	Text associated with the document item.	Y	Mapped to SAP IT_INBOUND_DATA/SGTXT. The field is required but can be provided as an empty string.
`xref3`	String	Reference information associated with the document item.	Y	Mapped to SAP IT_INBOUND_DATA/XREF3. The field is required but can be provided as an empty string.

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

#### Error Response Examples

Validation error - HTTP 400

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

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 2 as of 10 hours ago by Daniele.Urciuoli

0 Comments

Please sign in to post a comment.

Tax Code Retrieval

0 Comments

Docs Navigation